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 static void hub_disconnect(struct usb_interface *intf)
734 struct usb_hub *hub = usb_get_intfdata (intf);
735 struct usb_device *hdev;
737 usb_set_intfdata (intf, NULL);
740 if (hdev->speed == USB_SPEED_HIGH)
744 usb_free_urb(hub->urb);
747 spin_lock_irq(&hub_event_lock);
748 list_del_init(&hub->event_list);
749 spin_unlock_irq(&hub_event_lock);
751 kfree(hub->descriptor);
752 hub->descriptor = NULL;
758 usb_buffer_free(hdev, sizeof(*hub->buffer), hub->buffer,
763 /* Free the memory */
767 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
769 struct usb_host_interface *desc;
770 struct usb_endpoint_descriptor *endpoint;
771 struct usb_device *hdev;
774 desc = intf->cur_altsetting;
775 hdev = interface_to_usbdev(intf);
777 /* Some hubs have a subclass of 1, which AFAICT according to the */
778 /* specs is not defined, but it works */
779 if ((desc->desc.bInterfaceSubClass != 0) &&
780 (desc->desc.bInterfaceSubClass != 1)) {
782 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
786 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
787 if (desc->desc.bNumEndpoints != 1)
788 goto descriptor_error;
790 endpoint = &desc->endpoint[0].desc;
792 /* Output endpoint? Curiouser and curiouser.. */
793 if (!(endpoint->bEndpointAddress & USB_DIR_IN))
794 goto descriptor_error;
796 /* If it's not an interrupt endpoint, we'd better punt! */
797 if ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
798 != USB_ENDPOINT_XFER_INT)
799 goto descriptor_error;
802 dev_info (&intf->dev, "USB hub found\n");
804 hub = kmalloc(sizeof(*hub), GFP_KERNEL);
806 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
810 memset(hub, 0, sizeof(*hub));
812 INIT_LIST_HEAD(&hub->event_list);
813 hub->intfdev = &intf->dev;
815 INIT_WORK(&hub->leds, led_work, hub);
817 usb_set_intfdata (intf, hub);
819 if (hdev->speed == USB_SPEED_HIGH)
822 if (hub_configure(hub, endpoint) >= 0)
825 hub_disconnect (intf);
830 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
832 struct usb_device *hdev = interface_to_usbdev (intf);
834 /* assert ifno == 0 (part of hub spec) */
836 case USBDEVFS_HUB_PORTINFO: {
837 struct usbdevfs_hub_portinfo *info = user_data;
840 spin_lock_irq(&device_state_lock);
841 if (hdev->devnum <= 0)
844 info->nports = hdev->maxchild;
845 for (i = 0; i < info->nports; i++) {
846 if (hdev->children[i] == NULL)
850 hdev->children[i]->devnum;
853 spin_unlock_irq(&device_state_lock);
855 return info->nports + 1;
863 /* caller has locked the hub device */
864 static void hub_pre_reset(struct usb_hub *hub)
866 struct usb_device *hdev = hub->hdev;
869 for (i = 0; i < hdev->maxchild; ++i) {
870 if (hdev->children[i])
871 usb_disconnect(&hdev->children[i]);
876 /* caller has locked the hub device */
877 static void hub_post_reset(struct usb_hub *hub)
884 /* grab device/port lock, returning index of that port (zero based).
885 * protects the upstream link used by this device from concurrent
886 * tree operations like suspend, resume, reset, and disconnect, which
887 * apply to everything downstream of a given port.
889 static int locktree(struct usb_device *udev)
892 struct usb_device *hdev;
897 /* root hub is always the first lock in the series */
900 usb_lock_device(udev);
904 /* on the path from root to us, lock everything from
905 * top down, dropping parent locks when not needed
910 for (t = 0; t < hdev->maxchild; t++) {
911 if (hdev->children[t] == udev) {
912 /* everything is fail-fast once disconnect
915 if (udev->state == USB_STATE_NOTATTACHED)
918 /* when everyone grabs locks top->bottom,
919 * non-overlapping work may be concurrent
921 down(&udev->serialize);
922 up(&hdev->serialize);
926 usb_unlock_device(hdev);
930 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
934 for (i = 0; i < udev->maxchild; ++i) {
935 if (udev->children[i])
936 recursively_mark_NOTATTACHED(udev->children[i]);
938 udev->state = USB_STATE_NOTATTACHED;
942 * usb_set_device_state - change a device's current state (usbcore, hcds)
943 * @udev: pointer to device whose state should be changed
944 * @new_state: new state value to be stored
946 * udev->state is _not_ fully protected by the device lock. Although
947 * most transitions are made only while holding the lock, the state can
948 * can change to USB_STATE_NOTATTACHED at almost any time. This
949 * is so that devices can be marked as disconnected as soon as possible,
950 * without having to wait for any semaphores to be released. As a result,
951 * all changes to any device's state must be protected by the
952 * device_state_lock spinlock.
954 * Once a device has been added to the device tree, all changes to its state
955 * should be made using this routine. The state should _not_ be set directly.
957 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
958 * Otherwise udev->state is set to new_state, and if new_state is
959 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
960 * to USB_STATE_NOTATTACHED.
962 void usb_set_device_state(struct usb_device *udev,
963 enum usb_device_state new_state)
967 spin_lock_irqsave(&device_state_lock, flags);
968 if (udev->state == USB_STATE_NOTATTACHED)
970 else if (new_state != USB_STATE_NOTATTACHED)
971 udev->state = new_state;
973 recursively_mark_NOTATTACHED(udev);
974 spin_unlock_irqrestore(&device_state_lock, flags);
976 EXPORT_SYMBOL(usb_set_device_state);
979 static void choose_address(struct usb_device *udev)
982 struct usb_bus *bus = udev->bus;
984 /* If khubd ever becomes multithreaded, this will need a lock */
986 /* Try to allocate the next devnum beginning at bus->devnum_next. */
987 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
990 devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
992 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
995 set_bit(devnum, bus->devmap.devicemap);
996 udev->devnum = devnum;
1000 static void release_address(struct usb_device *udev)
1002 if (udev->devnum > 0) {
1003 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1009 * usb_disconnect - disconnect a device (usbcore-internal)
1010 * @pdev: pointer to device being disconnected
1011 * Context: !in_interrupt ()
1013 * Something got disconnected. Get rid of it and all of its children.
1015 * If *pdev is a normal device then the parent hub must already be locked.
1016 * If *pdev is a root hub then this routine will acquire the
1017 * usb_bus_list_lock on behalf of the caller.
1019 * Only hub drivers (including virtual root hub drivers for host
1020 * controllers) should ever call this.
1022 * This call is synchronous, and may not be used in an interrupt context.
1024 void usb_disconnect(struct usb_device **pdev)
1026 struct usb_device *udev = *pdev;
1030 pr_debug ("%s nodev\n", __FUNCTION__);
1034 /* mark the device as inactive, so any further urb submissions for
1035 * this device (and any of its children) will fail immediately.
1036 * this quiesces everyting except pending urbs.
1038 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1040 /* lock the bus list on behalf of HCDs unregistering their root hubs */
1041 if (!udev->parent) {
1042 down(&usb_bus_list_lock);
1043 usb_lock_device(udev);
1045 down(&udev->serialize);
1047 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1049 /* Free up all the children before we remove this device */
1050 for (i = 0; i < USB_MAXCHILDREN; i++) {
1051 if (udev->children[i])
1052 usb_disconnect(&udev->children[i]);
1055 /* deallocate hcd/hardware state ... nuking all pending urbs and
1056 * cleaning up all state associated with the current configuration
1057 * so that the hardware is now fully quiesced.
1059 usb_disable_device(udev, 0);
1061 /* Free the device number, remove the /proc/bus/usb entry and
1062 * the sysfs attributes, and delete the parent's children[]
1063 * (or root_hub) pointer.
1065 dev_dbg (&udev->dev, "unregistering device\n");
1066 release_address(udev);
1067 usbfs_remove_device(udev);
1068 usbdev_remove(udev);
1069 usb_remove_sysfs_dev_files(udev);
1071 /* Avoid races with recursively_mark_NOTATTACHED() */
1072 spin_lock_irq(&device_state_lock);
1074 spin_unlock_irq(&device_state_lock);
1076 if (!udev->parent) {
1077 usb_unlock_device(udev);
1078 up(&usb_bus_list_lock);
1080 up(&udev->serialize);
1082 device_unregister(&udev->dev);
1085 static int choose_configuration(struct usb_device *udev)
1089 /* NOTE: this should interact with hub power budgeting */
1091 c = udev->config[0].desc.bConfigurationValue;
1092 if (udev->descriptor.bNumConfigurations != 1) {
1093 for (i = 0; i < udev->descriptor.bNumConfigurations; i++) {
1094 struct usb_interface_descriptor *desc;
1096 /* heuristic: Linux is more likely to have class
1097 * drivers, so avoid vendor-specific interfaces.
1099 desc = &udev->config[i].intf_cache[0]
1101 if (desc->bInterfaceClass == USB_CLASS_VENDOR_SPEC)
1103 /* COMM/2/all is CDC ACM, except 0xff is MSFT RNDIS.
1104 * MSFT needs this to be the first config; never use
1105 * it as the default unless Linux has host-side RNDIS.
1106 * A second config would ideally be CDC-Ethernet, but
1107 * may instead be the "vendor specific" CDC subset
1108 * long used by ARM Linux for sa1100 or pxa255.
1110 if (desc->bInterfaceClass == USB_CLASS_COMM
1111 && desc->bInterfaceSubClass == 2
1112 && desc->bInterfaceProtocol == 0xff) {
1113 c = udev->config[1].desc.bConfigurationValue;
1116 c = udev->config[i].desc.bConfigurationValue;
1119 dev_info(&udev->dev,
1120 "configuration #%d chosen from %d choices\n",
1121 c, udev->descriptor.bNumConfigurations);
1127 static void show_string(struct usb_device *udev, char *id, char *string)
1131 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1135 static inline void show_string(struct usb_device *udev, char *id, char *string)
1139 static void get_string(struct usb_device *udev, char **string, int index)
1145 buf = kmalloc(256, GFP_KERNEL);
1148 if (usb_string(udev, index, buf, 256) > 0)
1155 #ifdef CONFIG_USB_OTG
1156 #include "otg_whitelist.h"
1160 * usb_new_device - perform initial device setup (usbcore-internal)
1161 * @udev: newly addressed device (in ADDRESS state)
1163 * This is called with devices which have been enumerated, but not yet
1164 * configured. The device descriptor is available, but not descriptors
1165 * for any device configuration. The caller must have locked udev and
1166 * either the parent hub (if udev is a normal device) or else the
1167 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1168 * udev has already been installed, but udev is not yet visible through
1169 * sysfs or other filesystem code.
1171 * Returns 0 for success (device is configured and listed, with its
1172 * interfaces, in sysfs); else a negative errno value.
1174 * This call is synchronous, and may not be used in an interrupt context.
1176 * Only the hub driver should ever call this; root hub registration
1177 * uses it indirectly.
1179 int usb_new_device(struct usb_device *udev)
1184 err = usb_get_configuration(udev);
1186 dev_err(&udev->dev, "can't read configurations, error %d\n",
1191 /* read the standard strings and cache them if present */
1192 get_string(udev, &udev->product, udev->descriptor.iProduct);
1193 get_string(udev, &udev->manufacturer, udev->descriptor.iManufacturer);
1194 get_string(udev, &udev->serial, udev->descriptor.iSerialNumber);
1196 /* Tell the world! */
1197 dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
1198 "SerialNumber=%d\n",
1199 udev->descriptor.iManufacturer,
1200 udev->descriptor.iProduct,
1201 udev->descriptor.iSerialNumber);
1202 show_string(udev, "Product", udev->product);
1203 show_string(udev, "Manufacturer", udev->manufacturer);
1204 show_string(udev, "SerialNumber", udev->serial);
1206 #ifdef CONFIG_USB_OTG
1208 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1209 * to wake us after we've powered off VBUS; and HNP, switching roles
1210 * "host" to "peripheral". The OTG descriptor helps figure this out.
1212 if (!udev->bus->is_b_host
1214 && udev->parent == udev->bus->root_hub) {
1215 struct usb_otg_descriptor *desc = 0;
1216 struct usb_bus *bus = udev->bus;
1218 /* descriptor may appear anywhere in config */
1219 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1220 le16_to_cpu(udev->config[0].desc.wTotalLength),
1221 USB_DT_OTG, (void **) &desc) == 0) {
1222 if (desc->bmAttributes & USB_OTG_HNP) {
1224 struct usb_device *root = udev->parent;
1226 for (port1 = 1; port1 <= root->maxchild;
1228 if (root->children[port1-1] == udev)
1232 dev_info(&udev->dev,
1233 "Dual-Role OTG device on %sHNP port\n",
1234 (port1 == bus->otg_port)
1237 /* enable HNP before suspend, it's simpler */
1238 if (port1 == bus->otg_port)
1239 bus->b_hnp_enable = 1;
1240 err = usb_control_msg(udev,
1241 usb_sndctrlpipe(udev, 0),
1242 USB_REQ_SET_FEATURE, 0,
1244 ? USB_DEVICE_B_HNP_ENABLE
1245 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1246 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1248 /* OTG MESSAGE: report errors here,
1249 * customize to match your product.
1251 dev_info(&udev->dev,
1252 "can't set HNP mode; %d\n",
1254 bus->b_hnp_enable = 0;
1260 if (!is_targeted(udev)) {
1262 /* Maybe it can talk to us, though we can't talk to it.
1263 * (Includes HNP test device.)
1265 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1266 static int __usb_suspend_device (struct usb_device *,
1267 int port1, pm_message_t state);
1268 err = __usb_suspend_device(udev,
1269 udev->bus->otg_port,
1272 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1279 /* put device-specific files into sysfs */
1280 err = device_add (&udev->dev);
1282 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1285 usb_create_sysfs_dev_files (udev);
1287 /* choose and set the configuration. that registers the interfaces
1288 * with the driver core, and lets usb device drivers bind to them.
1290 c = choose_configuration(udev);
1292 dev_warn(&udev->dev,
1293 "can't choose an initial configuration\n");
1295 err = usb_set_configuration(udev, c);
1297 dev_err(&udev->dev, "can't set config #%d, error %d\n",
1299 usb_remove_sysfs_dev_files(udev);
1300 device_del(&udev->dev);
1305 /* USB device state == configured ... usable */
1307 /* add a /proc/bus/usb entry */
1309 usbfs_add_device(udev);
1313 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1318 static int hub_port_status(struct usb_hub *hub, int port1,
1319 u16 *status, u16 *change)
1323 ret = get_port_status(hub->hdev, port1, &hub->status->port);
1325 dev_err (hub->intfdev,
1326 "%s failed (err = %d)\n", __FUNCTION__, ret);
1328 *status = le16_to_cpu(hub->status->port.wPortStatus);
1329 *change = le16_to_cpu(hub->status->port.wPortChange);
1335 #define PORT_RESET_TRIES 5
1336 #define SET_ADDRESS_TRIES 2
1337 #define GET_DESCRIPTOR_TRIES 2
1338 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1339 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1341 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1342 #define HUB_SHORT_RESET_TIME 10
1343 #define HUB_LONG_RESET_TIME 200
1344 #define HUB_RESET_TIMEOUT 500
1346 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1347 struct usb_device *udev, unsigned int delay)
1349 int delay_time, ret;
1353 for (delay_time = 0;
1354 delay_time < HUB_RESET_TIMEOUT;
1355 delay_time += delay) {
1356 /* wait to give the device a chance to reset */
1359 /* read and decode port status */
1360 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1364 /* Device went away? */
1365 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1368 /* bomb out completely if something weird happened */
1369 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1372 /* if we`ve finished resetting, then break out of the loop */
1373 if (!(portstatus & USB_PORT_STAT_RESET) &&
1374 (portstatus & USB_PORT_STAT_ENABLE)) {
1375 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1376 udev->speed = USB_SPEED_HIGH;
1377 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1378 udev->speed = USB_SPEED_LOW;
1380 udev->speed = USB_SPEED_FULL;
1384 /* switch to the long delay after two short delay failures */
1385 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1386 delay = HUB_LONG_RESET_TIME;
1388 dev_dbg (hub->intfdev,
1389 "port %d not reset yet, waiting %dms\n",
1396 static int hub_port_reset(struct usb_hub *hub, int port1,
1397 struct usb_device *udev, unsigned int delay)
1401 /* Reset the port */
1402 for (i = 0; i < PORT_RESET_TRIES; i++) {
1403 status = set_port_feature(hub->hdev,
1404 port1, USB_PORT_FEAT_RESET);
1406 dev_err(hub->intfdev,
1407 "cannot reset port %d (err = %d)\n",
1410 status = hub_port_wait_reset(hub, port1, udev, delay);
1412 dev_dbg(hub->intfdev,
1413 "port_wait_reset: err = %d\n",
1417 /* return on disconnect or reset */
1420 /* TRSTRCY = 10 ms */
1425 clear_port_feature(hub->hdev,
1426 port1, USB_PORT_FEAT_C_RESET);
1427 /* FIXME need disconnect() for NOTATTACHED device */
1428 usb_set_device_state(udev, status
1429 ? USB_STATE_NOTATTACHED
1430 : USB_STATE_DEFAULT);
1434 dev_dbg (hub->intfdev,
1435 "port %d not enabled, trying reset again...\n",
1437 delay = HUB_LONG_RESET_TIME;
1440 dev_err (hub->intfdev,
1441 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1448 * Disable a port and mark a logical connnect-change event, so that some
1449 * time later khubd will disconnect() any existing usb_device on the port
1450 * and will re-enumerate if there actually is a device attached.
1452 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
1454 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
1455 hub_port_disable(hub, port1, 1);
1457 /* FIXME let caller ask to power down the port:
1458 * - some devices won't enumerate without a VBUS power cycle
1459 * - SRP saves power that way
1460 * - usb_suspend_device(dev, PMSG_SUSPEND)
1461 * That's easy if this hub can switch power per-port, and
1462 * khubd reactivates the port later (timer, SRP, etc).
1463 * Powerdown must be optional, because of reset/DFU.
1466 set_bit(port1, hub->change_bits);
1471 #ifdef CONFIG_USB_SUSPEND
1474 * Selective port suspend reduces power; most suspended devices draw
1475 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1476 * All devices below the suspended port are also suspended.
1478 * Devices leave suspend state when the host wakes them up. Some devices
1479 * also support "remote wakeup", where the device can activate the USB
1480 * tree above them to deliver data, such as a keypress or packet. In
1481 * some cases, this wakes the USB host.
1483 static int hub_port_suspend(struct usb_hub *hub, int port1,
1484 struct usb_device *udev)
1488 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1490 /* enable remote wakeup when appropriate; this lets the device
1491 * wake up the upstream hub (including maybe the root hub).
1493 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1494 * we don't explicitly enable it here.
1497 // && FIXME (remote wakeup enabled on this bus)
1498 // ... currently assuming it's always appropriate
1499 && (udev->actconfig->desc.bmAttributes
1500 & USB_CONFIG_ATT_WAKEUP) != 0) {
1501 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1502 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1503 USB_DEVICE_REMOTE_WAKEUP, 0,
1505 USB_CTRL_SET_TIMEOUT);
1508 "won't remote wakeup, status %d\n",
1513 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1515 dev_dbg(hub->intfdev,
1516 "can't suspend port %d, status %d\n",
1518 /* paranoia: "should not happen" */
1519 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1520 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1521 USB_DEVICE_REMOTE_WAKEUP, 0,
1523 USB_CTRL_SET_TIMEOUT);
1525 /* device has up to 10 msec to fully suspend */
1526 dev_dbg(&udev->dev, "usb suspend\n");
1527 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1534 * Devices on USB hub ports have only one "suspend" state, corresponding
1535 * to ACPI D2, "may cause the device to lose some context".
1536 * State transitions include:
1538 * - suspend, resume ... when the VBUS power link stays live
1539 * - suspend, disconnect ... VBUS lost
1541 * Once VBUS drop breaks the circuit, the port it's using has to go through
1542 * normal re-enumeration procedures, starting with enabling VBUS power.
1543 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1544 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1545 * timer, no SRP, no requests through sysfs.
1547 static int __usb_suspend_device (struct usb_device *udev, int port1,
1552 /* caller owns the udev device lock */
1556 if (udev->state == USB_STATE_SUSPENDED
1557 || udev->state == USB_STATE_NOTATTACHED) {
1561 /* suspend interface drivers; if this is a hub, it
1562 * suspends the child devices
1564 if (udev->actconfig) {
1567 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1568 struct usb_interface *intf;
1569 struct usb_driver *driver;
1571 intf = udev->actconfig->interface[i];
1572 if (state.event <= intf->dev.power.power_state.event)
1574 if (!intf->dev.driver)
1576 driver = to_usb_driver(intf->dev.driver);
1578 if (driver->suspend) {
1579 status = driver->suspend(intf, state);
1580 if (intf->dev.power.power_state.event != state.event
1583 "suspend %d fail, code %d\n",
1584 state.event, status);
1587 /* only drivers with suspend() can ever resume();
1588 * and after power loss, even they won't.
1589 * bus_rescan_devices() can rebind drivers later.
1591 * FIXME the PM core self-deadlocks when unbinding
1592 * drivers during suspend/resume ... everything grabs
1593 * dpm_sem (not a spinlock, ugh). we want to unbind,
1594 * since we know every driver's probe/disconnect works
1595 * even for drivers that can't suspend.
1597 if (!driver->suspend || state.event > PM_EVENT_FREEZE) {
1599 dev_warn(&intf->dev, "resume is unsafe!\n");
1601 down_write(&usb_bus_type.rwsem);
1602 device_release_driver(&intf->dev);
1603 up_write(&usb_bus_type.rwsem);
1610 * FIXME this needs port power off call paths too, to help force
1611 * USB into the "generic" PM model. At least for devices on
1612 * ports that aren't using ganged switching (usually root hubs).
1614 * NOTE: SRP-capable links should adopt more aggressive poweroff
1615 * policies (when HNP doesn't apply) once we have mechanisms to
1616 * turn power back on! (Likely not before 2.7...)
1618 if (state.event > PM_EVENT_FREEZE) {
1619 dev_warn(&udev->dev, "no poweroff yet, suspending instead\n");
1622 /* "global suspend" of the HC-to-USB interface (root hub), or
1623 * "selective suspend" of just one hub-device link.
1625 if (!udev->parent) {
1626 struct usb_bus *bus = udev->bus;
1627 if (bus && bus->op->hub_suspend) {
1628 status = bus->op->hub_suspend (bus);
1630 dev_dbg(&udev->dev, "usb suspend\n");
1631 usb_set_device_state(udev,
1632 USB_STATE_SUSPENDED);
1635 status = -EOPNOTSUPP;
1637 status = hub_port_suspend(hdev_to_hub(udev->parent), port1,
1641 udev->dev.power.power_state = state;
1646 * usb_suspend_device - suspend a usb device
1647 * @udev: device that's no longer in active use
1648 * @state: PMSG_SUSPEND to suspend
1649 * Context: must be able to sleep; device not locked
1651 * Suspends a USB device that isn't in active use, conserving power.
1652 * Devices may wake out of a suspend, if anything important happens,
1653 * using the remote wakeup mechanism. They may also be taken out of
1654 * suspend by the host, using usb_resume_device(). It's also routine
1655 * to disconnect devices while they are suspended.
1657 * Suspending OTG devices may trigger HNP, if that's been enabled
1658 * between a pair of dual-role devices. That will change roles, such
1659 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1661 * Returns 0 on success, else negative errno.
1663 int usb_suspend_device(struct usb_device *udev, pm_message_t state)
1667 port1 = locktree(udev);
1671 status = __usb_suspend_device(udev, port1, state);
1672 usb_unlock_device(udev);
1677 * hardware resume signaling is finished, either because of selective
1678 * resume (by host) or remote wakeup (by device) ... now see what changed
1679 * in the tree that's rooted at this device.
1681 static int finish_port_resume(struct usb_device *udev)
1686 /* caller owns the udev device lock */
1687 dev_dbg(&udev->dev, "usb resume\n");
1689 /* usb ch9 identifies four variants of SUSPENDED, based on what
1690 * state the device resumes to. Linux currently won't see the
1691 * first two on the host side; they'd be inside hub_port_init()
1692 * during many timeouts, but khubd can't suspend until later.
1694 usb_set_device_state(udev, udev->actconfig
1695 ? USB_STATE_CONFIGURED
1696 : USB_STATE_ADDRESS);
1697 udev->dev.power.power_state = PMSG_ON;
1699 /* 10.5.4.5 says be sure devices in the tree are still there.
1700 * For now let's assume the device didn't go crazy on resume,
1701 * and device drivers will know about any resume quirks.
1703 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
1706 "gone after usb resume? status %d\n",
1708 else if (udev->actconfig) {
1711 le16_to_cpus(&devstatus);
1712 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
1713 status = usb_control_msg(udev,
1714 usb_sndctrlpipe(udev, 0),
1715 USB_REQ_CLEAR_FEATURE,
1717 USB_DEVICE_REMOTE_WAKEUP, 0,
1719 USB_CTRL_SET_TIMEOUT);
1721 dev_dbg(&udev->dev, "disable remote "
1722 "wakeup, status %d\n", status);
1727 /* resume interface drivers; if this is a hub, it
1728 * resumes the child devices
1730 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
1731 struct usb_interface *intf;
1732 struct usb_driver *driver;
1734 intf = udev->actconfig->interface[i];
1735 if (intf->dev.power.power_state.event == PM_EVENT_ON)
1737 if (!intf->dev.driver) {
1738 /* FIXME maybe force to alt 0 */
1741 driver = to_usb_driver(intf->dev.driver);
1743 /* bus_rescan_devices() may rebind drivers */
1744 if (!driver->resume)
1747 /* can we do better than just logging errors? */
1748 status = driver->resume(intf);
1749 if (intf->dev.power.power_state.event != PM_EVENT_ON
1752 "resume fail, state %d code %d\n",
1753 intf->dev.power.power_state.event, status);
1757 } else if (udev->devnum <= 0) {
1758 dev_dbg(&udev->dev, "bogus resume!\n");
1765 hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1769 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1771 /* see 7.1.7.7; affects power usage, but not budgeting */
1772 status = clear_port_feature(hub->hdev,
1773 port1, USB_PORT_FEAT_SUSPEND);
1775 dev_dbg(hub->intfdev,
1776 "can't resume port %d, status %d\n",
1782 /* drive resume for at least 20 msec */
1784 dev_dbg(&udev->dev, "RESUME\n");
1787 #define LIVE_FLAGS ( USB_PORT_STAT_POWER \
1788 | USB_PORT_STAT_ENABLE \
1789 | USB_PORT_STAT_CONNECTION)
1791 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1792 * stop resume signaling. Then finish the resume
1795 devstatus = portchange = 0;
1796 status = hub_port_status(hub, port1,
1797 &devstatus, &portchange);
1799 || (devstatus & LIVE_FLAGS) != LIVE_FLAGS
1800 || (devstatus & USB_PORT_STAT_SUSPEND) != 0
1802 dev_dbg(hub->intfdev,
1803 "port %d status %04x.%04x after resume, %d\n",
1804 port1, portchange, devstatus, status);
1806 /* TRSMRCY = 10 msec */
1809 status = finish_port_resume(udev);
1813 hub_port_logical_disconnect(hub, port1);
1818 static int hub_resume (struct usb_interface *intf);
1821 * usb_resume_device - re-activate a suspended usb device
1822 * @udev: device to re-activate
1823 * Context: must be able to sleep; device not locked
1825 * This will re-activate the suspended device, increasing power usage
1826 * while letting drivers communicate again with its endpoints.
1827 * USB resume explicitly guarantees that the power session between
1828 * the host and the device is the same as it was when the device
1831 * Returns 0 on success, else negative errno.
1833 int usb_resume_device(struct usb_device *udev)
1837 port1 = locktree(udev);
1841 /* "global resume" of the HC-to-USB interface (root hub), or
1842 * selective resume of one hub-to-device port
1844 if (!udev->parent) {
1845 struct usb_bus *bus = udev->bus;
1846 if (bus && bus->op->hub_resume) {
1847 status = bus->op->hub_resume (bus);
1849 status = -EOPNOTSUPP;
1851 dev_dbg(&udev->dev, "usb resume\n");
1852 /* TRSMRCY = 10 msec */
1854 usb_set_device_state (udev, USB_STATE_CONFIGURED);
1855 udev->dev.power.power_state = PMSG_ON;
1856 status = hub_resume (udev
1857 ->actconfig->interface[0]);
1859 } else if (udev->state == USB_STATE_SUSPENDED) {
1860 // NOTE this fails if parent is also suspended...
1861 status = hub_port_resume(hdev_to_hub(udev->parent),
1867 dev_dbg(&udev->dev, "can't resume, status %d\n",
1871 usb_unlock_device(udev);
1873 /* rebind drivers that had no suspend() */
1875 usb_lock_all_devices();
1876 bus_rescan_devices(&usb_bus_type);
1877 usb_unlock_all_devices();
1882 static int remote_wakeup(struct usb_device *udev)
1886 /* don't repeat RESUME sequence if this device
1887 * was already woken up by some other task
1889 down(&udev->serialize);
1890 if (udev->state == USB_STATE_SUSPENDED) {
1891 dev_dbg(&udev->dev, "RESUME (wakeup)\n");
1892 /* TRSMRCY = 10 msec */
1894 status = finish_port_resume(udev);
1896 up(&udev->serialize);
1900 static int hub_suspend(struct usb_interface *intf, pm_message_t state)
1902 struct usb_hub *hub = usb_get_intfdata (intf);
1903 struct usb_device *hdev = hub->hdev;
1907 /* stop khubd and related activity */
1910 /* then suspend every port */
1911 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1912 struct usb_device *udev;
1914 udev = hdev->children [port1-1];
1917 down(&udev->serialize);
1918 status = __usb_suspend_device(udev, port1, state);
1919 up(&udev->serialize);
1921 dev_dbg(&intf->dev, "suspend port %d --> %d\n",
1925 intf->dev.power.power_state = state;
1929 static int hub_resume(struct usb_interface *intf)
1931 struct usb_device *hdev = interface_to_usbdev(intf);
1932 struct usb_hub *hub = usb_get_intfdata (intf);
1936 if (intf->dev.power.power_state.event == PM_EVENT_ON)
1939 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1940 struct usb_device *udev;
1941 u16 portstat, portchange;
1943 udev = hdev->children [port1-1];
1944 status = hub_port_status(hub, port1, &portstat, &portchange);
1946 if (portchange & USB_PORT_STAT_C_SUSPEND) {
1947 clear_port_feature(hdev, port1,
1948 USB_PORT_FEAT_C_SUSPEND);
1949 portchange &= ~USB_PORT_STAT_C_SUSPEND;
1952 /* let khubd handle disconnects etc */
1957 if (!udev || status < 0)
1959 down (&udev->serialize);
1960 if (portstat & USB_PORT_STAT_SUSPEND)
1961 status = hub_port_resume(hub, port1, udev);
1963 status = finish_port_resume(udev);
1965 dev_dbg(&intf->dev, "resume port %d --> %d\n",
1967 hub_port_logical_disconnect(hub, port1);
1970 up(&udev->serialize);
1972 intf->dev.power.power_state = PMSG_ON;
1974 hub->resume_root_hub = 0;
1979 void usb_resume_root_hub(struct usb_device *hdev)
1981 struct usb_hub *hub = hdev_to_hub(hdev);
1983 hub->resume_root_hub = 1;
1987 #else /* !CONFIG_USB_SUSPEND */
1989 int usb_suspend_device(struct usb_device *udev, pm_message_t state)
1994 int usb_resume_device(struct usb_device *udev)
1999 #define hub_suspend NULL
2000 #define hub_resume NULL
2001 #define remote_wakeup(x) 0
2003 #endif /* CONFIG_USB_SUSPEND */
2005 EXPORT_SYMBOL(usb_suspend_device);
2006 EXPORT_SYMBOL(usb_resume_device);
2010 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2012 * Between connect detection and reset signaling there must be a delay
2013 * of 100ms at least for debounce and power-settling. The corresponding
2014 * timer shall restart whenever the downstream port detects a disconnect.
2016 * Apparently there are some bluetooth and irda-dongles and a number of
2017 * low-speed devices for which this debounce period may last over a second.
2018 * Not covered by the spec - but easy to deal with.
2020 * This implementation uses a 1500ms total debounce timeout; if the
2021 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2022 * every 25ms for transient disconnects. When the port status has been
2023 * unchanged for 100ms it returns the port status.
2026 #define HUB_DEBOUNCE_TIMEOUT 1500
2027 #define HUB_DEBOUNCE_STEP 25
2028 #define HUB_DEBOUNCE_STABLE 100
2030 static int hub_port_debounce(struct usb_hub *hub, int port1)
2033 int total_time, stable_time = 0;
2034 u16 portchange, portstatus;
2035 unsigned connection = 0xffff;
2037 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2038 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2042 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2043 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2044 stable_time += HUB_DEBOUNCE_STEP;
2045 if (stable_time >= HUB_DEBOUNCE_STABLE)
2049 connection = portstatus & USB_PORT_STAT_CONNECTION;
2052 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2053 clear_port_feature(hub->hdev, port1,
2054 USB_PORT_FEAT_C_CONNECTION);
2057 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2059 msleep(HUB_DEBOUNCE_STEP);
2062 dev_dbg (hub->intfdev,
2063 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2064 port1, total_time, stable_time, portstatus);
2066 if (stable_time < HUB_DEBOUNCE_STABLE)
2071 static void ep0_reinit(struct usb_device *udev)
2073 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
2074 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
2075 udev->ep_in[0] = udev->ep_out[0] = &udev->ep0;
2078 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2079 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2081 static int hub_set_address(struct usb_device *udev)
2085 if (udev->devnum == 0)
2087 if (udev->state == USB_STATE_ADDRESS)
2089 if (udev->state != USB_STATE_DEFAULT)
2091 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2092 USB_REQ_SET_ADDRESS, 0, udev->devnum, 0,
2093 NULL, 0, USB_CTRL_SET_TIMEOUT);
2095 usb_set_device_state(udev, USB_STATE_ADDRESS);
2101 /* Reset device, (re)assign address, get device descriptor.
2102 * Device connection must be stable, no more debouncing needed.
2103 * Returns device in USB_STATE_ADDRESS, except on error.
2105 * If this is called for an already-existing device (as part of
2106 * usb_reset_device), the caller must own the device lock. For a
2107 * newly detected device that is not accessible through any global
2108 * pointers, it's not necessary to lock the device.
2111 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2114 static DECLARE_MUTEX(usb_address0_sem);
2116 struct usb_device *hdev = hub->hdev;
2118 unsigned delay = HUB_SHORT_RESET_TIME;
2119 enum usb_device_speed oldspeed = udev->speed;
2121 /* root hub ports have a slightly longer reset period
2122 * (from USB 2.0 spec, section 7.1.7.5)
2124 if (!hdev->parent) {
2125 delay = HUB_ROOT_RESET_TIME;
2126 if (port1 == hdev->bus->otg_port)
2127 hdev->bus->b_hnp_enable = 0;
2130 /* Some low speed devices have problems with the quick delay, so */
2131 /* be a bit pessimistic with those devices. RHbug #23670 */
2132 if (oldspeed == USB_SPEED_LOW)
2133 delay = HUB_LONG_RESET_TIME;
2135 down(&usb_address0_sem);
2137 /* Reset the device; full speed may morph to high speed */
2138 retval = hub_port_reset(hub, port1, udev, delay);
2139 if (retval < 0) /* error or disconnect */
2141 /* success, speed is known */
2144 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2145 dev_dbg(&udev->dev, "device reset changed speed!\n");
2148 oldspeed = udev->speed;
2150 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2151 * it's fixed size except for full speed devices.
2153 switch (udev->speed) {
2154 case USB_SPEED_HIGH: /* fixed at 64 */
2155 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2157 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2158 /* to determine the ep0 maxpacket size, try to read
2159 * the device descriptor to get bMaxPacketSize0 and
2160 * then correct our initial guess.
2162 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2164 case USB_SPEED_LOW: /* fixed at 8 */
2165 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2171 dev_info (&udev->dev,
2172 "%s %s speed USB device using %s and address %d\n",
2173 (udev->config) ? "reset" : "new",
2174 ({ char *speed; switch (udev->speed) {
2175 case USB_SPEED_LOW: speed = "low"; break;
2176 case USB_SPEED_FULL: speed = "full"; break;
2177 case USB_SPEED_HIGH: speed = "high"; break;
2178 default: speed = "?"; break;
2180 udev->bus->controller->driver->name,
2183 /* Set up TT records, if needed */
2185 udev->tt = hdev->tt;
2186 udev->ttport = hdev->ttport;
2187 } else if (udev->speed != USB_SPEED_HIGH
2188 && hdev->speed == USB_SPEED_HIGH) {
2189 udev->tt = &hub->tt;
2190 udev->ttport = port1;
2193 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2194 * Because device hardware and firmware is sometimes buggy in
2195 * this area, and this is how Linux has done it for ages.
2196 * Change it cautiously.
2198 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2199 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2200 * so it may help with some non-standards-compliant devices.
2201 * Otherwise we start with SET_ADDRESS and then try to read the
2202 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2205 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2206 if (USE_NEW_SCHEME(retry_counter)) {
2207 struct usb_device_descriptor *buf;
2210 #define GET_DESCRIPTOR_BUFSIZE 64
2211 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2217 /* Use a short timeout the first time through,
2218 * so that recalcitrant full-speed devices with
2219 * 8- or 16-byte ep0-maxpackets won't slow things
2220 * down tremendously by NAKing the unexpectedly
2221 * early status stage. Also, retry on all errors;
2222 * some devices are flakey.
2224 for (j = 0; j < 3; ++j) {
2225 buf->bMaxPacketSize0 = 0;
2226 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2227 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2228 USB_DT_DEVICE << 8, 0,
2229 buf, GET_DESCRIPTOR_BUFSIZE,
2230 (i ? USB_CTRL_GET_TIMEOUT : 1000));
2231 switch (buf->bMaxPacketSize0) {
2232 case 8: case 16: case 32: case 64:
2233 if (buf->bDescriptorType ==
2247 udev->descriptor.bMaxPacketSize0 =
2248 buf->bMaxPacketSize0;
2251 retval = hub_port_reset(hub, port1, udev, delay);
2252 if (retval < 0) /* error or disconnect */
2254 if (oldspeed != udev->speed) {
2256 "device reset changed speed!\n");
2261 dev_err(&udev->dev, "device descriptor "
2262 "read/%s, error %d\n",
2267 #undef GET_DESCRIPTOR_BUFSIZE
2270 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2271 retval = hub_set_address(udev);
2278 "device not accepting address %d, error %d\n",
2279 udev->devnum, retval);
2283 /* cope with hardware quirkiness:
2284 * - let SET_ADDRESS settle, some device hardware wants it
2285 * - read ep0 maxpacket even for high and low speed,
2288 if (USE_NEW_SCHEME(retry_counter))
2291 retval = usb_get_device_descriptor(udev, 8);
2293 dev_err(&udev->dev, "device descriptor "
2294 "read/%s, error %d\n",
2306 i = udev->descriptor.bMaxPacketSize0;
2307 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2308 if (udev->speed != USB_SPEED_FULL ||
2309 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2310 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2314 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2315 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2319 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2320 if (retval < (signed)sizeof(udev->descriptor)) {
2321 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2332 hub_port_disable(hub, port1, 0);
2333 up(&usb_address0_sem);
2338 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2340 struct usb_qualifier_descriptor *qual;
2343 qual = kmalloc (sizeof *qual, SLAB_KERNEL);
2347 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2348 qual, sizeof *qual);
2349 if (status == sizeof *qual) {
2350 dev_info(&udev->dev, "not running at top speed; "
2351 "connect to a high speed hub\n");
2352 /* hub LEDs are probably harder to miss than syslog */
2353 if (hub->has_indicators) {
2354 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2355 schedule_work (&hub->leds);
2362 hub_power_remaining (struct usb_hub *hub)
2364 struct usb_device *hdev = hub->hdev;
2368 remaining = hub->power_budget;
2369 if (!remaining) /* self-powered */
2372 for (i = 0; i < hdev->maxchild; i++) {
2373 struct usb_device *udev = hdev->children[i];
2379 /* 100mA per-port ceiling, or 8mA for OTG ports */
2380 if (i != (udev->bus->otg_port - 1) || hdev->parent)
2385 if (udev->actconfig)
2386 delta = udev->actconfig->desc.bMaxPower;
2389 // dev_dbg(&udev->dev, "budgeted %dmA\n", 2 * delta);
2390 if (delta > ceiling)
2391 dev_warn(&udev->dev, "%dmA over %dmA budget!\n",
2392 2 * (delta - ceiling), 2 * ceiling);
2395 if (remaining < 0) {
2396 dev_warn(hub->intfdev,
2397 "%dmA over power budget!\n",
2404 /* Handle physical or logical connection change events.
2405 * This routine is called when:
2406 * a port connection-change occurs;
2407 * a port enable-change occurs (often caused by EMI);
2408 * usb_reset_device() encounters changed descriptors (as from
2409 * a firmware download)
2410 * caller already locked the hub
2412 static void hub_port_connect_change(struct usb_hub *hub, int port1,
2413 u16 portstatus, u16 portchange)
2415 struct usb_device *hdev = hub->hdev;
2416 struct device *hub_dev = hub->intfdev;
2420 "port %d, status %04x, change %04x, %s\n",
2421 port1, portstatus, portchange, portspeed (portstatus));
2423 if (hub->has_indicators) {
2424 set_port_led(hub, port1, HUB_LED_AUTO);
2425 hub->indicator[port1-1] = INDICATOR_AUTO;
2428 /* Disconnect any existing devices under this port */
2429 if (hdev->children[port1-1])
2430 usb_disconnect(&hdev->children[port1-1]);
2431 clear_bit(port1, hub->change_bits);
2433 #ifdef CONFIG_USB_OTG
2434 /* during HNP, don't repeat the debounce */
2435 if (hdev->bus->is_b_host)
2436 portchange &= ~USB_PORT_STAT_C_CONNECTION;
2439 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2440 status = hub_port_debounce(hub, port1);
2443 "connect-debounce failed, port %d disabled\n",
2447 portstatus = status;
2450 /* Return now if nothing is connected */
2451 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2453 /* maybe switch power back on (e.g. root hub was reset) */
2454 if ((hub->descriptor->wHubCharacteristics
2455 & HUB_CHAR_LPSM) < 2
2456 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2457 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2459 if (portstatus & USB_PORT_STAT_ENABLE)
2464 #ifdef CONFIG_USB_SUSPEND
2465 /* If something is connected, but the port is suspended, wake it up. */
2466 if (portstatus & USB_PORT_STAT_SUSPEND) {
2467 status = hub_port_resume(hub, port1, NULL);
2470 "can't clear suspend on port %d; %d\n",
2477 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2478 struct usb_device *udev;
2480 /* reallocate for each attempt, since references
2481 * to the previous one can escape in various ways
2483 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2486 "couldn't allocate port %d usb_device\n",
2491 usb_set_device_state(udev, USB_STATE_POWERED);
2492 udev->speed = USB_SPEED_UNKNOWN;
2494 /* set the address */
2495 choose_address(udev);
2496 if (udev->devnum <= 0) {
2497 status = -ENOTCONN; /* Don't retry */
2501 /* reset and get descriptor */
2502 status = hub_port_init(hub, udev, port1, i);
2506 /* consecutive bus-powered hubs aren't reliable; they can
2507 * violate the voltage drop budget. if the new child has
2508 * a "powered" LED, users should notice we didn't enable it
2509 * (without reading syslog), even without per-port LEDs
2512 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
2513 && hub->power_budget) {
2516 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2519 dev_dbg(&udev->dev, "get status %d ?\n", status);
2522 cpu_to_le16s(&devstat);
2523 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2525 "can't connect bus-powered hub "
2527 if (hub->has_indicators) {
2528 hub->indicator[port1-1] =
2529 INDICATOR_AMBER_BLINK;
2530 schedule_work (&hub->leds);
2532 status = -ENOTCONN; /* Don't retry */
2537 /* check for devices running slower than they could */
2538 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2539 && udev->speed == USB_SPEED_FULL
2540 && highspeed_hubs != 0)
2541 check_highspeed (hub, udev, port1);
2543 /* Store the parent's children[] pointer. At this point
2544 * udev becomes globally accessible, although presumably
2545 * no one will look at it until hdev is unlocked.
2547 down (&udev->serialize);
2550 /* We mustn't add new devices if the parent hub has
2551 * been disconnected; we would race with the
2552 * recursively_mark_NOTATTACHED() routine.
2554 spin_lock_irq(&device_state_lock);
2555 if (hdev->state == USB_STATE_NOTATTACHED)
2558 hdev->children[port1-1] = udev;
2559 spin_unlock_irq(&device_state_lock);
2561 /* Run it through the hoops (find a driver, etc) */
2563 status = usb_new_device(udev);
2565 spin_lock_irq(&device_state_lock);
2566 hdev->children[port1-1] = NULL;
2567 spin_unlock_irq(&device_state_lock);
2571 up (&udev->serialize);
2575 status = hub_power_remaining(hub);
2578 "%dmA power budget left\n",
2584 hub_port_disable(hub, port1, 1);
2587 release_address(udev);
2589 if (status == -ENOTCONN)
2594 hub_port_disable(hub, port1, 1);
2597 static void hub_events(void)
2599 struct list_head *tmp;
2600 struct usb_device *hdev;
2601 struct usb_interface *intf;
2602 struct usb_hub *hub;
2603 struct device *hub_dev;
2612 * We restart the list every time to avoid a deadlock with
2613 * deleting hubs downstream from this one. This should be
2614 * safe since we delete the hub from the event list.
2615 * Not the most efficient, but avoids deadlocks.
2619 /* Grab the first entry at the beginning of the list */
2620 spin_lock_irq(&hub_event_lock);
2621 if (list_empty(&hub_event_list)) {
2622 spin_unlock_irq(&hub_event_lock);
2626 tmp = hub_event_list.next;
2629 hub = list_entry(tmp, struct usb_hub, event_list);
2631 intf = to_usb_interface(hub->intfdev);
2632 hub_dev = &intf->dev;
2634 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
2635 hdev->state, hub->descriptor
2636 ? hub->descriptor->bNbrPorts
2638 /* NOTE: expects max 15 ports... */
2639 (u16) hub->change_bits[0],
2640 (u16) hub->event_bits[0]);
2643 i = hub->resume_root_hub;
2644 spin_unlock_irq(&hub_event_lock);
2646 /* Is this is a root hub wanting to be resumed? */
2648 usb_resume_device(hdev);
2650 /* Lock the device, then check to see if we were
2651 * disconnected while waiting for the lock to succeed. */
2652 if (locktree(hdev) < 0) {
2656 if (hub != usb_get_intfdata(intf))
2659 /* If the hub has died, clean up after it */
2660 if (hdev->state == USB_STATE_NOTATTACHED) {
2665 /* If this is an inactive or suspended hub, do nothing */
2670 dev_dbg (hub_dev, "resetting for error %d\n",
2673 ret = usb_reset_device(hdev);
2676 "error resetting hub: %d\n", ret);
2684 /* deal with port status changes */
2685 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2686 if (test_bit(i, hub->busy_bits))
2688 connect_change = test_bit(i, hub->change_bits);
2689 if (!test_and_clear_bit(i, hub->event_bits) &&
2690 !connect_change && !hub->activating)
2693 ret = hub_port_status(hub, i,
2694 &portstatus, &portchange);
2698 if (hub->activating && !hdev->children[i-1] &&
2700 USB_PORT_STAT_CONNECTION))
2703 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2704 clear_port_feature(hdev, i,
2705 USB_PORT_FEAT_C_CONNECTION);
2709 if (portchange & USB_PORT_STAT_C_ENABLE) {
2710 if (!connect_change)
2712 "port %d enable change, "
2715 clear_port_feature(hdev, i,
2716 USB_PORT_FEAT_C_ENABLE);
2719 * EM interference sometimes causes badly
2720 * shielded USB devices to be shutdown by
2721 * the hub, this hack enables them again.
2722 * Works at least with mouse driver.
2724 if (!(portstatus & USB_PORT_STAT_ENABLE)
2726 && hdev->children[i-1]) {
2729 "disabled by hub (EMI?), "
2736 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2737 clear_port_feature(hdev, i,
2738 USB_PORT_FEAT_C_SUSPEND);
2739 if (hdev->children[i-1]) {
2740 ret = remote_wakeup(hdev->
2746 hub_port_disable(hub, i, 1);
2749 "resume on port %d, status %d\n",
2753 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2755 "over-current change on port %d\n",
2757 clear_port_feature(hdev, i,
2758 USB_PORT_FEAT_C_OVER_CURRENT);
2762 if (portchange & USB_PORT_STAT_C_RESET) {
2764 "reset change on port %d\n",
2766 clear_port_feature(hdev, i,
2767 USB_PORT_FEAT_C_RESET);
2771 hub_port_connect_change(hub, i,
2772 portstatus, portchange);
2775 /* deal with hub status changes */
2776 if (test_and_clear_bit(0, hub->event_bits) == 0)
2778 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2779 dev_err (hub_dev, "get_hub_status failed\n");
2781 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2782 dev_dbg (hub_dev, "power change\n");
2783 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
2785 if (hubchange & HUB_CHANGE_OVERCURRENT) {
2786 dev_dbg (hub_dev, "overcurrent change\n");
2787 msleep(500); /* Cool down */
2788 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
2793 hub->activating = 0;
2795 /* If this is a root hub, tell the HCD it's okay to
2796 * re-enable port-change interrupts now. */
2798 usb_enable_root_hub_irq(hdev->bus);
2801 usb_unlock_device(hdev);
2804 } /* end while (1) */
2807 static int hub_thread(void *__unused)
2811 wait_event_interruptible(khubd_wait,
2812 !list_empty(&hub_event_list) ||
2813 kthread_should_stop());
2815 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
2817 pr_debug("%s: khubd exiting\n", usbcore_name);
2821 static struct usb_device_id hub_id_table [] = {
2822 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
2823 .bDeviceClass = USB_CLASS_HUB},
2824 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2825 .bInterfaceClass = USB_CLASS_HUB},
2826 { } /* Terminating entry */
2829 MODULE_DEVICE_TABLE (usb, hub_id_table);
2831 static struct usb_driver hub_driver = {
2832 .owner = THIS_MODULE,
2835 .disconnect = hub_disconnect,
2836 .suspend = hub_suspend,
2837 .resume = hub_resume,
2839 .id_table = hub_id_table,
2842 int usb_hub_init(void)
2844 if (usb_register(&hub_driver) < 0) {
2845 printk(KERN_ERR "%s: can't register hub driver\n",
2850 khubd_task = kthread_run(hub_thread, NULL, "khubd");
2851 if (!IS_ERR(khubd_task))
2854 /* Fall through if kernel_thread failed */
2855 usb_deregister(&hub_driver);
2856 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
2861 void usb_hub_cleanup(void)
2863 kthread_stop(khubd_task);
2866 * Hub resources are freed for us by usb_deregister. It calls
2867 * usb_driver_purge on every device which in turn calls that
2868 * devices disconnect function if it is using this driver.
2869 * The hub_disconnect function takes care of releasing the
2870 * individual hub resources. -greg
2872 usb_deregister(&hub_driver);
2873 } /* usb_hub_cleanup() */
2875 static int config_descriptors_changed(struct usb_device *udev)
2879 struct usb_config_descriptor *buf;
2881 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2882 if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
2883 len = le16_to_cpu(udev->config[index].desc.wTotalLength);
2885 buf = kmalloc (len, SLAB_KERNEL);
2887 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
2888 /* assume the worst */
2891 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2893 int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
2895 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
2897 if (length < old_length) {
2898 dev_dbg(&udev->dev, "config index %d, error %d\n",
2902 if (memcmp (buf, udev->rawdescriptors[index], old_length)
2904 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
2905 index, buf->bConfigurationValue);
2910 return index != udev->descriptor.bNumConfigurations;
2914 * usb_reset_device - perform a USB port reset to reinitialize a device
2915 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2917 * WARNING - don't reset any device unless drivers for all of its
2918 * interfaces are expecting that reset! Maybe some driver->reset()
2919 * method should eventually help ensure sufficient cooperation.
2921 * Do a port reset, reassign the device's address, and establish its
2922 * former operating configuration. If the reset fails, or the device's
2923 * descriptors change from their values before the reset, or the original
2924 * configuration and altsettings cannot be restored, a flag will be set
2925 * telling khubd to pretend the device has been disconnected and then
2926 * re-connected. All drivers will be unbound, and the device will be
2927 * re-enumerated and probed all over again.
2929 * Returns 0 if the reset succeeded, -ENODEV if the device has been
2930 * flagged for logical disconnection, or some other negative error code
2931 * if the reset wasn't even attempted.
2933 * The caller must own the device lock. For example, it's safe to use
2934 * this from a driver probe() routine after downloading new firmware.
2935 * For calls that might not occur during probe(), drivers should lock
2936 * the device using usb_lock_device_for_reset().
2938 int usb_reset_device(struct usb_device *udev)
2940 struct usb_device *parent_hdev = udev->parent;
2941 struct usb_hub *parent_hub;
2942 struct usb_device_descriptor descriptor = udev->descriptor;
2943 struct usb_hub *hub = NULL;
2944 int i, ret = 0, port1 = -1;
2946 if (udev->state == USB_STATE_NOTATTACHED ||
2947 udev->state == USB_STATE_SUSPENDED) {
2948 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
2954 /* this requires hcd-specific logic; see OHCI hc_restart() */
2955 dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
2959 for (i = 0; i < parent_hdev->maxchild; i++)
2960 if (parent_hdev->children[i] == udev) {
2966 /* If this ever happens, it's very bad */
2967 dev_err(&udev->dev, "Can't locate device's port!\n");
2970 parent_hub = hdev_to_hub(parent_hdev);
2972 /* If we're resetting an active hub, take some special actions */
2973 if (udev->actconfig &&
2974 udev->actconfig->interface[0]->dev.driver ==
2975 &hub_driver.driver &&
2976 (hub = hdev_to_hub(udev)) != NULL) {
2980 set_bit(port1, parent_hub->busy_bits);
2981 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
2983 /* ep0 maxpacket size may change; let the HCD know about it.
2984 * Other endpoints will be handled by re-enumeration. */
2986 ret = hub_port_init(parent_hub, udev, port1, i);
2990 clear_bit(port1, parent_hub->busy_bits);
2994 /* Device might have changed firmware (DFU or similar) */
2995 if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
2996 || config_descriptors_changed (udev)) {
2997 dev_info(&udev->dev, "device firmware changed\n");
2998 udev->descriptor = descriptor; /* for disconnect() calls */
3002 if (!udev->actconfig)
3005 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3006 USB_REQ_SET_CONFIGURATION, 0,
3007 udev->actconfig->desc.bConfigurationValue, 0,
3008 NULL, 0, USB_CTRL_SET_TIMEOUT);
3011 "can't restore configuration #%d (error=%d)\n",
3012 udev->actconfig->desc.bConfigurationValue, ret);
3015 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3017 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3018 struct usb_interface *intf = udev->actconfig->interface[i];
3019 struct usb_interface_descriptor *desc;
3021 /* set_interface resets host side toggle even
3022 * for altsetting zero. the interface may have no driver.
3024 desc = &intf->cur_altsetting->desc;
3025 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3026 desc->bAlternateSetting);
3028 dev_err(&udev->dev, "failed to restore interface %d "
3029 "altsetting %d (error=%d)\n",
3030 desc->bInterfaceNumber,
3031 desc->bAlternateSetting,
3039 hub_post_reset(hub);
3043 hub_port_logical_disconnect(parent_hub, port1);