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 disconnected:1;
77 unsigned has_indicators:1;
78 u8 indicator[USB_MAXCHILDREN];
79 struct delayed_work leds;
83 /* Protect struct usb_device->state and ->children members
84 * Note: Both are also protected by ->dev.sem, except that ->state can
85 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
86 static DEFINE_SPINLOCK(device_state_lock);
88 /* khubd's worklist and its lock */
89 static DEFINE_SPINLOCK(hub_event_lock);
90 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
93 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
95 static struct task_struct *khubd_task;
97 /* cycle leds on hubs that aren't blinking for attention */
98 static int blinkenlights = 0;
99 module_param (blinkenlights, bool, S_IRUGO);
100 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
103 * As of 2.6.10 we introduce a new USB device initialization scheme which
104 * closely resembles the way Windows works. Hopefully it will be compatible
105 * with a wider range of devices than the old scheme. However some previously
106 * working devices may start giving rise to "device not accepting address"
107 * errors; if that happens the user can try the old scheme by adjusting the
108 * following module parameters.
110 * For maximum flexibility there are two boolean parameters to control the
111 * hub driver's behavior. On the first initialization attempt, if the
112 * "old_scheme_first" parameter is set then the old scheme will be used,
113 * otherwise the new scheme is used. If that fails and "use_both_schemes"
114 * is set, then the driver will make another attempt, using the other scheme.
116 static int old_scheme_first = 0;
117 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
118 MODULE_PARM_DESC(old_scheme_first,
119 "start with the old device initialization scheme");
121 static int use_both_schemes = 1;
122 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
123 MODULE_PARM_DESC(use_both_schemes,
124 "try the other device initialization scheme if the "
127 /* Mutual exclusion for EHCI CF initialization. This interferes with
128 * port reset on some companion controllers.
130 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
131 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
134 static inline char *portspeed(int portstatus)
136 if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
138 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
144 /* Note that hdev or one of its children must be locked! */
145 static inline struct usb_hub *hdev_to_hub(struct usb_device *hdev)
147 return usb_get_intfdata(hdev->actconfig->interface[0]);
150 /* USB 2.0 spec Section 11.24.4.5 */
151 static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
155 for (i = 0; i < 3; i++) {
156 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
157 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
158 USB_DT_HUB << 8, 0, data, size,
159 USB_CTRL_GET_TIMEOUT);
160 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
167 * USB 2.0 spec Section 11.24.2.1
169 static int clear_hub_feature(struct usb_device *hdev, int feature)
171 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
172 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
176 * USB 2.0 spec Section 11.24.2.2
178 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
180 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
181 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
186 * USB 2.0 spec Section 11.24.2.13
188 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
190 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
191 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
196 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
197 * for info about using port indicators
199 static void set_port_led(
205 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
206 USB_PORT_FEAT_INDICATOR);
208 dev_dbg (hub->intfdev,
209 "port %d indicator %s status %d\n",
211 ({ char *s; switch (selector) {
212 case HUB_LED_AMBER: s = "amber"; break;
213 case HUB_LED_GREEN: s = "green"; break;
214 case HUB_LED_OFF: s = "off"; break;
215 case HUB_LED_AUTO: s = "auto"; break;
216 default: s = "??"; break;
221 #define LED_CYCLE_PERIOD ((2*HZ)/3)
223 static void led_work (struct work_struct *work)
225 struct usb_hub *hub =
226 container_of(work, struct usb_hub, leds.work);
227 struct usb_device *hdev = hub->hdev;
229 unsigned changed = 0;
232 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
235 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
236 unsigned selector, mode;
238 /* 30%-50% duty cycle */
240 switch (hub->indicator[i]) {
242 case INDICATOR_CYCLE:
244 selector = HUB_LED_AUTO;
245 mode = INDICATOR_AUTO;
247 /* blinking green = sw attention */
248 case INDICATOR_GREEN_BLINK:
249 selector = HUB_LED_GREEN;
250 mode = INDICATOR_GREEN_BLINK_OFF;
252 case INDICATOR_GREEN_BLINK_OFF:
253 selector = HUB_LED_OFF;
254 mode = INDICATOR_GREEN_BLINK;
256 /* blinking amber = hw attention */
257 case INDICATOR_AMBER_BLINK:
258 selector = HUB_LED_AMBER;
259 mode = INDICATOR_AMBER_BLINK_OFF;
261 case INDICATOR_AMBER_BLINK_OFF:
262 selector = HUB_LED_OFF;
263 mode = INDICATOR_AMBER_BLINK;
265 /* blink green/amber = reserved */
266 case INDICATOR_ALT_BLINK:
267 selector = HUB_LED_GREEN;
268 mode = INDICATOR_ALT_BLINK_OFF;
270 case INDICATOR_ALT_BLINK_OFF:
271 selector = HUB_LED_AMBER;
272 mode = INDICATOR_ALT_BLINK;
277 if (selector != HUB_LED_AUTO)
279 set_port_led(hub, i + 1, selector);
280 hub->indicator[i] = mode;
282 if (!changed && blinkenlights) {
284 cursor %= hub->descriptor->bNbrPorts;
285 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
286 hub->indicator[cursor] = INDICATOR_CYCLE;
290 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
293 /* use a short timeout for hub/port status fetches */
294 #define USB_STS_TIMEOUT 1000
295 #define USB_STS_RETRIES 5
298 * USB 2.0 spec Section 11.24.2.6
300 static int get_hub_status(struct usb_device *hdev,
301 struct usb_hub_status *data)
303 int i, status = -ETIMEDOUT;
305 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
306 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
307 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
308 data, sizeof(*data), USB_STS_TIMEOUT);
314 * USB 2.0 spec Section 11.24.2.7
316 static int get_port_status(struct usb_device *hdev, int port1,
317 struct usb_port_status *data)
319 int i, status = -ETIMEDOUT;
321 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
322 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
323 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
324 data, sizeof(*data), USB_STS_TIMEOUT);
329 static int hub_port_status(struct usb_hub *hub, int port1,
330 u16 *status, u16 *change)
334 mutex_lock(&hub->status_mutex);
335 ret = get_port_status(hub->hdev, port1, &hub->status->port);
337 dev_err(hub->intfdev,
338 "%s failed (err = %d)\n", __func__, ret);
342 *status = le16_to_cpu(hub->status->port.wPortStatus);
343 *change = le16_to_cpu(hub->status->port.wPortChange);
346 mutex_unlock(&hub->status_mutex);
350 static void kick_khubd(struct usb_hub *hub)
354 /* Suppress autosuspend until khubd runs */
355 to_usb_interface(hub->intfdev)->pm_usage_cnt = 1;
357 spin_lock_irqsave(&hub_event_lock, flags);
358 if (!hub->disconnected && list_empty(&hub->event_list)) {
359 list_add_tail(&hub->event_list, &hub_event_list);
360 wake_up(&khubd_wait);
362 spin_unlock_irqrestore(&hub_event_lock, flags);
365 void usb_kick_khubd(struct usb_device *hdev)
367 /* FIXME: What if hdev isn't bound to the hub driver? */
368 kick_khubd(hdev_to_hub(hdev));
372 /* completion function, fires on port status changes and various faults */
373 static void hub_irq(struct urb *urb)
375 struct usb_hub *hub = urb->context;
376 int status = urb->status;
381 case -ENOENT: /* synchronous unlink */
382 case -ECONNRESET: /* async unlink */
383 case -ESHUTDOWN: /* hardware going away */
386 default: /* presumably an error */
387 /* Cause a hub reset after 10 consecutive errors */
388 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
389 if ((++hub->nerrors < 10) || hub->error)
394 /* let khubd handle things */
395 case 0: /* we got data: port status changed */
397 for (i = 0; i < urb->actual_length; ++i)
398 bits |= ((unsigned long) ((*hub->buffer)[i]))
400 hub->event_bits[0] = bits;
406 /* Something happened, let khubd figure it out */
413 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
414 && status != -ENODEV && status != -EPERM)
415 dev_err (hub->intfdev, "resubmit --> %d\n", status);
418 /* USB 2.0 spec Section 11.24.2.3 */
420 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
422 return usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
423 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
428 * enumeration blocks khubd for a long time. we use keventd instead, since
429 * long blocking there is the exception, not the rule. accordingly, HCDs
430 * talking to TTs must queue control transfers (not just bulk and iso), so
431 * both can talk to the same hub concurrently.
433 static void hub_tt_kevent (struct work_struct *work)
435 struct usb_hub *hub =
436 container_of(work, struct usb_hub, tt.kevent);
440 spin_lock_irqsave (&hub->tt.lock, flags);
441 while (--limit && !list_empty (&hub->tt.clear_list)) {
442 struct list_head *temp;
443 struct usb_tt_clear *clear;
444 struct usb_device *hdev = hub->hdev;
447 temp = hub->tt.clear_list.next;
448 clear = list_entry (temp, struct usb_tt_clear, clear_list);
449 list_del (&clear->clear_list);
451 /* drop lock so HCD can concurrently report other TT errors */
452 spin_unlock_irqrestore (&hub->tt.lock, flags);
453 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
454 spin_lock_irqsave (&hub->tt.lock, flags);
458 "clear tt %d (%04x) error %d\n",
459 clear->tt, clear->devinfo, status);
462 spin_unlock_irqrestore (&hub->tt.lock, flags);
466 * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
467 * @udev: the device whose split transaction failed
468 * @pipe: identifies the endpoint of the failed transaction
470 * High speed HCDs use this to tell the hub driver that some split control or
471 * bulk transaction failed in a way that requires clearing internal state of
472 * a transaction translator. This is normally detected (and reported) from
475 * It may not be possible for that hub to handle additional full (or low)
476 * speed transactions until that state is fully cleared out.
478 void usb_hub_tt_clear_buffer (struct usb_device *udev, int pipe)
480 struct usb_tt *tt = udev->tt;
482 struct usb_tt_clear *clear;
484 /* we've got to cope with an arbitrary number of pending TT clears,
485 * since each TT has "at least two" buffers that can need it (and
486 * there can be many TTs per hub). even if they're uncommon.
488 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
489 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
490 /* FIXME recover somehow ... RESET_TT? */
494 /* info that CLEAR_TT_BUFFER needs */
495 clear->tt = tt->multi ? udev->ttport : 1;
496 clear->devinfo = usb_pipeendpoint (pipe);
497 clear->devinfo |= udev->devnum << 4;
498 clear->devinfo |= usb_pipecontrol (pipe)
499 ? (USB_ENDPOINT_XFER_CONTROL << 11)
500 : (USB_ENDPOINT_XFER_BULK << 11);
501 if (usb_pipein (pipe))
502 clear->devinfo |= 1 << 15;
504 /* tell keventd to clear state for this TT */
505 spin_lock_irqsave (&tt->lock, flags);
506 list_add_tail (&clear->clear_list, &tt->clear_list);
507 schedule_work (&tt->kevent);
508 spin_unlock_irqrestore (&tt->lock, flags);
510 EXPORT_SYMBOL_GPL(usb_hub_tt_clear_buffer);
512 static void hub_power_on(struct usb_hub *hub)
515 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
516 u16 wHubCharacteristics =
517 le16_to_cpu(hub->descriptor->wHubCharacteristics);
519 /* Enable power on each port. Some hubs have reserved values
520 * of LPSM (> 2) in their descriptors, even though they are
521 * USB 2.0 hubs. Some hubs do not implement port-power switching
522 * but only emulate it. In all cases, the ports won't work
523 * unless we send these messages to the hub.
525 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
526 dev_dbg(hub->intfdev, "enabling power on all ports\n");
528 dev_dbg(hub->intfdev, "trying to enable port power on "
529 "non-switchable hub\n");
530 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
531 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
533 /* Wait at least 100 msec for power to become stable */
534 msleep(max(pgood_delay, (unsigned) 100));
537 static void hub_quiesce(struct usb_hub *hub)
539 /* (nonblocking) khubd and related activity won't re-trigger */
542 /* (blocking) stop khubd and related activity */
543 usb_kill_urb(hub->urb);
544 if (hub->has_indicators)
545 cancel_delayed_work_sync(&hub->leds);
547 cancel_work_sync(&hub->tt.kevent);
550 static void hub_activate(struct usb_hub *hub)
556 status = usb_submit_urb(hub->urb, GFP_NOIO);
558 dev_err(hub->intfdev, "activate --> %d\n", status);
559 if (hub->has_indicators && blinkenlights)
560 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
562 /* scan all ports ASAP */
566 static int hub_hub_status(struct usb_hub *hub,
567 u16 *status, u16 *change)
571 mutex_lock(&hub->status_mutex);
572 ret = get_hub_status(hub->hdev, &hub->status->hub);
574 dev_err (hub->intfdev,
575 "%s failed (err = %d)\n", __func__, ret);
577 *status = le16_to_cpu(hub->status->hub.wHubStatus);
578 *change = le16_to_cpu(hub->status->hub.wHubChange);
581 mutex_unlock(&hub->status_mutex);
585 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
587 struct usb_device *hdev = hub->hdev;
590 if (hdev->children[port1-1] && set_state)
591 usb_set_device_state(hdev->children[port1-1],
592 USB_STATE_NOTATTACHED);
594 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
596 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
602 * Disable a port and mark a logical connnect-change event, so that some
603 * time later khubd will disconnect() any existing usb_device on the port
604 * and will re-enumerate if there actually is a device attached.
606 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
608 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
609 hub_port_disable(hub, port1, 1);
611 /* FIXME let caller ask to power down the port:
612 * - some devices won't enumerate without a VBUS power cycle
613 * - SRP saves power that way
614 * - ... new call, TBD ...
615 * That's easy if this hub can switch power per-port, and
616 * khubd reactivates the port later (timer, SRP, etc).
617 * Powerdown must be optional, because of reset/DFU.
620 set_bit(port1, hub->change_bits);
624 /* caller has locked the hub device */
625 static void hub_stop(struct usb_hub *hub)
627 struct usb_device *hdev = hub->hdev;
630 /* Disconnect all the children */
631 for (i = 0; i < hdev->maxchild; ++i) {
632 if (hdev->children[i])
633 usb_disconnect(&hdev->children[i]);
638 enum hub_activation_type {
639 HUB_INIT, HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME
642 static void hub_restart(struct usb_hub *hub, enum hub_activation_type type)
644 struct usb_device *hdev = hub->hdev;
647 /* Check each port and set hub->change_bits to let khubd know
648 * which ports need attention.
650 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
651 struct usb_device *udev = hdev->children[port1-1];
653 u16 portstatus, portchange;
655 portstatus = portchange = 0;
656 status = hub_port_status(hub, port1, &portstatus, &portchange);
657 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
658 dev_dbg(hub->intfdev,
659 "port %d: status %04x change %04x\n",
660 port1, portstatus, portchange);
662 /* After anything other than HUB_RESUME (i.e., initialization
663 * or any sort of reset), every port should be disabled.
664 * Unconnected ports should likewise be disabled (paranoia),
665 * and so should ports for which we have no usb_device.
667 if ((portstatus & USB_PORT_STAT_ENABLE) && (
668 type != HUB_RESUME ||
669 !(portstatus & USB_PORT_STAT_CONNECTION) ||
671 udev->state == USB_STATE_NOTATTACHED)) {
672 clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
673 portstatus &= ~USB_PORT_STAT_ENABLE;
676 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
677 /* Tell khubd to disconnect the device or
678 * check for a new connection
680 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
681 set_bit(port1, hub->change_bits);
683 } else if (portstatus & USB_PORT_STAT_ENABLE) {
684 /* The power session apparently survived the resume.
685 * If there was an overcurrent or suspend change
686 * (i.e., remote wakeup request), have khubd
690 set_bit(port1, hub->change_bits);
692 } else if (udev->persist_enabled) {
693 /* Turn off the status changes to prevent khubd
694 * from disconnecting the device.
696 if (portchange & USB_PORT_STAT_C_ENABLE)
697 clear_port_feature(hub->hdev, port1,
698 USB_PORT_FEAT_C_ENABLE);
699 if (portchange & USB_PORT_STAT_C_CONNECTION)
700 clear_port_feature(hub->hdev, port1,
701 USB_PORT_FEAT_C_CONNECTION);
703 udev->reset_resume = 1;
706 /* The power session is gone; tell khubd */
707 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
708 set_bit(port1, hub->change_bits);
715 /* caller has locked the hub device */
716 static int hub_pre_reset(struct usb_interface *intf)
718 struct usb_hub *hub = usb_get_intfdata(intf);
724 /* caller has locked the hub device */
725 static int hub_post_reset(struct usb_interface *intf)
727 struct usb_hub *hub = usb_get_intfdata(intf);
730 hub_restart(hub, HUB_POST_RESET);
734 static int hub_configure(struct usb_hub *hub,
735 struct usb_endpoint_descriptor *endpoint)
737 struct usb_device *hdev = hub->hdev;
738 struct device *hub_dev = hub->intfdev;
739 u16 hubstatus, hubchange;
740 u16 wHubCharacteristics;
745 hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
748 message = "can't allocate hub irq buffer";
753 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
755 message = "can't kmalloc hub status buffer";
759 mutex_init(&hub->status_mutex);
761 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
762 if (!hub->descriptor) {
763 message = "can't kmalloc hub descriptor";
768 /* Request the entire hub descriptor.
769 * hub->descriptor can handle USB_MAXCHILDREN ports,
770 * but the hub can/will return fewer bytes here.
772 ret = get_hub_descriptor(hdev, hub->descriptor,
773 sizeof(*hub->descriptor));
775 message = "can't read hub descriptor";
777 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
778 message = "hub has too many ports!";
783 hdev->maxchild = hub->descriptor->bNbrPorts;
784 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
785 (hdev->maxchild == 1) ? "" : "s");
787 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
789 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
791 char portstr [USB_MAXCHILDREN + 1];
793 for (i = 0; i < hdev->maxchild; i++)
794 portstr[i] = hub->descriptor->DeviceRemovable
795 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
797 portstr[hdev->maxchild] = 0;
798 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
800 dev_dbg(hub_dev, "standalone hub\n");
802 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
804 dev_dbg(hub_dev, "ganged power switching\n");
807 dev_dbg(hub_dev, "individual port power switching\n");
811 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
815 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
817 dev_dbg(hub_dev, "global over-current protection\n");
820 dev_dbg(hub_dev, "individual port over-current protection\n");
824 dev_dbg(hub_dev, "no over-current protection\n");
828 spin_lock_init (&hub->tt.lock);
829 INIT_LIST_HEAD (&hub->tt.clear_list);
830 INIT_WORK (&hub->tt.kevent, hub_tt_kevent);
831 switch (hdev->descriptor.bDeviceProtocol) {
835 dev_dbg(hub_dev, "Single TT\n");
839 ret = usb_set_interface(hdev, 0, 1);
841 dev_dbg(hub_dev, "TT per port\n");
844 dev_err(hub_dev, "Using single TT (err %d)\n",
849 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
850 hdev->descriptor.bDeviceProtocol);
854 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
855 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
856 case HUB_TTTT_8_BITS:
857 if (hdev->descriptor.bDeviceProtocol != 0) {
858 hub->tt.think_time = 666;
859 dev_dbg(hub_dev, "TT requires at most %d "
860 "FS bit times (%d ns)\n",
861 8, hub->tt.think_time);
864 case HUB_TTTT_16_BITS:
865 hub->tt.think_time = 666 * 2;
866 dev_dbg(hub_dev, "TT requires at most %d "
867 "FS bit times (%d ns)\n",
868 16, hub->tt.think_time);
870 case HUB_TTTT_24_BITS:
871 hub->tt.think_time = 666 * 3;
872 dev_dbg(hub_dev, "TT requires at most %d "
873 "FS bit times (%d ns)\n",
874 24, hub->tt.think_time);
876 case HUB_TTTT_32_BITS:
877 hub->tt.think_time = 666 * 4;
878 dev_dbg(hub_dev, "TT requires at most %d "
879 "FS bit times (%d ns)\n",
880 32, hub->tt.think_time);
884 /* probe() zeroes hub->indicator[] */
885 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
886 hub->has_indicators = 1;
887 dev_dbg(hub_dev, "Port indicators are supported\n");
890 dev_dbg(hub_dev, "power on to power good time: %dms\n",
891 hub->descriptor->bPwrOn2PwrGood * 2);
893 /* power budgeting mostly matters with bus-powered hubs,
894 * and battery-powered root hubs (may provide just 8 mA).
896 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
898 message = "can't get hub status";
901 le16_to_cpus(&hubstatus);
902 if (hdev == hdev->bus->root_hub) {
903 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
904 hub->mA_per_port = 500;
906 hub->mA_per_port = hdev->bus_mA;
907 hub->limited_power = 1;
909 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
910 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
911 hub->descriptor->bHubContrCurrent);
912 hub->limited_power = 1;
913 if (hdev->maxchild > 0) {
914 int remaining = hdev->bus_mA -
915 hub->descriptor->bHubContrCurrent;
917 if (remaining < hdev->maxchild * 100)
919 "insufficient power available "
920 "to use all downstream ports\n");
921 hub->mA_per_port = 100; /* 7.2.1.1 */
923 } else { /* Self-powered external hub */
924 /* FIXME: What about battery-powered external hubs that
925 * provide less current per port? */
926 hub->mA_per_port = 500;
928 if (hub->mA_per_port < 500)
929 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
932 ret = hub_hub_status(hub, &hubstatus, &hubchange);
934 message = "can't get hub status";
938 /* local power status reports aren't always correct */
939 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
940 dev_dbg(hub_dev, "local power source is %s\n",
941 (hubstatus & HUB_STATUS_LOCAL_POWER)
942 ? "lost (inactive)" : "good");
944 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
945 dev_dbg(hub_dev, "%sover-current condition exists\n",
946 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
948 /* set up the interrupt endpoint
949 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
950 * bytes as USB2.0[11.12.3] says because some hubs are known
951 * to send more data (and thus cause overflow). For root hubs,
952 * maxpktsize is defined in hcd.c's fake endpoint descriptors
953 * to be big enough for at least USB_MAXCHILDREN ports. */
954 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
955 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
957 if (maxp > sizeof(*hub->buffer))
958 maxp = sizeof(*hub->buffer);
960 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
962 message = "couldn't allocate interrupt urb";
967 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
968 hub, endpoint->bInterval);
969 hub->urb->transfer_dma = hub->buffer_dma;
970 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
972 /* maybe cycle the hub leds */
973 if (hub->has_indicators && blinkenlights)
974 hub->indicator [0] = INDICATOR_CYCLE;
981 dev_err (hub_dev, "config failed, %s (err %d)\n",
983 /* hub_disconnect() frees urb and descriptor */
987 static void hub_release(struct kref *kref)
989 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
991 usb_put_intf(to_usb_interface(hub->intfdev));
995 static unsigned highspeed_hubs;
997 static void hub_disconnect(struct usb_interface *intf)
999 struct usb_hub *hub = usb_get_intfdata (intf);
1001 /* Take the hub off the event list and don't let it be added again */
1002 spin_lock_irq(&hub_event_lock);
1003 list_del_init(&hub->event_list);
1004 hub->disconnected = 1;
1005 spin_unlock_irq(&hub_event_lock);
1007 /* Disconnect all children and quiesce the hub */
1011 usb_set_intfdata (intf, NULL);
1013 if (hub->hdev->speed == USB_SPEED_HIGH)
1016 usb_free_urb(hub->urb);
1017 kfree(hub->descriptor);
1019 usb_buffer_free(hub->hdev, sizeof(*hub->buffer), hub->buffer,
1022 kref_put(&hub->kref, hub_release);
1025 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1027 struct usb_host_interface *desc;
1028 struct usb_endpoint_descriptor *endpoint;
1029 struct usb_device *hdev;
1030 struct usb_hub *hub;
1032 desc = intf->cur_altsetting;
1033 hdev = interface_to_usbdev(intf);
1035 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1037 dev_warn(&intf->dev, "ignoring external hub\n");
1042 /* Some hubs have a subclass of 1, which AFAICT according to the */
1043 /* specs is not defined, but it works */
1044 if ((desc->desc.bInterfaceSubClass != 0) &&
1045 (desc->desc.bInterfaceSubClass != 1)) {
1047 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1051 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1052 if (desc->desc.bNumEndpoints != 1)
1053 goto descriptor_error;
1055 endpoint = &desc->endpoint[0].desc;
1057 /* If it's not an interrupt in endpoint, we'd better punt! */
1058 if (!usb_endpoint_is_int_in(endpoint))
1059 goto descriptor_error;
1061 /* We found a hub */
1062 dev_info (&intf->dev, "USB hub found\n");
1064 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1066 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1070 kref_init(&hub->kref);
1071 INIT_LIST_HEAD(&hub->event_list);
1072 hub->intfdev = &intf->dev;
1074 INIT_DELAYED_WORK(&hub->leds, led_work);
1077 usb_set_intfdata (intf, hub);
1078 intf->needs_remote_wakeup = 1;
1080 if (hdev->speed == USB_SPEED_HIGH)
1083 if (hub_configure(hub, endpoint) >= 0)
1086 hub_disconnect (intf);
1091 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1093 struct usb_device *hdev = interface_to_usbdev (intf);
1095 /* assert ifno == 0 (part of hub spec) */
1097 case USBDEVFS_HUB_PORTINFO: {
1098 struct usbdevfs_hub_portinfo *info = user_data;
1101 spin_lock_irq(&device_state_lock);
1102 if (hdev->devnum <= 0)
1105 info->nports = hdev->maxchild;
1106 for (i = 0; i < info->nports; i++) {
1107 if (hdev->children[i] == NULL)
1111 hdev->children[i]->devnum;
1114 spin_unlock_irq(&device_state_lock);
1116 return info->nports + 1;
1125 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1129 for (i = 0; i < udev->maxchild; ++i) {
1130 if (udev->children[i])
1131 recursively_mark_NOTATTACHED(udev->children[i]);
1133 if (udev->state == USB_STATE_SUSPENDED) {
1134 udev->discon_suspended = 1;
1135 udev->active_duration -= jiffies;
1137 udev->state = USB_STATE_NOTATTACHED;
1141 * usb_set_device_state - change a device's current state (usbcore, hcds)
1142 * @udev: pointer to device whose state should be changed
1143 * @new_state: new state value to be stored
1145 * udev->state is _not_ fully protected by the device lock. Although
1146 * most transitions are made only while holding the lock, the state can
1147 * can change to USB_STATE_NOTATTACHED at almost any time. This
1148 * is so that devices can be marked as disconnected as soon as possible,
1149 * without having to wait for any semaphores to be released. As a result,
1150 * all changes to any device's state must be protected by the
1151 * device_state_lock spinlock.
1153 * Once a device has been added to the device tree, all changes to its state
1154 * should be made using this routine. The state should _not_ be set directly.
1156 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1157 * Otherwise udev->state is set to new_state, and if new_state is
1158 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1159 * to USB_STATE_NOTATTACHED.
1161 void usb_set_device_state(struct usb_device *udev,
1162 enum usb_device_state new_state)
1164 unsigned long flags;
1166 spin_lock_irqsave(&device_state_lock, flags);
1167 if (udev->state == USB_STATE_NOTATTACHED)
1169 else if (new_state != USB_STATE_NOTATTACHED) {
1171 /* root hub wakeup capabilities are managed out-of-band
1172 * and may involve silicon errata ... ignore them here.
1175 if (udev->state == USB_STATE_SUSPENDED
1176 || new_state == USB_STATE_SUSPENDED)
1177 ; /* No change to wakeup settings */
1178 else if (new_state == USB_STATE_CONFIGURED)
1179 device_init_wakeup(&udev->dev,
1180 (udev->actconfig->desc.bmAttributes
1181 & USB_CONFIG_ATT_WAKEUP));
1183 device_init_wakeup(&udev->dev, 0);
1185 if (udev->state == USB_STATE_SUSPENDED &&
1186 new_state != USB_STATE_SUSPENDED)
1187 udev->active_duration -= jiffies;
1188 else if (new_state == USB_STATE_SUSPENDED &&
1189 udev->state != USB_STATE_SUSPENDED)
1190 udev->active_duration += jiffies;
1191 udev->state = new_state;
1193 recursively_mark_NOTATTACHED(udev);
1194 spin_unlock_irqrestore(&device_state_lock, flags);
1198 * WUSB devices are simple: they have no hubs behind, so the mapping
1199 * device <-> virtual port number becomes 1:1. Why? to simplify the
1200 * life of the device connection logic in
1201 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1202 * handshake we need to assign a temporary address in the unauthorized
1203 * space. For simplicity we use the first virtual port number found to
1204 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1205 * and that becomes it's address [X < 128] or its unauthorized address
1208 * We add 1 as an offset to the one-based USB-stack port number
1209 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1210 * 0 is reserved by USB for default address; (b) Linux's USB stack
1211 * uses always #1 for the root hub of the controller. So USB stack's
1212 * port #1, which is wusb virtual-port #0 has address #2.
1214 static void choose_address(struct usb_device *udev)
1217 struct usb_bus *bus = udev->bus;
1219 /* If khubd ever becomes multithreaded, this will need a lock */
1221 devnum = udev->portnum + 1;
1222 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1224 /* Try to allocate the next devnum beginning at
1225 * bus->devnum_next. */
1226 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1229 devnum = find_next_zero_bit(bus->devmap.devicemap,
1231 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1234 set_bit(devnum, bus->devmap.devicemap);
1235 udev->devnum = devnum;
1239 static void release_address(struct usb_device *udev)
1241 if (udev->devnum > 0) {
1242 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1247 static void update_address(struct usb_device *udev, int devnum)
1249 /* The address for a WUSB device is managed by wusbcore. */
1251 udev->devnum = devnum;
1254 #ifdef CONFIG_USB_SUSPEND
1256 static void usb_stop_pm(struct usb_device *udev)
1258 /* Synchronize with the ksuspend thread to prevent any more
1259 * autosuspend requests from being submitted, and decrement
1260 * the parent's count of unsuspended children.
1263 if (udev->parent && !udev->discon_suspended)
1264 usb_autosuspend_device(udev->parent);
1265 usb_pm_unlock(udev);
1267 /* Stop any autosuspend requests already submitted */
1268 cancel_rearming_delayed_work(&udev->autosuspend);
1273 static inline void usb_stop_pm(struct usb_device *udev)
1279 * usb_disconnect - disconnect a device (usbcore-internal)
1280 * @pdev: pointer to device being disconnected
1281 * Context: !in_interrupt ()
1283 * Something got disconnected. Get rid of it and all of its children.
1285 * If *pdev is a normal device then the parent hub must already be locked.
1286 * If *pdev is a root hub then this routine will acquire the
1287 * usb_bus_list_lock on behalf of the caller.
1289 * Only hub drivers (including virtual root hub drivers for host
1290 * controllers) should ever call this.
1292 * This call is synchronous, and may not be used in an interrupt context.
1294 void usb_disconnect(struct usb_device **pdev)
1296 struct usb_device *udev = *pdev;
1300 pr_debug ("%s nodev\n", __func__);
1304 /* mark the device as inactive, so any further urb submissions for
1305 * this device (and any of its children) will fail immediately.
1306 * this quiesces everyting except pending urbs.
1308 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1309 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1311 usb_lock_device(udev);
1313 /* Free up all the children before we remove this device */
1314 for (i = 0; i < USB_MAXCHILDREN; i++) {
1315 if (udev->children[i])
1316 usb_disconnect(&udev->children[i]);
1319 /* deallocate hcd/hardware state ... nuking all pending urbs and
1320 * cleaning up all state associated with the current configuration
1321 * so that the hardware is now fully quiesced.
1323 dev_dbg (&udev->dev, "unregistering device\n");
1324 usb_disable_device(udev, 0);
1326 usb_unlock_device(udev);
1328 /* Remove the device-specific files from sysfs. This must be
1329 * done with udev unlocked, because some of the attribute
1330 * routines try to acquire the device lock.
1332 usb_remove_sysfs_dev_files(udev);
1334 /* Unregister the device. The device driver is responsible
1335 * for removing the device files from usbfs and sysfs and for
1336 * de-configuring the device.
1338 device_del(&udev->dev);
1340 /* Free the device number and delete the parent's children[]
1341 * (or root_hub) pointer.
1343 release_address(udev);
1345 /* Avoid races with recursively_mark_NOTATTACHED() */
1346 spin_lock_irq(&device_state_lock);
1348 spin_unlock_irq(&device_state_lock);
1352 put_device(&udev->dev);
1355 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1356 static void show_string(struct usb_device *udev, char *id, char *string)
1360 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1363 static void announce_device(struct usb_device *udev)
1365 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1366 le16_to_cpu(udev->descriptor.idVendor),
1367 le16_to_cpu(udev->descriptor.idProduct));
1368 dev_info(&udev->dev, "New USB device strings: Mfr=%d, Product=%d, "
1369 "SerialNumber=%d\n",
1370 udev->descriptor.iManufacturer,
1371 udev->descriptor.iProduct,
1372 udev->descriptor.iSerialNumber);
1373 show_string(udev, "Product", udev->product);
1374 show_string(udev, "Manufacturer", udev->manufacturer);
1375 show_string(udev, "SerialNumber", udev->serial);
1378 static inline void announce_device(struct usb_device *udev) { }
1381 #ifdef CONFIG_USB_OTG
1382 #include "otg_whitelist.h"
1386 * usb_configure_device_otg - FIXME (usbcore-internal)
1387 * @udev: newly addressed device (in ADDRESS state)
1389 * Do configuration for On-The-Go devices
1391 static int usb_configure_device_otg(struct usb_device *udev)
1395 #ifdef CONFIG_USB_OTG
1397 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1398 * to wake us after we've powered off VBUS; and HNP, switching roles
1399 * "host" to "peripheral". The OTG descriptor helps figure this out.
1401 if (!udev->bus->is_b_host
1403 && udev->parent == udev->bus->root_hub) {
1404 struct usb_otg_descriptor *desc = 0;
1405 struct usb_bus *bus = udev->bus;
1407 /* descriptor may appear anywhere in config */
1408 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1409 le16_to_cpu(udev->config[0].desc.wTotalLength),
1410 USB_DT_OTG, (void **) &desc) == 0) {
1411 if (desc->bmAttributes & USB_OTG_HNP) {
1412 unsigned port1 = udev->portnum;
1414 dev_info(&udev->dev,
1415 "Dual-Role OTG device on %sHNP port\n",
1416 (port1 == bus->otg_port)
1419 /* enable HNP before suspend, it's simpler */
1420 if (port1 == bus->otg_port)
1421 bus->b_hnp_enable = 1;
1422 err = usb_control_msg(udev,
1423 usb_sndctrlpipe(udev, 0),
1424 USB_REQ_SET_FEATURE, 0,
1426 ? USB_DEVICE_B_HNP_ENABLE
1427 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1428 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1430 /* OTG MESSAGE: report errors here,
1431 * customize to match your product.
1433 dev_info(&udev->dev,
1434 "can't set HNP mode; %d\n",
1436 bus->b_hnp_enable = 0;
1442 if (!is_targeted(udev)) {
1444 /* Maybe it can talk to us, though we can't talk to it.
1445 * (Includes HNP test device.)
1447 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1448 err = usb_port_suspend(udev);
1450 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1462 * usb_configure_device - Detect and probe device intfs/otg (usbcore-internal)
1463 * @udev: newly addressed device (in ADDRESS state)
1465 * This is only called by usb_new_device() and usb_authorize_device()
1466 * and FIXME -- all comments that apply to them apply here wrt to
1469 * If the device is WUSB and not authorized, we don't attempt to read
1470 * the string descriptors, as they will be errored out by the device
1471 * until it has been authorized.
1473 static int usb_configure_device(struct usb_device *udev)
1477 if (udev->config == NULL) {
1478 err = usb_get_configuration(udev);
1480 dev_err(&udev->dev, "can't read configurations, error %d\n",
1485 if (udev->wusb == 1 && udev->authorized == 0) {
1486 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1487 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1488 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1491 /* read the standard strings and cache them if present */
1492 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1493 udev->manufacturer = usb_cache_string(udev,
1494 udev->descriptor.iManufacturer);
1495 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1497 err = usb_configure_device_otg(udev);
1504 * usb_new_device - perform initial device setup (usbcore-internal)
1505 * @udev: newly addressed device (in ADDRESS state)
1507 * This is called with devices which have been enumerated, but not yet
1508 * configured. The device descriptor is available, but not descriptors
1509 * for any device configuration. The caller must have locked either
1510 * the parent hub (if udev is a normal device) or else the
1511 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1512 * udev has already been installed, but udev is not yet visible through
1513 * sysfs or other filesystem code.
1515 * It will return if the device is configured properly or not. Zero if
1516 * the interface was registered with the driver core; else a negative
1519 * This call is synchronous, and may not be used in an interrupt context.
1521 * Only the hub driver or root-hub registrar should ever call this.
1523 int usb_new_device(struct usb_device *udev)
1527 usb_detect_quirks(udev); /* Determine quirks */
1528 err = usb_configure_device(udev); /* detect & probe dev/intfs */
1531 /* export the usbdev device-node for libusb */
1532 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1533 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1535 /* Increment the parent's count of unsuspended children */
1537 usb_autoresume_device(udev->parent);
1539 /* Register the device. The device driver is responsible
1540 * for adding the device files to sysfs and for configuring
1543 err = device_add(&udev->dev);
1545 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1549 /* put device-specific files into sysfs */
1550 usb_create_sysfs_dev_files(udev);
1552 /* Tell the world! */
1553 announce_device(udev);
1557 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1563 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1564 * @usb_dev: USB device
1566 * Move the USB device to a very basic state where interfaces are disabled
1567 * and the device is in fact unconfigured and unusable.
1569 * We share a lock (that we have) with device_del(), so we need to
1572 int usb_deauthorize_device(struct usb_device *usb_dev)
1575 usb_lock_device(usb_dev);
1576 if (usb_dev->authorized == 0)
1577 goto out_unauthorized;
1578 usb_dev->authorized = 0;
1579 usb_set_configuration(usb_dev, -1);
1580 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1581 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1582 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1583 kfree(usb_dev->config);
1584 usb_dev->config = NULL;
1585 for (cnt = 0; cnt < usb_dev->descriptor.bNumConfigurations; cnt++)
1586 kfree(usb_dev->rawdescriptors[cnt]);
1587 usb_dev->descriptor.bNumConfigurations = 0;
1588 kfree(usb_dev->rawdescriptors);
1590 usb_unlock_device(usb_dev);
1595 int usb_authorize_device(struct usb_device *usb_dev)
1598 usb_lock_device(usb_dev);
1599 if (usb_dev->authorized == 1)
1600 goto out_authorized;
1601 kfree(usb_dev->product);
1602 usb_dev->product = NULL;
1603 kfree(usb_dev->manufacturer);
1604 usb_dev->manufacturer = NULL;
1605 kfree(usb_dev->serial);
1606 usb_dev->serial = NULL;
1607 result = usb_autoresume_device(usb_dev);
1609 dev_err(&usb_dev->dev,
1610 "can't autoresume for authorization: %d\n", result);
1611 goto error_autoresume;
1613 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
1615 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
1616 "authorization: %d\n", result);
1617 goto error_device_descriptor;
1619 usb_dev->authorized = 1;
1620 result = usb_configure_device(usb_dev);
1622 goto error_configure;
1623 /* Choose and set the configuration. This registers the interfaces
1624 * with the driver core and lets interface drivers bind to them.
1626 c = usb_choose_configuration(usb_dev);
1628 result = usb_set_configuration(usb_dev, c);
1630 dev_err(&usb_dev->dev,
1631 "can't set config #%d, error %d\n", c, result);
1632 /* This need not be fatal. The user can try to
1633 * set other configurations. */
1636 dev_info(&usb_dev->dev, "authorized to connect\n");
1638 error_device_descriptor:
1641 usb_unlock_device(usb_dev); // complements locktree
1646 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1647 static unsigned hub_is_wusb(struct usb_hub *hub)
1649 struct usb_hcd *hcd;
1650 if (hub->hdev->parent != NULL) /* not a root hub? */
1652 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
1653 return hcd->wireless;
1657 #define PORT_RESET_TRIES 5
1658 #define SET_ADDRESS_TRIES 2
1659 #define GET_DESCRIPTOR_TRIES 2
1660 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1661 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1663 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1664 #define HUB_SHORT_RESET_TIME 10
1665 #define HUB_LONG_RESET_TIME 200
1666 #define HUB_RESET_TIMEOUT 500
1668 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1669 struct usb_device *udev, unsigned int delay)
1671 int delay_time, ret;
1675 for (delay_time = 0;
1676 delay_time < HUB_RESET_TIMEOUT;
1677 delay_time += delay) {
1678 /* wait to give the device a chance to reset */
1681 /* read and decode port status */
1682 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1686 /* Device went away? */
1687 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1690 /* bomb out completely if the connection bounced */
1691 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1694 /* if we`ve finished resetting, then break out of the loop */
1695 if (!(portstatus & USB_PORT_STAT_RESET) &&
1696 (portstatus & USB_PORT_STAT_ENABLE)) {
1697 if (hub_is_wusb(hub))
1698 udev->speed = USB_SPEED_VARIABLE;
1699 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1700 udev->speed = USB_SPEED_HIGH;
1701 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1702 udev->speed = USB_SPEED_LOW;
1704 udev->speed = USB_SPEED_FULL;
1708 /* switch to the long delay after two short delay failures */
1709 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1710 delay = HUB_LONG_RESET_TIME;
1712 dev_dbg (hub->intfdev,
1713 "port %d not reset yet, waiting %dms\n",
1720 static int hub_port_reset(struct usb_hub *hub, int port1,
1721 struct usb_device *udev, unsigned int delay)
1725 /* Block EHCI CF initialization during the port reset.
1726 * Some companion controllers don't like it when they mix.
1728 down_read(&ehci_cf_port_reset_rwsem);
1730 /* Reset the port */
1731 for (i = 0; i < PORT_RESET_TRIES; i++) {
1732 status = set_port_feature(hub->hdev,
1733 port1, USB_PORT_FEAT_RESET);
1735 dev_err(hub->intfdev,
1736 "cannot reset port %d (err = %d)\n",
1739 status = hub_port_wait_reset(hub, port1, udev, delay);
1740 if (status && status != -ENOTCONN)
1741 dev_dbg(hub->intfdev,
1742 "port_wait_reset: err = %d\n",
1746 /* return on disconnect or reset */
1749 /* TRSTRCY = 10 ms; plus some extra */
1751 update_address(udev, 0);
1755 clear_port_feature(hub->hdev,
1756 port1, USB_PORT_FEAT_C_RESET);
1757 /* FIXME need disconnect() for NOTATTACHED device */
1758 usb_set_device_state(udev, status
1759 ? USB_STATE_NOTATTACHED
1760 : USB_STATE_DEFAULT);
1764 dev_dbg (hub->intfdev,
1765 "port %d not enabled, trying reset again...\n",
1767 delay = HUB_LONG_RESET_TIME;
1770 dev_err (hub->intfdev,
1771 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1775 up_read(&ehci_cf_port_reset_rwsem);
1781 #define MASK_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION | \
1782 USB_PORT_STAT_SUSPEND)
1783 #define WANT_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION)
1785 /* Determine whether the device on a port is ready for a normal resume,
1786 * is ready for a reset-resume, or should be disconnected.
1788 static int check_port_resume_type(struct usb_device *udev,
1789 struct usb_hub *hub, int port1,
1790 int status, unsigned portchange, unsigned portstatus)
1792 /* Is the device still present? */
1793 if (status || (portstatus & MASK_BITS) != WANT_BITS) {
1798 /* Can't do a normal resume if the port isn't enabled */
1799 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume)
1803 dev_dbg(hub->intfdev,
1804 "port %d status %04x.%04x after resume, %d\n",
1805 port1, portchange, portstatus, status);
1806 } else if (udev->reset_resume) {
1808 /* Late port handoff can set status-change bits */
1809 if (portchange & USB_PORT_STAT_C_CONNECTION)
1810 clear_port_feature(hub->hdev, port1,
1811 USB_PORT_FEAT_C_CONNECTION);
1812 if (portchange & USB_PORT_STAT_C_ENABLE)
1813 clear_port_feature(hub->hdev, port1,
1814 USB_PORT_FEAT_C_ENABLE);
1820 #ifdef CONFIG_USB_SUSPEND
1823 * usb_port_suspend - suspend a usb device's upstream port
1824 * @udev: device that's no longer in active use, not a root hub
1825 * Context: must be able to sleep; device not locked; pm locks held
1827 * Suspends a USB device that isn't in active use, conserving power.
1828 * Devices may wake out of a suspend, if anything important happens,
1829 * using the remote wakeup mechanism. They may also be taken out of
1830 * suspend by the host, using usb_port_resume(). It's also routine
1831 * to disconnect devices while they are suspended.
1833 * This only affects the USB hardware for a device; its interfaces
1834 * (and, for hubs, child devices) must already have been suspended.
1836 * Selective port suspend reduces power; most suspended devices draw
1837 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1838 * All devices below the suspended port are also suspended.
1840 * Devices leave suspend state when the host wakes them up. Some devices
1841 * also support "remote wakeup", where the device can activate the USB
1842 * tree above them to deliver data, such as a keypress or packet. In
1843 * some cases, this wakes the USB host.
1845 * Suspending OTG devices may trigger HNP, if that's been enabled
1846 * between a pair of dual-role devices. That will change roles, such
1847 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1849 * Devices on USB hub ports have only one "suspend" state, corresponding
1850 * to ACPI D2, "may cause the device to lose some context".
1851 * State transitions include:
1853 * - suspend, resume ... when the VBUS power link stays live
1854 * - suspend, disconnect ... VBUS lost
1856 * Once VBUS drop breaks the circuit, the port it's using has to go through
1857 * normal re-enumeration procedures, starting with enabling VBUS power.
1858 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1859 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1860 * timer, no SRP, no requests through sysfs.
1862 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1863 * the root hub for their bus goes into global suspend ... so we don't
1864 * (falsely) update the device power state to say it suspended.
1866 * Returns 0 on success, else negative errno.
1868 int usb_port_suspend(struct usb_device *udev)
1870 struct usb_hub *hub = hdev_to_hub(udev->parent);
1871 int port1 = udev->portnum;
1874 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1876 /* enable remote wakeup when appropriate; this lets the device
1877 * wake up the upstream hub (including maybe the root hub).
1879 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1880 * we don't explicitly enable it here.
1882 if (udev->do_remote_wakeup) {
1883 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1884 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1885 USB_DEVICE_REMOTE_WAKEUP, 0,
1887 USB_CTRL_SET_TIMEOUT);
1889 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
1894 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1896 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
1898 /* paranoia: "should not happen" */
1899 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1900 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1901 USB_DEVICE_REMOTE_WAKEUP, 0,
1903 USB_CTRL_SET_TIMEOUT);
1905 /* device has up to 10 msec to fully suspend */
1906 dev_dbg(&udev->dev, "usb %ssuspend\n",
1907 udev->auto_pm ? "auto-" : "");
1908 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1915 * If the USB "suspend" state is in use (rather than "global suspend"),
1916 * many devices will be individually taken out of suspend state using
1917 * special "resume" signaling. This routine kicks in shortly after
1918 * hardware resume signaling is finished, either because of selective
1919 * resume (by host) or remote wakeup (by device) ... now see what changed
1920 * in the tree that's rooted at this device.
1922 * If @udev->reset_resume is set then the device is reset before the
1923 * status check is done.
1925 static int finish_port_resume(struct usb_device *udev)
1930 /* caller owns the udev device lock */
1931 dev_dbg(&udev->dev, "finish %sresume\n",
1932 udev->reset_resume ? "reset-" : "");
1934 /* usb ch9 identifies four variants of SUSPENDED, based on what
1935 * state the device resumes to. Linux currently won't see the
1936 * first two on the host side; they'd be inside hub_port_init()
1937 * during many timeouts, but khubd can't suspend until later.
1939 usb_set_device_state(udev, udev->actconfig
1940 ? USB_STATE_CONFIGURED
1941 : USB_STATE_ADDRESS);
1943 /* 10.5.4.5 says not to reset a suspended port if the attached
1944 * device is enabled for remote wakeup. Hence the reset
1945 * operation is carried out here, after the port has been
1948 if (udev->reset_resume)
1949 status = usb_reset_device(udev);
1951 /* 10.5.4.5 says be sure devices in the tree are still there.
1952 * For now let's assume the device didn't go crazy on resume,
1953 * and device drivers will know about any resume quirks.
1957 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
1959 status = (status > 0 ? 0 : -ENODEV);
1963 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
1965 } else if (udev->actconfig) {
1966 le16_to_cpus(&devstatus);
1967 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
1968 status = usb_control_msg(udev,
1969 usb_sndctrlpipe(udev, 0),
1970 USB_REQ_CLEAR_FEATURE,
1972 USB_DEVICE_REMOTE_WAKEUP, 0,
1974 USB_CTRL_SET_TIMEOUT);
1976 dev_dbg(&udev->dev, "disable remote "
1977 "wakeup, status %d\n", status);
1985 * usb_port_resume - re-activate a suspended usb device's upstream port
1986 * @udev: device to re-activate, not a root hub
1987 * Context: must be able to sleep; device not locked; pm locks held
1989 * This will re-activate the suspended device, increasing power usage
1990 * while letting drivers communicate again with its endpoints.
1991 * USB resume explicitly guarantees that the power session between
1992 * the host and the device is the same as it was when the device
1995 * If @udev->reset_resume is set then this routine won't check that the
1996 * port is still enabled. Furthermore, finish_port_resume() above will
1997 * reset @udev. The end result is that a broken power session can be
1998 * recovered and @udev will appear to persist across a loss of VBUS power.
2000 * For example, if a host controller doesn't maintain VBUS suspend current
2001 * during a system sleep or is reset when the system wakes up, all the USB
2002 * power sessions below it will be broken. This is especially troublesome
2003 * for mass-storage devices containing mounted filesystems, since the
2004 * device will appear to have disconnected and all the memory mappings
2005 * to it will be lost. Using the USB_PERSIST facility, the device can be
2006 * made to appear as if it had not disconnected.
2008 * This facility can be dangerous. Although usb_reset_device() makes
2009 * every effort to insure that the same device is present after the
2010 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2011 * quite possible for a device to remain unaltered but its media to be
2012 * changed. If the user replaces a flash memory card while the system is
2013 * asleep, he will have only himself to blame when the filesystem on the
2014 * new card is corrupted and the system crashes.
2016 * Returns 0 on success, else negative errno.
2018 int usb_port_resume(struct usb_device *udev)
2020 struct usb_hub *hub = hdev_to_hub(udev->parent);
2021 int port1 = udev->portnum;
2023 u16 portchange, portstatus;
2025 /* Skip the initial Clear-Suspend step for a remote wakeup */
2026 status = hub_port_status(hub, port1, &portstatus, &portchange);
2027 if (status == 0 && !(portstatus & USB_PORT_STAT_SUSPEND))
2028 goto SuspendCleared;
2030 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2032 set_bit(port1, hub->busy_bits);
2034 /* see 7.1.7.7; affects power usage, but not budgeting */
2035 status = clear_port_feature(hub->hdev,
2036 port1, USB_PORT_FEAT_SUSPEND);
2038 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
2041 /* drive resume for at least 20 msec */
2042 dev_dbg(&udev->dev, "usb %sresume\n",
2043 udev->auto_pm ? "auto-" : "");
2046 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2047 * stop resume signaling. Then finish the resume
2050 status = hub_port_status(hub, port1, &portstatus, &portchange);
2052 /* TRSMRCY = 10 msec */
2058 if (portchange & USB_PORT_STAT_C_SUSPEND)
2059 clear_port_feature(hub->hdev, port1,
2060 USB_PORT_FEAT_C_SUSPEND);
2063 clear_bit(port1, hub->busy_bits);
2064 if (!hub->hdev->parent && !hub->busy_bits[0])
2065 usb_enable_root_hub_irq(hub->hdev->bus);
2067 status = check_port_resume_type(udev,
2068 hub, port1, status, portchange, portstatus);
2070 status = finish_port_resume(udev);
2072 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2073 hub_port_logical_disconnect(hub, port1);
2078 static int remote_wakeup(struct usb_device *udev)
2082 usb_lock_device(udev);
2083 if (udev->state == USB_STATE_SUSPENDED) {
2084 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
2085 usb_mark_last_busy(udev);
2086 status = usb_external_resume_device(udev);
2088 usb_unlock_device(udev);
2092 #else /* CONFIG_USB_SUSPEND */
2094 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2096 int usb_port_suspend(struct usb_device *udev)
2101 /* However we may need to do a reset-resume */
2103 int usb_port_resume(struct usb_device *udev)
2105 struct usb_hub *hub = hdev_to_hub(udev->parent);
2106 int port1 = udev->portnum;
2108 u16 portchange, portstatus;
2110 status = hub_port_status(hub, port1, &portstatus, &portchange);
2111 status = check_port_resume_type(udev,
2112 hub, port1, status, portchange, portstatus);
2115 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2116 hub_port_logical_disconnect(hub, port1);
2117 } else if (udev->reset_resume) {
2118 dev_dbg(&udev->dev, "reset-resume\n");
2119 status = usb_reset_device(udev);
2124 static inline int remote_wakeup(struct usb_device *udev)
2131 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
2133 struct usb_hub *hub = usb_get_intfdata (intf);
2134 struct usb_device *hdev = hub->hdev;
2137 /* fail if children aren't already suspended */
2138 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2139 struct usb_device *udev;
2141 udev = hdev->children [port1-1];
2142 if (udev && udev->can_submit) {
2144 dev_dbg(&intf->dev, "port %d nyet suspended\n",
2150 dev_dbg(&intf->dev, "%s\n", __func__);
2152 /* stop khubd and related activity */
2157 static int hub_resume(struct usb_interface *intf)
2159 struct usb_hub *hub = usb_get_intfdata(intf);
2161 dev_dbg(&intf->dev, "%s\n", __func__);
2162 hub_restart(hub, HUB_RESUME);
2166 static int hub_reset_resume(struct usb_interface *intf)
2168 struct usb_hub *hub = usb_get_intfdata(intf);
2170 dev_dbg(&intf->dev, "%s\n", __func__);
2172 hub_restart(hub, HUB_RESET_RESUME);
2177 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2178 * @rhdev: struct usb_device for the root hub
2180 * The USB host controller driver calls this function when its root hub
2181 * is resumed and Vbus power has been interrupted or the controller
2182 * has been reset. The routine marks @rhdev as having lost power.
2183 * When the hub driver is resumed it will take notice and carry out
2184 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2185 * the others will be disconnected.
2187 void usb_root_hub_lost_power(struct usb_device *rhdev)
2189 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
2190 rhdev->reset_resume = 1;
2192 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
2194 #else /* CONFIG_PM */
2196 static inline int remote_wakeup(struct usb_device *udev)
2201 #define hub_suspend NULL
2202 #define hub_resume NULL
2203 #define hub_reset_resume NULL
2207 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2209 * Between connect detection and reset signaling there must be a delay
2210 * of 100ms at least for debounce and power-settling. The corresponding
2211 * timer shall restart whenever the downstream port detects a disconnect.
2213 * Apparently there are some bluetooth and irda-dongles and a number of
2214 * low-speed devices for which this debounce period may last over a second.
2215 * Not covered by the spec - but easy to deal with.
2217 * This implementation uses a 1500ms total debounce timeout; if the
2218 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2219 * every 25ms for transient disconnects. When the port status has been
2220 * unchanged for 100ms it returns the port status.
2223 #define HUB_DEBOUNCE_TIMEOUT 1500
2224 #define HUB_DEBOUNCE_STEP 25
2225 #define HUB_DEBOUNCE_STABLE 100
2227 static int hub_port_debounce(struct usb_hub *hub, int port1)
2230 int total_time, stable_time = 0;
2231 u16 portchange, portstatus;
2232 unsigned connection = 0xffff;
2234 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2235 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2239 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2240 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2241 stable_time += HUB_DEBOUNCE_STEP;
2242 if (stable_time >= HUB_DEBOUNCE_STABLE)
2246 connection = portstatus & USB_PORT_STAT_CONNECTION;
2249 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2250 clear_port_feature(hub->hdev, port1,
2251 USB_PORT_FEAT_C_CONNECTION);
2254 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2256 msleep(HUB_DEBOUNCE_STEP);
2259 dev_dbg (hub->intfdev,
2260 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2261 port1, total_time, stable_time, portstatus);
2263 if (stable_time < HUB_DEBOUNCE_STABLE)
2268 void usb_ep0_reinit(struct usb_device *udev)
2270 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
2271 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
2272 usb_enable_endpoint(udev, &udev->ep0);
2274 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
2276 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2277 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2279 static int hub_set_address(struct usb_device *udev, int devnum)
2285 if (udev->state == USB_STATE_ADDRESS)
2287 if (udev->state != USB_STATE_DEFAULT)
2289 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2290 USB_REQ_SET_ADDRESS, 0, devnum, 0,
2291 NULL, 0, USB_CTRL_SET_TIMEOUT);
2293 /* Device now using proper address. */
2294 update_address(udev, devnum);
2295 usb_set_device_state(udev, USB_STATE_ADDRESS);
2296 usb_ep0_reinit(udev);
2301 /* Reset device, (re)assign address, get device descriptor.
2302 * Device connection must be stable, no more debouncing needed.
2303 * Returns device in USB_STATE_ADDRESS, except on error.
2305 * If this is called for an already-existing device (as part of
2306 * usb_reset_device), the caller must own the device lock. For a
2307 * newly detected device that is not accessible through any global
2308 * pointers, it's not necessary to lock the device.
2311 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2314 static DEFINE_MUTEX(usb_address0_mutex);
2316 struct usb_device *hdev = hub->hdev;
2318 unsigned delay = HUB_SHORT_RESET_TIME;
2319 enum usb_device_speed oldspeed = udev->speed;
2321 int devnum = udev->devnum;
2323 /* root hub ports have a slightly longer reset period
2324 * (from USB 2.0 spec, section 7.1.7.5)
2326 if (!hdev->parent) {
2327 delay = HUB_ROOT_RESET_TIME;
2328 if (port1 == hdev->bus->otg_port)
2329 hdev->bus->b_hnp_enable = 0;
2332 /* Some low speed devices have problems with the quick delay, so */
2333 /* be a bit pessimistic with those devices. RHbug #23670 */
2334 if (oldspeed == USB_SPEED_LOW)
2335 delay = HUB_LONG_RESET_TIME;
2337 mutex_lock(&usb_address0_mutex);
2339 /* Reset the device; full speed may morph to high speed */
2340 retval = hub_port_reset(hub, port1, udev, delay);
2341 if (retval < 0) /* error or disconnect */
2343 /* success, speed is known */
2346 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2347 dev_dbg(&udev->dev, "device reset changed speed!\n");
2350 oldspeed = udev->speed;
2352 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2353 * it's fixed size except for full speed devices.
2354 * For Wireless USB devices, ep0 max packet is always 512 (tho
2355 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2357 switch (udev->speed) {
2358 case USB_SPEED_VARIABLE: /* fixed at 512 */
2359 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(512);
2361 case USB_SPEED_HIGH: /* fixed at 64 */
2362 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2364 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2365 /* to determine the ep0 maxpacket size, try to read
2366 * the device descriptor to get bMaxPacketSize0 and
2367 * then correct our initial guess.
2369 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2371 case USB_SPEED_LOW: /* fixed at 8 */
2372 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2379 switch (udev->speed) {
2380 case USB_SPEED_LOW: speed = "low"; break;
2381 case USB_SPEED_FULL: speed = "full"; break;
2382 case USB_SPEED_HIGH: speed = "high"; break;
2383 case USB_SPEED_VARIABLE:
2387 default: speed = "?"; break;
2389 dev_info (&udev->dev,
2390 "%s %s speed %sUSB device using %s and address %d\n",
2391 (udev->config) ? "reset" : "new", speed, type,
2392 udev->bus->controller->driver->name, devnum);
2394 /* Set up TT records, if needed */
2396 udev->tt = hdev->tt;
2397 udev->ttport = hdev->ttport;
2398 } else if (udev->speed != USB_SPEED_HIGH
2399 && hdev->speed == USB_SPEED_HIGH) {
2400 udev->tt = &hub->tt;
2401 udev->ttport = port1;
2404 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2405 * Because device hardware and firmware is sometimes buggy in
2406 * this area, and this is how Linux has done it for ages.
2407 * Change it cautiously.
2409 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2410 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2411 * so it may help with some non-standards-compliant devices.
2412 * Otherwise we start with SET_ADDRESS and then try to read the
2413 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2416 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2417 if (USE_NEW_SCHEME(retry_counter)) {
2418 struct usb_device_descriptor *buf;
2421 #define GET_DESCRIPTOR_BUFSIZE 64
2422 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2428 /* Retry on all errors; some devices are flakey.
2429 * 255 is for WUSB devices, we actually need to use
2430 * 512 (WUSB1.0[4.8.1]).
2432 for (j = 0; j < 3; ++j) {
2433 buf->bMaxPacketSize0 = 0;
2434 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2435 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2436 USB_DT_DEVICE << 8, 0,
2437 buf, GET_DESCRIPTOR_BUFSIZE,
2438 USB_CTRL_GET_TIMEOUT);
2439 switch (buf->bMaxPacketSize0) {
2440 case 8: case 16: case 32: case 64: case 255:
2441 if (buf->bDescriptorType ==
2455 udev->descriptor.bMaxPacketSize0 =
2456 buf->bMaxPacketSize0;
2459 retval = hub_port_reset(hub, port1, udev, delay);
2460 if (retval < 0) /* error or disconnect */
2462 if (oldspeed != udev->speed) {
2464 "device reset changed speed!\n");
2469 dev_err(&udev->dev, "device descriptor "
2470 "read/%s, error %d\n",
2475 #undef GET_DESCRIPTOR_BUFSIZE
2479 * If device is WUSB, we already assigned an
2480 * unauthorized address in the Connect Ack sequence;
2481 * authorization will assign the final address.
2483 if (udev->wusb == 0) {
2484 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2485 retval = hub_set_address(udev, devnum);
2492 "device not accepting address %d, error %d\n",
2497 /* cope with hardware quirkiness:
2498 * - let SET_ADDRESS settle, some device hardware wants it
2499 * - read ep0 maxpacket even for high and low speed,
2502 if (USE_NEW_SCHEME(retry_counter))
2506 retval = usb_get_device_descriptor(udev, 8);
2508 dev_err(&udev->dev, "device descriptor "
2509 "read/%s, error %d\n",
2521 i = udev->descriptor.bMaxPacketSize0 == 0xff? /* wusb device? */
2522 512 : udev->descriptor.bMaxPacketSize0;
2523 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2524 if (udev->speed != USB_SPEED_FULL ||
2525 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2526 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2530 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2531 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2532 usb_ep0_reinit(udev);
2535 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2536 if (retval < (signed)sizeof(udev->descriptor)) {
2537 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2548 hub_port_disable(hub, port1, 0);
2549 update_address(udev, devnum); /* for disconnect processing */
2551 mutex_unlock(&usb_address0_mutex);
2556 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2558 struct usb_qualifier_descriptor *qual;
2561 qual = kmalloc (sizeof *qual, GFP_KERNEL);
2565 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2566 qual, sizeof *qual);
2567 if (status == sizeof *qual) {
2568 dev_info(&udev->dev, "not running at top speed; "
2569 "connect to a high speed hub\n");
2570 /* hub LEDs are probably harder to miss than syslog */
2571 if (hub->has_indicators) {
2572 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2573 schedule_delayed_work (&hub->leds, 0);
2580 hub_power_remaining (struct usb_hub *hub)
2582 struct usb_device *hdev = hub->hdev;
2586 if (!hub->limited_power)
2589 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2590 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2591 struct usb_device *udev = hdev->children[port1 - 1];
2597 /* Unconfigured devices may not use more than 100mA,
2598 * or 8mA for OTG ports */
2599 if (udev->actconfig)
2600 delta = udev->actconfig->desc.bMaxPower * 2;
2601 else if (port1 != udev->bus->otg_port || hdev->parent)
2605 if (delta > hub->mA_per_port)
2606 dev_warn(&udev->dev, "%dmA is over %umA budget "
2608 delta, hub->mA_per_port, port1);
2611 if (remaining < 0) {
2612 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2619 /* Handle physical or logical connection change events.
2620 * This routine is called when:
2621 * a port connection-change occurs;
2622 * a port enable-change occurs (often caused by EMI);
2623 * usb_reset_device() encounters changed descriptors (as from
2624 * a firmware download)
2625 * caller already locked the hub
2627 static void hub_port_connect_change(struct usb_hub *hub, int port1,
2628 u16 portstatus, u16 portchange)
2630 struct usb_device *hdev = hub->hdev;
2631 struct device *hub_dev = hub->intfdev;
2632 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
2633 unsigned wHubCharacteristics =
2634 le16_to_cpu(hub->descriptor->wHubCharacteristics);
2638 "port %d, status %04x, change %04x, %s\n",
2639 port1, portstatus, portchange, portspeed (portstatus));
2641 if (hub->has_indicators) {
2642 set_port_led(hub, port1, HUB_LED_AUTO);
2643 hub->indicator[port1-1] = INDICATOR_AUTO;
2646 #ifdef CONFIG_USB_OTG
2647 /* during HNP, don't repeat the debounce */
2648 if (hdev->bus->is_b_host)
2649 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
2650 USB_PORT_STAT_C_ENABLE);
2653 /* Try to use the debounce delay for protection against
2654 * port-enable changes caused, for example, by EMI.
2656 if (portchange & (USB_PORT_STAT_C_CONNECTION |
2657 USB_PORT_STAT_C_ENABLE)) {
2658 status = hub_port_debounce(hub, port1);
2660 if (printk_ratelimit())
2661 dev_err (hub_dev, "connect-debounce failed, "
2662 "port %d disabled\n", port1);
2663 portstatus &= ~USB_PORT_STAT_CONNECTION;
2665 portstatus = status;
2669 /* Disconnect any existing devices under this port */
2670 if (hdev->children[port1-1])
2671 usb_disconnect(&hdev->children[port1-1]);
2672 clear_bit(port1, hub->change_bits);
2674 /* Return now if debouncing failed or nothing is connected */
2675 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2677 /* maybe switch power back on (e.g. root hub was reset) */
2678 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
2679 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2680 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2682 if (portstatus & USB_PORT_STAT_ENABLE)
2687 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2688 struct usb_device *udev;
2690 /* reallocate for each attempt, since references
2691 * to the previous one can escape in various ways
2693 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2696 "couldn't allocate port %d usb_device\n",
2701 usb_set_device_state(udev, USB_STATE_POWERED);
2702 udev->speed = USB_SPEED_UNKNOWN;
2703 udev->bus_mA = hub->mA_per_port;
2704 udev->level = hdev->level + 1;
2705 udev->wusb = hub_is_wusb(hub);
2707 /* set the address */
2708 choose_address(udev);
2709 if (udev->devnum <= 0) {
2710 status = -ENOTCONN; /* Don't retry */
2714 /* reset and get descriptor */
2715 status = hub_port_init(hub, udev, port1, i);
2719 /* consecutive bus-powered hubs aren't reliable; they can
2720 * violate the voltage drop budget. if the new child has
2721 * a "powered" LED, users should notice we didn't enable it
2722 * (without reading syslog), even without per-port LEDs
2725 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
2726 && udev->bus_mA <= 100) {
2729 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2732 dev_dbg(&udev->dev, "get status %d ?\n", status);
2735 le16_to_cpus(&devstat);
2736 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2738 "can't connect bus-powered hub "
2740 if (hub->has_indicators) {
2741 hub->indicator[port1-1] =
2742 INDICATOR_AMBER_BLINK;
2743 schedule_delayed_work (&hub->leds, 0);
2745 status = -ENOTCONN; /* Don't retry */
2750 /* check for devices running slower than they could */
2751 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2752 && udev->speed == USB_SPEED_FULL
2753 && highspeed_hubs != 0)
2754 check_highspeed (hub, udev, port1);
2756 /* Store the parent's children[] pointer. At this point
2757 * udev becomes globally accessible, although presumably
2758 * no one will look at it until hdev is unlocked.
2762 /* We mustn't add new devices if the parent hub has
2763 * been disconnected; we would race with the
2764 * recursively_mark_NOTATTACHED() routine.
2766 spin_lock_irq(&device_state_lock);
2767 if (hdev->state == USB_STATE_NOTATTACHED)
2770 hdev->children[port1-1] = udev;
2771 spin_unlock_irq(&device_state_lock);
2773 /* Run it through the hoops (find a driver, etc) */
2775 status = usb_new_device(udev);
2777 spin_lock_irq(&device_state_lock);
2778 hdev->children[port1-1] = NULL;
2779 spin_unlock_irq(&device_state_lock);
2786 status = hub_power_remaining(hub);
2788 dev_dbg(hub_dev, "%dmA power budget left\n", status);
2793 hub_port_disable(hub, port1, 1);
2795 usb_ep0_reinit(udev);
2796 release_address(udev);
2798 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
2801 if (hub->hdev->parent ||
2802 !hcd->driver->port_handed_over ||
2803 !(hcd->driver->port_handed_over)(hcd, port1))
2804 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
2808 hub_port_disable(hub, port1, 1);
2809 if (hcd->driver->relinquish_port && !hub->hdev->parent)
2810 hcd->driver->relinquish_port(hcd, port1);
2813 static void hub_events(void)
2815 struct list_head *tmp;
2816 struct usb_device *hdev;
2817 struct usb_interface *intf;
2818 struct usb_hub *hub;
2819 struct device *hub_dev;
2828 * We restart the list every time to avoid a deadlock with
2829 * deleting hubs downstream from this one. This should be
2830 * safe since we delete the hub from the event list.
2831 * Not the most efficient, but avoids deadlocks.
2835 /* Grab the first entry at the beginning of the list */
2836 spin_lock_irq(&hub_event_lock);
2837 if (list_empty(&hub_event_list)) {
2838 spin_unlock_irq(&hub_event_lock);
2842 tmp = hub_event_list.next;
2845 hub = list_entry(tmp, struct usb_hub, event_list);
2846 kref_get(&hub->kref);
2847 spin_unlock_irq(&hub_event_lock);
2850 hub_dev = hub->intfdev;
2851 intf = to_usb_interface(hub_dev);
2852 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
2853 hdev->state, hub->descriptor
2854 ? hub->descriptor->bNbrPorts
2856 /* NOTE: expects max 15 ports... */
2857 (u16) hub->change_bits[0],
2858 (u16) hub->event_bits[0]);
2860 /* Lock the device, then check to see if we were
2861 * disconnected while waiting for the lock to succeed. */
2862 usb_lock_device(hdev);
2863 if (unlikely(hub->disconnected))
2866 /* If the hub has died, clean up after it */
2867 if (hdev->state == USB_STATE_NOTATTACHED) {
2868 hub->error = -ENODEV;
2874 ret = usb_autopm_get_interface(intf);
2876 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
2880 /* If this is an inactive hub, do nothing */
2885 dev_dbg (hub_dev, "resetting for error %d\n",
2888 ret = usb_reset_composite_device(hdev, intf);
2891 "error resetting hub: %d\n", ret);
2899 /* deal with port status changes */
2900 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2901 if (test_bit(i, hub->busy_bits))
2903 connect_change = test_bit(i, hub->change_bits);
2904 if (!test_and_clear_bit(i, hub->event_bits) &&
2908 ret = hub_port_status(hub, i,
2909 &portstatus, &portchange);
2913 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2914 clear_port_feature(hdev, i,
2915 USB_PORT_FEAT_C_CONNECTION);
2919 if (portchange & USB_PORT_STAT_C_ENABLE) {
2920 if (!connect_change)
2922 "port %d enable change, "
2925 clear_port_feature(hdev, i,
2926 USB_PORT_FEAT_C_ENABLE);
2929 * EM interference sometimes causes badly
2930 * shielded USB devices to be shutdown by
2931 * the hub, this hack enables them again.
2932 * Works at least with mouse driver.
2934 if (!(portstatus & USB_PORT_STAT_ENABLE)
2936 && hdev->children[i-1]) {
2939 "disabled by hub (EMI?), "
2946 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2947 clear_port_feature(hdev, i,
2948 USB_PORT_FEAT_C_SUSPEND);
2949 if (hdev->children[i-1]) {
2950 ret = remote_wakeup(hdev->
2956 hub_port_disable(hub, i, 1);
2959 "resume on port %d, status %d\n",
2963 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2965 "over-current change on port %d\n",
2967 clear_port_feature(hdev, i,
2968 USB_PORT_FEAT_C_OVER_CURRENT);
2972 if (portchange & USB_PORT_STAT_C_RESET) {
2974 "reset change on port %d\n",
2976 clear_port_feature(hdev, i,
2977 USB_PORT_FEAT_C_RESET);
2981 hub_port_connect_change(hub, i,
2982 portstatus, portchange);
2985 /* deal with hub status changes */
2986 if (test_and_clear_bit(0, hub->event_bits) == 0)
2988 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2989 dev_err (hub_dev, "get_hub_status failed\n");
2991 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2992 dev_dbg (hub_dev, "power change\n");
2993 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
2994 if (hubstatus & HUB_STATUS_LOCAL_POWER)
2995 /* FIXME: Is this always true? */
2996 hub->limited_power = 1;
2998 hub->limited_power = 0;
3000 if (hubchange & HUB_CHANGE_OVERCURRENT) {
3001 dev_dbg (hub_dev, "overcurrent change\n");
3002 msleep(500); /* Cool down */
3003 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
3008 /* If this is a root hub, tell the HCD it's okay to
3009 * re-enable port-change interrupts now. */
3010 if (!hdev->parent && !hub->busy_bits[0])
3011 usb_enable_root_hub_irq(hdev->bus);
3014 /* Allow autosuspend if we're not going to run again */
3015 if (list_empty(&hub->event_list))
3016 usb_autopm_enable(intf);
3018 usb_unlock_device(hdev);
3019 kref_put(&hub->kref, hub_release);
3021 } /* end while (1) */
3024 static int hub_thread(void *__unused)
3026 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3027 * port handover. Otherwise it might see that a full-speed device
3028 * was gone before the EHCI controller had handed its port over to
3029 * the companion full-speed controller.
3035 wait_event_freezable(khubd_wait,
3036 !list_empty(&hub_event_list) ||
3037 kthread_should_stop());
3038 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
3040 pr_debug("%s: khubd exiting\n", usbcore_name);
3044 static struct usb_device_id hub_id_table [] = {
3045 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
3046 .bDeviceClass = USB_CLASS_HUB},
3047 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
3048 .bInterfaceClass = USB_CLASS_HUB},
3049 { } /* Terminating entry */
3052 MODULE_DEVICE_TABLE (usb, hub_id_table);
3054 static struct usb_driver hub_driver = {
3057 .disconnect = hub_disconnect,
3058 .suspend = hub_suspend,
3059 .resume = hub_resume,
3060 .reset_resume = hub_reset_resume,
3061 .pre_reset = hub_pre_reset,
3062 .post_reset = hub_post_reset,
3064 .id_table = hub_id_table,
3065 .supports_autosuspend = 1,
3068 int usb_hub_init(void)
3070 if (usb_register(&hub_driver) < 0) {
3071 printk(KERN_ERR "%s: can't register hub driver\n",
3076 khubd_task = kthread_run(hub_thread, NULL, "khubd");
3077 if (!IS_ERR(khubd_task))
3080 /* Fall through if kernel_thread failed */
3081 usb_deregister(&hub_driver);
3082 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
3087 void usb_hub_cleanup(void)
3089 kthread_stop(khubd_task);
3092 * Hub resources are freed for us by usb_deregister. It calls
3093 * usb_driver_purge on every device which in turn calls that
3094 * devices disconnect function if it is using this driver.
3095 * The hub_disconnect function takes care of releasing the
3096 * individual hub resources. -greg
3098 usb_deregister(&hub_driver);
3099 } /* usb_hub_cleanup() */
3101 static int descriptors_changed(struct usb_device *udev,
3102 struct usb_device_descriptor *old_device_descriptor)
3106 unsigned serial_len = 0;
3108 unsigned old_length;
3112 if (memcmp(&udev->descriptor, old_device_descriptor,
3113 sizeof(*old_device_descriptor)) != 0)
3116 /* Since the idVendor, idProduct, and bcdDevice values in the
3117 * device descriptor haven't changed, we will assume the
3118 * Manufacturer and Product strings haven't changed either.
3119 * But the SerialNumber string could be different (e.g., a
3120 * different flash card of the same brand).
3123 serial_len = strlen(udev->serial) + 1;
3126 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3127 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3128 len = max(len, old_length);
3131 buf = kmalloc(len, GFP_NOIO);
3133 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
3134 /* assume the worst */
3137 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3138 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3139 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
3141 if (length != old_length) {
3142 dev_dbg(&udev->dev, "config index %d, error %d\n",
3147 if (memcmp (buf, udev->rawdescriptors[index], old_length)
3149 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
3151 ((struct usb_config_descriptor *) buf)->
3152 bConfigurationValue);
3158 if (!changed && serial_len) {
3159 length = usb_string(udev, udev->descriptor.iSerialNumber,
3161 if (length + 1 != serial_len) {
3162 dev_dbg(&udev->dev, "serial string error %d\n",
3165 } else if (memcmp(buf, udev->serial, length) != 0) {
3166 dev_dbg(&udev->dev, "serial string changed\n");
3176 * usb_reset_device - perform a USB port reset to reinitialize a device
3177 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3179 * WARNING - don't use this routine to reset a composite device
3180 * (one with multiple interfaces owned by separate drivers)!
3181 * Use usb_reset_composite_device() instead.
3183 * Do a port reset, reassign the device's address, and establish its
3184 * former operating configuration. If the reset fails, or the device's
3185 * descriptors change from their values before the reset, or the original
3186 * configuration and altsettings cannot be restored, a flag will be set
3187 * telling khubd to pretend the device has been disconnected and then
3188 * re-connected. All drivers will be unbound, and the device will be
3189 * re-enumerated and probed all over again.
3191 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3192 * flagged for logical disconnection, or some other negative error code
3193 * if the reset wasn't even attempted.
3195 * The caller must own the device lock. For example, it's safe to use
3196 * this from a driver probe() routine after downloading new firmware.
3197 * For calls that might not occur during probe(), drivers should lock
3198 * the device using usb_lock_device_for_reset().
3200 * Locking exception: This routine may also be called from within an
3201 * autoresume handler. Such usage won't conflict with other tasks
3202 * holding the device lock because these tasks should always call
3203 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
3205 int usb_reset_device(struct usb_device *udev)
3207 struct usb_device *parent_hdev = udev->parent;
3208 struct usb_hub *parent_hub;
3209 struct usb_device_descriptor descriptor = udev->descriptor;
3211 int port1 = udev->portnum;
3213 if (udev->state == USB_STATE_NOTATTACHED ||
3214 udev->state == USB_STATE_SUSPENDED) {
3215 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3221 /* this requires hcd-specific logic; see OHCI hc_restart() */
3222 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
3225 parent_hub = hdev_to_hub(parent_hdev);
3227 set_bit(port1, parent_hub->busy_bits);
3228 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3230 /* ep0 maxpacket size may change; let the HCD know about it.
3231 * Other endpoints will be handled by re-enumeration. */
3232 usb_ep0_reinit(udev);
3233 ret = hub_port_init(parent_hub, udev, port1, i);
3234 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
3237 clear_bit(port1, parent_hub->busy_bits);
3238 if (!parent_hdev->parent && !parent_hub->busy_bits[0])
3239 usb_enable_root_hub_irq(parent_hdev->bus);
3244 /* Device might have changed firmware (DFU or similar) */
3245 if (descriptors_changed(udev, &descriptor)) {
3246 dev_info(&udev->dev, "device firmware changed\n");
3247 udev->descriptor = descriptor; /* for disconnect() calls */
3251 if (!udev->actconfig)
3254 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3255 USB_REQ_SET_CONFIGURATION, 0,
3256 udev->actconfig->desc.bConfigurationValue, 0,
3257 NULL, 0, USB_CTRL_SET_TIMEOUT);
3260 "can't restore configuration #%d (error=%d)\n",
3261 udev->actconfig->desc.bConfigurationValue, ret);
3264 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3266 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3267 struct usb_interface *intf = udev->actconfig->interface[i];
3268 struct usb_interface_descriptor *desc;
3270 /* set_interface resets host side toggle even
3271 * for altsetting zero. the interface may have no driver.
3273 desc = &intf->cur_altsetting->desc;
3274 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3275 desc->bAlternateSetting);
3277 dev_err(&udev->dev, "failed to restore interface %d "
3278 "altsetting %d (error=%d)\n",
3279 desc->bInterfaceNumber,
3280 desc->bAlternateSetting,
3290 hub_port_logical_disconnect(parent_hub, port1);
3293 EXPORT_SYMBOL_GPL(usb_reset_device);
3296 * usb_reset_composite_device - warn interface drivers and perform a USB port reset
3297 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3298 * @iface: interface bound to the driver making the request (optional)
3300 * Warns all drivers bound to registered interfaces (using their pre_reset
3301 * method), performs the port reset, and then lets the drivers know that
3302 * the reset is over (using their post_reset method).
3304 * Return value is the same as for usb_reset_device().
3306 * The caller must own the device lock. For example, it's safe to use
3307 * this from a driver probe() routine after downloading new firmware.
3308 * For calls that might not occur during probe(), drivers should lock
3309 * the device using usb_lock_device_for_reset().
3311 int usb_reset_composite_device(struct usb_device *udev,
3312 struct usb_interface *iface)
3316 struct usb_host_config *config = udev->actconfig;
3318 if (udev->state == USB_STATE_NOTATTACHED ||
3319 udev->state == USB_STATE_SUSPENDED) {
3320 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3325 /* Prevent autosuspend during the reset */
3326 usb_autoresume_device(udev);
3328 if (iface && iface->condition != USB_INTERFACE_BINDING)
3332 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
3333 struct usb_interface *cintf = config->interface[i];
3334 struct usb_driver *drv;
3336 if (cintf->dev.driver) {
3337 drv = to_usb_driver(cintf->dev.driver);
3339 (drv->pre_reset)(cintf);
3340 /* FIXME: Unbind if pre_reset returns an error or isn't defined */
3345 ret = usb_reset_device(udev);
3348 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
3349 struct usb_interface *cintf = config->interface[i];
3350 struct usb_driver *drv;
3352 if (cintf->dev.driver) {
3353 drv = to_usb_driver(cintf->dev.driver);
3354 if (drv->post_reset)
3355 (drv->post_reset)(cintf);
3356 /* FIXME: Unbind if post_reset returns an error or isn't defined */
3361 usb_autosuspend_device(udev);
3364 EXPORT_SYMBOL_GPL(usb_reset_composite_device);