4 * (C) Copyright 1999 Linus Torvalds
5 * (C) Copyright 1999 Johannes Erdfelt
6 * (C) Copyright 1999 Gregory P. Smith
7 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
11 #include <linux/kernel.h>
12 #include <linux/errno.h>
13 #include <linux/module.h>
14 #include <linux/moduleparam.h>
15 #include <linux/completion.h>
16 #include <linux/sched.h>
17 #include <linux/list.h>
18 #include <linux/slab.h>
19 #include <linux/ioctl.h>
20 #include <linux/usb.h>
21 #include <linux/usbdevice_fs.h>
22 #include <linux/kthread.h>
23 #include <linux/mutex.h>
24 #include <linux/freezer.h>
26 #include <asm/semaphore.h>
27 #include <asm/uaccess.h>
28 #include <asm/byteorder.h>
35 struct device *intfdev; /* the "interface" device */
36 struct usb_device *hdev;
38 struct urb *urb; /* for interrupt polling pipe */
40 /* buffer for urb ... with extra space in case of babble */
42 dma_addr_t buffer_dma; /* DMA address for buffer */
44 struct usb_hub_status hub;
45 struct usb_port_status port;
46 } *status; /* buffer for status reports */
47 struct mutex status_mutex; /* for the status buffer */
49 int error; /* last reported error */
50 int nerrors; /* track consecutive errors */
52 struct list_head event_list; /* hubs w/data or errs ready */
53 unsigned long event_bits[1]; /* status change bitmask */
54 unsigned long change_bits[1]; /* ports with logical connect
56 unsigned long busy_bits[1]; /* ports being reset or
58 #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
59 #error event_bits[] is too short!
62 struct usb_hub_descriptor *descriptor; /* class descriptor */
63 struct usb_tt tt; /* Transaction Translator */
65 unsigned mA_per_port; /* current for each child */
67 unsigned limited_power:1;
69 unsigned activating:1;
70 unsigned disconnected:1;
72 unsigned has_indicators:1;
73 u8 indicator[USB_MAXCHILDREN];
74 struct delayed_work leds;
78 /* Protect struct usb_device->state and ->children members
79 * Note: Both are also protected by ->dev.sem, except that ->state can
80 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
81 static DEFINE_SPINLOCK(device_state_lock);
83 /* khubd's worklist and its lock */
84 static DEFINE_SPINLOCK(hub_event_lock);
85 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
88 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
90 static struct task_struct *khubd_task;
92 /* cycle leds on hubs that aren't blinking for attention */
93 static int blinkenlights = 0;
94 module_param (blinkenlights, bool, S_IRUGO);
95 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
98 * As of 2.6.10 we introduce a new USB device initialization scheme which
99 * closely resembles the way Windows works. Hopefully it will be compatible
100 * with a wider range of devices than the old scheme. However some previously
101 * working devices may start giving rise to "device not accepting address"
102 * errors; if that happens the user can try the old scheme by adjusting the
103 * following module parameters.
105 * For maximum flexibility there are two boolean parameters to control the
106 * hub driver's behavior. On the first initialization attempt, if the
107 * "old_scheme_first" parameter is set then the old scheme will be used,
108 * otherwise the new scheme is used. If that fails and "use_both_schemes"
109 * is set, then the driver will make another attempt, using the other scheme.
111 static int old_scheme_first = 0;
112 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
113 MODULE_PARM_DESC(old_scheme_first,
114 "start with the old device initialization scheme");
116 static int use_both_schemes = 1;
117 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
118 MODULE_PARM_DESC(use_both_schemes,
119 "try the other device initialization scheme if the "
123 static inline char *portspeed(int portstatus)
125 if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
127 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
133 /* Note that hdev or one of its children must be locked! */
134 static inline struct usb_hub *hdev_to_hub(struct usb_device *hdev)
136 return usb_get_intfdata(hdev->actconfig->interface[0]);
139 /* USB 2.0 spec Section 11.24.4.5 */
140 static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
144 for (i = 0; i < 3; i++) {
145 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
146 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
147 USB_DT_HUB << 8, 0, data, size,
148 USB_CTRL_GET_TIMEOUT);
149 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
156 * USB 2.0 spec Section 11.24.2.1
158 static int clear_hub_feature(struct usb_device *hdev, int feature)
160 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
161 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
165 * USB 2.0 spec Section 11.24.2.2
167 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
169 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
170 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
175 * USB 2.0 spec Section 11.24.2.13
177 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
179 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
180 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
185 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
186 * for info about using port indicators
188 static void set_port_led(
194 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
195 USB_PORT_FEAT_INDICATOR);
197 dev_dbg (hub->intfdev,
198 "port %d indicator %s status %d\n",
200 ({ char *s; switch (selector) {
201 case HUB_LED_AMBER: s = "amber"; break;
202 case HUB_LED_GREEN: s = "green"; break;
203 case HUB_LED_OFF: s = "off"; break;
204 case HUB_LED_AUTO: s = "auto"; break;
205 default: s = "??"; break;
210 #define LED_CYCLE_PERIOD ((2*HZ)/3)
212 static void led_work (struct work_struct *work)
214 struct usb_hub *hub =
215 container_of(work, struct usb_hub, leds.work);
216 struct usb_device *hdev = hub->hdev;
218 unsigned changed = 0;
221 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
224 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
225 unsigned selector, mode;
227 /* 30%-50% duty cycle */
229 switch (hub->indicator[i]) {
231 case INDICATOR_CYCLE:
233 selector = HUB_LED_AUTO;
234 mode = INDICATOR_AUTO;
236 /* blinking green = sw attention */
237 case INDICATOR_GREEN_BLINK:
238 selector = HUB_LED_GREEN;
239 mode = INDICATOR_GREEN_BLINK_OFF;
241 case INDICATOR_GREEN_BLINK_OFF:
242 selector = HUB_LED_OFF;
243 mode = INDICATOR_GREEN_BLINK;
245 /* blinking amber = hw attention */
246 case INDICATOR_AMBER_BLINK:
247 selector = HUB_LED_AMBER;
248 mode = INDICATOR_AMBER_BLINK_OFF;
250 case INDICATOR_AMBER_BLINK_OFF:
251 selector = HUB_LED_OFF;
252 mode = INDICATOR_AMBER_BLINK;
254 /* blink green/amber = reserved */
255 case INDICATOR_ALT_BLINK:
256 selector = HUB_LED_GREEN;
257 mode = INDICATOR_ALT_BLINK_OFF;
259 case INDICATOR_ALT_BLINK_OFF:
260 selector = HUB_LED_AMBER;
261 mode = INDICATOR_ALT_BLINK;
266 if (selector != HUB_LED_AUTO)
268 set_port_led(hub, i + 1, selector);
269 hub->indicator[i] = mode;
271 if (!changed && blinkenlights) {
273 cursor %= hub->descriptor->bNbrPorts;
274 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
275 hub->indicator[cursor] = INDICATOR_CYCLE;
279 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
282 /* use a short timeout for hub/port status fetches */
283 #define USB_STS_TIMEOUT 1000
284 #define USB_STS_RETRIES 5
287 * USB 2.0 spec Section 11.24.2.6
289 static int get_hub_status(struct usb_device *hdev,
290 struct usb_hub_status *data)
292 int i, status = -ETIMEDOUT;
294 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
295 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
296 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
297 data, sizeof(*data), USB_STS_TIMEOUT);
303 * USB 2.0 spec Section 11.24.2.7
305 static int get_port_status(struct usb_device *hdev, int port1,
306 struct usb_port_status *data)
308 int i, status = -ETIMEDOUT;
310 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
311 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
312 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
313 data, sizeof(*data), USB_STS_TIMEOUT);
318 static void kick_khubd(struct usb_hub *hub)
322 /* Suppress autosuspend until khubd runs */
323 to_usb_interface(hub->intfdev)->pm_usage_cnt = 1;
325 spin_lock_irqsave(&hub_event_lock, flags);
326 if (!hub->disconnected & list_empty(&hub->event_list)) {
327 list_add_tail(&hub->event_list, &hub_event_list);
328 wake_up(&khubd_wait);
330 spin_unlock_irqrestore(&hub_event_lock, flags);
333 void usb_kick_khubd(struct usb_device *hdev)
335 /* FIXME: What if hdev isn't bound to the hub driver? */
336 kick_khubd(hdev_to_hub(hdev));
340 /* completion function, fires on port status changes and various faults */
341 static void hub_irq(struct urb *urb)
343 struct usb_hub *hub = urb->context;
348 switch (urb->status) {
349 case -ENOENT: /* synchronous unlink */
350 case -ECONNRESET: /* async unlink */
351 case -ESHUTDOWN: /* hardware going away */
354 default: /* presumably an error */
355 /* Cause a hub reset after 10 consecutive errors */
356 dev_dbg (hub->intfdev, "transfer --> %d\n", urb->status);
357 if ((++hub->nerrors < 10) || hub->error)
359 hub->error = urb->status;
362 /* let khubd handle things */
363 case 0: /* we got data: port status changed */
365 for (i = 0; i < urb->actual_length; ++i)
366 bits |= ((unsigned long) ((*hub->buffer)[i]))
368 hub->event_bits[0] = bits;
374 /* Something happened, let khubd figure it out */
381 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
382 && status != -ENODEV && status != -EPERM)
383 dev_err (hub->intfdev, "resubmit --> %d\n", status);
386 /* USB 2.0 spec Section 11.24.2.3 */
388 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
390 return usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
391 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
396 * enumeration blocks khubd for a long time. we use keventd instead, since
397 * long blocking there is the exception, not the rule. accordingly, HCDs
398 * talking to TTs must queue control transfers (not just bulk and iso), so
399 * both can talk to the same hub concurrently.
401 static void hub_tt_kevent (struct work_struct *work)
403 struct usb_hub *hub =
404 container_of(work, struct usb_hub, tt.kevent);
407 spin_lock_irqsave (&hub->tt.lock, flags);
408 while (!list_empty (&hub->tt.clear_list)) {
409 struct list_head *temp;
410 struct usb_tt_clear *clear;
411 struct usb_device *hdev = hub->hdev;
414 temp = hub->tt.clear_list.next;
415 clear = list_entry (temp, struct usb_tt_clear, clear_list);
416 list_del (&clear->clear_list);
418 /* drop lock so HCD can concurrently report other TT errors */
419 spin_unlock_irqrestore (&hub->tt.lock, flags);
420 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
421 spin_lock_irqsave (&hub->tt.lock, flags);
425 "clear tt %d (%04x) error %d\n",
426 clear->tt, clear->devinfo, status);
429 spin_unlock_irqrestore (&hub->tt.lock, flags);
433 * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
434 * @udev: the device whose split transaction failed
435 * @pipe: identifies the endpoint of the failed transaction
437 * High speed HCDs use this to tell the hub driver that some split control or
438 * bulk transaction failed in a way that requires clearing internal state of
439 * a transaction translator. This is normally detected (and reported) from
442 * It may not be possible for that hub to handle additional full (or low)
443 * speed transactions until that state is fully cleared out.
445 void usb_hub_tt_clear_buffer (struct usb_device *udev, int pipe)
447 struct usb_tt *tt = udev->tt;
449 struct usb_tt_clear *clear;
451 /* we've got to cope with an arbitrary number of pending TT clears,
452 * since each TT has "at least two" buffers that can need it (and
453 * there can be many TTs per hub). even if they're uncommon.
455 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
456 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
457 /* FIXME recover somehow ... RESET_TT? */
461 /* info that CLEAR_TT_BUFFER needs */
462 clear->tt = tt->multi ? udev->ttport : 1;
463 clear->devinfo = usb_pipeendpoint (pipe);
464 clear->devinfo |= udev->devnum << 4;
465 clear->devinfo |= usb_pipecontrol (pipe)
466 ? (USB_ENDPOINT_XFER_CONTROL << 11)
467 : (USB_ENDPOINT_XFER_BULK << 11);
468 if (usb_pipein (pipe))
469 clear->devinfo |= 1 << 15;
471 /* tell keventd to clear state for this TT */
472 spin_lock_irqsave (&tt->lock, flags);
473 list_add_tail (&clear->clear_list, &tt->clear_list);
474 schedule_work (&tt->kevent);
475 spin_unlock_irqrestore (&tt->lock, flags);
478 static void hub_power_on(struct usb_hub *hub)
481 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
482 u16 wHubCharacteristics =
483 le16_to_cpu(hub->descriptor->wHubCharacteristics);
485 /* Enable power on each port. Some hubs have reserved values
486 * of LPSM (> 2) in their descriptors, even though they are
487 * USB 2.0 hubs. Some hubs do not implement port-power switching
488 * but only emulate it. In all cases, the ports won't work
489 * unless we send these messages to the hub.
491 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
492 dev_dbg(hub->intfdev, "enabling power on all ports\n");
494 dev_dbg(hub->intfdev, "trying to enable port power on "
495 "non-switchable hub\n");
496 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
497 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
499 /* Wait at least 100 msec for power to become stable */
500 msleep(max(pgood_delay, (unsigned) 100));
503 static void hub_quiesce(struct usb_hub *hub)
505 /* (nonblocking) khubd and related activity won't re-trigger */
509 /* (blocking) stop khubd and related activity */
510 usb_kill_urb(hub->urb);
511 if (hub->has_indicators)
512 cancel_delayed_work(&hub->leds);
513 if (hub->has_indicators || hub->tt.hub)
514 flush_scheduled_work();
517 static void hub_activate(struct usb_hub *hub)
524 status = usb_submit_urb(hub->urb, GFP_NOIO);
526 dev_err(hub->intfdev, "activate --> %d\n", status);
527 if (hub->has_indicators && blinkenlights)
528 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
530 /* scan all ports ASAP */
534 static int hub_hub_status(struct usb_hub *hub,
535 u16 *status, u16 *change)
539 mutex_lock(&hub->status_mutex);
540 ret = get_hub_status(hub->hdev, &hub->status->hub);
542 dev_err (hub->intfdev,
543 "%s failed (err = %d)\n", __FUNCTION__, ret);
545 *status = le16_to_cpu(hub->status->hub.wHubStatus);
546 *change = le16_to_cpu(hub->status->hub.wHubChange);
549 mutex_unlock(&hub->status_mutex);
553 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
555 struct usb_device *hdev = hub->hdev;
558 if (hdev->children[port1-1] && set_state)
559 usb_set_device_state(hdev->children[port1-1],
560 USB_STATE_NOTATTACHED);
562 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
564 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
570 * Disable a port and mark a logical connnect-change event, so that some
571 * time later khubd will disconnect() any existing usb_device on the port
572 * and will re-enumerate if there actually is a device attached.
574 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
576 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
577 hub_port_disable(hub, port1, 1);
579 /* FIXME let caller ask to power down the port:
580 * - some devices won't enumerate without a VBUS power cycle
581 * - SRP saves power that way
582 * - ... new call, TBD ...
583 * That's easy if this hub can switch power per-port, and
584 * khubd reactivates the port later (timer, SRP, etc).
585 * Powerdown must be optional, because of reset/DFU.
588 set_bit(port1, hub->change_bits);
592 static void disconnect_all_children(struct usb_hub *hub, int logical)
594 struct usb_device *hdev = hub->hdev;
597 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
598 if (hdev->children[port1-1]) {
600 hub_port_logical_disconnect(hub, port1);
602 usb_disconnect(&hdev->children[port1-1]);
607 #ifdef CONFIG_USB_PERSIST
609 #define USB_PERSIST 1
611 /* For "persistent-device" resets we must mark the child devices for reset
612 * and turn off a possible connect-change status (so khubd won't disconnect
615 static void mark_children_for_reset_resume(struct usb_hub *hub)
617 struct usb_device *hdev = hub->hdev;
620 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
621 struct usb_device *child = hdev->children[port1-1];
624 child->reset_resume = 1;
625 clear_port_feature(hdev, port1,
626 USB_PORT_FEAT_C_CONNECTION);
633 #define USB_PERSIST 0
635 static inline void mark_children_for_reset_resume(struct usb_hub *hub)
638 #endif /* CONFIG_USB_PERSIST */
640 /* caller has locked the hub device */
641 static void hub_pre_reset(struct usb_interface *intf)
643 struct usb_hub *hub = usb_get_intfdata(intf);
645 /* This routine doesn't run as part of a reset-resume, so it's safe
646 * to disconnect all the drivers below the hub.
648 disconnect_all_children(hub, 0);
652 /* caller has locked the hub device */
653 static void hub_post_reset(struct usb_interface *intf, int reset_resume)
655 struct usb_hub *hub = usb_get_intfdata(intf);
660 mark_children_for_reset_resume(hub);
662 /* Reset-resume doesn't call pre_reset, so we have to
663 * disconnect the children here. But we may not lock
664 * the child devices, so we have to do a "logical"
667 disconnect_all_children(hub, 1);
674 static int hub_configure(struct usb_hub *hub,
675 struct usb_endpoint_descriptor *endpoint)
677 struct usb_device *hdev = hub->hdev;
678 struct device *hub_dev = hub->intfdev;
679 u16 hubstatus, hubchange;
680 u16 wHubCharacteristics;
685 hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
688 message = "can't allocate hub irq buffer";
693 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
695 message = "can't kmalloc hub status buffer";
699 mutex_init(&hub->status_mutex);
701 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
702 if (!hub->descriptor) {
703 message = "can't kmalloc hub descriptor";
708 /* Request the entire hub descriptor.
709 * hub->descriptor can handle USB_MAXCHILDREN ports,
710 * but the hub can/will return fewer bytes here.
712 ret = get_hub_descriptor(hdev, hub->descriptor,
713 sizeof(*hub->descriptor));
715 message = "can't read hub descriptor";
717 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
718 message = "hub has too many ports!";
723 hdev->maxchild = hub->descriptor->bNbrPorts;
724 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
725 (hdev->maxchild == 1) ? "" : "s");
727 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
729 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
731 char portstr [USB_MAXCHILDREN + 1];
733 for (i = 0; i < hdev->maxchild; i++)
734 portstr[i] = hub->descriptor->DeviceRemovable
735 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
737 portstr[hdev->maxchild] = 0;
738 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
740 dev_dbg(hub_dev, "standalone hub\n");
742 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
744 dev_dbg(hub_dev, "ganged power switching\n");
747 dev_dbg(hub_dev, "individual port power switching\n");
751 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
755 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
757 dev_dbg(hub_dev, "global over-current protection\n");
760 dev_dbg(hub_dev, "individual port over-current protection\n");
764 dev_dbg(hub_dev, "no over-current protection\n");
768 spin_lock_init (&hub->tt.lock);
769 INIT_LIST_HEAD (&hub->tt.clear_list);
770 INIT_WORK (&hub->tt.kevent, hub_tt_kevent);
771 switch (hdev->descriptor.bDeviceProtocol) {
775 dev_dbg(hub_dev, "Single TT\n");
779 ret = usb_set_interface(hdev, 0, 1);
781 dev_dbg(hub_dev, "TT per port\n");
784 dev_err(hub_dev, "Using single TT (err %d)\n",
789 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
790 hdev->descriptor.bDeviceProtocol);
794 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
795 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
796 case HUB_TTTT_8_BITS:
797 if (hdev->descriptor.bDeviceProtocol != 0) {
798 hub->tt.think_time = 666;
799 dev_dbg(hub_dev, "TT requires at most %d "
800 "FS bit times (%d ns)\n",
801 8, hub->tt.think_time);
804 case HUB_TTTT_16_BITS:
805 hub->tt.think_time = 666 * 2;
806 dev_dbg(hub_dev, "TT requires at most %d "
807 "FS bit times (%d ns)\n",
808 16, hub->tt.think_time);
810 case HUB_TTTT_24_BITS:
811 hub->tt.think_time = 666 * 3;
812 dev_dbg(hub_dev, "TT requires at most %d "
813 "FS bit times (%d ns)\n",
814 24, hub->tt.think_time);
816 case HUB_TTTT_32_BITS:
817 hub->tt.think_time = 666 * 4;
818 dev_dbg(hub_dev, "TT requires at most %d "
819 "FS bit times (%d ns)\n",
820 32, hub->tt.think_time);
824 /* probe() zeroes hub->indicator[] */
825 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
826 hub->has_indicators = 1;
827 dev_dbg(hub_dev, "Port indicators are supported\n");
830 dev_dbg(hub_dev, "power on to power good time: %dms\n",
831 hub->descriptor->bPwrOn2PwrGood * 2);
833 /* power budgeting mostly matters with bus-powered hubs,
834 * and battery-powered root hubs (may provide just 8 mA).
836 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
838 message = "can't get hub status";
841 le16_to_cpus(&hubstatus);
842 if (hdev == hdev->bus->root_hub) {
843 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
844 hub->mA_per_port = 500;
846 hub->mA_per_port = hdev->bus_mA;
847 hub->limited_power = 1;
849 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
850 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
851 hub->descriptor->bHubContrCurrent);
852 hub->limited_power = 1;
853 if (hdev->maxchild > 0) {
854 int remaining = hdev->bus_mA -
855 hub->descriptor->bHubContrCurrent;
857 if (remaining < hdev->maxchild * 100)
859 "insufficient power available "
860 "to use all downstream ports\n");
861 hub->mA_per_port = 100; /* 7.2.1.1 */
863 } else { /* Self-powered external hub */
864 /* FIXME: What about battery-powered external hubs that
865 * provide less current per port? */
866 hub->mA_per_port = 500;
868 if (hub->mA_per_port < 500)
869 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
872 ret = hub_hub_status(hub, &hubstatus, &hubchange);
874 message = "can't get hub status";
878 /* local power status reports aren't always correct */
879 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
880 dev_dbg(hub_dev, "local power source is %s\n",
881 (hubstatus & HUB_STATUS_LOCAL_POWER)
882 ? "lost (inactive)" : "good");
884 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
885 dev_dbg(hub_dev, "%sover-current condition exists\n",
886 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
888 /* set up the interrupt endpoint
889 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
890 * bytes as USB2.0[11.12.3] says because some hubs are known
891 * to send more data (and thus cause overflow). For root hubs,
892 * maxpktsize is defined in hcd.c's fake endpoint descriptors
893 * to be big enough for at least USB_MAXCHILDREN ports. */
894 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
895 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
897 if (maxp > sizeof(*hub->buffer))
898 maxp = sizeof(*hub->buffer);
900 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
902 message = "couldn't allocate interrupt urb";
907 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
908 hub, endpoint->bInterval);
909 hub->urb->transfer_dma = hub->buffer_dma;
910 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
912 /* maybe cycle the hub leds */
913 if (hub->has_indicators && blinkenlights)
914 hub->indicator [0] = INDICATOR_CYCLE;
921 dev_err (hub_dev, "config failed, %s (err %d)\n",
923 /* hub_disconnect() frees urb and descriptor */
927 static void hub_release(struct kref *kref)
929 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
931 usb_put_intf(to_usb_interface(hub->intfdev));
935 static unsigned highspeed_hubs;
937 static void hub_disconnect(struct usb_interface *intf)
939 struct usb_hub *hub = usb_get_intfdata (intf);
941 /* Take the hub off the event list and don't let it be added again */
942 spin_lock_irq(&hub_event_lock);
943 list_del_init(&hub->event_list);
944 hub->disconnected = 1;
945 spin_unlock_irq(&hub_event_lock);
947 /* Disconnect all children and quiesce the hub */
951 usb_set_intfdata (intf, NULL);
953 if (hub->hdev->speed == USB_SPEED_HIGH)
956 usb_free_urb(hub->urb);
957 kfree(hub->descriptor);
959 usb_buffer_free(hub->hdev, sizeof(*hub->buffer), hub->buffer,
962 kref_put(&hub->kref, hub_release);
965 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
967 struct usb_host_interface *desc;
968 struct usb_endpoint_descriptor *endpoint;
969 struct usb_device *hdev;
972 desc = intf->cur_altsetting;
973 hdev = interface_to_usbdev(intf);
975 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
977 dev_warn(&intf->dev, "ignoring external hub\n");
982 /* Some hubs have a subclass of 1, which AFAICT according to the */
983 /* specs is not defined, but it works */
984 if ((desc->desc.bInterfaceSubClass != 0) &&
985 (desc->desc.bInterfaceSubClass != 1)) {
987 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
991 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
992 if (desc->desc.bNumEndpoints != 1)
993 goto descriptor_error;
995 endpoint = &desc->endpoint[0].desc;
997 /* If it's not an interrupt in endpoint, we'd better punt! */
998 if (!usb_endpoint_is_int_in(endpoint))
999 goto descriptor_error;
1001 /* We found a hub */
1002 dev_info (&intf->dev, "USB hub found\n");
1004 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1006 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1010 kref_init(&hub->kref);
1011 INIT_LIST_HEAD(&hub->event_list);
1012 hub->intfdev = &intf->dev;
1014 INIT_DELAYED_WORK(&hub->leds, led_work);
1017 usb_set_intfdata (intf, hub);
1018 intf->needs_remote_wakeup = 1;
1020 if (hdev->speed == USB_SPEED_HIGH)
1023 if (hub_configure(hub, endpoint) >= 0)
1026 hub_disconnect (intf);
1031 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1033 struct usb_device *hdev = interface_to_usbdev (intf);
1035 /* assert ifno == 0 (part of hub spec) */
1037 case USBDEVFS_HUB_PORTINFO: {
1038 struct usbdevfs_hub_portinfo *info = user_data;
1041 spin_lock_irq(&device_state_lock);
1042 if (hdev->devnum <= 0)
1045 info->nports = hdev->maxchild;
1046 for (i = 0; i < info->nports; i++) {
1047 if (hdev->children[i] == NULL)
1051 hdev->children[i]->devnum;
1054 spin_unlock_irq(&device_state_lock);
1056 return info->nports + 1;
1065 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1069 for (i = 0; i < udev->maxchild; ++i) {
1070 if (udev->children[i])
1071 recursively_mark_NOTATTACHED(udev->children[i]);
1073 if (udev->state == USB_STATE_SUSPENDED)
1074 udev->discon_suspended = 1;
1075 udev->state = USB_STATE_NOTATTACHED;
1079 * usb_set_device_state - change a device's current state (usbcore, hcds)
1080 * @udev: pointer to device whose state should be changed
1081 * @new_state: new state value to be stored
1083 * udev->state is _not_ fully protected by the device lock. Although
1084 * most transitions are made only while holding the lock, the state can
1085 * can change to USB_STATE_NOTATTACHED at almost any time. This
1086 * is so that devices can be marked as disconnected as soon as possible,
1087 * without having to wait for any semaphores to be released. As a result,
1088 * all changes to any device's state must be protected by the
1089 * device_state_lock spinlock.
1091 * Once a device has been added to the device tree, all changes to its state
1092 * should be made using this routine. The state should _not_ be set directly.
1094 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1095 * Otherwise udev->state is set to new_state, and if new_state is
1096 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1097 * to USB_STATE_NOTATTACHED.
1099 void usb_set_device_state(struct usb_device *udev,
1100 enum usb_device_state new_state)
1102 unsigned long flags;
1104 spin_lock_irqsave(&device_state_lock, flags);
1105 if (udev->state == USB_STATE_NOTATTACHED)
1107 else if (new_state != USB_STATE_NOTATTACHED) {
1109 /* root hub wakeup capabilities are managed out-of-band
1110 * and may involve silicon errata ... ignore them here.
1113 if (udev->state == USB_STATE_SUSPENDED
1114 || new_state == USB_STATE_SUSPENDED)
1115 ; /* No change to wakeup settings */
1116 else if (new_state == USB_STATE_CONFIGURED)
1117 device_init_wakeup(&udev->dev,
1118 (udev->actconfig->desc.bmAttributes
1119 & USB_CONFIG_ATT_WAKEUP));
1121 device_init_wakeup(&udev->dev, 0);
1123 udev->state = new_state;
1125 recursively_mark_NOTATTACHED(udev);
1126 spin_unlock_irqrestore(&device_state_lock, flags);
1133 * usb_reset_suspended_device - reset a suspended device instead of resuming it
1134 * @udev: device to be reset instead of resumed
1136 * If a host controller doesn't maintain VBUS suspend current during a
1137 * system sleep or is reset when the system wakes up, all the USB
1138 * power sessions below it will be broken. This is especially troublesome
1139 * for mass-storage devices containing mounted filesystems, since the
1140 * device will appear to have disconnected and all the memory mappings
1141 * to it will be lost.
1143 * As an alternative, this routine attempts to recover power sessions for
1144 * devices that are still present by resetting them instead of resuming
1145 * them. If all goes well, the devices will appear to persist across the
1146 * the interruption of the power sessions.
1148 * This facility is inherently dangerous. Although usb_reset_device()
1149 * makes every effort to insure that the same device is present after the
1150 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
1151 * quite possible for a device to remain unaltered but its media to be
1152 * changed. If the user replaces a flash memory card while the system is
1153 * asleep, he will have only himself to blame when the filesystem on the
1154 * new card is corrupted and the system crashes.
1156 int usb_reset_suspended_device(struct usb_device *udev)
1160 dev_dbg(&udev->dev, "usb %sresume\n", "reset-");
1162 /* After we're done the device won't be suspended any more.
1163 * In addition, the reset won't work if udev->state is SUSPENDED.
1165 usb_set_device_state(udev, udev->actconfig
1166 ? USB_STATE_CONFIGURED
1167 : USB_STATE_ADDRESS);
1169 /* Root hubs don't need to be (and can't be) reset */
1171 rc = usb_reset_device(udev);
1176 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
1177 * @rhdev: struct usb_device for the root hub
1179 * The USB host controller driver calls this function when its root hub
1180 * is resumed and Vbus power has been interrupted or the controller
1181 * has been reset. The routine marks @rhdev as having lost power. When
1182 * the hub driver is resumed it will take notice; if CONFIG_USB_PERSIST
1183 * is enabled then it will carry out power-session recovery, otherwise
1184 * it will disconnect all the child devices.
1186 void usb_root_hub_lost_power(struct usb_device *rhdev)
1188 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
1189 rhdev->reset_resume = 1;
1191 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
1193 #endif /* CONFIG_PM */
1195 static void choose_address(struct usb_device *udev)
1198 struct usb_bus *bus = udev->bus;
1200 /* If khubd ever becomes multithreaded, this will need a lock */
1202 /* Try to allocate the next devnum beginning at bus->devnum_next. */
1203 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1206 devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
1208 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1211 set_bit(devnum, bus->devmap.devicemap);
1212 udev->devnum = devnum;
1216 static void release_address(struct usb_device *udev)
1218 if (udev->devnum > 0) {
1219 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1224 #ifdef CONFIG_USB_SUSPEND
1226 static void usb_stop_pm(struct usb_device *udev)
1228 /* Synchronize with the ksuspend thread to prevent any more
1229 * autosuspend requests from being submitted, and decrement
1230 * the parent's count of unsuspended children.
1233 if (udev->parent && !udev->discon_suspended)
1234 usb_autosuspend_device(udev->parent);
1235 usb_pm_unlock(udev);
1237 /* Stop any autosuspend requests already submitted */
1238 cancel_rearming_delayed_work(&udev->autosuspend);
1243 static inline void usb_stop_pm(struct usb_device *udev)
1249 * usb_disconnect - disconnect a device (usbcore-internal)
1250 * @pdev: pointer to device being disconnected
1251 * Context: !in_interrupt ()
1253 * Something got disconnected. Get rid of it and all of its children.
1255 * If *pdev is a normal device then the parent hub must already be locked.
1256 * If *pdev is a root hub then this routine will acquire the
1257 * usb_bus_list_lock on behalf of the caller.
1259 * Only hub drivers (including virtual root hub drivers for host
1260 * controllers) should ever call this.
1262 * This call is synchronous, and may not be used in an interrupt context.
1264 void usb_disconnect(struct usb_device **pdev)
1266 struct usb_device *udev = *pdev;
1270 pr_debug ("%s nodev\n", __FUNCTION__);
1274 /* mark the device as inactive, so any further urb submissions for
1275 * this device (and any of its children) will fail immediately.
1276 * this quiesces everyting except pending urbs.
1278 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1279 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1281 usb_lock_device(udev);
1283 /* Free up all the children before we remove this device */
1284 for (i = 0; i < USB_MAXCHILDREN; i++) {
1285 if (udev->children[i])
1286 usb_disconnect(&udev->children[i]);
1289 /* deallocate hcd/hardware state ... nuking all pending urbs and
1290 * cleaning up all state associated with the current configuration
1291 * so that the hardware is now fully quiesced.
1293 dev_dbg (&udev->dev, "unregistering device\n");
1294 usb_disable_device(udev, 0);
1296 usb_unlock_device(udev);
1298 /* Unregister the device. The device driver is responsible
1299 * for removing the device files from usbfs and sysfs and for
1300 * de-configuring the device.
1302 device_del(&udev->dev);
1304 /* Free the device number and delete the parent's children[]
1305 * (or root_hub) pointer.
1307 release_address(udev);
1309 /* Avoid races with recursively_mark_NOTATTACHED() */
1310 spin_lock_irq(&device_state_lock);
1312 spin_unlock_irq(&device_state_lock);
1316 put_device(&udev->dev);
1320 static void show_string(struct usb_device *udev, char *id, char *string)
1324 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1328 static inline void show_string(struct usb_device *udev, char *id, char *string)
1333 #ifdef CONFIG_USB_OTG
1334 #include "otg_whitelist.h"
1335 static int __usb_port_suspend(struct usb_device *, int port1);
1339 * usb_new_device - perform initial device setup (usbcore-internal)
1340 * @udev: newly addressed device (in ADDRESS state)
1342 * This is called with devices which have been enumerated, but not yet
1343 * configured. The device descriptor is available, but not descriptors
1344 * for any device configuration. The caller must have locked either
1345 * the parent hub (if udev is a normal device) or else the
1346 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1347 * udev has already been installed, but udev is not yet visible through
1348 * sysfs or other filesystem code.
1350 * It will return if the device is configured properly or not. Zero if
1351 * the interface was registered with the driver core; else a negative
1354 * This call is synchronous, and may not be used in an interrupt context.
1356 * Only the hub driver or root-hub registrar should ever call this.
1358 int usb_new_device(struct usb_device *udev)
1362 /* Determine quirks */
1363 usb_detect_quirks(udev);
1365 err = usb_get_configuration(udev);
1367 dev_err(&udev->dev, "can't read configurations, error %d\n",
1372 /* read the standard strings and cache them if present */
1373 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1374 udev->manufacturer = usb_cache_string(udev,
1375 udev->descriptor.iManufacturer);
1376 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1378 /* Tell the world! */
1379 dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
1380 "SerialNumber=%d\n",
1381 udev->descriptor.iManufacturer,
1382 udev->descriptor.iProduct,
1383 udev->descriptor.iSerialNumber);
1384 show_string(udev, "Product", udev->product);
1385 show_string(udev, "Manufacturer", udev->manufacturer);
1386 show_string(udev, "SerialNumber", udev->serial);
1388 #ifdef CONFIG_USB_OTG
1390 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1391 * to wake us after we've powered off VBUS; and HNP, switching roles
1392 * "host" to "peripheral". The OTG descriptor helps figure this out.
1394 if (!udev->bus->is_b_host
1396 && udev->parent == udev->bus->root_hub) {
1397 struct usb_otg_descriptor *desc = 0;
1398 struct usb_bus *bus = udev->bus;
1400 /* descriptor may appear anywhere in config */
1401 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1402 le16_to_cpu(udev->config[0].desc.wTotalLength),
1403 USB_DT_OTG, (void **) &desc) == 0) {
1404 if (desc->bmAttributes & USB_OTG_HNP) {
1405 unsigned port1 = udev->portnum;
1407 dev_info(&udev->dev,
1408 "Dual-Role OTG device on %sHNP port\n",
1409 (port1 == bus->otg_port)
1412 /* enable HNP before suspend, it's simpler */
1413 if (port1 == bus->otg_port)
1414 bus->b_hnp_enable = 1;
1415 err = usb_control_msg(udev,
1416 usb_sndctrlpipe(udev, 0),
1417 USB_REQ_SET_FEATURE, 0,
1419 ? USB_DEVICE_B_HNP_ENABLE
1420 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1421 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1423 /* OTG MESSAGE: report errors here,
1424 * customize to match your product.
1426 dev_info(&udev->dev,
1427 "can't set HNP mode; %d\n",
1429 bus->b_hnp_enable = 0;
1435 if (!is_targeted(udev)) {
1437 /* Maybe it can talk to us, though we can't talk to it.
1438 * (Includes HNP test device.)
1440 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1441 err = __usb_port_suspend(udev, udev->bus->otg_port);
1443 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1450 /* export the usbdev device-node for libusb */
1451 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1452 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1454 /* Register the device. The device driver is responsible
1455 * for adding the device files to sysfs and for configuring
1458 err = device_add(&udev->dev);
1460 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1464 /* Increment the parent's count of unsuspended children */
1466 usb_autoresume_device(udev->parent);
1472 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1476 static int hub_port_status(struct usb_hub *hub, int port1,
1477 u16 *status, u16 *change)
1481 mutex_lock(&hub->status_mutex);
1482 ret = get_port_status(hub->hdev, port1, &hub->status->port);
1484 dev_err (hub->intfdev,
1485 "%s failed (err = %d)\n", __FUNCTION__, ret);
1489 *status = le16_to_cpu(hub->status->port.wPortStatus);
1490 *change = le16_to_cpu(hub->status->port.wPortChange);
1493 mutex_unlock(&hub->status_mutex);
1498 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1499 static unsigned hub_is_wusb(struct usb_hub *hub)
1501 struct usb_hcd *hcd;
1502 if (hub->hdev->parent != NULL) /* not a root hub? */
1504 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
1505 return hcd->wireless;
1509 #define PORT_RESET_TRIES 5
1510 #define SET_ADDRESS_TRIES 2
1511 #define GET_DESCRIPTOR_TRIES 2
1512 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1513 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1515 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1516 #define HUB_SHORT_RESET_TIME 10
1517 #define HUB_LONG_RESET_TIME 200
1518 #define HUB_RESET_TIMEOUT 500
1520 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1521 struct usb_device *udev, unsigned int delay)
1523 int delay_time, ret;
1527 for (delay_time = 0;
1528 delay_time < HUB_RESET_TIMEOUT;
1529 delay_time += delay) {
1530 /* wait to give the device a chance to reset */
1533 /* read and decode port status */
1534 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1538 /* Device went away? */
1539 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1542 /* bomb out completely if something weird happened */
1543 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1546 /* if we`ve finished resetting, then break out of the loop */
1547 if (!(portstatus & USB_PORT_STAT_RESET) &&
1548 (portstatus & USB_PORT_STAT_ENABLE)) {
1549 if (hub_is_wusb(hub))
1550 udev->speed = USB_SPEED_VARIABLE;
1551 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1552 udev->speed = USB_SPEED_HIGH;
1553 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1554 udev->speed = USB_SPEED_LOW;
1556 udev->speed = USB_SPEED_FULL;
1560 /* switch to the long delay after two short delay failures */
1561 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1562 delay = HUB_LONG_RESET_TIME;
1564 dev_dbg (hub->intfdev,
1565 "port %d not reset yet, waiting %dms\n",
1572 static int hub_port_reset(struct usb_hub *hub, int port1,
1573 struct usb_device *udev, unsigned int delay)
1577 /* Reset the port */
1578 for (i = 0; i < PORT_RESET_TRIES; i++) {
1579 status = set_port_feature(hub->hdev,
1580 port1, USB_PORT_FEAT_RESET);
1582 dev_err(hub->intfdev,
1583 "cannot reset port %d (err = %d)\n",
1586 status = hub_port_wait_reset(hub, port1, udev, delay);
1587 if (status && status != -ENOTCONN)
1588 dev_dbg(hub->intfdev,
1589 "port_wait_reset: err = %d\n",
1593 /* return on disconnect or reset */
1596 /* TRSTRCY = 10 ms; plus some extra */
1601 clear_port_feature(hub->hdev,
1602 port1, USB_PORT_FEAT_C_RESET);
1603 /* FIXME need disconnect() for NOTATTACHED device */
1604 usb_set_device_state(udev, status
1605 ? USB_STATE_NOTATTACHED
1606 : USB_STATE_DEFAULT);
1610 dev_dbg (hub->intfdev,
1611 "port %d not enabled, trying reset again...\n",
1613 delay = HUB_LONG_RESET_TIME;
1616 dev_err (hub->intfdev,
1617 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1625 #ifdef CONFIG_USB_SUSPEND
1628 * Selective port suspend reduces power; most suspended devices draw
1629 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1630 * All devices below the suspended port are also suspended.
1632 * Devices leave suspend state when the host wakes them up. Some devices
1633 * also support "remote wakeup", where the device can activate the USB
1634 * tree above them to deliver data, such as a keypress or packet. In
1635 * some cases, this wakes the USB host.
1637 static int hub_port_suspend(struct usb_hub *hub, int port1,
1638 struct usb_device *udev)
1642 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1644 /* enable remote wakeup when appropriate; this lets the device
1645 * wake up the upstream hub (including maybe the root hub).
1647 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1648 * we don't explicitly enable it here.
1650 if (udev->do_remote_wakeup) {
1651 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1652 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1653 USB_DEVICE_REMOTE_WAKEUP, 0,
1655 USB_CTRL_SET_TIMEOUT);
1658 "won't remote wakeup, status %d\n",
1663 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1665 dev_dbg(hub->intfdev,
1666 "can't suspend port %d, status %d\n",
1668 /* paranoia: "should not happen" */
1669 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1670 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1671 USB_DEVICE_REMOTE_WAKEUP, 0,
1673 USB_CTRL_SET_TIMEOUT);
1675 /* device has up to 10 msec to fully suspend */
1676 dev_dbg(&udev->dev, "usb %ssuspend\n",
1677 udev->auto_pm ? "auto-" : "");
1678 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1685 * Devices on USB hub ports have only one "suspend" state, corresponding
1686 * to ACPI D2, "may cause the device to lose some context".
1687 * State transitions include:
1689 * - suspend, resume ... when the VBUS power link stays live
1690 * - suspend, disconnect ... VBUS lost
1692 * Once VBUS drop breaks the circuit, the port it's using has to go through
1693 * normal re-enumeration procedures, starting with enabling VBUS power.
1694 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1695 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1696 * timer, no SRP, no requests through sysfs.
1698 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1699 * the root hub for their bus goes into global suspend ... so we don't
1700 * (falsely) update the device power state to say it suspended.
1702 static int __usb_port_suspend (struct usb_device *udev, int port1)
1706 /* caller owns the udev device lock */
1710 /* we change the device's upstream USB link,
1711 * but root hubs have no upstream USB link.
1714 status = hub_port_suspend(hdev_to_hub(udev->parent), port1,
1717 dev_dbg(&udev->dev, "usb %ssuspend\n",
1718 udev->auto_pm ? "auto-" : "");
1719 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1725 * usb_port_suspend - suspend a usb device's upstream port
1726 * @udev: device that's no longer in active use
1727 * Context: must be able to sleep; device not locked; pm locks held
1729 * Suspends a USB device that isn't in active use, conserving power.
1730 * Devices may wake out of a suspend, if anything important happens,
1731 * using the remote wakeup mechanism. They may also be taken out of
1732 * suspend by the host, using usb_port_resume(). It's also routine
1733 * to disconnect devices while they are suspended.
1735 * This only affects the USB hardware for a device; its interfaces
1736 * (and, for hubs, child devices) must already have been suspended.
1738 * Suspending OTG devices may trigger HNP, if that's been enabled
1739 * between a pair of dual-role devices. That will change roles, such
1740 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1742 * Returns 0 on success, else negative errno.
1744 int usb_port_suspend(struct usb_device *udev)
1746 return __usb_port_suspend(udev, udev->portnum);
1750 * If the USB "suspend" state is in use (rather than "global suspend"),
1751 * many devices will be individually taken out of suspend state using
1752 * special" resume" signaling. These routines kick in shortly after
1753 * hardware resume signaling is finished, either because of selective
1754 * resume (by host) or remote wakeup (by device) ... now see what changed
1755 * in the tree that's rooted at this device.
1757 static int finish_port_resume(struct usb_device *udev)
1762 /* caller owns the udev device lock */
1763 dev_dbg(&udev->dev, "finish resume\n");
1765 /* usb ch9 identifies four variants of SUSPENDED, based on what
1766 * state the device resumes to. Linux currently won't see the
1767 * first two on the host side; they'd be inside hub_port_init()
1768 * during many timeouts, but khubd can't suspend until later.
1770 usb_set_device_state(udev, udev->actconfig
1771 ? USB_STATE_CONFIGURED
1772 : USB_STATE_ADDRESS);
1774 /* 10.5.4.5 says be sure devices in the tree are still there.
1775 * For now let's assume the device didn't go crazy on resume,
1776 * and device drivers will know about any resume quirks.
1778 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
1780 status = (status == 2 ? 0 : -ENODEV);
1784 "gone after usb resume? status %d\n",
1786 else if (udev->actconfig) {
1787 le16_to_cpus(&devstatus);
1788 if ((devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
1790 status = usb_control_msg(udev,
1791 usb_sndctrlpipe(udev, 0),
1792 USB_REQ_CLEAR_FEATURE,
1794 USB_DEVICE_REMOTE_WAKEUP, 0,
1796 USB_CTRL_SET_TIMEOUT);
1798 dev_dbg(&udev->dev, "disable remote "
1799 "wakeup, status %d\n", status);
1803 } else if (udev->devnum <= 0) {
1804 dev_dbg(&udev->dev, "bogus resume!\n");
1811 hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1814 u16 portchange, portstatus;
1816 /* Skip the initial Clear-Suspend step for a remote wakeup */
1817 status = hub_port_status(hub, port1, &portstatus, &portchange);
1818 if (status == 0 && !(portstatus & USB_PORT_STAT_SUSPEND))
1819 goto SuspendCleared;
1821 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1823 set_bit(port1, hub->busy_bits);
1825 /* see 7.1.7.7; affects power usage, but not budgeting */
1826 status = clear_port_feature(hub->hdev,
1827 port1, USB_PORT_FEAT_SUSPEND);
1829 dev_dbg(hub->intfdev,
1830 "can't resume port %d, status %d\n",
1833 /* drive resume for at least 20 msec */
1835 dev_dbg(&udev->dev, "usb %sresume\n",
1836 udev->auto_pm ? "auto-" : "");
1839 #define LIVE_FLAGS ( USB_PORT_STAT_POWER \
1840 | USB_PORT_STAT_ENABLE \
1841 | USB_PORT_STAT_CONNECTION)
1843 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1844 * stop resume signaling. Then finish the resume
1847 status = hub_port_status(hub, port1, &portstatus, &portchange);
1850 || (portstatus & LIVE_FLAGS) != LIVE_FLAGS
1851 || (portstatus & USB_PORT_STAT_SUSPEND) != 0
1853 dev_dbg(hub->intfdev,
1854 "port %d status %04x.%04x after resume, %d\n",
1855 port1, portchange, portstatus, status);
1859 if (portchange & USB_PORT_STAT_C_SUSPEND)
1860 clear_port_feature(hub->hdev, port1,
1861 USB_PORT_FEAT_C_SUSPEND);
1862 /* TRSMRCY = 10 msec */
1865 status = finish_port_resume(udev);
1869 hub_port_logical_disconnect(hub, port1);
1871 clear_bit(port1, hub->busy_bits);
1872 if (!hub->hdev->parent && !hub->busy_bits[0])
1873 usb_enable_root_hub_irq(hub->hdev->bus);
1879 * usb_port_resume - re-activate a suspended usb device's upstream port
1880 * @udev: device to re-activate
1881 * Context: must be able to sleep; device not locked; pm locks held
1883 * This will re-activate the suspended device, increasing power usage
1884 * while letting drivers communicate again with its endpoints.
1885 * USB resume explicitly guarantees that the power session between
1886 * the host and the device is the same as it was when the device
1889 * Returns 0 on success, else negative errno.
1891 int usb_port_resume(struct usb_device *udev)
1895 /* we change the device's upstream USB link,
1896 * but root hubs have no upstream USB link.
1899 // NOTE this fails if parent is also suspended...
1900 status = hub_port_resume(hdev_to_hub(udev->parent),
1901 udev->portnum, udev);
1903 dev_dbg(&udev->dev, "usb %sresume\n",
1904 udev->auto_pm ? "auto-" : "");
1905 status = finish_port_resume(udev);
1908 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
1912 static int remote_wakeup(struct usb_device *udev)
1916 usb_lock_device(udev);
1917 if (udev->state == USB_STATE_SUSPENDED) {
1918 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
1919 usb_mark_last_busy(udev);
1920 status = usb_external_resume_device(udev);
1922 usb_unlock_device(udev);
1926 #else /* CONFIG_USB_SUSPEND */
1928 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
1930 int usb_port_suspend(struct usb_device *udev)
1936 finish_port_resume(struct usb_device *udev)
1942 hub_port_resume(struct usb_hub *hub, int port1, struct usb_device *udev)
1947 int usb_port_resume(struct usb_device *udev)
1952 static inline int remote_wakeup(struct usb_device *udev)
1959 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
1961 struct usb_hub *hub = usb_get_intfdata (intf);
1962 struct usb_device *hdev = hub->hdev;
1965 /* fail if children aren't already suspended */
1966 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1967 struct usb_device *udev;
1969 udev = hdev->children [port1-1];
1970 if (udev && msg.event == PM_EVENT_SUSPEND &&
1971 #ifdef CONFIG_USB_SUSPEND
1972 udev->state != USB_STATE_SUSPENDED
1974 udev->dev.power.power_state.event
1979 dev_dbg(&intf->dev, "port %d nyet suspended\n",
1985 dev_dbg(&intf->dev, "%s\n", __FUNCTION__);
1987 /* stop khubd and related activity */
1992 static int hub_resume(struct usb_interface *intf)
1994 struct usb_hub *hub = usb_get_intfdata (intf);
1996 dev_dbg(&intf->dev, "%s\n", __FUNCTION__);
1998 /* tell khubd to look for changes on this hub */
2003 #else /* CONFIG_PM */
2005 static inline int remote_wakeup(struct usb_device *udev)
2010 #define hub_suspend NULL
2011 #define hub_resume NULL
2015 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2017 * Between connect detection and reset signaling there must be a delay
2018 * of 100ms at least for debounce and power-settling. The corresponding
2019 * timer shall restart whenever the downstream port detects a disconnect.
2021 * Apparently there are some bluetooth and irda-dongles and a number of
2022 * low-speed devices for which this debounce period may last over a second.
2023 * Not covered by the spec - but easy to deal with.
2025 * This implementation uses a 1500ms total debounce timeout; if the
2026 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2027 * every 25ms for transient disconnects. When the port status has been
2028 * unchanged for 100ms it returns the port status.
2031 #define HUB_DEBOUNCE_TIMEOUT 1500
2032 #define HUB_DEBOUNCE_STEP 25
2033 #define HUB_DEBOUNCE_STABLE 100
2035 static int hub_port_debounce(struct usb_hub *hub, int port1)
2038 int total_time, stable_time = 0;
2039 u16 portchange, portstatus;
2040 unsigned connection = 0xffff;
2042 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2043 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2047 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2048 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2049 stable_time += HUB_DEBOUNCE_STEP;
2050 if (stable_time >= HUB_DEBOUNCE_STABLE)
2054 connection = portstatus & USB_PORT_STAT_CONNECTION;
2057 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2058 clear_port_feature(hub->hdev, port1,
2059 USB_PORT_FEAT_C_CONNECTION);
2062 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2064 msleep(HUB_DEBOUNCE_STEP);
2067 dev_dbg (hub->intfdev,
2068 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2069 port1, total_time, stable_time, portstatus);
2071 if (stable_time < HUB_DEBOUNCE_STABLE)
2076 static void ep0_reinit(struct usb_device *udev)
2078 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
2079 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
2080 udev->ep_in[0] = udev->ep_out[0] = &udev->ep0;
2083 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2084 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2086 static int hub_set_address(struct usb_device *udev)
2090 if (udev->devnum == 0)
2092 if (udev->state == USB_STATE_ADDRESS)
2094 if (udev->state != USB_STATE_DEFAULT)
2096 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2097 USB_REQ_SET_ADDRESS, 0, udev->devnum, 0,
2098 NULL, 0, USB_CTRL_SET_TIMEOUT);
2100 usb_set_device_state(udev, USB_STATE_ADDRESS);
2106 /* Reset device, (re)assign address, get device descriptor.
2107 * Device connection must be stable, no more debouncing needed.
2108 * Returns device in USB_STATE_ADDRESS, except on error.
2110 * If this is called for an already-existing device (as part of
2111 * usb_reset_device), the caller must own the device lock. For a
2112 * newly detected device that is not accessible through any global
2113 * pointers, it's not necessary to lock the device.
2116 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2119 static DEFINE_MUTEX(usb_address0_mutex);
2121 struct usb_device *hdev = hub->hdev;
2123 unsigned delay = HUB_SHORT_RESET_TIME;
2124 enum usb_device_speed oldspeed = udev->speed;
2127 /* root hub ports have a slightly longer reset period
2128 * (from USB 2.0 spec, section 7.1.7.5)
2130 if (!hdev->parent) {
2131 delay = HUB_ROOT_RESET_TIME;
2132 if (port1 == hdev->bus->otg_port)
2133 hdev->bus->b_hnp_enable = 0;
2136 /* Some low speed devices have problems with the quick delay, so */
2137 /* be a bit pessimistic with those devices. RHbug #23670 */
2138 if (oldspeed == USB_SPEED_LOW)
2139 delay = HUB_LONG_RESET_TIME;
2141 mutex_lock(&usb_address0_mutex);
2143 /* Reset the device; full speed may morph to high speed */
2144 retval = hub_port_reset(hub, port1, udev, delay);
2145 if (retval < 0) /* error or disconnect */
2147 /* success, speed is known */
2150 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2151 dev_dbg(&udev->dev, "device reset changed speed!\n");
2154 oldspeed = udev->speed;
2156 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2157 * it's fixed size except for full speed devices.
2158 * For Wireless USB devices, ep0 max packet is always 512 (tho
2159 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2161 switch (udev->speed) {
2162 case USB_SPEED_VARIABLE: /* fixed at 512 */
2163 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(512);
2165 case USB_SPEED_HIGH: /* fixed at 64 */
2166 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2168 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2169 /* to determine the ep0 maxpacket size, try to read
2170 * the device descriptor to get bMaxPacketSize0 and
2171 * then correct our initial guess.
2173 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2175 case USB_SPEED_LOW: /* fixed at 8 */
2176 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2183 switch (udev->speed) {
2184 case USB_SPEED_LOW: speed = "low"; break;
2185 case USB_SPEED_FULL: speed = "full"; break;
2186 case USB_SPEED_HIGH: speed = "high"; break;
2187 case USB_SPEED_VARIABLE:
2191 default: speed = "?"; break;
2193 dev_info (&udev->dev,
2194 "%s %s speed %sUSB device using %s and address %d\n",
2195 (udev->config) ? "reset" : "new", speed, type,
2196 udev->bus->controller->driver->name, udev->devnum);
2198 /* Set up TT records, if needed */
2200 udev->tt = hdev->tt;
2201 udev->ttport = hdev->ttport;
2202 } else if (udev->speed != USB_SPEED_HIGH
2203 && hdev->speed == USB_SPEED_HIGH) {
2204 udev->tt = &hub->tt;
2205 udev->ttport = port1;
2208 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2209 * Because device hardware and firmware is sometimes buggy in
2210 * this area, and this is how Linux has done it for ages.
2211 * Change it cautiously.
2213 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2214 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2215 * so it may help with some non-standards-compliant devices.
2216 * Otherwise we start with SET_ADDRESS and then try to read the
2217 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2220 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2221 if (USE_NEW_SCHEME(retry_counter)) {
2222 struct usb_device_descriptor *buf;
2225 #define GET_DESCRIPTOR_BUFSIZE 64
2226 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2232 /* Retry on all errors; some devices are flakey.
2233 * 255 is for WUSB devices, we actually need to use
2234 * 512 (WUSB1.0[4.8.1]).
2236 for (j = 0; j < 3; ++j) {
2237 buf->bMaxPacketSize0 = 0;
2238 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2239 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2240 USB_DT_DEVICE << 8, 0,
2241 buf, GET_DESCRIPTOR_BUFSIZE,
2242 USB_CTRL_GET_TIMEOUT);
2243 switch (buf->bMaxPacketSize0) {
2244 case 8: case 16: case 32: case 64: case 255:
2245 if (buf->bDescriptorType ==
2259 udev->descriptor.bMaxPacketSize0 =
2260 buf->bMaxPacketSize0;
2263 retval = hub_port_reset(hub, port1, udev, delay);
2264 if (retval < 0) /* error or disconnect */
2266 if (oldspeed != udev->speed) {
2268 "device reset changed speed!\n");
2273 dev_err(&udev->dev, "device descriptor "
2274 "read/%s, error %d\n",
2279 #undef GET_DESCRIPTOR_BUFSIZE
2282 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2283 retval = hub_set_address(udev);
2290 "device not accepting address %d, error %d\n",
2291 udev->devnum, retval);
2295 /* cope with hardware quirkiness:
2296 * - let SET_ADDRESS settle, some device hardware wants it
2297 * - read ep0 maxpacket even for high and low speed,
2300 if (USE_NEW_SCHEME(retry_counter))
2303 retval = usb_get_device_descriptor(udev, 8);
2305 dev_err(&udev->dev, "device descriptor "
2306 "read/%s, error %d\n",
2318 i = udev->descriptor.bMaxPacketSize0 == 0xff?
2319 512 : udev->descriptor.bMaxPacketSize0;
2320 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2321 if (udev->speed != USB_SPEED_FULL ||
2322 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2323 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2327 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2328 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2332 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2333 if (retval < (signed)sizeof(udev->descriptor)) {
2334 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2345 hub_port_disable(hub, port1, 0);
2346 mutex_unlock(&usb_address0_mutex);
2351 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2353 struct usb_qualifier_descriptor *qual;
2356 qual = kmalloc (sizeof *qual, GFP_KERNEL);
2360 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2361 qual, sizeof *qual);
2362 if (status == sizeof *qual) {
2363 dev_info(&udev->dev, "not running at top speed; "
2364 "connect to a high speed hub\n");
2365 /* hub LEDs are probably harder to miss than syslog */
2366 if (hub->has_indicators) {
2367 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2368 schedule_delayed_work (&hub->leds, 0);
2375 hub_power_remaining (struct usb_hub *hub)
2377 struct usb_device *hdev = hub->hdev;
2381 if (!hub->limited_power)
2384 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2385 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2386 struct usb_device *udev = hdev->children[port1 - 1];
2392 /* Unconfigured devices may not use more than 100mA,
2393 * or 8mA for OTG ports */
2394 if (udev->actconfig)
2395 delta = udev->actconfig->desc.bMaxPower * 2;
2396 else if (port1 != udev->bus->otg_port || hdev->parent)
2400 if (delta > hub->mA_per_port)
2401 dev_warn(&udev->dev, "%dmA is over %umA budget "
2403 delta, hub->mA_per_port, port1);
2406 if (remaining < 0) {
2407 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2414 /* Handle physical or logical connection change events.
2415 * This routine is called when:
2416 * a port connection-change occurs;
2417 * a port enable-change occurs (often caused by EMI);
2418 * usb_reset_device() encounters changed descriptors (as from
2419 * a firmware download)
2420 * caller already locked the hub
2422 static void hub_port_connect_change(struct usb_hub *hub, int port1,
2423 u16 portstatus, u16 portchange)
2425 struct usb_device *hdev = hub->hdev;
2426 struct device *hub_dev = hub->intfdev;
2427 u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2431 "port %d, status %04x, change %04x, %s\n",
2432 port1, portstatus, portchange, portspeed (portstatus));
2434 if (hub->has_indicators) {
2435 set_port_led(hub, port1, HUB_LED_AUTO);
2436 hub->indicator[port1-1] = INDICATOR_AUTO;
2439 /* Disconnect any existing devices under this port */
2440 if (hdev->children[port1-1])
2441 usb_disconnect(&hdev->children[port1-1]);
2442 clear_bit(port1, hub->change_bits);
2444 #ifdef CONFIG_USB_OTG
2445 /* during HNP, don't repeat the debounce */
2446 if (hdev->bus->is_b_host)
2447 portchange &= ~USB_PORT_STAT_C_CONNECTION;
2450 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2451 status = hub_port_debounce(hub, port1);
2453 if (printk_ratelimit())
2454 dev_err (hub_dev, "connect-debounce failed, "
2455 "port %d disabled\n", port1);
2458 portstatus = status;
2461 /* Return now if nothing is connected */
2462 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2464 /* maybe switch power back on (e.g. root hub was reset) */
2465 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
2466 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2467 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2469 if (portstatus & USB_PORT_STAT_ENABLE)
2474 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2475 struct usb_device *udev;
2477 /* reallocate for each attempt, since references
2478 * to the previous one can escape in various ways
2480 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2483 "couldn't allocate port %d usb_device\n",
2488 usb_set_device_state(udev, USB_STATE_POWERED);
2489 udev->speed = USB_SPEED_UNKNOWN;
2490 udev->bus_mA = hub->mA_per_port;
2491 udev->level = hdev->level + 1;
2493 /* set the address */
2494 choose_address(udev);
2495 if (udev->devnum <= 0) {
2496 status = -ENOTCONN; /* Don't retry */
2500 /* reset and get descriptor */
2501 status = hub_port_init(hub, udev, port1, i);
2505 /* consecutive bus-powered hubs aren't reliable; they can
2506 * violate the voltage drop budget. if the new child has
2507 * a "powered" LED, users should notice we didn't enable it
2508 * (without reading syslog), even without per-port LEDs
2511 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
2512 && udev->bus_mA <= 100) {
2515 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2518 dev_dbg(&udev->dev, "get status %d ?\n", status);
2521 le16_to_cpus(&devstat);
2522 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2524 "can't connect bus-powered hub "
2526 if (hub->has_indicators) {
2527 hub->indicator[port1-1] =
2528 INDICATOR_AMBER_BLINK;
2529 schedule_delayed_work (&hub->leds, 0);
2531 status = -ENOTCONN; /* Don't retry */
2536 /* check for devices running slower than they could */
2537 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2538 && udev->speed == USB_SPEED_FULL
2539 && highspeed_hubs != 0)
2540 check_highspeed (hub, udev, port1);
2542 /* Store the parent's children[] pointer. At this point
2543 * udev becomes globally accessible, although presumably
2544 * no one will look at it until hdev is unlocked.
2548 /* We mustn't add new devices if the parent hub has
2549 * been disconnected; we would race with the
2550 * recursively_mark_NOTATTACHED() routine.
2552 spin_lock_irq(&device_state_lock);
2553 if (hdev->state == USB_STATE_NOTATTACHED)
2556 hdev->children[port1-1] = udev;
2557 spin_unlock_irq(&device_state_lock);
2559 /* Run it through the hoops (find a driver, etc) */
2561 status = usb_new_device(udev);
2563 spin_lock_irq(&device_state_lock);
2564 hdev->children[port1-1] = NULL;
2565 spin_unlock_irq(&device_state_lock);
2572 status = hub_power_remaining(hub);
2574 dev_dbg(hub_dev, "%dmA power budget left\n", status);
2579 hub_port_disable(hub, port1, 1);
2582 release_address(udev);
2584 if (status == -ENOTCONN)
2589 hub_port_disable(hub, port1, 1);
2592 static void hub_events(void)
2594 struct list_head *tmp;
2595 struct usb_device *hdev;
2596 struct usb_interface *intf;
2597 struct usb_hub *hub;
2598 struct device *hub_dev;
2607 * We restart the list every time to avoid a deadlock with
2608 * deleting hubs downstream from this one. This should be
2609 * safe since we delete the hub from the event list.
2610 * Not the most efficient, but avoids deadlocks.
2614 /* Grab the first entry at the beginning of the list */
2615 spin_lock_irq(&hub_event_lock);
2616 if (list_empty(&hub_event_list)) {
2617 spin_unlock_irq(&hub_event_lock);
2621 tmp = hub_event_list.next;
2624 hub = list_entry(tmp, struct usb_hub, event_list);
2625 kref_get(&hub->kref);
2626 spin_unlock_irq(&hub_event_lock);
2629 hub_dev = hub->intfdev;
2630 intf = to_usb_interface(hub_dev);
2631 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
2632 hdev->state, hub->descriptor
2633 ? hub->descriptor->bNbrPorts
2635 /* NOTE: expects max 15 ports... */
2636 (u16) hub->change_bits[0],
2637 (u16) hub->event_bits[0]);
2639 /* Lock the device, then check to see if we were
2640 * disconnected while waiting for the lock to succeed. */
2641 usb_lock_device(hdev);
2642 if (unlikely(hub->disconnected))
2645 /* If the hub has died, clean up after it */
2646 if (hdev->state == USB_STATE_NOTATTACHED) {
2647 hub->error = -ENODEV;
2648 hub_pre_reset(intf);
2653 ret = usb_autopm_get_interface(intf);
2655 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
2659 /* If this is an inactive hub, do nothing */
2664 dev_dbg (hub_dev, "resetting for error %d\n",
2667 ret = usb_reset_composite_device(hdev, intf);
2670 "error resetting hub: %d\n", ret);
2678 /* deal with port status changes */
2679 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2680 if (test_bit(i, hub->busy_bits))
2682 connect_change = test_bit(i, hub->change_bits);
2683 if (!test_and_clear_bit(i, hub->event_bits) &&
2684 !connect_change && !hub->activating)
2687 ret = hub_port_status(hub, i,
2688 &portstatus, &portchange);
2692 if (hub->activating && !hdev->children[i-1] &&
2694 USB_PORT_STAT_CONNECTION))
2697 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2698 clear_port_feature(hdev, i,
2699 USB_PORT_FEAT_C_CONNECTION);
2703 if (portchange & USB_PORT_STAT_C_ENABLE) {
2704 if (!connect_change)
2706 "port %d enable change, "
2709 clear_port_feature(hdev, i,
2710 USB_PORT_FEAT_C_ENABLE);
2713 * EM interference sometimes causes badly
2714 * shielded USB devices to be shutdown by
2715 * the hub, this hack enables them again.
2716 * Works at least with mouse driver.
2718 if (!(portstatus & USB_PORT_STAT_ENABLE)
2720 && hdev->children[i-1]) {
2723 "disabled by hub (EMI?), "
2730 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2731 clear_port_feature(hdev, i,
2732 USB_PORT_FEAT_C_SUSPEND);
2733 if (hdev->children[i-1]) {
2734 ret = remote_wakeup(hdev->
2740 hub_port_disable(hub, i, 1);
2743 "resume on port %d, status %d\n",
2747 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2749 "over-current change on port %d\n",
2751 clear_port_feature(hdev, i,
2752 USB_PORT_FEAT_C_OVER_CURRENT);
2756 if (portchange & USB_PORT_STAT_C_RESET) {
2758 "reset change on port %d\n",
2760 clear_port_feature(hdev, i,
2761 USB_PORT_FEAT_C_RESET);
2765 hub_port_connect_change(hub, i,
2766 portstatus, portchange);
2769 /* deal with hub status changes */
2770 if (test_and_clear_bit(0, hub->event_bits) == 0)
2772 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2773 dev_err (hub_dev, "get_hub_status failed\n");
2775 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2776 dev_dbg (hub_dev, "power change\n");
2777 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
2778 if (hubstatus & HUB_STATUS_LOCAL_POWER)
2779 /* FIXME: Is this always true? */
2780 hub->limited_power = 0;
2782 hub->limited_power = 1;
2784 if (hubchange & HUB_CHANGE_OVERCURRENT) {
2785 dev_dbg (hub_dev, "overcurrent change\n");
2786 msleep(500); /* Cool down */
2787 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
2792 hub->activating = 0;
2794 /* If this is a root hub, tell the HCD it's okay to
2795 * re-enable port-change interrupts now. */
2796 if (!hdev->parent && !hub->busy_bits[0])
2797 usb_enable_root_hub_irq(hdev->bus);
2800 /* Allow autosuspend if we're not going to run again */
2801 if (list_empty(&hub->event_list))
2802 usb_autopm_enable(intf);
2804 usb_unlock_device(hdev);
2805 kref_put(&hub->kref, hub_release);
2807 } /* end while (1) */
2810 static int hub_thread(void *__unused)
2814 wait_event_interruptible(khubd_wait,
2815 !list_empty(&hub_event_list) ||
2816 kthread_should_stop());
2818 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
2820 pr_debug("%s: khubd exiting\n", usbcore_name);
2824 static struct usb_device_id hub_id_table [] = {
2825 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
2826 .bDeviceClass = USB_CLASS_HUB},
2827 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2828 .bInterfaceClass = USB_CLASS_HUB},
2829 { } /* Terminating entry */
2832 MODULE_DEVICE_TABLE (usb, hub_id_table);
2834 static struct usb_driver hub_driver = {
2837 .disconnect = hub_disconnect,
2838 .suspend = hub_suspend,
2839 .resume = hub_resume,
2840 .pre_reset = hub_pre_reset,
2841 .post_reset = hub_post_reset,
2843 .id_table = hub_id_table,
2844 .supports_autosuspend = 1,
2847 int usb_hub_init(void)
2849 if (usb_register(&hub_driver) < 0) {
2850 printk(KERN_ERR "%s: can't register hub driver\n",
2855 khubd_task = kthread_run(hub_thread, NULL, "khubd");
2856 if (!IS_ERR(khubd_task))
2859 /* Fall through if kernel_thread failed */
2860 usb_deregister(&hub_driver);
2861 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
2866 void usb_hub_cleanup(void)
2868 kthread_stop(khubd_task);
2871 * Hub resources are freed for us by usb_deregister. It calls
2872 * usb_driver_purge on every device which in turn calls that
2873 * devices disconnect function if it is using this driver.
2874 * The hub_disconnect function takes care of releasing the
2875 * individual hub resources. -greg
2877 usb_deregister(&hub_driver);
2878 } /* usb_hub_cleanup() */
2880 static int config_descriptors_changed(struct usb_device *udev)
2884 struct usb_config_descriptor *buf;
2886 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2887 if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
2888 len = le16_to_cpu(udev->config[index].desc.wTotalLength);
2890 buf = kmalloc (len, GFP_KERNEL);
2892 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
2893 /* assume the worst */
2896 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2898 int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
2900 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
2902 if (length < old_length) {
2903 dev_dbg(&udev->dev, "config index %d, error %d\n",
2907 if (memcmp (buf, udev->rawdescriptors[index], old_length)
2909 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
2910 index, buf->bConfigurationValue);
2915 return index != udev->descriptor.bNumConfigurations;
2919 * usb_reset_device - perform a USB port reset to reinitialize a device
2920 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2922 * WARNING - don't use this routine to reset a composite device
2923 * (one with multiple interfaces owned by separate drivers)!
2924 * Use usb_reset_composite_device() instead.
2926 * Do a port reset, reassign the device's address, and establish its
2927 * former operating configuration. If the reset fails, or the device's
2928 * descriptors change from their values before the reset, or the original
2929 * configuration and altsettings cannot be restored, a flag will be set
2930 * telling khubd to pretend the device has been disconnected and then
2931 * re-connected. All drivers will be unbound, and the device will be
2932 * re-enumerated and probed all over again.
2934 * Returns 0 if the reset succeeded, -ENODEV if the device has been
2935 * flagged for logical disconnection, or some other negative error code
2936 * if the reset wasn't even attempted.
2938 * The caller must own the device lock. For example, it's safe to use
2939 * this from a driver probe() routine after downloading new firmware.
2940 * For calls that might not occur during probe(), drivers should lock
2941 * the device using usb_lock_device_for_reset().
2943 int usb_reset_device(struct usb_device *udev)
2945 struct usb_device *parent_hdev = udev->parent;
2946 struct usb_hub *parent_hub;
2947 struct usb_device_descriptor descriptor = udev->descriptor;
2949 int port1 = udev->portnum;
2951 if (udev->state == USB_STATE_NOTATTACHED ||
2952 udev->state == USB_STATE_SUSPENDED) {
2953 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
2959 /* this requires hcd-specific logic; see OHCI hc_restart() */
2960 dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
2963 parent_hub = hdev_to_hub(parent_hdev);
2965 set_bit(port1, parent_hub->busy_bits);
2966 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
2968 /* ep0 maxpacket size may change; let the HCD know about it.
2969 * Other endpoints will be handled by re-enumeration. */
2971 ret = hub_port_init(parent_hub, udev, port1, i);
2975 clear_bit(port1, parent_hub->busy_bits);
2976 if (!parent_hdev->parent && !parent_hub->busy_bits[0])
2977 usb_enable_root_hub_irq(parent_hdev->bus);
2982 /* Device might have changed firmware (DFU or similar) */
2983 if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
2984 || config_descriptors_changed (udev)) {
2985 dev_info(&udev->dev, "device firmware changed\n");
2986 udev->descriptor = descriptor; /* for disconnect() calls */
2990 if (!udev->actconfig)
2993 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2994 USB_REQ_SET_CONFIGURATION, 0,
2995 udev->actconfig->desc.bConfigurationValue, 0,
2996 NULL, 0, USB_CTRL_SET_TIMEOUT);
2999 "can't restore configuration #%d (error=%d)\n",
3000 udev->actconfig->desc.bConfigurationValue, ret);
3003 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3005 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3006 struct usb_interface *intf = udev->actconfig->interface[i];
3007 struct usb_interface_descriptor *desc;
3009 /* set_interface resets host side toggle even
3010 * for altsetting zero. the interface may have no driver.
3012 desc = &intf->cur_altsetting->desc;
3013 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3014 desc->bAlternateSetting);
3016 dev_err(&udev->dev, "failed to restore interface %d "
3017 "altsetting %d (error=%d)\n",
3018 desc->bInterfaceNumber,
3019 desc->bAlternateSetting,
3029 hub_port_logical_disconnect(parent_hub, port1);
3032 EXPORT_SYMBOL(usb_reset_device);
3035 * usb_reset_composite_device - warn interface drivers and perform a USB port reset
3036 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3037 * @iface: interface bound to the driver making the request (optional)
3039 * Warns all drivers bound to registered interfaces (using their pre_reset
3040 * method), performs the port reset, and then lets the drivers know that
3041 * the reset is over (using their post_reset method).
3043 * Return value is the same as for usb_reset_device().
3045 * The caller must own the device lock. For example, it's safe to use
3046 * this from a driver probe() routine after downloading new firmware.
3047 * For calls that might not occur during probe(), drivers should lock
3048 * the device using usb_lock_device_for_reset().
3050 * The interface locks are acquired during the pre_reset stage and released
3051 * during the post_reset stage. However if iface is not NULL and is
3052 * currently being probed, we assume that the caller already owns its
3055 int usb_reset_composite_device(struct usb_device *udev,
3056 struct usb_interface *iface)
3059 struct usb_host_config *config = udev->actconfig;
3061 if (udev->state == USB_STATE_NOTATTACHED ||
3062 udev->state == USB_STATE_SUSPENDED) {
3063 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3068 /* Prevent autosuspend during the reset */
3069 usb_autoresume_device(udev);
3071 if (iface && iface->condition != USB_INTERFACE_BINDING)
3076 struct usb_interface *cintf;
3077 struct usb_driver *drv;
3079 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
3080 cintf = config->interface[i];
3082 down(&cintf->dev.sem);
3083 if (device_is_registered(&cintf->dev) &&
3084 cintf->dev.driver) {
3085 drv = to_usb_driver(cintf->dev.driver);
3087 (drv->pre_reset)(cintf);
3092 ret = usb_reset_device(udev);
3096 struct usb_interface *cintf;
3097 struct usb_driver *drv;
3099 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
3100 cintf = config->interface[i];
3101 if (device_is_registered(&cintf->dev) &&
3102 cintf->dev.driver) {
3103 drv = to_usb_driver(cintf->dev.driver);
3104 if (drv->post_reset)
3105 (drv->post_reset)(cintf, 0);
3108 up(&cintf->dev.sem);
3112 usb_autosuspend_device(udev);
3115 EXPORT_SYMBOL(usb_reset_composite_device);