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/kthread.h>
23 #include <linux/mutex.h>
24 #include <linux/freezer.h>
25 #include <linux/usb/quirks.h>
27 #include <asm/uaccess.h>
28 #include <asm/byteorder.h>
34 /* if we are in debug mode, always announce new devices */
36 #ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
37 #define CONFIG_USB_ANNOUNCE_NEW_DEVICES
42 struct device *intfdev; /* the "interface" device */
43 struct usb_device *hdev;
45 struct urb *urb; /* for interrupt polling pipe */
47 /* buffer for urb ... with extra space in case of babble */
49 dma_addr_t buffer_dma; /* DMA address for buffer */
51 struct usb_hub_status hub;
52 struct usb_port_status port;
53 } *status; /* buffer for status reports */
54 struct mutex status_mutex; /* for the status buffer */
56 int error; /* last reported error */
57 int nerrors; /* track consecutive errors */
59 struct list_head event_list; /* hubs w/data or errs ready */
60 unsigned long event_bits[1]; /* status change bitmask */
61 unsigned long change_bits[1]; /* ports with logical connect
63 unsigned long busy_bits[1]; /* ports being reset or
65 #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
66 #error event_bits[] is too short!
69 struct usb_hub_descriptor *descriptor; /* class descriptor */
70 struct usb_tt tt; /* Transaction Translator */
72 unsigned mA_per_port; /* current for each child */
74 unsigned limited_power:1;
76 unsigned disconnected:1;
78 unsigned has_indicators:1;
79 u8 indicator[USB_MAXCHILDREN];
80 struct delayed_work leds;
81 struct delayed_work init_work;
86 /* Protect struct usb_device->state and ->children members
87 * Note: Both are also protected by ->dev.sem, except that ->state can
88 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
89 static DEFINE_SPINLOCK(device_state_lock);
91 /* khubd's worklist and its lock */
92 static DEFINE_SPINLOCK(hub_event_lock);
93 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
96 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
98 static struct task_struct *khubd_task;
100 /* cycle leds on hubs that aren't blinking for attention */
101 static int blinkenlights = 0;
102 module_param (blinkenlights, bool, S_IRUGO);
103 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
106 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
107 * 10 seconds to send reply for the initial 64-byte descriptor request.
109 /* define initial 64-byte descriptor request timeout in milliseconds */
110 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
111 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
112 MODULE_PARM_DESC(initial_descriptor_timeout,
113 "initial 64-byte descriptor request timeout in milliseconds "
114 "(default 5000 - 5.0 seconds)");
117 * As of 2.6.10 we introduce a new USB device initialization scheme which
118 * closely resembles the way Windows works. Hopefully it will be compatible
119 * with a wider range of devices than the old scheme. However some previously
120 * working devices may start giving rise to "device not accepting address"
121 * errors; if that happens the user can try the old scheme by adjusting the
122 * following module parameters.
124 * For maximum flexibility there are two boolean parameters to control the
125 * hub driver's behavior. On the first initialization attempt, if the
126 * "old_scheme_first" parameter is set then the old scheme will be used,
127 * otherwise the new scheme is used. If that fails and "use_both_schemes"
128 * is set, then the driver will make another attempt, using the other scheme.
130 static int old_scheme_first = 0;
131 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
132 MODULE_PARM_DESC(old_scheme_first,
133 "start with the old device initialization scheme");
135 static int use_both_schemes = 1;
136 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
137 MODULE_PARM_DESC(use_both_schemes,
138 "try the other device initialization scheme if the "
141 /* Mutual exclusion for EHCI CF initialization. This interferes with
142 * port reset on some companion controllers.
144 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
145 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
147 #define HUB_DEBOUNCE_TIMEOUT 1500
148 #define HUB_DEBOUNCE_STEP 25
149 #define HUB_DEBOUNCE_STABLE 100
152 static int usb_reset_and_verify_device(struct usb_device *udev);
154 static inline char *portspeed(int portstatus)
156 if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
158 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
160 else if (portstatus & (1 << USB_PORT_FEAT_SUPERSPEED))
166 /* Note that hdev or one of its children must be locked! */
167 static struct usb_hub *hdev_to_hub(struct usb_device *hdev)
169 if (!hdev || !hdev->actconfig)
171 return usb_get_intfdata(hdev->actconfig->interface[0]);
174 /* USB 2.0 spec Section 11.24.4.5 */
175 static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
179 for (i = 0; i < 3; i++) {
180 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
181 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
182 USB_DT_HUB << 8, 0, data, size,
183 USB_CTRL_GET_TIMEOUT);
184 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
191 * USB 2.0 spec Section 11.24.2.1
193 static int clear_hub_feature(struct usb_device *hdev, int feature)
195 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
196 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
200 * USB 2.0 spec Section 11.24.2.2
202 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
204 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
205 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
210 * USB 2.0 spec Section 11.24.2.13
212 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
214 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
215 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
220 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
221 * for info about using port indicators
223 static void set_port_led(
229 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
230 USB_PORT_FEAT_INDICATOR);
232 dev_dbg (hub->intfdev,
233 "port %d indicator %s status %d\n",
235 ({ char *s; switch (selector) {
236 case HUB_LED_AMBER: s = "amber"; break;
237 case HUB_LED_GREEN: s = "green"; break;
238 case HUB_LED_OFF: s = "off"; break;
239 case HUB_LED_AUTO: s = "auto"; break;
240 default: s = "??"; break;
245 #define LED_CYCLE_PERIOD ((2*HZ)/3)
247 static void led_work (struct work_struct *work)
249 struct usb_hub *hub =
250 container_of(work, struct usb_hub, leds.work);
251 struct usb_device *hdev = hub->hdev;
253 unsigned changed = 0;
256 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
259 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
260 unsigned selector, mode;
262 /* 30%-50% duty cycle */
264 switch (hub->indicator[i]) {
266 case INDICATOR_CYCLE:
268 selector = HUB_LED_AUTO;
269 mode = INDICATOR_AUTO;
271 /* blinking green = sw attention */
272 case INDICATOR_GREEN_BLINK:
273 selector = HUB_LED_GREEN;
274 mode = INDICATOR_GREEN_BLINK_OFF;
276 case INDICATOR_GREEN_BLINK_OFF:
277 selector = HUB_LED_OFF;
278 mode = INDICATOR_GREEN_BLINK;
280 /* blinking amber = hw attention */
281 case INDICATOR_AMBER_BLINK:
282 selector = HUB_LED_AMBER;
283 mode = INDICATOR_AMBER_BLINK_OFF;
285 case INDICATOR_AMBER_BLINK_OFF:
286 selector = HUB_LED_OFF;
287 mode = INDICATOR_AMBER_BLINK;
289 /* blink green/amber = reserved */
290 case INDICATOR_ALT_BLINK:
291 selector = HUB_LED_GREEN;
292 mode = INDICATOR_ALT_BLINK_OFF;
294 case INDICATOR_ALT_BLINK_OFF:
295 selector = HUB_LED_AMBER;
296 mode = INDICATOR_ALT_BLINK;
301 if (selector != HUB_LED_AUTO)
303 set_port_led(hub, i + 1, selector);
304 hub->indicator[i] = mode;
306 if (!changed && blinkenlights) {
308 cursor %= hub->descriptor->bNbrPorts;
309 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
310 hub->indicator[cursor] = INDICATOR_CYCLE;
314 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
317 /* use a short timeout for hub/port status fetches */
318 #define USB_STS_TIMEOUT 1000
319 #define USB_STS_RETRIES 5
322 * USB 2.0 spec Section 11.24.2.6
324 static int get_hub_status(struct usb_device *hdev,
325 struct usb_hub_status *data)
327 int i, status = -ETIMEDOUT;
329 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
330 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
331 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
332 data, sizeof(*data), USB_STS_TIMEOUT);
338 * USB 2.0 spec Section 11.24.2.7
340 static int get_port_status(struct usb_device *hdev, int port1,
341 struct usb_port_status *data)
343 int i, status = -ETIMEDOUT;
345 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
346 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
347 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
348 data, sizeof(*data), USB_STS_TIMEOUT);
353 static int hub_port_status(struct usb_hub *hub, int port1,
354 u16 *status, u16 *change)
358 mutex_lock(&hub->status_mutex);
359 ret = get_port_status(hub->hdev, port1, &hub->status->port);
361 dev_err(hub->intfdev,
362 "%s failed (err = %d)\n", __func__, ret);
366 *status = le16_to_cpu(hub->status->port.wPortStatus);
367 *change = le16_to_cpu(hub->status->port.wPortChange);
370 mutex_unlock(&hub->status_mutex);
374 static void kick_khubd(struct usb_hub *hub)
378 /* Suppress autosuspend until khubd runs */
379 atomic_set(&to_usb_interface(hub->intfdev)->pm_usage_cnt, 1);
381 spin_lock_irqsave(&hub_event_lock, flags);
382 if (!hub->disconnected && list_empty(&hub->event_list)) {
383 list_add_tail(&hub->event_list, &hub_event_list);
384 wake_up(&khubd_wait);
386 spin_unlock_irqrestore(&hub_event_lock, flags);
389 void usb_kick_khubd(struct usb_device *hdev)
391 struct usb_hub *hub = hdev_to_hub(hdev);
398 /* completion function, fires on port status changes and various faults */
399 static void hub_irq(struct urb *urb)
401 struct usb_hub *hub = urb->context;
402 int status = urb->status;
407 case -ENOENT: /* synchronous unlink */
408 case -ECONNRESET: /* async unlink */
409 case -ESHUTDOWN: /* hardware going away */
412 default: /* presumably an error */
413 /* Cause a hub reset after 10 consecutive errors */
414 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
415 if ((++hub->nerrors < 10) || hub->error)
420 /* let khubd handle things */
421 case 0: /* we got data: port status changed */
423 for (i = 0; i < urb->actual_length; ++i)
424 bits |= ((unsigned long) ((*hub->buffer)[i]))
426 hub->event_bits[0] = bits;
432 /* Something happened, let khubd figure it out */
439 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
440 && status != -ENODEV && status != -EPERM)
441 dev_err (hub->intfdev, "resubmit --> %d\n", status);
444 /* USB 2.0 spec Section 11.24.2.3 */
446 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
448 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
449 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
454 * enumeration blocks khubd for a long time. we use keventd instead, since
455 * long blocking there is the exception, not the rule. accordingly, HCDs
456 * talking to TTs must queue control transfers (not just bulk and iso), so
457 * both can talk to the same hub concurrently.
459 static void hub_tt_work(struct work_struct *work)
461 struct usb_hub *hub =
462 container_of(work, struct usb_hub, tt.clear_work);
466 spin_lock_irqsave (&hub->tt.lock, flags);
467 while (--limit && !list_empty (&hub->tt.clear_list)) {
468 struct list_head *next;
469 struct usb_tt_clear *clear;
470 struct usb_device *hdev = hub->hdev;
471 const struct hc_driver *drv;
474 next = hub->tt.clear_list.next;
475 clear = list_entry (next, struct usb_tt_clear, clear_list);
476 list_del (&clear->clear_list);
478 /* drop lock so HCD can concurrently report other TT errors */
479 spin_unlock_irqrestore (&hub->tt.lock, flags);
480 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
483 "clear tt %d (%04x) error %d\n",
484 clear->tt, clear->devinfo, status);
486 /* Tell the HCD, even if the operation failed */
487 drv = clear->hcd->driver;
488 if (drv->clear_tt_buffer_complete)
489 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
492 spin_lock_irqsave(&hub->tt.lock, flags);
494 spin_unlock_irqrestore (&hub->tt.lock, flags);
498 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
499 * @urb: an URB associated with the failed or incomplete split transaction
501 * High speed HCDs use this to tell the hub driver that some split control or
502 * bulk transaction failed in a way that requires clearing internal state of
503 * a transaction translator. This is normally detected (and reported) from
506 * It may not be possible for that hub to handle additional full (or low)
507 * speed transactions until that state is fully cleared out.
509 int usb_hub_clear_tt_buffer(struct urb *urb)
511 struct usb_device *udev = urb->dev;
512 int pipe = urb->pipe;
513 struct usb_tt *tt = udev->tt;
515 struct usb_tt_clear *clear;
517 /* we've got to cope with an arbitrary number of pending TT clears,
518 * since each TT has "at least two" buffers that can need it (and
519 * there can be many TTs per hub). even if they're uncommon.
521 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
522 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
523 /* FIXME recover somehow ... RESET_TT? */
527 /* info that CLEAR_TT_BUFFER needs */
528 clear->tt = tt->multi ? udev->ttport : 1;
529 clear->devinfo = usb_pipeendpoint (pipe);
530 clear->devinfo |= udev->devnum << 4;
531 clear->devinfo |= usb_pipecontrol (pipe)
532 ? (USB_ENDPOINT_XFER_CONTROL << 11)
533 : (USB_ENDPOINT_XFER_BULK << 11);
534 if (usb_pipein (pipe))
535 clear->devinfo |= 1 << 15;
537 /* info for completion callback */
538 clear->hcd = bus_to_hcd(udev->bus);
541 /* tell keventd to clear state for this TT */
542 spin_lock_irqsave (&tt->lock, flags);
543 list_add_tail (&clear->clear_list, &tt->clear_list);
544 schedule_work(&tt->clear_work);
545 spin_unlock_irqrestore (&tt->lock, flags);
548 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
550 /* If do_delay is false, return the number of milliseconds the caller
553 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
556 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
558 u16 wHubCharacteristics =
559 le16_to_cpu(hub->descriptor->wHubCharacteristics);
561 /* Enable power on each port. Some hubs have reserved values
562 * of LPSM (> 2) in their descriptors, even though they are
563 * USB 2.0 hubs. Some hubs do not implement port-power switching
564 * but only emulate it. In all cases, the ports won't work
565 * unless we send these messages to the hub.
567 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
568 dev_dbg(hub->intfdev, "enabling power on all ports\n");
570 dev_dbg(hub->intfdev, "trying to enable port power on "
571 "non-switchable hub\n");
572 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
573 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
575 /* Wait at least 100 msec for power to become stable */
576 delay = max(pgood_delay, (unsigned) 100);
582 static int hub_hub_status(struct usb_hub *hub,
583 u16 *status, u16 *change)
587 mutex_lock(&hub->status_mutex);
588 ret = get_hub_status(hub->hdev, &hub->status->hub);
590 dev_err (hub->intfdev,
591 "%s failed (err = %d)\n", __func__, ret);
593 *status = le16_to_cpu(hub->status->hub.wHubStatus);
594 *change = le16_to_cpu(hub->status->hub.wHubChange);
597 mutex_unlock(&hub->status_mutex);
601 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
603 struct usb_device *hdev = hub->hdev;
606 if (hdev->children[port1-1] && set_state)
607 usb_set_device_state(hdev->children[port1-1],
608 USB_STATE_NOTATTACHED);
610 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
612 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
618 * Disable a port and mark a logical connnect-change event, so that some
619 * time later khubd will disconnect() any existing usb_device on the port
620 * and will re-enumerate if there actually is a device attached.
622 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
624 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
625 hub_port_disable(hub, port1, 1);
627 /* FIXME let caller ask to power down the port:
628 * - some devices won't enumerate without a VBUS power cycle
629 * - SRP saves power that way
630 * - ... new call, TBD ...
631 * That's easy if this hub can switch power per-port, and
632 * khubd reactivates the port later (timer, SRP, etc).
633 * Powerdown must be optional, because of reset/DFU.
636 set_bit(port1, hub->change_bits);
640 enum hub_activation_type {
641 HUB_INIT, HUB_INIT2, HUB_INIT3,
642 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
645 static void hub_init_func2(struct work_struct *ws);
646 static void hub_init_func3(struct work_struct *ws);
648 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
650 struct usb_device *hdev = hub->hdev;
655 bool need_debounce_delay = false;
658 /* Continue a partial initialization */
659 if (type == HUB_INIT2)
661 if (type == HUB_INIT3)
664 /* After a resume, port power should still be on.
665 * For any other type of activation, turn it on.
667 if (type != HUB_RESUME) {
669 /* Speed up system boot by using a delayed_work for the
670 * hub's initial power-up delays. This is pretty awkward
671 * and the implementation looks like a home-brewed sort of
672 * setjmp/longjmp, but it saves at least 100 ms for each
673 * root hub (assuming usbcore is compiled into the kernel
674 * rather than as a module). It adds up.
676 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
677 * because for those activation types the ports have to be
678 * operational when we return. In theory this could be done
679 * for HUB_POST_RESET, but it's easier not to.
681 if (type == HUB_INIT) {
682 delay = hub_power_on(hub, false);
683 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
684 schedule_delayed_work(&hub->init_work,
685 msecs_to_jiffies(delay));
687 /* Suppress autosuspend until init is done */
688 atomic_set(&to_usb_interface(hub->intfdev)->
690 return; /* Continues at init2: below */
691 } else if (type == HUB_RESET_RESUME) {
692 /* The internal host controller state for the hub device
693 * may be gone after a host power loss on system resume.
694 * Update the device's info so the HW knows it's a hub.
696 hcd = bus_to_hcd(hdev->bus);
697 if (hcd->driver->update_hub_device) {
698 ret = hcd->driver->update_hub_device(hcd, hdev,
701 dev_err(hub->intfdev, "Host not "
702 "accepting hub info "
704 dev_err(hub->intfdev, "LS/FS devices "
705 "and hubs may not work "
706 "under this hub\n.");
709 hub_power_on(hub, true);
711 hub_power_on(hub, true);
716 /* Check each port and set hub->change_bits to let khubd know
717 * which ports need attention.
719 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
720 struct usb_device *udev = hdev->children[port1-1];
721 u16 portstatus, portchange;
723 portstatus = portchange = 0;
724 status = hub_port_status(hub, port1, &portstatus, &portchange);
725 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
726 dev_dbg(hub->intfdev,
727 "port %d: status %04x change %04x\n",
728 port1, portstatus, portchange);
730 /* After anything other than HUB_RESUME (i.e., initialization
731 * or any sort of reset), every port should be disabled.
732 * Unconnected ports should likewise be disabled (paranoia),
733 * and so should ports for which we have no usb_device.
735 if ((portstatus & USB_PORT_STAT_ENABLE) && (
736 type != HUB_RESUME ||
737 !(portstatus & USB_PORT_STAT_CONNECTION) ||
739 udev->state == USB_STATE_NOTATTACHED)) {
740 clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
741 portstatus &= ~USB_PORT_STAT_ENABLE;
744 /* Clear status-change flags; we'll debounce later */
745 if (portchange & USB_PORT_STAT_C_CONNECTION) {
746 need_debounce_delay = true;
747 clear_port_feature(hub->hdev, port1,
748 USB_PORT_FEAT_C_CONNECTION);
750 if (portchange & USB_PORT_STAT_C_ENABLE) {
751 need_debounce_delay = true;
752 clear_port_feature(hub->hdev, port1,
753 USB_PORT_FEAT_C_ENABLE);
756 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
757 /* Tell khubd to disconnect the device or
758 * check for a new connection
760 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
761 set_bit(port1, hub->change_bits);
763 } else if (portstatus & USB_PORT_STAT_ENABLE) {
764 /* The power session apparently survived the resume.
765 * If there was an overcurrent or suspend change
766 * (i.e., remote wakeup request), have khubd
770 set_bit(port1, hub->change_bits);
772 } else if (udev->persist_enabled) {
774 udev->reset_resume = 1;
776 set_bit(port1, hub->change_bits);
779 /* The power session is gone; tell khubd */
780 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
781 set_bit(port1, hub->change_bits);
785 /* If no port-status-change flags were set, we don't need any
786 * debouncing. If flags were set we can try to debounce the
787 * ports all at once right now, instead of letting khubd do them
788 * one at a time later on.
790 * If any port-status changes do occur during this delay, khubd
791 * will see them later and handle them normally.
793 if (need_debounce_delay) {
794 delay = HUB_DEBOUNCE_STABLE;
796 /* Don't do a long sleep inside a workqueue routine */
797 if (type == HUB_INIT2) {
798 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
799 schedule_delayed_work(&hub->init_work,
800 msecs_to_jiffies(delay));
801 return; /* Continues at init3: below */
809 status = usb_submit_urb(hub->urb, GFP_NOIO);
811 dev_err(hub->intfdev, "activate --> %d\n", status);
812 if (hub->has_indicators && blinkenlights)
813 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
815 /* Scan all ports that need attention */
819 /* Implement the continuations for the delays above */
820 static void hub_init_func2(struct work_struct *ws)
822 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
824 hub_activate(hub, HUB_INIT2);
827 static void hub_init_func3(struct work_struct *ws)
829 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
831 hub_activate(hub, HUB_INIT3);
834 enum hub_quiescing_type {
835 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
838 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
840 struct usb_device *hdev = hub->hdev;
843 cancel_delayed_work_sync(&hub->init_work);
845 /* khubd and related activity won't re-trigger */
848 if (type != HUB_SUSPEND) {
849 /* Disconnect all the children */
850 for (i = 0; i < hdev->maxchild; ++i) {
851 if (hdev->children[i])
852 usb_disconnect(&hdev->children[i]);
856 /* Stop khubd and related activity */
857 usb_kill_urb(hub->urb);
858 if (hub->has_indicators)
859 cancel_delayed_work_sync(&hub->leds);
861 cancel_work_sync(&hub->tt.clear_work);
864 /* caller has locked the hub device */
865 static int hub_pre_reset(struct usb_interface *intf)
867 struct usb_hub *hub = usb_get_intfdata(intf);
869 hub_quiesce(hub, HUB_PRE_RESET);
873 /* caller has locked the hub device */
874 static int hub_post_reset(struct usb_interface *intf)
876 struct usb_hub *hub = usb_get_intfdata(intf);
878 hub_activate(hub, HUB_POST_RESET);
882 static int hub_configure(struct usb_hub *hub,
883 struct usb_endpoint_descriptor *endpoint)
886 struct usb_device *hdev = hub->hdev;
887 struct device *hub_dev = hub->intfdev;
888 u16 hubstatus, hubchange;
889 u16 wHubCharacteristics;
892 char *message = "out of memory";
894 hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
901 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
906 mutex_init(&hub->status_mutex);
908 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
909 if (!hub->descriptor) {
914 /* Request the entire hub descriptor.
915 * hub->descriptor can handle USB_MAXCHILDREN ports,
916 * but the hub can/will return fewer bytes here.
918 ret = get_hub_descriptor(hdev, hub->descriptor,
919 sizeof(*hub->descriptor));
921 message = "can't read hub descriptor";
923 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
924 message = "hub has too many ports!";
929 hdev->maxchild = hub->descriptor->bNbrPorts;
930 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
931 (hdev->maxchild == 1) ? "" : "s");
933 hub->port_owners = kzalloc(hdev->maxchild * sizeof(void *), GFP_KERNEL);
934 if (!hub->port_owners) {
939 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
941 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
943 char portstr [USB_MAXCHILDREN + 1];
945 for (i = 0; i < hdev->maxchild; i++)
946 portstr[i] = hub->descriptor->DeviceRemovable
947 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
949 portstr[hdev->maxchild] = 0;
950 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
952 dev_dbg(hub_dev, "standalone hub\n");
954 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
956 dev_dbg(hub_dev, "ganged power switching\n");
959 dev_dbg(hub_dev, "individual port power switching\n");
963 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
967 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
969 dev_dbg(hub_dev, "global over-current protection\n");
972 dev_dbg(hub_dev, "individual port over-current protection\n");
976 dev_dbg(hub_dev, "no over-current protection\n");
980 spin_lock_init (&hub->tt.lock);
981 INIT_LIST_HEAD (&hub->tt.clear_list);
982 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
983 switch (hdev->descriptor.bDeviceProtocol) {
987 dev_dbg(hub_dev, "Single TT\n");
991 ret = usb_set_interface(hdev, 0, 1);
993 dev_dbg(hub_dev, "TT per port\n");
996 dev_err(hub_dev, "Using single TT (err %d)\n",
1001 /* USB 3.0 hubs don't have a TT */
1004 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1005 hdev->descriptor.bDeviceProtocol);
1009 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1010 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1011 case HUB_TTTT_8_BITS:
1012 if (hdev->descriptor.bDeviceProtocol != 0) {
1013 hub->tt.think_time = 666;
1014 dev_dbg(hub_dev, "TT requires at most %d "
1015 "FS bit times (%d ns)\n",
1016 8, hub->tt.think_time);
1019 case HUB_TTTT_16_BITS:
1020 hub->tt.think_time = 666 * 2;
1021 dev_dbg(hub_dev, "TT requires at most %d "
1022 "FS bit times (%d ns)\n",
1023 16, hub->tt.think_time);
1025 case HUB_TTTT_24_BITS:
1026 hub->tt.think_time = 666 * 3;
1027 dev_dbg(hub_dev, "TT requires at most %d "
1028 "FS bit times (%d ns)\n",
1029 24, hub->tt.think_time);
1031 case HUB_TTTT_32_BITS:
1032 hub->tt.think_time = 666 * 4;
1033 dev_dbg(hub_dev, "TT requires at most %d "
1034 "FS bit times (%d ns)\n",
1035 32, hub->tt.think_time);
1039 /* probe() zeroes hub->indicator[] */
1040 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1041 hub->has_indicators = 1;
1042 dev_dbg(hub_dev, "Port indicators are supported\n");
1045 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1046 hub->descriptor->bPwrOn2PwrGood * 2);
1048 /* power budgeting mostly matters with bus-powered hubs,
1049 * and battery-powered root hubs (may provide just 8 mA).
1051 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1053 message = "can't get hub status";
1056 le16_to_cpus(&hubstatus);
1057 if (hdev == hdev->bus->root_hub) {
1058 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
1059 hub->mA_per_port = 500;
1061 hub->mA_per_port = hdev->bus_mA;
1062 hub->limited_power = 1;
1064 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1065 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1066 hub->descriptor->bHubContrCurrent);
1067 hub->limited_power = 1;
1068 if (hdev->maxchild > 0) {
1069 int remaining = hdev->bus_mA -
1070 hub->descriptor->bHubContrCurrent;
1072 if (remaining < hdev->maxchild * 100)
1074 "insufficient power available "
1075 "to use all downstream ports\n");
1076 hub->mA_per_port = 100; /* 7.2.1.1 */
1078 } else { /* Self-powered external hub */
1079 /* FIXME: What about battery-powered external hubs that
1080 * provide less current per port? */
1081 hub->mA_per_port = 500;
1083 if (hub->mA_per_port < 500)
1084 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1087 /* Update the HCD's internal representation of this hub before khubd
1088 * starts getting port status changes for devices under the hub.
1090 hcd = bus_to_hcd(hdev->bus);
1091 if (hcd->driver->update_hub_device) {
1092 ret = hcd->driver->update_hub_device(hcd, hdev,
1093 &hub->tt, GFP_KERNEL);
1095 message = "can't update HCD hub info";
1100 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1102 message = "can't get hub status";
1106 /* local power status reports aren't always correct */
1107 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1108 dev_dbg(hub_dev, "local power source is %s\n",
1109 (hubstatus & HUB_STATUS_LOCAL_POWER)
1110 ? "lost (inactive)" : "good");
1112 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1113 dev_dbg(hub_dev, "%sover-current condition exists\n",
1114 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1116 /* set up the interrupt endpoint
1117 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1118 * bytes as USB2.0[11.12.3] says because some hubs are known
1119 * to send more data (and thus cause overflow). For root hubs,
1120 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1121 * to be big enough for at least USB_MAXCHILDREN ports. */
1122 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1123 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1125 if (maxp > sizeof(*hub->buffer))
1126 maxp = sizeof(*hub->buffer);
1128 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1134 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1135 hub, endpoint->bInterval);
1136 hub->urb->transfer_dma = hub->buffer_dma;
1137 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1139 /* maybe cycle the hub leds */
1140 if (hub->has_indicators && blinkenlights)
1141 hub->indicator [0] = INDICATOR_CYCLE;
1143 hub_activate(hub, HUB_INIT);
1147 dev_err (hub_dev, "config failed, %s (err %d)\n",
1149 /* hub_disconnect() frees urb and descriptor */
1153 static void hub_release(struct kref *kref)
1155 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1157 usb_put_intf(to_usb_interface(hub->intfdev));
1161 static unsigned highspeed_hubs;
1163 static void hub_disconnect(struct usb_interface *intf)
1165 struct usb_hub *hub = usb_get_intfdata (intf);
1167 /* Take the hub off the event list and don't let it be added again */
1168 spin_lock_irq(&hub_event_lock);
1169 list_del_init(&hub->event_list);
1170 hub->disconnected = 1;
1171 spin_unlock_irq(&hub_event_lock);
1173 /* Disconnect all children and quiesce the hub */
1175 hub_quiesce(hub, HUB_DISCONNECT);
1177 usb_set_intfdata (intf, NULL);
1178 hub->hdev->maxchild = 0;
1180 if (hub->hdev->speed == USB_SPEED_HIGH)
1183 usb_free_urb(hub->urb);
1184 kfree(hub->port_owners);
1185 kfree(hub->descriptor);
1187 usb_buffer_free(hub->hdev, sizeof(*hub->buffer), hub->buffer,
1190 kref_put(&hub->kref, hub_release);
1192 struct usb_hub *g_root_hub20 = NULL;
1193 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1195 struct usb_host_interface *desc;
1196 struct usb_endpoint_descriptor *endpoint;
1197 struct usb_device *hdev;
1198 struct usb_hub *hub;
1200 desc = intf->cur_altsetting;
1201 hdev = interface_to_usbdev(intf);
1203 if (hdev->level == MAX_TOPO_LEVEL) {
1205 "Unsupported bus topology: hub nested too deep\n");
1209 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1211 dev_warn(&intf->dev, "ignoring external hub\n");
1216 /* Some hubs have a subclass of 1, which AFAICT according to the */
1217 /* specs is not defined, but it works */
1218 if ((desc->desc.bInterfaceSubClass != 0) &&
1219 (desc->desc.bInterfaceSubClass != 1)) {
1221 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1225 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1226 if (desc->desc.bNumEndpoints != 1)
1227 goto descriptor_error;
1229 endpoint = &desc->endpoint[0].desc;
1231 /* If it's not an interrupt in endpoint, we'd better punt! */
1232 if (!usb_endpoint_is_int_in(endpoint))
1233 goto descriptor_error;
1235 /* We found a hub */
1236 dev_info (&intf->dev, "USB hub found\n");
1238 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1240 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1247 kref_init(&hub->kref);
1248 INIT_LIST_HEAD(&hub->event_list);
1249 hub->intfdev = &intf->dev;
1251 INIT_DELAYED_WORK(&hub->leds, led_work);
1252 INIT_DELAYED_WORK(&hub->init_work, NULL);
1255 usb_set_intfdata (intf, hub);
1256 intf->needs_remote_wakeup = 1;
1258 if (hdev->speed == USB_SPEED_HIGH)
1261 if (hub_configure(hub, endpoint) >= 0)
1264 hub_disconnect (intf);
1269 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1271 struct usb_device *hdev = interface_to_usbdev (intf);
1273 /* assert ifno == 0 (part of hub spec) */
1275 case USBDEVFS_HUB_PORTINFO: {
1276 struct usbdevfs_hub_portinfo *info = user_data;
1279 spin_lock_irq(&device_state_lock);
1280 if (hdev->devnum <= 0)
1283 info->nports = hdev->maxchild;
1284 for (i = 0; i < info->nports; i++) {
1285 if (hdev->children[i] == NULL)
1289 hdev->children[i]->devnum;
1292 spin_unlock_irq(&device_state_lock);
1294 return info->nports + 1;
1303 * Allow user programs to claim ports on a hub. When a device is attached
1304 * to one of these "claimed" ports, the program will "own" the device.
1306 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1309 if (hdev->state == USB_STATE_NOTATTACHED)
1311 if (port1 == 0 || port1 > hdev->maxchild)
1314 /* This assumes that devices not managed by the hub driver
1315 * will always have maxchild equal to 0.
1317 *ppowner = &(hdev_to_hub(hdev)->port_owners[port1 - 1]);
1321 /* In the following three functions, the caller must hold hdev's lock */
1322 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1, void *owner)
1327 rc = find_port_owner(hdev, port1, &powner);
1336 int usb_hub_release_port(struct usb_device *hdev, unsigned port1, void *owner)
1341 rc = find_port_owner(hdev, port1, &powner);
1344 if (*powner != owner)
1350 void usb_hub_release_all_ports(struct usb_device *hdev, void *owner)
1355 n = find_port_owner(hdev, 1, &powner);
1357 for (; n < hdev->maxchild; (++n, ++powner)) {
1358 if (*powner == owner)
1364 /* The caller must hold udev's lock */
1365 bool usb_device_is_owned(struct usb_device *udev)
1367 struct usb_hub *hub;
1369 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1371 hub = hdev_to_hub(udev->parent);
1372 return !!hub->port_owners[udev->portnum - 1];
1376 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1380 for (i = 0; i < udev->maxchild; ++i) {
1381 if (udev->children[i])
1382 recursively_mark_NOTATTACHED(udev->children[i]);
1384 if (udev->state == USB_STATE_SUSPENDED) {
1385 udev->discon_suspended = 1;
1386 udev->active_duration -= jiffies;
1388 udev->state = USB_STATE_NOTATTACHED;
1392 * usb_set_device_state - change a device's current state (usbcore, hcds)
1393 * @udev: pointer to device whose state should be changed
1394 * @new_state: new state value to be stored
1396 * udev->state is _not_ fully protected by the device lock. Although
1397 * most transitions are made only while holding the lock, the state can
1398 * can change to USB_STATE_NOTATTACHED at almost any time. This
1399 * is so that devices can be marked as disconnected as soon as possible,
1400 * without having to wait for any semaphores to be released. As a result,
1401 * all changes to any device's state must be protected by the
1402 * device_state_lock spinlock.
1404 * Once a device has been added to the device tree, all changes to its state
1405 * should be made using this routine. The state should _not_ be set directly.
1407 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1408 * Otherwise udev->state is set to new_state, and if new_state is
1409 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1410 * to USB_STATE_NOTATTACHED.
1412 void usb_set_device_state(struct usb_device *udev,
1413 enum usb_device_state new_state)
1415 unsigned long flags;
1417 spin_lock_irqsave(&device_state_lock, flags);
1418 if (udev->state == USB_STATE_NOTATTACHED)
1420 else if (new_state != USB_STATE_NOTATTACHED) {
1422 /* root hub wakeup capabilities are managed out-of-band
1423 * and may involve silicon errata ... ignore them here.
1426 if (udev->state == USB_STATE_SUSPENDED
1427 || new_state == USB_STATE_SUSPENDED)
1428 ; /* No change to wakeup settings */
1429 else if (new_state == USB_STATE_CONFIGURED)
1430 device_set_wakeup_capable(&udev->dev,
1431 (udev->actconfig->desc.bmAttributes
1432 & USB_CONFIG_ATT_WAKEUP));
1434 device_set_wakeup_capable(&udev->dev, 0);
1436 if (udev->state == USB_STATE_SUSPENDED &&
1437 new_state != USB_STATE_SUSPENDED)
1438 udev->active_duration -= jiffies;
1439 else if (new_state == USB_STATE_SUSPENDED &&
1440 udev->state != USB_STATE_SUSPENDED)
1441 udev->active_duration += jiffies;
1442 udev->state = new_state;
1444 recursively_mark_NOTATTACHED(udev);
1445 spin_unlock_irqrestore(&device_state_lock, flags);
1447 EXPORT_SYMBOL_GPL(usb_set_device_state);
1450 * WUSB devices are simple: they have no hubs behind, so the mapping
1451 * device <-> virtual port number becomes 1:1. Why? to simplify the
1452 * life of the device connection logic in
1453 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1454 * handshake we need to assign a temporary address in the unauthorized
1455 * space. For simplicity we use the first virtual port number found to
1456 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1457 * and that becomes it's address [X < 128] or its unauthorized address
1460 * We add 1 as an offset to the one-based USB-stack port number
1461 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1462 * 0 is reserved by USB for default address; (b) Linux's USB stack
1463 * uses always #1 for the root hub of the controller. So USB stack's
1464 * port #1, which is wusb virtual-port #0 has address #2.
1466 * Devices connected under xHCI are not as simple. The host controller
1467 * supports virtualization, so the hardware assigns device addresses and
1468 * the HCD must setup data structures before issuing a set address
1469 * command to the hardware.
1471 static void choose_address(struct usb_device *udev)
1474 struct usb_bus *bus = udev->bus;
1476 /* If khubd ever becomes multithreaded, this will need a lock */
1478 devnum = udev->portnum + 1;
1479 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1481 /* Try to allocate the next devnum beginning at
1482 * bus->devnum_next. */
1483 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1486 devnum = find_next_zero_bit(bus->devmap.devicemap,
1488 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1491 set_bit(devnum, bus->devmap.devicemap);
1492 udev->devnum = devnum;
1496 static void release_address(struct usb_device *udev)
1498 if (udev->devnum > 0) {
1499 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1504 static void update_address(struct usb_device *udev, int devnum)
1506 /* The address for a WUSB device is managed by wusbcore. */
1508 udev->devnum = devnum;
1511 #ifdef CONFIG_USB_SUSPEND
1513 static void usb_stop_pm(struct usb_device *udev)
1515 /* Synchronize with the ksuspend thread to prevent any more
1516 * autosuspend requests from being submitted, and decrement
1517 * the parent's count of unsuspended children.
1520 if (udev->parent && !udev->discon_suspended)
1521 usb_autosuspend_device(udev->parent);
1522 usb_pm_unlock(udev);
1524 /* Stop any autosuspend or autoresume requests already submitted */
1525 cancel_delayed_work_sync(&udev->autosuspend);
1526 cancel_work_sync(&udev->autoresume);
1531 static inline void usb_stop_pm(struct usb_device *udev)
1536 static void hub_free_dev(struct usb_device *udev)
1538 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1540 /* Root hubs aren't real devices, so don't free HCD resources */
1541 if (hcd->driver->free_dev && udev->parent)
1542 hcd->driver->free_dev(hcd, udev);
1546 * usb_disconnect - disconnect a device (usbcore-internal)
1547 * @pdev: pointer to device being disconnected
1548 * Context: !in_interrupt ()
1550 * Something got disconnected. Get rid of it and all of its children.
1552 * If *pdev is a normal device then the parent hub must already be locked.
1553 * If *pdev is a root hub then this routine will acquire the
1554 * usb_bus_list_lock on behalf of the caller.
1556 * Only hub drivers (including virtual root hub drivers for host
1557 * controllers) should ever call this.
1559 * This call is synchronous, and may not be used in an interrupt context.
1561 void usb_disconnect(struct usb_device **pdev)
1563 struct usb_device *udev = *pdev;
1567 pr_debug ("%s nodev\n", __func__);
1571 /* mark the device as inactive, so any further urb submissions for
1572 * this device (and any of its children) will fail immediately.
1573 * this quiesces everyting except pending urbs.
1575 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1576 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1578 usb_lock_device(udev);
1580 /* Free up all the children before we remove this device */
1581 for (i = 0; i < USB_MAXCHILDREN; i++) {
1582 if (udev->children[i])
1583 usb_disconnect(&udev->children[i]);
1586 /* deallocate hcd/hardware state ... nuking all pending urbs and
1587 * cleaning up all state associated with the current configuration
1588 * so that the hardware is now fully quiesced.
1590 dev_dbg (&udev->dev, "unregistering device\n");
1591 usb_disable_device(udev, 0);
1592 usb_hcd_synchronize_unlinks(udev);
1594 usb_remove_ep_devs(&udev->ep0);
1595 usb_unlock_device(udev);
1597 /* Unregister the device. The device driver is responsible
1598 * for de-configuring the device and invoking the remove-device
1599 * notifier chain (used by usbfs and possibly others).
1601 device_del(&udev->dev);
1603 /* Free the device number and delete the parent's children[]
1604 * (or root_hub) pointer.
1606 release_address(udev);
1608 /* Avoid races with recursively_mark_NOTATTACHED() */
1609 spin_lock_irq(&device_state_lock);
1611 spin_unlock_irq(&device_state_lock);
1618 put_device(&udev->dev);
1621 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1622 static void show_string(struct usb_device *udev, char *id, char *string)
1626 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1629 static void announce_device(struct usb_device *udev)
1631 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1632 le16_to_cpu(udev->descriptor.idVendor),
1633 le16_to_cpu(udev->descriptor.idProduct));
1634 dev_info(&udev->dev,
1635 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1636 udev->descriptor.iManufacturer,
1637 udev->descriptor.iProduct,
1638 udev->descriptor.iSerialNumber);
1639 show_string(udev, "Product", udev->product);
1640 show_string(udev, "Manufacturer", udev->manufacturer);
1641 show_string(udev, "SerialNumber", udev->serial);
1644 static inline void announce_device(struct usb_device *udev) { }
1647 #ifdef CONFIG_USB_OTG
1648 #include "otg_whitelist.h"
1652 * usb_enumerate_device_otg - FIXME (usbcore-internal)
1653 * @udev: newly addressed device (in ADDRESS state)
1655 * Finish enumeration for On-The-Go devices
1657 static int usb_enumerate_device_otg(struct usb_device *udev)
1661 #ifdef CONFIG_USB_OTG
1663 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1664 * to wake us after we've powered off VBUS; and HNP, switching roles
1665 * "host" to "peripheral". The OTG descriptor helps figure this out.
1667 if (!udev->bus->is_b_host
1669 && udev->parent == udev->bus->root_hub) {
1670 struct usb_otg_descriptor *desc = 0;
1671 struct usb_bus *bus = udev->bus;
1673 /* descriptor may appear anywhere in config */
1674 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1675 le16_to_cpu(udev->config[0].desc.wTotalLength),
1676 USB_DT_OTG, (void **) &desc) == 0) {
1677 if (desc->bmAttributes & USB_OTG_HNP) {
1678 unsigned port1 = udev->portnum;
1680 dev_info(&udev->dev,
1681 "Dual-Role OTG device on %sHNP port\n",
1682 (port1 == bus->otg_port)
1685 /* enable HNP before suspend, it's simpler */
1686 if (port1 == bus->otg_port)
1687 bus->b_hnp_enable = 1;
1688 err = usb_control_msg(udev,
1689 usb_sndctrlpipe(udev, 0),
1690 USB_REQ_SET_FEATURE, 0,
1692 ? USB_DEVICE_B_HNP_ENABLE
1693 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1694 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1696 /* OTG MESSAGE: report errors here,
1697 * customize to match your product.
1699 dev_info(&udev->dev,
1700 "can't set HNP mode: %d\n",
1702 bus->b_hnp_enable = 0;
1708 if (!is_targeted(udev)) {
1710 /* Maybe it can talk to us, though we can't talk to it.
1711 * (Includes HNP test device.)
1713 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1714 err = usb_port_suspend(udev, PMSG_SUSPEND);
1716 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1728 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
1729 * @udev: newly addressed device (in ADDRESS state)
1731 * This is only called by usb_new_device() and usb_authorize_device()
1732 * and FIXME -- all comments that apply to them apply here wrt to
1735 * If the device is WUSB and not authorized, we don't attempt to read
1736 * the string descriptors, as they will be errored out by the device
1737 * until it has been authorized.
1739 static int usb_enumerate_device(struct usb_device *udev)
1743 if (udev->config == NULL) {
1744 err = usb_get_configuration(udev);
1746 dev_err(&udev->dev, "can't read configurations, error %d\n",
1751 if (udev->wusb == 1 && udev->authorized == 0) {
1752 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1753 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1754 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1757 /* read the standard strings and cache them if present */
1758 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1759 udev->manufacturer = usb_cache_string(udev,
1760 udev->descriptor.iManufacturer);
1761 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1763 err = usb_enumerate_device_otg(udev);
1770 * usb_new_device - perform initial device setup (usbcore-internal)
1771 * @udev: newly addressed device (in ADDRESS state)
1773 * This is called with devices which have been detected but not fully
1774 * enumerated. The device descriptor is available, but not descriptors
1775 * for any device configuration. The caller must have locked either
1776 * the parent hub (if udev is a normal device) or else the
1777 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1778 * udev has already been installed, but udev is not yet visible through
1779 * sysfs or other filesystem code.
1781 * It will return if the device is configured properly or not. Zero if
1782 * the interface was registered with the driver core; else a negative
1785 * This call is synchronous, and may not be used in an interrupt context.
1787 * Only the hub driver or root-hub registrar should ever call this.
1789 int usb_new_device(struct usb_device *udev)
1794 /* Increment the parent's count of unsuspended children */
1795 usb_autoresume_device(udev->parent);
1797 /* Initialize non-root-hub device wakeup to disabled;
1798 * device (un)configuration controls wakeup capable
1799 * sysfs power/wakeup controls wakeup enabled/disabled
1801 device_init_wakeup(&udev->dev, 0);
1804 err = usb_enumerate_device(udev); /* Read descriptors */
1807 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
1808 udev->devnum, udev->bus->busnum,
1809 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1810 /* export the usbdev device-node for libusb */
1811 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1812 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1814 /* Tell the world! */
1815 announce_device(udev);
1817 /* Register the device. The device driver is responsible
1818 * for configuring the device and invoking the add-device
1819 * notifier chain (used by usbfs and possibly others).
1821 err = device_add(&udev->dev);
1823 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1827 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
1831 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1838 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1839 * @usb_dev: USB device
1841 * Move the USB device to a very basic state where interfaces are disabled
1842 * and the device is in fact unconfigured and unusable.
1844 * We share a lock (that we have) with device_del(), so we need to
1847 int usb_deauthorize_device(struct usb_device *usb_dev)
1849 usb_lock_device(usb_dev);
1850 if (usb_dev->authorized == 0)
1851 goto out_unauthorized;
1853 usb_dev->authorized = 0;
1854 usb_set_configuration(usb_dev, -1);
1856 kfree(usb_dev->product);
1857 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1858 kfree(usb_dev->manufacturer);
1859 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1860 kfree(usb_dev->serial);
1861 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1863 usb_destroy_configuration(usb_dev);
1864 usb_dev->descriptor.bNumConfigurations = 0;
1867 usb_unlock_device(usb_dev);
1872 int usb_authorize_device(struct usb_device *usb_dev)
1876 usb_lock_device(usb_dev);
1877 if (usb_dev->authorized == 1)
1878 goto out_authorized;
1880 result = usb_autoresume_device(usb_dev);
1882 dev_err(&usb_dev->dev,
1883 "can't autoresume for authorization: %d\n", result);
1884 goto error_autoresume;
1886 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
1888 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
1889 "authorization: %d\n", result);
1890 goto error_device_descriptor;
1893 kfree(usb_dev->product);
1894 usb_dev->product = NULL;
1895 kfree(usb_dev->manufacturer);
1896 usb_dev->manufacturer = NULL;
1897 kfree(usb_dev->serial);
1898 usb_dev->serial = NULL;
1900 usb_dev->authorized = 1;
1901 result = usb_enumerate_device(usb_dev);
1903 goto error_enumerate;
1904 /* Choose and set the configuration. This registers the interfaces
1905 * with the driver core and lets interface drivers bind to them.
1907 c = usb_choose_configuration(usb_dev);
1909 result = usb_set_configuration(usb_dev, c);
1911 dev_err(&usb_dev->dev,
1912 "can't set config #%d, error %d\n", c, result);
1913 /* This need not be fatal. The user can try to
1914 * set other configurations. */
1917 dev_info(&usb_dev->dev, "authorized to connect\n");
1920 error_device_descriptor:
1921 usb_autosuspend_device(usb_dev);
1924 usb_unlock_device(usb_dev); // complements locktree
1929 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1930 static unsigned hub_is_wusb(struct usb_hub *hub)
1932 struct usb_hcd *hcd;
1933 if (hub->hdev->parent != NULL) /* not a root hub? */
1935 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
1936 return hcd->wireless;
1940 #define PORT_RESET_TRIES 5
1941 #define SET_ADDRESS_TRIES 2
1942 #define GET_DESCRIPTOR_TRIES 2
1943 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1944 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1946 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1947 #define HUB_SHORT_RESET_TIME 10
1948 #define HUB_LONG_RESET_TIME 200
1949 #define HUB_RESET_TIMEOUT 500
1951 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1952 struct usb_device *udev, unsigned int delay)
1954 int delay_time, ret;
1958 for (delay_time = 0;
1959 delay_time < HUB_RESET_TIMEOUT;
1960 delay_time += delay) {
1961 /* wait to give the device a chance to reset */
1964 /* read and decode port status */
1965 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1969 /* Device went away? */
1970 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1973 /* bomb out completely if the connection bounced */
1974 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1977 /* if we`ve finished resetting, then break out of the loop */
1978 if (!(portstatus & USB_PORT_STAT_RESET) &&
1979 (portstatus & USB_PORT_STAT_ENABLE)) {
1980 if (hub_is_wusb(hub))
1981 udev->speed = USB_SPEED_VARIABLE;
1982 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1983 udev->speed = USB_SPEED_HIGH;
1984 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1985 udev->speed = USB_SPEED_LOW;
1987 udev->speed = USB_SPEED_FULL;
1991 /* switch to the long delay after two short delay failures */
1992 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1993 delay = HUB_LONG_RESET_TIME;
1995 dev_dbg (hub->intfdev,
1996 "port %d not reset yet, waiting %dms\n",
2003 static int hub_port_reset(struct usb_hub *hub, int port1,
2004 struct usb_device *udev, unsigned int delay)
2008 /* Block EHCI CF initialization during the port reset.
2009 * Some companion controllers don't like it when they mix.
2011 down_read(&ehci_cf_port_reset_rwsem);
2013 /* Reset the port */
2014 for (i = 0; i < PORT_RESET_TRIES; i++) {
2015 status = set_port_feature(hub->hdev,
2016 port1, USB_PORT_FEAT_RESET);
2018 dev_err(hub->intfdev,
2019 "cannot reset port %d (err = %d)\n",
2022 status = hub_port_wait_reset(hub, port1, udev, delay);
2023 if (status && status != -ENOTCONN)
2024 dev_dbg(hub->intfdev,
2025 "port_wait_reset: err = %d\n",
2029 /* return on disconnect or reset */
2032 /* TRSTRCY = 10 ms; plus some extra */
2034 update_address(udev, 0);
2038 clear_port_feature(hub->hdev,
2039 port1, USB_PORT_FEAT_C_RESET);
2040 /* FIXME need disconnect() for NOTATTACHED device */
2041 usb_set_device_state(udev, status
2042 ? USB_STATE_NOTATTACHED
2043 : USB_STATE_DEFAULT);
2047 dev_dbg (hub->intfdev,
2048 "port %d not enabled, trying reset again...\n",
2050 delay = HUB_LONG_RESET_TIME;
2053 dev_err (hub->intfdev,
2054 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2058 up_read(&ehci_cf_port_reset_rwsem);
2064 #define MASK_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION | \
2065 USB_PORT_STAT_SUSPEND)
2066 #define WANT_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION)
2068 /* Determine whether the device on a port is ready for a normal resume,
2069 * is ready for a reset-resume, or should be disconnected.
2071 static int check_port_resume_type(struct usb_device *udev,
2072 struct usb_hub *hub, int port1,
2073 int status, unsigned portchange, unsigned portstatus)
2075 /* Is the device still present? */
2076 if (status || (portstatus & MASK_BITS) != WANT_BITS) {
2081 /* Can't do a normal resume if the port isn't enabled,
2082 * so try a reset-resume instead.
2084 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2085 if (udev->persist_enabled)
2086 udev->reset_resume = 1;
2092 dev_dbg(hub->intfdev,
2093 "port %d status %04x.%04x after resume, %d\n",
2094 port1, portchange, portstatus, status);
2095 } else if (udev->reset_resume) {
2097 /* Late port handoff can set status-change bits */
2098 if (portchange & USB_PORT_STAT_C_CONNECTION)
2099 clear_port_feature(hub->hdev, port1,
2100 USB_PORT_FEAT_C_CONNECTION);
2101 if (portchange & USB_PORT_STAT_C_ENABLE)
2102 clear_port_feature(hub->hdev, port1,
2103 USB_PORT_FEAT_C_ENABLE);
2109 #ifdef CONFIG_USB_SUSPEND
2112 * usb_port_suspend - suspend a usb device's upstream port
2113 * @udev: device that's no longer in active use, not a root hub
2114 * Context: must be able to sleep; device not locked; pm locks held
2116 * Suspends a USB device that isn't in active use, conserving power.
2117 * Devices may wake out of a suspend, if anything important happens,
2118 * using the remote wakeup mechanism. They may also be taken out of
2119 * suspend by the host, using usb_port_resume(). It's also routine
2120 * to disconnect devices while they are suspended.
2122 * This only affects the USB hardware for a device; its interfaces
2123 * (and, for hubs, child devices) must already have been suspended.
2125 * Selective port suspend reduces power; most suspended devices draw
2126 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2127 * All devices below the suspended port are also suspended.
2129 * Devices leave suspend state when the host wakes them up. Some devices
2130 * also support "remote wakeup", where the device can activate the USB
2131 * tree above them to deliver data, such as a keypress or packet. In
2132 * some cases, this wakes the USB host.
2134 * Suspending OTG devices may trigger HNP, if that's been enabled
2135 * between a pair of dual-role devices. That will change roles, such
2136 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2138 * Devices on USB hub ports have only one "suspend" state, corresponding
2139 * to ACPI D2, "may cause the device to lose some context".
2140 * State transitions include:
2142 * - suspend, resume ... when the VBUS power link stays live
2143 * - suspend, disconnect ... VBUS lost
2145 * Once VBUS drop breaks the circuit, the port it's using has to go through
2146 * normal re-enumeration procedures, starting with enabling VBUS power.
2147 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2148 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2149 * timer, no SRP, no requests through sysfs.
2151 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2152 * the root hub for their bus goes into global suspend ... so we don't
2153 * (falsely) update the device power state to say it suspended.
2155 * Returns 0 on success, else negative errno.
2157 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2159 struct usb_hub *hub = hdev_to_hub(udev->parent);
2160 int port1 = udev->portnum;
2163 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
2165 /* enable remote wakeup when appropriate; this lets the device
2166 * wake up the upstream hub (including maybe the root hub).
2168 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2169 * we don't explicitly enable it here.
2171 if (udev->do_remote_wakeup) {
2172 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2173 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2174 USB_DEVICE_REMOTE_WAKEUP, 0,
2176 USB_CTRL_SET_TIMEOUT);
2178 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2183 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
2185 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
2187 /* paranoia: "should not happen" */
2188 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2189 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2190 USB_DEVICE_REMOTE_WAKEUP, 0,
2192 USB_CTRL_SET_TIMEOUT);
2194 /* device has up to 10 msec to fully suspend */
2195 dev_dbg(&udev->dev, "usb %ssuspend\n",
2196 (msg.event & PM_EVENT_AUTO ? "auto-" : ""));
2197 usb_set_device_state(udev, USB_STATE_SUSPENDED);
2204 * If the USB "suspend" state is in use (rather than "global suspend"),
2205 * many devices will be individually taken out of suspend state using
2206 * special "resume" signaling. This routine kicks in shortly after
2207 * hardware resume signaling is finished, either because of selective
2208 * resume (by host) or remote wakeup (by device) ... now see what changed
2209 * in the tree that's rooted at this device.
2211 * If @udev->reset_resume is set then the device is reset before the
2212 * status check is done.
2214 static int finish_port_resume(struct usb_device *udev)
2219 /* caller owns the udev device lock */
2220 dev_dbg(&udev->dev, "%s\n",
2221 udev->reset_resume ? "finish reset-resume" : "finish resume");
2223 /* usb ch9 identifies four variants of SUSPENDED, based on what
2224 * state the device resumes to. Linux currently won't see the
2225 * first two on the host side; they'd be inside hub_port_init()
2226 * during many timeouts, but khubd can't suspend until later.
2228 usb_set_device_state(udev, udev->actconfig
2229 ? USB_STATE_CONFIGURED
2230 : USB_STATE_ADDRESS);
2232 /* 10.5.4.5 says not to reset a suspended port if the attached
2233 * device is enabled for remote wakeup. Hence the reset
2234 * operation is carried out here, after the port has been
2237 if (udev->reset_resume)
2239 status = usb_reset_and_verify_device(udev);
2241 /* 10.5.4.5 says be sure devices in the tree are still there.
2242 * For now let's assume the device didn't go crazy on resume,
2243 * and device drivers will know about any resume quirks.
2247 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
2249 status = (status > 0 ? 0 : -ENODEV);
2251 /* If a normal resume failed, try doing a reset-resume */
2252 if (status && !udev->reset_resume && udev->persist_enabled) {
2253 dev_dbg(&udev->dev, "retry with reset-resume\n");
2254 udev->reset_resume = 1;
2255 goto retry_reset_resume;
2260 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
2262 } else if (udev->actconfig) {
2263 le16_to_cpus(&devstatus);
2264 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
2265 status = usb_control_msg(udev,
2266 usb_sndctrlpipe(udev, 0),
2267 USB_REQ_CLEAR_FEATURE,
2269 USB_DEVICE_REMOTE_WAKEUP, 0,
2271 USB_CTRL_SET_TIMEOUT);
2274 "disable remote wakeup, status %d\n",
2283 * usb_port_resume - re-activate a suspended usb device's upstream port
2284 * @udev: device to re-activate, not a root hub
2285 * Context: must be able to sleep; device not locked; pm locks held
2287 * This will re-activate the suspended device, increasing power usage
2288 * while letting drivers communicate again with its endpoints.
2289 * USB resume explicitly guarantees that the power session between
2290 * the host and the device is the same as it was when the device
2293 * If @udev->reset_resume is set then this routine won't check that the
2294 * port is still enabled. Furthermore, finish_port_resume() above will
2295 * reset @udev. The end result is that a broken power session can be
2296 * recovered and @udev will appear to persist across a loss of VBUS power.
2298 * For example, if a host controller doesn't maintain VBUS suspend current
2299 * during a system sleep or is reset when the system wakes up, all the USB
2300 * power sessions below it will be broken. This is especially troublesome
2301 * for mass-storage devices containing mounted filesystems, since the
2302 * device will appear to have disconnected and all the memory mappings
2303 * to it will be lost. Using the USB_PERSIST facility, the device can be
2304 * made to appear as if it had not disconnected.
2306 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
2307 * every effort to insure that the same device is present after the
2308 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2309 * quite possible for a device to remain unaltered but its media to be
2310 * changed. If the user replaces a flash memory card while the system is
2311 * asleep, he will have only himself to blame when the filesystem on the
2312 * new card is corrupted and the system crashes.
2314 * Returns 0 on success, else negative errno.
2316 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2318 struct usb_hub *hub = hdev_to_hub(udev->parent);
2319 int port1 = udev->portnum;
2321 u16 portchange, portstatus;
2323 /* Skip the initial Clear-Suspend step for a remote wakeup */
2324 status = hub_port_status(hub, port1, &portstatus, &portchange);
2325 if (status == 0 && !(portstatus & USB_PORT_STAT_SUSPEND))
2326 goto SuspendCleared;
2328 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2330 set_bit(port1, hub->busy_bits);
2332 /* see 7.1.7.7; affects power usage, but not budgeting */
2333 status = clear_port_feature(hub->hdev,
2334 port1, USB_PORT_FEAT_SUSPEND);
2336 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
2339 /* drive resume for at least 20 msec */
2340 dev_dbg(&udev->dev, "usb %sresume\n",
2341 (msg.event & PM_EVENT_AUTO ? "auto-" : ""));
2344 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2345 * stop resume signaling. Then finish the resume
2348 status = hub_port_status(hub, port1, &portstatus, &portchange);
2350 /* TRSMRCY = 10 msec */
2356 if (portchange & USB_PORT_STAT_C_SUSPEND)
2357 clear_port_feature(hub->hdev, port1,
2358 USB_PORT_FEAT_C_SUSPEND);
2361 clear_bit(port1, hub->busy_bits);
2363 status = check_port_resume_type(udev,
2364 hub, port1, status, portchange, portstatus);
2366 status = finish_port_resume(udev);
2368 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2369 hub_port_logical_disconnect(hub, port1);
2374 /* caller has locked udev */
2375 static int remote_wakeup(struct usb_device *udev)
2379 if (udev->state == USB_STATE_SUSPENDED) {
2380 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
2381 usb_mark_last_busy(udev);
2382 status = usb_external_resume_device(udev, PMSG_REMOTE_RESUME);
2387 #else /* CONFIG_USB_SUSPEND */
2389 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2391 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2396 /* However we may need to do a reset-resume */
2398 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2400 struct usb_hub *hub = hdev_to_hub(udev->parent);
2401 int port1 = udev->portnum;
2403 u16 portchange, portstatus;
2405 status = hub_port_status(hub, port1, &portstatus, &portchange);
2406 status = check_port_resume_type(udev,
2407 hub, port1, status, portchange, portstatus);
2410 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2411 hub_port_logical_disconnect(hub, port1);
2412 } else if (udev->reset_resume) {
2413 dev_dbg(&udev->dev, "reset-resume\n");
2414 status = usb_reset_and_verify_device(udev);
2419 static inline int remote_wakeup(struct usb_device *udev)
2426 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
2428 struct usb_hub *hub = usb_get_intfdata (intf);
2429 struct usb_device *hdev = hub->hdev;
2432 /* fail if children aren't already suspended */
2433 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2434 struct usb_device *udev;
2436 udev = hdev->children [port1-1];
2437 if (udev && udev->can_submit) {
2438 if (!(msg.event & PM_EVENT_AUTO))
2439 dev_dbg(&intf->dev, "port %d nyet suspended\n",
2445 dev_dbg(&intf->dev, "%s\n", __func__);
2447 /* stop khubd and related activity */
2448 hub_quiesce(hub, HUB_SUSPEND);
2452 static int hub_resume(struct usb_interface *intf)
2454 struct usb_hub *hub = usb_get_intfdata(intf);
2456 dev_dbg(&intf->dev, "%s\n", __func__);
2457 hub_activate(hub, HUB_RESUME);
2461 static int hub_reset_resume(struct usb_interface *intf)
2463 struct usb_hub *hub = usb_get_intfdata(intf);
2465 dev_dbg(&intf->dev, "%s\n", __func__);
2466 hub_activate(hub, HUB_RESET_RESUME);
2471 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2472 * @rhdev: struct usb_device for the root hub
2474 * The USB host controller driver calls this function when its root hub
2475 * is resumed and Vbus power has been interrupted or the controller
2476 * has been reset. The routine marks @rhdev as having lost power.
2477 * When the hub driver is resumed it will take notice and carry out
2478 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2479 * the others will be disconnected.
2481 void usb_root_hub_lost_power(struct usb_device *rhdev)
2483 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
2484 rhdev->reset_resume = 1;
2486 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
2488 #else /* CONFIG_PM */
2490 static inline int remote_wakeup(struct usb_device *udev)
2495 #define hub_suspend NULL
2496 #define hub_resume NULL
2497 #define hub_reset_resume NULL
2501 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2503 * Between connect detection and reset signaling there must be a delay
2504 * of 100ms at least for debounce and power-settling. The corresponding
2505 * timer shall restart whenever the downstream port detects a disconnect.
2507 * Apparently there are some bluetooth and irda-dongles and a number of
2508 * low-speed devices for which this debounce period may last over a second.
2509 * Not covered by the spec - but easy to deal with.
2511 * This implementation uses a 1500ms total debounce timeout; if the
2512 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2513 * every 25ms for transient disconnects. When the port status has been
2514 * unchanged for 100ms it returns the port status.
2516 static int hub_port_debounce(struct usb_hub *hub, int port1)
2519 int total_time, stable_time = 0;
2520 u16 portchange, portstatus;
2521 unsigned connection = 0xffff;
2523 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2524 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2528 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2529 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2530 stable_time += HUB_DEBOUNCE_STEP;
2531 if (stable_time >= HUB_DEBOUNCE_STABLE)
2535 connection = portstatus & USB_PORT_STAT_CONNECTION;
2538 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2539 clear_port_feature(hub->hdev, port1,
2540 USB_PORT_FEAT_C_CONNECTION);
2543 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2545 msleep(HUB_DEBOUNCE_STEP);
2548 dev_dbg (hub->intfdev,
2549 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2550 port1, total_time, stable_time, portstatus);
2552 if (stable_time < HUB_DEBOUNCE_STABLE)
2557 void usb_ep0_reinit(struct usb_device *udev)
2559 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
2560 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
2561 usb_enable_endpoint(udev, &udev->ep0, true);
2563 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
2565 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2566 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2568 static int hub_set_address(struct usb_device *udev, int devnum)
2571 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2574 * The host controller will choose the device address,
2575 * instead of the core having chosen it earlier
2577 if (!hcd->driver->address_device && devnum <= 1)
2579 if (udev->state == USB_STATE_ADDRESS)
2581 if (udev->state != USB_STATE_DEFAULT)
2583 if (hcd->driver->address_device) {
2584 retval = hcd->driver->address_device(hcd, udev);
2586 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2587 USB_REQ_SET_ADDRESS, 0, devnum, 0,
2588 NULL, 0, USB_CTRL_SET_TIMEOUT);
2590 update_address(udev, devnum);
2593 /* Device now using proper address. */
2594 usb_set_device_state(udev, USB_STATE_ADDRESS);
2595 usb_ep0_reinit(udev);
2600 /* Reset device, (re)assign address, get device descriptor.
2601 * Device connection must be stable, no more debouncing needed.
2602 * Returns device in USB_STATE_ADDRESS, except on error.
2604 * If this is called for an already-existing device (as part of
2605 * usb_reset_and_verify_device), the caller must own the device lock. For a
2606 * newly detected device that is not accessible through any global
2607 * pointers, it's not necessary to lock the device.
2610 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2613 static DEFINE_MUTEX(usb_address0_mutex);
2615 struct usb_device *hdev = hub->hdev;
2616 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
2618 unsigned delay = HUB_SHORT_RESET_TIME;
2619 enum usb_device_speed oldspeed = udev->speed;
2621 int devnum = udev->devnum;
2623 /* root hub ports have a slightly longer reset period
2624 * (from USB 2.0 spec, section 7.1.7.5)
2626 if (!hdev->parent) {
2627 delay = HUB_ROOT_RESET_TIME;
2628 if (port1 == hdev->bus->otg_port)
2629 hdev->bus->b_hnp_enable = 0;
2632 /* Some low speed devices have problems with the quick delay, so */
2633 /* be a bit pessimistic with those devices. RHbug #23670 */
2634 if (oldspeed == USB_SPEED_LOW)
2635 delay = HUB_LONG_RESET_TIME;
2637 mutex_lock(&usb_address0_mutex);
2639 if ((hcd->driver->flags & HCD_USB3) && udev->config) {
2640 /* FIXME this will need special handling by the xHCI driver. */
2642 "xHCI reset of configured device "
2643 "not supported yet.\n");
2646 } else if (!udev->config && oldspeed == USB_SPEED_SUPER) {
2647 /* Don't reset USB 3.0 devices during an initial setup */
2648 usb_set_device_state(udev, USB_STATE_DEFAULT);
2650 /* Reset the device; full speed may morph to high speed */
2651 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
2652 retval = hub_port_reset(hub, port1, udev, delay);
2653 if (retval < 0) /* error or disconnect */
2655 /* success, speed is known */
2659 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2660 dev_dbg(&udev->dev, "device reset changed speed!\n");
2663 oldspeed = udev->speed;
2665 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2666 * it's fixed size except for full speed devices.
2667 * For Wireless USB devices, ep0 max packet is always 512 (tho
2668 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2670 switch (udev->speed) {
2671 case USB_SPEED_SUPER:
2672 case USB_SPEED_VARIABLE: /* fixed at 512 */
2673 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
2675 case USB_SPEED_HIGH: /* fixed at 64 */
2676 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
2678 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2679 /* to determine the ep0 maxpacket size, try to read
2680 * the device descriptor to get bMaxPacketSize0 and
2681 * then correct our initial guess.
2683 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
2685 case USB_SPEED_LOW: /* fixed at 8 */
2686 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
2693 switch (udev->speed) {
2694 case USB_SPEED_LOW: speed = "low"; break;
2695 case USB_SPEED_FULL: speed = "full"; break;
2696 case USB_SPEED_HIGH: speed = "high"; break;
2697 case USB_SPEED_SUPER:
2700 case USB_SPEED_VARIABLE:
2704 default: speed = "?"; break;
2706 if (udev->speed != USB_SPEED_SUPER)
2707 dev_info(&udev->dev,
2708 "%s %s speed %sUSB device using %s and address %d\n",
2709 (udev->config) ? "reset" : "new", speed, type,
2710 udev->bus->controller->driver->name, devnum);
2712 /* Set up TT records, if needed */
2714 udev->tt = hdev->tt;
2715 udev->ttport = hdev->ttport;
2716 } else if (udev->speed != USB_SPEED_HIGH
2717 && hdev->speed == USB_SPEED_HIGH) {
2720 * parent hub has no TT would not be error in rk29
2724 dev_err(&udev->dev, "parent hub has no TT\n");
2729 udev->tt = &hub->tt;
2730 udev->ttport = port1;
2733 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2734 * Because device hardware and firmware is sometimes buggy in
2735 * this area, and this is how Linux has done it for ages.
2736 * Change it cautiously.
2738 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2739 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2740 * so it may help with some non-standards-compliant devices.
2741 * Otherwise we start with SET_ADDRESS and then try to read the
2742 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2745 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2747 * An xHCI controller cannot send any packets to a device until
2748 * a set address command successfully completes.
2750 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
2751 struct usb_device_descriptor *buf;
2754 #define GET_DESCRIPTOR_BUFSIZE 64
2755 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2761 /* Retry on all errors; some devices are flakey.
2762 * 255 is for WUSB devices, we actually need to use
2763 * 512 (WUSB1.0[4.8.1]).
2765 for (j = 0; j < 3; ++j) {
2766 buf->bMaxPacketSize0 = 0;
2767 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2768 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2769 USB_DT_DEVICE << 8, 0,
2770 buf, GET_DESCRIPTOR_BUFSIZE,
2771 initial_descriptor_timeout);
2772 switch (buf->bMaxPacketSize0) {
2773 case 8: case 16: case 32: case 64: case 255:
2774 if (buf->bDescriptorType ==
2788 udev->descriptor.bMaxPacketSize0 =
2789 buf->bMaxPacketSize0;
2792 retval = hub_port_reset(hub, port1, udev, delay);
2793 if (retval < 0) /* error or disconnect */
2795 if (oldspeed != udev->speed) {
2797 "device reset changed speed!\n");
2803 "device descriptor read/64, error %d\n",
2808 #undef GET_DESCRIPTOR_BUFSIZE
2812 * If device is WUSB, we already assigned an
2813 * unauthorized address in the Connect Ack sequence;
2814 * authorization will assign the final address.
2816 if (udev->wusb == 0) {
2817 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2818 retval = hub_set_address(udev, devnum);
2825 "device not accepting address %d, error %d\n",
2829 if (udev->speed == USB_SPEED_SUPER) {
2830 devnum = udev->devnum;
2831 dev_info(&udev->dev,
2832 "%s SuperSpeed USB device using %s and address %d\n",
2833 (udev->config) ? "reset" : "new",
2834 udev->bus->controller->driver->name, devnum);
2837 /* cope with hardware quirkiness:
2838 * - let SET_ADDRESS settle, some device hardware wants it
2839 * - read ep0 maxpacket even for high and low speed,
2842 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
2846 retval = usb_get_device_descriptor(udev, 8);
2849 "device descriptor read/8, error %d\n",
2861 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
2862 udev->speed == USB_SPEED_SUPER)
2865 i = udev->descriptor.bMaxPacketSize0;
2866 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2867 if (udev->speed == USB_SPEED_LOW ||
2868 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2869 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
2873 if (udev->speed == USB_SPEED_FULL)
2874 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2876 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
2877 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2878 usb_ep0_reinit(udev);
2881 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2882 if (retval < (signed)sizeof(udev->descriptor)) {
2883 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
2894 hub_port_disable(hub, port1, 0);
2895 update_address(udev, devnum); /* for disconnect processing */
2897 mutex_unlock(&usb_address0_mutex);
2902 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2904 struct usb_qualifier_descriptor *qual;
2907 qual = kmalloc (sizeof *qual, GFP_KERNEL);
2911 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2912 qual, sizeof *qual);
2913 if (status == sizeof *qual) {
2914 dev_info(&udev->dev, "not running at top speed; "
2915 "connect to a high speed hub\n");
2916 /* hub LEDs are probably harder to miss than syslog */
2917 if (hub->has_indicators) {
2918 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2919 schedule_delayed_work (&hub->leds, 0);
2926 hub_power_remaining (struct usb_hub *hub)
2928 struct usb_device *hdev = hub->hdev;
2932 if (!hub->limited_power)
2935 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2936 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2937 struct usb_device *udev = hdev->children[port1 - 1];
2943 /* Unconfigured devices may not use more than 100mA,
2944 * or 8mA for OTG ports */
2945 if (udev->actconfig)
2946 delta = udev->actconfig->desc.bMaxPower * 2;
2947 else if (port1 != udev->bus->otg_port || hdev->parent)
2951 if (delta > hub->mA_per_port)
2952 dev_warn(&udev->dev,
2953 "%dmA is over %umA budget for port %d!\n",
2954 delta, hub->mA_per_port, port1);
2957 if (remaining < 0) {
2958 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2965 /* Handle physical or logical connection change events.
2966 * This routine is called when:
2967 * a port connection-change occurs;
2968 * a port enable-change occurs (often caused by EMI);
2969 * usb_reset_and_verify_device() encounters changed descriptors (as from
2970 * a firmware download)
2971 * caller already locked the hub
2973 static void hub_port_connect_change(struct usb_hub *hub, int port1,
2974 u16 portstatus, u16 portchange)
2976 struct usb_device *hdev = hub->hdev;
2977 struct device *hub_dev = hub->intfdev;
2978 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
2979 unsigned wHubCharacteristics =
2980 le16_to_cpu(hub->descriptor->wHubCharacteristics);
2981 struct usb_device *udev;
2985 "port %d, status %04x, change %04x, %s\n",
2986 port1, portstatus, portchange, portspeed (portstatus));
2988 if (hub->has_indicators) {
2989 set_port_led(hub, port1, HUB_LED_AUTO);
2990 hub->indicator[port1-1] = INDICATOR_AUTO;
2993 #ifdef CONFIG_USB_OTG
2994 /* during HNP, don't repeat the debounce */
2995 if (hdev->bus->is_b_host)
2996 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
2997 USB_PORT_STAT_C_ENABLE);
3000 /* Try to resuscitate an existing device */
3001 udev = hdev->children[port1-1];
3002 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
3003 udev->state != USB_STATE_NOTATTACHED) {
3004 usb_lock_device(udev);
3005 if (portstatus & USB_PORT_STAT_ENABLE) {
3006 status = 0; /* Nothing to do */
3008 #ifdef CONFIG_USB_SUSPEND
3009 } else if (udev->state == USB_STATE_SUSPENDED &&
3010 udev->persist_enabled) {
3011 /* For a suspended device, treat this as a
3012 * remote wakeup event.
3014 status = remote_wakeup(udev);
3018 status = -ENODEV; /* Don't resuscitate */
3020 usb_unlock_device(udev);
3023 clear_bit(port1, hub->change_bits);
3028 /* Disconnect any existing devices under this port */
3030 usb_disconnect(&hdev->children[port1-1]);
3031 clear_bit(port1, hub->change_bits);
3033 if (portchange & (USB_PORT_STAT_C_CONNECTION |
3034 USB_PORT_STAT_C_ENABLE)) {
3035 status = hub_port_debounce(hub, port1);
3037 if (printk_ratelimit())
3038 dev_err(hub_dev, "connect-debounce failed, "
3039 "port %d disabled\n", port1);
3040 portstatus &= ~USB_PORT_STAT_CONNECTION;
3042 portstatus = status;
3046 /* Return now if debouncing failed or nothing is connected */
3047 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
3049 /* maybe switch power back on (e.g. root hub was reset) */
3050 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
3051 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
3052 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
3054 if (portstatus & USB_PORT_STAT_ENABLE)
3059 for (i = 0; i < SET_CONFIG_TRIES; i++) {
3061 /* reallocate for each attempt, since references
3062 * to the previous one can escape in various ways
3064 udev = usb_alloc_dev(hdev, hdev->bus, port1);
3067 "couldn't allocate port %d usb_device\n",
3072 usb_set_device_state(udev, USB_STATE_POWERED);
3073 udev->bus_mA = hub->mA_per_port;
3074 udev->level = hdev->level + 1;
3075 udev->wusb = hub_is_wusb(hub);
3078 * USB 3.0 devices are reset automatically before the connect
3079 * port status change appears, and the root hub port status
3080 * shows the correct speed. We also get port change
3081 * notifications for USB 3.0 devices from the USB 3.0 portion of
3082 * an external USB 3.0 hub, but this isn't handled correctly yet
3086 if (!(hcd->driver->flags & HCD_USB3))
3087 udev->speed = USB_SPEED_UNKNOWN;
3088 else if ((hdev->parent == NULL) &&
3089 (portstatus & (1 << USB_PORT_FEAT_SUPERSPEED)))
3090 udev->speed = USB_SPEED_SUPER;
3092 udev->speed = USB_SPEED_UNKNOWN;
3095 * xHCI needs to issue an address device command later
3096 * in the hub_port_init sequence for SS/HS/FS/LS devices.
3098 if (!(hcd->driver->flags & HCD_USB3)) {
3099 /* set the address */
3100 choose_address(udev);
3101 if (udev->devnum <= 0) {
3102 status = -ENOTCONN; /* Don't retry */
3107 /* reset (non-USB 3.0 devices) and get descriptor */
3108 status = hub_port_init(hub, udev, port1, i);
3112 usb_detect_quirks(udev);
3113 if (udev->quirks & USB_QUIRK_DELAY_INIT)
3116 /* consecutive bus-powered hubs aren't reliable; they can
3117 * violate the voltage drop budget. if the new child has
3118 * a "powered" LED, users should notice we didn't enable it
3119 * (without reading syslog), even without per-port LEDs
3122 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
3123 && udev->bus_mA <= 100) {
3126 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
3129 dev_dbg(&udev->dev, "get status %d ?\n", status);
3132 le16_to_cpus(&devstat);
3133 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
3135 "can't connect bus-powered hub "
3137 if (hub->has_indicators) {
3138 hub->indicator[port1-1] =
3139 INDICATOR_AMBER_BLINK;
3140 schedule_delayed_work (&hub->leds, 0);
3142 status = -ENOTCONN; /* Don't retry */
3147 /* check for devices running slower than they could */
3148 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
3149 && udev->speed == USB_SPEED_FULL
3150 && highspeed_hubs != 0)
3151 check_highspeed (hub, udev, port1);
3153 /* Store the parent's children[] pointer. At this point
3154 * udev becomes globally accessible, although presumably
3155 * no one will look at it until hdev is unlocked.
3159 /* We mustn't add new devices if the parent hub has
3160 * been disconnected; we would race with the
3161 * recursively_mark_NOTATTACHED() routine.
3163 spin_lock_irq(&device_state_lock);
3164 if (hdev->state == USB_STATE_NOTATTACHED)
3167 hdev->children[port1-1] = udev;
3168 spin_unlock_irq(&device_state_lock);
3170 /* Run it through the hoops (find a driver, etc) */
3172 status = usb_new_device(udev);
3174 spin_lock_irq(&device_state_lock);
3175 hdev->children[port1-1] = NULL;
3176 spin_unlock_irq(&device_state_lock);
3183 status = hub_power_remaining(hub);
3185 dev_dbg(hub_dev, "%dmA power budget left\n", status);
3190 hub_port_disable(hub, port1, 1);
3192 usb_ep0_reinit(udev);
3193 release_address(udev);
3196 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
3199 if (hub->hdev->parent ||
3200 !hcd->driver->port_handed_over ||
3201 !(hcd->driver->port_handed_over)(hcd, port1))
3202 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
3206 hub_port_disable(hub, port1, 1);
3207 if (hcd->driver->relinquish_port && !hub->hdev->parent)
3208 hcd->driver->relinquish_port(hcd, port1);
3211 static void hub_events(void)
3213 struct list_head *tmp;
3214 struct usb_device *hdev;
3215 struct usb_interface *intf;
3216 struct usb_hub *hub;
3217 struct device *hub_dev;
3226 * We restart the list every time to avoid a deadlock with
3227 * deleting hubs downstream from this one. This should be
3228 * safe since we delete the hub from the event list.
3229 * Not the most efficient, but avoids deadlocks.
3233 /* Grab the first entry at the beginning of the list */
3234 spin_lock_irq(&hub_event_lock);
3235 if (list_empty(&hub_event_list)) {
3236 spin_unlock_irq(&hub_event_lock);
3240 tmp = hub_event_list.next;
3243 hub = list_entry(tmp, struct usb_hub, event_list);
3244 kref_get(&hub->kref);
3245 spin_unlock_irq(&hub_event_lock);
3248 hub_dev = hub->intfdev;
3249 intf = to_usb_interface(hub_dev);
3250 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
3251 hdev->state, hub->descriptor
3252 ? hub->descriptor->bNbrPorts
3254 /* NOTE: expects max 15 ports... */
3255 (u16) hub->change_bits[0],
3256 (u16) hub->event_bits[0]);
3258 /* Lock the device, then check to see if we were
3259 * disconnected while waiting for the lock to succeed. */
3260 usb_lock_device(hdev);
3261 if (unlikely(hub->disconnected))
3264 /* If the hub has died, clean up after it */
3265 if (hdev->state == USB_STATE_NOTATTACHED) {
3266 hub->error = -ENODEV;
3267 hub_quiesce(hub, HUB_DISCONNECT);
3272 ret = usb_autopm_get_interface(intf);
3274 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
3278 /* If this is an inactive hub, do nothing */
3283 dev_dbg (hub_dev, "resetting for error %d\n",
3286 ret = usb_reset_device(hdev);
3289 "error resetting hub: %d\n", ret);
3297 /* deal with port status changes */
3298 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
3299 if (test_bit(i, hub->busy_bits))
3301 connect_change = test_bit(i, hub->change_bits);
3302 if (!test_and_clear_bit(i, hub->event_bits) &&
3306 ret = hub_port_status(hub, i,
3307 &portstatus, &portchange);
3311 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3312 clear_port_feature(hdev, i,
3313 USB_PORT_FEAT_C_CONNECTION);
3317 if (portchange & USB_PORT_STAT_C_ENABLE) {
3318 if (!connect_change)
3320 "port %d enable change, "
3323 clear_port_feature(hdev, i,
3324 USB_PORT_FEAT_C_ENABLE);
3327 * EM interference sometimes causes badly
3328 * shielded USB devices to be shutdown by
3329 * the hub, this hack enables them again.
3330 * Works at least with mouse driver.
3332 if (!(portstatus & USB_PORT_STAT_ENABLE)
3334 && hdev->children[i-1]) {
3337 "disabled by hub (EMI?), "
3344 if (portchange & USB_PORT_STAT_C_SUSPEND) {
3345 struct usb_device *udev;
3347 clear_port_feature(hdev, i,
3348 USB_PORT_FEAT_C_SUSPEND);
3349 udev = hdev->children[i-1];
3351 /* TRSMRCY = 10 msec */
3354 usb_lock_device(udev);
3355 ret = remote_wakeup(hdev->
3357 usb_unlock_device(udev);
3362 hub_port_disable(hub, i, 1);
3365 "resume on port %d, status %d\n",
3369 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
3371 "over-current change on port %d\n",
3373 clear_port_feature(hdev, i,
3374 USB_PORT_FEAT_C_OVER_CURRENT);
3375 hub_power_on(hub, true);
3378 if (portchange & USB_PORT_STAT_C_RESET) {
3380 "reset change on port %d\n",
3382 clear_port_feature(hdev, i,
3383 USB_PORT_FEAT_C_RESET);
3387 hub_port_connect_change(hub, i,
3388 portstatus, portchange);
3391 /* deal with hub status changes */
3392 if (test_and_clear_bit(0, hub->event_bits) == 0)
3394 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
3395 dev_err (hub_dev, "get_hub_status failed\n");
3397 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
3398 dev_dbg (hub_dev, "power change\n");
3399 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
3400 if (hubstatus & HUB_STATUS_LOCAL_POWER)
3401 /* FIXME: Is this always true? */
3402 hub->limited_power = 1;
3404 hub->limited_power = 0;
3406 if (hubchange & HUB_CHANGE_OVERCURRENT) {
3407 dev_dbg (hub_dev, "overcurrent change\n");
3408 msleep(500); /* Cool down */
3409 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
3410 hub_power_on(hub, true);
3415 /* Allow autosuspend if we're not going to run again */
3416 if (list_empty(&hub->event_list))
3417 usb_autopm_enable(intf);
3419 usb_unlock_device(hdev);
3420 kref_put(&hub->kref, hub_release);
3422 } /* end while (1) */
3426 * disconnect all devices on root hub
3428 void hub_disconnect_device(struct usb_hub *hub)
3430 hub_port_connect_change(hub, 1, 0, 0x2);
3433 static int hub_thread(void *__unused)
3435 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3436 * port handover. Otherwise it might see that a full-speed device
3437 * was gone before the EHCI controller had handed its port over to
3438 * the companion full-speed controller.
3444 wait_event_freezable(khubd_wait,
3445 !list_empty(&hub_event_list) ||
3446 kthread_should_stop());
3447 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
3449 pr_debug("%s: khubd exiting\n", usbcore_name);
3453 static struct usb_device_id hub_id_table [] = {
3454 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
3455 .bDeviceClass = USB_CLASS_HUB},
3456 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
3457 .bInterfaceClass = USB_CLASS_HUB},
3458 { } /* Terminating entry */
3461 MODULE_DEVICE_TABLE (usb, hub_id_table);
3463 static struct usb_driver hub_driver = {
3466 .disconnect = hub_disconnect,
3467 .suspend = hub_suspend,
3468 .resume = hub_resume,
3469 .reset_resume = hub_reset_resume,
3470 .pre_reset = hub_pre_reset,
3471 .post_reset = hub_post_reset,
3473 .id_table = hub_id_table,
3474 .supports_autosuspend = 1,
3477 int usb_hub_init(void)
3479 if (usb_register(&hub_driver) < 0) {
3480 printk(KERN_ERR "%s: can't register hub driver\n",
3485 khubd_task = kthread_run(hub_thread, NULL, "khubd");
3486 if (!IS_ERR(khubd_task))
3489 /* Fall through if kernel_thread failed */
3490 usb_deregister(&hub_driver);
3491 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
3496 void usb_hub_cleanup(void)
3498 kthread_stop(khubd_task);
3501 * Hub resources are freed for us by usb_deregister. It calls
3502 * usb_driver_purge on every device which in turn calls that
3503 * devices disconnect function if it is using this driver.
3504 * The hub_disconnect function takes care of releasing the
3505 * individual hub resources. -greg
3507 usb_deregister(&hub_driver);
3508 } /* usb_hub_cleanup() */
3510 static int descriptors_changed(struct usb_device *udev,
3511 struct usb_device_descriptor *old_device_descriptor)
3515 unsigned serial_len = 0;
3517 unsigned old_length;
3521 if (memcmp(&udev->descriptor, old_device_descriptor,
3522 sizeof(*old_device_descriptor)) != 0)
3525 /* Since the idVendor, idProduct, and bcdDevice values in the
3526 * device descriptor haven't changed, we will assume the
3527 * Manufacturer and Product strings haven't changed either.
3528 * But the SerialNumber string could be different (e.g., a
3529 * different flash card of the same brand).
3532 serial_len = strlen(udev->serial) + 1;
3535 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3536 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3537 len = max(len, old_length);
3540 buf = kmalloc(len, GFP_NOIO);
3542 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
3543 /* assume the worst */
3546 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3547 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3548 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
3550 if (length != old_length) {
3551 dev_dbg(&udev->dev, "config index %d, error %d\n",
3556 if (memcmp (buf, udev->rawdescriptors[index], old_length)
3558 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
3560 ((struct usb_config_descriptor *) buf)->
3561 bConfigurationValue);
3567 if (!changed && serial_len) {
3568 length = usb_string(udev, udev->descriptor.iSerialNumber,
3570 if (length + 1 != serial_len) {
3571 dev_dbg(&udev->dev, "serial string error %d\n",
3574 } else if (memcmp(buf, udev->serial, length) != 0) {
3575 dev_dbg(&udev->dev, "serial string changed\n");
3585 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
3586 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3588 * WARNING - don't use this routine to reset a composite device
3589 * (one with multiple interfaces owned by separate drivers)!
3590 * Use usb_reset_device() instead.
3592 * Do a port reset, reassign the device's address, and establish its
3593 * former operating configuration. If the reset fails, or the device's
3594 * descriptors change from their values before the reset, or the original
3595 * configuration and altsettings cannot be restored, a flag will be set
3596 * telling khubd to pretend the device has been disconnected and then
3597 * re-connected. All drivers will be unbound, and the device will be
3598 * re-enumerated and probed all over again.
3600 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3601 * flagged for logical disconnection, or some other negative error code
3602 * if the reset wasn't even attempted.
3604 * The caller must own the device lock. For example, it's safe to use
3605 * this from a driver probe() routine after downloading new firmware.
3606 * For calls that might not occur during probe(), drivers should lock
3607 * the device using usb_lock_device_for_reset().
3609 * Locking exception: This routine may also be called from within an
3610 * autoresume handler. Such usage won't conflict with other tasks
3611 * holding the device lock because these tasks should always call
3612 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
3614 static int usb_reset_and_verify_device(struct usb_device *udev)
3616 struct usb_device *parent_hdev = udev->parent;
3617 struct usb_hub *parent_hub;
3618 struct usb_device_descriptor descriptor = udev->descriptor;
3620 int port1 = udev->portnum;
3622 if (udev->state == USB_STATE_NOTATTACHED ||
3623 udev->state == USB_STATE_SUSPENDED) {
3624 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3630 /* this requires hcd-specific logic; see OHCI hc_restart() */
3631 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
3634 parent_hub = hdev_to_hub(parent_hdev);
3636 set_bit(port1, parent_hub->busy_bits);
3637 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3639 /* ep0 maxpacket size may change; let the HCD know about it.
3640 * Other endpoints will be handled by re-enumeration. */
3641 usb_ep0_reinit(udev);
3642 ret = hub_port_init(parent_hub, udev, port1, i);
3643 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
3646 clear_bit(port1, parent_hub->busy_bits);
3651 /* Device might have changed firmware (DFU or similar) */
3652 if (descriptors_changed(udev, &descriptor)) {
3653 dev_info(&udev->dev, "device firmware changed\n");
3654 udev->descriptor = descriptor; /* for disconnect() calls */
3658 /* Restore the device's previous configuration */
3659 if (!udev->actconfig)
3661 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3662 USB_REQ_SET_CONFIGURATION, 0,
3663 udev->actconfig->desc.bConfigurationValue, 0,
3664 NULL, 0, USB_CTRL_SET_TIMEOUT);
3667 "can't restore configuration #%d (error=%d)\n",
3668 udev->actconfig->desc.bConfigurationValue, ret);
3671 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3673 /* Put interfaces back into the same altsettings as before.
3674 * Don't bother to send the Set-Interface request for interfaces
3675 * that were already in altsetting 0; besides being unnecessary,
3676 * many devices can't handle it. Instead just reset the host-side
3679 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3680 struct usb_interface *intf = udev->actconfig->interface[i];
3681 struct usb_interface_descriptor *desc;
3683 desc = &intf->cur_altsetting->desc;
3684 if (desc->bAlternateSetting == 0) {
3685 usb_disable_interface(udev, intf, true);
3686 usb_enable_interface(udev, intf, true);
3689 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3690 desc->bAlternateSetting);
3693 dev_err(&udev->dev, "failed to restore interface %d "
3694 "altsetting %d (error=%d)\n",
3695 desc->bInterfaceNumber,
3696 desc->bAlternateSetting,
3706 hub_port_logical_disconnect(parent_hub, port1);
3711 * usb_reset_device - warn interface drivers and perform a USB port reset
3712 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3714 * Warns all drivers bound to registered interfaces (using their pre_reset
3715 * method), performs the port reset, and then lets the drivers know that
3716 * the reset is over (using their post_reset method).
3718 * Return value is the same as for usb_reset_and_verify_device().
3720 * The caller must own the device lock. For example, it's safe to use
3721 * this from a driver probe() routine after downloading new firmware.
3722 * For calls that might not occur during probe(), drivers should lock
3723 * the device using usb_lock_device_for_reset().
3725 * If an interface is currently being probed or disconnected, we assume
3726 * its driver knows how to handle resets. For all other interfaces,
3727 * if the driver doesn't have pre_reset and post_reset methods then
3728 * we attempt to unbind it and rebind afterward.
3730 int usb_reset_device(struct usb_device *udev)
3734 struct usb_host_config *config = udev->actconfig;
3736 if (udev->state == USB_STATE_NOTATTACHED ||
3737 udev->state == USB_STATE_SUSPENDED) {
3738 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3743 /* Prevent autosuspend during the reset */
3744 usb_autoresume_device(udev);
3747 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
3748 struct usb_interface *cintf = config->interface[i];
3749 struct usb_driver *drv;
3752 if (cintf->dev.driver) {
3753 drv = to_usb_driver(cintf->dev.driver);
3754 if (drv->pre_reset && drv->post_reset)
3755 unbind = (drv->pre_reset)(cintf);
3756 else if (cintf->condition ==
3757 USB_INTERFACE_BOUND)
3760 usb_forced_unbind_intf(cintf);
3765 ret = usb_reset_and_verify_device(udev);
3768 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
3769 struct usb_interface *cintf = config->interface[i];
3770 struct usb_driver *drv;
3771 int rebind = cintf->needs_binding;
3773 if (!rebind && cintf->dev.driver) {
3774 drv = to_usb_driver(cintf->dev.driver);
3775 if (drv->post_reset)
3776 rebind = (drv->post_reset)(cintf);
3777 else if (cintf->condition ==
3778 USB_INTERFACE_BOUND)
3781 if (ret == 0 && rebind)
3782 usb_rebind_intf(cintf);
3786 usb_autosuspend_device(udev);
3789 EXPORT_SYMBOL_GPL(usb_reset_device);
3793 * usb_queue_reset_device - Reset a USB device from an atomic context
3794 * @iface: USB interface belonging to the device to reset
3796 * This function can be used to reset a USB device from an atomic
3797 * context, where usb_reset_device() won't work (as it blocks).
3799 * Doing a reset via this method is functionally equivalent to calling
3800 * usb_reset_device(), except for the fact that it is delayed to a
3801 * workqueue. This means that any drivers bound to other interfaces
3802 * might be unbound, as well as users from usbfs in user space.
3806 * - Scheduling two resets at the same time from two different drivers
3807 * attached to two different interfaces of the same device is
3808 * possible; depending on how the driver attached to each interface
3809 * handles ->pre_reset(), the second reset might happen or not.
3811 * - If a driver is unbound and it had a pending reset, the reset will
3814 * - This function can be called during .probe() or .disconnect()
3815 * times. On return from .disconnect(), any pending resets will be
3818 * There is no no need to lock/unlock the @reset_ws as schedule_work()
3821 * NOTE: We don't do any reference count tracking because it is not
3822 * needed. The lifecycle of the work_struct is tied to the
3823 * usb_interface. Before destroying the interface we cancel the
3824 * work_struct, so the fact that work_struct is queued and or
3825 * running means the interface (and thus, the device) exist and
3828 void usb_queue_reset_device(struct usb_interface *iface)
3830 schedule_work(&iface->reset_ws);
3832 EXPORT_SYMBOL_GPL(usb_queue_reset_device);