V4L/DVB (6715): ivtv: Remove unnecessary register update
[linux-2.6/verdex.git] / drivers / usb / core / hub.c
blobb04d232d4c6561720f219ff506fcd2a35a9c0caf
1 /*
2 * USB hub driver.
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)
9 */
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>
30 #include "usb.h"
31 #include "hcd.h"
32 #include "hub.h"
34 #ifdef CONFIG_USB_PERSIST
35 #define USB_PERSIST 1
36 #else
37 #define USB_PERSIST 0
38 #endif
40 struct usb_hub {
41 struct device *intfdev; /* the "interface" device */
42 struct usb_device *hdev;
43 struct kref kref;
44 struct urb *urb; /* for interrupt polling pipe */
46 /* buffer for urb ... with extra space in case of babble */
47 char (*buffer)[8];
48 dma_addr_t buffer_dma; /* DMA address for buffer */
49 union {
50 struct usb_hub_status hub;
51 struct usb_port_status port;
52 } *status; /* buffer for status reports */
53 struct mutex status_mutex; /* for the status buffer */
55 int error; /* last reported error */
56 int nerrors; /* track consecutive errors */
58 struct list_head event_list; /* hubs w/data or errs ready */
59 unsigned long event_bits[1]; /* status change bitmask */
60 unsigned long change_bits[1]; /* ports with logical connect
61 status change */
62 unsigned long busy_bits[1]; /* ports being reset or
63 resumed */
64 #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
65 #error event_bits[] is too short!
66 #endif
68 struct usb_hub_descriptor *descriptor; /* class descriptor */
69 struct usb_tt tt; /* Transaction Translator */
71 unsigned mA_per_port; /* current for each child */
73 unsigned limited_power:1;
74 unsigned quiescing:1;
75 unsigned activating:1;
76 unsigned disconnected:1;
78 unsigned has_indicators:1;
79 u8 indicator[USB_MAXCHILDREN];
80 struct delayed_work leds;
84 /* Protect struct usb_device->state and ->children members
85 * Note: Both are also protected by ->dev.sem, except that ->state can
86 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
87 static DEFINE_SPINLOCK(device_state_lock);
89 /* khubd's worklist and its lock */
90 static DEFINE_SPINLOCK(hub_event_lock);
91 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
93 /* Wakes up khubd */
94 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
96 static struct task_struct *khubd_task;
98 /* cycle leds on hubs that aren't blinking for attention */
99 static int blinkenlights = 0;
100 module_param (blinkenlights, bool, S_IRUGO);
101 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
104 * As of 2.6.10 we introduce a new USB device initialization scheme which
105 * closely resembles the way Windows works. Hopefully it will be compatible
106 * with a wider range of devices than the old scheme. However some previously
107 * working devices may start giving rise to "device not accepting address"
108 * errors; if that happens the user can try the old scheme by adjusting the
109 * following module parameters.
111 * For maximum flexibility there are two boolean parameters to control the
112 * hub driver's behavior. On the first initialization attempt, if the
113 * "old_scheme_first" parameter is set then the old scheme will be used,
114 * otherwise the new scheme is used. If that fails and "use_both_schemes"
115 * is set, then the driver will make another attempt, using the other scheme.
117 static int old_scheme_first = 0;
118 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
119 MODULE_PARM_DESC(old_scheme_first,
120 "start with the old device initialization scheme");
122 static int use_both_schemes = 1;
123 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
124 MODULE_PARM_DESC(use_both_schemes,
125 "try the other device initialization scheme if the "
126 "first one fails");
128 /* Mutual exclusion for EHCI CF initialization. This interferes with
129 * port reset on some companion controllers.
131 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
132 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
135 static inline char *portspeed(int portstatus)
137 if (portstatus & (1 << USB_PORT_FEAT_HIGHSPEED))
138 return "480 Mb/s";
139 else if (portstatus & (1 << USB_PORT_FEAT_LOWSPEED))
140 return "1.5 Mb/s";
141 else
142 return "12 Mb/s";
145 /* Note that hdev or one of its children must be locked! */
146 static inline struct usb_hub *hdev_to_hub(struct usb_device *hdev)
148 return usb_get_intfdata(hdev->actconfig->interface[0]);
151 /* USB 2.0 spec Section 11.24.4.5 */
152 static int get_hub_descriptor(struct usb_device *hdev, void *data, int size)
154 int i, ret;
156 for (i = 0; i < 3; i++) {
157 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
158 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
159 USB_DT_HUB << 8, 0, data, size,
160 USB_CTRL_GET_TIMEOUT);
161 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
162 return ret;
164 return -EINVAL;
168 * USB 2.0 spec Section 11.24.2.1
170 static int clear_hub_feature(struct usb_device *hdev, int feature)
172 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
173 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
177 * USB 2.0 spec Section 11.24.2.2
179 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
181 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
182 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
183 NULL, 0, 1000);
187 * USB 2.0 spec Section 11.24.2.13
189 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
191 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
192 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
193 NULL, 0, 1000);
197 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
198 * for info about using port indicators
200 static void set_port_led(
201 struct usb_hub *hub,
202 int port1,
203 int selector
206 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
207 USB_PORT_FEAT_INDICATOR);
208 if (status < 0)
209 dev_dbg (hub->intfdev,
210 "port %d indicator %s status %d\n",
211 port1,
212 ({ char *s; switch (selector) {
213 case HUB_LED_AMBER: s = "amber"; break;
214 case HUB_LED_GREEN: s = "green"; break;
215 case HUB_LED_OFF: s = "off"; break;
216 case HUB_LED_AUTO: s = "auto"; break;
217 default: s = "??"; break;
218 }; s; }),
219 status);
222 #define LED_CYCLE_PERIOD ((2*HZ)/3)
224 static void led_work (struct work_struct *work)
226 struct usb_hub *hub =
227 container_of(work, struct usb_hub, leds.work);
228 struct usb_device *hdev = hub->hdev;
229 unsigned i;
230 unsigned changed = 0;
231 int cursor = -1;
233 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
234 return;
236 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
237 unsigned selector, mode;
239 /* 30%-50% duty cycle */
241 switch (hub->indicator[i]) {
242 /* cycle marker */
243 case INDICATOR_CYCLE:
244 cursor = i;
245 selector = HUB_LED_AUTO;
246 mode = INDICATOR_AUTO;
247 break;
248 /* blinking green = sw attention */
249 case INDICATOR_GREEN_BLINK:
250 selector = HUB_LED_GREEN;
251 mode = INDICATOR_GREEN_BLINK_OFF;
252 break;
253 case INDICATOR_GREEN_BLINK_OFF:
254 selector = HUB_LED_OFF;
255 mode = INDICATOR_GREEN_BLINK;
256 break;
257 /* blinking amber = hw attention */
258 case INDICATOR_AMBER_BLINK:
259 selector = HUB_LED_AMBER;
260 mode = INDICATOR_AMBER_BLINK_OFF;
261 break;
262 case INDICATOR_AMBER_BLINK_OFF:
263 selector = HUB_LED_OFF;
264 mode = INDICATOR_AMBER_BLINK;
265 break;
266 /* blink green/amber = reserved */
267 case INDICATOR_ALT_BLINK:
268 selector = HUB_LED_GREEN;
269 mode = INDICATOR_ALT_BLINK_OFF;
270 break;
271 case INDICATOR_ALT_BLINK_OFF:
272 selector = HUB_LED_AMBER;
273 mode = INDICATOR_ALT_BLINK;
274 break;
275 default:
276 continue;
278 if (selector != HUB_LED_AUTO)
279 changed = 1;
280 set_port_led(hub, i + 1, selector);
281 hub->indicator[i] = mode;
283 if (!changed && blinkenlights) {
284 cursor++;
285 cursor %= hub->descriptor->bNbrPorts;
286 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
287 hub->indicator[cursor] = INDICATOR_CYCLE;
288 changed++;
290 if (changed)
291 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
294 /* use a short timeout for hub/port status fetches */
295 #define USB_STS_TIMEOUT 1000
296 #define USB_STS_RETRIES 5
299 * USB 2.0 spec Section 11.24.2.6
301 static int get_hub_status(struct usb_device *hdev,
302 struct usb_hub_status *data)
304 int i, status = -ETIMEDOUT;
306 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
307 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
308 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
309 data, sizeof(*data), USB_STS_TIMEOUT);
311 return status;
315 * USB 2.0 spec Section 11.24.2.7
317 static int get_port_status(struct usb_device *hdev, int port1,
318 struct usb_port_status *data)
320 int i, status = -ETIMEDOUT;
322 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
323 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
324 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
325 data, sizeof(*data), USB_STS_TIMEOUT);
327 return status;
330 static void kick_khubd(struct usb_hub *hub)
332 unsigned long flags;
334 /* Suppress autosuspend until khubd runs */
335 to_usb_interface(hub->intfdev)->pm_usage_cnt = 1;
337 spin_lock_irqsave(&hub_event_lock, flags);
338 if (!hub->disconnected && list_empty(&hub->event_list)) {
339 list_add_tail(&hub->event_list, &hub_event_list);
340 wake_up(&khubd_wait);
342 spin_unlock_irqrestore(&hub_event_lock, flags);
345 void usb_kick_khubd(struct usb_device *hdev)
347 /* FIXME: What if hdev isn't bound to the hub driver? */
348 kick_khubd(hdev_to_hub(hdev));
352 /* completion function, fires on port status changes and various faults */
353 static void hub_irq(struct urb *urb)
355 struct usb_hub *hub = urb->context;
356 int status = urb->status;
357 int i;
358 unsigned long bits;
360 switch (status) {
361 case -ENOENT: /* synchronous unlink */
362 case -ECONNRESET: /* async unlink */
363 case -ESHUTDOWN: /* hardware going away */
364 return;
366 default: /* presumably an error */
367 /* Cause a hub reset after 10 consecutive errors */
368 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
369 if ((++hub->nerrors < 10) || hub->error)
370 goto resubmit;
371 hub->error = status;
372 /* FALL THROUGH */
374 /* let khubd handle things */
375 case 0: /* we got data: port status changed */
376 bits = 0;
377 for (i = 0; i < urb->actual_length; ++i)
378 bits |= ((unsigned long) ((*hub->buffer)[i]))
379 << (i*8);
380 hub->event_bits[0] = bits;
381 break;
384 hub->nerrors = 0;
386 /* Something happened, let khubd figure it out */
387 kick_khubd(hub);
389 resubmit:
390 if (hub->quiescing)
391 return;
393 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
394 && status != -ENODEV && status != -EPERM)
395 dev_err (hub->intfdev, "resubmit --> %d\n", status);
398 /* USB 2.0 spec Section 11.24.2.3 */
399 static inline int
400 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
402 return usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
403 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
404 tt, NULL, 0, 1000);
408 * enumeration blocks khubd for a long time. we use keventd instead, since
409 * long blocking there is the exception, not the rule. accordingly, HCDs
410 * talking to TTs must queue control transfers (not just bulk and iso), so
411 * both can talk to the same hub concurrently.
413 static void hub_tt_kevent (struct work_struct *work)
415 struct usb_hub *hub =
416 container_of(work, struct usb_hub, tt.kevent);
417 unsigned long flags;
418 int limit = 100;
420 spin_lock_irqsave (&hub->tt.lock, flags);
421 while (--limit && !list_empty (&hub->tt.clear_list)) {
422 struct list_head *temp;
423 struct usb_tt_clear *clear;
424 struct usb_device *hdev = hub->hdev;
425 int status;
427 temp = hub->tt.clear_list.next;
428 clear = list_entry (temp, struct usb_tt_clear, clear_list);
429 list_del (&clear->clear_list);
431 /* drop lock so HCD can concurrently report other TT errors */
432 spin_unlock_irqrestore (&hub->tt.lock, flags);
433 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
434 spin_lock_irqsave (&hub->tt.lock, flags);
436 if (status)
437 dev_err (&hdev->dev,
438 "clear tt %d (%04x) error %d\n",
439 clear->tt, clear->devinfo, status);
440 kfree(clear);
442 spin_unlock_irqrestore (&hub->tt.lock, flags);
446 * usb_hub_tt_clear_buffer - clear control/bulk TT state in high speed hub
447 * @udev: the device whose split transaction failed
448 * @pipe: identifies the endpoint of the failed transaction
450 * High speed HCDs use this to tell the hub driver that some split control or
451 * bulk transaction failed in a way that requires clearing internal state of
452 * a transaction translator. This is normally detected (and reported) from
453 * interrupt context.
455 * It may not be possible for that hub to handle additional full (or low)
456 * speed transactions until that state is fully cleared out.
458 void usb_hub_tt_clear_buffer (struct usb_device *udev, int pipe)
460 struct usb_tt *tt = udev->tt;
461 unsigned long flags;
462 struct usb_tt_clear *clear;
464 /* we've got to cope with an arbitrary number of pending TT clears,
465 * since each TT has "at least two" buffers that can need it (and
466 * there can be many TTs per hub). even if they're uncommon.
468 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
469 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
470 /* FIXME recover somehow ... RESET_TT? */
471 return;
474 /* info that CLEAR_TT_BUFFER needs */
475 clear->tt = tt->multi ? udev->ttport : 1;
476 clear->devinfo = usb_pipeendpoint (pipe);
477 clear->devinfo |= udev->devnum << 4;
478 clear->devinfo |= usb_pipecontrol (pipe)
479 ? (USB_ENDPOINT_XFER_CONTROL << 11)
480 : (USB_ENDPOINT_XFER_BULK << 11);
481 if (usb_pipein (pipe))
482 clear->devinfo |= 1 << 15;
484 /* tell keventd to clear state for this TT */
485 spin_lock_irqsave (&tt->lock, flags);
486 list_add_tail (&clear->clear_list, &tt->clear_list);
487 schedule_work (&tt->kevent);
488 spin_unlock_irqrestore (&tt->lock, flags);
491 static void hub_power_on(struct usb_hub *hub)
493 int port1;
494 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
495 u16 wHubCharacteristics =
496 le16_to_cpu(hub->descriptor->wHubCharacteristics);
498 /* Enable power on each port. Some hubs have reserved values
499 * of LPSM (> 2) in their descriptors, even though they are
500 * USB 2.0 hubs. Some hubs do not implement port-power switching
501 * but only emulate it. In all cases, the ports won't work
502 * unless we send these messages to the hub.
504 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
505 dev_dbg(hub->intfdev, "enabling power on all ports\n");
506 else
507 dev_dbg(hub->intfdev, "trying to enable port power on "
508 "non-switchable hub\n");
509 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
510 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
512 /* Wait at least 100 msec for power to become stable */
513 msleep(max(pgood_delay, (unsigned) 100));
516 static void hub_quiesce(struct usb_hub *hub)
518 /* (nonblocking) khubd and related activity won't re-trigger */
519 hub->quiescing = 1;
520 hub->activating = 0;
522 /* (blocking) stop khubd and related activity */
523 usb_kill_urb(hub->urb);
524 if (hub->has_indicators)
525 cancel_delayed_work_sync(&hub->leds);
526 if (hub->tt.hub)
527 cancel_work_sync(&hub->tt.kevent);
530 static void hub_activate(struct usb_hub *hub)
532 int status;
534 hub->quiescing = 0;
535 hub->activating = 1;
537 status = usb_submit_urb(hub->urb, GFP_NOIO);
538 if (status < 0)
539 dev_err(hub->intfdev, "activate --> %d\n", status);
540 if (hub->has_indicators && blinkenlights)
541 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
543 /* scan all ports ASAP */
544 kick_khubd(hub);
547 static int hub_hub_status(struct usb_hub *hub,
548 u16 *status, u16 *change)
550 int ret;
552 mutex_lock(&hub->status_mutex);
553 ret = get_hub_status(hub->hdev, &hub->status->hub);
554 if (ret < 0)
555 dev_err (hub->intfdev,
556 "%s failed (err = %d)\n", __FUNCTION__, ret);
557 else {
558 *status = le16_to_cpu(hub->status->hub.wHubStatus);
559 *change = le16_to_cpu(hub->status->hub.wHubChange);
560 ret = 0;
562 mutex_unlock(&hub->status_mutex);
563 return ret;
566 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
568 struct usb_device *hdev = hub->hdev;
569 int ret = 0;
571 if (hdev->children[port1-1] && set_state)
572 usb_set_device_state(hdev->children[port1-1],
573 USB_STATE_NOTATTACHED);
574 if (!hub->error)
575 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
576 if (ret)
577 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
578 port1, ret);
579 return ret;
583 * Disable a port and mark a logical connnect-change event, so that some
584 * time later khubd will disconnect() any existing usb_device on the port
585 * and will re-enumerate if there actually is a device attached.
587 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
589 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
590 hub_port_disable(hub, port1, 1);
592 /* FIXME let caller ask to power down the port:
593 * - some devices won't enumerate without a VBUS power cycle
594 * - SRP saves power that way
595 * - ... new call, TBD ...
596 * That's easy if this hub can switch power per-port, and
597 * khubd reactivates the port later (timer, SRP, etc).
598 * Powerdown must be optional, because of reset/DFU.
601 set_bit(port1, hub->change_bits);
602 kick_khubd(hub);
605 /* caller has locked the hub device */
606 static int hub_pre_reset(struct usb_interface *intf)
608 struct usb_hub *hub = usb_get_intfdata(intf);
609 struct usb_device *hdev = hub->hdev;
610 int i;
612 /* Disconnect all the children */
613 for (i = 0; i < hdev->maxchild; ++i) {
614 if (hdev->children[i])
615 usb_disconnect(&hdev->children[i]);
617 hub_quiesce(hub);
618 return 0;
621 /* caller has locked the hub device */
622 static int hub_post_reset(struct usb_interface *intf)
624 struct usb_hub *hub = usb_get_intfdata(intf);
626 hub_power_on(hub);
627 hub_activate(hub);
628 return 0;
631 static int hub_configure(struct usb_hub *hub,
632 struct usb_endpoint_descriptor *endpoint)
634 struct usb_device *hdev = hub->hdev;
635 struct device *hub_dev = hub->intfdev;
636 u16 hubstatus, hubchange;
637 u16 wHubCharacteristics;
638 unsigned int pipe;
639 int maxp, ret;
640 char *message;
642 hub->buffer = usb_buffer_alloc(hdev, sizeof(*hub->buffer), GFP_KERNEL,
643 &hub->buffer_dma);
644 if (!hub->buffer) {
645 message = "can't allocate hub irq buffer";
646 ret = -ENOMEM;
647 goto fail;
650 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
651 if (!hub->status) {
652 message = "can't kmalloc hub status buffer";
653 ret = -ENOMEM;
654 goto fail;
656 mutex_init(&hub->status_mutex);
658 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
659 if (!hub->descriptor) {
660 message = "can't kmalloc hub descriptor";
661 ret = -ENOMEM;
662 goto fail;
665 /* Request the entire hub descriptor.
666 * hub->descriptor can handle USB_MAXCHILDREN ports,
667 * but the hub can/will return fewer bytes here.
669 ret = get_hub_descriptor(hdev, hub->descriptor,
670 sizeof(*hub->descriptor));
671 if (ret < 0) {
672 message = "can't read hub descriptor";
673 goto fail;
674 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
675 message = "hub has too many ports!";
676 ret = -ENODEV;
677 goto fail;
680 hdev->maxchild = hub->descriptor->bNbrPorts;
681 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
682 (hdev->maxchild == 1) ? "" : "s");
684 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
686 if (wHubCharacteristics & HUB_CHAR_COMPOUND) {
687 int i;
688 char portstr [USB_MAXCHILDREN + 1];
690 for (i = 0; i < hdev->maxchild; i++)
691 portstr[i] = hub->descriptor->DeviceRemovable
692 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
693 ? 'F' : 'R';
694 portstr[hdev->maxchild] = 0;
695 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
696 } else
697 dev_dbg(hub_dev, "standalone hub\n");
699 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
700 case 0x00:
701 dev_dbg(hub_dev, "ganged power switching\n");
702 break;
703 case 0x01:
704 dev_dbg(hub_dev, "individual port power switching\n");
705 break;
706 case 0x02:
707 case 0x03:
708 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
709 break;
712 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
713 case 0x00:
714 dev_dbg(hub_dev, "global over-current protection\n");
715 break;
716 case 0x08:
717 dev_dbg(hub_dev, "individual port over-current protection\n");
718 break;
719 case 0x10:
720 case 0x18:
721 dev_dbg(hub_dev, "no over-current protection\n");
722 break;
725 spin_lock_init (&hub->tt.lock);
726 INIT_LIST_HEAD (&hub->tt.clear_list);
727 INIT_WORK (&hub->tt.kevent, hub_tt_kevent);
728 switch (hdev->descriptor.bDeviceProtocol) {
729 case 0:
730 break;
731 case 1:
732 dev_dbg(hub_dev, "Single TT\n");
733 hub->tt.hub = hdev;
734 break;
735 case 2:
736 ret = usb_set_interface(hdev, 0, 1);
737 if (ret == 0) {
738 dev_dbg(hub_dev, "TT per port\n");
739 hub->tt.multi = 1;
740 } else
741 dev_err(hub_dev, "Using single TT (err %d)\n",
742 ret);
743 hub->tt.hub = hdev;
744 break;
745 default:
746 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
747 hdev->descriptor.bDeviceProtocol);
748 break;
751 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
752 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
753 case HUB_TTTT_8_BITS:
754 if (hdev->descriptor.bDeviceProtocol != 0) {
755 hub->tt.think_time = 666;
756 dev_dbg(hub_dev, "TT requires at most %d "
757 "FS bit times (%d ns)\n",
758 8, hub->tt.think_time);
760 break;
761 case HUB_TTTT_16_BITS:
762 hub->tt.think_time = 666 * 2;
763 dev_dbg(hub_dev, "TT requires at most %d "
764 "FS bit times (%d ns)\n",
765 16, hub->tt.think_time);
766 break;
767 case HUB_TTTT_24_BITS:
768 hub->tt.think_time = 666 * 3;
769 dev_dbg(hub_dev, "TT requires at most %d "
770 "FS bit times (%d ns)\n",
771 24, hub->tt.think_time);
772 break;
773 case HUB_TTTT_32_BITS:
774 hub->tt.think_time = 666 * 4;
775 dev_dbg(hub_dev, "TT requires at most %d "
776 "FS bit times (%d ns)\n",
777 32, hub->tt.think_time);
778 break;
781 /* probe() zeroes hub->indicator[] */
782 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
783 hub->has_indicators = 1;
784 dev_dbg(hub_dev, "Port indicators are supported\n");
787 dev_dbg(hub_dev, "power on to power good time: %dms\n",
788 hub->descriptor->bPwrOn2PwrGood * 2);
790 /* power budgeting mostly matters with bus-powered hubs,
791 * and battery-powered root hubs (may provide just 8 mA).
793 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
794 if (ret < 2) {
795 message = "can't get hub status";
796 goto fail;
798 le16_to_cpus(&hubstatus);
799 if (hdev == hdev->bus->root_hub) {
800 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
801 hub->mA_per_port = 500;
802 else {
803 hub->mA_per_port = hdev->bus_mA;
804 hub->limited_power = 1;
806 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
807 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
808 hub->descriptor->bHubContrCurrent);
809 hub->limited_power = 1;
810 if (hdev->maxchild > 0) {
811 int remaining = hdev->bus_mA -
812 hub->descriptor->bHubContrCurrent;
814 if (remaining < hdev->maxchild * 100)
815 dev_warn(hub_dev,
816 "insufficient power available "
817 "to use all downstream ports\n");
818 hub->mA_per_port = 100; /* 7.2.1.1 */
820 } else { /* Self-powered external hub */
821 /* FIXME: What about battery-powered external hubs that
822 * provide less current per port? */
823 hub->mA_per_port = 500;
825 if (hub->mA_per_port < 500)
826 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
827 hub->mA_per_port);
829 ret = hub_hub_status(hub, &hubstatus, &hubchange);
830 if (ret < 0) {
831 message = "can't get hub status";
832 goto fail;
835 /* local power status reports aren't always correct */
836 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
837 dev_dbg(hub_dev, "local power source is %s\n",
838 (hubstatus & HUB_STATUS_LOCAL_POWER)
839 ? "lost (inactive)" : "good");
841 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
842 dev_dbg(hub_dev, "%sover-current condition exists\n",
843 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
845 /* set up the interrupt endpoint
846 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
847 * bytes as USB2.0[11.12.3] says because some hubs are known
848 * to send more data (and thus cause overflow). For root hubs,
849 * maxpktsize is defined in hcd.c's fake endpoint descriptors
850 * to be big enough for at least USB_MAXCHILDREN ports. */
851 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
852 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
854 if (maxp > sizeof(*hub->buffer))
855 maxp = sizeof(*hub->buffer);
857 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
858 if (!hub->urb) {
859 message = "couldn't allocate interrupt urb";
860 ret = -ENOMEM;
861 goto fail;
864 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
865 hub, endpoint->bInterval);
866 hub->urb->transfer_dma = hub->buffer_dma;
867 hub->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
869 /* maybe cycle the hub leds */
870 if (hub->has_indicators && blinkenlights)
871 hub->indicator [0] = INDICATOR_CYCLE;
873 hub_power_on(hub);
874 hub_activate(hub);
875 return 0;
877 fail:
878 dev_err (hub_dev, "config failed, %s (err %d)\n",
879 message, ret);
880 /* hub_disconnect() frees urb and descriptor */
881 return ret;
884 static void hub_release(struct kref *kref)
886 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
888 usb_put_intf(to_usb_interface(hub->intfdev));
889 kfree(hub);
892 static unsigned highspeed_hubs;
894 static void hub_disconnect(struct usb_interface *intf)
896 struct usb_hub *hub = usb_get_intfdata (intf);
898 /* Take the hub off the event list and don't let it be added again */
899 spin_lock_irq(&hub_event_lock);
900 list_del_init(&hub->event_list);
901 hub->disconnected = 1;
902 spin_unlock_irq(&hub_event_lock);
904 /* Disconnect all children and quiesce the hub */
905 hub->error = 0;
906 hub_pre_reset(intf);
908 usb_set_intfdata (intf, NULL);
910 if (hub->hdev->speed == USB_SPEED_HIGH)
911 highspeed_hubs--;
913 usb_free_urb(hub->urb);
914 kfree(hub->descriptor);
915 kfree(hub->status);
916 usb_buffer_free(hub->hdev, sizeof(*hub->buffer), hub->buffer,
917 hub->buffer_dma);
919 kref_put(&hub->kref, hub_release);
922 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
924 struct usb_host_interface *desc;
925 struct usb_endpoint_descriptor *endpoint;
926 struct usb_device *hdev;
927 struct usb_hub *hub;
929 desc = intf->cur_altsetting;
930 hdev = interface_to_usbdev(intf);
932 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
933 if (hdev->parent) {
934 dev_warn(&intf->dev, "ignoring external hub\n");
935 return -ENODEV;
937 #endif
939 /* Some hubs have a subclass of 1, which AFAICT according to the */
940 /* specs is not defined, but it works */
941 if ((desc->desc.bInterfaceSubClass != 0) &&
942 (desc->desc.bInterfaceSubClass != 1)) {
943 descriptor_error:
944 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
945 return -EIO;
948 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
949 if (desc->desc.bNumEndpoints != 1)
950 goto descriptor_error;
952 endpoint = &desc->endpoint[0].desc;
954 /* If it's not an interrupt in endpoint, we'd better punt! */
955 if (!usb_endpoint_is_int_in(endpoint))
956 goto descriptor_error;
958 /* We found a hub */
959 dev_info (&intf->dev, "USB hub found\n");
961 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
962 if (!hub) {
963 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
964 return -ENOMEM;
967 kref_init(&hub->kref);
968 INIT_LIST_HEAD(&hub->event_list);
969 hub->intfdev = &intf->dev;
970 hub->hdev = hdev;
971 INIT_DELAYED_WORK(&hub->leds, led_work);
972 usb_get_intf(intf);
974 usb_set_intfdata (intf, hub);
975 intf->needs_remote_wakeup = 1;
977 if (hdev->speed == USB_SPEED_HIGH)
978 highspeed_hubs++;
980 if (hub_configure(hub, endpoint) >= 0)
981 return 0;
983 hub_disconnect (intf);
984 return -ENODEV;
987 static int
988 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
990 struct usb_device *hdev = interface_to_usbdev (intf);
992 /* assert ifno == 0 (part of hub spec) */
993 switch (code) {
994 case USBDEVFS_HUB_PORTINFO: {
995 struct usbdevfs_hub_portinfo *info = user_data;
996 int i;
998 spin_lock_irq(&device_state_lock);
999 if (hdev->devnum <= 0)
1000 info->nports = 0;
1001 else {
1002 info->nports = hdev->maxchild;
1003 for (i = 0; i < info->nports; i++) {
1004 if (hdev->children[i] == NULL)
1005 info->port[i] = 0;
1006 else
1007 info->port[i] =
1008 hdev->children[i]->devnum;
1011 spin_unlock_irq(&device_state_lock);
1013 return info->nports + 1;
1016 default:
1017 return -ENOSYS;
1022 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1024 int i;
1026 for (i = 0; i < udev->maxchild; ++i) {
1027 if (udev->children[i])
1028 recursively_mark_NOTATTACHED(udev->children[i]);
1030 if (udev->state == USB_STATE_SUSPENDED)
1031 udev->discon_suspended = 1;
1032 udev->state = USB_STATE_NOTATTACHED;
1036 * usb_set_device_state - change a device's current state (usbcore, hcds)
1037 * @udev: pointer to device whose state should be changed
1038 * @new_state: new state value to be stored
1040 * udev->state is _not_ fully protected by the device lock. Although
1041 * most transitions are made only while holding the lock, the state can
1042 * can change to USB_STATE_NOTATTACHED at almost any time. This
1043 * is so that devices can be marked as disconnected as soon as possible,
1044 * without having to wait for any semaphores to be released. As a result,
1045 * all changes to any device's state must be protected by the
1046 * device_state_lock spinlock.
1048 * Once a device has been added to the device tree, all changes to its state
1049 * should be made using this routine. The state should _not_ be set directly.
1051 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1052 * Otherwise udev->state is set to new_state, and if new_state is
1053 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1054 * to USB_STATE_NOTATTACHED.
1056 void usb_set_device_state(struct usb_device *udev,
1057 enum usb_device_state new_state)
1059 unsigned long flags;
1061 spin_lock_irqsave(&device_state_lock, flags);
1062 if (udev->state == USB_STATE_NOTATTACHED)
1063 ; /* do nothing */
1064 else if (new_state != USB_STATE_NOTATTACHED) {
1066 /* root hub wakeup capabilities are managed out-of-band
1067 * and may involve silicon errata ... ignore them here.
1069 if (udev->parent) {
1070 if (udev->state == USB_STATE_SUSPENDED
1071 || new_state == USB_STATE_SUSPENDED)
1072 ; /* No change to wakeup settings */
1073 else if (new_state == USB_STATE_CONFIGURED)
1074 device_init_wakeup(&udev->dev,
1075 (udev->actconfig->desc.bmAttributes
1076 & USB_CONFIG_ATT_WAKEUP));
1077 else
1078 device_init_wakeup(&udev->dev, 0);
1080 udev->state = new_state;
1081 } else
1082 recursively_mark_NOTATTACHED(udev);
1083 spin_unlock_irqrestore(&device_state_lock, flags);
1086 static void choose_address(struct usb_device *udev)
1088 int devnum;
1089 struct usb_bus *bus = udev->bus;
1091 /* If khubd ever becomes multithreaded, this will need a lock */
1093 /* Try to allocate the next devnum beginning at bus->devnum_next. */
1094 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1095 bus->devnum_next);
1096 if (devnum >= 128)
1097 devnum = find_next_zero_bit(bus->devmap.devicemap, 128, 1);
1099 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1101 if (devnum < 128) {
1102 set_bit(devnum, bus->devmap.devicemap);
1103 udev->devnum = devnum;
1107 static void release_address(struct usb_device *udev)
1109 if (udev->devnum > 0) {
1110 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1111 udev->devnum = -1;
1115 #ifdef CONFIG_USB_SUSPEND
1117 static void usb_stop_pm(struct usb_device *udev)
1119 /* Synchronize with the ksuspend thread to prevent any more
1120 * autosuspend requests from being submitted, and decrement
1121 * the parent's count of unsuspended children.
1123 usb_pm_lock(udev);
1124 if (udev->parent && !udev->discon_suspended)
1125 usb_autosuspend_device(udev->parent);
1126 usb_pm_unlock(udev);
1128 /* Stop any autosuspend requests already submitted */
1129 cancel_rearming_delayed_work(&udev->autosuspend);
1132 #else
1134 static inline void usb_stop_pm(struct usb_device *udev)
1137 #endif
1140 * usb_disconnect - disconnect a device (usbcore-internal)
1141 * @pdev: pointer to device being disconnected
1142 * Context: !in_interrupt ()
1144 * Something got disconnected. Get rid of it and all of its children.
1146 * If *pdev is a normal device then the parent hub must already be locked.
1147 * If *pdev is a root hub then this routine will acquire the
1148 * usb_bus_list_lock on behalf of the caller.
1150 * Only hub drivers (including virtual root hub drivers for host
1151 * controllers) should ever call this.
1153 * This call is synchronous, and may not be used in an interrupt context.
1155 void usb_disconnect(struct usb_device **pdev)
1157 struct usb_device *udev = *pdev;
1158 int i;
1160 if (!udev) {
1161 pr_debug ("%s nodev\n", __FUNCTION__);
1162 return;
1165 /* mark the device as inactive, so any further urb submissions for
1166 * this device (and any of its children) will fail immediately.
1167 * this quiesces everyting except pending urbs.
1169 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1170 dev_info (&udev->dev, "USB disconnect, address %d\n", udev->devnum);
1172 usb_lock_device(udev);
1174 /* Free up all the children before we remove this device */
1175 for (i = 0; i < USB_MAXCHILDREN; i++) {
1176 if (udev->children[i])
1177 usb_disconnect(&udev->children[i]);
1180 /* deallocate hcd/hardware state ... nuking all pending urbs and
1181 * cleaning up all state associated with the current configuration
1182 * so that the hardware is now fully quiesced.
1184 dev_dbg (&udev->dev, "unregistering device\n");
1185 usb_disable_device(udev, 0);
1187 usb_unlock_device(udev);
1189 /* Unregister the device. The device driver is responsible
1190 * for removing the device files from usbfs and sysfs and for
1191 * de-configuring the device.
1193 device_del(&udev->dev);
1195 /* Free the device number and delete the parent's children[]
1196 * (or root_hub) pointer.
1198 release_address(udev);
1200 /* Avoid races with recursively_mark_NOTATTACHED() */
1201 spin_lock_irq(&device_state_lock);
1202 *pdev = NULL;
1203 spin_unlock_irq(&device_state_lock);
1205 usb_stop_pm(udev);
1207 put_device(&udev->dev);
1210 #ifdef DEBUG
1211 static void show_string(struct usb_device *udev, char *id, char *string)
1213 if (!string)
1214 return;
1215 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1218 #else
1219 static inline void show_string(struct usb_device *udev, char *id, char *string)
1221 #endif
1224 #ifdef CONFIG_USB_OTG
1225 #include "otg_whitelist.h"
1226 #endif
1229 * usb_configure_device_otg - FIXME (usbcore-internal)
1230 * @udev: newly addressed device (in ADDRESS state)
1232 * Do configuration for On-The-Go devices
1234 static int usb_configure_device_otg(struct usb_device *udev)
1236 int err = 0;
1238 #ifdef CONFIG_USB_OTG
1240 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1241 * to wake us after we've powered off VBUS; and HNP, switching roles
1242 * "host" to "peripheral". The OTG descriptor helps figure this out.
1244 if (!udev->bus->is_b_host
1245 && udev->config
1246 && udev->parent == udev->bus->root_hub) {
1247 struct usb_otg_descriptor *desc = 0;
1248 struct usb_bus *bus = udev->bus;
1250 /* descriptor may appear anywhere in config */
1251 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1252 le16_to_cpu(udev->config[0].desc.wTotalLength),
1253 USB_DT_OTG, (void **) &desc) == 0) {
1254 if (desc->bmAttributes & USB_OTG_HNP) {
1255 unsigned port1 = udev->portnum;
1257 dev_info(&udev->dev,
1258 "Dual-Role OTG device on %sHNP port\n",
1259 (port1 == bus->otg_port)
1260 ? "" : "non-");
1262 /* enable HNP before suspend, it's simpler */
1263 if (port1 == bus->otg_port)
1264 bus->b_hnp_enable = 1;
1265 err = usb_control_msg(udev,
1266 usb_sndctrlpipe(udev, 0),
1267 USB_REQ_SET_FEATURE, 0,
1268 bus->b_hnp_enable
1269 ? USB_DEVICE_B_HNP_ENABLE
1270 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1271 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1272 if (err < 0) {
1273 /* OTG MESSAGE: report errors here,
1274 * customize to match your product.
1276 dev_info(&udev->dev,
1277 "can't set HNP mode; %d\n",
1278 err);
1279 bus->b_hnp_enable = 0;
1285 if (!is_targeted(udev)) {
1287 /* Maybe it can talk to us, though we can't talk to it.
1288 * (Includes HNP test device.)
1290 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1291 err = usb_port_suspend(udev);
1292 if (err < 0)
1293 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1295 err = -ENOTSUPP;
1296 goto fail;
1298 fail:
1299 #endif
1300 return err;
1305 * usb_configure_device - Detect and probe device intfs/otg (usbcore-internal)
1306 * @udev: newly addressed device (in ADDRESS state)
1308 * This is only called by usb_new_device() and usb_authorize_device()
1309 * and FIXME -- all comments that apply to them apply here wrt to
1310 * environment.
1312 * If the device is WUSB and not authorized, we don't attempt to read
1313 * the string descriptors, as they will be errored out by the device
1314 * until it has been authorized.
1316 static int usb_configure_device(struct usb_device *udev)
1318 int err;
1320 if (udev->config == NULL) {
1321 err = usb_get_configuration(udev);
1322 if (err < 0) {
1323 dev_err(&udev->dev, "can't read configurations, error %d\n",
1324 err);
1325 goto fail;
1328 if (udev->wusb == 1 && udev->authorized == 0) {
1329 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1330 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1331 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1333 else {
1334 /* read the standard strings and cache them if present */
1335 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1336 udev->manufacturer = usb_cache_string(udev,
1337 udev->descriptor.iManufacturer);
1338 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1340 err = usb_configure_device_otg(udev);
1341 fail:
1342 return err;
1347 * usb_new_device - perform initial device setup (usbcore-internal)
1348 * @udev: newly addressed device (in ADDRESS state)
1350 * This is called with devices which have been enumerated, but not yet
1351 * configured. The device descriptor is available, but not descriptors
1352 * for any device configuration. The caller must have locked either
1353 * the parent hub (if udev is a normal device) or else the
1354 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1355 * udev has already been installed, but udev is not yet visible through
1356 * sysfs or other filesystem code.
1358 * It will return if the device is configured properly or not. Zero if
1359 * the interface was registered with the driver core; else a negative
1360 * errno value.
1362 * This call is synchronous, and may not be used in an interrupt context.
1364 * Only the hub driver or root-hub registrar should ever call this.
1366 int usb_new_device(struct usb_device *udev)
1368 int err;
1370 usb_detect_quirks(udev); /* Determine quirks */
1371 err = usb_configure_device(udev); /* detect & probe dev/intfs */
1372 if (err < 0)
1373 goto fail;
1374 /* export the usbdev device-node for libusb */
1375 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1376 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1378 /* Increment the parent's count of unsuspended children */
1379 if (udev->parent)
1380 usb_autoresume_device(udev->parent);
1382 /* Register the device. The device driver is responsible
1383 * for adding the device files to sysfs and for configuring
1384 * the device.
1386 err = device_add(&udev->dev);
1387 if (err) {
1388 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1389 goto fail;
1392 /* Tell the world! */
1393 dev_dbg(&udev->dev, "new device strings: Mfr=%d, Product=%d, "
1394 "SerialNumber=%d\n",
1395 udev->descriptor.iManufacturer,
1396 udev->descriptor.iProduct,
1397 udev->descriptor.iSerialNumber);
1398 show_string(udev, "Product", udev->product);
1399 show_string(udev, "Manufacturer", udev->manufacturer);
1400 show_string(udev, "SerialNumber", udev->serial);
1401 return err;
1403 fail:
1404 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1405 return err;
1410 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1411 * @usb_dev: USB device
1413 * Move the USB device to a very basic state where interfaces are disabled
1414 * and the device is in fact unconfigured and unusable.
1416 * We share a lock (that we have) with device_del(), so we need to
1417 * defer its call.
1419 int usb_deauthorize_device(struct usb_device *usb_dev)
1421 unsigned cnt;
1422 usb_lock_device(usb_dev);
1423 if (usb_dev->authorized == 0)
1424 goto out_unauthorized;
1425 usb_dev->authorized = 0;
1426 usb_set_configuration(usb_dev, -1);
1427 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1428 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1429 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1430 kfree(usb_dev->config);
1431 usb_dev->config = NULL;
1432 for (cnt = 0; cnt < usb_dev->descriptor.bNumConfigurations; cnt++)
1433 kfree(usb_dev->rawdescriptors[cnt]);
1434 usb_dev->descriptor.bNumConfigurations = 0;
1435 kfree(usb_dev->rawdescriptors);
1436 out_unauthorized:
1437 usb_unlock_device(usb_dev);
1438 return 0;
1442 int usb_authorize_device(struct usb_device *usb_dev)
1444 int result = 0, c;
1445 usb_lock_device(usb_dev);
1446 if (usb_dev->authorized == 1)
1447 goto out_authorized;
1448 kfree(usb_dev->product);
1449 usb_dev->product = NULL;
1450 kfree(usb_dev->manufacturer);
1451 usb_dev->manufacturer = NULL;
1452 kfree(usb_dev->serial);
1453 usb_dev->serial = NULL;
1454 result = usb_autoresume_device(usb_dev);
1455 if (result < 0) {
1456 dev_err(&usb_dev->dev,
1457 "can't autoresume for authorization: %d\n", result);
1458 goto error_autoresume;
1460 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
1461 if (result < 0) {
1462 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
1463 "authorization: %d\n", result);
1464 goto error_device_descriptor;
1466 usb_dev->authorized = 1;
1467 result = usb_configure_device(usb_dev);
1468 if (result < 0)
1469 goto error_configure;
1470 /* Choose and set the configuration. This registers the interfaces
1471 * with the driver core and lets interface drivers bind to them.
1473 c = usb_choose_configuration(usb_dev);
1474 if (c >= 0) {
1475 result = usb_set_configuration(usb_dev, c);
1476 if (result) {
1477 dev_err(&usb_dev->dev,
1478 "can't set config #%d, error %d\n", c, result);
1479 /* This need not be fatal. The user can try to
1480 * set other configurations. */
1483 dev_info(&usb_dev->dev, "authorized to connect\n");
1484 error_configure:
1485 error_device_descriptor:
1486 error_autoresume:
1487 out_authorized:
1488 usb_unlock_device(usb_dev); // complements locktree
1489 return result;
1493 static int hub_port_status(struct usb_hub *hub, int port1,
1494 u16 *status, u16 *change)
1496 int ret;
1498 mutex_lock(&hub->status_mutex);
1499 ret = get_port_status(hub->hdev, port1, &hub->status->port);
1500 if (ret < 4) {
1501 dev_err (hub->intfdev,
1502 "%s failed (err = %d)\n", __FUNCTION__, ret);
1503 if (ret >= 0)
1504 ret = -EIO;
1505 } else {
1506 *status = le16_to_cpu(hub->status->port.wPortStatus);
1507 *change = le16_to_cpu(hub->status->port.wPortChange);
1508 ret = 0;
1510 mutex_unlock(&hub->status_mutex);
1511 return ret;
1515 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
1516 static unsigned hub_is_wusb(struct usb_hub *hub)
1518 struct usb_hcd *hcd;
1519 if (hub->hdev->parent != NULL) /* not a root hub? */
1520 return 0;
1521 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
1522 return hcd->wireless;
1526 #define PORT_RESET_TRIES 5
1527 #define SET_ADDRESS_TRIES 2
1528 #define GET_DESCRIPTOR_TRIES 2
1529 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
1530 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
1532 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
1533 #define HUB_SHORT_RESET_TIME 10
1534 #define HUB_LONG_RESET_TIME 200
1535 #define HUB_RESET_TIMEOUT 500
1537 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
1538 struct usb_device *udev, unsigned int delay)
1540 int delay_time, ret;
1541 u16 portstatus;
1542 u16 portchange;
1544 for (delay_time = 0;
1545 delay_time < HUB_RESET_TIMEOUT;
1546 delay_time += delay) {
1547 /* wait to give the device a chance to reset */
1548 msleep(delay);
1550 /* read and decode port status */
1551 ret = hub_port_status(hub, port1, &portstatus, &portchange);
1552 if (ret < 0)
1553 return ret;
1555 /* Device went away? */
1556 if (!(portstatus & USB_PORT_STAT_CONNECTION))
1557 return -ENOTCONN;
1559 /* bomb out completely if the connection bounced */
1560 if ((portchange & USB_PORT_STAT_C_CONNECTION))
1561 return -ENOTCONN;
1563 /* if we`ve finished resetting, then break out of the loop */
1564 if (!(portstatus & USB_PORT_STAT_RESET) &&
1565 (portstatus & USB_PORT_STAT_ENABLE)) {
1566 if (hub_is_wusb(hub))
1567 udev->speed = USB_SPEED_VARIABLE;
1568 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
1569 udev->speed = USB_SPEED_HIGH;
1570 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
1571 udev->speed = USB_SPEED_LOW;
1572 else
1573 udev->speed = USB_SPEED_FULL;
1574 return 0;
1577 /* switch to the long delay after two short delay failures */
1578 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
1579 delay = HUB_LONG_RESET_TIME;
1581 dev_dbg (hub->intfdev,
1582 "port %d not reset yet, waiting %dms\n",
1583 port1, delay);
1586 return -EBUSY;
1589 static int hub_port_reset(struct usb_hub *hub, int port1,
1590 struct usb_device *udev, unsigned int delay)
1592 int i, status;
1594 /* Block EHCI CF initialization during the port reset.
1595 * Some companion controllers don't like it when they mix.
1597 down_read(&ehci_cf_port_reset_rwsem);
1599 /* Reset the port */
1600 for (i = 0; i < PORT_RESET_TRIES; i++) {
1601 status = set_port_feature(hub->hdev,
1602 port1, USB_PORT_FEAT_RESET);
1603 if (status)
1604 dev_err(hub->intfdev,
1605 "cannot reset port %d (err = %d)\n",
1606 port1, status);
1607 else {
1608 status = hub_port_wait_reset(hub, port1, udev, delay);
1609 if (status && status != -ENOTCONN)
1610 dev_dbg(hub->intfdev,
1611 "port_wait_reset: err = %d\n",
1612 status);
1615 /* return on disconnect or reset */
1616 switch (status) {
1617 case 0:
1618 /* TRSTRCY = 10 ms; plus some extra */
1619 msleep(10 + 40);
1620 udev->devnum = 0; /* Device now at address 0 */
1621 /* FALL THROUGH */
1622 case -ENOTCONN:
1623 case -ENODEV:
1624 clear_port_feature(hub->hdev,
1625 port1, USB_PORT_FEAT_C_RESET);
1626 /* FIXME need disconnect() for NOTATTACHED device */
1627 usb_set_device_state(udev, status
1628 ? USB_STATE_NOTATTACHED
1629 : USB_STATE_DEFAULT);
1630 goto done;
1633 dev_dbg (hub->intfdev,
1634 "port %d not enabled, trying reset again...\n",
1635 port1);
1636 delay = HUB_LONG_RESET_TIME;
1639 dev_err (hub->intfdev,
1640 "Cannot enable port %i. Maybe the USB cable is bad?\n",
1641 port1);
1643 done:
1644 up_read(&ehci_cf_port_reset_rwsem);
1645 return status;
1648 #ifdef CONFIG_PM
1650 #ifdef CONFIG_USB_SUSPEND
1653 * usb_port_suspend - suspend a usb device's upstream port
1654 * @udev: device that's no longer in active use, not a root hub
1655 * Context: must be able to sleep; device not locked; pm locks held
1657 * Suspends a USB device that isn't in active use, conserving power.
1658 * Devices may wake out of a suspend, if anything important happens,
1659 * using the remote wakeup mechanism. They may also be taken out of
1660 * suspend by the host, using usb_port_resume(). It's also routine
1661 * to disconnect devices while they are suspended.
1663 * This only affects the USB hardware for a device; its interfaces
1664 * (and, for hubs, child devices) must already have been suspended.
1666 * Selective port suspend reduces power; most suspended devices draw
1667 * less than 500 uA. It's also used in OTG, along with remote wakeup.
1668 * All devices below the suspended port are also suspended.
1670 * Devices leave suspend state when the host wakes them up. Some devices
1671 * also support "remote wakeup", where the device can activate the USB
1672 * tree above them to deliver data, such as a keypress or packet. In
1673 * some cases, this wakes the USB host.
1675 * Suspending OTG devices may trigger HNP, if that's been enabled
1676 * between a pair of dual-role devices. That will change roles, such
1677 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
1679 * Devices on USB hub ports have only one "suspend" state, corresponding
1680 * to ACPI D2, "may cause the device to lose some context".
1681 * State transitions include:
1683 * - suspend, resume ... when the VBUS power link stays live
1684 * - suspend, disconnect ... VBUS lost
1686 * Once VBUS drop breaks the circuit, the port it's using has to go through
1687 * normal re-enumeration procedures, starting with enabling VBUS power.
1688 * Other than re-initializing the hub (plug/unplug, except for root hubs),
1689 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
1690 * timer, no SRP, no requests through sysfs.
1692 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
1693 * the root hub for their bus goes into global suspend ... so we don't
1694 * (falsely) update the device power state to say it suspended.
1696 * Returns 0 on success, else negative errno.
1698 int usb_port_suspend(struct usb_device *udev)
1700 struct usb_hub *hub = hdev_to_hub(udev->parent);
1701 int port1 = udev->portnum;
1702 int status;
1704 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
1706 /* enable remote wakeup when appropriate; this lets the device
1707 * wake up the upstream hub (including maybe the root hub).
1709 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
1710 * we don't explicitly enable it here.
1712 if (udev->do_remote_wakeup) {
1713 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1714 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
1715 USB_DEVICE_REMOTE_WAKEUP, 0,
1716 NULL, 0,
1717 USB_CTRL_SET_TIMEOUT);
1718 if (status)
1719 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
1720 status);
1723 /* see 7.1.7.6 */
1724 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
1725 if (status) {
1726 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
1727 port1, status);
1728 /* paranoia: "should not happen" */
1729 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1730 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
1731 USB_DEVICE_REMOTE_WAKEUP, 0,
1732 NULL, 0,
1733 USB_CTRL_SET_TIMEOUT);
1734 } else {
1735 /* device has up to 10 msec to fully suspend */
1736 dev_dbg(&udev->dev, "usb %ssuspend\n",
1737 udev->auto_pm ? "auto-" : "");
1738 usb_set_device_state(udev, USB_STATE_SUSPENDED);
1739 msleep(10);
1741 return status;
1745 * If the USB "suspend" state is in use (rather than "global suspend"),
1746 * many devices will be individually taken out of suspend state using
1747 * special "resume" signaling. This routine kicks in shortly after
1748 * hardware resume signaling is finished, either because of selective
1749 * resume (by host) or remote wakeup (by device) ... now see what changed
1750 * in the tree that's rooted at this device.
1752 * If @udev->reset_resume is set then the device is reset before the
1753 * status check is done.
1755 static int finish_port_resume(struct usb_device *udev)
1757 int status = 0;
1758 u16 devstatus;
1760 /* caller owns the udev device lock */
1761 dev_dbg(&udev->dev, "finish %sresume\n",
1762 udev->reset_resume ? "reset-" : "");
1764 /* usb ch9 identifies four variants of SUSPENDED, based on what
1765 * state the device resumes to. Linux currently won't see the
1766 * first two on the host side; they'd be inside hub_port_init()
1767 * during many timeouts, but khubd can't suspend until later.
1769 usb_set_device_state(udev, udev->actconfig
1770 ? USB_STATE_CONFIGURED
1771 : USB_STATE_ADDRESS);
1773 /* 10.5.4.5 says not to reset a suspended port if the attached
1774 * device is enabled for remote wakeup. Hence the reset
1775 * operation is carried out here, after the port has been
1776 * resumed.
1778 if (udev->reset_resume)
1779 status = usb_reset_device(udev);
1781 /* 10.5.4.5 says be sure devices in the tree are still there.
1782 * For now let's assume the device didn't go crazy on resume,
1783 * and device drivers will know about any resume quirks.
1785 if (status == 0) {
1786 devstatus = 0;
1787 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
1788 if (status >= 0)
1789 status = (status > 0 ? 0 : -ENODEV);
1792 if (status) {
1793 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
1794 status);
1795 } else if (udev->actconfig) {
1796 le16_to_cpus(&devstatus);
1797 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
1798 status = usb_control_msg(udev,
1799 usb_sndctrlpipe(udev, 0),
1800 USB_REQ_CLEAR_FEATURE,
1801 USB_RECIP_DEVICE,
1802 USB_DEVICE_REMOTE_WAKEUP, 0,
1803 NULL, 0,
1804 USB_CTRL_SET_TIMEOUT);
1805 if (status)
1806 dev_dbg(&udev->dev, "disable remote "
1807 "wakeup, status %d\n", status);
1809 status = 0;
1811 return status;
1815 * usb_port_resume - re-activate a suspended usb device's upstream port
1816 * @udev: device to re-activate, not a root hub
1817 * Context: must be able to sleep; device not locked; pm locks held
1819 * This will re-activate the suspended device, increasing power usage
1820 * while letting drivers communicate again with its endpoints.
1821 * USB resume explicitly guarantees that the power session between
1822 * the host and the device is the same as it was when the device
1823 * suspended.
1825 * If CONFIG_USB_PERSIST and @udev->reset_resume are both set then this
1826 * routine won't check that the port is still enabled. Furthermore,
1827 * if @udev->reset_resume is set then finish_port_resume() above will
1828 * reset @udev. The end result is that a broken power session can be
1829 * recovered and @udev will appear to persist across a loss of VBUS power.
1831 * For example, if a host controller doesn't maintain VBUS suspend current
1832 * during a system sleep or is reset when the system wakes up, all the USB
1833 * power sessions below it will be broken. This is especially troublesome
1834 * for mass-storage devices containing mounted filesystems, since the
1835 * device will appear to have disconnected and all the memory mappings
1836 * to it will be lost. Using the USB_PERSIST facility, the device can be
1837 * made to appear as if it had not disconnected.
1839 * This facility is inherently dangerous. Although usb_reset_device()
1840 * makes every effort to insure that the same device is present after the
1841 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
1842 * quite possible for a device to remain unaltered but its media to be
1843 * changed. If the user replaces a flash memory card while the system is
1844 * asleep, he will have only himself to blame when the filesystem on the
1845 * new card is corrupted and the system crashes.
1847 * Returns 0 on success, else negative errno.
1849 int usb_port_resume(struct usb_device *udev)
1851 struct usb_hub *hub = hdev_to_hub(udev->parent);
1852 int port1 = udev->portnum;
1853 int status;
1854 u16 portchange, portstatus;
1855 unsigned mask_flags, want_flags;
1857 /* Skip the initial Clear-Suspend step for a remote wakeup */
1858 status = hub_port_status(hub, port1, &portstatus, &portchange);
1859 if (status == 0 && !(portstatus & USB_PORT_STAT_SUSPEND))
1860 goto SuspendCleared;
1862 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
1864 set_bit(port1, hub->busy_bits);
1866 /* see 7.1.7.7; affects power usage, but not budgeting */
1867 status = clear_port_feature(hub->hdev,
1868 port1, USB_PORT_FEAT_SUSPEND);
1869 if (status) {
1870 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
1871 port1, status);
1872 } else {
1873 /* drive resume for at least 20 msec */
1874 dev_dbg(&udev->dev, "usb %sresume\n",
1875 udev->auto_pm ? "auto-" : "");
1876 msleep(25);
1878 /* Virtual root hubs can trigger on GET_PORT_STATUS to
1879 * stop resume signaling. Then finish the resume
1880 * sequence.
1882 status = hub_port_status(hub, port1, &portstatus, &portchange);
1884 SuspendCleared:
1885 if (USB_PERSIST && udev->reset_resume)
1886 want_flags = USB_PORT_STAT_POWER
1887 | USB_PORT_STAT_CONNECTION;
1888 else
1889 want_flags = USB_PORT_STAT_POWER
1890 | USB_PORT_STAT_CONNECTION
1891 | USB_PORT_STAT_ENABLE;
1892 mask_flags = want_flags | USB_PORT_STAT_SUSPEND;
1894 if (status < 0 || (portstatus & mask_flags) != want_flags) {
1895 dev_dbg(hub->intfdev,
1896 "port %d status %04x.%04x after resume, %d\n",
1897 port1, portchange, portstatus, status);
1898 if (status >= 0)
1899 status = -ENODEV;
1900 } else {
1901 if (portchange & USB_PORT_STAT_C_SUSPEND)
1902 clear_port_feature(hub->hdev, port1,
1903 USB_PORT_FEAT_C_SUSPEND);
1904 /* TRSMRCY = 10 msec */
1905 msleep(10);
1909 clear_bit(port1, hub->busy_bits);
1910 if (!hub->hdev->parent && !hub->busy_bits[0])
1911 usb_enable_root_hub_irq(hub->hdev->bus);
1913 if (status == 0)
1914 status = finish_port_resume(udev);
1915 if (status < 0) {
1916 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
1917 hub_port_logical_disconnect(hub, port1);
1919 return status;
1922 static int remote_wakeup(struct usb_device *udev)
1924 int status = 0;
1926 usb_lock_device(udev);
1927 if (udev->state == USB_STATE_SUSPENDED) {
1928 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
1929 usb_mark_last_busy(udev);
1930 status = usb_external_resume_device(udev);
1932 usb_unlock_device(udev);
1933 return status;
1936 #else /* CONFIG_USB_SUSPEND */
1938 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
1940 int usb_port_suspend(struct usb_device *udev)
1942 return 0;
1945 int usb_port_resume(struct usb_device *udev)
1947 int status = 0;
1949 /* However we may need to do a reset-resume */
1950 if (udev->reset_resume) {
1951 dev_dbg(&udev->dev, "reset-resume\n");
1952 status = usb_reset_device(udev);
1954 return status;
1957 static inline int remote_wakeup(struct usb_device *udev)
1959 return 0;
1962 #endif
1964 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
1966 struct usb_hub *hub = usb_get_intfdata (intf);
1967 struct usb_device *hdev = hub->hdev;
1968 unsigned port1;
1970 /* fail if children aren't already suspended */
1971 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
1972 struct usb_device *udev;
1974 udev = hdev->children [port1-1];
1975 if (udev && udev->can_submit) {
1976 if (!hdev->auto_pm)
1977 dev_dbg(&intf->dev, "port %d nyet suspended\n",
1978 port1);
1979 return -EBUSY;
1983 dev_dbg(&intf->dev, "%s\n", __FUNCTION__);
1985 /* stop khubd and related activity */
1986 hub_quiesce(hub);
1987 return 0;
1990 static int hub_resume(struct usb_interface *intf)
1992 struct usb_hub *hub = usb_get_intfdata (intf);
1994 dev_dbg(&intf->dev, "%s\n", __FUNCTION__);
1996 /* tell khubd to look for changes on this hub */
1997 hub_activate(hub);
1998 return 0;
2001 static int hub_reset_resume(struct usb_interface *intf)
2003 struct usb_hub *hub = usb_get_intfdata(intf);
2004 struct usb_device *hdev = hub->hdev;
2005 int port1;
2007 hub_power_on(hub);
2009 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2010 struct usb_device *child = hdev->children[port1-1];
2012 if (child) {
2014 /* For "USB_PERSIST"-enabled children we must
2015 * mark the child device for reset-resume and
2016 * turn off the connect-change status to prevent
2017 * khubd from disconnecting it later.
2019 if (USB_PERSIST && child->persist_enabled) {
2020 child->reset_resume = 1;
2021 clear_port_feature(hdev, port1,
2022 USB_PORT_FEAT_C_CONNECTION);
2024 /* Otherwise we must disconnect the child,
2025 * but as we may not lock the child device here
2026 * we have to do a "logical" disconnect.
2028 } else {
2029 hub_port_logical_disconnect(hub, port1);
2034 hub_activate(hub);
2035 return 0;
2039 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2040 * @rhdev: struct usb_device for the root hub
2042 * The USB host controller driver calls this function when its root hub
2043 * is resumed and Vbus power has been interrupted or the controller
2044 * has been reset. The routine marks @rhdev as having lost power. When
2045 * the hub driver is resumed it will take notice; if CONFIG_USB_PERSIST
2046 * is enabled then it will carry out power-session recovery, otherwise
2047 * it will disconnect all the child devices.
2049 void usb_root_hub_lost_power(struct usb_device *rhdev)
2051 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
2052 rhdev->reset_resume = 1;
2054 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
2056 #else /* CONFIG_PM */
2058 static inline int remote_wakeup(struct usb_device *udev)
2060 return 0;
2063 #define hub_suspend NULL
2064 #define hub_resume NULL
2065 #define hub_reset_resume NULL
2066 #endif
2069 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2071 * Between connect detection and reset signaling there must be a delay
2072 * of 100ms at least for debounce and power-settling. The corresponding
2073 * timer shall restart whenever the downstream port detects a disconnect.
2075 * Apparently there are some bluetooth and irda-dongles and a number of
2076 * low-speed devices for which this debounce period may last over a second.
2077 * Not covered by the spec - but easy to deal with.
2079 * This implementation uses a 1500ms total debounce timeout; if the
2080 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2081 * every 25ms for transient disconnects. When the port status has been
2082 * unchanged for 100ms it returns the port status.
2085 #define HUB_DEBOUNCE_TIMEOUT 1500
2086 #define HUB_DEBOUNCE_STEP 25
2087 #define HUB_DEBOUNCE_STABLE 100
2089 static int hub_port_debounce(struct usb_hub *hub, int port1)
2091 int ret;
2092 int total_time, stable_time = 0;
2093 u16 portchange, portstatus;
2094 unsigned connection = 0xffff;
2096 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2097 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2098 if (ret < 0)
2099 return ret;
2101 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2102 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2103 stable_time += HUB_DEBOUNCE_STEP;
2104 if (stable_time >= HUB_DEBOUNCE_STABLE)
2105 break;
2106 } else {
2107 stable_time = 0;
2108 connection = portstatus & USB_PORT_STAT_CONNECTION;
2111 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2112 clear_port_feature(hub->hdev, port1,
2113 USB_PORT_FEAT_C_CONNECTION);
2116 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2117 break;
2118 msleep(HUB_DEBOUNCE_STEP);
2121 dev_dbg (hub->intfdev,
2122 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2123 port1, total_time, stable_time, portstatus);
2125 if (stable_time < HUB_DEBOUNCE_STABLE)
2126 return -ETIMEDOUT;
2127 return portstatus;
2130 static void ep0_reinit(struct usb_device *udev)
2132 usb_disable_endpoint(udev, 0 + USB_DIR_IN);
2133 usb_disable_endpoint(udev, 0 + USB_DIR_OUT);
2134 usb_enable_endpoint(udev, &udev->ep0);
2137 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2138 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2140 static int hub_set_address(struct usb_device *udev, int devnum)
2142 int retval;
2144 if (devnum <= 1)
2145 return -EINVAL;
2146 if (udev->state == USB_STATE_ADDRESS)
2147 return 0;
2148 if (udev->state != USB_STATE_DEFAULT)
2149 return -EINVAL;
2150 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2151 USB_REQ_SET_ADDRESS, 0, devnum, 0,
2152 NULL, 0, USB_CTRL_SET_TIMEOUT);
2153 if (retval == 0) {
2154 udev->devnum = devnum; /* Device now using proper address */
2155 usb_set_device_state(udev, USB_STATE_ADDRESS);
2156 ep0_reinit(udev);
2158 return retval;
2161 /* Reset device, (re)assign address, get device descriptor.
2162 * Device connection must be stable, no more debouncing needed.
2163 * Returns device in USB_STATE_ADDRESS, except on error.
2165 * If this is called for an already-existing device (as part of
2166 * usb_reset_device), the caller must own the device lock. For a
2167 * newly detected device that is not accessible through any global
2168 * pointers, it's not necessary to lock the device.
2170 static int
2171 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2172 int retry_counter)
2174 static DEFINE_MUTEX(usb_address0_mutex);
2176 struct usb_device *hdev = hub->hdev;
2177 int i, j, retval;
2178 unsigned delay = HUB_SHORT_RESET_TIME;
2179 enum usb_device_speed oldspeed = udev->speed;
2180 char *speed, *type;
2181 int devnum = udev->devnum;
2183 /* root hub ports have a slightly longer reset period
2184 * (from USB 2.0 spec, section 7.1.7.5)
2186 if (!hdev->parent) {
2187 delay = HUB_ROOT_RESET_TIME;
2188 if (port1 == hdev->bus->otg_port)
2189 hdev->bus->b_hnp_enable = 0;
2192 /* Some low speed devices have problems with the quick delay, so */
2193 /* be a bit pessimistic with those devices. RHbug #23670 */
2194 if (oldspeed == USB_SPEED_LOW)
2195 delay = HUB_LONG_RESET_TIME;
2197 mutex_lock(&usb_address0_mutex);
2199 /* Reset the device; full speed may morph to high speed */
2200 retval = hub_port_reset(hub, port1, udev, delay);
2201 if (retval < 0) /* error or disconnect */
2202 goto fail;
2203 /* success, speed is known */
2204 retval = -ENODEV;
2206 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2207 dev_dbg(&udev->dev, "device reset changed speed!\n");
2208 goto fail;
2210 oldspeed = udev->speed;
2212 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2213 * it's fixed size except for full speed devices.
2214 * For Wireless USB devices, ep0 max packet is always 512 (tho
2215 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2217 switch (udev->speed) {
2218 case USB_SPEED_VARIABLE: /* fixed at 512 */
2219 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(512);
2220 break;
2221 case USB_SPEED_HIGH: /* fixed at 64 */
2222 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2223 break;
2224 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2225 /* to determine the ep0 maxpacket size, try to read
2226 * the device descriptor to get bMaxPacketSize0 and
2227 * then correct our initial guess.
2229 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(64);
2230 break;
2231 case USB_SPEED_LOW: /* fixed at 8 */
2232 udev->ep0.desc.wMaxPacketSize = __constant_cpu_to_le16(8);
2233 break;
2234 default:
2235 goto fail;
2238 type = "";
2239 switch (udev->speed) {
2240 case USB_SPEED_LOW: speed = "low"; break;
2241 case USB_SPEED_FULL: speed = "full"; break;
2242 case USB_SPEED_HIGH: speed = "high"; break;
2243 case USB_SPEED_VARIABLE:
2244 speed = "variable";
2245 type = "Wireless ";
2246 break;
2247 default: speed = "?"; break;
2249 dev_info (&udev->dev,
2250 "%s %s speed %sUSB device using %s and address %d\n",
2251 (udev->config) ? "reset" : "new", speed, type,
2252 udev->bus->controller->driver->name, devnum);
2254 /* Set up TT records, if needed */
2255 if (hdev->tt) {
2256 udev->tt = hdev->tt;
2257 udev->ttport = hdev->ttport;
2258 } else if (udev->speed != USB_SPEED_HIGH
2259 && hdev->speed == USB_SPEED_HIGH) {
2260 udev->tt = &hub->tt;
2261 udev->ttport = port1;
2264 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2265 * Because device hardware and firmware is sometimes buggy in
2266 * this area, and this is how Linux has done it for ages.
2267 * Change it cautiously.
2269 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2270 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2271 * so it may help with some non-standards-compliant devices.
2272 * Otherwise we start with SET_ADDRESS and then try to read the
2273 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2274 * value.
2276 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2277 if (USE_NEW_SCHEME(retry_counter)) {
2278 struct usb_device_descriptor *buf;
2279 int r = 0;
2281 #define GET_DESCRIPTOR_BUFSIZE 64
2282 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2283 if (!buf) {
2284 retval = -ENOMEM;
2285 continue;
2288 /* Retry on all errors; some devices are flakey.
2289 * 255 is for WUSB devices, we actually need to use
2290 * 512 (WUSB1.0[4.8.1]).
2292 for (j = 0; j < 3; ++j) {
2293 buf->bMaxPacketSize0 = 0;
2294 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2295 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2296 USB_DT_DEVICE << 8, 0,
2297 buf, GET_DESCRIPTOR_BUFSIZE,
2298 USB_CTRL_GET_TIMEOUT);
2299 switch (buf->bMaxPacketSize0) {
2300 case 8: case 16: case 32: case 64: case 255:
2301 if (buf->bDescriptorType ==
2302 USB_DT_DEVICE) {
2303 r = 0;
2304 break;
2306 /* FALL THROUGH */
2307 default:
2308 if (r == 0)
2309 r = -EPROTO;
2310 break;
2312 if (r == 0)
2313 break;
2315 udev->descriptor.bMaxPacketSize0 =
2316 buf->bMaxPacketSize0;
2317 kfree(buf);
2319 retval = hub_port_reset(hub, port1, udev, delay);
2320 if (retval < 0) /* error or disconnect */
2321 goto fail;
2322 if (oldspeed != udev->speed) {
2323 dev_dbg(&udev->dev,
2324 "device reset changed speed!\n");
2325 retval = -ENODEV;
2326 goto fail;
2328 if (r) {
2329 dev_err(&udev->dev, "device descriptor "
2330 "read/%s, error %d\n",
2331 "64", r);
2332 retval = -EMSGSIZE;
2333 continue;
2335 #undef GET_DESCRIPTOR_BUFSIZE
2338 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2339 retval = hub_set_address(udev, devnum);
2340 if (retval >= 0)
2341 break;
2342 msleep(200);
2344 if (retval < 0) {
2345 dev_err(&udev->dev,
2346 "device not accepting address %d, error %d\n",
2347 devnum, retval);
2348 goto fail;
2351 /* cope with hardware quirkiness:
2352 * - let SET_ADDRESS settle, some device hardware wants it
2353 * - read ep0 maxpacket even for high and low speed,
2355 msleep(10);
2356 if (USE_NEW_SCHEME(retry_counter))
2357 break;
2359 retval = usb_get_device_descriptor(udev, 8);
2360 if (retval < 8) {
2361 dev_err(&udev->dev, "device descriptor "
2362 "read/%s, error %d\n",
2363 "8", retval);
2364 if (retval >= 0)
2365 retval = -EMSGSIZE;
2366 } else {
2367 retval = 0;
2368 break;
2371 if (retval)
2372 goto fail;
2374 i = udev->descriptor.bMaxPacketSize0 == 0xff?
2375 512 : udev->descriptor.bMaxPacketSize0;
2376 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2377 if (udev->speed != USB_SPEED_FULL ||
2378 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2379 dev_err(&udev->dev, "ep0 maxpacket = %d\n", i);
2380 retval = -EMSGSIZE;
2381 goto fail;
2383 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2384 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2385 ep0_reinit(udev);
2388 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2389 if (retval < (signed)sizeof(udev->descriptor)) {
2390 dev_err(&udev->dev, "device descriptor read/%s, error %d\n",
2391 "all", retval);
2392 if (retval >= 0)
2393 retval = -ENOMSG;
2394 goto fail;
2397 retval = 0;
2399 fail:
2400 if (retval) {
2401 hub_port_disable(hub, port1, 0);
2402 udev->devnum = devnum; /* for disconnect processing */
2404 mutex_unlock(&usb_address0_mutex);
2405 return retval;
2408 static void
2409 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2411 struct usb_qualifier_descriptor *qual;
2412 int status;
2414 qual = kmalloc (sizeof *qual, GFP_KERNEL);
2415 if (qual == NULL)
2416 return;
2418 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2419 qual, sizeof *qual);
2420 if (status == sizeof *qual) {
2421 dev_info(&udev->dev, "not running at top speed; "
2422 "connect to a high speed hub\n");
2423 /* hub LEDs are probably harder to miss than syslog */
2424 if (hub->has_indicators) {
2425 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
2426 schedule_delayed_work (&hub->leds, 0);
2429 kfree(qual);
2432 static unsigned
2433 hub_power_remaining (struct usb_hub *hub)
2435 struct usb_device *hdev = hub->hdev;
2436 int remaining;
2437 int port1;
2439 if (!hub->limited_power)
2440 return 0;
2442 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
2443 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
2444 struct usb_device *udev = hdev->children[port1 - 1];
2445 int delta;
2447 if (!udev)
2448 continue;
2450 /* Unconfigured devices may not use more than 100mA,
2451 * or 8mA for OTG ports */
2452 if (udev->actconfig)
2453 delta = udev->actconfig->desc.bMaxPower * 2;
2454 else if (port1 != udev->bus->otg_port || hdev->parent)
2455 delta = 100;
2456 else
2457 delta = 8;
2458 if (delta > hub->mA_per_port)
2459 dev_warn(&udev->dev, "%dmA is over %umA budget "
2460 "for port %d!\n",
2461 delta, hub->mA_per_port, port1);
2462 remaining -= delta;
2464 if (remaining < 0) {
2465 dev_warn(hub->intfdev, "%dmA over power budget!\n",
2466 - remaining);
2467 remaining = 0;
2469 return remaining;
2472 /* Handle physical or logical connection change events.
2473 * This routine is called when:
2474 * a port connection-change occurs;
2475 * a port enable-change occurs (often caused by EMI);
2476 * usb_reset_device() encounters changed descriptors (as from
2477 * a firmware download)
2478 * caller already locked the hub
2480 static void hub_port_connect_change(struct usb_hub *hub, int port1,
2481 u16 portstatus, u16 portchange)
2483 struct usb_device *hdev = hub->hdev;
2484 struct device *hub_dev = hub->intfdev;
2485 u16 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2486 int status, i;
2488 dev_dbg (hub_dev,
2489 "port %d, status %04x, change %04x, %s\n",
2490 port1, portstatus, portchange, portspeed (portstatus));
2492 if (hub->has_indicators) {
2493 set_port_led(hub, port1, HUB_LED_AUTO);
2494 hub->indicator[port1-1] = INDICATOR_AUTO;
2497 /* Disconnect any existing devices under this port */
2498 if (hdev->children[port1-1])
2499 usb_disconnect(&hdev->children[port1-1]);
2500 clear_bit(port1, hub->change_bits);
2502 #ifdef CONFIG_USB_OTG
2503 /* during HNP, don't repeat the debounce */
2504 if (hdev->bus->is_b_host)
2505 portchange &= ~USB_PORT_STAT_C_CONNECTION;
2506 #endif
2508 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2509 status = hub_port_debounce(hub, port1);
2510 if (status < 0) {
2511 if (printk_ratelimit())
2512 dev_err (hub_dev, "connect-debounce failed, "
2513 "port %d disabled\n", port1);
2514 goto done;
2516 portstatus = status;
2519 /* Return now if nothing is connected */
2520 if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2522 /* maybe switch power back on (e.g. root hub was reset) */
2523 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
2524 && !(portstatus & (1 << USB_PORT_FEAT_POWER)))
2525 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
2527 if (portstatus & USB_PORT_STAT_ENABLE)
2528 goto done;
2529 return;
2532 for (i = 0; i < SET_CONFIG_TRIES; i++) {
2533 struct usb_device *udev;
2535 /* reallocate for each attempt, since references
2536 * to the previous one can escape in various ways
2538 udev = usb_alloc_dev(hdev, hdev->bus, port1);
2539 if (!udev) {
2540 dev_err (hub_dev,
2541 "couldn't allocate port %d usb_device\n",
2542 port1);
2543 goto done;
2546 usb_set_device_state(udev, USB_STATE_POWERED);
2547 udev->speed = USB_SPEED_UNKNOWN;
2548 udev->bus_mA = hub->mA_per_port;
2549 udev->level = hdev->level + 1;
2551 /* set the address */
2552 choose_address(udev);
2553 if (udev->devnum <= 0) {
2554 status = -ENOTCONN; /* Don't retry */
2555 goto loop;
2558 /* reset and get descriptor */
2559 status = hub_port_init(hub, udev, port1, i);
2560 if (status < 0)
2561 goto loop;
2563 /* consecutive bus-powered hubs aren't reliable; they can
2564 * violate the voltage drop budget. if the new child has
2565 * a "powered" LED, users should notice we didn't enable it
2566 * (without reading syslog), even without per-port LEDs
2567 * on the parent.
2569 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
2570 && udev->bus_mA <= 100) {
2571 u16 devstat;
2573 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
2574 &devstat);
2575 if (status < 2) {
2576 dev_dbg(&udev->dev, "get status %d ?\n", status);
2577 goto loop_disable;
2579 le16_to_cpus(&devstat);
2580 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
2581 dev_err(&udev->dev,
2582 "can't connect bus-powered hub "
2583 "to this port\n");
2584 if (hub->has_indicators) {
2585 hub->indicator[port1-1] =
2586 INDICATOR_AMBER_BLINK;
2587 schedule_delayed_work (&hub->leds, 0);
2589 status = -ENOTCONN; /* Don't retry */
2590 goto loop_disable;
2594 /* check for devices running slower than they could */
2595 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
2596 && udev->speed == USB_SPEED_FULL
2597 && highspeed_hubs != 0)
2598 check_highspeed (hub, udev, port1);
2600 /* Store the parent's children[] pointer. At this point
2601 * udev becomes globally accessible, although presumably
2602 * no one will look at it until hdev is unlocked.
2604 status = 0;
2606 /* We mustn't add new devices if the parent hub has
2607 * been disconnected; we would race with the
2608 * recursively_mark_NOTATTACHED() routine.
2610 spin_lock_irq(&device_state_lock);
2611 if (hdev->state == USB_STATE_NOTATTACHED)
2612 status = -ENOTCONN;
2613 else
2614 hdev->children[port1-1] = udev;
2615 spin_unlock_irq(&device_state_lock);
2617 /* Run it through the hoops (find a driver, etc) */
2618 if (!status) {
2619 status = usb_new_device(udev);
2620 if (status) {
2621 spin_lock_irq(&device_state_lock);
2622 hdev->children[port1-1] = NULL;
2623 spin_unlock_irq(&device_state_lock);
2627 if (status)
2628 goto loop_disable;
2630 status = hub_power_remaining(hub);
2631 if (status)
2632 dev_dbg(hub_dev, "%dmA power budget left\n", status);
2634 return;
2636 loop_disable:
2637 hub_port_disable(hub, port1, 1);
2638 loop:
2639 ep0_reinit(udev);
2640 release_address(udev);
2641 usb_put_dev(udev);
2642 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
2643 break;
2646 done:
2647 hub_port_disable(hub, port1, 1);
2650 static void hub_events(void)
2652 struct list_head *tmp;
2653 struct usb_device *hdev;
2654 struct usb_interface *intf;
2655 struct usb_hub *hub;
2656 struct device *hub_dev;
2657 u16 hubstatus;
2658 u16 hubchange;
2659 u16 portstatus;
2660 u16 portchange;
2661 int i, ret;
2662 int connect_change;
2665 * We restart the list every time to avoid a deadlock with
2666 * deleting hubs downstream from this one. This should be
2667 * safe since we delete the hub from the event list.
2668 * Not the most efficient, but avoids deadlocks.
2670 while (1) {
2672 /* Grab the first entry at the beginning of the list */
2673 spin_lock_irq(&hub_event_lock);
2674 if (list_empty(&hub_event_list)) {
2675 spin_unlock_irq(&hub_event_lock);
2676 break;
2679 tmp = hub_event_list.next;
2680 list_del_init(tmp);
2682 hub = list_entry(tmp, struct usb_hub, event_list);
2683 kref_get(&hub->kref);
2684 spin_unlock_irq(&hub_event_lock);
2686 hdev = hub->hdev;
2687 hub_dev = hub->intfdev;
2688 intf = to_usb_interface(hub_dev);
2689 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
2690 hdev->state, hub->descriptor
2691 ? hub->descriptor->bNbrPorts
2692 : 0,
2693 /* NOTE: expects max 15 ports... */
2694 (u16) hub->change_bits[0],
2695 (u16) hub->event_bits[0]);
2697 /* Lock the device, then check to see if we were
2698 * disconnected while waiting for the lock to succeed. */
2699 usb_lock_device(hdev);
2700 if (unlikely(hub->disconnected))
2701 goto loop;
2703 /* If the hub has died, clean up after it */
2704 if (hdev->state == USB_STATE_NOTATTACHED) {
2705 hub->error = -ENODEV;
2706 hub_pre_reset(intf);
2707 goto loop;
2710 /* Autoresume */
2711 ret = usb_autopm_get_interface(intf);
2712 if (ret) {
2713 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
2714 goto loop;
2717 /* If this is an inactive hub, do nothing */
2718 if (hub->quiescing)
2719 goto loop_autopm;
2721 if (hub->error) {
2722 dev_dbg (hub_dev, "resetting for error %d\n",
2723 hub->error);
2725 ret = usb_reset_composite_device(hdev, intf);
2726 if (ret) {
2727 dev_dbg (hub_dev,
2728 "error resetting hub: %d\n", ret);
2729 goto loop_autopm;
2732 hub->nerrors = 0;
2733 hub->error = 0;
2736 /* deal with port status changes */
2737 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
2738 if (test_bit(i, hub->busy_bits))
2739 continue;
2740 connect_change = test_bit(i, hub->change_bits);
2741 if (!test_and_clear_bit(i, hub->event_bits) &&
2742 !connect_change && !hub->activating)
2743 continue;
2745 ret = hub_port_status(hub, i,
2746 &portstatus, &portchange);
2747 if (ret < 0)
2748 continue;
2750 if (hub->activating && !hdev->children[i-1] &&
2751 (portstatus &
2752 USB_PORT_STAT_CONNECTION))
2753 connect_change = 1;
2755 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2756 clear_port_feature(hdev, i,
2757 USB_PORT_FEAT_C_CONNECTION);
2758 connect_change = 1;
2761 if (portchange & USB_PORT_STAT_C_ENABLE) {
2762 if (!connect_change)
2763 dev_dbg (hub_dev,
2764 "port %d enable change, "
2765 "status %08x\n",
2766 i, portstatus);
2767 clear_port_feature(hdev, i,
2768 USB_PORT_FEAT_C_ENABLE);
2771 * EM interference sometimes causes badly
2772 * shielded USB devices to be shutdown by
2773 * the hub, this hack enables them again.
2774 * Works at least with mouse driver.
2776 if (!(portstatus & USB_PORT_STAT_ENABLE)
2777 && !connect_change
2778 && hdev->children[i-1]) {
2779 dev_err (hub_dev,
2780 "port %i "
2781 "disabled by hub (EMI?), "
2782 "re-enabling...\n",
2784 connect_change = 1;
2788 if (portchange & USB_PORT_STAT_C_SUSPEND) {
2789 clear_port_feature(hdev, i,
2790 USB_PORT_FEAT_C_SUSPEND);
2791 if (hdev->children[i-1]) {
2792 ret = remote_wakeup(hdev->
2793 children[i-1]);
2794 if (ret < 0)
2795 connect_change = 1;
2796 } else {
2797 ret = -ENODEV;
2798 hub_port_disable(hub, i, 1);
2800 dev_dbg (hub_dev,
2801 "resume on port %d, status %d\n",
2802 i, ret);
2805 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
2806 dev_err (hub_dev,
2807 "over-current change on port %d\n",
2809 clear_port_feature(hdev, i,
2810 USB_PORT_FEAT_C_OVER_CURRENT);
2811 hub_power_on(hub);
2814 if (portchange & USB_PORT_STAT_C_RESET) {
2815 dev_dbg (hub_dev,
2816 "reset change on port %d\n",
2818 clear_port_feature(hdev, i,
2819 USB_PORT_FEAT_C_RESET);
2822 if (connect_change)
2823 hub_port_connect_change(hub, i,
2824 portstatus, portchange);
2825 } /* end for i */
2827 /* deal with hub status changes */
2828 if (test_and_clear_bit(0, hub->event_bits) == 0)
2829 ; /* do nothing */
2830 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
2831 dev_err (hub_dev, "get_hub_status failed\n");
2832 else {
2833 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
2834 dev_dbg (hub_dev, "power change\n");
2835 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
2836 if (hubstatus & HUB_STATUS_LOCAL_POWER)
2837 /* FIXME: Is this always true? */
2838 hub->limited_power = 1;
2839 else
2840 hub->limited_power = 0;
2842 if (hubchange & HUB_CHANGE_OVERCURRENT) {
2843 dev_dbg (hub_dev, "overcurrent change\n");
2844 msleep(500); /* Cool down */
2845 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
2846 hub_power_on(hub);
2850 hub->activating = 0;
2852 /* If this is a root hub, tell the HCD it's okay to
2853 * re-enable port-change interrupts now. */
2854 if (!hdev->parent && !hub->busy_bits[0])
2855 usb_enable_root_hub_irq(hdev->bus);
2857 loop_autopm:
2858 /* Allow autosuspend if we're not going to run again */
2859 if (list_empty(&hub->event_list))
2860 usb_autopm_enable(intf);
2861 loop:
2862 usb_unlock_device(hdev);
2863 kref_put(&hub->kref, hub_release);
2865 } /* end while (1) */
2868 static int hub_thread(void *__unused)
2870 set_freezable();
2871 do {
2872 hub_events();
2873 wait_event_freezable(khubd_wait,
2874 !list_empty(&hub_event_list) ||
2875 kthread_should_stop());
2876 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
2878 pr_debug("%s: khubd exiting\n", usbcore_name);
2879 return 0;
2882 static struct usb_device_id hub_id_table [] = {
2883 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
2884 .bDeviceClass = USB_CLASS_HUB},
2885 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
2886 .bInterfaceClass = USB_CLASS_HUB},
2887 { } /* Terminating entry */
2890 MODULE_DEVICE_TABLE (usb, hub_id_table);
2892 static struct usb_driver hub_driver = {
2893 .name = "hub",
2894 .probe = hub_probe,
2895 .disconnect = hub_disconnect,
2896 .suspend = hub_suspend,
2897 .resume = hub_resume,
2898 .reset_resume = hub_reset_resume,
2899 .pre_reset = hub_pre_reset,
2900 .post_reset = hub_post_reset,
2901 .ioctl = hub_ioctl,
2902 .id_table = hub_id_table,
2903 .supports_autosuspend = 1,
2906 int usb_hub_init(void)
2908 if (usb_register(&hub_driver) < 0) {
2909 printk(KERN_ERR "%s: can't register hub driver\n",
2910 usbcore_name);
2911 return -1;
2914 khubd_task = kthread_run(hub_thread, NULL, "khubd");
2915 if (!IS_ERR(khubd_task))
2916 return 0;
2918 /* Fall through if kernel_thread failed */
2919 usb_deregister(&hub_driver);
2920 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
2922 return -1;
2925 void usb_hub_cleanup(void)
2927 kthread_stop(khubd_task);
2930 * Hub resources are freed for us by usb_deregister. It calls
2931 * usb_driver_purge on every device which in turn calls that
2932 * devices disconnect function if it is using this driver.
2933 * The hub_disconnect function takes care of releasing the
2934 * individual hub resources. -greg
2936 usb_deregister(&hub_driver);
2937 } /* usb_hub_cleanup() */
2939 static int config_descriptors_changed(struct usb_device *udev)
2941 unsigned index;
2942 unsigned len = 0;
2943 struct usb_config_descriptor *buf;
2945 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2946 if (len < le16_to_cpu(udev->config[index].desc.wTotalLength))
2947 len = le16_to_cpu(udev->config[index].desc.wTotalLength);
2949 buf = kmalloc (len, GFP_KERNEL);
2950 if (buf == NULL) {
2951 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
2952 /* assume the worst */
2953 return 1;
2955 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
2956 int length;
2957 int old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
2959 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
2960 old_length);
2961 if (length < old_length) {
2962 dev_dbg(&udev->dev, "config index %d, error %d\n",
2963 index, length);
2964 break;
2966 if (memcmp (buf, udev->rawdescriptors[index], old_length)
2967 != 0) {
2968 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
2969 index, buf->bConfigurationValue);
2970 break;
2973 kfree(buf);
2974 return index != udev->descriptor.bNumConfigurations;
2978 * usb_reset_device - perform a USB port reset to reinitialize a device
2979 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
2981 * WARNING - don't use this routine to reset a composite device
2982 * (one with multiple interfaces owned by separate drivers)!
2983 * Use usb_reset_composite_device() instead.
2985 * Do a port reset, reassign the device's address, and establish its
2986 * former operating configuration. If the reset fails, or the device's
2987 * descriptors change from their values before the reset, or the original
2988 * configuration and altsettings cannot be restored, a flag will be set
2989 * telling khubd to pretend the device has been disconnected and then
2990 * re-connected. All drivers will be unbound, and the device will be
2991 * re-enumerated and probed all over again.
2993 * Returns 0 if the reset succeeded, -ENODEV if the device has been
2994 * flagged for logical disconnection, or some other negative error code
2995 * if the reset wasn't even attempted.
2997 * The caller must own the device lock. For example, it's safe to use
2998 * this from a driver probe() routine after downloading new firmware.
2999 * For calls that might not occur during probe(), drivers should lock
3000 * the device using usb_lock_device_for_reset().
3002 * Locking exception: This routine may also be called from within an
3003 * autoresume handler. Such usage won't conflict with other tasks
3004 * holding the device lock because these tasks should always call
3005 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
3007 int usb_reset_device(struct usb_device *udev)
3009 struct usb_device *parent_hdev = udev->parent;
3010 struct usb_hub *parent_hub;
3011 struct usb_device_descriptor descriptor = udev->descriptor;
3012 int i, ret = 0;
3013 int port1 = udev->portnum;
3015 if (udev->state == USB_STATE_NOTATTACHED ||
3016 udev->state == USB_STATE_SUSPENDED) {
3017 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3018 udev->state);
3019 return -EINVAL;
3022 if (!parent_hdev) {
3023 /* this requires hcd-specific logic; see OHCI hc_restart() */
3024 dev_dbg(&udev->dev, "%s for root hub!\n", __FUNCTION__);
3025 return -EISDIR;
3027 parent_hub = hdev_to_hub(parent_hdev);
3029 set_bit(port1, parent_hub->busy_bits);
3030 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3032 /* ep0 maxpacket size may change; let the HCD know about it.
3033 * Other endpoints will be handled by re-enumeration. */
3034 ep0_reinit(udev);
3035 ret = hub_port_init(parent_hub, udev, port1, i);
3036 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
3037 break;
3039 clear_bit(port1, parent_hub->busy_bits);
3040 if (!parent_hdev->parent && !parent_hub->busy_bits[0])
3041 usb_enable_root_hub_irq(parent_hdev->bus);
3043 if (ret < 0)
3044 goto re_enumerate;
3046 /* Device might have changed firmware (DFU or similar) */
3047 if (memcmp(&udev->descriptor, &descriptor, sizeof descriptor)
3048 || config_descriptors_changed (udev)) {
3049 dev_info(&udev->dev, "device firmware changed\n");
3050 udev->descriptor = descriptor; /* for disconnect() calls */
3051 goto re_enumerate;
3054 if (!udev->actconfig)
3055 goto done;
3057 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3058 USB_REQ_SET_CONFIGURATION, 0,
3059 udev->actconfig->desc.bConfigurationValue, 0,
3060 NULL, 0, USB_CTRL_SET_TIMEOUT);
3061 if (ret < 0) {
3062 dev_err(&udev->dev,
3063 "can't restore configuration #%d (error=%d)\n",
3064 udev->actconfig->desc.bConfigurationValue, ret);
3065 goto re_enumerate;
3067 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3069 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3070 struct usb_interface *intf = udev->actconfig->interface[i];
3071 struct usb_interface_descriptor *desc;
3073 /* set_interface resets host side toggle even
3074 * for altsetting zero. the interface may have no driver.
3076 desc = &intf->cur_altsetting->desc;
3077 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3078 desc->bAlternateSetting);
3079 if (ret < 0) {
3080 dev_err(&udev->dev, "failed to restore interface %d "
3081 "altsetting %d (error=%d)\n",
3082 desc->bInterfaceNumber,
3083 desc->bAlternateSetting,
3084 ret);
3085 goto re_enumerate;
3089 done:
3090 return 0;
3092 re_enumerate:
3093 hub_port_logical_disconnect(parent_hub, port1);
3094 return -ENODEV;
3096 EXPORT_SYMBOL(usb_reset_device);
3099 * usb_reset_composite_device - warn interface drivers and perform a USB port reset
3100 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3101 * @iface: interface bound to the driver making the request (optional)
3103 * Warns all drivers bound to registered interfaces (using their pre_reset
3104 * method), performs the port reset, and then lets the drivers know that
3105 * the reset is over (using their post_reset method).
3107 * Return value is the same as for usb_reset_device().
3109 * The caller must own the device lock. For example, it's safe to use
3110 * this from a driver probe() routine after downloading new firmware.
3111 * For calls that might not occur during probe(), drivers should lock
3112 * the device using usb_lock_device_for_reset().
3114 * The interface locks are acquired during the pre_reset stage and released
3115 * during the post_reset stage. However if iface is not NULL and is
3116 * currently being probed, we assume that the caller already owns its
3117 * lock.
3119 int usb_reset_composite_device(struct usb_device *udev,
3120 struct usb_interface *iface)
3122 int ret;
3123 struct usb_host_config *config = udev->actconfig;
3125 if (udev->state == USB_STATE_NOTATTACHED ||
3126 udev->state == USB_STATE_SUSPENDED) {
3127 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3128 udev->state);
3129 return -EINVAL;
3132 /* Prevent autosuspend during the reset */
3133 usb_autoresume_device(udev);
3135 if (iface && iface->condition != USB_INTERFACE_BINDING)
3136 iface = NULL;
3138 if (config) {
3139 int i;
3140 struct usb_interface *cintf;
3141 struct usb_driver *drv;
3143 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
3144 cintf = config->interface[i];
3145 if (cintf != iface)
3146 down(&cintf->dev.sem);
3147 if (device_is_registered(&cintf->dev) &&
3148 cintf->dev.driver) {
3149 drv = to_usb_driver(cintf->dev.driver);
3150 if (drv->pre_reset)
3151 (drv->pre_reset)(cintf);
3152 /* FIXME: Unbind if pre_reset returns an error or isn't defined */
3157 ret = usb_reset_device(udev);
3159 if (config) {
3160 int i;
3161 struct usb_interface *cintf;
3162 struct usb_driver *drv;
3164 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
3165 cintf = config->interface[i];
3166 if (device_is_registered(&cintf->dev) &&
3167 cintf->dev.driver) {
3168 drv = to_usb_driver(cintf->dev.driver);
3169 if (drv->post_reset)
3170 (drv->post_reset)(cintf);
3171 /* FIXME: Unbind if post_reset returns an error or isn't defined */
3173 if (cintf != iface)
3174 up(&cintf->dev.sem);
3178 usb_autosuspend_device(udev);
3179 return ret;
3181 EXPORT_SYMBOL(usb_reset_composite_device);