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)
439 /* if hub supports power switching, enable power on each port */
440 if ((hub->descriptor->wHubCharacteristics & HUB_CHAR_LPSM) < 2) {
441 dev_dbg(hub->intfdev, "enabling power on all ports\n");
442 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
443 set_port_feature(hub->hdev, port1,
444 USB_PORT_FEAT_POWER);
447 /* Wait for power to be enabled */
448 msleep(hub->descriptor->bPwrOn2PwrGood * 2);
451 static void hub_quiesce(struct usb_hub *hub)
453 /* stop khubd and related activity */
455 usb_kill_urb(hub->urb);
456 if (hub->has_indicators)
457 cancel_delayed_work(&hub->leds);
458 if (hub->has_indicators || hub->tt.hub)
459 flush_scheduled_work();
462 static void hub_activate(struct usb_hub *hub)
468 status = usb_submit_urb(hub->urb, GFP_NOIO);
470 dev_err(hub->intfdev, "activate --> %d\n", status);
471 if (hub->has_indicators && blinkenlights)
472 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
474 /* scan all ports ASAP */
478 static int hub_hub_status(struct usb_hub *hub,
479 u16 *status, u16 *change)
483 ret = get_hub_status(hub->hdev, &hub->status->hub);
485 dev_err (hub->intfdev,
486 "%s failed (err = %d)\n", __FUNCTION__, ret);
488 *status = le16_to_cpu(hub->status->hub.wHubStatus);
489 *change = le16_to_cpu(hub->status->hub.wHubChange);
495 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
497 struct usb_device *hdev = hub->hdev;
500 if (hdev->children[port1-1] && set_state) {
501 usb_set_device_state(hdev->children[port1-1],
502 USB_STATE_NOTATTACHED);
504 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
506 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
512 static int hub_configure(struct usb_hub *hub,
513 struct usb_endpoint_descriptor *endpoint)
515 struct usb_device *hdev = hub->hdev;
516 struct device *hub_dev = hub->intfdev;
517 u16 hubstatus, hubchange;
522 hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
525 message = "can't allocate hub irq buffer";
530 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
532 message = "can't kmalloc hub status buffer";
537 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
538 if (!hub->descriptor) {
539 message = "can't kmalloc hub descriptor";
544 /* Request the entire hub descriptor.
545 * hub->descriptor can handle USB_MAXCHILDREN ports,
546 * but the hub can/will return fewer bytes here.
548 ret = get_hub_descriptor(hdev, hub->descriptor,
549 sizeof(*hub->descriptor));
551 message = "can't read hub descriptor";
553 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
554 message = "hub has too many ports!";
559 hdev->maxchild = hub->descriptor->bNbrPorts;
560 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
561 (hdev->maxchild == 1) ? "" : "s");
563 le16_to_cpus(&hub->descriptor->wHubCharacteristics);
565 if (hub->descriptor->wHubCharacteristics & HUB_CHAR_COMPOUND) {
567 char portstr [USB_MAXCHILDREN + 1];
569 for (i = 0; i < hdev->maxchild; i++)
570 portstr[i] = hub->descriptor->DeviceRemovable
571 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
573 portstr[hdev->maxchild] = 0;
574 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
576 dev_dbg(hub_dev, "standalone hub\n");
578 switch (hub->descriptor->wHubCharacteristics & HUB_CHAR_LPSM) {
580 dev_dbg(hub_dev, "ganged power switching\n");
583 dev_dbg(hub_dev, "individual port power switching\n");
587 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
591 switch (hub->descriptor->wHubCharacteristics & HUB_CHAR_OCPM) {
593 dev_dbg(hub_dev, "global over-current protection\n");
596 dev_dbg(hub_dev, "individual port over-current protection\n");
600 dev_dbg(hub_dev, "no over-current protection\n");
604 spin_lock_init (&hub->tt.lock);
605 INIT_LIST_HEAD (&hub->tt.clear_list);
606 INIT_WORK (&hub->tt.kevent, hub_tt_kevent, hub);
607 switch (hdev->descriptor.bDeviceProtocol) {
611 dev_dbg(hub_dev, "Single TT\n");
615 ret = usb_set_interface(hdev, 0, 1);
617 dev_dbg(hub_dev, "TT per port\n");
620 dev_err(hub_dev, "Using single TT (err %d)\n",
625 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
626 hdev->descriptor.bDeviceProtocol);
630 switch (hub->descriptor->wHubCharacteristics & HUB_CHAR_TTTT) {
632 if (hdev->descriptor.bDeviceProtocol != 0)
633 dev_dbg(hub_dev, "TT requires at most 8 FS bit times\n");
636 dev_dbg(hub_dev, "TT requires at most 16 FS bit times\n");
639 dev_dbg(hub_dev, "TT requires at most 24 FS bit times\n");
642 dev_dbg(hub_dev, "TT requires at most 32 FS bit times\n");
646 /* probe() zeroes hub->indicator[] */
647 if (hub->descriptor->wHubCharacteristics & HUB_CHAR_PORTIND) {
648 hub->has_indicators = 1;
649 dev_dbg(hub_dev, "Port indicators are supported\n");
652 dev_dbg(hub_dev, "power on to power good time: %dms\n",
653 hub->descriptor->bPwrOn2PwrGood * 2);
655 /* power budgeting mostly matters with bus-powered hubs,
656 * and battery-powered root hubs (may provide just 8 mA).
658 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
660 message = "can't get hub status";
663 le16_to_cpus(&hubstatus);
664 if (hdev == hdev->bus->root_hub) {
665 struct usb_hcd *hcd =
666 container_of(hdev->bus, struct usb_hcd, self);
668 hub->power_budget = min(500u, hcd->power_budget) / 2;
669 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
670 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
671 hub->descriptor->bHubContrCurrent);
672 hub->power_budget = (501 - hub->descriptor->bHubContrCurrent)
675 if (hub->power_budget)
676 dev_dbg(hub_dev, "%dmA bus power budget for children\n",
677 hub->power_budget * 2);
680 ret = hub_hub_status(hub, &hubstatus, &hubchange);
682 message = "can't get hub status";
686 /* local power status reports aren't always correct */
687 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
688 dev_dbg(hub_dev, "local power source is %s\n",
689 (hubstatus & HUB_STATUS_LOCAL_POWER)
690 ? "lost (inactive)" : "good");
692 if ((hub->descriptor->wHubCharacteristics & HUB_CHAR_OCPM) == 0)
693 dev_dbg(hub_dev, "%sover-current condition exists\n",
694 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
696 /* set up the interrupt endpoint */
697 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
698 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
700 if (maxp > sizeof(*hub->buffer))
701 maxp = sizeof(*hub->buffer);
703 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
705 message = "couldn't allocate interrupt urb";
710 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
711 hub, endpoint->bInterval);
712 hub->urb->transfer_dma = hub->buffer_dma;
713 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
715 /* maybe cycle the hub leds */
716 if (hub->has_indicators && blinkenlights)
717 hub->indicator [0] = INDICATOR_CYCLE;
724 dev_err (hub_dev, "config failed, %s (err %d)\n",
726 /* hub_disconnect() frees urb and descriptor */
730 static unsigned highspeed_hubs;
732 /* Called after the hub driver is unbound from a hub with children */
733 static void hub_remove_children_work(void *__hub)
735 struct usb_hub *hub = __hub;
736 struct usb_device *hdev = hub->hdev;
741 usb_lock_device(hdev);
742 for (i = 0; i < hdev->maxchild; ++i) {
743 if (hdev->children[i])
744 usb_disconnect(&hdev->children[i]);
746 usb_unlock_device(hdev);
750 static void hub_disconnect(struct usb_interface *intf)
752 struct usb_hub *hub = usb_get_intfdata (intf);
753 struct usb_device *hdev;
756 usb_set_intfdata (intf, NULL);
759 if (hdev->speed == USB_SPEED_HIGH)
763 usb_free_urb(hub->urb);
766 spin_lock_irq(&hub_event_lock);
767 list_del_init(&hub->event_list);
768 spin_unlock_irq(&hub_event_lock);
770 kfree(hub->descriptor);
771 hub->descriptor = NULL;
777 usb_buffer_free(hdev, sizeof(*hub->buffer), hub->buffer,
782 /* If there are any children then this is an unbind only, not a
783 * physical disconnection. The active ports must be disabled
784 * and later on we must call usb_disconnect(). We can't call
785 * it now because we may not hold the hub's device lock.
788 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
789 if (hdev->children[port1 - 1]) {
791 hub_port_disable(hub, port1, 1);
798 /* Reuse the hub->leds work_struct for our own purposes */
799 INIT_WORK(&hub->leds, hub_remove_children_work, hub);
800 schedule_work(&hub->leds);
805 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
807 struct usb_host_interface *desc;
808 struct usb_endpoint_descriptor *endpoint;
809 struct usb_device *hdev;
812 desc = intf->cur_altsetting;
813 hdev = interface_to_usbdev(intf);
815 /* Some hubs have a subclass of 1, which AFAICT according to the */
816 /* specs is not defined, but it works */
817 if ((desc->desc.bInterfaceSubClass != 0) &&
818 (desc->desc.bInterfaceSubClass != 1)) {
820 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
824 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
825 if (desc->desc.bNumEndpoints != 1)
826 goto descriptor_error;
828 endpoint = &desc->endpoint[0].desc;
830 /* Output endpoint? Curiouser and curiouser.. */
831 if (!(endpoint->bEndpointAddress & USB_DIR_IN))
832 goto descriptor_error;
834 /* If it's not an interrupt endpoint, we'd better punt! */
835 if ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
836 != USB_ENDPOINT_XFER_INT)
837 goto descriptor_error;
840 dev_info (&intf->dev, "USB hub found\n");
842 hub = kmalloc(sizeof(*hub), GFP_KERNEL);
844 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
848 memset(hub, 0, sizeof(*hub));
850 INIT_LIST_HEAD(&hub->event_list);
851 hub->intfdev = &intf->dev;
853 INIT_WORK(&hub->leds, led_work, hub);
855 usb_set_intfdata (intf, hub);
857 if (hdev->speed == USB_SPEED_HIGH)
860 if (hub_configure(hub, endpoint) >= 0)
863 hub_disconnect (intf);
868 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
870 struct usb_device *hdev = interface_to_usbdev (intf);
872 /* assert ifno == 0 (part of hub spec) */
874 case USBDEVFS_HUB_PORTINFO: {
875 struct usbdevfs_hub_portinfo *info = user_data;
878 spin_lock_irq(&device_state_lock);
879 if (hdev->devnum <= 0)
882 info->nports = hdev->maxchild;
883 for (i = 0; i < info->nports; i++) {
884 if (hdev->children[i] == NULL)
888 hdev->children[i]->devnum;
891 spin_unlock_irq(&device_state_lock);
893 return info->nports + 1;
901 /* caller has locked the hub device */
902 static void hub_pre_reset(struct usb_hub *hub)
904 struct usb_device *hdev = hub->hdev;
907 for (i = 0; i < hdev->maxchild; ++i) {
908 if (hdev->children[i])
909 usb_disconnect(&hdev->children[i]);
914 /* caller has locked the hub device */
915 static void hub_post_reset(struct usb_hub *hub)
922 /* grab device/port lock, returning index of that port (zero based).
923 * protects the upstream link used by this device from concurrent
924 * tree operations like suspend, resume, reset, and disconnect, which
925 * apply to everything downstream of a given port.
927 static int locktree(struct usb_device *udev)
930 struct usb_device *hdev;
935 /* root hub is always the first lock in the series */
938 usb_lock_device(udev);
942 /* on the path from root to us, lock everything from
943 * top down, dropping parent locks when not needed
948 for (t = 0; t < hdev->maxchild; t++) {
949 if (hdev->children[t] == udev) {
950 /* everything is fail-fast once disconnect
953 if (udev->state == USB_STATE_NOTATTACHED)
956 /* when everyone grabs locks top->bottom,
957 * non-overlapping work may be concurrent
959 down(&udev->serialize);
960 up(&hdev->serialize);
964 usb_unlock_device(hdev);
968 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
972 for (i = 0; i < udev->maxchild; ++i) {
973 if (udev->children[i])
974 recursively_mark_NOTATTACHED(udev->children[i]);
976 udev->state = USB_STATE_NOTATTACHED;
980 * usb_set_device_state - change a device's current state (usbcore, hcds)
981 * @udev: pointer to device whose state should be changed
982 * @new_state: new state value to be stored
984 * udev->state is _not_ fully protected by the device lock. Although
985 * most transitions are made only while holding the lock, the state can
986 * can change to USB_STATE_NOTATTACHED at almost any time. This
987 * is so that devices can be marked as disconnected as soon as possible,
988 * without having to wait for any semaphores to be released. As a result,
989 * all changes to any device's state must be protected by the
990 * device_state_lock spinlock.
992 * Once a device has been added to the device tree, all changes to its state
993 * should be made using this routine. The state should _not_ be set directly.
995 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
996 * Otherwise udev->state is set to new_state, and if new_state is
997 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
998 * to USB_STATE_NOTATTACHED.
1000 void usb_set_device_state(struct usb_device *udev,
1001 enum usb_device_state new_state)
1003 unsigned long flags;
1005 spin_lock_irqsave(&device_state_lock, flags);
1006 if (udev->state == USB_STATE_NOTATTACHED)
1008 else if (new_state != USB_STATE_NOTATTACHED)
1009 udev->state = new_state;
1011 recursively_mark_NOTATTACHED(udev);
1012 spin_unlock_irqrestore(&device_state_lock, flags);
1014 EXPORT_SYMBOL(usb_set_device_state);
1017 static void choose_address(struct usb_device *udev)
1020 struct usb_bus *bus = udev->bus;
1022 /* If khubd ever becomes multithreaded, this will need a lock */
1024 /* Try to allocate the next devnum beginning at bus->devnum_next. */
1025 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1028 devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
1030 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1033 set_bit(devnum, bus->devmap.devicemap);
1034 udev->devnum = devnum;
1038 static void release_address(struct usb_device *udev)
1040 if (udev->devnum > 0) {
1041 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1047 * usb_disconnect - disconnect a device (usbcore-internal)
1048 * @pdev: pointer to device being disconnected
1049 * Context: !in_interrupt ()
1051 * Something got disconnected. Get rid of it and all of its children.
1053 * If *pdev is a normal device then the parent hub must already be locked.
1054 * If *pdev is a root hub then this routine will acquire the
1055 * usb_bus_list_lock on behalf of the caller.
1057 * Only hub drivers (including virtual root hub drivers for host
1058 * controllers) should ever call this.
1060 * This call is synchronous, and may not be used in an interrupt context.
1062 void usb_disconnect(struct usb_device **pdev)
1064 struct usb_device *udev = *pdev;
1068 pr_debug ("%s nodev\n", __FUNCTION__);
1072 /* mark the device as inactive, so any further urb submissions for
1073 * this device (and any of its children) will fail immediately.
1074 * this quiesces everyting except pending urbs.
1076 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1078 /* lock the bus list on behalf of HCDs unregistering their root hubs */
1079 if (!udev->parent) {
1080 down(&usb_bus_list_lock);
1081 usb_lock_device(udev);
1083 down(&udev->serialize);
1085 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1087 /* Free up all the children before we remove this device */
1088 for (i = 0; i < USB_MAXCHILDREN; i++) {
1089 if (udev->children[i])
1090 usb_disconnect(&udev->children[i]);
1093 /* deallocate hcd/hardware state ... nuking all pending urbs and
1094 * cleaning up all state associated with the current configuration
1095 * so that the hardware is now fully quiesced.
1097 usb_disable_device(udev, 0);
1099 /* Free the device number, remove the /proc/bus/usb entry and
1100 * the sysfs attributes, and delete the parent's children[]
1101 * (or root_hub) pointer.
1103 dev_dbg (&udev->dev, "unregistering device\n");
1104 release_address(udev);
1105 usbfs_remove_device(udev);
1106 usbdev_remove(udev);
1107 usb_remove_sysfs_dev_files(udev);
1109 /* Avoid races with recursively_mark_NOTATTACHED() */
1110 spin_lock_irq(&device_state_lock);
1112 spin_unlock_irq(&device_state_lock);
1114 if (!udev->parent) {
1115 usb_unlock_device(udev);
1116 up(&usb_bus_list_lock);
1118 up(&udev->serialize);
1120 device_unregister(&udev->dev);
1123 static int choose_configuration(struct usb_device *udev)
1127 /* NOTE: this should interact with hub power budgeting */
1129 c = udev->config[0].desc.bConfigurationValue;
1130 if (udev->descriptor.bNumConfigurations != 1) {
1131 for (i = 0; i < udev->descriptor.bNumConfigurations; i++) {
1132 struct usb_interface_descriptor *desc;
1134 /* heuristic: Linux is more likely to have class
1135 * drivers, so avoid vendor-specific interfaces.
1137 desc = &udev->config[i].intf_cache[0]
1139 if (desc->bInterfaceClass == USB_CLASS_VENDOR_SPEC)
1141 /* COMM/2/all is CDC ACM, except 0xff is MSFT RNDIS.
1142 * MSFT needs this to be the first config; never use
1143 * it as the default unless Linux has host-side RNDIS.
1144 * A second config would ideally be CDC-Ethernet, but
1145 * may instead be the "vendor specific" CDC subset
1146 * long used by ARM Linux for sa1100 or pxa255.
1148 if (desc->bInterfaceClass == USB_CLASS_COMM
1149 && desc->bInterfaceSubClass == 2
1150 && desc->bInterfaceProtocol == 0xff) {
1151 c = udev->config[1].desc.bConfigurationValue;
1154 c = udev->config[i].desc.bConfigurationValue;
1157 dev_info(&udev->dev,
1158 "configuration #%d chosen from %d choices\n",
1159 c, udev->descriptor.bNumConfigurations);
1165 static void show_string(struct usb_device *udev, char *id, char *string)
1169 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1173 static inline void show_string(struct usb_device *udev, char *id, char *string)
1177 static void get_string(struct usb_device *udev, char **string, int index)
1183 buf = kmalloc(256, GFP_KERNEL);
1186 if (usb_string(udev, index, buf, 256) > 0)
1193 #ifdef CONFIG_USB_OTG
1194 #include "otg_whitelist.h"
1198 * usb_new_device - perform initial device setup (usbcore-internal)
1199 * @udev: newly addressed device (in ADDRESS state)
1201 * This is called with devices which have been enumerated, but not yet
1202 * configured. The device descriptor is available, but not descriptors
1203 * for any device configuration. The caller must have locked udev and
1204 * either the parent hub (if udev is a normal device) or else the
1205 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1206 * udev has already been installed, but udev is not yet visible through
1207 * sysfs or other filesystem code.
1209 * Returns 0 for success (device is configured and listed, with its
1210 * interfaces, in sysfs); else a negative errno value.
1212 * This call is synchronous, and may not be used in an interrupt context.
1214 * Only the hub driver should ever call this; root hub registration
1215 * uses it indirectly.
1217 int usb_new_device(struct usb_device *udev)
1222 err = usb_get_configuration(udev);
1224 dev_err(&udev->dev, "can't read configurations, error %d\n",
1229 /* read the standard strings and cache them if present */
1230 get_string(udev, &udev->product, udev->descriptor.iProduct);
1231 get_string(udev, &udev->manufacturer, udev->descriptor.iManufacturer);
1232 get_string(udev, &udev->serial, udev->descriptor.iSerialNumber);
1234 /* Tell the world! */
1235 dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
1236 "SerialNumber=%d\n",
1237 udev->descriptor.iManufacturer,
1238 udev->descriptor.iProduct,
1239 udev->descriptor.iSerialNumber);
1240 show_string(udev, "Product", udev->product);
1241 show_string(udev, "Manufacturer", udev->manufacturer);
1242 show_string(udev, "SerialNumber", udev->serial);
1244 #ifdef CONFIG_USB_OTG
1246 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1247 * to wake us after we've powered off VBUS; and HNP, switching roles
1248 * "host" to "peripheral". The OTG descriptor helps figure this out.
1250 if (!udev->bus->is_b_host
1252 && udev->parent == udev->bus->root_hub) {
1253 struct usb_otg_descriptor *desc = 0;
1254 struct usb_bus *bus = udev->bus;
1256 /* descriptor may appear anywhere in config */
1257 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1258 le16_to_cpu(udev->config[0].desc.wTotalLength),
1259 USB_DT_OTG, (void **) &desc) == 0) {
1260 if (desc->bmAttributes & USB_OTG_HNP) {
1262 struct usb_device *root = udev->parent;
1264 for (port1 = 1; port1 <= root->maxchild;
1266 if (root->children[port1-1] == udev)
1270 dev_info(&udev->dev,
1271 "Dual-Role OTG device on %sHNP port\n",
1272 (port1 == bus->otg_port)
1275 /* enable HNP before suspend, it's simpler */
1276 if (port1 == bus->otg_port)
1277 bus->b_hnp_enable = 1;
1278 err = usb_control_msg(udev,
1279 usb_sndctrlpipe(udev, 0),
1280 USB_REQ_SET_FEATURE, 0,
1282 ? USB_DEVICE_B_HNP_ENABLE
1283 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1284 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1286 /* OTG MESSAGE: report errors here,
1287 * customize to match your product.
1289 dev_info(&udev->dev,
1290 "can't set HNP mode; %d\n",
1292 bus->b_hnp_enable = 0;
1298 if (!is_targeted(udev)) {
1300 /* Maybe it can talk to us, though we can't talk to it.
1301 * (Includes HNP test device.)
1303 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1304 static int __usb_suspend_device (struct usb_device *,
1305 int port1, pm_message_t state);
1306 err = __usb_suspend_device(udev,
1307 udev->bus->otg_port,
1310 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1317 /* put device-specific files into sysfs */
1318 err = device_add (&udev->dev);
1320 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1323 usb_create_sysfs_dev_files (udev);
1325 /* choose and set the configuration. that registers the interfaces
1326 * with the driver core, and lets usb device drivers bind to them.
1328 c = choose_configuration(udev);
1330 dev_warn(&udev->dev,
1331 "can't choose an initial configuration\n");
1333 err = usb_set_configuration(udev, c);
1335 dev_err(&udev->dev, "can't set config #%d, error %d\n",
1337 usb_remove_sysfs_dev_files(udev);
1338 device_del(&udev->dev);
1343 /* USB device state == configured ... usable */
1345 /* add a /proc/bus/usb entry */
1347 usbfs_add_device(udev);
1351 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1356 static int hub_port_status(struct usb_hub *hub, int port1,
1357 u16 *status, u16 *change)
1361 ret = get_port_status(hub->hdev, port1, &hub->status->port);
1363 dev_err (hub->intfdev,
1364 "%s failed (err = %d)\n", __FUNCTION__, ret);
1366 *status = le16_to_cpu(hub->status->port.wPortStatus);
1367 *change = le16_to_cpu(hub->status->port.wPortChange);
1373 #define PORT_RESET_TRIES 5
1374 #define SET_ADDRESS_TRIES 2
1375 #define GET_DESCRIPTOR_TRIES 2
1376 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1377 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1379 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1380 #define HUB_SHORT_RESET_TIME 10
1381 #define HUB_LONG_RESET_TIME 200
1382 #define HUB_RESET_TIMEOUT 500
1384 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1385 struct usb_device *udev, unsigned int delay)
1387 int delay_time, ret;
1391 for (delay_time = 0;
1392 delay_time < HUB_RESET_TIMEOUT;
1393 delay_time += delay) {
1394 /* wait to give the device a chance to reset */
1397 /* read and decode port status */
1398 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1402 /* Device went away? */
1403 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1406 /* bomb out completely if something weird happened */
1407 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1410 /* if we`ve finished resetting, then break out of the loop */
1411 if (!(portstatus & USB_PORT_STAT_RESET) &&
1412 (portstatus & USB_PORT_STAT_ENABLE)) {
1413 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1414 udev->speed = USB_SPEED_HIGH;
1415 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1416 udev->speed = USB_SPEED_LOW;
1418 udev->speed = USB_SPEED_FULL;
1422 /* switch to the long delay after two short delay failures */
1423 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1424 delay = HUB_LONG_RESET_TIME;
1426 dev_dbg (hub->intfdev,
1427 "port %d not reset yet, waiting %dms\n",
1434 static int hub_port_reset(struct usb_hub *hub, int port1,
1435 struct usb_device *udev, unsigned int delay)
1439 /* Reset the port */
1440 for (i = 0; i < PORT_RESET_TRIES; i++) {
1441 status = set_port_feature(hub->hdev,
1442 port1, USB_PORT_FEAT_RESET);
1444 dev_err(hub->intfdev,
1445 "cannot reset port %d (err = %d)\n",
1448 status = hub_port_wait_reset(hub, port1, udev, delay);
1450 dev_dbg(hub->intfdev,
1451 "port_wait_reset: err = %d\n",
1455 /* return on disconnect or reset */
1458 /* TRSTRCY = 10 ms */
1463 clear_port_feature(hub->hdev,
1464 port1, USB_PORT_FEAT_C_RESET);
1465 /* FIXME need disconnect() for NOTATTACHED device */
1466 usb_set_device_state(udev, status
1467 ? USB_STATE_NOTATTACHED
1468 : USB_STATE_DEFAULT);
1472 dev_dbg (hub->intfdev,
1473 "port %d not enabled, trying reset again...\n",
1475 delay = HUB_LONG_RESET_TIME;
1478 dev_err (hub->intfdev,
1479 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1486 * Disable a port and mark a logical connnect-change event, so that some
1487 * time later khubd will disconnect() any existing usb_device on the port
1488 * and will re-enumerate if there actually is a device attached.
1490 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
1492 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
1493 hub_port_disable(hub, port1, 1);
1495 /* FIXME let caller ask to power down the port:
1496 * - some devices won't enumerate without a VBUS power cycle
1497 * - SRP saves power that way
1498 * - usb_suspend_device(dev, PMSG_SUSPEND)
1499 * That's easy if this hub can switch power per-port, and
1500 * khubd reactivates the port later (timer, SRP, etc).
1501 * Powerdown must be optional, because of reset/DFU.
1504 set_bit(port1, hub->change_bits);
1509 #ifdef CONFIG_USB_SUSPEND
1512 * Selective port suspend reduces power; most suspended devices draw
1513 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1514 * All devices below the suspended port are also suspended.
1516 * Devices leave suspend state when the host wakes them up. Some devices
1517 * also support "remote wakeup", where the device can activate the USB
1518 * tree above them to deliver data, such as a keypress or packet. In
1519 * some cases, this wakes the USB host.
1521 static int hub_port_suspend(struct usb_hub *hub, int port1,
1522 struct usb_device *udev)
1526 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1528 /* enable remote wakeup when appropriate; this lets the device
1529 * wake up the upstream hub (including maybe the root hub).
1531 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1532 * we don't explicitly enable it here.
1535 // && FIXME (remote wakeup enabled on this bus)
1536 // ... currently assuming it's always appropriate
1537 && (udev->actconfig->desc.bmAttributes
1538 & USB_CONFIG_ATT_WAKEUP) != 0) {
1539 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1540 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1541 USB_DEVICE_REMOTE_WAKEUP, 0,
1543 USB_CTRL_SET_TIMEOUT);
1546 "won't remote wakeup, status %d\n",
1551 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1553 dev_dbg(hub->intfdev,
1554 "can't suspend port %d, status %d\n",
1556 /* paranoia: "should not happen" */
1557 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1558 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1559 USB_DEVICE_REMOTE_WAKEUP, 0,
1561 USB_CTRL_SET_TIMEOUT);
1563 /* device has up to 10 msec to fully suspend */
1564 dev_dbg(&udev->dev, "usb suspend\n");
1565 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1572 * Devices on USB hub ports have only one "suspend" state, corresponding
1573 * to ACPI D2, "may cause the device to lose some context".
1574 * State transitions include:
1576 * - suspend, resume ... when the VBUS power link stays live
1577 * - suspend, disconnect ... VBUS lost
1579 * Once VBUS drop breaks the circuit, the port it's using has to go through
1580 * normal re-enumeration procedures, starting with enabling VBUS power.
1581 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1582 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1583 * timer, no SRP, no requests through sysfs.
1585 static int __usb_suspend_device (struct usb_device *udev, int port1,
1590 /* caller owns the udev device lock */
1594 if (udev->state == USB_STATE_SUSPENDED
1595 || udev->state == USB_STATE_NOTATTACHED) {
1599 /* suspend interface drivers; if this is a hub, it
1600 * suspends the child devices
1602 if (udev->actconfig) {
1605 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1606 struct usb_interface *intf;
1607 struct usb_driver *driver;
1609 intf = udev->actconfig->interface[i];
1610 if (state.event <= intf->dev.power.power_state.event)
1612 if (!intf->dev.driver)
1614 driver = to_usb_driver(intf->dev.driver);
1616 if (driver->suspend) {
1617 status = driver->suspend(intf, state);
1618 if (intf->dev.power.power_state.event != state.event
1621 "suspend %d fail, code %d\n",
1622 state.event, status);
1625 /* only drivers with suspend() can ever resume();
1626 * and after power loss, even they won't.
1627 * bus_rescan_devices() can rebind drivers later.
1629 * FIXME the PM core self-deadlocks when unbinding
1630 * drivers during suspend/resume ... everything grabs
1631 * dpm_sem (not a spinlock, ugh). we want to unbind,
1632 * since we know every driver's probe/disconnect works
1633 * even for drivers that can't suspend.
1635 if (!driver->suspend || state.event > PM_EVENT_FREEZE) {
1637 dev_warn(&intf->dev, "resume is unsafe!\n");
1639 down_write(&usb_bus_type.rwsem);
1640 device_release_driver(&intf->dev);
1641 up_write(&usb_bus_type.rwsem);
1648 * FIXME this needs port power off call paths too, to help force
1649 * USB into the "generic" PM model. At least for devices on
1650 * ports that aren't using ganged switching (usually root hubs).
1652 * NOTE: SRP-capable links should adopt more aggressive poweroff
1653 * policies (when HNP doesn't apply) once we have mechanisms to
1654 * turn power back on! (Likely not before 2.7...)
1656 if (state.event > PM_EVENT_FREEZE) {
1657 dev_warn(&udev->dev, "no poweroff yet, suspending instead\n");
1660 /* "global suspend" of the HC-to-USB interface (root hub), or
1661 * "selective suspend" of just one hub-device link.
1663 if (!udev->parent) {
1664 struct usb_bus *bus = udev->bus;
1665 if (bus && bus->op->hub_suspend) {
1666 status = bus->op->hub_suspend (bus);
1668 dev_dbg(&udev->dev, "usb suspend\n");
1669 usb_set_device_state(udev,
1670 USB_STATE_SUSPENDED);
1673 status = -EOPNOTSUPP;
1675 status = hub_port_suspend(hdev_to_hub(udev->parent), port1,
1679 udev->dev.power.power_state = state;
1684 * usb_suspend_device - suspend a usb device
1685 * @udev: device that's no longer in active use
1686 * @state: PMSG_SUSPEND to suspend
1687 * Context: must be able to sleep; device not locked
1689 * Suspends a USB device that isn't in active use, conserving power.
1690 * Devices may wake out of a suspend, if anything important happens,
1691 * using the remote wakeup mechanism. They may also be taken out of
1692 * suspend by the host, using usb_resume_device(). It's also routine
1693 * to disconnect devices while they are suspended.
1695 * Suspending OTG devices may trigger HNP, if that's been enabled
1696 * between a pair of dual-role devices. That will change roles, such
1697 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1699 * Returns 0 on success, else negative errno.
1701 int usb_suspend_device(struct usb_device *udev, pm_message_t state)
1705 port1 = locktree(udev);
1709 status = __usb_suspend_device(udev, port1, state);
1710 usb_unlock_device(udev);
1715 * hardware resume signaling is finished, either because of selective
1716 * resume (by host) or remote wakeup (by device) ... now see what changed
1717 * in the tree that's rooted at this device.
1719 static int finish_port_resume(struct usb_device *udev)
1724 /* caller owns the udev device lock */
1725 dev_dbg(&udev->dev, "usb resume\n");
1727 /* usb ch9 identifies four variants of SUSPENDED, based on what
1728 * state the device resumes to. Linux currently won't see the
1729 * first two on the host side; they'd be inside hub_port_init()
1730 * during many timeouts, but khubd can't suspend until later.
1732 usb_set_device_state(udev, udev->actconfig
1733 ? USB_STATE_CONFIGURED
1734 : USB_STATE_ADDRESS);
1735 udev->dev.power.power_state = PMSG_ON;
1737 /* 10.5.4.5 says be sure devices in the tree are still there.
1738 * For now let's assume the device didn't go crazy on resume,
1739 * and device drivers will know about any resume quirks.
1741 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
1744 "gone after usb resume? status %d\n",
1746 else if (udev->actconfig) {
1749 le16_to_cpus(&devstatus);
1750 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
1751 status = usb_control_msg(udev,
1752 usb_sndctrlpipe(udev, 0),
1753 USB_REQ_CLEAR_FEATURE,
1755 USB_DEVICE_REMOTE_WAKEUP, 0,
1757 USB_CTRL_SET_TIMEOUT);
1759 dev_dbg(&udev->dev, "disable remote "
1760 "wakeup, status %d\n", status);
1765 /* resume interface drivers; if this is a hub, it
1766 * resumes the child devices
1768 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1769 struct usb_interface *intf;
1770 struct usb_driver *driver;
1772 intf = udev->actconfig->interface[i];
1773 if (intf->dev.power.power_state.event == PM_EVENT_ON)
1775 if (!intf->dev.driver) {
1776 /* FIXME maybe force to alt 0 */
1779 driver = to_usb_driver(intf->dev.driver);
1781 /* bus_rescan_devices() may rebind drivers */
1782 if (!driver->resume)
1785 /* can we do better than just logging errors? */
1786 status = driver->resume(intf);
1787 if (intf->dev.power.power_state.event != PM_EVENT_ON
1790 "resume fail, state %d code %d\n",
1791 intf->dev.power.power_state.event, status);
1795 } else if (udev->devnum <= 0) {
1796 dev_dbg(&udev->dev, "bogus resume!\n");
1803 hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1807 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1809 /* see 7.1.7.7; affects power usage, but not budgeting */
1810 status = clear_port_feature(hub->hdev,
1811 port1, USB_PORT_FEAT_SUSPEND);
1813 dev_dbg(hub->intfdev,
1814 "can't resume port %d, status %d\n",
1820 /* drive resume for at least 20 msec */
1822 dev_dbg(&udev->dev, "RESUME\n");
1825 #define LIVE_FLAGS ( USB_PORT_STAT_POWER \
1826 | USB_PORT_STAT_ENABLE \
1827 | USB_PORT_STAT_CONNECTION)
1829 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1830 * stop resume signaling. Then finish the resume
1833 devstatus = portchange = 0;
1834 status = hub_port_status(hub, port1,
1835 &devstatus, &portchange);
1837 || (devstatus & LIVE_FLAGS) != LIVE_FLAGS
1838 || (devstatus & USB_PORT_STAT_SUSPEND) != 0
1840 dev_dbg(hub->intfdev,
1841 "port %d status %04x.%04x after resume, %d\n",
1842 port1, portchange, devstatus, status);
1844 /* TRSMRCY = 10 msec */
1847 status = finish_port_resume(udev);
1851 hub_port_logical_disconnect(hub, port1);
1856 static int hub_resume (struct usb_interface *intf);
1859 * usb_resume_device - re-activate a suspended usb device
1860 * @udev: device to re-activate
1861 * Context: must be able to sleep; device not locked
1863 * This will re-activate the suspended device, increasing power usage
1864 * while letting drivers communicate again with its endpoints.
1865 * USB resume explicitly guarantees that the power session between
1866 * the host and the device is the same as it was when the device
1869 * Returns 0 on success, else negative errno.
1871 int usb_resume_device(struct usb_device *udev)
1875 port1 = locktree(udev);
1879 /* "global resume" of the HC-to-USB interface (root hub), or
1880 * selective resume of one hub-to-device port
1882 if (!udev->parent) {
1883 struct usb_bus *bus = udev->bus;
1884 if (bus && bus->op->hub_resume) {
1885 status = bus->op->hub_resume (bus);
1887 status = -EOPNOTSUPP;
1889 dev_dbg(&udev->dev, "usb resume\n");
1890 /* TRSMRCY = 10 msec */
1892 usb_set_device_state (udev, USB_STATE_CONFIGURED);
1893 udev->dev.power.power_state = PMSG_ON;
1894 status = hub_resume (udev
1895 ->actconfig->interface[0]);
1897 } else if (udev->state == USB_STATE_SUSPENDED) {
1898 // NOTE this fails if parent is also suspended...
1899 status = hub_port_resume(hdev_to_hub(udev->parent),
1905 dev_dbg(&udev->dev, "can't resume, status %d\n",
1909 usb_unlock_device(udev);
1911 /* rebind drivers that had no suspend() */
1913 usb_lock_all_devices();
1914 bus_rescan_devices(&usb_bus_type);
1915 usb_unlock_all_devices();
1920 static int remote_wakeup(struct usb_device *udev)
1924 /* don't repeat RESUME sequence if this device
1925 * was already woken up by some other task
1927 down(&udev->serialize);
1928 if (udev->state == USB_STATE_SUSPENDED) {
1929 dev_dbg(&udev->dev, "RESUME (wakeup)\n");
1930 /* TRSMRCY = 10 msec */
1932 status = finish_port_resume(udev);
1934 up(&udev->serialize);
1938 static int hub_suspend(struct usb_interface *intf, pm_message_t state)
1940 struct usb_hub *hub = usb_get_intfdata (intf);
1941 struct usb_device *hdev = hub->hdev;
1945 /* stop khubd and related activity */
1948 /* then suspend every port */
1949 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1950 struct usb_device *udev;
1952 udev = hdev->children [port1-1];
1955 down(&udev->serialize);
1956 status = __usb_suspend_device(udev, port1, state);
1957 up(&udev->serialize);
1959 dev_dbg(&intf->dev, "suspend port %d --> %d\n",
1963 intf->dev.power.power_state = state;
1967 static int hub_resume(struct usb_interface *intf)
1969 struct usb_device *hdev = interface_to_usbdev(intf);
1970 struct usb_hub *hub = usb_get_intfdata (intf);
1974 if (intf->dev.power.power_state.event == PM_EVENT_ON)
1977 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1978 struct usb_device *udev;
1979 u16 portstat, portchange;
1981 udev = hdev->children [port1-1];
1982 status = hub_port_status(hub, port1, &portstat, &portchange);
1984 if (portchange & USB_PORT_STAT_C_SUSPEND) {
1985 clear_port_feature(hdev, port1,
1986 USB_PORT_FEAT_C_SUSPEND);
1987 portchange &= ~USB_PORT_STAT_C_SUSPEND;
1990 /* let khubd handle disconnects etc */
1995 if (!udev || status < 0)
1997 down (&udev->serialize);
1998 if (portstat & USB_PORT_STAT_SUSPEND)
1999 status = hub_port_resume(hub, port1, udev);
2001 status = finish_port_resume(udev);
2003 dev_dbg(&intf->dev, "resume port %d --> %d\n",
2005 hub_port_logical_disconnect(hub, port1);
2008 up(&udev->serialize);
2010 intf->dev.power.power_state = PMSG_ON;
2012 hub->resume_root_hub = 0;
2017 void usb_resume_root_hub(struct usb_device *hdev)
2019 struct usb_hub *hub = hdev_to_hub(hdev);
2021 hub->resume_root_hub = 1;
2025 #else /* !CONFIG_USB_SUSPEND */
2027 int usb_suspend_device(struct usb_device *udev, pm_message_t state)
2032 int usb_resume_device(struct usb_device *udev)
2037 #define hub_suspend NULL
2038 #define hub_resume NULL
2039 #define remote_wakeup(x) 0
2041 #endif /* CONFIG_USB_SUSPEND */
2043 EXPORT_SYMBOL(usb_suspend_device);
2044 EXPORT_SYMBOL(usb_resume_device);
2048 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2050 * Between connect detection and reset signaling there must be a delay
2051 * of 100ms at least for debounce and power-settling. The corresponding
2052 * timer shall restart whenever the downstream port detects a disconnect.
2054 * Apparently there are some bluetooth and irda-dongles and a number of
2055 * low-speed devices for which this debounce period may last over a second.
2056 * Not covered by the spec - but easy to deal with.
2058 * This implementation uses a 1500ms total debounce timeout; if the
2059 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2060 * every 25ms for transient disconnects. When the port status has been
2061 * unchanged for 100ms it returns the port status.
2064 #define HUB_DEBOUNCE_TIMEOUT 1500
2065 #define HUB_DEBOUNCE_STEP 25
2066 #define HUB_DEBOUNCE_STABLE 100
2068 static int hub_port_debounce(struct usb_hub *hub, int port1)
2071 int total_time, stable_time = 0;
2072 u16 portchange, portstatus;
2073 unsigned connection = 0xffff;
2075 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2076 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2080 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2081 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2082 stable_time += HUB_DEBOUNCE_STEP;
2083 if (stable_time >= HUB_DEBOUNCE_STABLE)
2087 connection = portstatus & USB_PORT_STAT_CONNECTION;
2090 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2091 clear_port_feature(hub->hdev, port1,
2092 USB_PORT_FEAT_C_CONNECTION);
2095 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2097 msleep(HUB_DEBOUNCE_STEP);
2100 dev_dbg (hub->intfdev,
2101 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2102 port1, total_time, stable_time, portstatus);
2104 if (stable_time < HUB_DEBOUNCE_STABLE)
2109 static void ep0_reinit(struct usb_device *udev)
2111 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
2112 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
2113 udev->ep_in[0] = udev->ep_out[0] = &udev->ep0;
2116 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2117 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2119 static int hub_set_address(struct usb_device *udev)
2123 if (udev->devnum == 0)
2125 if (udev->state == USB_STATE_ADDRESS)
2127 if (udev->state != USB_STATE_DEFAULT)
2129 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2130 USB_REQ_SET_ADDRESS, 0, udev->devnum, 0,
2131 NULL, 0, USB_CTRL_SET_TIMEOUT);
2133 usb_set_device_state(udev, USB_STATE_ADDRESS);
2139 /* Reset device, (re)assign address, get device descriptor.
2140 * Device connection must be stable, no more debouncing needed.
2141 * Returns device in USB_STATE_ADDRESS, except on error.
2143 * If this is called for an already-existing device (as part of
2144 * usb_reset_device), the caller must own the device lock. For a
2145 * newly detected device that is not accessible through any global
2146 * pointers, it's not necessary to lock the device.
2149 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2152 static DECLARE_MUTEX(usb_address0_sem);
2154 struct usb_device *hdev = hub->hdev;
2156 unsigned delay = HUB_SHORT_RESET_TIME;
2157 enum usb_device_speed oldspeed = udev->speed;
2159 /* root hub ports have a slightly longer reset period
2160 * (from USB 2.0 spec, section 7.1.7.5)
2162 if (!hdev->parent) {
2163 delay = HUB_ROOT_RESET_TIME;
2164 if (port1 == hdev->bus->otg_port)
2165 hdev->bus->b_hnp_enable = 0;
2168 /* Some low speed devices have problems with the quick delay, so */
2169 /* be a bit pessimistic with those devices. RHbug #23670 */
2170 if (oldspeed == USB_SPEED_LOW)
2171 delay = HUB_LONG_RESET_TIME;
2173 down(&usb_address0_sem);
2175 /* Reset the device; full speed may morph to high speed */
2176 retval = hub_port_reset(hub, port1, udev, delay);
2177 if (retval < 0) /* error or disconnect */
2179 /* success, speed is known */
2182 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2183 dev_dbg(&udev->dev, "device reset changed speed!\n");
2186 oldspeed = udev->speed;
2188 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2189 * it's fixed size except for full speed devices.
2191 switch (udev->speed) {
2192 case USB_SPEED_HIGH: /* fixed at 64 */
2193 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2195 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2196 /* to determine the ep0 maxpacket size, try to read
2197 * the device descriptor to get bMaxPacketSize0 and
2198 * then correct our initial guess.
2200 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2202 case USB_SPEED_LOW: /* fixed at 8 */
2203 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2209 dev_info (&udev->dev,
2210 "%s %s speed USB device using %s and address %d\n",
2211 (udev->config) ? "reset" : "new",
2212 ({ char *speed; switch (udev->speed) {
2213 case USB_SPEED_LOW: speed = "low"; break;
2214 case USB_SPEED_FULL: speed = "full"; break;
2215 case USB_SPEED_HIGH: speed = "high"; break;
2216 default: speed = "?"; break;
2218 udev->bus->controller->driver->name,
2221 /* Set up TT records, if needed */
2223 udev->tt = hdev->tt;
2224 udev->ttport = hdev->ttport;
2225 } else if (udev->speed != USB_SPEED_HIGH
2226 && hdev->speed == USB_SPEED_HIGH) {
2227 udev->tt = &hub->tt;
2228 udev->ttport = port1;
2231 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2232 * Because device hardware and firmware is sometimes buggy in
2233 * this area, and this is how Linux has done it for ages.
2234 * Change it cautiously.
2236 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2237 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2238 * so it may help with some non-standards-compliant devices.
2239 * Otherwise we start with SET_ADDRESS and then try to read the
2240 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2243 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2244 if (USE_NEW_SCHEME(retry_counter)) {
2245 struct usb_device_descriptor *buf;
2248 #define GET_DESCRIPTOR_BUFSIZE 64
2249 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2255 /* Use a short timeout the first time through,
2256 * so that recalcitrant full-speed devices with
2257 * 8- or 16-byte ep0-maxpackets won't slow things
2258 * down tremendously by NAKing the unexpectedly
2259 * early status stage. Also, retry on all errors;
2260 * some devices are flakey.
2262 for (j = 0; j < 3; ++j) {
2263 buf->bMaxPacketSize0 = 0;
2264 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2265 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2266 USB_DT_DEVICE << 8, 0,
2267 buf, GET_DESCRIPTOR_BUFSIZE,
2268 (i ? USB_CTRL_GET_TIMEOUT : 1000));
2269 switch (buf->bMaxPacketSize0) {
2270 case 8: case 16: case 32: case 64:
2271 if (buf->bDescriptorType ==
2285 udev->descriptor.bMaxPacketSize0 =
2286 buf->bMaxPacketSize0;
2289 retval = hub_port_reset(hub, port1, udev, delay);
2290 if (retval < 0) /* error or disconnect */
2292 if (oldspeed != udev->speed) {
2294 "device reset changed speed!\n");
2299 dev_err(&udev->dev, "device descriptor "
2300 "read/%s, error %d\n",
2305 #undef GET_DESCRIPTOR_BUFSIZE
2308 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2309 retval = hub_set_address(udev);
2316 "device not accepting address %d, error %d\n",
2317 udev->devnum, retval);
2321 /* cope with hardware quirkiness:
2322 * - let SET_ADDRESS settle, some device hardware wants it
2323 * - read ep0 maxpacket even for high and low speed,
2326 if (USE_NEW_SCHEME(retry_counter))
2329 retval = usb_get_device_descriptor(udev, 8);
2331 dev_err(&udev->dev, "device descriptor "
2332 "read/%s, error %d\n",
2344 i = udev->descriptor.bMaxPacketSize0;
2345 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2346 if (udev->speed != USB_SPEED_FULL ||
2347 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2348 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2352 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2353 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2357 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2358 if (retval < (signed)sizeof(udev->descriptor)) {
2359 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2370 hub_port_disable(hub, port1, 0);
2371 up(&usb_address0_sem);
2376 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2378 struct usb_qualifier_descriptor *qual;
2381 qual = kmalloc (sizeof *qual, SLAB_KERNEL);
2385 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2386 qual, sizeof *qual);
2387 if (status == sizeof *qual) {
2388 dev_info(&udev->dev, "not running at top speed; "
2389 "connect to a high speed hub\n");
2390 /* hub LEDs are probably harder to miss than syslog */
2391 if (hub->has_indicators) {
2392 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2393 schedule_work (&hub->leds);
2400 hub_power_remaining (struct usb_hub *hub)
2402 struct usb_device *hdev = hub->hdev;
2406 remaining = hub->power_budget;
2407 if (!remaining) /* self-powered */
2410 for (i = 0; i < hdev->maxchild; i++) {
2411 struct usb_device *udev = hdev->children[i];
2417 /* 100mA per-port ceiling, or 8mA for OTG ports */
2418 if (i != (udev->bus->otg_port - 1) || hdev->parent)
2423 if (udev->actconfig)
2424 delta = udev->actconfig->desc.bMaxPower;
2427 // dev_dbg(&udev->dev, "budgeted %dmA\n", 2 * delta);
2428 if (delta > ceiling)
2429 dev_warn(&udev->dev, "%dmA over %dmA budget!\n",
2430 2 * (delta - ceiling), 2 * ceiling);
2433 if (remaining < 0) {
2434 dev_warn(hub->intfdev,
2435 "%dmA over power budget!\n",
2442 /* Handle physical or logical connection change events.
2443 * This routine is called when:
2444 * a port connection-change occurs;
2445 * a port enable-change occurs (often caused by EMI);
2446 * usb_reset_device() encounters changed descriptors (as from
2447 * a firmware download)
2448 * caller already locked the hub
2450 static void hub_port_connect_change(struct usb_hub *hub, int port1,
2451 u16 portstatus, u16 portchange)
2453 struct usb_device *hdev = hub->hdev;
2454 struct device *hub_dev = hub->intfdev;
2458 "port %d, status %04x, change %04x, %s\n",
2459 port1, portstatus, portchange, portspeed (portstatus));
2461 if (hub->has_indicators) {
2462 set_port_led(hub, port1, HUB_LED_AUTO);
2463 hub->indicator[port1-1] = INDICATOR_AUTO;
2466 /* Disconnect any existing devices under this port */
2467 if (hdev->children[port1-1])
2468 usb_disconnect(&hdev->children[port1-1]);
2469 clear_bit(port1, hub->change_bits);
2471 #ifdef CONFIG_USB_OTG
2472 /* during HNP, don't repeat the debounce */
2473 if (hdev->bus->is_b_host)
2474 portchange &= ~USB_PORT_STAT_C_CONNECTION;
2477 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2478 status = hub_port_debounce(hub, port1);
2481 "connect-debounce failed, port %d disabled\n",
2485 portstatus = status;
2488 /* Return now if nothing is connected */
2489 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2491 /* maybe switch power back on (e.g. root hub was reset) */
2492 if ((hub->descriptor->wHubCharacteristics
2493 & HUB_CHAR_LPSM) < 2
2494 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2495 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2497 if (portstatus & USB_PORT_STAT_ENABLE)
2502 #ifdef CONFIG_USB_SUSPEND
2503 /* If something is connected, but the port is suspended, wake it up. */
2504 if (portstatus & USB_PORT_STAT_SUSPEND) {
2505 status = hub_port_resume(hub, port1, NULL);
2508 "can't clear suspend on port %d; %d\n",
2515 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2516 struct usb_device *udev;
2518 /* reallocate for each attempt, since references
2519 * to the previous one can escape in various ways
2521 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2524 "couldn't allocate port %d usb_device\n",
2529 usb_set_device_state(udev, USB_STATE_POWERED);
2530 udev->speed = USB_SPEED_UNKNOWN;
2532 /* set the address */
2533 choose_address(udev);
2534 if (udev->devnum <= 0) {
2535 status = -ENOTCONN; /* Don't retry */
2539 /* reset and get descriptor */
2540 status = hub_port_init(hub, udev, port1, i);
2544 /* consecutive bus-powered hubs aren't reliable; they can
2545 * violate the voltage drop budget. if the new child has
2546 * a "powered" LED, users should notice we didn't enable it
2547 * (without reading syslog), even without per-port LEDs
2550 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
2551 && hub->power_budget) {
2554 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2557 dev_dbg(&udev->dev, "get status %d ?\n", status);
2560 cpu_to_le16s(&devstat);
2561 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2563 "can't connect bus-powered hub "
2565 if (hub->has_indicators) {
2566 hub->indicator[port1-1] =
2567 INDICATOR_AMBER_BLINK;
2568 schedule_work (&hub->leds);
2570 status = -ENOTCONN; /* Don't retry */
2575 /* check for devices running slower than they could */
2576 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2577 && udev->speed == USB_SPEED_FULL
2578 && highspeed_hubs != 0)
2579 check_highspeed (hub, udev, port1);
2581 /* Store the parent's children[] pointer. At this point
2582 * udev becomes globally accessible, although presumably
2583 * no one will look at it until hdev is unlocked.
2585 down (&udev->serialize);
2588 /* We mustn't add new devices if the parent hub has
2589 * been disconnected; we would race with the
2590 * recursively_mark_NOTATTACHED() routine.
2592 spin_lock_irq(&device_state_lock);
2593 if (hdev->state == USB_STATE_NOTATTACHED)
2596 hdev->children[port1-1] = udev;
2597 spin_unlock_irq(&device_state_lock);
2599 /* Run it through the hoops (find a driver, etc) */
2601 status = usb_new_device(udev);
2603 spin_lock_irq(&device_state_lock);
2604 hdev->children[port1-1] = NULL;
2605 spin_unlock_irq(&device_state_lock);
2609 up (&udev->serialize);
2613 status = hub_power_remaining(hub);
2616 "%dmA power budget left\n",
2622 hub_port_disable(hub, port1, 1);
2625 release_address(udev);
2627 if (status == -ENOTCONN)
2632 hub_port_disable(hub, port1, 1);
2635 static void hub_events(void)
2637 struct list_head *tmp;
2638 struct usb_device *hdev;
2639 struct usb_interface *intf;
2640 struct usb_hub *hub;
2641 struct device *hub_dev;
2650 * We restart the list every time to avoid a deadlock with
2651 * deleting hubs downstream from this one. This should be
2652 * safe since we delete the hub from the event list.
2653 * Not the most efficient, but avoids deadlocks.
2657 /* Grab the first entry at the beginning of the list */
2658 spin_lock_irq(&hub_event_lock);
2659 if (list_empty(&hub_event_list)) {
2660 spin_unlock_irq(&hub_event_lock);
2664 tmp = hub_event_list.next;
2667 hub = list_entry(tmp, struct usb_hub, event_list);
2669 intf = to_usb_interface(hub->intfdev);
2670 hub_dev = &intf->dev;
2672 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
2673 hdev->state, hub->descriptor
2674 ? hub->descriptor->bNbrPorts
2676 /* NOTE: expects max 15 ports... */
2677 (u16) hub->change_bits[0],
2678 (u16) hub->event_bits[0]);
2681 i = hub->resume_root_hub;
2682 spin_unlock_irq(&hub_event_lock);
2684 /* Is this is a root hub wanting to be resumed? */
2686 usb_resume_device(hdev);
2688 /* Lock the device, then check to see if we were
2689 * disconnected while waiting for the lock to succeed. */
2690 if (locktree(hdev) < 0) {
2694 if (hub != usb_get_intfdata(intf))
2697 /* If the hub has died, clean up after it */
2698 if (hdev->state == USB_STATE_NOTATTACHED) {
2703 /* If this is an inactive or suspended hub, do nothing */
2708 dev_dbg (hub_dev, "resetting for error %d\n",
2711 ret = usb_reset_device(hdev);
2714 "error resetting hub: %d\n", ret);
2722 /* deal with port status changes */
2723 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2724 if (test_bit(i, hub->busy_bits))
2726 connect_change = test_bit(i, hub->change_bits);
2727 if (!test_and_clear_bit(i, hub->event_bits) &&
2728 !connect_change && !hub->activating)
2731 ret = hub_port_status(hub, i,
2732 &portstatus, &portchange);
2736 if (hub->activating && !hdev->children[i-1] &&
2738 USB_PORT_STAT_CONNECTION))
2741 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2742 clear_port_feature(hdev, i,
2743 USB_PORT_FEAT_C_CONNECTION);
2747 if (portchange & USB_PORT_STAT_C_ENABLE) {
2748 if (!connect_change)
2750 "port %d enable change, "
2753 clear_port_feature(hdev, i,
2754 USB_PORT_FEAT_C_ENABLE);
2757 * EM interference sometimes causes badly
2758 * shielded USB devices to be shutdown by
2759 * the hub, this hack enables them again.
2760 * Works at least with mouse driver.
2762 if (!(portstatus & USB_PORT_STAT_ENABLE)
2764 && hdev->children[i-1]) {
2767 "disabled by hub (EMI?), "
2774 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2775 clear_port_feature(hdev, i,
2776 USB_PORT_FEAT_C_SUSPEND);
2777 if (hdev->children[i-1]) {
2778 ret = remote_wakeup(hdev->
2784 hub_port_disable(hub, i, 1);
2787 "resume on port %d, status %d\n",
2791 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2793 "over-current change on port %d\n",
2795 clear_port_feature(hdev, i,
2796 USB_PORT_FEAT_C_OVER_CURRENT);
2800 if (portchange & USB_PORT_STAT_C_RESET) {
2802 "reset change on port %d\n",
2804 clear_port_feature(hdev, i,
2805 USB_PORT_FEAT_C_RESET);
2809 hub_port_connect_change(hub, i,
2810 portstatus, portchange);
2813 /* deal with hub status changes */
2814 if (test_and_clear_bit(0, hub->event_bits) == 0)
2816 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2817 dev_err (hub_dev, "get_hub_status failed\n");
2819 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2820 dev_dbg (hub_dev, "power change\n");
2821 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
2823 if (hubchange & HUB_CHANGE_OVERCURRENT) {
2824 dev_dbg (hub_dev, "overcurrent change\n");
2825 msleep(500); /* Cool down */
2826 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
2831 hub->activating = 0;
2833 /* If this is a root hub, tell the HCD it's okay to
2834 * re-enable port-change interrupts now. */
2836 usb_enable_root_hub_irq(hdev->bus);
2839 usb_unlock_device(hdev);
2842 } /* end while (1) */
2845 static int hub_thread(void *__unused)
2849 wait_event_interruptible(khubd_wait,
2850 !list_empty(&hub_event_list) ||
2851 kthread_should_stop());
2853 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
2855 pr_debug("%s: khubd exiting\n", usbcore_name);
2859 static struct usb_device_id hub_id_table [] = {
2860 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
2861 .bDeviceClass = USB_CLASS_HUB},
2862 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2863 .bInterfaceClass = USB_CLASS_HUB},
2864 { } /* Terminating entry */
2867 MODULE_DEVICE_TABLE (usb, hub_id_table);
2869 static struct usb_driver hub_driver = {
2870 .owner = THIS_MODULE,
2873 .disconnect = hub_disconnect,
2874 .suspend = hub_suspend,
2875 .resume = hub_resume,
2877 .id_table = hub_id_table,
2880 int usb_hub_init(void)
2882 if (usb_register(&hub_driver) < 0) {
2883 printk(KERN_ERR "%s: can't register hub driver\n",
2888 khubd_task = kthread_run(hub_thread, NULL, "khubd");
2889 if (!IS_ERR(khubd_task))
2892 /* Fall through if kernel_thread failed */
2893 usb_deregister(&hub_driver);
2894 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
2899 void usb_hub_cleanup(void)
2901 kthread_stop(khubd_task);
2904 * Hub resources are freed for us by usb_deregister. It calls
2905 * usb_driver_purge on every device which in turn calls that
2906 * devices disconnect function if it is using this driver.
2907 * The hub_disconnect function takes care of releasing the
2908 * individual hub resources. -greg
2910 usb_deregister(&hub_driver);
2911 } /* usb_hub_cleanup() */
2913 static int config_descriptors_changed(struct usb_device *udev)
2917 struct usb_config_descriptor *buf;
2919 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2920 if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
2921 len = le16_to_cpu(udev->config[index].desc.wTotalLength);
2923 buf = kmalloc (len, SLAB_KERNEL);
2925 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
2926 /* assume the worst */
2929 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2931 int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
2933 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
2935 if (length < old_length) {
2936 dev_dbg(&udev->dev, "config index %d, error %d\n",
2940 if (memcmp (buf, udev->rawdescriptors[index], old_length)
2942 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
2943 index, buf->bConfigurationValue);
2948 return index != udev->descriptor.bNumConfigurations;
2952 * usb_reset_device - perform a USB port reset to reinitialize a device
2953 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2955 * WARNING - don't reset any device unless drivers for all of its
2956 * interfaces are expecting that reset! Maybe some driver->reset()
2957 * method should eventually help ensure sufficient cooperation.
2959 * Do a port reset, reassign the device's address, and establish its
2960 * former operating configuration. If the reset fails, or the device's
2961 * descriptors change from their values before the reset, or the original
2962 * configuration and altsettings cannot be restored, a flag will be set
2963 * telling khubd to pretend the device has been disconnected and then
2964 * re-connected. All drivers will be unbound, and the device will be
2965 * re-enumerated and probed all over again.
2967 * Returns 0 if the reset succeeded, -ENODEV if the device has been
2968 * flagged for logical disconnection, or some other negative error code
2969 * if the reset wasn't even attempted.
2971 * The caller must own the device lock. For example, it's safe to use
2972 * this from a driver probe() routine after downloading new firmware.
2973 * For calls that might not occur during probe(), drivers should lock
2974 * the device using usb_lock_device_for_reset().
2976 int usb_reset_device(struct usb_device *udev)
2978 struct usb_device *parent_hdev = udev->parent;
2979 struct usb_hub *parent_hub;
2980 struct usb_device_descriptor descriptor = udev->descriptor;
2981 struct usb_hub *hub = NULL;
2982 int i, ret = 0, port1 = -1;
2984 if (udev->state == USB_STATE_NOTATTACHED ||
2985 udev->state == USB_STATE_SUSPENDED) {
2986 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
2992 /* this requires hcd-specific logic; see OHCI hc_restart() */
2993 dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
2997 for (i = 0; i < parent_hdev->maxchild; i++)
2998 if (parent_hdev->children[i] == udev) {
3004 /* If this ever happens, it's very bad */
3005 dev_err(&udev->dev, "Can't locate device's port!\n");
3008 parent_hub = hdev_to_hub(parent_hdev);
3010 /* If we're resetting an active hub, take some special actions */
3011 if (udev->actconfig &&
3012 udev->actconfig->interface[0]->dev.driver ==
3013 &hub_driver.driver &&
3014 (hub = hdev_to_hub(udev)) != NULL) {
3018 set_bit(port1, parent_hub->busy_bits);
3019 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3021 /* ep0 maxpacket size may change; let the HCD know about it.
3022 * Other endpoints will be handled by re-enumeration. */
3024 ret = hub_port_init(parent_hub, udev, port1, i);
3028 clear_bit(port1, parent_hub->busy_bits);
3032 /* Device might have changed firmware (DFU or similar) */
3033 if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
3034 || config_descriptors_changed (udev)) {
3035 dev_info(&udev->dev, "device firmware changed\n");
3036 udev->descriptor = descriptor; /* for disconnect() calls */
3040 if (!udev->actconfig)
3043 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3044 USB_REQ_SET_CONFIGURATION, 0,
3045 udev->actconfig->desc.bConfigurationValue, 0,
3046 NULL, 0, USB_CTRL_SET_TIMEOUT);
3049 "can't restore configuration #%d (error=%d)\n",
3050 udev->actconfig->desc.bConfigurationValue, ret);
3053 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3055 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3056 struct usb_interface *intf = udev->actconfig->interface[i];
3057 struct usb_interface_descriptor *desc;
3059 /* set_interface resets host side toggle even
3060 * for altsetting zero. the interface may have no driver.
3062 desc = &intf->cur_altsetting->desc;
3063 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3064 desc->bAlternateSetting);
3066 dev_err(&udev->dev, "failed to restore interface %d "
3067 "altsetting %d (error=%d)\n",
3068 desc->bInterfaceNumber,
3069 desc->bAlternateSetting,
3077 hub_post_reset(hub);
3081 hub_port_logical_disconnect(parent_hub, port1);