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);
133 #define HUB_DEBOUNCE_TIMEOUT 1500
134 #define HUB_DEBOUNCE_STEP 25
135 #define HUB_DEBOUNCE_STABLE 100
138 static inline char *portspeed(int portstatus)
140 if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
142 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
148 /* Note that hdev or one of its children must be locked! */
149 static inline struct usb_hub *hdev_to_hub(struct usb_device *hdev)
151 return usb_get_intfdata(hdev->actconfig->interface[0]);
154 /* USB 2.0 spec Section 11.24.4.5 */
155 static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
159 for (i = 0; i < 3; i++) {
160 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
161 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
162 USB_DT_HUB << 8, 0, data, size,
163 USB_CTRL_GET_TIMEOUT);
164 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
171 * USB 2.0 spec Section 11.24.2.1
173 static int clear_hub_feature(struct usb_device *hdev, int feature)
175 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
176 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
180 * USB 2.0 spec Section 11.24.2.2
182 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
184 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
185 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
190 * USB 2.0 spec Section 11.24.2.13
192 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
194 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
195 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
200 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
201 * for info about using port indicators
203 static void set_port_led(
209 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
210 USB_PORT_FEAT_INDICATOR);
212 dev_dbg (hub->intfdev,
213 "port %d indicator %s status %d\n",
215 ({ char *s; switch (selector) {
216 case HUB_LED_AMBER: s = "amber"; break;
217 case HUB_LED_GREEN: s = "green"; break;
218 case HUB_LED_OFF: s = "off"; break;
219 case HUB_LED_AUTO: s = "auto"; break;
220 default: s = "??"; break;
225 #define LED_CYCLE_PERIOD ((2*HZ)/3)
227 static void led_work (struct work_struct *work)
229 struct usb_hub *hub =
230 container_of(work, struct usb_hub, leds.work);
231 struct usb_device *hdev = hub->hdev;
233 unsigned changed = 0;
236 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
239 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
240 unsigned selector, mode;
242 /* 30%-50% duty cycle */
244 switch (hub->indicator[i]) {
246 case INDICATOR_CYCLE:
248 selector = HUB_LED_AUTO;
249 mode = INDICATOR_AUTO;
251 /* blinking green = sw attention */
252 case INDICATOR_GREEN_BLINK:
253 selector = HUB_LED_GREEN;
254 mode = INDICATOR_GREEN_BLINK_OFF;
256 case INDICATOR_GREEN_BLINK_OFF:
257 selector = HUB_LED_OFF;
258 mode = INDICATOR_GREEN_BLINK;
260 /* blinking amber = hw attention */
261 case INDICATOR_AMBER_BLINK:
262 selector = HUB_LED_AMBER;
263 mode = INDICATOR_AMBER_BLINK_OFF;
265 case INDICATOR_AMBER_BLINK_OFF:
266 selector = HUB_LED_OFF;
267 mode = INDICATOR_AMBER_BLINK;
269 /* blink green/amber = reserved */
270 case INDICATOR_ALT_BLINK:
271 selector = HUB_LED_GREEN;
272 mode = INDICATOR_ALT_BLINK_OFF;
274 case INDICATOR_ALT_BLINK_OFF:
275 selector = HUB_LED_AMBER;
276 mode = INDICATOR_ALT_BLINK;
281 if (selector != HUB_LED_AUTO)
283 set_port_led(hub, i + 1, selector);
284 hub->indicator[i] = mode;
286 if (!changed && blinkenlights) {
288 cursor %= hub->descriptor->bNbrPorts;
289 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
290 hub->indicator[cursor] = INDICATOR_CYCLE;
294 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
297 /* use a short timeout for hub/port status fetches */
298 #define USB_STS_TIMEOUT 1000
299 #define USB_STS_RETRIES 5
302 * USB 2.0 spec Section 11.24.2.6
304 static int get_hub_status(struct usb_device *hdev,
305 struct usb_hub_status *data)
307 int i, status = -ETIMEDOUT;
309 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
310 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
311 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
312 data, sizeof(*data), USB_STS_TIMEOUT);
318 * USB 2.0 spec Section 11.24.2.7
320 static int get_port_status(struct usb_device *hdev, int port1,
321 struct usb_port_status *data)
323 int i, status = -ETIMEDOUT;
325 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
326 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
327 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
328 data, sizeof(*data), USB_STS_TIMEOUT);
333 static int hub_port_status(struct usb_hub *hub, int port1,
334 u16 *status, u16 *change)
338 mutex_lock(&hub->status_mutex);
339 ret = get_port_status(hub->hdev, port1, &hub->status->port);
341 dev_err(hub->intfdev,
342 "%s failed (err = %d)\n", __func__, ret);
346 *status = le16_to_cpu(hub->status->port.wPortStatus);
347 *change = le16_to_cpu(hub->status->port.wPortChange);
350 mutex_unlock(&hub->status_mutex);
354 static void kick_khubd(struct usb_hub *hub)
358 /* Suppress autosuspend until khubd runs */
359 to_usb_interface(hub->intfdev)->pm_usage_cnt = 1;
361 spin_lock_irqsave(&hub_event_lock, flags);
362 if (!hub->disconnected && list_empty(&hub->event_list)) {
363 list_add_tail(&hub->event_list, &hub_event_list);
364 wake_up(&khubd_wait);
366 spin_unlock_irqrestore(&hub_event_lock, flags);
369 void usb_kick_khubd(struct usb_device *hdev)
371 /* FIXME: What if hdev isn't bound to the hub driver? */
372 kick_khubd(hdev_to_hub(hdev));
376 /* completion function, fires on port status changes and various faults */
377 static void hub_irq(struct urb *urb)
379 struct usb_hub *hub = urb->context;
380 int status = urb->status;
385 case -ENOENT: /* synchronous unlink */
386 case -ECONNRESET: /* async unlink */
387 case -ESHUTDOWN: /* hardware going away */
390 default: /* presumably an error */
391 /* Cause a hub reset after 10 consecutive errors */
392 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
393 if ((++hub->nerrors < 10) || hub->error)
398 /* let khubd handle things */
399 case 0: /* we got data: port status changed */
401 for (i = 0; i < urb->actual_length; ++i)
402 bits |= ((unsigned long) ((*hub->buffer)[i]))
404 hub->event_bits[0] = bits;
410 /* Something happened, let khubd figure it out */
417 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
418 && status != -ENODEV && status != -EPERM)
419 dev_err (hub->intfdev, "resubmit --> %d\n", status);
422 /* USB 2.0 spec Section 11.24.2.3 */
424 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
426 return usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
427 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
432 * enumeration blocks khubd for a long time. we use keventd instead, since
433 * long blocking there is the exception, not the rule. accordingly, HCDs
434 * talking to TTs must queue control transfers (not just bulk and iso), so
435 * both can talk to the same hub concurrently.
437 static void hub_tt_kevent (struct work_struct *work)
439 struct usb_hub *hub =
440 container_of(work, struct usb_hub, tt.kevent);
444 spin_lock_irqsave (&hub->tt.lock, flags);
445 while (--limit && !list_empty (&hub->tt.clear_list)) {
446 struct list_head *temp;
447 struct usb_tt_clear *clear;
448 struct usb_device *hdev = hub->hdev;
451 temp = hub->tt.clear_list.next;
452 clear = list_entry (temp, struct usb_tt_clear, clear_list);
453 list_del (&clear->clear_list);
455 /* drop lock so HCD can concurrently report other TT errors */
456 spin_unlock_irqrestore (&hub->tt.lock, flags);
457 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
458 spin_lock_irqsave (&hub->tt.lock, flags);
462 "clear tt %d (%04x) error %d\n",
463 clear->tt, clear->devinfo, status);
466 spin_unlock_irqrestore (&hub->tt.lock, flags);
470 * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
471 * @udev: the device whose split transaction failed
472 * @pipe: identifies the endpoint of the failed transaction
474 * High speed HCDs use this to tell the hub driver that some split control or
475 * bulk transaction failed in a way that requires clearing internal state of
476 * a transaction translator. This is normally detected (and reported) from
479 * It may not be possible for that hub to handle additional full (or low)
480 * speed transactions until that state is fully cleared out.
482 void usb_hub_tt_clear_buffer (struct usb_device *udev, int pipe)
484 struct usb_tt *tt = udev->tt;
486 struct usb_tt_clear *clear;
488 /* we've got to cope with an arbitrary number of pending TT clears,
489 * since each TT has "at least two" buffers that can need it (and
490 * there can be many TTs per hub). even if they're uncommon.
492 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
493 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
494 /* FIXME recover somehow ... RESET_TT? */
498 /* info that CLEAR_TT_BUFFER needs */
499 clear->tt = tt->multi ? udev->ttport : 1;
500 clear->devinfo = usb_pipeendpoint (pipe);
501 clear->devinfo |= udev->devnum << 4;
502 clear->devinfo |= usb_pipecontrol (pipe)
503 ? (USB_ENDPOINT_XFER_CONTROL << 11)
504 : (USB_ENDPOINT_XFER_BULK << 11);
505 if (usb_pipein (pipe))
506 clear->devinfo |= 1 << 15;
508 /* tell keventd to clear state for this TT */
509 spin_lock_irqsave (&tt->lock, flags);
510 list_add_tail (&clear->clear_list, &tt->clear_list);
511 schedule_work (&tt->kevent);
512 spin_unlock_irqrestore (&tt->lock, flags);
514 EXPORT_SYMBOL_GPL(usb_hub_tt_clear_buffer);
516 static void hub_power_on(struct usb_hub *hub)
519 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
520 u16 wHubCharacteristics =
521 le16_to_cpu(hub->descriptor->wHubCharacteristics);
523 /* Enable power on each port. Some hubs have reserved values
524 * of LPSM (> 2) in their descriptors, even though they are
525 * USB 2.0 hubs. Some hubs do not implement port-power switching
526 * but only emulate it. In all cases, the ports won't work
527 * unless we send these messages to the hub.
529 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
530 dev_dbg(hub->intfdev, "enabling power on all ports\n");
532 dev_dbg(hub->intfdev, "trying to enable port power on "
533 "non-switchable hub\n");
534 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
535 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
537 /* Wait at least 100 msec for power to become stable */
538 msleep(max(pgood_delay, (unsigned) 100));
541 static int hub_hub_status(struct usb_hub *hub,
542 u16 *status, u16 *change)
546 mutex_lock(&hub->status_mutex);
547 ret = get_hub_status(hub->hdev, &hub->status->hub);
549 dev_err (hub->intfdev,
550 "%s failed (err = %d)\n", __func__, ret);
552 *status = le16_to_cpu(hub->status->hub.wHubStatus);
553 *change = le16_to_cpu(hub->status->hub.wHubChange);
556 mutex_unlock(&hub->status_mutex);
560 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
562 struct usb_device *hdev = hub->hdev;
565 if (hdev->children[port1-1] && set_state)
566 usb_set_device_state(hdev->children[port1-1],
567 USB_STATE_NOTATTACHED);
569 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
571 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
577 * Disable a port and mark a logical connnect-change event, so that some
578 * time later khubd will disconnect() any existing usb_device on the port
579 * and will re-enumerate if there actually is a device attached.
581 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
583 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
584 hub_port_disable(hub, port1, 1);
586 /* FIXME let caller ask to power down the port:
587 * - some devices won't enumerate without a VBUS power cycle
588 * - SRP saves power that way
589 * - ... new call, TBD ...
590 * That's easy if this hub can switch power per-port, and
591 * khubd reactivates the port later (timer, SRP, etc).
592 * Powerdown must be optional, because of reset/DFU.
595 set_bit(port1, hub->change_bits);
599 enum hub_activation_type {
600 HUB_INIT, HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME
603 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
605 struct usb_device *hdev = hub->hdev;
608 bool need_debounce_delay = false;
610 /* After a resume, port power should still be on.
611 * For any other type of activation, turn it on.
613 if (type != HUB_RESUME)
616 /* Check each port and set hub->change_bits to let khubd know
617 * which ports need attention.
619 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
620 struct usb_device *udev = hdev->children[port1-1];
621 u16 portstatus, portchange;
623 portstatus = portchange = 0;
624 status = hub_port_status(hub, port1, &portstatus, &portchange);
625 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
626 dev_dbg(hub->intfdev,
627 "port %d: status %04x change %04x\n",
628 port1, portstatus, portchange);
630 /* After anything other than HUB_RESUME (i.e., initialization
631 * or any sort of reset), every port should be disabled.
632 * Unconnected ports should likewise be disabled (paranoia),
633 * and so should ports for which we have no usb_device.
635 if ((portstatus & USB_PORT_STAT_ENABLE) && (
636 type != HUB_RESUME ||
637 !(portstatus & USB_PORT_STAT_CONNECTION) ||
639 udev->state == USB_STATE_NOTATTACHED)) {
640 clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
641 portstatus &= ~USB_PORT_STAT_ENABLE;
644 /* Clear status-change flags; we'll debounce later */
645 if (portchange & USB_PORT_STAT_C_CONNECTION) {
646 need_debounce_delay = true;
647 clear_port_feature(hub->hdev, port1,
648 USB_PORT_FEAT_C_CONNECTION);
650 if (portchange & USB_PORT_STAT_C_ENABLE) {
651 need_debounce_delay = true;
652 clear_port_feature(hub->hdev, port1,
653 USB_PORT_FEAT_C_ENABLE);
656 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
657 /* Tell khubd to disconnect the device or
658 * check for a new connection
660 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
661 set_bit(port1, hub->change_bits);
663 } else if (portstatus & USB_PORT_STAT_ENABLE) {
664 /* The power session apparently survived the resume.
665 * If there was an overcurrent or suspend change
666 * (i.e., remote wakeup request), have khubd
670 set_bit(port1, hub->change_bits);
672 } else if (udev->persist_enabled) {
674 udev->reset_resume = 1;
676 set_bit(port1, hub->change_bits);
679 /* The power session is gone; tell khubd */
680 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
681 set_bit(port1, hub->change_bits);
685 /* If no port-status-change flags were set, we don't need any
686 * debouncing. If flags were set we can try to debounce the
687 * ports all at once right now, instead of letting khubd do them
688 * one at a time later on.
690 * If any port-status changes do occur during this delay, khubd
691 * will see them later and handle them normally.
693 if (need_debounce_delay)
694 msleep(HUB_DEBOUNCE_STABLE);
698 status = usb_submit_urb(hub->urb, GFP_NOIO);
700 dev_err(hub->intfdev, "activate --> %d\n", status);
701 if (hub->has_indicators && blinkenlights)
702 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
704 /* Scan all ports that need attention */
708 enum hub_quiescing_type {
709 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
712 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
714 struct usb_device *hdev = hub->hdev;
717 /* khubd and related activity won't re-trigger */
720 if (type != HUB_SUSPEND) {
721 /* Disconnect all the children */
722 for (i = 0; i < hdev->maxchild; ++i) {
723 if (hdev->children[i])
724 usb_disconnect(&hdev->children[i]);
728 /* Stop khubd and related activity */
729 usb_kill_urb(hub->urb);
730 if (hub->has_indicators)
731 cancel_delayed_work_sync(&hub->leds);
733 cancel_work_sync(&hub->tt.kevent);
736 /* caller has locked the hub device */
737 static int hub_pre_reset(struct usb_interface *intf)
739 struct usb_hub *hub = usb_get_intfdata(intf);
741 hub_quiesce(hub, HUB_PRE_RESET);
745 /* caller has locked the hub device */
746 static int hub_post_reset(struct usb_interface *intf)
748 struct usb_hub *hub = usb_get_intfdata(intf);
750 hub_activate(hub, HUB_POST_RESET);
754 static int hub_configure(struct usb_hub *hub,
755 struct usb_endpoint_descriptor *endpoint)
757 struct usb_device *hdev = hub->hdev;
758 struct device *hub_dev = hub->intfdev;
759 u16 hubstatus, hubchange;
760 u16 wHubCharacteristics;
765 hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
768 message = "can't allocate hub irq buffer";
773 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
775 message = "can't kmalloc hub status buffer";
779 mutex_init(&hub->status_mutex);
781 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
782 if (!hub->descriptor) {
783 message = "can't kmalloc hub descriptor";
788 /* Request the entire hub descriptor.
789 * hub->descriptor can handle USB_MAXCHILDREN ports,
790 * but the hub can/will return fewer bytes here.
792 ret = get_hub_descriptor(hdev, hub->descriptor,
793 sizeof(*hub->descriptor));
795 message = "can't read hub descriptor";
797 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
798 message = "hub has too many ports!";
803 hdev->maxchild = hub->descriptor->bNbrPorts;
804 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
805 (hdev->maxchild == 1) ? "" : "s");
807 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
809 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
811 char portstr [USB_MAXCHILDREN + 1];
813 for (i = 0; i < hdev->maxchild; i++)
814 portstr[i] = hub->descriptor->DeviceRemovable
815 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
817 portstr[hdev->maxchild] = 0;
818 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
820 dev_dbg(hub_dev, "standalone hub\n");
822 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
824 dev_dbg(hub_dev, "ganged power switching\n");
827 dev_dbg(hub_dev, "individual port power switching\n");
831 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
835 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
837 dev_dbg(hub_dev, "global over-current protection\n");
840 dev_dbg(hub_dev, "individual port over-current protection\n");
844 dev_dbg(hub_dev, "no over-current protection\n");
848 spin_lock_init (&hub->tt.lock);
849 INIT_LIST_HEAD (&hub->tt.clear_list);
850 INIT_WORK (&hub->tt.kevent, hub_tt_kevent);
851 switch (hdev->descriptor.bDeviceProtocol) {
855 dev_dbg(hub_dev, "Single TT\n");
859 ret = usb_set_interface(hdev, 0, 1);
861 dev_dbg(hub_dev, "TT per port\n");
864 dev_err(hub_dev, "Using single TT (err %d)\n",
869 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
870 hdev->descriptor.bDeviceProtocol);
874 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
875 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
876 case HUB_TTTT_8_BITS:
877 if (hdev->descriptor.bDeviceProtocol != 0) {
878 hub->tt.think_time = 666;
879 dev_dbg(hub_dev, "TT requires at most %d "
880 "FS bit times (%d ns)\n",
881 8, hub->tt.think_time);
884 case HUB_TTTT_16_BITS:
885 hub->tt.think_time = 666 * 2;
886 dev_dbg(hub_dev, "TT requires at most %d "
887 "FS bit times (%d ns)\n",
888 16, hub->tt.think_time);
890 case HUB_TTTT_24_BITS:
891 hub->tt.think_time = 666 * 3;
892 dev_dbg(hub_dev, "TT requires at most %d "
893 "FS bit times (%d ns)\n",
894 24, hub->tt.think_time);
896 case HUB_TTTT_32_BITS:
897 hub->tt.think_time = 666 * 4;
898 dev_dbg(hub_dev, "TT requires at most %d "
899 "FS bit times (%d ns)\n",
900 32, hub->tt.think_time);
904 /* probe() zeroes hub->indicator[] */
905 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
906 hub->has_indicators = 1;
907 dev_dbg(hub_dev, "Port indicators are supported\n");
910 dev_dbg(hub_dev, "power on to power good time: %dms\n",
911 hub->descriptor->bPwrOn2PwrGood * 2);
913 /* power budgeting mostly matters with bus-powered hubs,
914 * and battery-powered root hubs (may provide just 8 mA).
916 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
918 message = "can't get hub status";
921 le16_to_cpus(&hubstatus);
922 if (hdev == hdev->bus->root_hub) {
923 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
924 hub->mA_per_port = 500;
926 hub->mA_per_port = hdev->bus_mA;
927 hub->limited_power = 1;
929 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
930 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
931 hub->descriptor->bHubContrCurrent);
932 hub->limited_power = 1;
933 if (hdev->maxchild > 0) {
934 int remaining = hdev->bus_mA -
935 hub->descriptor->bHubContrCurrent;
937 if (remaining < hdev->maxchild * 100)
939 "insufficient power available "
940 "to use all downstream ports\n");
941 hub->mA_per_port = 100; /* 7.2.1.1 */
943 } else { /* Self-powered external hub */
944 /* FIXME: What about battery-powered external hubs that
945 * provide less current per port? */
946 hub->mA_per_port = 500;
948 if (hub->mA_per_port < 500)
949 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
952 ret = hub_hub_status(hub, &hubstatus, &hubchange);
954 message = "can't get hub status";
958 /* local power status reports aren't always correct */
959 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
960 dev_dbg(hub_dev, "local power source is %s\n",
961 (hubstatus & HUB_STATUS_LOCAL_POWER)
962 ? "lost (inactive)" : "good");
964 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
965 dev_dbg(hub_dev, "%sover-current condition exists\n",
966 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
968 /* set up the interrupt endpoint
969 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
970 * bytes as USB2.0[11.12.3] says because some hubs are known
971 * to send more data (and thus cause overflow). For root hubs,
972 * maxpktsize is defined in hcd.c's fake endpoint descriptors
973 * to be big enough for at least USB_MAXCHILDREN ports. */
974 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
975 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
977 if (maxp > sizeof(*hub->buffer))
978 maxp = sizeof(*hub->buffer);
980 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
982 message = "couldn't allocate interrupt urb";
987 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
988 hub, endpoint->bInterval);
989 hub->urb->transfer_dma = hub->buffer_dma;
990 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
992 /* maybe cycle the hub leds */
993 if (hub->has_indicators && blinkenlights)
994 hub->indicator [0] = INDICATOR_CYCLE;
996 hub_activate(hub, HUB_INIT);
1000 dev_err (hub_dev, "config failed, %s (err %d)\n",
1002 /* hub_disconnect() frees urb and descriptor */
1006 static void hub_release(struct kref *kref)
1008 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1010 usb_put_intf(to_usb_interface(hub->intfdev));
1014 static unsigned highspeed_hubs;
1016 static void hub_disconnect(struct usb_interface *intf)
1018 struct usb_hub *hub = usb_get_intfdata (intf);
1020 /* Take the hub off the event list and don't let it be added again */
1021 spin_lock_irq(&hub_event_lock);
1022 list_del_init(&hub->event_list);
1023 hub->disconnected = 1;
1024 spin_unlock_irq(&hub_event_lock);
1026 /* Disconnect all children and quiesce the hub */
1028 hub_quiesce(hub, HUB_DISCONNECT);
1030 usb_set_intfdata (intf, NULL);
1032 if (hub->hdev->speed == USB_SPEED_HIGH)
1035 usb_free_urb(hub->urb);
1036 kfree(hub->descriptor);
1038 usb_buffer_free(hub->hdev, sizeof(*hub->buffer), hub->buffer,
1041 kref_put(&hub->kref, hub_release);
1044 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1046 struct usb_host_interface *desc;
1047 struct usb_endpoint_descriptor *endpoint;
1048 struct usb_device *hdev;
1049 struct usb_hub *hub;
1051 desc = intf->cur_altsetting;
1052 hdev = interface_to_usbdev(intf);
1054 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1056 dev_warn(&intf->dev, "ignoring external hub\n");
1061 /* Some hubs have a subclass of 1, which AFAICT according to the */
1062 /* specs is not defined, but it works */
1063 if ((desc->desc.bInterfaceSubClass != 0) &&
1064 (desc->desc.bInterfaceSubClass != 1)) {
1066 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1070 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1071 if (desc->desc.bNumEndpoints != 1)
1072 goto descriptor_error;
1074 endpoint = &desc->endpoint[0].desc;
1076 /* If it's not an interrupt in endpoint, we'd better punt! */
1077 if (!usb_endpoint_is_int_in(endpoint))
1078 goto descriptor_error;
1080 /* We found a hub */
1081 dev_info (&intf->dev, "USB hub found\n");
1083 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1085 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1089 kref_init(&hub->kref);
1090 INIT_LIST_HEAD(&hub->event_list);
1091 hub->intfdev = &intf->dev;
1093 INIT_DELAYED_WORK(&hub->leds, led_work);
1096 usb_set_intfdata (intf, hub);
1097 intf->needs_remote_wakeup = 1;
1099 if (hdev->speed == USB_SPEED_HIGH)
1102 if (hub_configure(hub, endpoint) >= 0)
1105 hub_disconnect (intf);
1110 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1112 struct usb_device *hdev = interface_to_usbdev (intf);
1114 /* assert ifno == 0 (part of hub spec) */
1116 case USBDEVFS_HUB_PORTINFO: {
1117 struct usbdevfs_hub_portinfo *info = user_data;
1120 spin_lock_irq(&device_state_lock);
1121 if (hdev->devnum <= 0)
1124 info->nports = hdev->maxchild;
1125 for (i = 0; i < info->nports; i++) {
1126 if (hdev->children[i] == NULL)
1130 hdev->children[i]->devnum;
1133 spin_unlock_irq(&device_state_lock);
1135 return info->nports + 1;
1144 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1148 for (i = 0; i < udev->maxchild; ++i) {
1149 if (udev->children[i])
1150 recursively_mark_NOTATTACHED(udev->children[i]);
1152 if (udev->state == USB_STATE_SUSPENDED) {
1153 udev->discon_suspended = 1;
1154 udev->active_duration -= jiffies;
1156 udev->state = USB_STATE_NOTATTACHED;
1160 * usb_set_device_state - change a device's current state (usbcore, hcds)
1161 * @udev: pointer to device whose state should be changed
1162 * @new_state: new state value to be stored
1164 * udev->state is _not_ fully protected by the device lock. Although
1165 * most transitions are made only while holding the lock, the state can
1166 * can change to USB_STATE_NOTATTACHED at almost any time. This
1167 * is so that devices can be marked as disconnected as soon as possible,
1168 * without having to wait for any semaphores to be released. As a result,
1169 * all changes to any device's state must be protected by the
1170 * device_state_lock spinlock.
1172 * Once a device has been added to the device tree, all changes to its state
1173 * should be made using this routine. The state should _not_ be set directly.
1175 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1176 * Otherwise udev->state is set to new_state, and if new_state is
1177 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1178 * to USB_STATE_NOTATTACHED.
1180 void usb_set_device_state(struct usb_device *udev,
1181 enum usb_device_state new_state)
1183 unsigned long flags;
1185 spin_lock_irqsave(&device_state_lock, flags);
1186 if (udev->state == USB_STATE_NOTATTACHED)
1188 else if (new_state != USB_STATE_NOTATTACHED) {
1190 /* root hub wakeup capabilities are managed out-of-band
1191 * and may involve silicon errata ... ignore them here.
1194 if (udev->state == USB_STATE_SUSPENDED
1195 || new_state == USB_STATE_SUSPENDED)
1196 ; /* No change to wakeup settings */
1197 else if (new_state == USB_STATE_CONFIGURED)
1198 device_init_wakeup(&udev->dev,
1199 (udev->actconfig->desc.bmAttributes
1200 & USB_CONFIG_ATT_WAKEUP));
1202 device_init_wakeup(&udev->dev, 0);
1204 if (udev->state == USB_STATE_SUSPENDED &&
1205 new_state != USB_STATE_SUSPENDED)
1206 udev->active_duration -= jiffies;
1207 else if (new_state == USB_STATE_SUSPENDED &&
1208 udev->state != USB_STATE_SUSPENDED)
1209 udev->active_duration += jiffies;
1210 udev->state = new_state;
1212 recursively_mark_NOTATTACHED(udev);
1213 spin_unlock_irqrestore(&device_state_lock, flags);
1217 * WUSB devices are simple: they have no hubs behind, so the mapping
1218 * device <-> virtual port number becomes 1:1. Why? to simplify the
1219 * life of the device connection logic in
1220 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1221 * handshake we need to assign a temporary address in the unauthorized
1222 * space. For simplicity we use the first virtual port number found to
1223 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1224 * and that becomes it's address [X < 128] or its unauthorized address
1227 * We add 1 as an offset to the one-based USB-stack port number
1228 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1229 * 0 is reserved by USB for default address; (b) Linux's USB stack
1230 * uses always #1 for the root hub of the controller. So USB stack's
1231 * port #1, which is wusb virtual-port #0 has address #2.
1233 static void choose_address(struct usb_device *udev)
1236 struct usb_bus *bus = udev->bus;
1238 /* If khubd ever becomes multithreaded, this will need a lock */
1240 devnum = udev->portnum + 1;
1241 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1243 /* Try to allocate the next devnum beginning at
1244 * bus->devnum_next. */
1245 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1248 devnum = find_next_zero_bit(bus->devmap.devicemap,
1250 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1253 set_bit(devnum, bus->devmap.devicemap);
1254 udev->devnum = devnum;
1258 static void release_address(struct usb_device *udev)
1260 if (udev->devnum > 0) {
1261 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1266 static void update_address(struct usb_device *udev, int devnum)
1268 /* The address for a WUSB device is managed by wusbcore. */
1270 udev->devnum = devnum;
1273 #ifdef CONFIG_USB_SUSPEND
1275 static void usb_stop_pm(struct usb_device *udev)
1277 /* Synchronize with the ksuspend thread to prevent any more
1278 * autosuspend requests from being submitted, and decrement
1279 * the parent's count of unsuspended children.
1282 if (udev->parent && !udev->discon_suspended)
1283 usb_autosuspend_device(udev->parent);
1284 usb_pm_unlock(udev);
1286 /* Stop any autosuspend requests already submitted */
1287 cancel_rearming_delayed_work(&udev->autosuspend);
1292 static inline void usb_stop_pm(struct usb_device *udev)
1298 * usb_disconnect - disconnect a device (usbcore-internal)
1299 * @pdev: pointer to device being disconnected
1300 * Context: !in_interrupt ()
1302 * Something got disconnected. Get rid of it and all of its children.
1304 * If *pdev is a normal device then the parent hub must already be locked.
1305 * If *pdev is a root hub then this routine will acquire the
1306 * usb_bus_list_lock on behalf of the caller.
1308 * Only hub drivers (including virtual root hub drivers for host
1309 * controllers) should ever call this.
1311 * This call is synchronous, and may not be used in an interrupt context.
1313 void usb_disconnect(struct usb_device **pdev)
1315 struct usb_device *udev = *pdev;
1319 pr_debug ("%s nodev\n", __func__);
1323 /* mark the device as inactive, so any further urb submissions for
1324 * this device (and any of its children) will fail immediately.
1325 * this quiesces everyting except pending urbs.
1327 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1328 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1330 usb_lock_device(udev);
1332 /* Free up all the children before we remove this device */
1333 for (i = 0; i < USB_MAXCHILDREN; i++) {
1334 if (udev->children[i])
1335 usb_disconnect(&udev->children[i]);
1338 /* deallocate hcd/hardware state ... nuking all pending urbs and
1339 * cleaning up all state associated with the current configuration
1340 * so that the hardware is now fully quiesced.
1342 dev_dbg (&udev->dev, "unregistering device\n");
1343 usb_disable_device(udev, 0);
1345 usb_unlock_device(udev);
1347 /* Remove the device-specific files from sysfs. This must be
1348 * done with udev unlocked, because some of the attribute
1349 * routines try to acquire the device lock.
1351 usb_remove_sysfs_dev_files(udev);
1353 /* Unregister the device. The device driver is responsible
1354 * for removing the device files from usbfs and sysfs and for
1355 * de-configuring the device.
1357 device_del(&udev->dev);
1359 /* Free the device number and delete the parent's children[]
1360 * (or root_hub) pointer.
1362 release_address(udev);
1364 /* Avoid races with recursively_mark_NOTATTACHED() */
1365 spin_lock_irq(&device_state_lock);
1367 spin_unlock_irq(&device_state_lock);
1371 put_device(&udev->dev);
1374 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1375 static void show_string(struct usb_device *udev, char *id, char *string)
1379 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1382 static void announce_device(struct usb_device *udev)
1384 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1385 le16_to_cpu(udev->descriptor.idVendor),
1386 le16_to_cpu(udev->descriptor.idProduct));
1387 dev_info(&udev->dev, "New USB device strings: Mfr=%d, Product=%d, "
1388 "SerialNumber=%d\n",
1389 udev->descriptor.iManufacturer,
1390 udev->descriptor.iProduct,
1391 udev->descriptor.iSerialNumber);
1392 show_string(udev, "Product", udev->product);
1393 show_string(udev, "Manufacturer", udev->manufacturer);
1394 show_string(udev, "SerialNumber", udev->serial);
1397 static inline void announce_device(struct usb_device *udev) { }
1400 #ifdef CONFIG_USB_OTG
1401 #include "otg_whitelist.h"
1405 * usb_configure_device_otg - FIXME (usbcore-internal)
1406 * @udev: newly addressed device (in ADDRESS state)
1408 * Do configuration for On-The-Go devices
1410 static int usb_configure_device_otg(struct usb_device *udev)
1414 #ifdef CONFIG_USB_OTG
1416 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1417 * to wake us after we've powered off VBUS; and HNP, switching roles
1418 * "host" to "peripheral". The OTG descriptor helps figure this out.
1420 if (!udev->bus->is_b_host
1422 && udev->parent == udev->bus->root_hub) {
1423 struct usb_otg_descriptor *desc = 0;
1424 struct usb_bus *bus = udev->bus;
1426 /* descriptor may appear anywhere in config */
1427 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1428 le16_to_cpu(udev->config[0].desc.wTotalLength),
1429 USB_DT_OTG, (void **) &desc) == 0) {
1430 if (desc->bmAttributes & USB_OTG_HNP) {
1431 unsigned port1 = udev->portnum;
1433 dev_info(&udev->dev,
1434 "Dual-Role OTG device on %sHNP port\n",
1435 (port1 == bus->otg_port)
1438 /* enable HNP before suspend, it's simpler */
1439 if (port1 == bus->otg_port)
1440 bus->b_hnp_enable = 1;
1441 err = usb_control_msg(udev,
1442 usb_sndctrlpipe(udev, 0),
1443 USB_REQ_SET_FEATURE, 0,
1445 ? USB_DEVICE_B_HNP_ENABLE
1446 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1447 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1449 /* OTG MESSAGE: report errors here,
1450 * customize to match your product.
1452 dev_info(&udev->dev,
1453 "can't set HNP mode; %d\n",
1455 bus->b_hnp_enable = 0;
1461 if (!is_targeted(udev)) {
1463 /* Maybe it can talk to us, though we can't talk to it.
1464 * (Includes HNP test device.)
1466 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1467 err = usb_port_suspend(udev);
1469 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1481 * usb_configure_device - Detect and probe device intfs/otg (usbcore-internal)
1482 * @udev: newly addressed device (in ADDRESS state)
1484 * This is only called by usb_new_device() and usb_authorize_device()
1485 * and FIXME -- all comments that apply to them apply here wrt to
1488 * If the device is WUSB and not authorized, we don't attempt to read
1489 * the string descriptors, as they will be errored out by the device
1490 * until it has been authorized.
1492 static int usb_configure_device(struct usb_device *udev)
1496 if (udev->config == NULL) {
1497 err = usb_get_configuration(udev);
1499 dev_err(&udev->dev, "can't read configurations, error %d\n",
1504 if (udev->wusb == 1 && udev->authorized == 0) {
1505 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1506 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1507 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1510 /* read the standard strings and cache them if present */
1511 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1512 udev->manufacturer = usb_cache_string(udev,
1513 udev->descriptor.iManufacturer);
1514 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1516 err = usb_configure_device_otg(udev);
1523 * usb_new_device - perform initial device setup (usbcore-internal)
1524 * @udev: newly addressed device (in ADDRESS state)
1526 * This is called with devices which have been enumerated, but not yet
1527 * configured. The device descriptor is available, but not descriptors
1528 * for any device configuration. The caller must have locked either
1529 * the parent hub (if udev is a normal device) or else the
1530 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1531 * udev has already been installed, but udev is not yet visible through
1532 * sysfs or other filesystem code.
1534 * It will return if the device is configured properly or not. Zero if
1535 * the interface was registered with the driver core; else a negative
1538 * This call is synchronous, and may not be used in an interrupt context.
1540 * Only the hub driver or root-hub registrar should ever call this.
1542 int usb_new_device(struct usb_device *udev)
1546 usb_detect_quirks(udev); /* Determine quirks */
1547 err = usb_configure_device(udev); /* detect & probe dev/intfs */
1550 /* export the usbdev device-node for libusb */
1551 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1552 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1554 /* Increment the parent's count of unsuspended children */
1556 usb_autoresume_device(udev->parent);
1558 /* Register the device. The device driver is responsible
1559 * for adding the device files to sysfs and for configuring
1562 err = device_add(&udev->dev);
1564 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1568 /* put device-specific files into sysfs */
1569 usb_create_sysfs_dev_files(udev);
1571 /* Tell the world! */
1572 announce_device(udev);
1576 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1582 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1583 * @usb_dev: USB device
1585 * Move the USB device to a very basic state where interfaces are disabled
1586 * and the device is in fact unconfigured and unusable.
1588 * We share a lock (that we have) with device_del(), so we need to
1591 int usb_deauthorize_device(struct usb_device *usb_dev)
1594 usb_lock_device(usb_dev);
1595 if (usb_dev->authorized == 0)
1596 goto out_unauthorized;
1597 usb_dev->authorized = 0;
1598 usb_set_configuration(usb_dev, -1);
1599 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1600 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1601 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1602 kfree(usb_dev->config);
1603 usb_dev->config = NULL;
1604 for (cnt = 0; cnt < usb_dev->descriptor.bNumConfigurations; cnt++)
1605 kfree(usb_dev->rawdescriptors[cnt]);
1606 usb_dev->descriptor.bNumConfigurations = 0;
1607 kfree(usb_dev->rawdescriptors);
1609 usb_unlock_device(usb_dev);
1614 int usb_authorize_device(struct usb_device *usb_dev)
1617 usb_lock_device(usb_dev);
1618 if (usb_dev->authorized == 1)
1619 goto out_authorized;
1620 kfree(usb_dev->product);
1621 usb_dev->product = NULL;
1622 kfree(usb_dev->manufacturer);
1623 usb_dev->manufacturer = NULL;
1624 kfree(usb_dev->serial);
1625 usb_dev->serial = NULL;
1626 result = usb_autoresume_device(usb_dev);
1628 dev_err(&usb_dev->dev,
1629 "can't autoresume for authorization: %d\n", result);
1630 goto error_autoresume;
1632 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
1634 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
1635 "authorization: %d\n", result);
1636 goto error_device_descriptor;
1638 usb_dev->authorized = 1;
1639 result = usb_configure_device(usb_dev);
1641 goto error_configure;
1642 /* Choose and set the configuration. This registers the interfaces
1643 * with the driver core and lets interface drivers bind to them.
1645 c = usb_choose_configuration(usb_dev);
1647 result = usb_set_configuration(usb_dev, c);
1649 dev_err(&usb_dev->dev,
1650 "can't set config #%d, error %d\n", c, result);
1651 /* This need not be fatal. The user can try to
1652 * set other configurations. */
1655 dev_info(&usb_dev->dev, "authorized to connect\n");
1657 error_device_descriptor:
1660 usb_unlock_device(usb_dev); // complements locktree
1665 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1666 static unsigned hub_is_wusb(struct usb_hub *hub)
1668 struct usb_hcd *hcd;
1669 if (hub->hdev->parent != NULL) /* not a root hub? */
1671 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
1672 return hcd->wireless;
1676 #define PORT_RESET_TRIES 5
1677 #define SET_ADDRESS_TRIES 2
1678 #define GET_DESCRIPTOR_TRIES 2
1679 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1680 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1682 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1683 #define HUB_SHORT_RESET_TIME 10
1684 #define HUB_LONG_RESET_TIME 200
1685 #define HUB_RESET_TIMEOUT 500
1687 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1688 struct usb_device *udev, unsigned int delay)
1690 int delay_time, ret;
1694 for (delay_time = 0;
1695 delay_time < HUB_RESET_TIMEOUT;
1696 delay_time += delay) {
1697 /* wait to give the device a chance to reset */
1700 /* read and decode port status */
1701 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1705 /* Device went away? */
1706 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1709 /* bomb out completely if the connection bounced */
1710 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1713 /* if we`ve finished resetting, then break out of the loop */
1714 if (!(portstatus & USB_PORT_STAT_RESET) &&
1715 (portstatus & USB_PORT_STAT_ENABLE)) {
1716 if (hub_is_wusb(hub))
1717 udev->speed = USB_SPEED_VARIABLE;
1718 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1719 udev->speed = USB_SPEED_HIGH;
1720 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1721 udev->speed = USB_SPEED_LOW;
1723 udev->speed = USB_SPEED_FULL;
1727 /* switch to the long delay after two short delay failures */
1728 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1729 delay = HUB_LONG_RESET_TIME;
1731 dev_dbg (hub->intfdev,
1732 "port %d not reset yet, waiting %dms\n",
1739 static int hub_port_reset(struct usb_hub *hub, int port1,
1740 struct usb_device *udev, unsigned int delay)
1744 /* Block EHCI CF initialization during the port reset.
1745 * Some companion controllers don't like it when they mix.
1747 down_read(&ehci_cf_port_reset_rwsem);
1749 /* Reset the port */
1750 for (i = 0; i < PORT_RESET_TRIES; i++) {
1751 status = set_port_feature(hub->hdev,
1752 port1, USB_PORT_FEAT_RESET);
1754 dev_err(hub->intfdev,
1755 "cannot reset port %d (err = %d)\n",
1758 status = hub_port_wait_reset(hub, port1, udev, delay);
1759 if (status && status != -ENOTCONN)
1760 dev_dbg(hub->intfdev,
1761 "port_wait_reset: err = %d\n",
1765 /* return on disconnect or reset */
1768 /* TRSTRCY = 10 ms; plus some extra */
1770 update_address(udev, 0);
1774 clear_port_feature(hub->hdev,
1775 port1, USB_PORT_FEAT_C_RESET);
1776 /* FIXME need disconnect() for NOTATTACHED device */
1777 usb_set_device_state(udev, status
1778 ? USB_STATE_NOTATTACHED
1779 : USB_STATE_DEFAULT);
1783 dev_dbg (hub->intfdev,
1784 "port %d not enabled, trying reset again...\n",
1786 delay = HUB_LONG_RESET_TIME;
1789 dev_err (hub->intfdev,
1790 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1794 up_read(&ehci_cf_port_reset_rwsem);
1800 #define MASK_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION | \
1801 USB_PORT_STAT_SUSPEND)
1802 #define WANT_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION)
1804 /* Determine whether the device on a port is ready for a normal resume,
1805 * is ready for a reset-resume, or should be disconnected.
1807 static int check_port_resume_type(struct usb_device *udev,
1808 struct usb_hub *hub, int port1,
1809 int status, unsigned portchange, unsigned portstatus)
1811 /* Is the device still present? */
1812 if (status || (portstatus & MASK_BITS) != WANT_BITS) {
1817 /* Can't do a normal resume if the port isn't enabled */
1818 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume)
1822 dev_dbg(hub->intfdev,
1823 "port %d status %04x.%04x after resume, %d\n",
1824 port1, portchange, portstatus, status);
1825 } else if (udev->reset_resume) {
1827 /* Late port handoff can set status-change bits */
1828 if (portchange & USB_PORT_STAT_C_CONNECTION)
1829 clear_port_feature(hub->hdev, port1,
1830 USB_PORT_FEAT_C_CONNECTION);
1831 if (portchange & USB_PORT_STAT_C_ENABLE)
1832 clear_port_feature(hub->hdev, port1,
1833 USB_PORT_FEAT_C_ENABLE);
1839 #ifdef CONFIG_USB_SUSPEND
1842 * usb_port_suspend - suspend a usb device's upstream port
1843 * @udev: device that's no longer in active use, not a root hub
1844 * Context: must be able to sleep; device not locked; pm locks held
1846 * Suspends a USB device that isn't in active use, conserving power.
1847 * Devices may wake out of a suspend, if anything important happens,
1848 * using the remote wakeup mechanism. They may also be taken out of
1849 * suspend by the host, using usb_port_resume(). It's also routine
1850 * to disconnect devices while they are suspended.
1852 * This only affects the USB hardware for a device; its interfaces
1853 * (and, for hubs, child devices) must already have been suspended.
1855 * Selective port suspend reduces power; most suspended devices draw
1856 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1857 * All devices below the suspended port are also suspended.
1859 * Devices leave suspend state when the host wakes them up. Some devices
1860 * also support "remote wakeup", where the device can activate the USB
1861 * tree above them to deliver data, such as a keypress or packet. In
1862 * some cases, this wakes the USB host.
1864 * Suspending OTG devices may trigger HNP, if that's been enabled
1865 * between a pair of dual-role devices. That will change roles, such
1866 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1868 * Devices on USB hub ports have only one "suspend" state, corresponding
1869 * to ACPI D2, "may cause the device to lose some context".
1870 * State transitions include:
1872 * - suspend, resume ... when the VBUS power link stays live
1873 * - suspend, disconnect ... VBUS lost
1875 * Once VBUS drop breaks the circuit, the port it's using has to go through
1876 * normal re-enumeration procedures, starting with enabling VBUS power.
1877 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1878 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1879 * timer, no SRP, no requests through sysfs.
1881 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1882 * the root hub for their bus goes into global suspend ... so we don't
1883 * (falsely) update the device power state to say it suspended.
1885 * Returns 0 on success, else negative errno.
1887 int usb_port_suspend(struct usb_device *udev)
1889 struct usb_hub *hub = hdev_to_hub(udev->parent);
1890 int port1 = udev->portnum;
1893 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1895 /* enable remote wakeup when appropriate; this lets the device
1896 * wake up the upstream hub (including maybe the root hub).
1898 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1899 * we don't explicitly enable it here.
1901 if (udev->do_remote_wakeup) {
1902 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1903 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1904 USB_DEVICE_REMOTE_WAKEUP, 0,
1906 USB_CTRL_SET_TIMEOUT);
1908 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
1913 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1915 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
1917 /* paranoia: "should not happen" */
1918 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1919 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1920 USB_DEVICE_REMOTE_WAKEUP, 0,
1922 USB_CTRL_SET_TIMEOUT);
1924 /* device has up to 10 msec to fully suspend */
1925 dev_dbg(&udev->dev, "usb %ssuspend\n",
1926 udev->auto_pm ? "auto-" : "");
1927 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1934 * If the USB "suspend" state is in use (rather than "global suspend"),
1935 * many devices will be individually taken out of suspend state using
1936 * special "resume" signaling. This routine kicks in shortly after
1937 * hardware resume signaling is finished, either because of selective
1938 * resume (by host) or remote wakeup (by device) ... now see what changed
1939 * in the tree that's rooted at this device.
1941 * If @udev->reset_resume is set then the device is reset before the
1942 * status check is done.
1944 static int finish_port_resume(struct usb_device *udev)
1949 /* caller owns the udev device lock */
1950 dev_dbg(&udev->dev, "finish %sresume\n",
1951 udev->reset_resume ? "reset-" : "");
1953 /* usb ch9 identifies four variants of SUSPENDED, based on what
1954 * state the device resumes to. Linux currently won't see the
1955 * first two on the host side; they'd be inside hub_port_init()
1956 * during many timeouts, but khubd can't suspend until later.
1958 usb_set_device_state(udev, udev->actconfig
1959 ? USB_STATE_CONFIGURED
1960 : USB_STATE_ADDRESS);
1962 /* 10.5.4.5 says not to reset a suspended port if the attached
1963 * device is enabled for remote wakeup. Hence the reset
1964 * operation is carried out here, after the port has been
1967 if (udev->reset_resume)
1968 status = usb_reset_device(udev);
1970 /* 10.5.4.5 says be sure devices in the tree are still there.
1971 * For now let's assume the device didn't go crazy on resume,
1972 * and device drivers will know about any resume quirks.
1976 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
1978 status = (status > 0 ? 0 : -ENODEV);
1982 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
1984 } else if (udev->actconfig) {
1985 le16_to_cpus(&devstatus);
1986 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
1987 status = usb_control_msg(udev,
1988 usb_sndctrlpipe(udev, 0),
1989 USB_REQ_CLEAR_FEATURE,
1991 USB_DEVICE_REMOTE_WAKEUP, 0,
1993 USB_CTRL_SET_TIMEOUT);
1995 dev_dbg(&udev->dev, "disable remote "
1996 "wakeup, status %d\n", status);
2004 * usb_port_resume - re-activate a suspended usb device's upstream port
2005 * @udev: device to re-activate, not a root hub
2006 * Context: must be able to sleep; device not locked; pm locks held
2008 * This will re-activate the suspended device, increasing power usage
2009 * while letting drivers communicate again with its endpoints.
2010 * USB resume explicitly guarantees that the power session between
2011 * the host and the device is the same as it was when the device
2014 * If @udev->reset_resume is set then this routine won't check that the
2015 * port is still enabled. Furthermore, finish_port_resume() above will
2016 * reset @udev. The end result is that a broken power session can be
2017 * recovered and @udev will appear to persist across a loss of VBUS power.
2019 * For example, if a host controller doesn't maintain VBUS suspend current
2020 * during a system sleep or is reset when the system wakes up, all the USB
2021 * power sessions below it will be broken. This is especially troublesome
2022 * for mass-storage devices containing mounted filesystems, since the
2023 * device will appear to have disconnected and all the memory mappings
2024 * to it will be lost. Using the USB_PERSIST facility, the device can be
2025 * made to appear as if it had not disconnected.
2027 * This facility can be dangerous. Although usb_reset_device() makes
2028 * every effort to insure that the same device is present after the
2029 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2030 * quite possible for a device to remain unaltered but its media to be
2031 * changed. If the user replaces a flash memory card while the system is
2032 * asleep, he will have only himself to blame when the filesystem on the
2033 * new card is corrupted and the system crashes.
2035 * Returns 0 on success, else negative errno.
2037 int usb_port_resume(struct usb_device *udev)
2039 struct usb_hub *hub = hdev_to_hub(udev->parent);
2040 int port1 = udev->portnum;
2042 u16 portchange, portstatus;
2044 /* Skip the initial Clear-Suspend step for a remote wakeup */
2045 status = hub_port_status(hub, port1, &portstatus, &portchange);
2046 if (status == 0 && !(portstatus & USB_PORT_STAT_SUSPEND))
2047 goto SuspendCleared;
2049 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2051 set_bit(port1, hub->busy_bits);
2053 /* see 7.1.7.7; affects power usage, but not budgeting */
2054 status = clear_port_feature(hub->hdev,
2055 port1, USB_PORT_FEAT_SUSPEND);
2057 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
2060 /* drive resume for at least 20 msec */
2061 dev_dbg(&udev->dev, "usb %sresume\n",
2062 udev->auto_pm ? "auto-" : "");
2065 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2066 * stop resume signaling. Then finish the resume
2069 status = hub_port_status(hub, port1, &portstatus, &portchange);
2071 /* TRSMRCY = 10 msec */
2077 if (portchange & USB_PORT_STAT_C_SUSPEND)
2078 clear_port_feature(hub->hdev, port1,
2079 USB_PORT_FEAT_C_SUSPEND);
2082 clear_bit(port1, hub->busy_bits);
2083 if (!hub->hdev->parent && !hub->busy_bits[0])
2084 usb_enable_root_hub_irq(hub->hdev->bus);
2086 status = check_port_resume_type(udev,
2087 hub, port1, status, portchange, portstatus);
2089 status = finish_port_resume(udev);
2091 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2092 hub_port_logical_disconnect(hub, port1);
2097 /* caller has locked udev */
2098 static int remote_wakeup(struct usb_device *udev)
2102 if (udev->state == USB_STATE_SUSPENDED) {
2103 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
2104 usb_mark_last_busy(udev);
2105 status = usb_external_resume_device(udev);
2110 #else /* CONFIG_USB_SUSPEND */
2112 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2114 int usb_port_suspend(struct usb_device *udev)
2119 /* However we may need to do a reset-resume */
2121 int usb_port_resume(struct usb_device *udev)
2123 struct usb_hub *hub = hdev_to_hub(udev->parent);
2124 int port1 = udev->portnum;
2126 u16 portchange, portstatus;
2128 status = hub_port_status(hub, port1, &portstatus, &portchange);
2129 status = check_port_resume_type(udev,
2130 hub, port1, status, portchange, portstatus);
2133 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2134 hub_port_logical_disconnect(hub, port1);
2135 } else if (udev->reset_resume) {
2136 dev_dbg(&udev->dev, "reset-resume\n");
2137 status = usb_reset_device(udev);
2142 static inline int remote_wakeup(struct usb_device *udev)
2149 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
2151 struct usb_hub *hub = usb_get_intfdata (intf);
2152 struct usb_device *hdev = hub->hdev;
2155 /* fail if children aren't already suspended */
2156 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2157 struct usb_device *udev;
2159 udev = hdev->children [port1-1];
2160 if (udev && udev->can_submit) {
2162 dev_dbg(&intf->dev, "port %d nyet suspended\n",
2168 dev_dbg(&intf->dev, "%s\n", __func__);
2170 /* stop khubd and related activity */
2171 hub_quiesce(hub, HUB_SUSPEND);
2175 static int hub_resume(struct usb_interface *intf)
2177 struct usb_hub *hub = usb_get_intfdata(intf);
2179 dev_dbg(&intf->dev, "%s\n", __func__);
2180 hub_activate(hub, HUB_RESUME);
2184 static int hub_reset_resume(struct usb_interface *intf)
2186 struct usb_hub *hub = usb_get_intfdata(intf);
2188 dev_dbg(&intf->dev, "%s\n", __func__);
2189 hub_activate(hub, HUB_RESET_RESUME);
2194 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2195 * @rhdev: struct usb_device for the root hub
2197 * The USB host controller driver calls this function when its root hub
2198 * is resumed and Vbus power has been interrupted or the controller
2199 * has been reset. The routine marks @rhdev as having lost power.
2200 * When the hub driver is resumed it will take notice and carry out
2201 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2202 * the others will be disconnected.
2204 void usb_root_hub_lost_power(struct usb_device *rhdev)
2206 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
2207 rhdev->reset_resume = 1;
2209 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
2211 #else /* CONFIG_PM */
2213 static inline int remote_wakeup(struct usb_device *udev)
2218 #define hub_suspend NULL
2219 #define hub_resume NULL
2220 #define hub_reset_resume NULL
2224 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2226 * Between connect detection and reset signaling there must be a delay
2227 * of 100ms at least for debounce and power-settling. The corresponding
2228 * timer shall restart whenever the downstream port detects a disconnect.
2230 * Apparently there are some bluetooth and irda-dongles and a number of
2231 * low-speed devices for which this debounce period may last over a second.
2232 * Not covered by the spec - but easy to deal with.
2234 * This implementation uses a 1500ms total debounce timeout; if the
2235 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2236 * every 25ms for transient disconnects. When the port status has been
2237 * unchanged for 100ms it returns the port status.
2239 static int hub_port_debounce(struct usb_hub *hub, int port1)
2242 int total_time, stable_time = 0;
2243 u16 portchange, portstatus;
2244 unsigned connection = 0xffff;
2246 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2247 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2251 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2252 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2253 stable_time += HUB_DEBOUNCE_STEP;
2254 if (stable_time >= HUB_DEBOUNCE_STABLE)
2258 connection = portstatus & USB_PORT_STAT_CONNECTION;
2261 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2262 clear_port_feature(hub->hdev, port1,
2263 USB_PORT_FEAT_C_CONNECTION);
2266 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2268 msleep(HUB_DEBOUNCE_STEP);
2271 dev_dbg (hub->intfdev,
2272 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2273 port1, total_time, stable_time, portstatus);
2275 if (stable_time < HUB_DEBOUNCE_STABLE)
2280 void usb_ep0_reinit(struct usb_device *udev)
2282 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
2283 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
2284 usb_enable_endpoint(udev, &udev->ep0);
2286 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
2288 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2289 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2291 static int hub_set_address(struct usb_device *udev, int devnum)
2297 if (udev->state == USB_STATE_ADDRESS)
2299 if (udev->state != USB_STATE_DEFAULT)
2301 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2302 USB_REQ_SET_ADDRESS, 0, devnum, 0,
2303 NULL, 0, USB_CTRL_SET_TIMEOUT);
2305 /* Device now using proper address. */
2306 update_address(udev, devnum);
2307 usb_set_device_state(udev, USB_STATE_ADDRESS);
2308 usb_ep0_reinit(udev);
2313 /* Reset device, (re)assign address, get device descriptor.
2314 * Device connection must be stable, no more debouncing needed.
2315 * Returns device in USB_STATE_ADDRESS, except on error.
2317 * If this is called for an already-existing device (as part of
2318 * usb_reset_device), the caller must own the device lock. For a
2319 * newly detected device that is not accessible through any global
2320 * pointers, it's not necessary to lock the device.
2323 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2326 static DEFINE_MUTEX(usb_address0_mutex);
2328 struct usb_device *hdev = hub->hdev;
2330 unsigned delay = HUB_SHORT_RESET_TIME;
2331 enum usb_device_speed oldspeed = udev->speed;
2333 int devnum = udev->devnum;
2335 /* root hub ports have a slightly longer reset period
2336 * (from USB 2.0 spec, section 7.1.7.5)
2338 if (!hdev->parent) {
2339 delay = HUB_ROOT_RESET_TIME;
2340 if (port1 == hdev->bus->otg_port)
2341 hdev->bus->b_hnp_enable = 0;
2344 /* Some low speed devices have problems with the quick delay, so */
2345 /* be a bit pessimistic with those devices. RHbug #23670 */
2346 if (oldspeed == USB_SPEED_LOW)
2347 delay = HUB_LONG_RESET_TIME;
2349 mutex_lock(&usb_address0_mutex);
2351 /* Reset the device; full speed may morph to high speed */
2352 retval = hub_port_reset(hub, port1, udev, delay);
2353 if (retval < 0) /* error or disconnect */
2355 /* success, speed is known */
2358 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2359 dev_dbg(&udev->dev, "device reset changed speed!\n");
2362 oldspeed = udev->speed;
2364 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2365 * it's fixed size except for full speed devices.
2366 * For Wireless USB devices, ep0 max packet is always 512 (tho
2367 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2369 switch (udev->speed) {
2370 case USB_SPEED_VARIABLE: /* fixed at 512 */
2371 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(512);
2373 case USB_SPEED_HIGH: /* fixed at 64 */
2374 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2376 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2377 /* to determine the ep0 maxpacket size, try to read
2378 * the device descriptor to get bMaxPacketSize0 and
2379 * then correct our initial guess.
2381 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2383 case USB_SPEED_LOW: /* fixed at 8 */
2384 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2391 switch (udev->speed) {
2392 case USB_SPEED_LOW: speed = "low"; break;
2393 case USB_SPEED_FULL: speed = "full"; break;
2394 case USB_SPEED_HIGH: speed = "high"; break;
2395 case USB_SPEED_VARIABLE:
2399 default: speed = "?"; break;
2401 dev_info (&udev->dev,
2402 "%s %s speed %sUSB device using %s and address %d\n",
2403 (udev->config) ? "reset" : "new", speed, type,
2404 udev->bus->controller->driver->name, devnum);
2406 /* Set up TT records, if needed */
2408 udev->tt = hdev->tt;
2409 udev->ttport = hdev->ttport;
2410 } else if (udev->speed != USB_SPEED_HIGH
2411 && hdev->speed == USB_SPEED_HIGH) {
2412 udev->tt = &hub->tt;
2413 udev->ttport = port1;
2416 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2417 * Because device hardware and firmware is sometimes buggy in
2418 * this area, and this is how Linux has done it for ages.
2419 * Change it cautiously.
2421 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2422 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2423 * so it may help with some non-standards-compliant devices.
2424 * Otherwise we start with SET_ADDRESS and then try to read the
2425 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2428 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2429 if (USE_NEW_SCHEME(retry_counter)) {
2430 struct usb_device_descriptor *buf;
2433 #define GET_DESCRIPTOR_BUFSIZE 64
2434 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2440 /* Retry on all errors; some devices are flakey.
2441 * 255 is for WUSB devices, we actually need to use
2442 * 512 (WUSB1.0[4.8.1]).
2444 for (j = 0; j < 3; ++j) {
2445 buf->bMaxPacketSize0 = 0;
2446 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2447 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2448 USB_DT_DEVICE << 8, 0,
2449 buf, GET_DESCRIPTOR_BUFSIZE,
2450 USB_CTRL_GET_TIMEOUT);
2451 switch (buf->bMaxPacketSize0) {
2452 case 8: case 16: case 32: case 64: case 255:
2453 if (buf->bDescriptorType ==
2467 udev->descriptor.bMaxPacketSize0 =
2468 buf->bMaxPacketSize0;
2471 retval = hub_port_reset(hub, port1, udev, delay);
2472 if (retval < 0) /* error or disconnect */
2474 if (oldspeed != udev->speed) {
2476 "device reset changed speed!\n");
2481 dev_err(&udev->dev, "device descriptor "
2482 "read/%s, error %d\n",
2487 #undef GET_DESCRIPTOR_BUFSIZE
2491 * If device is WUSB, we already assigned an
2492 * unauthorized address in the Connect Ack sequence;
2493 * authorization will assign the final address.
2495 if (udev->wusb == 0) {
2496 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2497 retval = hub_set_address(udev, devnum);
2504 "device not accepting address %d, error %d\n",
2509 /* cope with hardware quirkiness:
2510 * - let SET_ADDRESS settle, some device hardware wants it
2511 * - read ep0 maxpacket even for high and low speed,
2514 if (USE_NEW_SCHEME(retry_counter))
2518 retval = usb_get_device_descriptor(udev, 8);
2520 dev_err(&udev->dev, "device descriptor "
2521 "read/%s, error %d\n",
2533 i = udev->descriptor.bMaxPacketSize0 == 0xff? /* wusb device? */
2534 512 : udev->descriptor.bMaxPacketSize0;
2535 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2536 if (udev->speed != USB_SPEED_FULL ||
2537 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2538 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2542 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2543 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2544 usb_ep0_reinit(udev);
2547 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2548 if (retval < (signed)sizeof(udev->descriptor)) {
2549 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2560 hub_port_disable(hub, port1, 0);
2561 update_address(udev, devnum); /* for disconnect processing */
2563 mutex_unlock(&usb_address0_mutex);
2568 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2570 struct usb_qualifier_descriptor *qual;
2573 qual = kmalloc (sizeof *qual, GFP_KERNEL);
2577 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2578 qual, sizeof *qual);
2579 if (status == sizeof *qual) {
2580 dev_info(&udev->dev, "not running at top speed; "
2581 "connect to a high speed hub\n");
2582 /* hub LEDs are probably harder to miss than syslog */
2583 if (hub->has_indicators) {
2584 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2585 schedule_delayed_work (&hub->leds, 0);
2592 hub_power_remaining (struct usb_hub *hub)
2594 struct usb_device *hdev = hub->hdev;
2598 if (!hub->limited_power)
2601 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2602 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2603 struct usb_device *udev = hdev->children[port1 - 1];
2609 /* Unconfigured devices may not use more than 100mA,
2610 * or 8mA for OTG ports */
2611 if (udev->actconfig)
2612 delta = udev->actconfig->desc.bMaxPower * 2;
2613 else if (port1 != udev->bus->otg_port || hdev->parent)
2617 if (delta > hub->mA_per_port)
2618 dev_warn(&udev->dev, "%dmA is over %umA budget "
2620 delta, hub->mA_per_port, port1);
2623 if (remaining < 0) {
2624 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2631 /* Handle physical or logical connection change events.
2632 * This routine is called when:
2633 * a port connection-change occurs;
2634 * a port enable-change occurs (often caused by EMI);
2635 * usb_reset_device() encounters changed descriptors (as from
2636 * a firmware download)
2637 * caller already locked the hub
2639 static void hub_port_connect_change(struct usb_hub *hub, int port1,
2640 u16 portstatus, u16 portchange)
2642 struct usb_device *hdev = hub->hdev;
2643 struct device *hub_dev = hub->intfdev;
2644 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
2645 unsigned wHubCharacteristics =
2646 le16_to_cpu(hub->descriptor->wHubCharacteristics);
2647 struct usb_device *udev;
2651 "port %d, status %04x, change %04x, %s\n",
2652 port1, portstatus, portchange, portspeed (portstatus));
2654 if (hub->has_indicators) {
2655 set_port_led(hub, port1, HUB_LED_AUTO);
2656 hub->indicator[port1-1] = INDICATOR_AUTO;
2659 #ifdef CONFIG_USB_OTG
2660 /* during HNP, don't repeat the debounce */
2661 if (hdev->bus->is_b_host)
2662 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
2663 USB_PORT_STAT_C_ENABLE);
2666 /* Try to use the debounce delay for protection against
2667 * port-enable changes caused, for example, by EMI.
2669 if (portchange & (USB_PORT_STAT_C_CONNECTION |
2670 USB_PORT_STAT_C_ENABLE)) {
2671 status = hub_port_debounce(hub, port1);
2673 if (printk_ratelimit())
2674 dev_err (hub_dev, "connect-debounce failed, "
2675 "port %d disabled\n", port1);
2676 portstatus &= ~USB_PORT_STAT_CONNECTION;
2678 portstatus = status;
2682 /* Try to resuscitate an existing device */
2683 udev = hdev->children[port1-1];
2684 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
2685 udev->state != USB_STATE_NOTATTACHED) {
2687 usb_lock_device(udev);
2688 if (portstatus & USB_PORT_STAT_ENABLE) {
2689 status = 0; /* Nothing to do */
2690 } else if (!udev->persist_enabled) {
2691 status = -ENODEV; /* Mustn't resuscitate */
2693 #ifdef CONFIG_USB_SUSPEND
2694 } else if (udev->state == USB_STATE_SUSPENDED) {
2695 /* For a suspended device, treat this as a
2696 * remote wakeup event.
2698 if (udev->do_remote_wakeup)
2699 status = remote_wakeup(udev);
2701 /* Otherwise leave it be; devices can't tell the
2702 * difference between suspended and disabled.
2709 status = usb_reset_composite_device(udev, NULL);
2711 usb_unlock_device(udev);
2714 clear_bit(port1, hub->change_bits);
2719 /* Disconnect any existing devices under this port */
2721 usb_disconnect(&hdev->children[port1-1]);
2722 clear_bit(port1, hub->change_bits);
2724 /* Return now if debouncing failed or nothing is connected */
2725 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2727 /* maybe switch power back on (e.g. root hub was reset) */
2728 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
2729 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2730 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2732 if (portstatus & USB_PORT_STAT_ENABLE)
2737 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2739 /* reallocate for each attempt, since references
2740 * to the previous one can escape in various ways
2742 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2745 "couldn't allocate port %d usb_device\n",
2750 usb_set_device_state(udev, USB_STATE_POWERED);
2751 udev->speed = USB_SPEED_UNKNOWN;
2752 udev->bus_mA = hub->mA_per_port;
2753 udev->level = hdev->level + 1;
2754 udev->wusb = hub_is_wusb(hub);
2756 /* set the address */
2757 choose_address(udev);
2758 if (udev->devnum <= 0) {
2759 status = -ENOTCONN; /* Don't retry */
2763 /* reset and get descriptor */
2764 status = hub_port_init(hub, udev, port1, i);
2768 /* consecutive bus-powered hubs aren't reliable; they can
2769 * violate the voltage drop budget. if the new child has
2770 * a "powered" LED, users should notice we didn't enable it
2771 * (without reading syslog), even without per-port LEDs
2774 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
2775 && udev->bus_mA <= 100) {
2778 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2781 dev_dbg(&udev->dev, "get status %d ?\n", status);
2784 le16_to_cpus(&devstat);
2785 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2787 "can't connect bus-powered hub "
2789 if (hub->has_indicators) {
2790 hub->indicator[port1-1] =
2791 INDICATOR_AMBER_BLINK;
2792 schedule_delayed_work (&hub->leds, 0);
2794 status = -ENOTCONN; /* Don't retry */
2799 /* check for devices running slower than they could */
2800 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2801 && udev->speed == USB_SPEED_FULL
2802 && highspeed_hubs != 0)
2803 check_highspeed (hub, udev, port1);
2805 /* Store the parent's children[] pointer. At this point
2806 * udev becomes globally accessible, although presumably
2807 * no one will look at it until hdev is unlocked.
2811 /* We mustn't add new devices if the parent hub has
2812 * been disconnected; we would race with the
2813 * recursively_mark_NOTATTACHED() routine.
2815 spin_lock_irq(&device_state_lock);
2816 if (hdev->state == USB_STATE_NOTATTACHED)
2819 hdev->children[port1-1] = udev;
2820 spin_unlock_irq(&device_state_lock);
2822 /* Run it through the hoops (find a driver, etc) */
2824 status = usb_new_device(udev);
2826 spin_lock_irq(&device_state_lock);
2827 hdev->children[port1-1] = NULL;
2828 spin_unlock_irq(&device_state_lock);
2835 status = hub_power_remaining(hub);
2837 dev_dbg(hub_dev, "%dmA power budget left\n", status);
2842 hub_port_disable(hub, port1, 1);
2844 usb_ep0_reinit(udev);
2845 release_address(udev);
2847 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
2850 if (hub->hdev->parent ||
2851 !hcd->driver->port_handed_over ||
2852 !(hcd->driver->port_handed_over)(hcd, port1))
2853 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
2857 hub_port_disable(hub, port1, 1);
2858 if (hcd->driver->relinquish_port && !hub->hdev->parent)
2859 hcd->driver->relinquish_port(hcd, port1);
2862 static void hub_events(void)
2864 struct list_head *tmp;
2865 struct usb_device *hdev;
2866 struct usb_interface *intf;
2867 struct usb_hub *hub;
2868 struct device *hub_dev;
2877 * We restart the list every time to avoid a deadlock with
2878 * deleting hubs downstream from this one. This should be
2879 * safe since we delete the hub from the event list.
2880 * Not the most efficient, but avoids deadlocks.
2884 /* Grab the first entry at the beginning of the list */
2885 spin_lock_irq(&hub_event_lock);
2886 if (list_empty(&hub_event_list)) {
2887 spin_unlock_irq(&hub_event_lock);
2891 tmp = hub_event_list.next;
2894 hub = list_entry(tmp, struct usb_hub, event_list);
2895 kref_get(&hub->kref);
2896 spin_unlock_irq(&hub_event_lock);
2899 hub_dev = hub->intfdev;
2900 intf = to_usb_interface(hub_dev);
2901 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
2902 hdev->state, hub->descriptor
2903 ? hub->descriptor->bNbrPorts
2905 /* NOTE: expects max 15 ports... */
2906 (u16) hub->change_bits[0],
2907 (u16) hub->event_bits[0]);
2909 /* Lock the device, then check to see if we were
2910 * disconnected while waiting for the lock to succeed. */
2911 usb_lock_device(hdev);
2912 if (unlikely(hub->disconnected))
2915 /* If the hub has died, clean up after it */
2916 if (hdev->state == USB_STATE_NOTATTACHED) {
2917 hub->error = -ENODEV;
2918 hub_quiesce(hub, HUB_DISCONNECT);
2923 ret = usb_autopm_get_interface(intf);
2925 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
2929 /* If this is an inactive hub, do nothing */
2934 dev_dbg (hub_dev, "resetting for error %d\n",
2937 ret = usb_reset_composite_device(hdev, intf);
2940 "error resetting hub: %d\n", ret);
2948 /* deal with port status changes */
2949 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2950 if (test_bit(i, hub->busy_bits))
2952 connect_change = test_bit(i, hub->change_bits);
2953 if (!test_and_clear_bit(i, hub->event_bits) &&
2957 ret = hub_port_status(hub, i,
2958 &portstatus, &portchange);
2962 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2963 clear_port_feature(hdev, i,
2964 USB_PORT_FEAT_C_CONNECTION);
2968 if (portchange & USB_PORT_STAT_C_ENABLE) {
2969 if (!connect_change)
2971 "port %d enable change, "
2974 clear_port_feature(hdev, i,
2975 USB_PORT_FEAT_C_ENABLE);
2978 * EM interference sometimes causes badly
2979 * shielded USB devices to be shutdown by
2980 * the hub, this hack enables them again.
2981 * Works at least with mouse driver.
2983 if (!(portstatus & USB_PORT_STAT_ENABLE)
2985 && hdev->children[i-1]) {
2988 "disabled by hub (EMI?), "
2995 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2996 struct usb_device *udev;
2998 clear_port_feature(hdev, i,
2999 USB_PORT_FEAT_C_SUSPEND);
3000 udev = hdev->children[i-1];
3002 usb_lock_device(udev);
3003 ret = remote_wakeup(hdev->
3005 usb_unlock_device(udev);
3010 hub_port_disable(hub, i, 1);
3013 "resume on port %d, status %d\n",
3017 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
3019 "over-current change on port %d\n",
3021 clear_port_feature(hdev, i,
3022 USB_PORT_FEAT_C_OVER_CURRENT);
3026 if (portchange & USB_PORT_STAT_C_RESET) {
3028 "reset change on port %d\n",
3030 clear_port_feature(hdev, i,
3031 USB_PORT_FEAT_C_RESET);
3035 hub_port_connect_change(hub, i,
3036 portstatus, portchange);
3039 /* deal with hub status changes */
3040 if (test_and_clear_bit(0, hub->event_bits) == 0)
3042 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
3043 dev_err (hub_dev, "get_hub_status failed\n");
3045 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
3046 dev_dbg (hub_dev, "power change\n");
3047 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
3048 if (hubstatus & HUB_STATUS_LOCAL_POWER)
3049 /* FIXME: Is this always true? */
3050 hub->limited_power = 1;
3052 hub->limited_power = 0;
3054 if (hubchange & HUB_CHANGE_OVERCURRENT) {
3055 dev_dbg (hub_dev, "overcurrent change\n");
3056 msleep(500); /* Cool down */
3057 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
3062 /* If this is a root hub, tell the HCD it's okay to
3063 * re-enable port-change interrupts now. */
3064 if (!hdev->parent && !hub->busy_bits[0])
3065 usb_enable_root_hub_irq(hdev->bus);
3068 /* Allow autosuspend if we're not going to run again */
3069 if (list_empty(&hub->event_list))
3070 usb_autopm_enable(intf);
3072 usb_unlock_device(hdev);
3073 kref_put(&hub->kref, hub_release);
3075 } /* end while (1) */
3078 static int hub_thread(void *__unused)
3080 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3081 * port handover. Otherwise it might see that a full-speed device
3082 * was gone before the EHCI controller had handed its port over to
3083 * the companion full-speed controller.
3089 wait_event_freezable(khubd_wait,
3090 !list_empty(&hub_event_list) ||
3091 kthread_should_stop());
3092 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
3094 pr_debug("%s: khubd exiting\n", usbcore_name);
3098 static struct usb_device_id hub_id_table [] = {
3099 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
3100 .bDeviceClass = USB_CLASS_HUB},
3101 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
3102 .bInterfaceClass = USB_CLASS_HUB},
3103 { } /* Terminating entry */
3106 MODULE_DEVICE_TABLE (usb, hub_id_table);
3108 static struct usb_driver hub_driver = {
3111 .disconnect = hub_disconnect,
3112 .suspend = hub_suspend,
3113 .resume = hub_resume,
3114 .reset_resume = hub_reset_resume,
3115 .pre_reset = hub_pre_reset,
3116 .post_reset = hub_post_reset,
3118 .id_table = hub_id_table,
3119 .supports_autosuspend = 1,
3122 int usb_hub_init(void)
3124 if (usb_register(&hub_driver) < 0) {
3125 printk(KERN_ERR "%s: can't register hub driver\n",
3130 khubd_task = kthread_run(hub_thread, NULL, "khubd");
3131 if (!IS_ERR(khubd_task))
3134 /* Fall through if kernel_thread failed */
3135 usb_deregister(&hub_driver);
3136 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
3141 void usb_hub_cleanup(void)
3143 kthread_stop(khubd_task);
3146 * Hub resources are freed for us by usb_deregister. It calls
3147 * usb_driver_purge on every device which in turn calls that
3148 * devices disconnect function if it is using this driver.
3149 * The hub_disconnect function takes care of releasing the
3150 * individual hub resources. -greg
3152 usb_deregister(&hub_driver);
3153 } /* usb_hub_cleanup() */
3155 static int descriptors_changed(struct usb_device *udev,
3156 struct usb_device_descriptor *old_device_descriptor)
3160 unsigned serial_len = 0;
3162 unsigned old_length;
3166 if (memcmp(&udev->descriptor, old_device_descriptor,
3167 sizeof(*old_device_descriptor)) != 0)
3170 /* Since the idVendor, idProduct, and bcdDevice values in the
3171 * device descriptor haven't changed, we will assume the
3172 * Manufacturer and Product strings haven't changed either.
3173 * But the SerialNumber string could be different (e.g., a
3174 * different flash card of the same brand).
3177 serial_len = strlen(udev->serial) + 1;
3180 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3181 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3182 len = max(len, old_length);
3185 buf = kmalloc(len, GFP_NOIO);
3187 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
3188 /* assume the worst */
3191 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3192 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3193 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
3195 if (length != old_length) {
3196 dev_dbg(&udev->dev, "config index %d, error %d\n",
3201 if (memcmp (buf, udev->rawdescriptors[index], old_length)
3203 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
3205 ((struct usb_config_descriptor *) buf)->
3206 bConfigurationValue);
3212 if (!changed && serial_len) {
3213 length = usb_string(udev, udev->descriptor.iSerialNumber,
3215 if (length + 1 != serial_len) {
3216 dev_dbg(&udev->dev, "serial string error %d\n",
3219 } else if (memcmp(buf, udev->serial, length) != 0) {
3220 dev_dbg(&udev->dev, "serial string changed\n");
3230 * usb_reset_device - perform a USB port reset to reinitialize a device
3231 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3233 * WARNING - don't use this routine to reset a composite device
3234 * (one with multiple interfaces owned by separate drivers)!
3235 * Use usb_reset_composite_device() instead.
3237 * Do a port reset, reassign the device's address, and establish its
3238 * former operating configuration. If the reset fails, or the device's
3239 * descriptors change from their values before the reset, or the original
3240 * configuration and altsettings cannot be restored, a flag will be set
3241 * telling khubd to pretend the device has been disconnected and then
3242 * re-connected. All drivers will be unbound, and the device will be
3243 * re-enumerated and probed all over again.
3245 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3246 * flagged for logical disconnection, or some other negative error code
3247 * if the reset wasn't even attempted.
3249 * The caller must own the device lock. For example, it's safe to use
3250 * this from a driver probe() routine after downloading new firmware.
3251 * For calls that might not occur during probe(), drivers should lock
3252 * the device using usb_lock_device_for_reset().
3254 * Locking exception: This routine may also be called from within an
3255 * autoresume handler. Such usage won't conflict with other tasks
3256 * holding the device lock because these tasks should always call
3257 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
3259 int usb_reset_device(struct usb_device *udev)
3261 struct usb_device *parent_hdev = udev->parent;
3262 struct usb_hub *parent_hub;
3263 struct usb_device_descriptor descriptor = udev->descriptor;
3265 int port1 = udev->portnum;
3267 if (udev->state == USB_STATE_NOTATTACHED ||
3268 udev->state == USB_STATE_SUSPENDED) {
3269 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3275 /* this requires hcd-specific logic; see OHCI hc_restart() */
3276 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
3279 parent_hub = hdev_to_hub(parent_hdev);
3281 set_bit(port1, parent_hub->busy_bits);
3282 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3284 /* ep0 maxpacket size may change; let the HCD know about it.
3285 * Other endpoints will be handled by re-enumeration. */
3286 usb_ep0_reinit(udev);
3287 ret = hub_port_init(parent_hub, udev, port1, i);
3288 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
3291 clear_bit(port1, parent_hub->busy_bits);
3292 if (!parent_hdev->parent && !parent_hub->busy_bits[0])
3293 usb_enable_root_hub_irq(parent_hdev->bus);
3298 /* Device might have changed firmware (DFU or similar) */
3299 if (descriptors_changed(udev, &descriptor)) {
3300 dev_info(&udev->dev, "device firmware changed\n");
3301 udev->descriptor = descriptor; /* for disconnect() calls */
3305 if (!udev->actconfig)
3308 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3309 USB_REQ_SET_CONFIGURATION, 0,
3310 udev->actconfig->desc.bConfigurationValue, 0,
3311 NULL, 0, USB_CTRL_SET_TIMEOUT);
3314 "can't restore configuration #%d (error=%d)\n",
3315 udev->actconfig->desc.bConfigurationValue, ret);
3318 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3320 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3321 struct usb_interface *intf = udev->actconfig->interface[i];
3322 struct usb_interface_descriptor *desc;
3324 /* set_interface resets host side toggle even
3325 * for altsetting zero. the interface may have no driver.
3327 desc = &intf->cur_altsetting->desc;
3328 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3329 desc->bAlternateSetting);
3331 dev_err(&udev->dev, "failed to restore interface %d "
3332 "altsetting %d (error=%d)\n",
3333 desc->bInterfaceNumber,
3334 desc->bAlternateSetting,
3344 hub_port_logical_disconnect(parent_hub, port1);
3347 EXPORT_SYMBOL_GPL(usb_reset_device);
3350 * usb_reset_composite_device - warn interface drivers and perform a USB port reset
3351 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3352 * @iface: interface bound to the driver making the request (optional)
3354 * Warns all drivers bound to registered interfaces (using their pre_reset
3355 * method), performs the port reset, and then lets the drivers know that
3356 * the reset is over (using their post_reset method).
3358 * Return value is the same as for usb_reset_device().
3360 * The caller must own the device lock. For example, it's safe to use
3361 * this from a driver probe() routine after downloading new firmware.
3362 * For calls that might not occur during probe(), drivers should lock
3363 * the device using usb_lock_device_for_reset().
3365 int usb_reset_composite_device(struct usb_device *udev,
3366 struct usb_interface *iface)
3370 struct usb_host_config *config = udev->actconfig;
3372 if (udev->state == USB_STATE_NOTATTACHED ||
3373 udev->state == USB_STATE_SUSPENDED) {
3374 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3379 /* Prevent autosuspend during the reset */
3380 usb_autoresume_device(udev);
3382 if (iface && iface->condition != USB_INTERFACE_BINDING)
3386 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
3387 struct usb_interface *cintf = config->interface[i];
3388 struct usb_driver *drv;
3390 if (cintf->dev.driver) {
3391 drv = to_usb_driver(cintf->dev.driver);
3393 (drv->pre_reset)(cintf);
3394 /* FIXME: Unbind if pre_reset returns an error or isn't defined */
3399 ret = usb_reset_device(udev);
3402 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
3403 struct usb_interface *cintf = config->interface[i];
3404 struct usb_driver *drv;
3406 if (cintf->dev.driver) {
3407 drv = to_usb_driver(cintf->dev.driver);
3408 if (drv->post_reset)
3409 (drv->post_reset)(cintf);
3410 /* FIXME: Unbind if post_reset returns an error or isn't defined */
3415 usb_autosuspend_device(udev);
3418 EXPORT_SYMBOL_GPL(usb_reset_composite_device);