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/config.h>
12 #ifdef CONFIG_USB_DEBUG
17 #include <linux/kernel.h>
18 #include <linux/errno.h>
19 #include <linux/module.h>
20 #include <linux/moduleparam.h>
21 #include <linux/completion.h>
22 #include <linux/sched.h>
23 #include <linux/list.h>
24 #include <linux/slab.h>
25 #include <linux/smp_lock.h>
26 #include <linux/ioctl.h>
27 #include <linux/usb.h>
28 #include <linux/usbdevice_fs.h>
29 #include <linux/kthread.h>
31 #include <asm/semaphore.h>
32 #include <asm/uaccess.h>
33 #include <asm/byteorder.h>
39 /* Protect struct usb_device->state and ->children members
40 * Note: Both are also protected by ->serialize, except that ->state can
41 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
42 static DEFINE_SPINLOCK(device_state_lock);
44 /* khubd's worklist and its lock */
45 static DEFINE_SPINLOCK(hub_event_lock);
46 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
49 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
51 static struct task_struct *khubd_task;
53 /* cycle leds on hubs that aren't blinking for attention */
54 static int blinkenlights = 0;
55 module_param (blinkenlights, bool, S_IRUGO);
56 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
59 * As of 2.6.10 we introduce a new USB device initialization scheme which
60 * closely resembles the way Windows works. Hopefully it will be compatible
61 * with a wider range of devices than the old scheme. However some previously
62 * working devices may start giving rise to "device not accepting address"
63 * errors; if that happens the user can try the old scheme by adjusting the
64 * following module parameters.
66 * For maximum flexibility there are two boolean parameters to control the
67 * hub driver's behavior. On the first initialization attempt, if the
68 * "old_scheme_first" parameter is set then the old scheme will be used,
69 * otherwise the new scheme is used. If that fails and "use_both_schemes"
70 * is set, then the driver will make another attempt, using the other scheme.
72 static int old_scheme_first = 0;
73 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
74 MODULE_PARM_DESC(old_scheme_first,
75 "start with the old device initialization scheme");
77 static int use_both_schemes = 1;
78 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
79 MODULE_PARM_DESC(use_both_schemes,
80 "try the other device initialization scheme if the "
85 static inline char *portspeed (int portstatus)
87 if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
89 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
96 /* Note that hdev or one of its children must be locked! */
97 static inline struct usb_hub *hdev_to_hub(struct usb_device *hdev)
99 return usb_get_intfdata(hdev->actconfig->interface[0]);
102 /* USB 2.0 spec Section 11.24.4.5 */
103 static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
107 for (i = 0; i < 3; i++) {
108 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
109 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
110 USB_DT_HUB << 8, 0, data, size,
111 USB_CTRL_GET_TIMEOUT);
112 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
119 * USB 2.0 spec Section 11.24.2.1
121 static int clear_hub_feature(struct usb_device *hdev, int feature)
123 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
124 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
128 * USB 2.0 spec Section 11.24.2.2
130 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
132 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
133 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
138 * USB 2.0 spec Section 11.24.2.13
140 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
142 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
143 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
148 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
149 * for info about using port indicators
151 static void set_port_led(
157 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
158 USB_PORT_FEAT_INDICATOR);
160 dev_dbg (hub->intfdev,
161 "port %d indicator %s status %d\n",
163 ({ char *s; switch (selector) {
164 case HUB_LED_AMBER: s = "amber"; break;
165 case HUB_LED_GREEN: s = "green"; break;
166 case HUB_LED_OFF: s = "off"; break;
167 case HUB_LED_AUTO: s = "auto"; break;
168 default: s = "??"; break;
173 #define LED_CYCLE_PERIOD ((2*HZ)/3)
175 static void led_work (void *__hub)
177 struct usb_hub *hub = __hub;
178 struct usb_device *hdev = hub->hdev;
180 unsigned changed = 0;
183 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
186 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
187 unsigned selector, mode;
189 /* 30%-50% duty cycle */
191 switch (hub->indicator[i]) {
193 case INDICATOR_CYCLE:
195 selector = HUB_LED_AUTO;
196 mode = INDICATOR_AUTO;
198 /* blinking green = sw attention */
199 case INDICATOR_GREEN_BLINK:
200 selector = HUB_LED_GREEN;
201 mode = INDICATOR_GREEN_BLINK_OFF;
203 case INDICATOR_GREEN_BLINK_OFF:
204 selector = HUB_LED_OFF;
205 mode = INDICATOR_GREEN_BLINK;
207 /* blinking amber = hw attention */
208 case INDICATOR_AMBER_BLINK:
209 selector = HUB_LED_AMBER;
210 mode = INDICATOR_AMBER_BLINK_OFF;
212 case INDICATOR_AMBER_BLINK_OFF:
213 selector = HUB_LED_OFF;
214 mode = INDICATOR_AMBER_BLINK;
216 /* blink green/amber = reserved */
217 case INDICATOR_ALT_BLINK:
218 selector = HUB_LED_GREEN;
219 mode = INDICATOR_ALT_BLINK_OFF;
221 case INDICATOR_ALT_BLINK_OFF:
222 selector = HUB_LED_AMBER;
223 mode = INDICATOR_ALT_BLINK;
228 if (selector != HUB_LED_AUTO)
230 set_port_led(hub, i + 1, selector);
231 hub->indicator[i] = mode;
233 if (!changed && blinkenlights) {
235 cursor %= hub->descriptor->bNbrPorts;
236 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
237 hub->indicator[cursor] = INDICATOR_CYCLE;
241 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
244 /* use a short timeout for hub/port status fetches */
245 #define USB_STS_TIMEOUT 1000
246 #define USB_STS_RETRIES 5
249 * USB 2.0 spec Section 11.24.2.6
251 static int get_hub_status(struct usb_device *hdev,
252 struct usb_hub_status *data)
254 int i, status = -ETIMEDOUT;
256 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
257 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
258 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
259 data, sizeof(*data), USB_STS_TIMEOUT);
265 * USB 2.0 spec Section 11.24.2.7
267 static int get_port_status(struct usb_device *hdev, int port1,
268 struct usb_port_status *data)
270 int i, status = -ETIMEDOUT;
272 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
273 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
274 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
275 data, sizeof(*data), USB_STS_TIMEOUT);
280 static void kick_khubd(struct usb_hub *hub)
284 spin_lock_irqsave(&hub_event_lock, flags);
285 if (list_empty(&hub->event_list)) {
286 list_add_tail(&hub->event_list, &hub_event_list);
287 wake_up(&khubd_wait);
289 spin_unlock_irqrestore(&hub_event_lock, flags);
292 void usb_kick_khubd(struct usb_device *hdev)
294 kick_khubd(hdev_to_hub(hdev));
298 /* completion function, fires on port status changes and various faults */
299 static void hub_irq(struct urb *urb, struct pt_regs *regs)
301 struct usb_hub *hub = (struct usb_hub *)urb->context;
306 switch (urb->status) {
307 case -ENOENT: /* synchronous unlink */
308 case -ECONNRESET: /* async unlink */
309 case -ESHUTDOWN: /* hardware going away */
312 default: /* presumably an error */
313 /* Cause a hub reset after 10 consecutive errors */
314 dev_dbg (hub->intfdev, "transfer --> %d\n", urb->status);
315 if ((++hub->nerrors < 10) || hub->error)
317 hub->error = urb->status;
320 /* let khubd handle things */
321 case 0: /* we got data: port status changed */
323 for (i = 0; i < urb->actual_length; ++i)
324 bits |= ((unsigned long) ((*hub->buffer)[i]))
326 hub->event_bits[0] = bits;
332 /* Something happened, let khubd figure it out */
339 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
340 && status != -ENODEV && status != -EPERM)
341 dev_err (hub->intfdev, "resubmit --> %d\n", status);
344 /* USB 2.0 spec Section 11.24.2.3 */
346 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
348 return usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
349 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
354 * enumeration blocks khubd for a long time. we use keventd instead, since
355 * long blocking there is the exception, not the rule. accordingly, HCDs
356 * talking to TTs must queue control transfers (not just bulk and iso), so
357 * both can talk to the same hub concurrently.
359 static void hub_tt_kevent (void *arg)
361 struct usb_hub *hub = arg;
364 spin_lock_irqsave (&hub->tt.lock, flags);
365 while (!list_empty (&hub->tt.clear_list)) {
366 struct list_head *temp;
367 struct usb_tt_clear *clear;
368 struct usb_device *hdev = hub->hdev;
371 temp = hub->tt.clear_list.next;
372 clear = list_entry (temp, struct usb_tt_clear, clear_list);
373 list_del (&clear->clear_list);
375 /* drop lock so HCD can concurrently report other TT errors */
376 spin_unlock_irqrestore (&hub->tt.lock, flags);
377 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
378 spin_lock_irqsave (&hub->tt.lock, flags);
382 "clear tt %d (%04x) error %d\n",
383 clear->tt, clear->devinfo, status);
386 spin_unlock_irqrestore (&hub->tt.lock, flags);
390 * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
391 * @udev: the device whose split transaction failed
392 * @pipe: identifies the endpoint of the failed transaction
394 * High speed HCDs use this to tell the hub driver that some split control or
395 * bulk transaction failed in a way that requires clearing internal state of
396 * a transaction translator. This is normally detected (and reported) from
399 * It may not be possible for that hub to handle additional full (or low)
400 * speed transactions until that state is fully cleared out.
402 void usb_hub_tt_clear_buffer (struct usb_device *udev, int pipe)
404 struct usb_tt *tt = udev->tt;
406 struct usb_tt_clear *clear;
408 /* we've got to cope with an arbitrary number of pending TT clears,
409 * since each TT has "at least two" buffers that can need it (and
410 * there can be many TTs per hub). even if they're uncommon.
412 if ((clear = kmalloc (sizeof *clear, SLAB_ATOMIC)) == NULL) {
413 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
414 /* FIXME recover somehow ... RESET_TT? */
418 /* info that CLEAR_TT_BUFFER needs */
419 clear->tt = tt->multi ? udev->ttport : 1;
420 clear->devinfo = usb_pipeendpoint (pipe);
421 clear->devinfo |= udev->devnum << 4;
422 clear->devinfo |= usb_pipecontrol (pipe)
423 ? (USB_ENDPOINT_XFER_CONTROL << 11)
424 : (USB_ENDPOINT_XFER_BULK << 11);
425 if (usb_pipein (pipe))
426 clear->devinfo |= 1 << 15;
428 /* tell keventd to clear state for this TT */
429 spin_lock_irqsave (&tt->lock, flags);
430 list_add_tail (&clear->clear_list, &tt->clear_list);
431 schedule_work (&tt->kevent);
432 spin_unlock_irqrestore (&tt->lock, flags);
435 static void hub_power_on(struct usb_hub *hub)
438 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
440 /* if hub supports power switching, enable power on each port */
441 if ((hub->descriptor->wHubCharacteristics & HUB_CHAR_LPSM) < 2) {
442 dev_dbg(hub->intfdev, "enabling power on all ports\n");
443 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
444 set_port_feature(hub->hdev, port1,
445 USB_PORT_FEAT_POWER);
448 /* Wait at least 100 msec for power to become stable */
449 msleep(max(pgood_delay, (unsigned) 100));
452 static void hub_quiesce(struct usb_hub *hub)
454 /* stop khubd and related activity */
457 usb_kill_urb(hub->urb);
458 if (hub->has_indicators)
459 cancel_delayed_work(&hub->leds);
460 if (hub->has_indicators || hub->tt.hub)
461 flush_scheduled_work();
464 static void hub_activate(struct usb_hub *hub)
470 status = usb_submit_urb(hub->urb, GFP_NOIO);
472 dev_err(hub->intfdev, "activate --> %d\n", status);
473 if (hub->has_indicators && blinkenlights)
474 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
476 /* scan all ports ASAP */
480 static int hub_hub_status(struct usb_hub *hub,
481 u16 *status, u16 *change)
485 ret = get_hub_status(hub->hdev, &hub->status->hub);
487 dev_err (hub->intfdev,
488 "%s failed (err = %d)\n", __FUNCTION__, ret);
490 *status = le16_to_cpu(hub->status->hub.wHubStatus);
491 *change = le16_to_cpu(hub->status->hub.wHubChange);
497 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
499 struct usb_device *hdev = hub->hdev;
502 if (hdev->children[port1-1] && set_state) {
503 usb_set_device_state(hdev->children[port1-1],
504 USB_STATE_NOTATTACHED);
506 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
508 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
514 static int hub_configure(struct usb_hub *hub,
515 struct usb_endpoint_descriptor *endpoint)
517 struct usb_device *hdev = hub->hdev;
518 struct device *hub_dev = hub->intfdev;
519 u16 hubstatus, hubchange;
524 hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
527 message = "can't allocate hub irq buffer";
532 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
534 message = "can't kmalloc hub status buffer";
539 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
540 if (!hub->descriptor) {
541 message = "can't kmalloc hub descriptor";
546 /* Request the entire hub descriptor.
547 * hub->descriptor can handle USB_MAXCHILDREN ports,
548 * but the hub can/will return fewer bytes here.
550 ret = get_hub_descriptor(hdev, hub->descriptor,
551 sizeof(*hub->descriptor));
553 message = "can't read hub descriptor";
555 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
556 message = "hub has too many ports!";
561 hdev->maxchild = hub->descriptor->bNbrPorts;
562 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
563 (hdev->maxchild == 1) ? "" : "s");
565 le16_to_cpus(&hub->descriptor->wHubCharacteristics);
567 if (hub->descriptor->wHubCharacteristics & HUB_CHAR_COMPOUND) {
569 char portstr [USB_MAXCHILDREN + 1];
571 for (i = 0; i < hdev->maxchild; i++)
572 portstr[i] = hub->descriptor->DeviceRemovable
573 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
575 portstr[hdev->maxchild] = 0;
576 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
578 dev_dbg(hub_dev, "standalone hub\n");
580 switch (hub->descriptor->wHubCharacteristics & HUB_CHAR_LPSM) {
582 dev_dbg(hub_dev, "ganged power switching\n");
585 dev_dbg(hub_dev, "individual port power switching\n");
589 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
593 switch (hub->descriptor->wHubCharacteristics & HUB_CHAR_OCPM) {
595 dev_dbg(hub_dev, "global over-current protection\n");
598 dev_dbg(hub_dev, "individual port over-current protection\n");
602 dev_dbg(hub_dev, "no over-current protection\n");
606 spin_lock_init (&hub->tt.lock);
607 INIT_LIST_HEAD (&hub->tt.clear_list);
608 INIT_WORK (&hub->tt.kevent, hub_tt_kevent, hub);
609 switch (hdev->descriptor.bDeviceProtocol) {
613 dev_dbg(hub_dev, "Single TT\n");
617 ret = usb_set_interface(hdev, 0, 1);
619 dev_dbg(hub_dev, "TT per port\n");
622 dev_err(hub_dev, "Using single TT (err %d)\n",
627 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
628 hdev->descriptor.bDeviceProtocol);
632 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
633 switch (hub->descriptor->wHubCharacteristics & HUB_CHAR_TTTT) {
634 case HUB_TTTT_8_BITS:
635 if (hdev->descriptor.bDeviceProtocol != 0) {
636 hub->tt.think_time = 666;
637 dev_dbg(hub_dev, "TT requires at most %d "
638 "FS bit times (%d ns)\n",
639 8, hub->tt.think_time);
642 case HUB_TTTT_16_BITS:
643 hub->tt.think_time = 666 * 2;
644 dev_dbg(hub_dev, "TT requires at most %d "
645 "FS bit times (%d ns)\n",
646 16, hub->tt.think_time);
648 case HUB_TTTT_24_BITS:
649 hub->tt.think_time = 666 * 3;
650 dev_dbg(hub_dev, "TT requires at most %d "
651 "FS bit times (%d ns)\n",
652 24, hub->tt.think_time);
654 case HUB_TTTT_32_BITS:
655 hub->tt.think_time = 666 * 4;
656 dev_dbg(hub_dev, "TT requires at most %d "
657 "FS bit times (%d ns)\n",
658 32, hub->tt.think_time);
662 /* probe() zeroes hub->indicator[] */
663 if (hub->descriptor->wHubCharacteristics & HUB_CHAR_PORTIND) {
664 hub->has_indicators = 1;
665 dev_dbg(hub_dev, "Port indicators are supported\n");
668 dev_dbg(hub_dev, "power on to power good time: %dms\n",
669 hub->descriptor->bPwrOn2PwrGood * 2);
671 /* power budgeting mostly matters with bus-powered hubs,
672 * and battery-powered root hubs (may provide just 8 mA).
674 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
676 message = "can't get hub status";
679 le16_to_cpus(&hubstatus);
680 if (hdev == hdev->bus->root_hub) {
681 struct usb_hcd *hcd =
682 container_of(hdev->bus, struct usb_hcd, self);
684 hub->power_budget = min(500u, hcd->power_budget) / 2;
685 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
686 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
687 hub->descriptor->bHubContrCurrent);
688 hub->power_budget = (501 - hub->descriptor->bHubContrCurrent)
691 if (hub->power_budget)
692 dev_dbg(hub_dev, "%dmA bus power budget for children\n",
693 hub->power_budget * 2);
696 ret = hub_hub_status(hub, &hubstatus, &hubchange);
698 message = "can't get hub status";
702 /* local power status reports aren't always correct */
703 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
704 dev_dbg(hub_dev, "local power source is %s\n",
705 (hubstatus & HUB_STATUS_LOCAL_POWER)
706 ? "lost (inactive)" : "good");
708 if ((hub->descriptor->wHubCharacteristics & HUB_CHAR_OCPM) == 0)
709 dev_dbg(hub_dev, "%sover-current condition exists\n",
710 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
712 /* set up the interrupt endpoint */
713 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
714 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
716 if (maxp > sizeof(*hub->buffer))
717 maxp = sizeof(*hub->buffer);
719 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
721 message = "couldn't allocate interrupt urb";
726 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
727 hub, endpoint->bInterval);
728 hub->urb->transfer_dma = hub->buffer_dma;
729 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
731 /* maybe cycle the hub leds */
732 if (hub->has_indicators && blinkenlights)
733 hub->indicator [0] = INDICATOR_CYCLE;
740 dev_err (hub_dev, "config failed, %s (err %d)\n",
742 /* hub_disconnect() frees urb and descriptor */
746 static unsigned highspeed_hubs;
748 /* Called after the hub driver is unbound from a hub with children */
749 static void hub_remove_children_work(void *__hub)
751 struct usb_hub *hub = __hub;
752 struct usb_device *hdev = hub->hdev;
757 usb_lock_device(hdev);
758 for (i = 0; i < hdev->maxchild; ++i) {
759 if (hdev->children[i])
760 usb_disconnect(&hdev->children[i]);
762 usb_unlock_device(hdev);
766 static void hub_disconnect(struct usb_interface *intf)
768 struct usb_hub *hub = usb_get_intfdata (intf);
769 struct usb_device *hdev;
772 usb_set_intfdata (intf, NULL);
775 if (hdev->speed == USB_SPEED_HIGH)
779 usb_free_urb(hub->urb);
782 spin_lock_irq(&hub_event_lock);
783 list_del_init(&hub->event_list);
784 spin_unlock_irq(&hub_event_lock);
786 kfree(hub->descriptor);
787 hub->descriptor = NULL;
793 usb_buffer_free(hdev, sizeof(*hub->buffer), hub->buffer,
798 /* If there are any children then this is an unbind only, not a
799 * physical disconnection. The active ports must be disabled
800 * and later on we must call usb_disconnect(). We can't call
801 * it now because we may not hold the hub's device lock.
804 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
805 if (hdev->children[port1 - 1]) {
807 hub_port_disable(hub, port1, 1);
814 /* Reuse the hub->leds work_struct for our own purposes */
815 INIT_WORK(&hub->leds, hub_remove_children_work, hub);
816 schedule_work(&hub->leds);
821 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
823 struct usb_host_interface *desc;
824 struct usb_endpoint_descriptor *endpoint;
825 struct usb_device *hdev;
828 desc = intf->cur_altsetting;
829 hdev = interface_to_usbdev(intf);
831 /* Some hubs have a subclass of 1, which AFAICT according to the */
832 /* specs is not defined, but it works */
833 if ((desc->desc.bInterfaceSubClass != 0) &&
834 (desc->desc.bInterfaceSubClass != 1)) {
836 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
840 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
841 if (desc->desc.bNumEndpoints != 1)
842 goto descriptor_error;
844 endpoint = &desc->endpoint[0].desc;
846 /* Output endpoint? Curiouser and curiouser.. */
847 if (!(endpoint->bEndpointAddress & USB_DIR_IN))
848 goto descriptor_error;
850 /* If it's not an interrupt endpoint, we'd better punt! */
851 if ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
852 != USB_ENDPOINT_XFER_INT)
853 goto descriptor_error;
856 dev_info (&intf->dev, "USB hub found\n");
858 hub = kmalloc(sizeof(*hub), GFP_KERNEL);
860 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
864 memset(hub, 0, sizeof(*hub));
866 INIT_LIST_HEAD(&hub->event_list);
867 hub->intfdev = &intf->dev;
869 INIT_WORK(&hub->leds, led_work, hub);
871 usb_set_intfdata (intf, hub);
873 if (hdev->speed == USB_SPEED_HIGH)
876 if (hub_configure(hub, endpoint) >= 0)
879 hub_disconnect (intf);
884 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
886 struct usb_device *hdev = interface_to_usbdev (intf);
888 /* assert ifno == 0 (part of hub spec) */
890 case USBDEVFS_HUB_PORTINFO: {
891 struct usbdevfs_hub_portinfo *info = user_data;
894 spin_lock_irq(&device_state_lock);
895 if (hdev->devnum <= 0)
898 info->nports = hdev->maxchild;
899 for (i = 0; i < info->nports; i++) {
900 if (hdev->children[i] == NULL)
904 hdev->children[i]->devnum;
907 spin_unlock_irq(&device_state_lock);
909 return info->nports + 1;
917 /* caller has locked the hub device */
918 static void hub_pre_reset(struct usb_hub *hub)
920 struct usb_device *hdev = hub->hdev;
923 for (i = 0; i < hdev->maxchild; ++i) {
924 if (hdev->children[i])
925 usb_disconnect(&hdev->children[i]);
930 /* caller has locked the hub device */
931 static void hub_post_reset(struct usb_hub *hub)
938 /* grab device/port lock, returning index of that port (zero based).
939 * protects the upstream link used by this device from concurrent
940 * tree operations like suspend, resume, reset, and disconnect, which
941 * apply to everything downstream of a given port.
943 static int locktree(struct usb_device *udev)
946 struct usb_device *hdev;
951 /* root hub is always the first lock in the series */
954 usb_lock_device(udev);
958 /* on the path from root to us, lock everything from
959 * top down, dropping parent locks when not needed
964 for (t = 0; t < hdev->maxchild; t++) {
965 if (hdev->children[t] == udev) {
966 /* everything is fail-fast once disconnect
969 if (udev->state == USB_STATE_NOTATTACHED)
972 /* when everyone grabs locks top->bottom,
973 * non-overlapping work may be concurrent
975 down(&udev->serialize);
976 up(&hdev->serialize);
980 usb_unlock_device(hdev);
984 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
988 for (i = 0; i < udev->maxchild; ++i) {
989 if (udev->children[i])
990 recursively_mark_NOTATTACHED(udev->children[i]);
992 udev->state = USB_STATE_NOTATTACHED;
996 * usb_set_device_state - change a device's current state (usbcore, hcds)
997 * @udev: pointer to device whose state should be changed
998 * @new_state: new state value to be stored
1000 * udev->state is _not_ fully protected by the device lock. Although
1001 * most transitions are made only while holding the lock, the state can
1002 * can change to USB_STATE_NOTATTACHED at almost any time. This
1003 * is so that devices can be marked as disconnected as soon as possible,
1004 * without having to wait for any semaphores to be released. As a result,
1005 * all changes to any device's state must be protected by the
1006 * device_state_lock spinlock.
1008 * Once a device has been added to the device tree, all changes to its state
1009 * should be made using this routine. The state should _not_ be set directly.
1011 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1012 * Otherwise udev->state is set to new_state, and if new_state is
1013 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1014 * to USB_STATE_NOTATTACHED.
1016 void usb_set_device_state(struct usb_device *udev,
1017 enum usb_device_state new_state)
1019 unsigned long flags;
1021 spin_lock_irqsave(&device_state_lock, flags);
1022 if (udev->state == USB_STATE_NOTATTACHED)
1024 else if (new_state != USB_STATE_NOTATTACHED) {
1025 udev->state = new_state;
1026 if (new_state == USB_STATE_CONFIGURED)
1027 device_init_wakeup(&udev->dev,
1028 (udev->actconfig->desc.bmAttributes
1029 & USB_CONFIG_ATT_WAKEUP));
1030 else if (new_state != USB_STATE_SUSPENDED)
1031 device_init_wakeup(&udev->dev, 0);
1033 recursively_mark_NOTATTACHED(udev);
1034 spin_unlock_irqrestore(&device_state_lock, flags);
1036 EXPORT_SYMBOL(usb_set_device_state);
1039 static void choose_address(struct usb_device *udev)
1042 struct usb_bus *bus = udev->bus;
1044 /* If khubd ever becomes multithreaded, this will need a lock */
1046 /* Try to allocate the next devnum beginning at bus->devnum_next. */
1047 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1050 devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
1052 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1055 set_bit(devnum, bus->devmap.devicemap);
1056 udev->devnum = devnum;
1060 static void release_address(struct usb_device *udev)
1062 if (udev->devnum > 0) {
1063 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1069 * usb_disconnect - disconnect a device (usbcore-internal)
1070 * @pdev: pointer to device being disconnected
1071 * Context: !in_interrupt ()
1073 * Something got disconnected. Get rid of it and all of its children.
1075 * If *pdev is a normal device then the parent hub must already be locked.
1076 * If *pdev is a root hub then this routine will acquire the
1077 * usb_bus_list_lock on behalf of the caller.
1079 * Only hub drivers (including virtual root hub drivers for host
1080 * controllers) should ever call this.
1082 * This call is synchronous, and may not be used in an interrupt context.
1084 void usb_disconnect(struct usb_device **pdev)
1086 struct usb_device *udev = *pdev;
1090 pr_debug ("%s nodev\n", __FUNCTION__);
1094 /* mark the device as inactive, so any further urb submissions for
1095 * this device (and any of its children) will fail immediately.
1096 * this quiesces everyting except pending urbs.
1098 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1100 /* lock the bus list on behalf of HCDs unregistering their root hubs */
1101 if (!udev->parent) {
1102 down(&usb_bus_list_lock);
1103 usb_lock_device(udev);
1105 down(&udev->serialize);
1107 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1109 /* Free up all the children before we remove this device */
1110 for (i = 0; i < USB_MAXCHILDREN; i++) {
1111 if (udev->children[i])
1112 usb_disconnect(&udev->children[i]);
1115 /* deallocate hcd/hardware state ... nuking all pending urbs and
1116 * cleaning up all state associated with the current configuration
1117 * so that the hardware is now fully quiesced.
1119 usb_disable_device(udev, 0);
1121 /* Free the device number, remove the /proc/bus/usb entry and
1122 * the sysfs attributes, and delete the parent's children[]
1123 * (or root_hub) pointer.
1125 dev_dbg (&udev->dev, "unregistering device\n");
1126 release_address(udev);
1127 usbfs_remove_device(udev);
1128 usbdev_remove(udev);
1129 usb_remove_sysfs_dev_files(udev);
1131 /* Avoid races with recursively_mark_NOTATTACHED() */
1132 spin_lock_irq(&device_state_lock);
1134 spin_unlock_irq(&device_state_lock);
1136 if (!udev->parent) {
1137 usb_unlock_device(udev);
1138 up(&usb_bus_list_lock);
1140 up(&udev->serialize);
1142 device_unregister(&udev->dev);
1145 static int choose_configuration(struct usb_device *udev)
1149 /* NOTE: this should interact with hub power budgeting */
1151 c = udev->config[0].desc.bConfigurationValue;
1152 if (udev->descriptor.bNumConfigurations != 1) {
1153 for (i = 0; i < udev->descriptor.bNumConfigurations; i++) {
1154 struct usb_interface_descriptor *desc;
1156 /* heuristic: Linux is more likely to have class
1157 * drivers, so avoid vendor-specific interfaces.
1159 desc = &udev->config[i].intf_cache[0]
1161 if (desc->bInterfaceClass == USB_CLASS_VENDOR_SPEC)
1163 /* COMM/2/all is CDC ACM, except 0xff is MSFT RNDIS.
1164 * MSFT needs this to be the first config; never use
1165 * it as the default unless Linux has host-side RNDIS.
1166 * A second config would ideally be CDC-Ethernet, but
1167 * may instead be the "vendor specific" CDC subset
1168 * long used by ARM Linux for sa1100 or pxa255.
1170 if (desc->bInterfaceClass == USB_CLASS_COMM
1171 && desc->bInterfaceSubClass == 2
1172 && desc->bInterfaceProtocol == 0xff) {
1173 c = udev->config[1].desc.bConfigurationValue;
1176 c = udev->config[i].desc.bConfigurationValue;
1179 dev_info(&udev->dev,
1180 "configuration #%d chosen from %d choices\n",
1181 c, udev->descriptor.bNumConfigurations);
1187 static void show_string(struct usb_device *udev, char *id, char *string)
1191 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1195 static inline void show_string(struct usb_device *udev, char *id, char *string)
1199 static void get_string(struct usb_device *udev, char **string, int index)
1205 buf = kmalloc(256, GFP_KERNEL);
1208 if (usb_string(udev, index, buf, 256) > 0)
1215 #ifdef CONFIG_USB_OTG
1216 #include "otg_whitelist.h"
1220 * usb_new_device - perform initial device setup (usbcore-internal)
1221 * @udev: newly addressed device (in ADDRESS state)
1223 * This is called with devices which have been enumerated, but not yet
1224 * configured. The device descriptor is available, but not descriptors
1225 * for any device configuration. The caller must have locked udev and
1226 * either the parent hub (if udev is a normal device) or else the
1227 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1228 * udev has already been installed, but udev is not yet visible through
1229 * sysfs or other filesystem code.
1231 * Returns 0 for success (device is configured and listed, with its
1232 * interfaces, in sysfs); else a negative errno value.
1234 * This call is synchronous, and may not be used in an interrupt context.
1236 * Only the hub driver should ever call this; root hub registration
1237 * uses it indirectly.
1239 int usb_new_device(struct usb_device *udev)
1244 err = usb_get_configuration(udev);
1246 dev_err(&udev->dev, "can't read configurations, error %d\n",
1251 /* read the standard strings and cache them if present */
1252 get_string(udev, &udev->product, udev->descriptor.iProduct);
1253 get_string(udev, &udev->manufacturer, udev->descriptor.iManufacturer);
1254 get_string(udev, &udev->serial, udev->descriptor.iSerialNumber);
1256 /* Tell the world! */
1257 dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
1258 "SerialNumber=%d\n",
1259 udev->descriptor.iManufacturer,
1260 udev->descriptor.iProduct,
1261 udev->descriptor.iSerialNumber);
1262 show_string(udev, "Product", udev->product);
1263 show_string(udev, "Manufacturer", udev->manufacturer);
1264 show_string(udev, "SerialNumber", udev->serial);
1266 #ifdef CONFIG_USB_OTG
1268 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1269 * to wake us after we've powered off VBUS; and HNP, switching roles
1270 * "host" to "peripheral". The OTG descriptor helps figure this out.
1272 if (!udev->bus->is_b_host
1274 && udev->parent == udev->bus->root_hub) {
1275 struct usb_otg_descriptor *desc = 0;
1276 struct usb_bus *bus = udev->bus;
1278 /* descriptor may appear anywhere in config */
1279 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1280 le16_to_cpu(udev->config[0].desc.wTotalLength),
1281 USB_DT_OTG, (void **) &desc) == 0) {
1282 if (desc->bmAttributes & USB_OTG_HNP) {
1284 struct usb_device *root = udev->parent;
1286 for (port1 = 1; port1 <= root->maxchild;
1288 if (root->children[port1-1] == udev)
1292 dev_info(&udev->dev,
1293 "Dual-Role OTG device on %sHNP port\n",
1294 (port1 == bus->otg_port)
1297 /* enable HNP before suspend, it's simpler */
1298 if (port1 == bus->otg_port)
1299 bus->b_hnp_enable = 1;
1300 err = usb_control_msg(udev,
1301 usb_sndctrlpipe(udev, 0),
1302 USB_REQ_SET_FEATURE, 0,
1304 ? USB_DEVICE_B_HNP_ENABLE
1305 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1306 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1308 /* OTG MESSAGE: report errors here,
1309 * customize to match your product.
1311 dev_info(&udev->dev,
1312 "can't set HNP mode; %d\n",
1314 bus->b_hnp_enable = 0;
1320 if (!is_targeted(udev)) {
1322 /* Maybe it can talk to us, though we can't talk to it.
1323 * (Includes HNP test device.)
1325 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1326 static int __usb_suspend_device(struct usb_device *,
1328 err = __usb_suspend_device(udev, udev->bus->otg_port);
1330 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1337 /* put device-specific files into sysfs */
1338 err = device_add (&udev->dev);
1340 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1343 usb_create_sysfs_dev_files (udev);
1345 /* choose and set the configuration. that registers the interfaces
1346 * with the driver core, and lets usb device drivers bind to them.
1348 c = choose_configuration(udev);
1350 dev_warn(&udev->dev,
1351 "can't choose an initial configuration\n");
1353 err = usb_set_configuration(udev, c);
1355 dev_err(&udev->dev, "can't set config #%d, error %d\n",
1357 usb_remove_sysfs_dev_files(udev);
1358 device_del(&udev->dev);
1363 /* USB device state == configured ... usable */
1365 /* add a /proc/bus/usb entry */
1367 usbfs_add_device(udev);
1371 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1376 static int hub_port_status(struct usb_hub *hub, int port1,
1377 u16 *status, u16 *change)
1381 ret = get_port_status(hub->hdev, port1, &hub->status->port);
1383 dev_err (hub->intfdev,
1384 "%s failed (err = %d)\n", __FUNCTION__, ret);
1386 *status = le16_to_cpu(hub->status->port.wPortStatus);
1387 *change = le16_to_cpu(hub->status->port.wPortChange);
1393 #define PORT_RESET_TRIES 5
1394 #define SET_ADDRESS_TRIES 2
1395 #define GET_DESCRIPTOR_TRIES 2
1396 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1397 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1399 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1400 #define HUB_SHORT_RESET_TIME 10
1401 #define HUB_LONG_RESET_TIME 200
1402 #define HUB_RESET_TIMEOUT 500
1404 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1405 struct usb_device *udev, unsigned int delay)
1407 int delay_time, ret;
1411 for (delay_time = 0;
1412 delay_time < HUB_RESET_TIMEOUT;
1413 delay_time += delay) {
1414 /* wait to give the device a chance to reset */
1417 /* read and decode port status */
1418 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1422 /* Device went away? */
1423 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1426 /* bomb out completely if something weird happened */
1427 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1430 /* if we`ve finished resetting, then break out of the loop */
1431 if (!(portstatus & USB_PORT_STAT_RESET) &&
1432 (portstatus & USB_PORT_STAT_ENABLE)) {
1433 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1434 udev->speed = USB_SPEED_HIGH;
1435 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1436 udev->speed = USB_SPEED_LOW;
1438 udev->speed = USB_SPEED_FULL;
1442 /* switch to the long delay after two short delay failures */
1443 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1444 delay = HUB_LONG_RESET_TIME;
1446 dev_dbg (hub->intfdev,
1447 "port %d not reset yet, waiting %dms\n",
1454 static int hub_port_reset(struct usb_hub *hub, int port1,
1455 struct usb_device *udev, unsigned int delay)
1459 /* Reset the port */
1460 for (i = 0; i < PORT_RESET_TRIES; i++) {
1461 status = set_port_feature(hub->hdev,
1462 port1, USB_PORT_FEAT_RESET);
1464 dev_err(hub->intfdev,
1465 "cannot reset port %d (err = %d)\n",
1468 status = hub_port_wait_reset(hub, port1, udev, delay);
1469 if (status && status != -ENOTCONN)
1470 dev_dbg(hub->intfdev,
1471 "port_wait_reset: err = %d\n",
1475 /* return on disconnect or reset */
1478 /* TRSTRCY = 10 ms; plus some extra */
1483 clear_port_feature(hub->hdev,
1484 port1, USB_PORT_FEAT_C_RESET);
1485 /* FIXME need disconnect() for NOTATTACHED device */
1486 usb_set_device_state(udev, status
1487 ? USB_STATE_NOTATTACHED
1488 : USB_STATE_DEFAULT);
1492 dev_dbg (hub->intfdev,
1493 "port %d not enabled, trying reset again...\n",
1495 delay = HUB_LONG_RESET_TIME;
1498 dev_err (hub->intfdev,
1499 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1506 * Disable a port and mark a logical connnect-change event, so that some
1507 * time later khubd will disconnect() any existing usb_device on the port
1508 * and will re-enumerate if there actually is a device attached.
1510 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
1512 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
1513 hub_port_disable(hub, port1, 1);
1515 /* FIXME let caller ask to power down the port:
1516 * - some devices won't enumerate without a VBUS power cycle
1517 * - SRP saves power that way
1518 * - ... new call, TBD ...
1519 * That's easy if this hub can switch power per-port, and
1520 * khubd reactivates the port later (timer, SRP, etc).
1521 * Powerdown must be optional, because of reset/DFU.
1524 set_bit(port1, hub->change_bits);
1529 #ifdef CONFIG_USB_SUSPEND
1532 * Selective port suspend reduces power; most suspended devices draw
1533 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1534 * All devices below the suspended port are also suspended.
1536 * Devices leave suspend state when the host wakes them up. Some devices
1537 * also support "remote wakeup", where the device can activate the USB
1538 * tree above them to deliver data, such as a keypress or packet. In
1539 * some cases, this wakes the USB host.
1541 static int hub_port_suspend(struct usb_hub *hub, int port1,
1542 struct usb_device *udev)
1546 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1548 /* enable remote wakeup when appropriate; this lets the device
1549 * wake up the upstream hub (including maybe the root hub).
1551 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1552 * we don't explicitly enable it here.
1554 if (device_may_wakeup(&udev->dev)) {
1555 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1556 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1557 USB_DEVICE_REMOTE_WAKEUP, 0,
1559 USB_CTRL_SET_TIMEOUT);
1562 "won't remote wakeup, status %d\n",
1567 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1569 dev_dbg(hub->intfdev,
1570 "can't suspend port %d, status %d\n",
1572 /* paranoia: "should not happen" */
1573 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1574 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1575 USB_DEVICE_REMOTE_WAKEUP, 0,
1577 USB_CTRL_SET_TIMEOUT);
1579 /* device has up to 10 msec to fully suspend */
1580 dev_dbg(&udev->dev, "usb suspend\n");
1581 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1588 * Devices on USB hub ports have only one "suspend" state, corresponding
1589 * to ACPI D2, "may cause the device to lose some context".
1590 * State transitions include:
1592 * - suspend, resume ... when the VBUS power link stays live
1593 * - suspend, disconnect ... VBUS lost
1595 * Once VBUS drop breaks the circuit, the port it's using has to go through
1596 * normal re-enumeration procedures, starting with enabling VBUS power.
1597 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1598 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1599 * timer, no SRP, no requests through sysfs.
1601 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1602 * the root hub for their bus goes into global suspend ... so we don't
1603 * (falsely) update the device power state to say it suspended.
1605 static int __usb_suspend_device (struct usb_device *udev, int port1)
1609 /* caller owns the udev device lock */
1613 if (udev->state == USB_STATE_SUSPENDED
1614 || udev->state == USB_STATE_NOTATTACHED) {
1618 /* all interfaces must already be suspended */
1619 if (udev->actconfig) {
1622 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1623 struct usb_interface *intf;
1625 intf = udev->actconfig->interface[i];
1626 if (is_active(intf)) {
1627 dev_dbg(&intf->dev, "nyet suspended\n");
1633 /* "global suspend" of the HC-to-USB interface (root hub), or
1634 * "selective suspend" of just one hub-device link.
1636 if (!udev->parent) {
1637 struct usb_bus *bus = udev->bus;
1638 if (bus && bus->op->hub_suspend) {
1639 status = bus->op->hub_suspend (bus);
1641 dev_dbg(&udev->dev, "usb suspend\n");
1642 usb_set_device_state(udev,
1643 USB_STATE_SUSPENDED);
1646 status = -EOPNOTSUPP;
1648 status = hub_port_suspend(hdev_to_hub(udev->parent), port1,
1652 udev->dev.power.power_state = PMSG_SUSPEND;
1657 * usb_suspend_device - suspend a usb device
1658 * @udev: device that's no longer in active use
1659 * Context: must be able to sleep; device not locked
1661 * Suspends a USB device that isn't in active use, conserving power.
1662 * Devices may wake out of a suspend, if anything important happens,
1663 * using the remote wakeup mechanism. They may also be taken out of
1664 * suspend by the host, using usb_resume_device(). It's also routine
1665 * to disconnect devices while they are suspended.
1667 * This only affects the USB hardware for a device; its interfaces
1668 * (and, for hubs, child devices) must already have been suspended.
1670 * Suspending OTG devices may trigger HNP, if that's been enabled
1671 * between a pair of dual-role devices. That will change roles, such
1672 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1674 * Returns 0 on success, else negative errno.
1676 int usb_suspend_device(struct usb_device *udev)
1680 port1 = locktree(udev);
1684 status = __usb_suspend_device(udev, port1);
1685 usb_unlock_device(udev);
1690 * If the USB "suspend" state is in use (rather than "global suspend"),
1691 * many devices will be individually taken out of suspend state using
1692 * special" resume" signaling. These routines kick in shortly after
1693 * hardware resume signaling is finished, either because of selective
1694 * resume (by host) or remote wakeup (by device) ... now see what changed
1695 * in the tree that's rooted at this device.
1697 static int finish_port_resume(struct usb_device *udev)
1702 /* caller owns the udev device lock */
1703 dev_dbg(&udev->dev, "usb resume\n");
1705 /* usb ch9 identifies four variants of SUSPENDED, based on what
1706 * state the device resumes to. Linux currently won't see the
1707 * first two on the host side; they'd be inside hub_port_init()
1708 * during many timeouts, but khubd can't suspend until later.
1710 usb_set_device_state(udev, udev->actconfig
1711 ? USB_STATE_CONFIGURED
1712 : USB_STATE_ADDRESS);
1713 udev->dev.power.power_state = PMSG_ON;
1715 /* 10.5.4.5 says be sure devices in the tree are still there.
1716 * For now let's assume the device didn't go crazy on resume,
1717 * and device drivers will know about any resume quirks.
1719 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
1722 "gone after usb resume? status %d\n",
1724 else if (udev->actconfig) {
1727 le16_to_cpus(&devstatus);
1728 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
1729 status = usb_control_msg(udev,
1730 usb_sndctrlpipe(udev, 0),
1731 USB_REQ_CLEAR_FEATURE,
1733 USB_DEVICE_REMOTE_WAKEUP, 0,
1735 USB_CTRL_SET_TIMEOUT);
1737 dev_dbg(&udev->dev, "disable remote "
1738 "wakeup, status %d\n", status);
1743 /* resume interface drivers; if this is a hub, it
1744 * resumes the child devices
1746 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1747 struct usb_interface *intf;
1748 struct usb_driver *driver;
1750 intf = udev->actconfig->interface[i];
1751 if (is_active(intf))
1753 if (!intf->dev.driver) {
1754 /* FIXME maybe force to alt 0 */
1757 driver = to_usb_driver(intf->dev.driver);
1759 /* bus_rescan_devices() may rebind drivers */
1760 if (!driver->resume)
1763 /* can we do better than just logging errors? */
1765 status = driver->resume(intf);
1767 mark_quiesced(intf);
1769 "resume error %d\n",
1775 } else if (udev->devnum <= 0) {
1776 dev_dbg(&udev->dev, "bogus resume!\n");
1783 hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1787 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1789 /* see 7.1.7.7; affects power usage, but not budgeting */
1790 status = clear_port_feature(hub->hdev,
1791 port1, USB_PORT_FEAT_SUSPEND);
1793 dev_dbg(hub->intfdev,
1794 "can't resume port %d, status %d\n",
1800 /* drive resume for at least 20 msec */
1802 dev_dbg(&udev->dev, "RESUME\n");
1805 #define LIVE_FLAGS ( USB_PORT_STAT_POWER \
1806 | USB_PORT_STAT_ENABLE \
1807 | USB_PORT_STAT_CONNECTION)
1809 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1810 * stop resume signaling. Then finish the resume
1813 devstatus = portchange = 0;
1814 status = hub_port_status(hub, port1,
1815 &devstatus, &portchange);
1817 || (devstatus & LIVE_FLAGS) != LIVE_FLAGS
1818 || (devstatus & USB_PORT_STAT_SUSPEND) != 0
1820 dev_dbg(hub->intfdev,
1821 "port %d status %04x.%04x after resume, %d\n",
1822 port1, portchange, devstatus, status);
1824 /* TRSMRCY = 10 msec */
1827 status = finish_port_resume(udev);
1831 hub_port_logical_disconnect(hub, port1);
1836 static int hub_resume (struct usb_interface *intf);
1839 * usb_resume_device - re-activate a suspended usb device
1840 * @udev: device to re-activate
1841 * Context: must be able to sleep; device not locked
1843 * This will re-activate the suspended device, increasing power usage
1844 * while letting drivers communicate again with its endpoints.
1845 * USB resume explicitly guarantees that the power session between
1846 * the host and the device is the same as it was when the device
1849 * Returns 0 on success, else negative errno.
1851 int usb_resume_device(struct usb_device *udev)
1855 port1 = locktree(udev);
1859 /* "global resume" of the HC-to-USB interface (root hub), or
1860 * selective resume of one hub-to-device port
1862 if (!udev->parent) {
1863 struct usb_bus *bus = udev->bus;
1864 if (bus && bus->op->hub_resume) {
1865 status = bus->op->hub_resume (bus);
1867 status = -EOPNOTSUPP;
1869 dev_dbg(&udev->dev, "usb resume\n");
1870 /* TRSMRCY = 10 msec */
1872 usb_set_device_state (udev, USB_STATE_CONFIGURED);
1873 udev->dev.power.power_state = PMSG_ON;
1874 status = hub_resume (udev
1875 ->actconfig->interface[0]);
1877 } else if (udev->state == USB_STATE_SUSPENDED) {
1878 // NOTE this fails if parent is also suspended...
1879 status = hub_port_resume(hdev_to_hub(udev->parent),
1885 dev_dbg(&udev->dev, "can't resume, status %d\n",
1889 usb_unlock_device(udev);
1891 /* rebind drivers that had no suspend() */
1893 usb_lock_all_devices();
1894 bus_rescan_devices(&usb_bus_type);
1895 usb_unlock_all_devices();
1900 static int remote_wakeup(struct usb_device *udev)
1904 /* don't repeat RESUME sequence if this device
1905 * was already woken up by some other task
1907 down(&udev->serialize);
1908 if (udev->state == USB_STATE_SUSPENDED) {
1909 dev_dbg(&udev->dev, "RESUME (wakeup)\n");
1910 /* TRSMRCY = 10 msec */
1912 status = finish_port_resume(udev);
1914 up(&udev->serialize);
1918 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
1920 struct usb_hub *hub = usb_get_intfdata (intf);
1921 struct usb_device *hdev = hub->hdev;
1924 /* fail if children aren't already suspended */
1925 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1926 struct usb_device *udev;
1928 udev = hdev->children [port1-1];
1929 if (udev && udev->state != USB_STATE_SUSPENDED) {
1930 dev_dbg(&intf->dev, "port %d nyet suspended\n", port1);
1935 /* stop khubd and related activity */
1940 static int hub_resume(struct usb_interface *intf)
1942 struct usb_device *hdev = interface_to_usbdev(intf);
1943 struct usb_hub *hub = usb_get_intfdata (intf);
1947 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1948 struct usb_device *udev;
1949 u16 portstat, portchange;
1951 udev = hdev->children [port1-1];
1952 status = hub_port_status(hub, port1, &portstat, &portchange);
1954 if (portchange & USB_PORT_STAT_C_SUSPEND) {
1955 clear_port_feature(hdev, port1,
1956 USB_PORT_FEAT_C_SUSPEND);
1957 portchange &= ~USB_PORT_STAT_C_SUSPEND;
1960 /* let khubd handle disconnects etc */
1965 if (!udev || status < 0)
1967 down (&udev->serialize);
1968 if (portstat & USB_PORT_STAT_SUSPEND)
1969 status = hub_port_resume(hub, port1, udev);
1971 status = finish_port_resume(udev);
1973 dev_dbg(&intf->dev, "resume port %d --> %d\n",
1975 hub_port_logical_disconnect(hub, port1);
1978 up(&udev->serialize);
1980 hub->resume_root_hub = 0;
1985 void usb_resume_root_hub(struct usb_device *hdev)
1987 struct usb_hub *hub = hdev_to_hub(hdev);
1989 hub->resume_root_hub = 1;
1993 #else /* !CONFIG_USB_SUSPEND */
1995 int usb_suspend_device(struct usb_device *udev)
1997 /* state does NOT lie by saying it's USB_STATE_SUSPENDED! */
2001 int usb_resume_device(struct usb_device *udev)
2003 udev->dev.power_state.event = PM_EVENT_ON;
2007 #define hub_suspend NULL
2008 #define hub_resume NULL
2009 #define remote_wakeup(x) 0
2011 #endif /* CONFIG_USB_SUSPEND */
2013 EXPORT_SYMBOL(usb_suspend_device);
2014 EXPORT_SYMBOL(usb_resume_device);
2018 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2020 * Between connect detection and reset signaling there must be a delay
2021 * of 100ms at least for debounce and power-settling. The corresponding
2022 * timer shall restart whenever the downstream port detects a disconnect.
2024 * Apparently there are some bluetooth and irda-dongles and a number of
2025 * low-speed devices for which this debounce period may last over a second.
2026 * Not covered by the spec - but easy to deal with.
2028 * This implementation uses a 1500ms total debounce timeout; if the
2029 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2030 * every 25ms for transient disconnects. When the port status has been
2031 * unchanged for 100ms it returns the port status.
2034 #define HUB_DEBOUNCE_TIMEOUT 1500
2035 #define HUB_DEBOUNCE_STEP 25
2036 #define HUB_DEBOUNCE_STABLE 100
2038 static int hub_port_debounce(struct usb_hub *hub, int port1)
2041 int total_time, stable_time = 0;
2042 u16 portchange, portstatus;
2043 unsigned connection = 0xffff;
2045 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2046 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2050 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2051 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2052 stable_time += HUB_DEBOUNCE_STEP;
2053 if (stable_time >= HUB_DEBOUNCE_STABLE)
2057 connection = portstatus & USB_PORT_STAT_CONNECTION;
2060 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2061 clear_port_feature(hub->hdev, port1,
2062 USB_PORT_FEAT_C_CONNECTION);
2065 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2067 msleep(HUB_DEBOUNCE_STEP);
2070 dev_dbg (hub->intfdev,
2071 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2072 port1, total_time, stable_time, portstatus);
2074 if (stable_time < HUB_DEBOUNCE_STABLE)
2079 static void ep0_reinit(struct usb_device *udev)
2081 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
2082 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
2083 udev->ep_in[0] = udev->ep_out[0] = &udev->ep0;
2086 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2087 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2089 static int hub_set_address(struct usb_device *udev)
2093 if (udev->devnum == 0)
2095 if (udev->state == USB_STATE_ADDRESS)
2097 if (udev->state != USB_STATE_DEFAULT)
2099 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2100 USB_REQ_SET_ADDRESS, 0, udev->devnum, 0,
2101 NULL, 0, USB_CTRL_SET_TIMEOUT);
2103 usb_set_device_state(udev, USB_STATE_ADDRESS);
2109 /* Reset device, (re)assign address, get device descriptor.
2110 * Device connection must be stable, no more debouncing needed.
2111 * Returns device in USB_STATE_ADDRESS, except on error.
2113 * If this is called for an already-existing device (as part of
2114 * usb_reset_device), the caller must own the device lock. For a
2115 * newly detected device that is not accessible through any global
2116 * pointers, it's not necessary to lock the device.
2119 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2122 static DECLARE_MUTEX(usb_address0_sem);
2124 struct usb_device *hdev = hub->hdev;
2126 unsigned delay = HUB_SHORT_RESET_TIME;
2127 enum usb_device_speed oldspeed = udev->speed;
2129 /* root hub ports have a slightly longer reset period
2130 * (from USB 2.0 spec, section 7.1.7.5)
2132 if (!hdev->parent) {
2133 delay = HUB_ROOT_RESET_TIME;
2134 if (port1 == hdev->bus->otg_port)
2135 hdev->bus->b_hnp_enable = 0;
2138 /* Some low speed devices have problems with the quick delay, so */
2139 /* be a bit pessimistic with those devices. RHbug #23670 */
2140 if (oldspeed == USB_SPEED_LOW)
2141 delay = HUB_LONG_RESET_TIME;
2143 down(&usb_address0_sem);
2145 /* Reset the device; full speed may morph to high speed */
2146 retval = hub_port_reset(hub, port1, udev, delay);
2147 if (retval < 0) /* error or disconnect */
2149 /* success, speed is known */
2152 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2153 dev_dbg(&udev->dev, "device reset changed speed!\n");
2156 oldspeed = udev->speed;
2158 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2159 * it's fixed size except for full speed devices.
2161 switch (udev->speed) {
2162 case USB_SPEED_HIGH: /* fixed at 64 */
2163 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2165 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2166 /* to determine the ep0 maxpacket size, try to read
2167 * the device descriptor to get bMaxPacketSize0 and
2168 * then correct our initial guess.
2170 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2172 case USB_SPEED_LOW: /* fixed at 8 */
2173 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2179 dev_info (&udev->dev,
2180 "%s %s speed USB device using %s and address %d\n",
2181 (udev->config) ? "reset" : "new",
2182 ({ char *speed; switch (udev->speed) {
2183 case USB_SPEED_LOW: speed = "low"; break;
2184 case USB_SPEED_FULL: speed = "full"; break;
2185 case USB_SPEED_HIGH: speed = "high"; break;
2186 default: speed = "?"; break;
2188 udev->bus->controller->driver->name,
2191 /* Set up TT records, if needed */
2193 udev->tt = hdev->tt;
2194 udev->ttport = hdev->ttport;
2195 } else if (udev->speed != USB_SPEED_HIGH
2196 && hdev->speed == USB_SPEED_HIGH) {
2197 udev->tt = &hub->tt;
2198 udev->ttport = port1;
2201 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2202 * Because device hardware and firmware is sometimes buggy in
2203 * this area, and this is how Linux has done it for ages.
2204 * Change it cautiously.
2206 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2207 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2208 * so it may help with some non-standards-compliant devices.
2209 * Otherwise we start with SET_ADDRESS and then try to read the
2210 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2213 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2214 if (USE_NEW_SCHEME(retry_counter)) {
2215 struct usb_device_descriptor *buf;
2218 #define GET_DESCRIPTOR_BUFSIZE 64
2219 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2225 /* Use a short timeout the first time through,
2226 * so that recalcitrant full-speed devices with
2227 * 8- or 16-byte ep0-maxpackets won't slow things
2228 * down tremendously by NAKing the unexpectedly
2229 * early status stage. Also, retry on all errors;
2230 * some devices are flakey.
2232 for (j = 0; j < 3; ++j) {
2233 buf->bMaxPacketSize0 = 0;
2234 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2235 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2236 USB_DT_DEVICE << 8, 0,
2237 buf, GET_DESCRIPTOR_BUFSIZE,
2238 (i ? USB_CTRL_GET_TIMEOUT : 1000));
2239 switch (buf->bMaxPacketSize0) {
2240 case 8: case 16: case 32: case 64:
2241 if (buf->bDescriptorType ==
2255 udev->descriptor.bMaxPacketSize0 =
2256 buf->bMaxPacketSize0;
2259 retval = hub_port_reset(hub, port1, udev, delay);
2260 if (retval < 0) /* error or disconnect */
2262 if (oldspeed != udev->speed) {
2264 "device reset changed speed!\n");
2269 dev_err(&udev->dev, "device descriptor "
2270 "read/%s, error %d\n",
2275 #undef GET_DESCRIPTOR_BUFSIZE
2278 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2279 retval = hub_set_address(udev);
2286 "device not accepting address %d, error %d\n",
2287 udev->devnum, retval);
2291 /* cope with hardware quirkiness:
2292 * - let SET_ADDRESS settle, some device hardware wants it
2293 * - read ep0 maxpacket even for high and low speed,
2296 if (USE_NEW_SCHEME(retry_counter))
2299 retval = usb_get_device_descriptor(udev, 8);
2301 dev_err(&udev->dev, "device descriptor "
2302 "read/%s, error %d\n",
2314 i = udev->descriptor.bMaxPacketSize0;
2315 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2316 if (udev->speed != USB_SPEED_FULL ||
2317 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2318 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2322 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2323 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2327 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2328 if (retval < (signed)sizeof(udev->descriptor)) {
2329 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2340 hub_port_disable(hub, port1, 0);
2341 up(&usb_address0_sem);
2346 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2348 struct usb_qualifier_descriptor *qual;
2351 qual = kmalloc (sizeof *qual, SLAB_KERNEL);
2355 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2356 qual, sizeof *qual);
2357 if (status == sizeof *qual) {
2358 dev_info(&udev->dev, "not running at top speed; "
2359 "connect to a high speed hub\n");
2360 /* hub LEDs are probably harder to miss than syslog */
2361 if (hub->has_indicators) {
2362 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2363 schedule_work (&hub->leds);
2370 hub_power_remaining (struct usb_hub *hub)
2372 struct usb_device *hdev = hub->hdev;
2376 remaining = hub->power_budget;
2377 if (!remaining) /* self-powered */
2380 for (i = 0; i < hdev->maxchild; i++) {
2381 struct usb_device *udev = hdev->children[i];
2387 /* 100mA per-port ceiling, or 8mA for OTG ports */
2388 if (i != (udev->bus->otg_port - 1) || hdev->parent)
2393 if (udev->actconfig)
2394 delta = udev->actconfig->desc.bMaxPower;
2397 // dev_dbg(&udev->dev, "budgeted %dmA\n", 2 * delta);
2398 if (delta > ceiling)
2399 dev_warn(&udev->dev, "%dmA over %dmA budget!\n",
2400 2 * (delta - ceiling), 2 * ceiling);
2403 if (remaining < 0) {
2404 dev_warn(hub->intfdev,
2405 "%dmA over power budget!\n",
2412 /* Handle physical or logical connection change events.
2413 * This routine is called when:
2414 * a port connection-change occurs;
2415 * a port enable-change occurs (often caused by EMI);
2416 * usb_reset_device() encounters changed descriptors (as from
2417 * a firmware download)
2418 * caller already locked the hub
2420 static void hub_port_connect_change(struct usb_hub *hub, int port1,
2421 u16 portstatus, u16 portchange)
2423 struct usb_device *hdev = hub->hdev;
2424 struct device *hub_dev = hub->intfdev;
2428 "port %d, status %04x, change %04x, %s\n",
2429 port1, portstatus, portchange, portspeed (portstatus));
2431 if (hub->has_indicators) {
2432 set_port_led(hub, port1, HUB_LED_AUTO);
2433 hub->indicator[port1-1] = INDICATOR_AUTO;
2436 /* Disconnect any existing devices under this port */
2437 if (hdev->children[port1-1])
2438 usb_disconnect(&hdev->children[port1-1]);
2439 clear_bit(port1, hub->change_bits);
2441 #ifdef CONFIG_USB_OTG
2442 /* during HNP, don't repeat the debounce */
2443 if (hdev->bus->is_b_host)
2444 portchange &= ~USB_PORT_STAT_C_CONNECTION;
2447 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2448 status = hub_port_debounce(hub, port1);
2451 "connect-debounce failed, port %d disabled\n",
2455 portstatus = status;
2458 /* Return now if nothing is connected */
2459 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2461 /* maybe switch power back on (e.g. root hub was reset) */
2462 if ((hub->descriptor->wHubCharacteristics
2463 & HUB_CHAR_LPSM) < 2
2464 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2465 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2467 if (portstatus & USB_PORT_STAT_ENABLE)
2472 #ifdef CONFIG_USB_SUSPEND
2473 /* If something is connected, but the port is suspended, wake it up. */
2474 if (portstatus & USB_PORT_STAT_SUSPEND) {
2475 status = hub_port_resume(hub, port1, NULL);
2478 "can't clear suspend on port %d; %d\n",
2485 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2486 struct usb_device *udev;
2488 /* reallocate for each attempt, since references
2489 * to the previous one can escape in various ways
2491 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2494 "couldn't allocate port %d usb_device\n",
2499 usb_set_device_state(udev, USB_STATE_POWERED);
2500 udev->speed = USB_SPEED_UNKNOWN;
2502 /* set the address */
2503 choose_address(udev);
2504 if (udev->devnum <= 0) {
2505 status = -ENOTCONN; /* Don't retry */
2509 /* reset and get descriptor */
2510 status = hub_port_init(hub, udev, port1, i);
2514 /* consecutive bus-powered hubs aren't reliable; they can
2515 * violate the voltage drop budget. if the new child has
2516 * a "powered" LED, users should notice we didn't enable it
2517 * (without reading syslog), even without per-port LEDs
2520 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
2521 && hub->power_budget) {
2524 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2527 dev_dbg(&udev->dev, "get status %d ?\n", status);
2530 cpu_to_le16s(&devstat);
2531 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2533 "can't connect bus-powered hub "
2535 if (hub->has_indicators) {
2536 hub->indicator[port1-1] =
2537 INDICATOR_AMBER_BLINK;
2538 schedule_work (&hub->leds);
2540 status = -ENOTCONN; /* Don't retry */
2545 /* check for devices running slower than they could */
2546 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2547 && udev->speed == USB_SPEED_FULL
2548 && highspeed_hubs != 0)
2549 check_highspeed (hub, udev, port1);
2551 /* Store the parent's children[] pointer. At this point
2552 * udev becomes globally accessible, although presumably
2553 * no one will look at it until hdev is unlocked.
2555 down (&udev->serialize);
2558 /* We mustn't add new devices if the parent hub has
2559 * been disconnected; we would race with the
2560 * recursively_mark_NOTATTACHED() routine.
2562 spin_lock_irq(&device_state_lock);
2563 if (hdev->state == USB_STATE_NOTATTACHED)
2566 hdev->children[port1-1] = udev;
2567 spin_unlock_irq(&device_state_lock);
2569 /* Run it through the hoops (find a driver, etc) */
2571 status = usb_new_device(udev);
2573 spin_lock_irq(&device_state_lock);
2574 hdev->children[port1-1] = NULL;
2575 spin_unlock_irq(&device_state_lock);
2579 up (&udev->serialize);
2583 status = hub_power_remaining(hub);
2586 "%dmA power budget left\n",
2592 hub_port_disable(hub, port1, 1);
2595 release_address(udev);
2597 if (status == -ENOTCONN)
2602 hub_port_disable(hub, port1, 1);
2605 static void hub_events(void)
2607 struct list_head *tmp;
2608 struct usb_device *hdev;
2609 struct usb_interface *intf;
2610 struct usb_hub *hub;
2611 struct device *hub_dev;
2620 * We restart the list every time to avoid a deadlock with
2621 * deleting hubs downstream from this one. This should be
2622 * safe since we delete the hub from the event list.
2623 * Not the most efficient, but avoids deadlocks.
2627 /* Grab the first entry at the beginning of the list */
2628 spin_lock_irq(&hub_event_lock);
2629 if (list_empty(&hub_event_list)) {
2630 spin_unlock_irq(&hub_event_lock);
2634 tmp = hub_event_list.next;
2637 hub = list_entry(tmp, struct usb_hub, event_list);
2639 intf = to_usb_interface(hub->intfdev);
2640 hub_dev = &intf->dev;
2642 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
2643 hdev->state, hub->descriptor
2644 ? hub->descriptor->bNbrPorts
2646 /* NOTE: expects max 15 ports... */
2647 (u16) hub->change_bits[0],
2648 (u16) hub->event_bits[0]);
2651 i = hub->resume_root_hub;
2652 spin_unlock_irq(&hub_event_lock);
2654 /* Is this is a root hub wanting to be resumed? */
2656 usb_resume_device(hdev);
2658 /* Lock the device, then check to see if we were
2659 * disconnected while waiting for the lock to succeed. */
2660 if (locktree(hdev) < 0) {
2664 if (hub != usb_get_intfdata(intf))
2667 /* If the hub has died, clean up after it */
2668 if (hdev->state == USB_STATE_NOTATTACHED) {
2673 /* If this is an inactive or suspended hub, do nothing */
2678 dev_dbg (hub_dev, "resetting for error %d\n",
2681 ret = usb_reset_device(hdev);
2684 "error resetting hub: %d\n", ret);
2692 /* deal with port status changes */
2693 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2694 if (test_bit(i, hub->busy_bits))
2696 connect_change = test_bit(i, hub->change_bits);
2697 if (!test_and_clear_bit(i, hub->event_bits) &&
2698 !connect_change && !hub->activating)
2701 ret = hub_port_status(hub, i,
2702 &portstatus, &portchange);
2706 if (hub->activating && !hdev->children[i-1] &&
2708 USB_PORT_STAT_CONNECTION))
2711 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2712 clear_port_feature(hdev, i,
2713 USB_PORT_FEAT_C_CONNECTION);
2717 if (portchange & USB_PORT_STAT_C_ENABLE) {
2718 if (!connect_change)
2720 "port %d enable change, "
2723 clear_port_feature(hdev, i,
2724 USB_PORT_FEAT_C_ENABLE);
2727 * EM interference sometimes causes badly
2728 * shielded USB devices to be shutdown by
2729 * the hub, this hack enables them again.
2730 * Works at least with mouse driver.
2732 if (!(portstatus & USB_PORT_STAT_ENABLE)
2734 && hdev->children[i-1]) {
2737 "disabled by hub (EMI?), "
2744 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2745 clear_port_feature(hdev, i,
2746 USB_PORT_FEAT_C_SUSPEND);
2747 if (hdev->children[i-1]) {
2748 ret = remote_wakeup(hdev->
2754 hub_port_disable(hub, i, 1);
2757 "resume on port %d, status %d\n",
2761 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2763 "over-current change on port %d\n",
2765 clear_port_feature(hdev, i,
2766 USB_PORT_FEAT_C_OVER_CURRENT);
2770 if (portchange & USB_PORT_STAT_C_RESET) {
2772 "reset change on port %d\n",
2774 clear_port_feature(hdev, i,
2775 USB_PORT_FEAT_C_RESET);
2779 hub_port_connect_change(hub, i,
2780 portstatus, portchange);
2783 /* deal with hub status changes */
2784 if (test_and_clear_bit(0, hub->event_bits) == 0)
2786 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2787 dev_err (hub_dev, "get_hub_status failed\n");
2789 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2790 dev_dbg (hub_dev, "power change\n");
2791 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
2793 if (hubchange & HUB_CHANGE_OVERCURRENT) {
2794 dev_dbg (hub_dev, "overcurrent change\n");
2795 msleep(500); /* Cool down */
2796 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
2801 hub->activating = 0;
2803 /* If this is a root hub, tell the HCD it's okay to
2804 * re-enable port-change interrupts now. */
2806 usb_enable_root_hub_irq(hdev->bus);
2809 usb_unlock_device(hdev);
2812 } /* end while (1) */
2815 static int hub_thread(void *__unused)
2819 wait_event_interruptible(khubd_wait,
2820 !list_empty(&hub_event_list) ||
2821 kthread_should_stop());
2823 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
2825 pr_debug("%s: khubd exiting\n", usbcore_name);
2829 static struct usb_device_id hub_id_table [] = {
2830 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
2831 .bDeviceClass = USB_CLASS_HUB},
2832 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2833 .bInterfaceClass = USB_CLASS_HUB},
2834 { } /* Terminating entry */
2837 MODULE_DEVICE_TABLE (usb, hub_id_table);
2839 static struct usb_driver hub_driver = {
2840 .owner = THIS_MODULE,
2843 .disconnect = hub_disconnect,
2844 .suspend = hub_suspend,
2845 .resume = hub_resume,
2847 .id_table = hub_id_table,
2850 int usb_hub_init(void)
2852 if (usb_register(&hub_driver) < 0) {
2853 printk(KERN_ERR "%s: can't register hub driver\n",
2858 khubd_task = kthread_run(hub_thread, NULL, "khubd");
2859 if (!IS_ERR(khubd_task))
2862 /* Fall through if kernel_thread failed */
2863 usb_deregister(&hub_driver);
2864 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
2869 void usb_hub_cleanup(void)
2871 kthread_stop(khubd_task);
2874 * Hub resources are freed for us by usb_deregister. It calls
2875 * usb_driver_purge on every device which in turn calls that
2876 * devices disconnect function if it is using this driver.
2877 * The hub_disconnect function takes care of releasing the
2878 * individual hub resources. -greg
2880 usb_deregister(&hub_driver);
2881 } /* usb_hub_cleanup() */
2883 static int config_descriptors_changed(struct usb_device *udev)
2887 struct usb_config_descriptor *buf;
2889 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2890 if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
2891 len = le16_to_cpu(udev->config[index].desc.wTotalLength);
2893 buf = kmalloc (len, SLAB_KERNEL);
2895 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
2896 /* assume the worst */
2899 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2901 int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
2903 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
2905 if (length < old_length) {
2906 dev_dbg(&udev->dev, "config index %d, error %d\n",
2910 if (memcmp (buf, udev->rawdescriptors[index], old_length)
2912 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
2913 index, buf->bConfigurationValue);
2918 return index != udev->descriptor.bNumConfigurations;
2922 * usb_reset_device - perform a USB port reset to reinitialize a device
2923 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2925 * WARNING - don't reset any device unless drivers for all of its
2926 * interfaces are expecting that reset! Maybe some driver->reset()
2927 * method should eventually help ensure sufficient cooperation.
2929 * Do a port reset, reassign the device's address, and establish its
2930 * former operating configuration. If the reset fails, or the device's
2931 * descriptors change from their values before the reset, or the original
2932 * configuration and altsettings cannot be restored, a flag will be set
2933 * telling khubd to pretend the device has been disconnected and then
2934 * re-connected. All drivers will be unbound, and the device will be
2935 * re-enumerated and probed all over again.
2937 * Returns 0 if the reset succeeded, -ENODEV if the device has been
2938 * flagged for logical disconnection, or some other negative error code
2939 * if the reset wasn't even attempted.
2941 * The caller must own the device lock. For example, it's safe to use
2942 * this from a driver probe() routine after downloading new firmware.
2943 * For calls that might not occur during probe(), drivers should lock
2944 * the device using usb_lock_device_for_reset().
2946 int usb_reset_device(struct usb_device *udev)
2948 struct usb_device *parent_hdev = udev->parent;
2949 struct usb_hub *parent_hub;
2950 struct usb_device_descriptor descriptor = udev->descriptor;
2951 struct usb_hub *hub = NULL;
2952 int i, ret = 0, port1 = -1;
2954 if (udev->state == USB_STATE_NOTATTACHED ||
2955 udev->state == USB_STATE_SUSPENDED) {
2956 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
2962 /* this requires hcd-specific logic; see OHCI hc_restart() */
2963 dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
2967 for (i = 0; i < parent_hdev->maxchild; i++)
2968 if (parent_hdev->children[i] == udev) {
2974 /* If this ever happens, it's very bad */
2975 dev_err(&udev->dev, "Can't locate device's port!\n");
2978 parent_hub = hdev_to_hub(parent_hdev);
2980 /* If we're resetting an active hub, take some special actions */
2981 if (udev->actconfig &&
2982 udev->actconfig->interface[0]->dev.driver ==
2983 &hub_driver.driver &&
2984 (hub = hdev_to_hub(udev)) != NULL) {
2988 set_bit(port1, parent_hub->busy_bits);
2989 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
2991 /* ep0 maxpacket size may change; let the HCD know about it.
2992 * Other endpoints will be handled by re-enumeration. */
2994 ret = hub_port_init(parent_hub, udev, port1, i);
2998 clear_bit(port1, parent_hub->busy_bits);
3002 /* Device might have changed firmware (DFU or similar) */
3003 if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
3004 || config_descriptors_changed (udev)) {
3005 dev_info(&udev->dev, "device firmware changed\n");
3006 udev->descriptor = descriptor; /* for disconnect() calls */
3010 if (!udev->actconfig)
3013 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3014 USB_REQ_SET_CONFIGURATION, 0,
3015 udev->actconfig->desc.bConfigurationValue, 0,
3016 NULL, 0, USB_CTRL_SET_TIMEOUT);
3019 "can't restore configuration #%d (error=%d)\n",
3020 udev->actconfig->desc.bConfigurationValue, ret);
3023 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3025 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3026 struct usb_interface *intf = udev->actconfig->interface[i];
3027 struct usb_interface_descriptor *desc;
3029 /* set_interface resets host side toggle even
3030 * for altsetting zero. the interface may have no driver.
3032 desc = &intf->cur_altsetting->desc;
3033 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3034 desc->bAlternateSetting);
3036 dev_err(&udev->dev, "failed to restore interface %d "
3037 "altsetting %d (error=%d)\n",
3038 desc->bInterfaceNumber,
3039 desc->bAlternateSetting,
3047 hub_post_reset(hub);
3051 hub_port_logical_disconnect(parent_hub, port1);