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>
26 #include <asm/uaccess.h>
27 #include <asm/byteorder.h>
33 /* if we are in debug mode, always announce new devices */
35 #ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
36 #define CONFIG_USB_ANNOUNCE_NEW_DEVICES
41 struct device *intfdev; /* the "interface" device */
42 struct usb_device *hdev;
44 struct urb *urb; /* for interrupt polling pipe */
46 /* buffer for urb ... with extra space in case of babble */
48 dma_addr_t buffer_dma; /* DMA address for buffer */
50 struct usb_hub_status hub;
51 struct usb_port_status port;
52 } *status; /* buffer for status reports */
53 struct mutex status_mutex; /* for the status buffer */
55 int error; /* last reported error */
56 int nerrors; /* track consecutive errors */
58 struct list_head event_list; /* hubs w/data or errs ready */
59 unsigned long event_bits[1]; /* status change bitmask */
60 unsigned long change_bits[1]; /* ports with logical connect
62 unsigned long busy_bits[1]; /* ports being reset or
64 #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
65 #error event_bits[] is too short!
68 struct usb_hub_descriptor *descriptor; /* class descriptor */
69 struct usb_tt tt; /* Transaction Translator */
71 unsigned mA_per_port; /* current for each child */
73 unsigned limited_power:1;
75 unsigned activating:1;
76 unsigned disconnected:1;
78 unsigned has_indicators:1;
79 u8 indicator[USB_MAXCHILDREN];
80 struct delayed_work leds;
84 /* Protect struct usb_device->state and ->children members
85 * Note: Both are also protected by ->dev.sem, except that ->state can
86 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
87 static DEFINE_SPINLOCK(device_state_lock);
89 /* khubd's worklist and its lock */
90 static DEFINE_SPINLOCK(hub_event_lock);
91 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
94 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
96 static struct task_struct *khubd_task;
98 /* cycle leds on hubs that aren't blinking for attention */
99 static int blinkenlights = 0;
100 module_param (blinkenlights, bool, S_IRUGO);
101 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
104 * As of 2.6.10 we introduce a new USB device initialization scheme which
105 * closely resembles the way Windows works. Hopefully it will be compatible
106 * with a wider range of devices than the old scheme. However some previously
107 * working devices may start giving rise to "device not accepting address"
108 * errors; if that happens the user can try the old scheme by adjusting the
109 * following module parameters.
111 * For maximum flexibility there are two boolean parameters to control the
112 * hub driver's behavior. On the first initialization attempt, if the
113 * "old_scheme_first" parameter is set then the old scheme will be used,
114 * otherwise the new scheme is used. If that fails and "use_both_schemes"
115 * is set, then the driver will make another attempt, using the other scheme.
117 static int old_scheme_first = 0;
118 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
119 MODULE_PARM_DESC(old_scheme_first,
120 "start with the old device initialization scheme");
122 static int use_both_schemes = 1;
123 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
124 MODULE_PARM_DESC(use_both_schemes,
125 "try the other device initialization scheme if the "
128 /* Mutual exclusion for EHCI CF initialization. This interferes with
129 * port reset on some companion controllers.
131 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
132 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
135 static inline char *portspeed(int portstatus)
137 if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
139 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
145 /* Note that hdev or one of its children must be locked! */
146 static inline struct usb_hub *hdev_to_hub(struct usb_device *hdev)
148 return usb_get_intfdata(hdev->actconfig->interface[0]);
151 /* USB 2.0 spec Section 11.24.4.5 */
152 static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
156 for (i = 0; i < 3; i++) {
157 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
158 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
159 USB_DT_HUB << 8, 0, data, size,
160 USB_CTRL_GET_TIMEOUT);
161 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
168 * USB 2.0 spec Section 11.24.2.1
170 static int clear_hub_feature(struct usb_device *hdev, int feature)
172 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
173 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
177 * USB 2.0 spec Section 11.24.2.2
179 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
181 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
182 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
187 * USB 2.0 spec Section 11.24.2.13
189 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
191 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
192 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
197 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
198 * for info about using port indicators
200 static void set_port_led(
206 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
207 USB_PORT_FEAT_INDICATOR);
209 dev_dbg (hub->intfdev,
210 "port %d indicator %s status %d\n",
212 ({ char *s; switch (selector) {
213 case HUB_LED_AMBER: s = "amber"; break;
214 case HUB_LED_GREEN: s = "green"; break;
215 case HUB_LED_OFF: s = "off"; break;
216 case HUB_LED_AUTO: s = "auto"; break;
217 default: s = "??"; break;
222 #define LED_CYCLE_PERIOD ((2*HZ)/3)
224 static void led_work (struct work_struct *work)
226 struct usb_hub *hub =
227 container_of(work, struct usb_hub, leds.work);
228 struct usb_device *hdev = hub->hdev;
230 unsigned changed = 0;
233 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
236 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
237 unsigned selector, mode;
239 /* 30%-50% duty cycle */
241 switch (hub->indicator[i]) {
243 case INDICATOR_CYCLE:
245 selector = HUB_LED_AUTO;
246 mode = INDICATOR_AUTO;
248 /* blinking green = sw attention */
249 case INDICATOR_GREEN_BLINK:
250 selector = HUB_LED_GREEN;
251 mode = INDICATOR_GREEN_BLINK_OFF;
253 case INDICATOR_GREEN_BLINK_OFF:
254 selector = HUB_LED_OFF;
255 mode = INDICATOR_GREEN_BLINK;
257 /* blinking amber = hw attention */
258 case INDICATOR_AMBER_BLINK:
259 selector = HUB_LED_AMBER;
260 mode = INDICATOR_AMBER_BLINK_OFF;
262 case INDICATOR_AMBER_BLINK_OFF:
263 selector = HUB_LED_OFF;
264 mode = INDICATOR_AMBER_BLINK;
266 /* blink green/amber = reserved */
267 case INDICATOR_ALT_BLINK:
268 selector = HUB_LED_GREEN;
269 mode = INDICATOR_ALT_BLINK_OFF;
271 case INDICATOR_ALT_BLINK_OFF:
272 selector = HUB_LED_AMBER;
273 mode = INDICATOR_ALT_BLINK;
278 if (selector != HUB_LED_AUTO)
280 set_port_led(hub, i + 1, selector);
281 hub->indicator[i] = mode;
283 if (!changed && blinkenlights) {
285 cursor %= hub->descriptor->bNbrPorts;
286 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
287 hub->indicator[cursor] = INDICATOR_CYCLE;
291 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
294 /* use a short timeout for hub/port status fetches */
295 #define USB_STS_TIMEOUT 1000
296 #define USB_STS_RETRIES 5
299 * USB 2.0 spec Section 11.24.2.6
301 static int get_hub_status(struct usb_device *hdev,
302 struct usb_hub_status *data)
304 int i, status = -ETIMEDOUT;
306 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
307 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
308 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
309 data, sizeof(*data), USB_STS_TIMEOUT);
315 * USB 2.0 spec Section 11.24.2.7
317 static int get_port_status(struct usb_device *hdev, int port1,
318 struct usb_port_status *data)
320 int i, status = -ETIMEDOUT;
322 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
323 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
324 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
325 data, sizeof(*data), USB_STS_TIMEOUT);
330 static int hub_port_status(struct usb_hub *hub, int port1,
331 u16 *status, u16 *change)
335 mutex_lock(&hub->status_mutex);
336 ret = get_port_status(hub->hdev, port1, &hub->status->port);
338 dev_err(hub->intfdev,
339 "%s failed (err = %d)\n", __func__, ret);
343 *status = le16_to_cpu(hub->status->port.wPortStatus);
344 *change = le16_to_cpu(hub->status->port.wPortChange);
347 mutex_unlock(&hub->status_mutex);
351 static void kick_khubd(struct usb_hub *hub)
355 /* Suppress autosuspend until khubd runs */
356 to_usb_interface(hub->intfdev)->pm_usage_cnt = 1;
358 spin_lock_irqsave(&hub_event_lock, flags);
359 if (!hub->disconnected && list_empty(&hub->event_list)) {
360 list_add_tail(&hub->event_list, &hub_event_list);
361 wake_up(&khubd_wait);
363 spin_unlock_irqrestore(&hub_event_lock, flags);
366 void usb_kick_khubd(struct usb_device *hdev)
368 /* FIXME: What if hdev isn't bound to the hub driver? */
369 kick_khubd(hdev_to_hub(hdev));
373 /* completion function, fires on port status changes and various faults */
374 static void hub_irq(struct urb *urb)
376 struct usb_hub *hub = urb->context;
377 int status = urb->status;
382 case -ENOENT: /* synchronous unlink */
383 case -ECONNRESET: /* async unlink */
384 case -ESHUTDOWN: /* hardware going away */
387 default: /* presumably an error */
388 /* Cause a hub reset after 10 consecutive errors */
389 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
390 if ((++hub->nerrors < 10) || hub->error)
395 /* let khubd handle things */
396 case 0: /* we got data: port status changed */
398 for (i = 0; i < urb->actual_length; ++i)
399 bits |= ((unsigned long) ((*hub->buffer)[i]))
401 hub->event_bits[0] = bits;
407 /* Something happened, let khubd figure it out */
414 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
415 && status != -ENODEV && status != -EPERM)
416 dev_err (hub->intfdev, "resubmit --> %d\n", status);
419 /* USB 2.0 spec Section 11.24.2.3 */
421 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
423 return usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
424 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
429 * enumeration blocks khubd for a long time. we use keventd instead, since
430 * long blocking there is the exception, not the rule. accordingly, HCDs
431 * talking to TTs must queue control transfers (not just bulk and iso), so
432 * both can talk to the same hub concurrently.
434 static void hub_tt_kevent (struct work_struct *work)
436 struct usb_hub *hub =
437 container_of(work, struct usb_hub, tt.kevent);
441 spin_lock_irqsave (&hub->tt.lock, flags);
442 while (--limit && !list_empty (&hub->tt.clear_list)) {
443 struct list_head *temp;
444 struct usb_tt_clear *clear;
445 struct usb_device *hdev = hub->hdev;
448 temp = hub->tt.clear_list.next;
449 clear = list_entry (temp, struct usb_tt_clear, clear_list);
450 list_del (&clear->clear_list);
452 /* drop lock so HCD can concurrently report other TT errors */
453 spin_unlock_irqrestore (&hub->tt.lock, flags);
454 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
455 spin_lock_irqsave (&hub->tt.lock, flags);
459 "clear tt %d (%04x) error %d\n",
460 clear->tt, clear->devinfo, status);
463 spin_unlock_irqrestore (&hub->tt.lock, flags);
467 * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
468 * @udev: the device whose split transaction failed
469 * @pipe: identifies the endpoint of the failed transaction
471 * High speed HCDs use this to tell the hub driver that some split control or
472 * bulk transaction failed in a way that requires clearing internal state of
473 * a transaction translator. This is normally detected (and reported) from
476 * It may not be possible for that hub to handle additional full (or low)
477 * speed transactions until that state is fully cleared out.
479 void usb_hub_tt_clear_buffer (struct usb_device *udev, int pipe)
481 struct usb_tt *tt = udev->tt;
483 struct usb_tt_clear *clear;
485 /* we've got to cope with an arbitrary number of pending TT clears,
486 * since each TT has "at least two" buffers that can need it (and
487 * there can be many TTs per hub). even if they're uncommon.
489 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
490 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
491 /* FIXME recover somehow ... RESET_TT? */
495 /* info that CLEAR_TT_BUFFER needs */
496 clear->tt = tt->multi ? udev->ttport : 1;
497 clear->devinfo = usb_pipeendpoint (pipe);
498 clear->devinfo |= udev->devnum << 4;
499 clear->devinfo |= usb_pipecontrol (pipe)
500 ? (USB_ENDPOINT_XFER_CONTROL << 11)
501 : (USB_ENDPOINT_XFER_BULK << 11);
502 if (usb_pipein (pipe))
503 clear->devinfo |= 1 << 15;
505 /* tell keventd to clear state for this TT */
506 spin_lock_irqsave (&tt->lock, flags);
507 list_add_tail (&clear->clear_list, &tt->clear_list);
508 schedule_work (&tt->kevent);
509 spin_unlock_irqrestore (&tt->lock, flags);
511 EXPORT_SYMBOL_GPL(usb_hub_tt_clear_buffer);
513 static void hub_power_on(struct usb_hub *hub)
516 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
517 u16 wHubCharacteristics =
518 le16_to_cpu(hub->descriptor->wHubCharacteristics);
520 /* Enable power on each port. Some hubs have reserved values
521 * of LPSM (> 2) in their descriptors, even though they are
522 * USB 2.0 hubs. Some hubs do not implement port-power switching
523 * but only emulate it. In all cases, the ports won't work
524 * unless we send these messages to the hub.
526 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
527 dev_dbg(hub->intfdev, "enabling power on all ports\n");
529 dev_dbg(hub->intfdev, "trying to enable port power on "
530 "non-switchable hub\n");
531 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
532 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
534 /* Wait at least 100 msec for power to become stable */
535 msleep(max(pgood_delay, (unsigned) 100));
538 static void hub_quiesce(struct usb_hub *hub)
540 /* (nonblocking) khubd and related activity won't re-trigger */
544 /* (blocking) stop khubd and related activity */
545 usb_kill_urb(hub->urb);
546 if (hub->has_indicators)
547 cancel_delayed_work_sync(&hub->leds);
549 cancel_work_sync(&hub->tt.kevent);
552 static void hub_activate(struct usb_hub *hub)
559 status = usb_submit_urb(hub->urb, GFP_NOIO);
561 dev_err(hub->intfdev, "activate --> %d\n", status);
562 if (hub->has_indicators && blinkenlights)
563 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
565 /* scan all ports ASAP */
569 static int hub_hub_status(struct usb_hub *hub,
570 u16 *status, u16 *change)
574 mutex_lock(&hub->status_mutex);
575 ret = get_hub_status(hub->hdev, &hub->status->hub);
577 dev_err (hub->intfdev,
578 "%s failed (err = %d)\n", __func__, ret);
580 *status = le16_to_cpu(hub->status->hub.wHubStatus);
581 *change = le16_to_cpu(hub->status->hub.wHubChange);
584 mutex_unlock(&hub->status_mutex);
588 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
590 struct usb_device *hdev = hub->hdev;
593 if (hdev->children[port1-1] && set_state)
594 usb_set_device_state(hdev->children[port1-1],
595 USB_STATE_NOTATTACHED);
597 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
599 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
605 * Disable a port and mark a logical connnect-change event, so that some
606 * time later khubd will disconnect() any existing usb_device on the port
607 * and will re-enumerate if there actually is a device attached.
609 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
611 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
612 hub_port_disable(hub, port1, 1);
614 /* FIXME let caller ask to power down the port:
615 * - some devices won't enumerate without a VBUS power cycle
616 * - SRP saves power that way
617 * - ... new call, TBD ...
618 * That's easy if this hub can switch power per-port, and
619 * khubd reactivates the port later (timer, SRP, etc).
620 * Powerdown must be optional, because of reset/DFU.
623 set_bit(port1, hub->change_bits);
627 /* caller has locked the hub device */
628 static void hub_stop(struct usb_hub *hub)
630 struct usb_device *hdev = hub->hdev;
633 /* Disconnect all the children */
634 for (i = 0; i < hdev->maxchild; ++i) {
635 if (hdev->children[i])
636 usb_disconnect(&hdev->children[i]);
643 #define HUB_RESET_RESUME 3
647 /* Try to identify which devices need USB-PERSIST handling */
648 static int persistent_device(struct usb_device *udev)
652 struct usb_host_config *actconfig;
654 /* Explicitly not marked persistent? */
655 if (!udev->persist_enabled)
658 /* No active config? */
659 actconfig = udev->actconfig;
663 /* FIXME! We should check whether it's open here or not! */
666 * Check that all the interface drivers have a
667 * 'reset_resume' entrypoint
670 for (i = 0; i < actconfig->desc.bNumInterfaces; i++) {
671 struct usb_interface *intf;
672 struct usb_driver *driver;
674 intf = actconfig->interface[i];
675 if (!intf->dev.driver)
677 driver = to_usb_driver(intf->dev.driver);
678 if (!driver->reset_resume)
681 * We have at least one driver, and that one
682 * has a reset_resume method.
689 static void hub_restart(struct usb_hub *hub, int type)
691 struct usb_device *hdev = hub->hdev;
694 /* Check each of the children to see if they require
695 * USB-PERSIST handling or disconnection. Also check
696 * each unoccupied port to make sure it is still disabled.
698 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
699 struct usb_device *udev = hdev->children[port1-1];
701 u16 portstatus, portchange;
703 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
704 if (type != HUB_RESET) {
705 status = hub_port_status(hub, port1,
706 &portstatus, &portchange);
707 if (status == 0 && (portstatus &
708 USB_PORT_STAT_ENABLE))
709 clear_port_feature(hdev, port1,
710 USB_PORT_FEAT_ENABLE);
715 /* Was the power session lost while we were suspended? */
716 status = hub_port_status(hub, port1, &portstatus, &portchange);
718 /* If the device is gone, khubd will handle it later */
719 if (status == 0 && !(portstatus & USB_PORT_STAT_CONNECTION))
722 /* For "USB_PERSIST"-enabled children we must
723 * mark the child device for reset-resume and
724 * turn off the various status changes to prevent
725 * khubd from disconnecting it later.
727 if (status == 0 && !(portstatus & USB_PORT_STAT_ENABLE) &&
728 persistent_device(udev)) {
729 if (portchange & USB_PORT_STAT_C_ENABLE)
730 clear_port_feature(hub->hdev, port1,
731 USB_PORT_FEAT_C_ENABLE);
732 if (portchange & USB_PORT_STAT_C_CONNECTION)
733 clear_port_feature(hub->hdev, port1,
734 USB_PORT_FEAT_C_CONNECTION);
735 udev->reset_resume = 1;
738 /* Otherwise for a reset_resume we must disconnect the child,
739 * but as we may not lock the child device here
740 * we have to do a "logical" disconnect.
742 else if (type == HUB_RESET_RESUME)
743 hub_port_logical_disconnect(hub, port1);
749 #endif /* CONFIG_PM */
751 /* caller has locked the hub device */
752 static int hub_pre_reset(struct usb_interface *intf)
754 struct usb_hub *hub = usb_get_intfdata(intf);
760 /* caller has locked the hub device */
761 static int hub_post_reset(struct usb_interface *intf)
763 struct usb_hub *hub = usb_get_intfdata(intf);
770 static int hub_configure(struct usb_hub *hub,
771 struct usb_endpoint_descriptor *endpoint)
773 struct usb_device *hdev = hub->hdev;
774 struct device *hub_dev = hub->intfdev;
775 u16 hubstatus, hubchange;
776 u16 wHubCharacteristics;
781 hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
784 message = "can't allocate hub irq buffer";
789 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
791 message = "can't kmalloc hub status buffer";
795 mutex_init(&hub->status_mutex);
797 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
798 if (!hub->descriptor) {
799 message = "can't kmalloc hub descriptor";
804 /* Request the entire hub descriptor.
805 * hub->descriptor can handle USB_MAXCHILDREN ports,
806 * but the hub can/will return fewer bytes here.
808 ret = get_hub_descriptor(hdev, hub->descriptor,
809 sizeof(*hub->descriptor));
811 message = "can't read hub descriptor";
813 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
814 message = "hub has too many ports!";
819 hdev->maxchild = hub->descriptor->bNbrPorts;
820 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
821 (hdev->maxchild == 1) ? "" : "s");
823 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
825 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
827 char portstr [USB_MAXCHILDREN + 1];
829 for (i = 0; i < hdev->maxchild; i++)
830 portstr[i] = hub->descriptor->DeviceRemovable
831 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
833 portstr[hdev->maxchild] = 0;
834 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
836 dev_dbg(hub_dev, "standalone hub\n");
838 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
840 dev_dbg(hub_dev, "ganged power switching\n");
843 dev_dbg(hub_dev, "individual port power switching\n");
847 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
851 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
853 dev_dbg(hub_dev, "global over-current protection\n");
856 dev_dbg(hub_dev, "individual port over-current protection\n");
860 dev_dbg(hub_dev, "no over-current protection\n");
864 spin_lock_init (&hub->tt.lock);
865 INIT_LIST_HEAD (&hub->tt.clear_list);
866 INIT_WORK (&hub->tt.kevent, hub_tt_kevent);
867 switch (hdev->descriptor.bDeviceProtocol) {
871 dev_dbg(hub_dev, "Single TT\n");
875 ret = usb_set_interface(hdev, 0, 1);
877 dev_dbg(hub_dev, "TT per port\n");
880 dev_err(hub_dev, "Using single TT (err %d)\n",
885 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
886 hdev->descriptor.bDeviceProtocol);
890 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
891 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
892 case HUB_TTTT_8_BITS:
893 if (hdev->descriptor.bDeviceProtocol != 0) {
894 hub->tt.think_time = 666;
895 dev_dbg(hub_dev, "TT requires at most %d "
896 "FS bit times (%d ns)\n",
897 8, hub->tt.think_time);
900 case HUB_TTTT_16_BITS:
901 hub->tt.think_time = 666 * 2;
902 dev_dbg(hub_dev, "TT requires at most %d "
903 "FS bit times (%d ns)\n",
904 16, hub->tt.think_time);
906 case HUB_TTTT_24_BITS:
907 hub->tt.think_time = 666 * 3;
908 dev_dbg(hub_dev, "TT requires at most %d "
909 "FS bit times (%d ns)\n",
910 24, hub->tt.think_time);
912 case HUB_TTTT_32_BITS:
913 hub->tt.think_time = 666 * 4;
914 dev_dbg(hub_dev, "TT requires at most %d "
915 "FS bit times (%d ns)\n",
916 32, hub->tt.think_time);
920 /* probe() zeroes hub->indicator[] */
921 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
922 hub->has_indicators = 1;
923 dev_dbg(hub_dev, "Port indicators are supported\n");
926 dev_dbg(hub_dev, "power on to power good time: %dms\n",
927 hub->descriptor->bPwrOn2PwrGood * 2);
929 /* power budgeting mostly matters with bus-powered hubs,
930 * and battery-powered root hubs (may provide just 8 mA).
932 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
934 message = "can't get hub status";
937 le16_to_cpus(&hubstatus);
938 if (hdev == hdev->bus->root_hub) {
939 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
940 hub->mA_per_port = 500;
942 hub->mA_per_port = hdev->bus_mA;
943 hub->limited_power = 1;
945 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
946 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
947 hub->descriptor->bHubContrCurrent);
948 hub->limited_power = 1;
949 if (hdev->maxchild > 0) {
950 int remaining = hdev->bus_mA -
951 hub->descriptor->bHubContrCurrent;
953 if (remaining < hdev->maxchild * 100)
955 "insufficient power available "
956 "to use all downstream ports\n");
957 hub->mA_per_port = 100; /* 7.2.1.1 */
959 } else { /* Self-powered external hub */
960 /* FIXME: What about battery-powered external hubs that
961 * provide less current per port? */
962 hub->mA_per_port = 500;
964 if (hub->mA_per_port < 500)
965 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
968 ret = hub_hub_status(hub, &hubstatus, &hubchange);
970 message = "can't get hub status";
974 /* local power status reports aren't always correct */
975 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
976 dev_dbg(hub_dev, "local power source is %s\n",
977 (hubstatus & HUB_STATUS_LOCAL_POWER)
978 ? "lost (inactive)" : "good");
980 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
981 dev_dbg(hub_dev, "%sover-current condition exists\n",
982 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
984 /* set up the interrupt endpoint
985 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
986 * bytes as USB2.0[11.12.3] says because some hubs are known
987 * to send more data (and thus cause overflow). For root hubs,
988 * maxpktsize is defined in hcd.c's fake endpoint descriptors
989 * to be big enough for at least USB_MAXCHILDREN ports. */
990 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
991 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
993 if (maxp > sizeof(*hub->buffer))
994 maxp = sizeof(*hub->buffer);
996 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
998 message = "couldn't allocate interrupt urb";
1003 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1004 hub, endpoint->bInterval);
1005 hub->urb->transfer_dma = hub->buffer_dma;
1006 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1008 /* maybe cycle the hub leds */
1009 if (hub->has_indicators && blinkenlights)
1010 hub->indicator [0] = INDICATOR_CYCLE;
1017 dev_err (hub_dev, "config failed, %s (err %d)\n",
1019 /* hub_disconnect() frees urb and descriptor */
1023 static void hub_release(struct kref *kref)
1025 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1027 usb_put_intf(to_usb_interface(hub->intfdev));
1031 static unsigned highspeed_hubs;
1033 static void hub_disconnect(struct usb_interface *intf)
1035 struct usb_hub *hub = usb_get_intfdata (intf);
1037 /* Take the hub off the event list and don't let it be added again */
1038 spin_lock_irq(&hub_event_lock);
1039 list_del_init(&hub->event_list);
1040 hub->disconnected = 1;
1041 spin_unlock_irq(&hub_event_lock);
1043 /* Disconnect all children and quiesce the hub */
1047 usb_set_intfdata (intf, NULL);
1049 if (hub->hdev->speed == USB_SPEED_HIGH)
1052 usb_free_urb(hub->urb);
1053 kfree(hub->descriptor);
1055 usb_buffer_free(hub->hdev, sizeof(*hub->buffer), hub->buffer,
1058 kref_put(&hub->kref, hub_release);
1061 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1063 struct usb_host_interface *desc;
1064 struct usb_endpoint_descriptor *endpoint;
1065 struct usb_device *hdev;
1066 struct usb_hub *hub;
1068 desc = intf->cur_altsetting;
1069 hdev = interface_to_usbdev(intf);
1071 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1073 dev_warn(&intf->dev, "ignoring external hub\n");
1078 /* Some hubs have a subclass of 1, which AFAICT according to the */
1079 /* specs is not defined, but it works */
1080 if ((desc->desc.bInterfaceSubClass != 0) &&
1081 (desc->desc.bInterfaceSubClass != 1)) {
1083 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1087 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1088 if (desc->desc.bNumEndpoints != 1)
1089 goto descriptor_error;
1091 endpoint = &desc->endpoint[0].desc;
1093 /* If it's not an interrupt in endpoint, we'd better punt! */
1094 if (!usb_endpoint_is_int_in(endpoint))
1095 goto descriptor_error;
1097 /* We found a hub */
1098 dev_info (&intf->dev, "USB hub found\n");
1100 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1102 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1106 kref_init(&hub->kref);
1107 INIT_LIST_HEAD(&hub->event_list);
1108 hub->intfdev = &intf->dev;
1110 INIT_DELAYED_WORK(&hub->leds, led_work);
1113 usb_set_intfdata (intf, hub);
1114 intf->needs_remote_wakeup = 1;
1116 if (hdev->speed == USB_SPEED_HIGH)
1119 if (hub_configure(hub, endpoint) >= 0)
1122 hub_disconnect (intf);
1127 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1129 struct usb_device *hdev = interface_to_usbdev (intf);
1131 /* assert ifno == 0 (part of hub spec) */
1133 case USBDEVFS_HUB_PORTINFO: {
1134 struct usbdevfs_hub_portinfo *info = user_data;
1137 spin_lock_irq(&device_state_lock);
1138 if (hdev->devnum <= 0)
1141 info->nports = hdev->maxchild;
1142 for (i = 0; i < info->nports; i++) {
1143 if (hdev->children[i] == NULL)
1147 hdev->children[i]->devnum;
1150 spin_unlock_irq(&device_state_lock);
1152 return info->nports + 1;
1161 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1165 for (i = 0; i < udev->maxchild; ++i) {
1166 if (udev->children[i])
1167 recursively_mark_NOTATTACHED(udev->children[i]);
1169 if (udev->state == USB_STATE_SUSPENDED) {
1170 udev->discon_suspended = 1;
1171 udev->active_duration -= jiffies;
1173 udev->state = USB_STATE_NOTATTACHED;
1177 * usb_set_device_state - change a device's current state (usbcore, hcds)
1178 * @udev: pointer to device whose state should be changed
1179 * @new_state: new state value to be stored
1181 * udev->state is _not_ fully protected by the device lock. Although
1182 * most transitions are made only while holding the lock, the state can
1183 * can change to USB_STATE_NOTATTACHED at almost any time. This
1184 * is so that devices can be marked as disconnected as soon as possible,
1185 * without having to wait for any semaphores to be released. As a result,
1186 * all changes to any device's state must be protected by the
1187 * device_state_lock spinlock.
1189 * Once a device has been added to the device tree, all changes to its state
1190 * should be made using this routine. The state should _not_ be set directly.
1192 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1193 * Otherwise udev->state is set to new_state, and if new_state is
1194 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1195 * to USB_STATE_NOTATTACHED.
1197 void usb_set_device_state(struct usb_device *udev,
1198 enum usb_device_state new_state)
1200 unsigned long flags;
1202 spin_lock_irqsave(&device_state_lock, flags);
1203 if (udev->state == USB_STATE_NOTATTACHED)
1205 else if (new_state != USB_STATE_NOTATTACHED) {
1207 /* root hub wakeup capabilities are managed out-of-band
1208 * and may involve silicon errata ... ignore them here.
1211 if (udev->state == USB_STATE_SUSPENDED
1212 || new_state == USB_STATE_SUSPENDED)
1213 ; /* No change to wakeup settings */
1214 else if (new_state == USB_STATE_CONFIGURED)
1215 device_init_wakeup(&udev->dev,
1216 (udev->actconfig->desc.bmAttributes
1217 & USB_CONFIG_ATT_WAKEUP));
1219 device_init_wakeup(&udev->dev, 0);
1221 if (udev->state == USB_STATE_SUSPENDED &&
1222 new_state != USB_STATE_SUSPENDED)
1223 udev->active_duration -= jiffies;
1224 else if (new_state == USB_STATE_SUSPENDED &&
1225 udev->state != USB_STATE_SUSPENDED)
1226 udev->active_duration += jiffies;
1227 udev->state = new_state;
1229 recursively_mark_NOTATTACHED(udev);
1230 spin_unlock_irqrestore(&device_state_lock, flags);
1234 * WUSB devices are simple: they have no hubs behind, so the mapping
1235 * device <-> virtual port number becomes 1:1. Why? to simplify the
1236 * life of the device connection logic in
1237 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1238 * handshake we need to assign a temporary address in the unauthorized
1239 * space. For simplicity we use the first virtual port number found to
1240 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1241 * and that becomes it's address [X < 128] or its unauthorized address
1244 * We add 1 as an offset to the one-based USB-stack port number
1245 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1246 * 0 is reserved by USB for default address; (b) Linux's USB stack
1247 * uses always #1 for the root hub of the controller. So USB stack's
1248 * port #1, which is wusb virtual-port #0 has address #2.
1250 static void choose_address(struct usb_device *udev)
1253 struct usb_bus *bus = udev->bus;
1255 /* If khubd ever becomes multithreaded, this will need a lock */
1257 devnum = udev->portnum + 1;
1258 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1260 /* Try to allocate the next devnum beginning at
1261 * bus->devnum_next. */
1262 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1265 devnum = find_next_zero_bit(bus->devmap.devicemap,
1267 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1270 set_bit(devnum, bus->devmap.devicemap);
1271 udev->devnum = devnum;
1275 static void release_address(struct usb_device *udev)
1277 if (udev->devnum > 0) {
1278 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1283 static void update_address(struct usb_device *udev, int devnum)
1285 /* The address for a WUSB device is managed by wusbcore. */
1287 udev->devnum = devnum;
1290 #ifdef CONFIG_USB_SUSPEND
1292 static void usb_stop_pm(struct usb_device *udev)
1294 /* Synchronize with the ksuspend thread to prevent any more
1295 * autosuspend requests from being submitted, and decrement
1296 * the parent's count of unsuspended children.
1299 if (udev->parent && !udev->discon_suspended)
1300 usb_autosuspend_device(udev->parent);
1301 usb_pm_unlock(udev);
1303 /* Stop any autosuspend requests already submitted */
1304 cancel_rearming_delayed_work(&udev->autosuspend);
1309 static inline void usb_stop_pm(struct usb_device *udev)
1315 * usb_disconnect - disconnect a device (usbcore-internal)
1316 * @pdev: pointer to device being disconnected
1317 * Context: !in_interrupt ()
1319 * Something got disconnected. Get rid of it and all of its children.
1321 * If *pdev is a normal device then the parent hub must already be locked.
1322 * If *pdev is a root hub then this routine will acquire the
1323 * usb_bus_list_lock on behalf of the caller.
1325 * Only hub drivers (including virtual root hub drivers for host
1326 * controllers) should ever call this.
1328 * This call is synchronous, and may not be used in an interrupt context.
1330 void usb_disconnect(struct usb_device **pdev)
1332 struct usb_device *udev = *pdev;
1336 pr_debug ("%s nodev\n", __func__);
1340 /* mark the device as inactive, so any further urb submissions for
1341 * this device (and any of its children) will fail immediately.
1342 * this quiesces everyting except pending urbs.
1344 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1345 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1347 usb_lock_device(udev);
1349 /* Free up all the children before we remove this device */
1350 for (i = 0; i < USB_MAXCHILDREN; i++) {
1351 if (udev->children[i])
1352 usb_disconnect(&udev->children[i]);
1355 /* deallocate hcd/hardware state ... nuking all pending urbs and
1356 * cleaning up all state associated with the current configuration
1357 * so that the hardware is now fully quiesced.
1359 dev_dbg (&udev->dev, "unregistering device\n");
1360 usb_disable_device(udev, 0);
1362 usb_unlock_device(udev);
1364 /* Remove the device-specific files from sysfs. This must be
1365 * done with udev unlocked, because some of the attribute
1366 * routines try to acquire the device lock.
1368 usb_remove_sysfs_dev_files(udev);
1370 /* Unregister the device. The device driver is responsible
1371 * for removing the device files from usbfs and sysfs and for
1372 * de-configuring the device.
1374 device_del(&udev->dev);
1376 /* Free the device number and delete the parent's children[]
1377 * (or root_hub) pointer.
1379 release_address(udev);
1381 /* Avoid races with recursively_mark_NOTATTACHED() */
1382 spin_lock_irq(&device_state_lock);
1384 spin_unlock_irq(&device_state_lock);
1388 put_device(&udev->dev);
1391 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1392 static void show_string(struct usb_device *udev, char *id, char *string)
1396 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1399 static void announce_device(struct usb_device *udev)
1401 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1402 le16_to_cpu(udev->descriptor.idVendor),
1403 le16_to_cpu(udev->descriptor.idProduct));
1404 dev_info(&udev->dev, "New USB device strings: Mfr=%d, Product=%d, "
1405 "SerialNumber=%d\n",
1406 udev->descriptor.iManufacturer,
1407 udev->descriptor.iProduct,
1408 udev->descriptor.iSerialNumber);
1409 show_string(udev, "Product", udev->product);
1410 show_string(udev, "Manufacturer", udev->manufacturer);
1411 show_string(udev, "SerialNumber", udev->serial);
1414 static inline void announce_device(struct usb_device *udev) { }
1417 #ifdef CONFIG_USB_OTG
1418 #include "otg_whitelist.h"
1422 * usb_configure_device_otg - FIXME (usbcore-internal)
1423 * @udev: newly addressed device (in ADDRESS state)
1425 * Do configuration for On-The-Go devices
1427 static int usb_configure_device_otg(struct usb_device *udev)
1431 #ifdef CONFIG_USB_OTG
1433 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1434 * to wake us after we've powered off VBUS; and HNP, switching roles
1435 * "host" to "peripheral". The OTG descriptor helps figure this out.
1437 if (!udev->bus->is_b_host
1439 && udev->parent == udev->bus->root_hub) {
1440 struct usb_otg_descriptor *desc = 0;
1441 struct usb_bus *bus = udev->bus;
1443 /* descriptor may appear anywhere in config */
1444 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1445 le16_to_cpu(udev->config[0].desc.wTotalLength),
1446 USB_DT_OTG, (void **) &desc) == 0) {
1447 if (desc->bmAttributes & USB_OTG_HNP) {
1448 unsigned port1 = udev->portnum;
1450 dev_info(&udev->dev,
1451 "Dual-Role OTG device on %sHNP port\n",
1452 (port1 == bus->otg_port)
1455 /* enable HNP before suspend, it's simpler */
1456 if (port1 == bus->otg_port)
1457 bus->b_hnp_enable = 1;
1458 err = usb_control_msg(udev,
1459 usb_sndctrlpipe(udev, 0),
1460 USB_REQ_SET_FEATURE, 0,
1462 ? USB_DEVICE_B_HNP_ENABLE
1463 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1464 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1466 /* OTG MESSAGE: report errors here,
1467 * customize to match your product.
1469 dev_info(&udev->dev,
1470 "can't set HNP mode; %d\n",
1472 bus->b_hnp_enable = 0;
1478 if (!is_targeted(udev)) {
1480 /* Maybe it can talk to us, though we can't talk to it.
1481 * (Includes HNP test device.)
1483 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1484 err = usb_port_suspend(udev);
1486 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1498 * usb_configure_device - Detect and probe device intfs/otg (usbcore-internal)
1499 * @udev: newly addressed device (in ADDRESS state)
1501 * This is only called by usb_new_device() and usb_authorize_device()
1502 * and FIXME -- all comments that apply to them apply here wrt to
1505 * If the device is WUSB and not authorized, we don't attempt to read
1506 * the string descriptors, as they will be errored out by the device
1507 * until it has been authorized.
1509 static int usb_configure_device(struct usb_device *udev)
1513 if (udev->config == NULL) {
1514 err = usb_get_configuration(udev);
1516 dev_err(&udev->dev, "can't read configurations, error %d\n",
1521 if (udev->wusb == 1 && udev->authorized == 0) {
1522 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1523 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1524 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1527 /* read the standard strings and cache them if present */
1528 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1529 udev->manufacturer = usb_cache_string(udev,
1530 udev->descriptor.iManufacturer);
1531 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1533 err = usb_configure_device_otg(udev);
1540 * usb_new_device - perform initial device setup (usbcore-internal)
1541 * @udev: newly addressed device (in ADDRESS state)
1543 * This is called with devices which have been enumerated, but not yet
1544 * configured. The device descriptor is available, but not descriptors
1545 * for any device configuration. The caller must have locked either
1546 * the parent hub (if udev is a normal device) or else the
1547 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1548 * udev has already been installed, but udev is not yet visible through
1549 * sysfs or other filesystem code.
1551 * It will return if the device is configured properly or not. Zero if
1552 * the interface was registered with the driver core; else a negative
1555 * This call is synchronous, and may not be used in an interrupt context.
1557 * Only the hub driver or root-hub registrar should ever call this.
1559 int usb_new_device(struct usb_device *udev)
1563 usb_detect_quirks(udev); /* Determine quirks */
1564 err = usb_configure_device(udev); /* detect & probe dev/intfs */
1567 /* export the usbdev device-node for libusb */
1568 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1569 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1571 /* Increment the parent's count of unsuspended children */
1573 usb_autoresume_device(udev->parent);
1575 /* Register the device. The device driver is responsible
1576 * for adding the device files to sysfs and for configuring
1579 err = device_add(&udev->dev);
1581 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1585 /* put device-specific files into sysfs */
1586 usb_create_sysfs_dev_files(udev);
1588 /* Tell the world! */
1589 announce_device(udev);
1593 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1599 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1600 * @usb_dev: USB device
1602 * Move the USB device to a very basic state where interfaces are disabled
1603 * and the device is in fact unconfigured and unusable.
1605 * We share a lock (that we have) with device_del(), so we need to
1608 int usb_deauthorize_device(struct usb_device *usb_dev)
1611 usb_lock_device(usb_dev);
1612 if (usb_dev->authorized == 0)
1613 goto out_unauthorized;
1614 usb_dev->authorized = 0;
1615 usb_set_configuration(usb_dev, -1);
1616 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1617 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1618 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1619 kfree(usb_dev->config);
1620 usb_dev->config = NULL;
1621 for (cnt = 0; cnt < usb_dev->descriptor.bNumConfigurations; cnt++)
1622 kfree(usb_dev->rawdescriptors[cnt]);
1623 usb_dev->descriptor.bNumConfigurations = 0;
1624 kfree(usb_dev->rawdescriptors);
1626 usb_unlock_device(usb_dev);
1631 int usb_authorize_device(struct usb_device *usb_dev)
1634 usb_lock_device(usb_dev);
1635 if (usb_dev->authorized == 1)
1636 goto out_authorized;
1637 kfree(usb_dev->product);
1638 usb_dev->product = NULL;
1639 kfree(usb_dev->manufacturer);
1640 usb_dev->manufacturer = NULL;
1641 kfree(usb_dev->serial);
1642 usb_dev->serial = NULL;
1643 result = usb_autoresume_device(usb_dev);
1645 dev_err(&usb_dev->dev,
1646 "can't autoresume for authorization: %d\n", result);
1647 goto error_autoresume;
1649 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
1651 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
1652 "authorization: %d\n", result);
1653 goto error_device_descriptor;
1655 usb_dev->authorized = 1;
1656 result = usb_configure_device(usb_dev);
1658 goto error_configure;
1659 /* Choose and set the configuration. This registers the interfaces
1660 * with the driver core and lets interface drivers bind to them.
1662 c = usb_choose_configuration(usb_dev);
1664 result = usb_set_configuration(usb_dev, c);
1666 dev_err(&usb_dev->dev,
1667 "can't set config #%d, error %d\n", c, result);
1668 /* This need not be fatal. The user can try to
1669 * set other configurations. */
1672 dev_info(&usb_dev->dev, "authorized to connect\n");
1674 error_device_descriptor:
1677 usb_unlock_device(usb_dev); // complements locktree
1682 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1683 static unsigned hub_is_wusb(struct usb_hub *hub)
1685 struct usb_hcd *hcd;
1686 if (hub->hdev->parent != NULL) /* not a root hub? */
1688 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
1689 return hcd->wireless;
1693 #define PORT_RESET_TRIES 5
1694 #define SET_ADDRESS_TRIES 2
1695 #define GET_DESCRIPTOR_TRIES 2
1696 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1697 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1699 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1700 #define HUB_SHORT_RESET_TIME 10
1701 #define HUB_LONG_RESET_TIME 200
1702 #define HUB_RESET_TIMEOUT 500
1704 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1705 struct usb_device *udev, unsigned int delay)
1707 int delay_time, ret;
1711 for (delay_time = 0;
1712 delay_time < HUB_RESET_TIMEOUT;
1713 delay_time += delay) {
1714 /* wait to give the device a chance to reset */
1717 /* read and decode port status */
1718 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1722 /* Device went away? */
1723 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1726 /* bomb out completely if the connection bounced */
1727 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1730 /* if we`ve finished resetting, then break out of the loop */
1731 if (!(portstatus & USB_PORT_STAT_RESET) &&
1732 (portstatus & USB_PORT_STAT_ENABLE)) {
1733 if (hub_is_wusb(hub))
1734 udev->speed = USB_SPEED_VARIABLE;
1735 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1736 udev->speed = USB_SPEED_HIGH;
1737 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1738 udev->speed = USB_SPEED_LOW;
1740 udev->speed = USB_SPEED_FULL;
1744 /* switch to the long delay after two short delay failures */
1745 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1746 delay = HUB_LONG_RESET_TIME;
1748 dev_dbg (hub->intfdev,
1749 "port %d not reset yet, waiting %dms\n",
1756 static int hub_port_reset(struct usb_hub *hub, int port1,
1757 struct usb_device *udev, unsigned int delay)
1761 /* Block EHCI CF initialization during the port reset.
1762 * Some companion controllers don't like it when they mix.
1764 down_read(&ehci_cf_port_reset_rwsem);
1766 /* Reset the port */
1767 for (i = 0; i < PORT_RESET_TRIES; i++) {
1768 status = set_port_feature(hub->hdev,
1769 port1, USB_PORT_FEAT_RESET);
1771 dev_err(hub->intfdev,
1772 "cannot reset port %d (err = %d)\n",
1775 status = hub_port_wait_reset(hub, port1, udev, delay);
1776 if (status && status != -ENOTCONN)
1777 dev_dbg(hub->intfdev,
1778 "port_wait_reset: err = %d\n",
1782 /* return on disconnect or reset */
1785 /* TRSTRCY = 10 ms; plus some extra */
1787 update_address(udev, 0);
1791 clear_port_feature(hub->hdev,
1792 port1, USB_PORT_FEAT_C_RESET);
1793 /* FIXME need disconnect() for NOTATTACHED device */
1794 usb_set_device_state(udev, status
1795 ? USB_STATE_NOTATTACHED
1796 : USB_STATE_DEFAULT);
1800 dev_dbg (hub->intfdev,
1801 "port %d not enabled, trying reset again...\n",
1803 delay = HUB_LONG_RESET_TIME;
1806 dev_err (hub->intfdev,
1807 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1811 up_read(&ehci_cf_port_reset_rwsem);
1817 #ifdef CONFIG_USB_SUSPEND
1820 * usb_port_suspend - suspend a usb device's upstream port
1821 * @udev: device that's no longer in active use, not a root hub
1822 * Context: must be able to sleep; device not locked; pm locks held
1824 * Suspends a USB device that isn't in active use, conserving power.
1825 * Devices may wake out of a suspend, if anything important happens,
1826 * using the remote wakeup mechanism. They may also be taken out of
1827 * suspend by the host, using usb_port_resume(). It's also routine
1828 * to disconnect devices while they are suspended.
1830 * This only affects the USB hardware for a device; its interfaces
1831 * (and, for hubs, child devices) must already have been suspended.
1833 * Selective port suspend reduces power; most suspended devices draw
1834 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1835 * All devices below the suspended port are also suspended.
1837 * Devices leave suspend state when the host wakes them up. Some devices
1838 * also support "remote wakeup", where the device can activate the USB
1839 * tree above them to deliver data, such as a keypress or packet. In
1840 * some cases, this wakes the USB host.
1842 * Suspending OTG devices may trigger HNP, if that's been enabled
1843 * between a pair of dual-role devices. That will change roles, such
1844 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1846 * Devices on USB hub ports have only one "suspend" state, corresponding
1847 * to ACPI D2, "may cause the device to lose some context".
1848 * State transitions include:
1850 * - suspend, resume ... when the VBUS power link stays live
1851 * - suspend, disconnect ... VBUS lost
1853 * Once VBUS drop breaks the circuit, the port it's using has to go through
1854 * normal re-enumeration procedures, starting with enabling VBUS power.
1855 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1856 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1857 * timer, no SRP, no requests through sysfs.
1859 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1860 * the root hub for their bus goes into global suspend ... so we don't
1861 * (falsely) update the device power state to say it suspended.
1863 * Returns 0 on success, else negative errno.
1865 int usb_port_suspend(struct usb_device *udev)
1867 struct usb_hub *hub = hdev_to_hub(udev->parent);
1868 int port1 = udev->portnum;
1871 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1873 /* enable remote wakeup when appropriate; this lets the device
1874 * wake up the upstream hub (including maybe the root hub).
1876 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1877 * we don't explicitly enable it here.
1879 if (udev->do_remote_wakeup) {
1880 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1881 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1882 USB_DEVICE_REMOTE_WAKEUP, 0,
1884 USB_CTRL_SET_TIMEOUT);
1886 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
1891 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1893 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
1895 /* paranoia: "should not happen" */
1896 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1897 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1898 USB_DEVICE_REMOTE_WAKEUP, 0,
1900 USB_CTRL_SET_TIMEOUT);
1902 /* device has up to 10 msec to fully suspend */
1903 dev_dbg(&udev->dev, "usb %ssuspend\n",
1904 udev->auto_pm ? "auto-" : "");
1905 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1912 * If the USB "suspend" state is in use (rather than "global suspend"),
1913 * many devices will be individually taken out of suspend state using
1914 * special "resume" signaling. This routine kicks in shortly after
1915 * hardware resume signaling is finished, either because of selective
1916 * resume (by host) or remote wakeup (by device) ... now see what changed
1917 * in the tree that's rooted at this device.
1919 * If @udev->reset_resume is set then the device is reset before the
1920 * status check is done.
1922 static int finish_port_resume(struct usb_device *udev)
1927 /* caller owns the udev device lock */
1928 dev_dbg(&udev->dev, "finish %sresume\n",
1929 udev->reset_resume ? "reset-" : "");
1931 /* usb ch9 identifies four variants of SUSPENDED, based on what
1932 * state the device resumes to. Linux currently won't see the
1933 * first two on the host side; they'd be inside hub_port_init()
1934 * during many timeouts, but khubd can't suspend until later.
1936 usb_set_device_state(udev, udev->actconfig
1937 ? USB_STATE_CONFIGURED
1938 : USB_STATE_ADDRESS);
1940 /* 10.5.4.5 says not to reset a suspended port if the attached
1941 * device is enabled for remote wakeup. Hence the reset
1942 * operation is carried out here, after the port has been
1945 if (udev->reset_resume)
1946 status = usb_reset_device(udev);
1948 /* 10.5.4.5 says be sure devices in the tree are still there.
1949 * For now let's assume the device didn't go crazy on resume,
1950 * and device drivers will know about any resume quirks.
1954 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
1956 status = (status > 0 ? 0 : -ENODEV);
1960 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
1962 } else if (udev->actconfig) {
1963 le16_to_cpus(&devstatus);
1964 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
1965 status = usb_control_msg(udev,
1966 usb_sndctrlpipe(udev, 0),
1967 USB_REQ_CLEAR_FEATURE,
1969 USB_DEVICE_REMOTE_WAKEUP, 0,
1971 USB_CTRL_SET_TIMEOUT);
1973 dev_dbg(&udev->dev, "disable remote "
1974 "wakeup, status %d\n", status);
1982 * usb_port_resume - re-activate a suspended usb device's upstream port
1983 * @udev: device to re-activate, not a root hub
1984 * Context: must be able to sleep; device not locked; pm locks held
1986 * This will re-activate the suspended device, increasing power usage
1987 * while letting drivers communicate again with its endpoints.
1988 * USB resume explicitly guarantees that the power session between
1989 * the host and the device is the same as it was when the device
1992 * If @udev->reset_resume is set then this routine won't check that the
1993 * port is still enabled. Furthermore, finish_port_resume() above will
1994 * reset @udev. The end result is that a broken power session can be
1995 * recovered and @udev will appear to persist across a loss of VBUS power.
1997 * For example, if a host controller doesn't maintain VBUS suspend current
1998 * during a system sleep or is reset when the system wakes up, all the USB
1999 * power sessions below it will be broken. This is especially troublesome
2000 * for mass-storage devices containing mounted filesystems, since the
2001 * device will appear to have disconnected and all the memory mappings
2002 * to it will be lost. Using the USB_PERSIST facility, the device can be
2003 * made to appear as if it had not disconnected.
2005 * This facility can be dangerous. Although usb_reset_device() makes
2006 * every effort to insure that the same device is present after the
2007 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2008 * quite possible for a device to remain unaltered but its media to be
2009 * changed. If the user replaces a flash memory card while the system is
2010 * asleep, he will have only himself to blame when the filesystem on the
2011 * new card is corrupted and the system crashes.
2013 * Returns 0 on success, else negative errno.
2015 int usb_port_resume(struct usb_device *udev)
2017 struct usb_hub *hub = hdev_to_hub(udev->parent);
2018 int port1 = udev->portnum;
2020 u16 portchange, portstatus;
2021 unsigned mask_flags, want_flags;
2023 /* Skip the initial Clear-Suspend step for a remote wakeup */
2024 status = hub_port_status(hub, port1, &portstatus, &portchange);
2025 if (status == 0 && !(portstatus & USB_PORT_STAT_SUSPEND))
2026 goto SuspendCleared;
2028 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2030 set_bit(port1, hub->busy_bits);
2032 /* see 7.1.7.7; affects power usage, but not budgeting */
2033 status = clear_port_feature(hub->hdev,
2034 port1, USB_PORT_FEAT_SUSPEND);
2036 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
2039 /* drive resume for at least 20 msec */
2040 dev_dbg(&udev->dev, "usb %sresume\n",
2041 udev->auto_pm ? "auto-" : "");
2044 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2045 * stop resume signaling. Then finish the resume
2048 status = hub_port_status(hub, port1, &portstatus, &portchange);
2051 if (udev->reset_resume)
2052 want_flags = USB_PORT_STAT_POWER
2053 | USB_PORT_STAT_CONNECTION;
2055 want_flags = USB_PORT_STAT_POWER
2056 | USB_PORT_STAT_CONNECTION
2057 | USB_PORT_STAT_ENABLE;
2058 mask_flags = want_flags | USB_PORT_STAT_SUSPEND;
2060 if (status < 0 || (portstatus & mask_flags) != want_flags) {
2061 dev_dbg(hub->intfdev,
2062 "port %d status %04x.%04x after resume, %d\n",
2063 port1, portchange, portstatus, status);
2067 if (portchange & USB_PORT_STAT_C_SUSPEND)
2068 clear_port_feature(hub->hdev, port1,
2069 USB_PORT_FEAT_C_SUSPEND);
2070 /* TRSMRCY = 10 msec */
2075 clear_bit(port1, hub->busy_bits);
2076 if (!hub->hdev->parent && !hub->busy_bits[0])
2077 usb_enable_root_hub_irq(hub->hdev->bus);
2080 status = finish_port_resume(udev);
2082 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2083 hub_port_logical_disconnect(hub, port1);
2088 static int remote_wakeup(struct usb_device *udev)
2092 usb_lock_device(udev);
2093 if (udev->state == USB_STATE_SUSPENDED) {
2094 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
2095 usb_mark_last_busy(udev);
2096 status = usb_external_resume_device(udev);
2098 usb_unlock_device(udev);
2102 #else /* CONFIG_USB_SUSPEND */
2104 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2106 int usb_port_suspend(struct usb_device *udev)
2111 int usb_port_resume(struct usb_device *udev)
2115 /* However we may need to do a reset-resume */
2116 if (udev->reset_resume) {
2117 dev_dbg(&udev->dev, "reset-resume\n");
2118 status = usb_reset_device(udev);
2123 static inline int remote_wakeup(struct usb_device *udev)
2130 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
2132 struct usb_hub *hub = usb_get_intfdata (intf);
2133 struct usb_device *hdev = hub->hdev;
2136 /* fail if children aren't already suspended */
2137 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2138 struct usb_device *udev;
2140 udev = hdev->children [port1-1];
2141 if (udev && udev->can_submit) {
2143 dev_dbg(&intf->dev, "port %d nyet suspended\n",
2149 dev_dbg(&intf->dev, "%s\n", __func__);
2151 /* stop khubd and related activity */
2156 static int hub_resume(struct usb_interface *intf)
2158 struct usb_hub *hub = usb_get_intfdata(intf);
2160 dev_dbg(&intf->dev, "%s\n", __func__);
2161 hub_restart(hub, HUB_RESUME);
2165 static int hub_reset_resume(struct usb_interface *intf)
2167 struct usb_hub *hub = usb_get_intfdata(intf);
2169 dev_dbg(&intf->dev, "%s\n", __func__);
2171 hub_restart(hub, HUB_RESET_RESUME);
2176 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2177 * @rhdev: struct usb_device for the root hub
2179 * The USB host controller driver calls this function when its root hub
2180 * is resumed and Vbus power has been interrupted or the controller
2181 * has been reset. The routine marks @rhdev as having lost power.
2182 * When the hub driver is resumed it will take notice and carry out
2183 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2184 * the others will be disconnected.
2186 void usb_root_hub_lost_power(struct usb_device *rhdev)
2188 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
2189 rhdev->reset_resume = 1;
2191 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
2193 #else /* CONFIG_PM */
2195 static inline int remote_wakeup(struct usb_device *udev)
2200 #define hub_suspend NULL
2201 #define hub_resume NULL
2202 #define hub_reset_resume NULL
2206 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2208 * Between connect detection and reset signaling there must be a delay
2209 * of 100ms at least for debounce and power-settling. The corresponding
2210 * timer shall restart whenever the downstream port detects a disconnect.
2212 * Apparently there are some bluetooth and irda-dongles and a number of
2213 * low-speed devices for which this debounce period may last over a second.
2214 * Not covered by the spec - but easy to deal with.
2216 * This implementation uses a 1500ms total debounce timeout; if the
2217 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2218 * every 25ms for transient disconnects. When the port status has been
2219 * unchanged for 100ms it returns the port status.
2222 #define HUB_DEBOUNCE_TIMEOUT 1500
2223 #define HUB_DEBOUNCE_STEP 25
2224 #define HUB_DEBOUNCE_STABLE 100
2226 static int hub_port_debounce(struct usb_hub *hub, int port1)
2229 int total_time, stable_time = 0;
2230 u16 portchange, portstatus;
2231 unsigned connection = 0xffff;
2233 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2234 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2238 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2239 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2240 stable_time += HUB_DEBOUNCE_STEP;
2241 if (stable_time >= HUB_DEBOUNCE_STABLE)
2245 connection = portstatus & USB_PORT_STAT_CONNECTION;
2248 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2249 clear_port_feature(hub->hdev, port1,
2250 USB_PORT_FEAT_C_CONNECTION);
2253 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2255 msleep(HUB_DEBOUNCE_STEP);
2258 dev_dbg (hub->intfdev,
2259 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2260 port1, total_time, stable_time, portstatus);
2262 if (stable_time < HUB_DEBOUNCE_STABLE)
2267 void usb_ep0_reinit(struct usb_device *udev)
2269 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
2270 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
2271 usb_enable_endpoint(udev, &udev->ep0);
2273 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
2275 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2276 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2278 static int hub_set_address(struct usb_device *udev, int devnum)
2284 if (udev->state == USB_STATE_ADDRESS)
2286 if (udev->state != USB_STATE_DEFAULT)
2288 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2289 USB_REQ_SET_ADDRESS, 0, devnum, 0,
2290 NULL, 0, USB_CTRL_SET_TIMEOUT);
2292 /* Device now using proper address. */
2293 update_address(udev, devnum);
2294 usb_set_device_state(udev, USB_STATE_ADDRESS);
2295 usb_ep0_reinit(udev);
2300 /* Reset device, (re)assign address, get device descriptor.
2301 * Device connection must be stable, no more debouncing needed.
2302 * Returns device in USB_STATE_ADDRESS, except on error.
2304 * If this is called for an already-existing device (as part of
2305 * usb_reset_device), the caller must own the device lock. For a
2306 * newly detected device that is not accessible through any global
2307 * pointers, it's not necessary to lock the device.
2310 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2313 static DEFINE_MUTEX(usb_address0_mutex);
2315 struct usb_device *hdev = hub->hdev;
2317 unsigned delay = HUB_SHORT_RESET_TIME;
2318 enum usb_device_speed oldspeed = udev->speed;
2320 int devnum = udev->devnum;
2322 /* root hub ports have a slightly longer reset period
2323 * (from USB 2.0 spec, section 7.1.7.5)
2325 if (!hdev->parent) {
2326 delay = HUB_ROOT_RESET_TIME;
2327 if (port1 == hdev->bus->otg_port)
2328 hdev->bus->b_hnp_enable = 0;
2331 /* Some low speed devices have problems with the quick delay, so */
2332 /* be a bit pessimistic with those devices. RHbug #23670 */
2333 if (oldspeed == USB_SPEED_LOW)
2334 delay = HUB_LONG_RESET_TIME;
2336 mutex_lock(&usb_address0_mutex);
2338 /* Reset the device; full speed may morph to high speed */
2339 retval = hub_port_reset(hub, port1, udev, delay);
2340 if (retval < 0) /* error or disconnect */
2342 /* success, speed is known */
2345 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2346 dev_dbg(&udev->dev, "device reset changed speed!\n");
2349 oldspeed = udev->speed;
2351 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2352 * it's fixed size except for full speed devices.
2353 * For Wireless USB devices, ep0 max packet is always 512 (tho
2354 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2356 switch (udev->speed) {
2357 case USB_SPEED_VARIABLE: /* fixed at 512 */
2358 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(512);
2360 case USB_SPEED_HIGH: /* fixed at 64 */
2361 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2363 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2364 /* to determine the ep0 maxpacket size, try to read
2365 * the device descriptor to get bMaxPacketSize0 and
2366 * then correct our initial guess.
2368 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2370 case USB_SPEED_LOW: /* fixed at 8 */
2371 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2378 switch (udev->speed) {
2379 case USB_SPEED_LOW: speed = "low"; break;
2380 case USB_SPEED_FULL: speed = "full"; break;
2381 case USB_SPEED_HIGH: speed = "high"; break;
2382 case USB_SPEED_VARIABLE:
2386 default: speed = "?"; break;
2388 dev_info (&udev->dev,
2389 "%s %s speed %sUSB device using %s and address %d\n",
2390 (udev->config) ? "reset" : "new", speed, type,
2391 udev->bus->controller->driver->name, devnum);
2393 /* Set up TT records, if needed */
2395 udev->tt = hdev->tt;
2396 udev->ttport = hdev->ttport;
2397 } else if (udev->speed != USB_SPEED_HIGH
2398 && hdev->speed == USB_SPEED_HIGH) {
2399 udev->tt = &hub->tt;
2400 udev->ttport = port1;
2403 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2404 * Because device hardware and firmware is sometimes buggy in
2405 * this area, and this is how Linux has done it for ages.
2406 * Change it cautiously.
2408 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2409 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2410 * so it may help with some non-standards-compliant devices.
2411 * Otherwise we start with SET_ADDRESS and then try to read the
2412 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2415 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2416 if (USE_NEW_SCHEME(retry_counter)) {
2417 struct usb_device_descriptor *buf;
2420 #define GET_DESCRIPTOR_BUFSIZE 64
2421 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2427 /* Retry on all errors; some devices are flakey.
2428 * 255 is for WUSB devices, we actually need to use
2429 * 512 (WUSB1.0[4.8.1]).
2431 for (j = 0; j < 3; ++j) {
2432 buf->bMaxPacketSize0 = 0;
2433 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2434 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2435 USB_DT_DEVICE << 8, 0,
2436 buf, GET_DESCRIPTOR_BUFSIZE,
2437 USB_CTRL_GET_TIMEOUT);
2438 switch (buf->bMaxPacketSize0) {
2439 case 8: case 16: case 32: case 64: case 255:
2440 if (buf->bDescriptorType ==
2454 udev->descriptor.bMaxPacketSize0 =
2455 buf->bMaxPacketSize0;
2458 retval = hub_port_reset(hub, port1, udev, delay);
2459 if (retval < 0) /* error or disconnect */
2461 if (oldspeed != udev->speed) {
2463 "device reset changed speed!\n");
2468 dev_err(&udev->dev, "device descriptor "
2469 "read/%s, error %d\n",
2474 #undef GET_DESCRIPTOR_BUFSIZE
2478 * If device is WUSB, we already assigned an
2479 * unauthorized address in the Connect Ack sequence;
2480 * authorization will assign the final address.
2482 if (udev->wusb == 0) {
2483 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2484 retval = hub_set_address(udev, devnum);
2491 "device not accepting address %d, error %d\n",
2496 /* cope with hardware quirkiness:
2497 * - let SET_ADDRESS settle, some device hardware wants it
2498 * - read ep0 maxpacket even for high and low speed,
2501 if (USE_NEW_SCHEME(retry_counter))
2505 retval = usb_get_device_descriptor(udev, 8);
2507 dev_err(&udev->dev, "device descriptor "
2508 "read/%s, error %d\n",
2520 i = udev->descriptor.bMaxPacketSize0 == 0xff? /* wusb device? */
2521 512 : udev->descriptor.bMaxPacketSize0;
2522 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2523 if (udev->speed != USB_SPEED_FULL ||
2524 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2525 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2529 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2530 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2531 usb_ep0_reinit(udev);
2534 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2535 if (retval < (signed)sizeof(udev->descriptor)) {
2536 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2547 hub_port_disable(hub, port1, 0);
2548 update_address(udev, devnum); /* for disconnect processing */
2550 mutex_unlock(&usb_address0_mutex);
2555 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2557 struct usb_qualifier_descriptor *qual;
2560 qual = kmalloc (sizeof *qual, GFP_KERNEL);
2564 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2565 qual, sizeof *qual);
2566 if (status == sizeof *qual) {
2567 dev_info(&udev->dev, "not running at top speed; "
2568 "connect to a high speed hub\n");
2569 /* hub LEDs are probably harder to miss than syslog */
2570 if (hub->has_indicators) {
2571 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2572 schedule_delayed_work (&hub->leds, 0);
2579 hub_power_remaining (struct usb_hub *hub)
2581 struct usb_device *hdev = hub->hdev;
2585 if (!hub->limited_power)
2588 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2589 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2590 struct usb_device *udev = hdev->children[port1 - 1];
2596 /* Unconfigured devices may not use more than 100mA,
2597 * or 8mA for OTG ports */
2598 if (udev->actconfig)
2599 delta = udev->actconfig->desc.bMaxPower * 2;
2600 else if (port1 != udev->bus->otg_port || hdev->parent)
2604 if (delta > hub->mA_per_port)
2605 dev_warn(&udev->dev, "%dmA is over %umA budget "
2607 delta, hub->mA_per_port, port1);
2610 if (remaining < 0) {
2611 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2618 /* Handle physical or logical connection change events.
2619 * This routine is called when:
2620 * a port connection-change occurs;
2621 * a port enable-change occurs (often caused by EMI);
2622 * usb_reset_device() encounters changed descriptors (as from
2623 * a firmware download)
2624 * caller already locked the hub
2626 static void hub_port_connect_change(struct usb_hub *hub, int port1,
2627 u16 portstatus, u16 portchange)
2629 struct usb_device *hdev = hub->hdev;
2630 struct device *hub_dev = hub->intfdev;
2631 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
2632 u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2636 "port %d, status %04x, change %04x, %s\n",
2637 port1, portstatus, portchange, portspeed (portstatus));
2639 if (hub->has_indicators) {
2640 set_port_led(hub, port1, HUB_LED_AUTO);
2641 hub->indicator[port1-1] = INDICATOR_AUTO;
2644 /* Disconnect any existing devices under this port */
2645 if (hdev->children[port1-1])
2646 usb_disconnect(&hdev->children[port1-1]);
2647 clear_bit(port1, hub->change_bits);
2649 #ifdef CONFIG_USB_OTG
2650 /* during HNP, don't repeat the debounce */
2651 if (hdev->bus->is_b_host)
2652 portchange &= ~USB_PORT_STAT_C_CONNECTION;
2655 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2656 status = hub_port_debounce(hub, port1);
2658 if (printk_ratelimit())
2659 dev_err (hub_dev, "connect-debounce failed, "
2660 "port %d disabled\n", port1);
2663 portstatus = status;
2666 /* Return now if nothing is connected */
2667 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2669 /* maybe switch power back on (e.g. root hub was reset) */
2670 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
2671 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2672 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2674 if (portstatus & USB_PORT_STAT_ENABLE)
2679 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2680 struct usb_device *udev;
2682 /* reallocate for each attempt, since references
2683 * to the previous one can escape in various ways
2685 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2688 "couldn't allocate port %d usb_device\n",
2693 usb_set_device_state(udev, USB_STATE_POWERED);
2694 udev->speed = USB_SPEED_UNKNOWN;
2695 udev->bus_mA = hub->mA_per_port;
2696 udev->level = hdev->level + 1;
2697 udev->wusb = hub_is_wusb(hub);
2699 /* set the address */
2700 choose_address(udev);
2701 if (udev->devnum <= 0) {
2702 status = -ENOTCONN; /* Don't retry */
2706 /* reset and get descriptor */
2707 status = hub_port_init(hub, udev, port1, i);
2711 /* consecutive bus-powered hubs aren't reliable; they can
2712 * violate the voltage drop budget. if the new child has
2713 * a "powered" LED, users should notice we didn't enable it
2714 * (without reading syslog), even without per-port LEDs
2717 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
2718 && udev->bus_mA <= 100) {
2721 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2724 dev_dbg(&udev->dev, "get status %d ?\n", status);
2727 le16_to_cpus(&devstat);
2728 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2730 "can't connect bus-powered hub "
2732 if (hub->has_indicators) {
2733 hub->indicator[port1-1] =
2734 INDICATOR_AMBER_BLINK;
2735 schedule_delayed_work (&hub->leds, 0);
2737 status = -ENOTCONN; /* Don't retry */
2742 /* check for devices running slower than they could */
2743 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2744 && udev->speed == USB_SPEED_FULL
2745 && highspeed_hubs != 0)
2746 check_highspeed (hub, udev, port1);
2748 /* Store the parent's children[] pointer. At this point
2749 * udev becomes globally accessible, although presumably
2750 * no one will look at it until hdev is unlocked.
2754 /* We mustn't add new devices if the parent hub has
2755 * been disconnected; we would race with the
2756 * recursively_mark_NOTATTACHED() routine.
2758 spin_lock_irq(&device_state_lock);
2759 if (hdev->state == USB_STATE_NOTATTACHED)
2762 hdev->children[port1-1] = udev;
2763 spin_unlock_irq(&device_state_lock);
2765 /* Run it through the hoops (find a driver, etc) */
2767 status = usb_new_device(udev);
2769 spin_lock_irq(&device_state_lock);
2770 hdev->children[port1-1] = NULL;
2771 spin_unlock_irq(&device_state_lock);
2778 status = hub_power_remaining(hub);
2780 dev_dbg(hub_dev, "%dmA power budget left\n", status);
2785 hub_port_disable(hub, port1, 1);
2787 usb_ep0_reinit(udev);
2788 release_address(udev);
2790 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
2793 if (hub->hdev->parent ||
2794 !hcd->driver->port_handed_over ||
2795 !(hcd->driver->port_handed_over)(hcd, port1))
2796 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
2800 hub_port_disable(hub, port1, 1);
2801 if (hcd->driver->relinquish_port && !hub->hdev->parent)
2802 hcd->driver->relinquish_port(hcd, port1);
2805 static void hub_events(void)
2807 struct list_head *tmp;
2808 struct usb_device *hdev;
2809 struct usb_interface *intf;
2810 struct usb_hub *hub;
2811 struct device *hub_dev;
2820 * We restart the list every time to avoid a deadlock with
2821 * deleting hubs downstream from this one. This should be
2822 * safe since we delete the hub from the event list.
2823 * Not the most efficient, but avoids deadlocks.
2827 /* Grab the first entry at the beginning of the list */
2828 spin_lock_irq(&hub_event_lock);
2829 if (list_empty(&hub_event_list)) {
2830 spin_unlock_irq(&hub_event_lock);
2834 tmp = hub_event_list.next;
2837 hub = list_entry(tmp, struct usb_hub, event_list);
2838 kref_get(&hub->kref);
2839 spin_unlock_irq(&hub_event_lock);
2842 hub_dev = hub->intfdev;
2843 intf = to_usb_interface(hub_dev);
2844 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
2845 hdev->state, hub->descriptor
2846 ? hub->descriptor->bNbrPorts
2848 /* NOTE: expects max 15 ports... */
2849 (u16) hub->change_bits[0],
2850 (u16) hub->event_bits[0]);
2852 /* Lock the device, then check to see if we were
2853 * disconnected while waiting for the lock to succeed. */
2854 usb_lock_device(hdev);
2855 if (unlikely(hub->disconnected))
2858 /* If the hub has died, clean up after it */
2859 if (hdev->state == USB_STATE_NOTATTACHED) {
2860 hub->error = -ENODEV;
2866 ret = usb_autopm_get_interface(intf);
2868 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
2872 /* If this is an inactive hub, do nothing */
2877 dev_dbg (hub_dev, "resetting for error %d\n",
2880 ret = usb_reset_composite_device(hdev, intf);
2883 "error resetting hub: %d\n", ret);
2891 /* deal with port status changes */
2892 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2893 if (test_bit(i, hub->busy_bits))
2895 connect_change = test_bit(i, hub->change_bits);
2896 if (!test_and_clear_bit(i, hub->event_bits) &&
2897 !connect_change && !hub->activating)
2900 ret = hub_port_status(hub, i,
2901 &portstatus, &portchange);
2905 if (hub->activating && !hdev->children[i-1] &&
2907 USB_PORT_STAT_CONNECTION))
2910 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2911 clear_port_feature(hdev, i,
2912 USB_PORT_FEAT_C_CONNECTION);
2916 if (portchange & USB_PORT_STAT_C_ENABLE) {
2917 if (!connect_change)
2919 "port %d enable change, "
2922 clear_port_feature(hdev, i,
2923 USB_PORT_FEAT_C_ENABLE);
2926 * EM interference sometimes causes badly
2927 * shielded USB devices to be shutdown by
2928 * the hub, this hack enables them again.
2929 * Works at least with mouse driver.
2931 if (!(portstatus & USB_PORT_STAT_ENABLE)
2933 && hdev->children[i-1]) {
2936 "disabled by hub (EMI?), "
2943 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2944 clear_port_feature(hdev, i,
2945 USB_PORT_FEAT_C_SUSPEND);
2946 if (hdev->children[i-1]) {
2947 ret = remote_wakeup(hdev->
2953 hub_port_disable(hub, i, 1);
2956 "resume on port %d, status %d\n",
2960 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2962 "over-current change on port %d\n",
2964 clear_port_feature(hdev, i,
2965 USB_PORT_FEAT_C_OVER_CURRENT);
2969 if (portchange & USB_PORT_STAT_C_RESET) {
2971 "reset change on port %d\n",
2973 clear_port_feature(hdev, i,
2974 USB_PORT_FEAT_C_RESET);
2978 hub_port_connect_change(hub, i,
2979 portstatus, portchange);
2982 /* deal with hub status changes */
2983 if (test_and_clear_bit(0, hub->event_bits) == 0)
2985 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2986 dev_err (hub_dev, "get_hub_status failed\n");
2988 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2989 dev_dbg (hub_dev, "power change\n");
2990 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
2991 if (hubstatus & HUB_STATUS_LOCAL_POWER)
2992 /* FIXME: Is this always true? */
2993 hub->limited_power = 1;
2995 hub->limited_power = 0;
2997 if (hubchange & HUB_CHANGE_OVERCURRENT) {
2998 dev_dbg (hub_dev, "overcurrent change\n");
2999 msleep(500); /* Cool down */
3000 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
3005 hub->activating = 0;
3007 /* If this is a root hub, tell the HCD it's okay to
3008 * re-enable port-change interrupts now. */
3009 if (!hdev->parent && !hub->busy_bits[0])
3010 usb_enable_root_hub_irq(hdev->bus);
3013 /* Allow autosuspend if we're not going to run again */
3014 if (list_empty(&hub->event_list))
3015 usb_autopm_enable(intf);
3017 usb_unlock_device(hdev);
3018 kref_put(&hub->kref, hub_release);
3020 } /* end while (1) */
3023 static int hub_thread(void *__unused)
3025 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3026 * port handover. Otherwise it might see that a full-speed device
3027 * was gone before the EHCI controller had handed its port over to
3028 * the companion full-speed controller.
3034 wait_event_freezable(khubd_wait,
3035 !list_empty(&hub_event_list) ||
3036 kthread_should_stop());
3037 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
3039 pr_debug("%s: khubd exiting\n", usbcore_name);
3043 static struct usb_device_id hub_id_table [] = {
3044 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
3045 .bDeviceClass = USB_CLASS_HUB},
3046 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
3047 .bInterfaceClass = USB_CLASS_HUB},
3048 { } /* Terminating entry */
3051 MODULE_DEVICE_TABLE (usb, hub_id_table);
3053 static struct usb_driver hub_driver = {
3056 .disconnect = hub_disconnect,
3057 .suspend = hub_suspend,
3058 .resume = hub_resume,
3059 .reset_resume = hub_reset_resume,
3060 .pre_reset = hub_pre_reset,
3061 .post_reset = hub_post_reset,
3063 .id_table = hub_id_table,
3064 .supports_autosuspend = 1,
3067 int usb_hub_init(void)
3069 if (usb_register(&hub_driver) < 0) {
3070 printk(KERN_ERR "%s: can't register hub driver\n",
3075 khubd_task = kthread_run(hub_thread, NULL, "khubd");
3076 if (!IS_ERR(khubd_task))
3079 /* Fall through if kernel_thread failed */
3080 usb_deregister(&hub_driver);
3081 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
3086 void usb_hub_cleanup(void)
3088 kthread_stop(khubd_task);
3091 * Hub resources are freed for us by usb_deregister. It calls
3092 * usb_driver_purge on every device which in turn calls that
3093 * devices disconnect function if it is using this driver.
3094 * The hub_disconnect function takes care of releasing the
3095 * individual hub resources. -greg
3097 usb_deregister(&hub_driver);
3098 } /* usb_hub_cleanup() */
3100 static int descriptors_changed(struct usb_device *udev,
3101 struct usb_device_descriptor *old_device_descriptor)
3105 unsigned serial_len = 0;
3107 unsigned old_length;
3111 if (memcmp(&udev->descriptor, old_device_descriptor,
3112 sizeof(*old_device_descriptor)) != 0)
3115 /* Since the idVendor, idProduct, and bcdDevice values in the
3116 * device descriptor haven't changed, we will assume the
3117 * Manufacturer and Product strings haven't changed either.
3118 * But the SerialNumber string could be different (e.g., a
3119 * different flash card of the same brand).
3122 serial_len = strlen(udev->serial) + 1;
3125 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3126 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3127 len = max(len, old_length);
3130 buf = kmalloc(len, GFP_NOIO);
3132 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
3133 /* assume the worst */
3136 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3137 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3138 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
3140 if (length != old_length) {
3141 dev_dbg(&udev->dev, "config index %d, error %d\n",
3146 if (memcmp (buf, udev->rawdescriptors[index], old_length)
3148 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
3150 ((struct usb_config_descriptor *) buf)->
3151 bConfigurationValue);
3157 if (!changed && serial_len) {
3158 length = usb_string(udev, udev->descriptor.iSerialNumber,
3160 if (length + 1 != serial_len) {
3161 dev_dbg(&udev->dev, "serial string error %d\n",
3164 } else if (memcmp(buf, udev->serial, length) != 0) {
3165 dev_dbg(&udev->dev, "serial string changed\n");
3175 * usb_reset_device - perform a USB port reset to reinitialize a device
3176 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3178 * WARNING - don't use this routine to reset a composite device
3179 * (one with multiple interfaces owned by separate drivers)!
3180 * Use usb_reset_composite_device() instead.
3182 * Do a port reset, reassign the device's address, and establish its
3183 * former operating configuration. If the reset fails, or the device's
3184 * descriptors change from their values before the reset, or the original
3185 * configuration and altsettings cannot be restored, a flag will be set
3186 * telling khubd to pretend the device has been disconnected and then
3187 * re-connected. All drivers will be unbound, and the device will be
3188 * re-enumerated and probed all over again.
3190 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3191 * flagged for logical disconnection, or some other negative error code
3192 * if the reset wasn't even attempted.
3194 * The caller must own the device lock. For example, it's safe to use
3195 * this from a driver probe() routine after downloading new firmware.
3196 * For calls that might not occur during probe(), drivers should lock
3197 * the device using usb_lock_device_for_reset().
3199 * Locking exception: This routine may also be called from within an
3200 * autoresume handler. Such usage won't conflict with other tasks
3201 * holding the device lock because these tasks should always call
3202 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
3204 int usb_reset_device(struct usb_device *udev)
3206 struct usb_device *parent_hdev = udev->parent;
3207 struct usb_hub *parent_hub;
3208 struct usb_device_descriptor descriptor = udev->descriptor;
3210 int port1 = udev->portnum;
3212 if (udev->state == USB_STATE_NOTATTACHED ||
3213 udev->state == USB_STATE_SUSPENDED) {
3214 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3220 /* this requires hcd-specific logic; see OHCI hc_restart() */
3221 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
3224 parent_hub = hdev_to_hub(parent_hdev);
3226 set_bit(port1, parent_hub->busy_bits);
3227 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3229 /* ep0 maxpacket size may change; let the HCD know about it.
3230 * Other endpoints will be handled by re-enumeration. */
3231 usb_ep0_reinit(udev);
3232 ret = hub_port_init(parent_hub, udev, port1, i);
3233 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
3236 clear_bit(port1, parent_hub->busy_bits);
3237 if (!parent_hdev->parent && !parent_hub->busy_bits[0])
3238 usb_enable_root_hub_irq(parent_hdev->bus);
3243 /* Device might have changed firmware (DFU or similar) */
3244 if (descriptors_changed(udev, &descriptor)) {
3245 dev_info(&udev->dev, "device firmware changed\n");
3246 udev->descriptor = descriptor; /* for disconnect() calls */
3250 if (!udev->actconfig)
3253 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3254 USB_REQ_SET_CONFIGURATION, 0,
3255 udev->actconfig->desc.bConfigurationValue, 0,
3256 NULL, 0, USB_CTRL_SET_TIMEOUT);
3259 "can't restore configuration #%d (error=%d)\n",
3260 udev->actconfig->desc.bConfigurationValue, ret);
3263 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3265 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3266 struct usb_interface *intf = udev->actconfig->interface[i];
3267 struct usb_interface_descriptor *desc;
3269 /* set_interface resets host side toggle even
3270 * for altsetting zero. the interface may have no driver.
3272 desc = &intf->cur_altsetting->desc;
3273 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3274 desc->bAlternateSetting);
3276 dev_err(&udev->dev, "failed to restore interface %d "
3277 "altsetting %d (error=%d)\n",
3278 desc->bInterfaceNumber,
3279 desc->bAlternateSetting,
3289 hub_port_logical_disconnect(parent_hub, port1);
3292 EXPORT_SYMBOL_GPL(usb_reset_device);
3295 * usb_reset_composite_device - warn interface drivers and perform a USB port reset
3296 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3297 * @iface: interface bound to the driver making the request (optional)
3299 * Warns all drivers bound to registered interfaces (using their pre_reset
3300 * method), performs the port reset, and then lets the drivers know that
3301 * the reset is over (using their post_reset method).
3303 * Return value is the same as for usb_reset_device().
3305 * The caller must own the device lock. For example, it's safe to use
3306 * this from a driver probe() routine after downloading new firmware.
3307 * For calls that might not occur during probe(), drivers should lock
3308 * the device using usb_lock_device_for_reset().
3310 int usb_reset_composite_device(struct usb_device *udev,
3311 struct usb_interface *iface)
3315 struct usb_host_config *config = udev->actconfig;
3317 if (udev->state == USB_STATE_NOTATTACHED ||
3318 udev->state == USB_STATE_SUSPENDED) {
3319 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3324 /* Prevent autosuspend during the reset */
3325 usb_autoresume_device(udev);
3327 if (iface && iface->condition != USB_INTERFACE_BINDING)
3331 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
3332 struct usb_interface *cintf = config->interface[i];
3333 struct usb_driver *drv;
3335 if (cintf->dev.driver) {
3336 drv = to_usb_driver(cintf->dev.driver);
3338 (drv->pre_reset)(cintf);
3339 /* FIXME: Unbind if pre_reset returns an error or isn't defined */
3344 ret = usb_reset_device(udev);
3347 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
3348 struct usb_interface *cintf = config->interface[i];
3349 struct usb_driver *drv;
3351 if (cintf->dev.driver) {
3352 drv = to_usb_driver(cintf->dev.driver);
3353 if (drv->post_reset)
3354 (drv->post_reset)(cintf);
3355 /* FIXME: Unbind if post_reset returns an error or isn't defined */
3360 usb_autosuspend_device(udev);
3363 EXPORT_SYMBOL_GPL(usb_reset_composite_device);