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;
439 u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
441 /* if hub supports power switching, enable power on each port */
442 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2) {
443 dev_dbg(hub->intfdev, "enabling power on all ports\n");
444 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
445 set_port_feature(hub->hdev, port1,
446 USB_PORT_FEAT_POWER);
449 /* Wait at least 100 msec for power to become stable */
450 msleep(max(pgood_delay, (unsigned) 100));
453 static inline void __hub_quiesce(struct usb_hub *hub)
455 /* (nonblocking) khubd and related activity won't re-trigger */
458 hub->resume_root_hub = 0;
461 static void hub_quiesce(struct usb_hub *hub)
463 /* (blocking) stop khubd and related activity */
465 usb_kill_urb(hub->urb);
466 if (hub->has_indicators)
467 cancel_delayed_work(&hub->leds);
468 if (hub->has_indicators || hub->tt.hub)
469 flush_scheduled_work();
472 static void hub_activate(struct usb_hub *hub)
478 hub->resume_root_hub = 0;
479 status = usb_submit_urb(hub->urb, GFP_NOIO);
481 dev_err(hub->intfdev, "activate --> %d\n", status);
482 if (hub->has_indicators && blinkenlights)
483 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
485 /* scan all ports ASAP */
489 static int hub_hub_status(struct usb_hub *hub,
490 u16 *status, u16 *change)
494 ret = get_hub_status(hub->hdev, &hub->status->hub);
496 dev_err (hub->intfdev,
497 "%s failed (err = %d)\n", __FUNCTION__, ret);
499 *status = le16_to_cpu(hub->status->hub.wHubStatus);
500 *change = le16_to_cpu(hub->status->hub.wHubChange);
506 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
508 struct usb_device *hdev = hub->hdev;
511 if (hdev->children[port1-1] && set_state) {
512 usb_set_device_state(hdev->children[port1-1],
513 USB_STATE_NOTATTACHED);
515 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
517 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
523 static int hub_configure(struct usb_hub *hub,
524 struct usb_endpoint_descriptor *endpoint)
526 struct usb_device *hdev = hub->hdev;
527 struct device *hub_dev = hub->intfdev;
528 u16 hubstatus, hubchange;
529 u16 wHubCharacteristics;
534 hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
537 message = "can't allocate hub irq buffer";
542 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
544 message = "can't kmalloc hub status buffer";
549 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
550 if (!hub->descriptor) {
551 message = "can't kmalloc hub descriptor";
556 /* Request the entire hub descriptor.
557 * hub->descriptor can handle USB_MAXCHILDREN ports,
558 * but the hub can/will return fewer bytes here.
560 ret = get_hub_descriptor(hdev, hub->descriptor,
561 sizeof(*hub->descriptor));
563 message = "can't read hub descriptor";
565 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
566 message = "hub has too many ports!";
571 hdev->maxchild = hub->descriptor->bNbrPorts;
572 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
573 (hdev->maxchild == 1) ? "" : "s");
575 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
577 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
579 char portstr [USB_MAXCHILDREN + 1];
581 for (i = 0; i < hdev->maxchild; i++)
582 portstr[i] = hub->descriptor->DeviceRemovable
583 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
585 portstr[hdev->maxchild] = 0;
586 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
588 dev_dbg(hub_dev, "standalone hub\n");
590 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
592 dev_dbg(hub_dev, "ganged power switching\n");
595 dev_dbg(hub_dev, "individual port power switching\n");
599 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
603 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
605 dev_dbg(hub_dev, "global over-current protection\n");
608 dev_dbg(hub_dev, "individual port over-current protection\n");
612 dev_dbg(hub_dev, "no over-current protection\n");
616 spin_lock_init (&hub->tt.lock);
617 INIT_LIST_HEAD (&hub->tt.clear_list);
618 INIT_WORK (&hub->tt.kevent, hub_tt_kevent, hub);
619 switch (hdev->descriptor.bDeviceProtocol) {
623 dev_dbg(hub_dev, "Single TT\n");
627 ret = usb_set_interface(hdev, 0, 1);
629 dev_dbg(hub_dev, "TT per port\n");
632 dev_err(hub_dev, "Using single TT (err %d)\n",
637 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
638 hdev->descriptor.bDeviceProtocol);
642 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
643 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
644 case HUB_TTTT_8_BITS:
645 if (hdev->descriptor.bDeviceProtocol != 0) {
646 hub->tt.think_time = 666;
647 dev_dbg(hub_dev, "TT requires at most %d "
648 "FS bit times (%d ns)\n",
649 8, hub->tt.think_time);
652 case HUB_TTTT_16_BITS:
653 hub->tt.think_time = 666 * 2;
654 dev_dbg(hub_dev, "TT requires at most %d "
655 "FS bit times (%d ns)\n",
656 16, hub->tt.think_time);
658 case HUB_TTTT_24_BITS:
659 hub->tt.think_time = 666 * 3;
660 dev_dbg(hub_dev, "TT requires at most %d "
661 "FS bit times (%d ns)\n",
662 24, hub->tt.think_time);
664 case HUB_TTTT_32_BITS:
665 hub->tt.think_time = 666 * 4;
666 dev_dbg(hub_dev, "TT requires at most %d "
667 "FS bit times (%d ns)\n",
668 32, hub->tt.think_time);
672 /* probe() zeroes hub->indicator[] */
673 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
674 hub->has_indicators = 1;
675 dev_dbg(hub_dev, "Port indicators are supported\n");
678 dev_dbg(hub_dev, "power on to power good time: %dms\n",
679 hub->descriptor->bPwrOn2PwrGood * 2);
681 /* power budgeting mostly matters with bus-powered hubs,
682 * and battery-powered root hubs (may provide just 8 mA).
684 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
686 message = "can't get hub status";
689 le16_to_cpus(&hubstatus);
690 if (hdev == hdev->bus->root_hub) {
691 struct usb_hcd *hcd =
692 container_of(hdev->bus, struct usb_hcd, self);
694 hub->power_budget = min(500u, hcd->power_budget) / 2;
695 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
696 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
697 hub->descriptor->bHubContrCurrent);
698 hub->power_budget = (501 - hub->descriptor->bHubContrCurrent)
701 if (hub->power_budget)
702 dev_dbg(hub_dev, "%dmA bus power budget for children\n",
703 hub->power_budget * 2);
706 ret = hub_hub_status(hub, &hubstatus, &hubchange);
708 message = "can't get hub status";
712 /* local power status reports aren't always correct */
713 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
714 dev_dbg(hub_dev, "local power source is %s\n",
715 (hubstatus & HUB_STATUS_LOCAL_POWER)
716 ? "lost (inactive)" : "good");
718 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
719 dev_dbg(hub_dev, "%sover-current condition exists\n",
720 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
722 /* set up the interrupt endpoint */
723 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
724 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
726 if (maxp > sizeof(*hub->buffer))
727 maxp = sizeof(*hub->buffer);
729 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
731 message = "couldn't allocate interrupt urb";
736 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
737 hub, endpoint->bInterval);
738 hub->urb->transfer_dma = hub->buffer_dma;
739 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
741 /* maybe cycle the hub leds */
742 if (hub->has_indicators && blinkenlights)
743 hub->indicator [0] = INDICATOR_CYCLE;
750 dev_err (hub_dev, "config failed, %s (err %d)\n",
752 /* hub_disconnect() frees urb and descriptor */
756 static unsigned highspeed_hubs;
758 /* Called after the hub driver is unbound from a hub with children */
759 static void hub_remove_children_work(void *__hub)
761 struct usb_hub *hub = __hub;
762 struct usb_device *hdev = hub->hdev;
767 usb_lock_device(hdev);
768 for (i = 0; i < hdev->maxchild; ++i) {
769 if (hdev->children[i])
770 usb_disconnect(&hdev->children[i]);
772 usb_unlock_device(hdev);
776 static void hub_disconnect(struct usb_interface *intf)
778 struct usb_hub *hub = usb_get_intfdata (intf);
779 struct usb_device *hdev;
782 usb_set_intfdata (intf, NULL);
785 if (hdev->speed == USB_SPEED_HIGH)
789 usb_free_urb(hub->urb);
792 spin_lock_irq(&hub_event_lock);
793 list_del_init(&hub->event_list);
794 spin_unlock_irq(&hub_event_lock);
796 kfree(hub->descriptor);
797 hub->descriptor = NULL;
803 usb_buffer_free(hdev, sizeof(*hub->buffer), hub->buffer,
808 /* If there are any children then this is an unbind only, not a
809 * physical disconnection. The active ports must be disabled
810 * and later on we must call usb_disconnect(). We can't call
811 * it now because we may not hold the hub's device lock.
814 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
815 if (hdev->children[port1 - 1]) {
817 hub_port_disable(hub, port1, 1);
824 /* Reuse the hub->leds work_struct for our own purposes */
825 INIT_WORK(&hub->leds, hub_remove_children_work, hub);
826 schedule_work(&hub->leds);
831 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
833 struct usb_host_interface *desc;
834 struct usb_endpoint_descriptor *endpoint;
835 struct usb_device *hdev;
838 desc = intf->cur_altsetting;
839 hdev = interface_to_usbdev(intf);
841 /* Some hubs have a subclass of 1, which AFAICT according to the */
842 /* specs is not defined, but it works */
843 if ((desc->desc.bInterfaceSubClass != 0) &&
844 (desc->desc.bInterfaceSubClass != 1)) {
846 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
850 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
851 if (desc->desc.bNumEndpoints != 1)
852 goto descriptor_error;
854 endpoint = &desc->endpoint[0].desc;
856 /* Output endpoint? Curiouser and curiouser.. */
857 if (!(endpoint->bEndpointAddress & USB_DIR_IN))
858 goto descriptor_error;
860 /* If it's not an interrupt endpoint, we'd better punt! */
861 if ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
862 != USB_ENDPOINT_XFER_INT)
863 goto descriptor_error;
866 dev_info (&intf->dev, "USB hub found\n");
868 hub = kmalloc(sizeof(*hub), GFP_KERNEL);
870 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
874 memset(hub, 0, sizeof(*hub));
876 INIT_LIST_HEAD(&hub->event_list);
877 hub->intfdev = &intf->dev;
879 INIT_WORK(&hub->leds, led_work, hub);
881 usb_set_intfdata (intf, hub);
883 if (hdev->speed == USB_SPEED_HIGH)
886 if (hub_configure(hub, endpoint) >= 0)
889 hub_disconnect (intf);
894 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
896 struct usb_device *hdev = interface_to_usbdev (intf);
898 /* assert ifno == 0 (part of hub spec) */
900 case USBDEVFS_HUB_PORTINFO: {
901 struct usbdevfs_hub_portinfo *info = user_data;
904 spin_lock_irq(&device_state_lock);
905 if (hdev->devnum <= 0)
908 info->nports = hdev->maxchild;
909 for (i = 0; i < info->nports; i++) {
910 if (hdev->children[i] == NULL)
914 hdev->children[i]->devnum;
917 spin_unlock_irq(&device_state_lock);
919 return info->nports + 1;
927 /* caller has locked the hub device */
928 static void hub_pre_reset(struct usb_hub *hub)
930 struct usb_device *hdev = hub->hdev;
933 for (i = 0; i < hdev->maxchild; ++i) {
934 if (hdev->children[i])
935 usb_disconnect(&hdev->children[i]);
940 /* caller has locked the hub device */
941 static void hub_post_reset(struct usb_hub *hub)
948 /* grab device/port lock, returning index of that port (zero based).
949 * protects the upstream link used by this device from concurrent
950 * tree operations like suspend, resume, reset, and disconnect, which
951 * apply to everything downstream of a given port.
953 static int locktree(struct usb_device *udev)
956 struct usb_device *hdev;
961 /* root hub is always the first lock in the series */
964 usb_lock_device(udev);
968 /* on the path from root to us, lock everything from
969 * top down, dropping parent locks when not needed
974 for (t = 0; t < hdev->maxchild; t++) {
975 if (hdev->children[t] == udev) {
976 /* everything is fail-fast once disconnect
979 if (udev->state == USB_STATE_NOTATTACHED)
982 /* when everyone grabs locks top->bottom,
983 * non-overlapping work may be concurrent
985 down(&udev->serialize);
986 up(&hdev->serialize);
990 usb_unlock_device(hdev);
994 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
998 for (i = 0; i < udev->maxchild; ++i) {
999 if (udev->children[i])
1000 recursively_mark_NOTATTACHED(udev->children[i]);
1002 udev->state = USB_STATE_NOTATTACHED;
1006 * usb_set_device_state - change a device's current state (usbcore, hcds)
1007 * @udev: pointer to device whose state should be changed
1008 * @new_state: new state value to be stored
1010 * udev->state is _not_ fully protected by the device lock. Although
1011 * most transitions are made only while holding the lock, the state can
1012 * can change to USB_STATE_NOTATTACHED at almost any time. This
1013 * is so that devices can be marked as disconnected as soon as possible,
1014 * without having to wait for any semaphores to be released. As a result,
1015 * all changes to any device's state must be protected by the
1016 * device_state_lock spinlock.
1018 * Once a device has been added to the device tree, all changes to its state
1019 * should be made using this routine. The state should _not_ be set directly.
1021 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1022 * Otherwise udev->state is set to new_state, and if new_state is
1023 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1024 * to USB_STATE_NOTATTACHED.
1026 void usb_set_device_state(struct usb_device *udev,
1027 enum usb_device_state new_state)
1029 unsigned long flags;
1031 spin_lock_irqsave(&device_state_lock, flags);
1032 if (udev->state == USB_STATE_NOTATTACHED)
1034 else if (new_state != USB_STATE_NOTATTACHED) {
1035 udev->state = new_state;
1036 if (new_state == USB_STATE_CONFIGURED)
1037 device_init_wakeup(&udev->dev,
1038 (udev->actconfig->desc.bmAttributes
1039 & USB_CONFIG_ATT_WAKEUP));
1040 else if (new_state != USB_STATE_SUSPENDED)
1041 device_init_wakeup(&udev->dev, 0);
1043 recursively_mark_NOTATTACHED(udev);
1044 spin_unlock_irqrestore(&device_state_lock, flags);
1046 EXPORT_SYMBOL(usb_set_device_state);
1049 static void choose_address(struct usb_device *udev)
1052 struct usb_bus *bus = udev->bus;
1054 /* If khubd ever becomes multithreaded, this will need a lock */
1056 /* Try to allocate the next devnum beginning at bus->devnum_next. */
1057 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1060 devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
1062 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1065 set_bit(devnum, bus->devmap.devicemap);
1066 udev->devnum = devnum;
1070 static void release_address(struct usb_device *udev)
1072 if (udev->devnum > 0) {
1073 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1079 * usb_disconnect - disconnect a device (usbcore-internal)
1080 * @pdev: pointer to device being disconnected
1081 * Context: !in_interrupt ()
1083 * Something got disconnected. Get rid of it and all of its children.
1085 * If *pdev is a normal device then the parent hub must already be locked.
1086 * If *pdev is a root hub then this routine will acquire the
1087 * usb_bus_list_lock on behalf of the caller.
1089 * Only hub drivers (including virtual root hub drivers for host
1090 * controllers) should ever call this.
1092 * This call is synchronous, and may not be used in an interrupt context.
1094 void usb_disconnect(struct usb_device **pdev)
1096 struct usb_device *udev = *pdev;
1100 pr_debug ("%s nodev\n", __FUNCTION__);
1104 /* mark the device as inactive, so any further urb submissions for
1105 * this device (and any of its children) will fail immediately.
1106 * this quiesces everyting except pending urbs.
1108 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1110 /* lock the bus list on behalf of HCDs unregistering their root hubs */
1111 if (!udev->parent) {
1112 down(&usb_bus_list_lock);
1113 usb_lock_device(udev);
1115 down(&udev->serialize);
1117 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1119 /* Free up all the children before we remove this device */
1120 for (i = 0; i < USB_MAXCHILDREN; i++) {
1121 if (udev->children[i])
1122 usb_disconnect(&udev->children[i]);
1125 /* deallocate hcd/hardware state ... nuking all pending urbs and
1126 * cleaning up all state associated with the current configuration
1127 * so that the hardware is now fully quiesced.
1129 usb_disable_device(udev, 0);
1131 /* Free the device number, remove the /proc/bus/usb entry and
1132 * the sysfs attributes, and delete the parent's children[]
1133 * (or root_hub) pointer.
1135 dev_dbg (&udev->dev, "unregistering device\n");
1136 release_address(udev);
1137 usbfs_remove_device(udev);
1138 usbdev_remove(udev);
1139 usb_remove_sysfs_dev_files(udev);
1141 /* Avoid races with recursively_mark_NOTATTACHED() */
1142 spin_lock_irq(&device_state_lock);
1144 spin_unlock_irq(&device_state_lock);
1146 if (!udev->parent) {
1147 usb_unlock_device(udev);
1148 up(&usb_bus_list_lock);
1150 up(&udev->serialize);
1152 device_unregister(&udev->dev);
1155 static int choose_configuration(struct usb_device *udev)
1159 /* NOTE: this should interact with hub power budgeting */
1161 c = udev->config[0].desc.bConfigurationValue;
1162 if (udev->descriptor.bNumConfigurations != 1) {
1163 for (i = 0; i < udev->descriptor.bNumConfigurations; i++) {
1164 struct usb_interface_descriptor *desc;
1166 /* heuristic: Linux is more likely to have class
1167 * drivers, so avoid vendor-specific interfaces.
1169 desc = &udev->config[i].intf_cache[0]
1171 if (desc->bInterfaceClass == USB_CLASS_VENDOR_SPEC)
1173 /* COMM/2/all is CDC ACM, except 0xff is MSFT RNDIS.
1174 * MSFT needs this to be the first config; never use
1175 * it as the default unless Linux has host-side RNDIS.
1176 * A second config would ideally be CDC-Ethernet, but
1177 * may instead be the "vendor specific" CDC subset
1178 * long used by ARM Linux for sa1100 or pxa255.
1180 if (desc->bInterfaceClass == USB_CLASS_COMM
1181 && desc->bInterfaceSubClass == 2
1182 && desc->bInterfaceProtocol == 0xff) {
1183 c = udev->config[1].desc.bConfigurationValue;
1186 c = udev->config[i].desc.bConfigurationValue;
1189 dev_info(&udev->dev,
1190 "configuration #%d chosen from %d choices\n",
1191 c, udev->descriptor.bNumConfigurations);
1197 static void show_string(struct usb_device *udev, char *id, char *string)
1201 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1205 static inline void show_string(struct usb_device *udev, char *id, char *string)
1209 static void get_string(struct usb_device *udev, char **string, int index)
1215 buf = kmalloc(256, GFP_KERNEL);
1218 if (usb_string(udev, index, buf, 256) > 0)
1225 #ifdef CONFIG_USB_OTG
1226 #include "otg_whitelist.h"
1230 * usb_new_device - perform initial device setup (usbcore-internal)
1231 * @udev: newly addressed device (in ADDRESS state)
1233 * This is called with devices which have been enumerated, but not yet
1234 * configured. The device descriptor is available, but not descriptors
1235 * for any device configuration. The caller must have locked udev and
1236 * either the parent hub (if udev is a normal device) or else the
1237 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1238 * udev has already been installed, but udev is not yet visible through
1239 * sysfs or other filesystem code.
1241 * Returns 0 for success (device is configured and listed, with its
1242 * interfaces, in sysfs); else a negative errno value.
1244 * This call is synchronous, and may not be used in an interrupt context.
1246 * Only the hub driver should ever call this; root hub registration
1247 * uses it indirectly.
1249 int usb_new_device(struct usb_device *udev)
1254 err = usb_get_configuration(udev);
1256 dev_err(&udev->dev, "can't read configurations, error %d\n",
1261 /* read the standard strings and cache them if present */
1262 get_string(udev, &udev->product, udev->descriptor.iProduct);
1263 get_string(udev, &udev->manufacturer, udev->descriptor.iManufacturer);
1264 get_string(udev, &udev->serial, udev->descriptor.iSerialNumber);
1266 /* Tell the world! */
1267 dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
1268 "SerialNumber=%d\n",
1269 udev->descriptor.iManufacturer,
1270 udev->descriptor.iProduct,
1271 udev->descriptor.iSerialNumber);
1272 show_string(udev, "Product", udev->product);
1273 show_string(udev, "Manufacturer", udev->manufacturer);
1274 show_string(udev, "SerialNumber", udev->serial);
1276 #ifdef CONFIG_USB_OTG
1278 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1279 * to wake us after we've powered off VBUS; and HNP, switching roles
1280 * "host" to "peripheral". The OTG descriptor helps figure this out.
1282 if (!udev->bus->is_b_host
1284 && udev->parent == udev->bus->root_hub) {
1285 struct usb_otg_descriptor *desc = 0;
1286 struct usb_bus *bus = udev->bus;
1288 /* descriptor may appear anywhere in config */
1289 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1290 le16_to_cpu(udev->config[0].desc.wTotalLength),
1291 USB_DT_OTG, (void **) &desc) == 0) {
1292 if (desc->bmAttributes & USB_OTG_HNP) {
1294 struct usb_device *root = udev->parent;
1296 for (port1 = 1; port1 <= root->maxchild;
1298 if (root->children[port1-1] == udev)
1302 dev_info(&udev->dev,
1303 "Dual-Role OTG device on %sHNP port\n",
1304 (port1 == bus->otg_port)
1307 /* enable HNP before suspend, it's simpler */
1308 if (port1 == bus->otg_port)
1309 bus->b_hnp_enable = 1;
1310 err = usb_control_msg(udev,
1311 usb_sndctrlpipe(udev, 0),
1312 USB_REQ_SET_FEATURE, 0,
1314 ? USB_DEVICE_B_HNP_ENABLE
1315 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1316 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1318 /* OTG MESSAGE: report errors here,
1319 * customize to match your product.
1321 dev_info(&udev->dev,
1322 "can't set HNP mode; %d\n",
1324 bus->b_hnp_enable = 0;
1330 if (!is_targeted(udev)) {
1332 /* Maybe it can talk to us, though we can't talk to it.
1333 * (Includes HNP test device.)
1335 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1336 static int __usb_suspend_device(struct usb_device *,
1338 err = __usb_suspend_device(udev, udev->bus->otg_port);
1340 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1347 /* put device-specific files into sysfs */
1348 err = device_add (&udev->dev);
1350 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1353 usb_create_sysfs_dev_files (udev);
1355 /* choose and set the configuration. that registers the interfaces
1356 * with the driver core, and lets usb device drivers bind to them.
1358 c = choose_configuration(udev);
1360 dev_warn(&udev->dev,
1361 "can't choose an initial configuration\n");
1363 err = usb_set_configuration(udev, c);
1365 dev_err(&udev->dev, "can't set config #%d, error %d\n",
1367 usb_remove_sysfs_dev_files(udev);
1368 device_del(&udev->dev);
1373 /* USB device state == configured ... usable */
1375 /* add a /proc/bus/usb entry */
1377 usbfs_add_device(udev);
1381 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1386 static int hub_port_status(struct usb_hub *hub, int port1,
1387 u16 *status, u16 *change)
1391 ret = get_port_status(hub->hdev, port1, &hub->status->port);
1393 dev_err (hub->intfdev,
1394 "%s failed (err = %d)\n", __FUNCTION__, ret);
1396 *status = le16_to_cpu(hub->status->port.wPortStatus);
1397 *change = le16_to_cpu(hub->status->port.wPortChange);
1403 #define PORT_RESET_TRIES 5
1404 #define SET_ADDRESS_TRIES 2
1405 #define GET_DESCRIPTOR_TRIES 2
1406 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1407 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1409 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1410 #define HUB_SHORT_RESET_TIME 10
1411 #define HUB_LONG_RESET_TIME 200
1412 #define HUB_RESET_TIMEOUT 500
1414 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1415 struct usb_device *udev, unsigned int delay)
1417 int delay_time, ret;
1421 for (delay_time = 0;
1422 delay_time < HUB_RESET_TIMEOUT;
1423 delay_time += delay) {
1424 /* wait to give the device a chance to reset */
1427 /* read and decode port status */
1428 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1432 /* Device went away? */
1433 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1436 /* bomb out completely if something weird happened */
1437 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1440 /* if we`ve finished resetting, then break out of the loop */
1441 if (!(portstatus & USB_PORT_STAT_RESET) &&
1442 (portstatus & USB_PORT_STAT_ENABLE)) {
1443 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1444 udev->speed = USB_SPEED_HIGH;
1445 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1446 udev->speed = USB_SPEED_LOW;
1448 udev->speed = USB_SPEED_FULL;
1452 /* switch to the long delay after two short delay failures */
1453 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1454 delay = HUB_LONG_RESET_TIME;
1456 dev_dbg (hub->intfdev,
1457 "port %d not reset yet, waiting %dms\n",
1464 static int hub_port_reset(struct usb_hub *hub, int port1,
1465 struct usb_device *udev, unsigned int delay)
1469 /* Reset the port */
1470 for (i = 0; i < PORT_RESET_TRIES; i++) {
1471 status = set_port_feature(hub->hdev,
1472 port1, USB_PORT_FEAT_RESET);
1474 dev_err(hub->intfdev,
1475 "cannot reset port %d (err = %d)\n",
1478 status = hub_port_wait_reset(hub, port1, udev, delay);
1479 if (status && status != -ENOTCONN)
1480 dev_dbg(hub->intfdev,
1481 "port_wait_reset: err = %d\n",
1485 /* return on disconnect or reset */
1488 /* TRSTRCY = 10 ms; plus some extra */
1493 clear_port_feature(hub->hdev,
1494 port1, USB_PORT_FEAT_C_RESET);
1495 /* FIXME need disconnect() for NOTATTACHED device */
1496 usb_set_device_state(udev, status
1497 ? USB_STATE_NOTATTACHED
1498 : USB_STATE_DEFAULT);
1502 dev_dbg (hub->intfdev,
1503 "port %d not enabled, trying reset again...\n",
1505 delay = HUB_LONG_RESET_TIME;
1508 dev_err (hub->intfdev,
1509 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1516 * Disable a port and mark a logical connnect-change event, so that some
1517 * time later khubd will disconnect() any existing usb_device on the port
1518 * and will re-enumerate if there actually is a device attached.
1520 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
1522 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
1523 hub_port_disable(hub, port1, 1);
1525 /* FIXME let caller ask to power down the port:
1526 * - some devices won't enumerate without a VBUS power cycle
1527 * - SRP saves power that way
1528 * - ... new call, TBD ...
1529 * That's easy if this hub can switch power per-port, and
1530 * khubd reactivates the port later (timer, SRP, etc).
1531 * Powerdown must be optional, because of reset/DFU.
1534 set_bit(port1, hub->change_bits);
1539 #ifdef CONFIG_USB_SUSPEND
1542 * Selective port suspend reduces power; most suspended devices draw
1543 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1544 * All devices below the suspended port are also suspended.
1546 * Devices leave suspend state when the host wakes them up. Some devices
1547 * also support "remote wakeup", where the device can activate the USB
1548 * tree above them to deliver data, such as a keypress or packet. In
1549 * some cases, this wakes the USB host.
1551 static int hub_port_suspend(struct usb_hub *hub, int port1,
1552 struct usb_device *udev)
1556 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1558 /* enable remote wakeup when appropriate; this lets the device
1559 * wake up the upstream hub (including maybe the root hub).
1561 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1562 * we don't explicitly enable it here.
1564 if (device_may_wakeup(&udev->dev)) {
1565 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1566 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1567 USB_DEVICE_REMOTE_WAKEUP, 0,
1569 USB_CTRL_SET_TIMEOUT);
1572 "won't remote wakeup, status %d\n",
1577 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1579 dev_dbg(hub->intfdev,
1580 "can't suspend port %d, status %d\n",
1582 /* paranoia: "should not happen" */
1583 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1584 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1585 USB_DEVICE_REMOTE_WAKEUP, 0,
1587 USB_CTRL_SET_TIMEOUT);
1589 /* device has up to 10 msec to fully suspend */
1590 dev_dbg(&udev->dev, "usb suspend\n");
1591 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1598 * Devices on USB hub ports have only one "suspend" state, corresponding
1599 * to ACPI D2, "may cause the device to lose some context".
1600 * State transitions include:
1602 * - suspend, resume ... when the VBUS power link stays live
1603 * - suspend, disconnect ... VBUS lost
1605 * Once VBUS drop breaks the circuit, the port it's using has to go through
1606 * normal re-enumeration procedures, starting with enabling VBUS power.
1607 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1608 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1609 * timer, no SRP, no requests through sysfs.
1611 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1612 * the root hub for their bus goes into global suspend ... so we don't
1613 * (falsely) update the device power state to say it suspended.
1615 static int __usb_suspend_device (struct usb_device *udev, int port1)
1619 /* caller owns the udev device lock */
1623 if (udev->state == USB_STATE_SUSPENDED
1624 || udev->state == USB_STATE_NOTATTACHED) {
1628 /* all interfaces must already be suspended */
1629 if (udev->actconfig) {
1632 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1633 struct usb_interface *intf;
1635 intf = udev->actconfig->interface[i];
1636 if (is_active(intf)) {
1637 dev_dbg(&intf->dev, "nyet suspended\n");
1643 /* we only change a device's upstream USB link.
1644 * root hubs have no upstream USB link.
1647 status = hub_port_suspend(hdev_to_hub(udev->parent), port1,
1651 udev->dev.power.power_state = PMSG_SUSPEND;
1658 * usb_suspend_device - suspend a usb device
1659 * @udev: device that's no longer in active use
1660 * Context: must be able to sleep; device not locked; pm locks held
1662 * Suspends a USB device that isn't in active use, conserving power.
1663 * Devices may wake out of a suspend, if anything important happens,
1664 * using the remote wakeup mechanism. They may also be taken out of
1665 * suspend by the host, using usb_resume_device(). It's also routine
1666 * to disconnect devices while they are suspended.
1668 * This only affects the USB hardware for a device; its interfaces
1669 * (and, for hubs, child devices) must already have been suspended.
1671 * Suspending OTG devices may trigger HNP, if that's been enabled
1672 * between a pair of dual-role devices. That will change roles, such
1673 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1675 * Returns 0 on success, else negative errno.
1677 int usb_suspend_device(struct usb_device *udev)
1679 #ifdef CONFIG_USB_SUSPEND
1682 port1 = locktree(udev);
1686 status = __usb_suspend_device(udev, port1);
1687 usb_unlock_device(udev);
1690 /* NOTE: udev->state unchanged, it's not lying ... */
1691 udev->dev.power.power_state = PMSG_SUSPEND;
1698 * If the USB "suspend" state is in use (rather than "global suspend"),
1699 * many devices will be individually taken out of suspend state using
1700 * special" resume" signaling. These routines kick in shortly after
1701 * hardware resume signaling is finished, either because of selective
1702 * resume (by host) or remote wakeup (by device) ... now see what changed
1703 * in the tree that's rooted at this device.
1705 static int finish_device_resume(struct usb_device *udev)
1710 /* caller owns the udev device lock */
1711 dev_dbg(&udev->dev, "finish resume\n");
1713 /* usb ch9 identifies four variants of SUSPENDED, based on what
1714 * state the device resumes to. Linux currently won't see the
1715 * first two on the host side; they'd be inside hub_port_init()
1716 * during many timeouts, but khubd can't suspend until later.
1718 usb_set_device_state(udev, udev->actconfig
1719 ? USB_STATE_CONFIGURED
1720 : USB_STATE_ADDRESS);
1722 /* 10.5.4.5 says be sure devices in the tree are still there.
1723 * For now let's assume the device didn't go crazy on resume,
1724 * and device drivers will know about any resume quirks.
1726 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
1729 "gone after usb resume? status %d\n",
1731 else if (udev->actconfig) {
1733 int (*resume)(struct device *);
1735 le16_to_cpus(&devstatus);
1736 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)
1738 status = usb_control_msg(udev,
1739 usb_sndctrlpipe(udev, 0),
1740 USB_REQ_CLEAR_FEATURE,
1742 USB_DEVICE_REMOTE_WAKEUP, 0,
1744 USB_CTRL_SET_TIMEOUT);
1746 dev_dbg(&udev->dev, "disable remote "
1747 "wakeup, status %d\n", status);
1752 /* resume interface drivers; if this is a hub, it
1753 * may have a child resume event to deal with soon
1755 resume = udev->dev.bus->resume;
1756 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++)
1757 (void) resume(&udev->actconfig->interface[i]->dev);
1760 } else if (udev->devnum <= 0) {
1761 dev_dbg(&udev->dev, "bogus resume!\n");
1767 #ifdef CONFIG_USB_SUSPEND
1770 hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1774 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1776 /* see 7.1.7.7; affects power usage, but not budgeting */
1777 status = clear_port_feature(hub->hdev,
1778 port1, USB_PORT_FEAT_SUSPEND);
1780 dev_dbg(hub->intfdev,
1781 "can't resume port %d, status %d\n",
1787 /* drive resume for at least 20 msec */
1789 dev_dbg(&udev->dev, "RESUME\n");
1792 #define LIVE_FLAGS ( USB_PORT_STAT_POWER \
1793 | USB_PORT_STAT_ENABLE \
1794 | USB_PORT_STAT_CONNECTION)
1796 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1797 * stop resume signaling. Then finish the resume
1800 devstatus = portchange = 0;
1801 status = hub_port_status(hub, port1,
1802 &devstatus, &portchange);
1804 || (devstatus & LIVE_FLAGS) != LIVE_FLAGS
1805 || (devstatus & USB_PORT_STAT_SUSPEND) != 0
1807 dev_dbg(hub->intfdev,
1808 "port %d status %04x.%04x after resume, %d\n",
1809 port1, portchange, devstatus, status);
1811 /* TRSMRCY = 10 msec */
1814 status = finish_device_resume(udev);
1818 hub_port_logical_disconnect(hub, port1);
1826 * usb_resume_device - re-activate a suspended usb device
1827 * @udev: device to re-activate
1828 * Context: must be able to sleep; device not locked; pm locks held
1830 * This will re-activate the suspended device, increasing power usage
1831 * while letting drivers communicate again with its endpoints.
1832 * USB resume explicitly guarantees that the power session between
1833 * the host and the device is the same as it was when the device
1836 * Returns 0 on success, else negative errno.
1838 int usb_resume_device(struct usb_device *udev)
1842 port1 = locktree(udev);
1846 #ifdef CONFIG_USB_SUSPEND
1847 /* selective resume of one downstream hub-to-device port */
1849 if (udev->state == USB_STATE_SUSPENDED) {
1850 // NOTE swsusp may bork us, device state being wrong...
1851 // NOTE this fails if parent is also suspended...
1852 status = hub_port_resume(hdev_to_hub(udev->parent),
1858 status = finish_device_resume(udev);
1860 dev_dbg(&udev->dev, "can't resume, status %d\n",
1863 usb_unlock_device(udev);
1865 /* rebind drivers that had no suspend() */
1867 usb_lock_all_devices();
1868 bus_rescan_devices(&usb_bus_type);
1869 usb_unlock_all_devices();
1874 static int remote_wakeup(struct usb_device *udev)
1878 #ifdef CONFIG_USB_SUSPEND
1880 /* don't repeat RESUME sequence if this device
1881 * was already woken up by some other task
1883 down(&udev->serialize);
1884 if (udev->state == USB_STATE_SUSPENDED) {
1885 dev_dbg(&udev->dev, "RESUME (wakeup)\n");
1886 /* TRSMRCY = 10 msec */
1888 status = finish_device_resume(udev);
1890 up(&udev->serialize);
1895 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
1897 struct usb_hub *hub = usb_get_intfdata (intf);
1898 struct usb_device *hdev = hub->hdev;
1901 /* fail if children aren't already suspended */
1902 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1903 struct usb_device *udev;
1905 udev = hdev->children [port1-1];
1906 if (udev && (udev->dev.power.power_state.event
1908 #ifdef CONFIG_USB_SUSPEND
1909 || udev->state != USB_STATE_SUSPENDED
1912 dev_dbg(&intf->dev, "port %d nyet suspended\n", port1);
1917 /* "global suspend" of the downstream HC-to-USB interface */
1918 if (!hdev->parent) {
1919 struct usb_bus *bus = hdev->bus;
1920 if (bus && bus->op->hub_suspend) {
1921 int status = bus->op->hub_suspend (bus);
1924 dev_dbg(&hdev->dev, "'global' suspend %d\n",
1932 /* stop khubd and related activity */
1937 static int hub_resume(struct usb_interface *intf)
1939 struct usb_device *hdev = interface_to_usbdev(intf);
1940 struct usb_hub *hub = usb_get_intfdata (intf);
1943 /* "global resume" of the downstream HC-to-USB interface */
1944 if (!hdev->parent) {
1945 struct usb_bus *bus = hdev->bus;
1946 if (bus && bus->op->hub_resume) {
1947 status = bus->op->hub_resume (bus);
1949 dev_dbg(&intf->dev, "'global' resume %d\n",
1956 /* TRSMRCY = 10 msec */
1963 /* REVISIT: this recursion probably shouldn't exist. Remove
1964 * this code sometime, after retesting with different root and
1967 #ifdef CONFIG_USB_SUSPEND
1971 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1972 struct usb_device *udev;
1973 u16 portstat, portchange;
1975 udev = hdev->children [port1-1];
1976 status = hub_port_status(hub, port1, &portstat, &portchange);
1978 if (portchange & USB_PORT_STAT_C_SUSPEND) {
1979 clear_port_feature(hdev, port1,
1980 USB_PORT_FEAT_C_SUSPEND);
1981 portchange &= ~USB_PORT_STAT_C_SUSPEND;
1984 /* let khubd handle disconnects etc */
1989 if (!udev || status < 0)
1991 down (&udev->serialize);
1992 if (portstat & USB_PORT_STAT_SUSPEND)
1993 status = hub_port_resume(hub, port1, udev);
1995 status = finish_device_resume(udev);
1997 dev_dbg(&intf->dev, "resume port %d --> %d\n",
1999 hub_port_logical_disconnect(hub, port1);
2002 up(&udev->serialize);
2009 void usb_suspend_root_hub(struct usb_device *hdev)
2011 struct usb_hub *hub = hdev_to_hub(hdev);
2013 /* This also makes any led blinker stop retriggering. We're called
2014 * from irq, so the blinker might still be scheduled. Caller promises
2015 * that the root hub status URB will be canceled.
2018 mark_quiesced(to_usb_interface(hub->intfdev));
2021 void usb_resume_root_hub(struct usb_device *hdev)
2023 struct usb_hub *hub = hdev_to_hub(hdev);
2025 hub->resume_root_hub = 1;
2030 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2032 * Between connect detection and reset signaling there must be a delay
2033 * of 100ms at least for debounce and power-settling. The corresponding
2034 * timer shall restart whenever the downstream port detects a disconnect.
2036 * Apparently there are some bluetooth and irda-dongles and a number of
2037 * low-speed devices for which this debounce period may last over a second.
2038 * Not covered by the spec - but easy to deal with.
2040 * This implementation uses a 1500ms total debounce timeout; if the
2041 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2042 * every 25ms for transient disconnects. When the port status has been
2043 * unchanged for 100ms it returns the port status.
2046 #define HUB_DEBOUNCE_TIMEOUT 1500
2047 #define HUB_DEBOUNCE_STEP 25
2048 #define HUB_DEBOUNCE_STABLE 100
2050 static int hub_port_debounce(struct usb_hub *hub, int port1)
2053 int total_time, stable_time = 0;
2054 u16 portchange, portstatus;
2055 unsigned connection = 0xffff;
2057 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2058 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2062 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2063 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2064 stable_time += HUB_DEBOUNCE_STEP;
2065 if (stable_time >= HUB_DEBOUNCE_STABLE)
2069 connection = portstatus & USB_PORT_STAT_CONNECTION;
2072 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2073 clear_port_feature(hub->hdev, port1,
2074 USB_PORT_FEAT_C_CONNECTION);
2077 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2079 msleep(HUB_DEBOUNCE_STEP);
2082 dev_dbg (hub->intfdev,
2083 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2084 port1, total_time, stable_time, portstatus);
2086 if (stable_time < HUB_DEBOUNCE_STABLE)
2091 static void ep0_reinit(struct usb_device *udev)
2093 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
2094 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
2095 udev->ep_in[0] = udev->ep_out[0] = &udev->ep0;
2098 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2099 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2101 static int hub_set_address(struct usb_device *udev)
2105 if (udev->devnum == 0)
2107 if (udev->state == USB_STATE_ADDRESS)
2109 if (udev->state != USB_STATE_DEFAULT)
2111 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2112 USB_REQ_SET_ADDRESS, 0, udev->devnum, 0,
2113 NULL, 0, USB_CTRL_SET_TIMEOUT);
2115 usb_set_device_state(udev, USB_STATE_ADDRESS);
2121 /* Reset device, (re)assign address, get device descriptor.
2122 * Device connection must be stable, no more debouncing needed.
2123 * Returns device in USB_STATE_ADDRESS, except on error.
2125 * If this is called for an already-existing device (as part of
2126 * usb_reset_device), the caller must own the device lock. For a
2127 * newly detected device that is not accessible through any global
2128 * pointers, it's not necessary to lock the device.
2131 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2134 static DECLARE_MUTEX(usb_address0_sem);
2136 struct usb_device *hdev = hub->hdev;
2138 unsigned delay = HUB_SHORT_RESET_TIME;
2139 enum usb_device_speed oldspeed = udev->speed;
2141 /* root hub ports have a slightly longer reset period
2142 * (from USB 2.0 spec, section 7.1.7.5)
2144 if (!hdev->parent) {
2145 delay = HUB_ROOT_RESET_TIME;
2146 if (port1 == hdev->bus->otg_port)
2147 hdev->bus->b_hnp_enable = 0;
2150 /* Some low speed devices have problems with the quick delay, so */
2151 /* be a bit pessimistic with those devices. RHbug #23670 */
2152 if (oldspeed == USB_SPEED_LOW)
2153 delay = HUB_LONG_RESET_TIME;
2155 down(&usb_address0_sem);
2157 /* Reset the device; full speed may morph to high speed */
2158 retval = hub_port_reset(hub, port1, udev, delay);
2159 if (retval < 0) /* error or disconnect */
2161 /* success, speed is known */
2164 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2165 dev_dbg(&udev->dev, "device reset changed speed!\n");
2168 oldspeed = udev->speed;
2170 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2171 * it's fixed size except for full speed devices.
2173 switch (udev->speed) {
2174 case USB_SPEED_HIGH: /* fixed at 64 */
2175 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2177 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2178 /* to determine the ep0 maxpacket size, try to read
2179 * the device descriptor to get bMaxPacketSize0 and
2180 * then correct our initial guess.
2182 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2184 case USB_SPEED_LOW: /* fixed at 8 */
2185 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2191 dev_info (&udev->dev,
2192 "%s %s speed USB device using %s and address %d\n",
2193 (udev->config) ? "reset" : "new",
2194 ({ char *speed; switch (udev->speed) {
2195 case USB_SPEED_LOW: speed = "low"; break;
2196 case USB_SPEED_FULL: speed = "full"; break;
2197 case USB_SPEED_HIGH: speed = "high"; break;
2198 default: speed = "?"; break;
2200 udev->bus->controller->driver->name,
2203 /* Set up TT records, if needed */
2205 udev->tt = hdev->tt;
2206 udev->ttport = hdev->ttport;
2207 } else if (udev->speed != USB_SPEED_HIGH
2208 && hdev->speed == USB_SPEED_HIGH) {
2209 udev->tt = &hub->tt;
2210 udev->ttport = port1;
2213 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2214 * Because device hardware and firmware is sometimes buggy in
2215 * this area, and this is how Linux has done it for ages.
2216 * Change it cautiously.
2218 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2219 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2220 * so it may help with some non-standards-compliant devices.
2221 * Otherwise we start with SET_ADDRESS and then try to read the
2222 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2225 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2226 if (USE_NEW_SCHEME(retry_counter)) {
2227 struct usb_device_descriptor *buf;
2230 #define GET_DESCRIPTOR_BUFSIZE 64
2231 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2237 /* Use a short timeout the first time through,
2238 * so that recalcitrant full-speed devices with
2239 * 8- or 16-byte ep0-maxpackets won't slow things
2240 * down tremendously by NAKing the unexpectedly
2241 * early status stage. Also, retry on all errors;
2242 * some devices are flakey.
2244 for (j = 0; j < 3; ++j) {
2245 buf->bMaxPacketSize0 = 0;
2246 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2247 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2248 USB_DT_DEVICE << 8, 0,
2249 buf, GET_DESCRIPTOR_BUFSIZE,
2250 (i ? USB_CTRL_GET_TIMEOUT : 1000));
2251 switch (buf->bMaxPacketSize0) {
2252 case 8: case 16: case 32: case 64:
2253 if (buf->bDescriptorType ==
2267 udev->descriptor.bMaxPacketSize0 =
2268 buf->bMaxPacketSize0;
2271 retval = hub_port_reset(hub, port1, udev, delay);
2272 if (retval < 0) /* error or disconnect */
2274 if (oldspeed != udev->speed) {
2276 "device reset changed speed!\n");
2281 dev_err(&udev->dev, "device descriptor "
2282 "read/%s, error %d\n",
2287 #undef GET_DESCRIPTOR_BUFSIZE
2290 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2291 retval = hub_set_address(udev);
2298 "device not accepting address %d, error %d\n",
2299 udev->devnum, retval);
2303 /* cope with hardware quirkiness:
2304 * - let SET_ADDRESS settle, some device hardware wants it
2305 * - read ep0 maxpacket even for high and low speed,
2308 if (USE_NEW_SCHEME(retry_counter))
2311 retval = usb_get_device_descriptor(udev, 8);
2313 dev_err(&udev->dev, "device descriptor "
2314 "read/%s, error %d\n",
2326 i = udev->descriptor.bMaxPacketSize0;
2327 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2328 if (udev->speed != USB_SPEED_FULL ||
2329 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2330 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2334 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2335 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2339 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2340 if (retval < (signed)sizeof(udev->descriptor)) {
2341 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2352 hub_port_disable(hub, port1, 0);
2353 up(&usb_address0_sem);
2358 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2360 struct usb_qualifier_descriptor *qual;
2363 qual = kmalloc (sizeof *qual, SLAB_KERNEL);
2367 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2368 qual, sizeof *qual);
2369 if (status == sizeof *qual) {
2370 dev_info(&udev->dev, "not running at top speed; "
2371 "connect to a high speed hub\n");
2372 /* hub LEDs are probably harder to miss than syslog */
2373 if (hub->has_indicators) {
2374 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2375 schedule_work (&hub->leds);
2382 hub_power_remaining (struct usb_hub *hub)
2384 struct usb_device *hdev = hub->hdev;
2388 remaining = hub->power_budget;
2389 if (!remaining) /* self-powered */
2392 for (i = 0; i < hdev->maxchild; i++) {
2393 struct usb_device *udev = hdev->children[i];
2399 /* 100mA per-port ceiling, or 8mA for OTG ports */
2400 if (i != (udev->bus->otg_port - 1) || hdev->parent)
2405 if (udev->actconfig)
2406 delta = udev->actconfig->desc.bMaxPower;
2409 // dev_dbg(&udev->dev, "budgeted %dmA\n", 2 * delta);
2410 if (delta > ceiling)
2411 dev_warn(&udev->dev, "%dmA over %dmA budget!\n",
2412 2 * (delta - ceiling), 2 * ceiling);
2415 if (remaining < 0) {
2416 dev_warn(hub->intfdev,
2417 "%dmA over power budget!\n",
2424 /* Handle physical or logical connection change events.
2425 * This routine is called when:
2426 * a port connection-change occurs;
2427 * a port enable-change occurs (often caused by EMI);
2428 * usb_reset_device() encounters changed descriptors (as from
2429 * a firmware download)
2430 * caller already locked the hub
2432 static void hub_port_connect_change(struct usb_hub *hub, int port1,
2433 u16 portstatus, u16 portchange)
2435 struct usb_device *hdev = hub->hdev;
2436 struct device *hub_dev = hub->intfdev;
2437 u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2441 "port %d, status %04x, change %04x, %s\n",
2442 port1, portstatus, portchange, portspeed (portstatus));
2444 if (hub->has_indicators) {
2445 set_port_led(hub, port1, HUB_LED_AUTO);
2446 hub->indicator[port1-1] = INDICATOR_AUTO;
2449 /* Disconnect any existing devices under this port */
2450 if (hdev->children[port1-1])
2451 usb_disconnect(&hdev->children[port1-1]);
2452 clear_bit(port1, hub->change_bits);
2454 #ifdef CONFIG_USB_OTG
2455 /* during HNP, don't repeat the debounce */
2456 if (hdev->bus->is_b_host)
2457 portchange &= ~USB_PORT_STAT_C_CONNECTION;
2460 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2461 status = hub_port_debounce(hub, port1);
2464 "connect-debounce failed, port %d disabled\n",
2468 portstatus = status;
2471 /* Return now if nothing is connected */
2472 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2474 /* maybe switch power back on (e.g. root hub was reset) */
2475 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
2476 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2477 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2479 if (portstatus & USB_PORT_STAT_ENABLE)
2484 #ifdef CONFIG_USB_SUSPEND
2485 /* If something is connected, but the port is suspended, wake it up. */
2486 if (portstatus & USB_PORT_STAT_SUSPEND) {
2487 status = hub_port_resume(hub, port1, NULL);
2490 "can't clear suspend on port %d; %d\n",
2497 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2498 struct usb_device *udev;
2500 /* reallocate for each attempt, since references
2501 * to the previous one can escape in various ways
2503 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2506 "couldn't allocate port %d usb_device\n",
2511 usb_set_device_state(udev, USB_STATE_POWERED);
2512 udev->speed = USB_SPEED_UNKNOWN;
2514 /* set the address */
2515 choose_address(udev);
2516 if (udev->devnum <= 0) {
2517 status = -ENOTCONN; /* Don't retry */
2521 /* reset and get descriptor */
2522 status = hub_port_init(hub, udev, port1, i);
2526 /* consecutive bus-powered hubs aren't reliable; they can
2527 * violate the voltage drop budget. if the new child has
2528 * a "powered" LED, users should notice we didn't enable it
2529 * (without reading syslog), even without per-port LEDs
2532 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
2533 && hub->power_budget) {
2536 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2539 dev_dbg(&udev->dev, "get status %d ?\n", status);
2542 cpu_to_le16s(&devstat);
2543 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2545 "can't connect bus-powered hub "
2547 if (hub->has_indicators) {
2548 hub->indicator[port1-1] =
2549 INDICATOR_AMBER_BLINK;
2550 schedule_work (&hub->leds);
2552 status = -ENOTCONN; /* Don't retry */
2557 /* check for devices running slower than they could */
2558 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2559 && udev->speed == USB_SPEED_FULL
2560 && highspeed_hubs != 0)
2561 check_highspeed (hub, udev, port1);
2563 /* Store the parent's children[] pointer. At this point
2564 * udev becomes globally accessible, although presumably
2565 * no one will look at it until hdev is unlocked.
2567 down (&udev->serialize);
2570 /* We mustn't add new devices if the parent hub has
2571 * been disconnected; we would race with the
2572 * recursively_mark_NOTATTACHED() routine.
2574 spin_lock_irq(&device_state_lock);
2575 if (hdev->state == USB_STATE_NOTATTACHED)
2578 hdev->children[port1-1] = udev;
2579 spin_unlock_irq(&device_state_lock);
2581 /* Run it through the hoops (find a driver, etc) */
2583 status = usb_new_device(udev);
2585 spin_lock_irq(&device_state_lock);
2586 hdev->children[port1-1] = NULL;
2587 spin_unlock_irq(&device_state_lock);
2591 up (&udev->serialize);
2595 status = hub_power_remaining(hub);
2598 "%dmA power budget left\n",
2604 hub_port_disable(hub, port1, 1);
2607 release_address(udev);
2609 if (status == -ENOTCONN)
2614 hub_port_disable(hub, port1, 1);
2617 static void hub_events(void)
2619 struct list_head *tmp;
2620 struct usb_device *hdev;
2621 struct usb_interface *intf;
2622 struct usb_hub *hub;
2623 struct device *hub_dev;
2632 * We restart the list every time to avoid a deadlock with
2633 * deleting hubs downstream from this one. This should be
2634 * safe since we delete the hub from the event list.
2635 * Not the most efficient, but avoids deadlocks.
2639 /* Grab the first entry at the beginning of the list */
2640 spin_lock_irq(&hub_event_lock);
2641 if (list_empty(&hub_event_list)) {
2642 spin_unlock_irq(&hub_event_lock);
2646 tmp = hub_event_list.next;
2649 hub = list_entry(tmp, struct usb_hub, event_list);
2651 intf = to_usb_interface(hub->intfdev);
2652 hub_dev = &intf->dev;
2654 i = hub->resume_root_hub;
2656 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x%s\n",
2657 hdev->state, hub->descriptor
2658 ? hub->descriptor->bNbrPorts
2660 /* NOTE: expects max 15 ports... */
2661 (u16) hub->change_bits[0],
2662 (u16) hub->event_bits[0],
2663 i ? ", resume root" : "");
2666 spin_unlock_irq(&hub_event_lock);
2668 /* Is this is a root hub wanting to reactivate the downstream
2669 * ports? If so, be sure the interface resumes even if its
2670 * stub "device" node was never suspended.
2673 extern void dpm_runtime_resume(struct device *);
2675 dpm_runtime_resume(&hdev->dev);
2676 dpm_runtime_resume(&intf->dev);
2679 /* Lock the device, then check to see if we were
2680 * disconnected while waiting for the lock to succeed. */
2681 if (locktree(hdev) < 0) {
2685 if (hub != usb_get_intfdata(intf))
2688 /* If the hub has died, clean up after it */
2689 if (hdev->state == USB_STATE_NOTATTACHED) {
2694 /* If this is an inactive or suspended hub, do nothing */
2699 dev_dbg (hub_dev, "resetting for error %d\n",
2702 ret = usb_reset_device(hdev);
2705 "error resetting hub: %d\n", ret);
2713 /* deal with port status changes */
2714 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2715 if (test_bit(i, hub->busy_bits))
2717 connect_change = test_bit(i, hub->change_bits);
2718 if (!test_and_clear_bit(i, hub->event_bits) &&
2719 !connect_change && !hub->activating)
2722 ret = hub_port_status(hub, i,
2723 &portstatus, &portchange);
2727 if (hub->activating && !hdev->children[i-1] &&
2729 USB_PORT_STAT_CONNECTION))
2732 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2733 clear_port_feature(hdev, i,
2734 USB_PORT_FEAT_C_CONNECTION);
2738 if (portchange & USB_PORT_STAT_C_ENABLE) {
2739 if (!connect_change)
2741 "port %d enable change, "
2744 clear_port_feature(hdev, i,
2745 USB_PORT_FEAT_C_ENABLE);
2748 * EM interference sometimes causes badly
2749 * shielded USB devices to be shutdown by
2750 * the hub, this hack enables them again.
2751 * Works at least with mouse driver.
2753 if (!(portstatus & USB_PORT_STAT_ENABLE)
2755 && hdev->children[i-1]) {
2758 "disabled by hub (EMI?), "
2765 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2766 clear_port_feature(hdev, i,
2767 USB_PORT_FEAT_C_SUSPEND);
2768 if (hdev->children[i-1]) {
2769 ret = remote_wakeup(hdev->
2775 hub_port_disable(hub, i, 1);
2778 "resume on port %d, status %d\n",
2782 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2784 "over-current change on port %d\n",
2786 clear_port_feature(hdev, i,
2787 USB_PORT_FEAT_C_OVER_CURRENT);
2791 if (portchange & USB_PORT_STAT_C_RESET) {
2793 "reset change on port %d\n",
2795 clear_port_feature(hdev, i,
2796 USB_PORT_FEAT_C_RESET);
2800 hub_port_connect_change(hub, i,
2801 portstatus, portchange);
2804 /* deal with hub status changes */
2805 if (test_and_clear_bit(0, hub->event_bits) == 0)
2807 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2808 dev_err (hub_dev, "get_hub_status failed\n");
2810 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2811 dev_dbg (hub_dev, "power change\n");
2812 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
2814 if (hubchange & HUB_CHANGE_OVERCURRENT) {
2815 dev_dbg (hub_dev, "overcurrent change\n");
2816 msleep(500); /* Cool down */
2817 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
2822 hub->activating = 0;
2824 /* If this is a root hub, tell the HCD it's okay to
2825 * re-enable port-change interrupts now. */
2827 usb_enable_root_hub_irq(hdev->bus);
2830 usb_unlock_device(hdev);
2833 } /* end while (1) */
2836 static int hub_thread(void *__unused)
2840 wait_event_interruptible(khubd_wait,
2841 !list_empty(&hub_event_list) ||
2842 kthread_should_stop());
2844 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
2846 pr_debug("%s: khubd exiting\n", usbcore_name);
2850 static struct usb_device_id hub_id_table [] = {
2851 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
2852 .bDeviceClass = USB_CLASS_HUB},
2853 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2854 .bInterfaceClass = USB_CLASS_HUB},
2855 { } /* Terminating entry */
2858 MODULE_DEVICE_TABLE (usb, hub_id_table);
2860 static struct usb_driver hub_driver = {
2861 .owner = THIS_MODULE,
2864 .disconnect = hub_disconnect,
2865 .suspend = hub_suspend,
2866 .resume = hub_resume,
2868 .id_table = hub_id_table,
2871 int usb_hub_init(void)
2873 if (usb_register(&hub_driver) < 0) {
2874 printk(KERN_ERR "%s: can't register hub driver\n",
2879 khubd_task = kthread_run(hub_thread, NULL, "khubd");
2880 if (!IS_ERR(khubd_task))
2883 /* Fall through if kernel_thread failed */
2884 usb_deregister(&hub_driver);
2885 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
2890 void usb_hub_cleanup(void)
2892 kthread_stop(khubd_task);
2895 * Hub resources are freed for us by usb_deregister. It calls
2896 * usb_driver_purge on every device which in turn calls that
2897 * devices disconnect function if it is using this driver.
2898 * The hub_disconnect function takes care of releasing the
2899 * individual hub resources. -greg
2901 usb_deregister(&hub_driver);
2902 } /* usb_hub_cleanup() */
2904 static int config_descriptors_changed(struct usb_device *udev)
2908 struct usb_config_descriptor *buf;
2910 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2911 if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
2912 len = le16_to_cpu(udev->config[index].desc.wTotalLength);
2914 buf = kmalloc (len, SLAB_KERNEL);
2916 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
2917 /* assume the worst */
2920 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2922 int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
2924 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
2926 if (length < old_length) {
2927 dev_dbg(&udev->dev, "config index %d, error %d\n",
2931 if (memcmp (buf, udev->rawdescriptors[index], old_length)
2933 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
2934 index, buf->bConfigurationValue);
2939 return index != udev->descriptor.bNumConfigurations;
2943 * usb_reset_device - perform a USB port reset to reinitialize a device
2944 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2946 * WARNING - don't reset any device unless drivers for all of its
2947 * interfaces are expecting that reset! Maybe some driver->reset()
2948 * method should eventually help ensure sufficient cooperation.
2950 * Do a port reset, reassign the device's address, and establish its
2951 * former operating configuration. If the reset fails, or the device's
2952 * descriptors change from their values before the reset, or the original
2953 * configuration and altsettings cannot be restored, a flag will be set
2954 * telling khubd to pretend the device has been disconnected and then
2955 * re-connected. All drivers will be unbound, and the device will be
2956 * re-enumerated and probed all over again.
2958 * Returns 0 if the reset succeeded, -ENODEV if the device has been
2959 * flagged for logical disconnection, or some other negative error code
2960 * if the reset wasn't even attempted.
2962 * The caller must own the device lock. For example, it's safe to use
2963 * this from a driver probe() routine after downloading new firmware.
2964 * For calls that might not occur during probe(), drivers should lock
2965 * the device using usb_lock_device_for_reset().
2967 int usb_reset_device(struct usb_device *udev)
2969 struct usb_device *parent_hdev = udev->parent;
2970 struct usb_hub *parent_hub;
2971 struct usb_device_descriptor descriptor = udev->descriptor;
2972 struct usb_hub *hub = NULL;
2973 int i, ret = 0, port1 = -1;
2975 if (udev->state == USB_STATE_NOTATTACHED ||
2976 udev->state == USB_STATE_SUSPENDED) {
2977 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
2983 /* this requires hcd-specific logic; see OHCI hc_restart() */
2984 dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
2988 for (i = 0; i < parent_hdev->maxchild; i++)
2989 if (parent_hdev->children[i] == udev) {
2995 /* If this ever happens, it's very bad */
2996 dev_err(&udev->dev, "Can't locate device's port!\n");
2999 parent_hub = hdev_to_hub(parent_hdev);
3001 /* If we're resetting an active hub, take some special actions */
3002 if (udev->actconfig &&
3003 udev->actconfig->interface[0]->dev.driver ==
3004 &hub_driver.driver &&
3005 (hub = hdev_to_hub(udev)) != NULL) {
3009 set_bit(port1, parent_hub->busy_bits);
3010 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3012 /* ep0 maxpacket size may change; let the HCD know about it.
3013 * Other endpoints will be handled by re-enumeration. */
3015 ret = hub_port_init(parent_hub, udev, port1, i);
3019 clear_bit(port1, parent_hub->busy_bits);
3023 /* Device might have changed firmware (DFU or similar) */
3024 if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
3025 || config_descriptors_changed (udev)) {
3026 dev_info(&udev->dev, "device firmware changed\n");
3027 udev->descriptor = descriptor; /* for disconnect() calls */
3031 if (!udev->actconfig)
3034 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3035 USB_REQ_SET_CONFIGURATION, 0,
3036 udev->actconfig->desc.bConfigurationValue, 0,
3037 NULL, 0, USB_CTRL_SET_TIMEOUT);
3040 "can't restore configuration #%d (error=%d)\n",
3041 udev->actconfig->desc.bConfigurationValue, ret);
3044 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3046 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3047 struct usb_interface *intf = udev->actconfig->interface[i];
3048 struct usb_interface_descriptor *desc;
3050 /* set_interface resets host side toggle even
3051 * for altsetting zero. the interface may have no driver.
3053 desc = &intf->cur_altsetting->desc;
3054 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3055 desc->bAlternateSetting);
3057 dev_err(&udev->dev, "failed to restore interface %d "
3058 "altsetting %d (error=%d)\n",
3059 desc->bInterfaceNumber,
3060 desc->bAlternateSetting,
3068 hub_post_reset(hub);
3072 hub_port_logical_disconnect(parent_hub, port1);