USB: Disable auto-suspend for USB 3.0 hubs.
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / usb / core / hub.c
blob0968157f3beb4d28b87234ea87f4353bc34fcecc
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/usb/hcd.h>
23 #include <linux/usb/quirks.h>
24 #include <linux/kthread.h>
25 #include <linux/mutex.h>
26 #include <linux/freezer.h>
28 #include <asm/uaccess.h>
29 #include <asm/byteorder.h>
31 #include "usb.h"
33 /* if we are in debug mode, always announce new devices */
34 #ifdef DEBUG
35 #ifndef CONFIG_USB_ANNOUNCE_NEW_DEVICES
36 #define CONFIG_USB_ANNOUNCE_NEW_DEVICES
37 #endif
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 union {
49 struct usb_hub_status hub;
50 struct usb_port_status port;
51 } *status; /* buffer for status reports */
52 struct mutex status_mutex; /* for the status buffer */
54 int error; /* last reported error */
55 int nerrors; /* track consecutive errors */
57 struct list_head event_list; /* hubs w/data or errs ready */
58 unsigned long event_bits[1]; /* status change bitmask */
59 unsigned long change_bits[1]; /* ports with logical connect
60 status change */
61 unsigned long busy_bits[1]; /* ports being reset or
62 resumed */
63 unsigned long removed_bits[1]; /* ports with a "removed"
64 device present */
65 #if USB_MAXCHILDREN > 31 /* 8*sizeof(unsigned long) - 1 */
66 #error event_bits[] is too short!
67 #endif
69 struct usb_hub_descriptor *descriptor; /* class descriptor */
70 struct usb_tt tt; /* Transaction Translator */
72 unsigned mA_per_port; /* current for each child */
74 unsigned limited_power:1;
75 unsigned quiescing:1;
76 unsigned disconnected:1;
78 unsigned has_indicators:1;
79 u8 indicator[USB_MAXCHILDREN];
80 struct delayed_work leds;
81 struct delayed_work init_work;
82 void **port_owners;
85 static inline int hub_is_superspeed(struct usb_device *hdev)
87 return (hdev->descriptor.bDeviceProtocol == 3);
90 /* Protect struct usb_device->state and ->children members
91 * Note: Both are also protected by ->dev.sem, except that ->state can
92 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
93 static DEFINE_SPINLOCK(device_state_lock);
95 /* khubd's worklist and its lock */
96 static DEFINE_SPINLOCK(hub_event_lock);
97 static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
99 /* Wakes up khubd */
100 static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
102 static struct task_struct *khubd_task;
104 /* cycle leds on hubs that aren't blinking for attention */
105 static int blinkenlights = 0;
106 module_param (blinkenlights, bool, S_IRUGO);
107 MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
110 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
111 * 10 seconds to send reply for the initial 64-byte descriptor request.
113 /* define initial 64-byte descriptor request timeout in milliseconds */
114 static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
115 module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
116 MODULE_PARM_DESC(initial_descriptor_timeout,
117 "initial 64-byte descriptor request timeout in milliseconds "
118 "(default 5000 - 5.0 seconds)");
121 * As of 2.6.10 we introduce a new USB device initialization scheme which
122 * closely resembles the way Windows works. Hopefully it will be compatible
123 * with a wider range of devices than the old scheme. However some previously
124 * working devices may start giving rise to "device not accepting address"
125 * errors; if that happens the user can try the old scheme by adjusting the
126 * following module parameters.
128 * For maximum flexibility there are two boolean parameters to control the
129 * hub driver's behavior. On the first initialization attempt, if the
130 * "old_scheme_first" parameter is set then the old scheme will be used,
131 * otherwise the new scheme is used. If that fails and "use_both_schemes"
132 * is set, then the driver will make another attempt, using the other scheme.
134 static int old_scheme_first = 0;
135 module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
136 MODULE_PARM_DESC(old_scheme_first,
137 "start with the old device initialization scheme");
139 static int use_both_schemes = 1;
140 module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
141 MODULE_PARM_DESC(use_both_schemes,
142 "try the other device initialization scheme if the "
143 "first one fails");
145 /* Mutual exclusion for EHCI CF initialization. This interferes with
146 * port reset on some companion controllers.
148 DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
149 EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
151 #define HUB_DEBOUNCE_TIMEOUT 1500
152 #define HUB_DEBOUNCE_STEP 25
153 #define HUB_DEBOUNCE_STABLE 100
156 static int usb_reset_and_verify_device(struct usb_device *udev);
158 static inline char *portspeed(struct usb_hub *hub, int portstatus)
160 if (hub_is_superspeed(hub->hdev))
161 return "5.0 Gb/s";
162 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
163 return "480 Mb/s";
164 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
165 return "1.5 Mb/s";
166 else
167 return "12 Mb/s";
170 /* Note that hdev or one of its children must be locked! */
171 static struct usb_hub *hdev_to_hub(struct usb_device *hdev)
173 if (!hdev || !hdev->actconfig)
174 return NULL;
175 return usb_get_intfdata(hdev->actconfig->interface[0]);
178 /* USB 2.0 spec Section 11.24.4.5 */
179 static int get_hub_descriptor(struct usb_device *hdev, void *data)
181 int i, ret, size;
182 unsigned dtype;
184 if (hub_is_superspeed(hdev)) {
185 dtype = USB_DT_SS_HUB;
186 size = USB_DT_SS_HUB_SIZE;
187 } else {
188 dtype = USB_DT_HUB;
189 size = sizeof(struct usb_hub_descriptor);
192 for (i = 0; i < 3; i++) {
193 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
194 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
195 dtype << 8, 0, data, size,
196 USB_CTRL_GET_TIMEOUT);
197 if (ret >= (USB_DT_HUB_NONVAR_SIZE + 2))
198 return ret;
200 return -EINVAL;
204 * USB 2.0 spec Section 11.24.2.1
206 static int clear_hub_feature(struct usb_device *hdev, int feature)
208 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
209 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
213 * USB 2.0 spec Section 11.24.2.2
215 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
217 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
218 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
219 NULL, 0, 1000);
223 * USB 2.0 spec Section 11.24.2.13
225 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
227 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
228 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
229 NULL, 0, 1000);
233 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
234 * for info about using port indicators
236 static void set_port_led(
237 struct usb_hub *hub,
238 int port1,
239 int selector
242 int status = set_port_feature(hub->hdev, (selector << 8) | port1,
243 USB_PORT_FEAT_INDICATOR);
244 if (status < 0)
245 dev_dbg (hub->intfdev,
246 "port %d indicator %s status %d\n",
247 port1,
248 ({ char *s; switch (selector) {
249 case HUB_LED_AMBER: s = "amber"; break;
250 case HUB_LED_GREEN: s = "green"; break;
251 case HUB_LED_OFF: s = "off"; break;
252 case HUB_LED_AUTO: s = "auto"; break;
253 default: s = "??"; break;
254 }; s; }),
255 status);
258 #define LED_CYCLE_PERIOD ((2*HZ)/3)
260 static void led_work (struct work_struct *work)
262 struct usb_hub *hub =
263 container_of(work, struct usb_hub, leds.work);
264 struct usb_device *hdev = hub->hdev;
265 unsigned i;
266 unsigned changed = 0;
267 int cursor = -1;
269 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
270 return;
272 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
273 unsigned selector, mode;
275 /* 30%-50% duty cycle */
277 switch (hub->indicator[i]) {
278 /* cycle marker */
279 case INDICATOR_CYCLE:
280 cursor = i;
281 selector = HUB_LED_AUTO;
282 mode = INDICATOR_AUTO;
283 break;
284 /* blinking green = sw attention */
285 case INDICATOR_GREEN_BLINK:
286 selector = HUB_LED_GREEN;
287 mode = INDICATOR_GREEN_BLINK_OFF;
288 break;
289 case INDICATOR_GREEN_BLINK_OFF:
290 selector = HUB_LED_OFF;
291 mode = INDICATOR_GREEN_BLINK;
292 break;
293 /* blinking amber = hw attention */
294 case INDICATOR_AMBER_BLINK:
295 selector = HUB_LED_AMBER;
296 mode = INDICATOR_AMBER_BLINK_OFF;
297 break;
298 case INDICATOR_AMBER_BLINK_OFF:
299 selector = HUB_LED_OFF;
300 mode = INDICATOR_AMBER_BLINK;
301 break;
302 /* blink green/amber = reserved */
303 case INDICATOR_ALT_BLINK:
304 selector = HUB_LED_GREEN;
305 mode = INDICATOR_ALT_BLINK_OFF;
306 break;
307 case INDICATOR_ALT_BLINK_OFF:
308 selector = HUB_LED_AMBER;
309 mode = INDICATOR_ALT_BLINK;
310 break;
311 default:
312 continue;
314 if (selector != HUB_LED_AUTO)
315 changed = 1;
316 set_port_led(hub, i + 1, selector);
317 hub->indicator[i] = mode;
319 if (!changed && blinkenlights) {
320 cursor++;
321 cursor %= hub->descriptor->bNbrPorts;
322 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
323 hub->indicator[cursor] = INDICATOR_CYCLE;
324 changed++;
326 if (changed)
327 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
330 /* use a short timeout for hub/port status fetches */
331 #define USB_STS_TIMEOUT 1000
332 #define USB_STS_RETRIES 5
335 * USB 2.0 spec Section 11.24.2.6
337 static int get_hub_status(struct usb_device *hdev,
338 struct usb_hub_status *data)
340 int i, status = -ETIMEDOUT;
342 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
343 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
344 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
345 data, sizeof(*data), USB_STS_TIMEOUT);
347 return status;
351 * USB 2.0 spec Section 11.24.2.7
353 static int get_port_status(struct usb_device *hdev, int port1,
354 struct usb_port_status *data)
356 int i, status = -ETIMEDOUT;
358 for (i = 0; i < USB_STS_RETRIES && status == -ETIMEDOUT; i++) {
359 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
360 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
361 data, sizeof(*data), USB_STS_TIMEOUT);
363 return status;
366 static int hub_port_status(struct usb_hub *hub, int port1,
367 u16 *status, u16 *change)
369 int ret;
371 mutex_lock(&hub->status_mutex);
372 ret = get_port_status(hub->hdev, port1, &hub->status->port);
373 if (ret < 4) {
374 dev_err(hub->intfdev,
375 "%s failed (err = %d)\n", __func__, ret);
376 if (ret >= 0)
377 ret = -EIO;
378 } else {
379 *status = le16_to_cpu(hub->status->port.wPortStatus);
380 *change = le16_to_cpu(hub->status->port.wPortChange);
382 if ((hub->hdev->parent != NULL) &&
383 hub_is_superspeed(hub->hdev)) {
384 /* Translate the USB 3 port status */
385 u16 tmp = *status & USB_SS_PORT_STAT_MASK;
386 if (*status & USB_SS_PORT_STAT_POWER)
387 tmp |= USB_PORT_STAT_POWER;
388 *status = tmp;
391 ret = 0;
393 mutex_unlock(&hub->status_mutex);
394 return ret;
397 static void kick_khubd(struct usb_hub *hub)
399 unsigned long flags;
401 spin_lock_irqsave(&hub_event_lock, flags);
402 if (!hub->disconnected && list_empty(&hub->event_list)) {
403 list_add_tail(&hub->event_list, &hub_event_list);
405 /* Suppress autosuspend until khubd runs */
406 usb_autopm_get_interface_no_resume(
407 to_usb_interface(hub->intfdev));
408 wake_up(&khubd_wait);
410 spin_unlock_irqrestore(&hub_event_lock, flags);
413 void usb_kick_khubd(struct usb_device *hdev)
415 struct usb_hub *hub = hdev_to_hub(hdev);
417 if (hub)
418 kick_khubd(hub);
422 /* completion function, fires on port status changes and various faults */
423 static void hub_irq(struct urb *urb)
425 struct usb_hub *hub = urb->context;
426 int status = urb->status;
427 unsigned i;
428 unsigned long bits;
430 switch (status) {
431 case -ENOENT: /* synchronous unlink */
432 case -ECONNRESET: /* async unlink */
433 case -ESHUTDOWN: /* hardware going away */
434 return;
436 default: /* presumably an error */
437 /* Cause a hub reset after 10 consecutive errors */
438 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
439 if ((++hub->nerrors < 10) || hub->error)
440 goto resubmit;
441 hub->error = status;
442 /* FALL THROUGH */
444 /* let khubd handle things */
445 case 0: /* we got data: port status changed */
446 bits = 0;
447 for (i = 0; i < urb->actual_length; ++i)
448 bits |= ((unsigned long) ((*hub->buffer)[i]))
449 << (i*8);
450 hub->event_bits[0] = bits;
451 break;
454 hub->nerrors = 0;
456 /* Something happened, let khubd figure it out */
457 kick_khubd(hub);
459 resubmit:
460 if (hub->quiescing)
461 return;
463 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
464 && status != -ENODEV && status != -EPERM)
465 dev_err (hub->intfdev, "resubmit --> %d\n", status);
468 /* USB 2.0 spec Section 11.24.2.3 */
469 static inline int
470 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
472 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
473 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
474 tt, NULL, 0, 1000);
478 * enumeration blocks khubd for a long time. we use keventd instead, since
479 * long blocking there is the exception, not the rule. accordingly, HCDs
480 * talking to TTs must queue control transfers (not just bulk and iso), so
481 * both can talk to the same hub concurrently.
483 static void hub_tt_work(struct work_struct *work)
485 struct usb_hub *hub =
486 container_of(work, struct usb_hub, tt.clear_work);
487 unsigned long flags;
488 int limit = 100;
490 spin_lock_irqsave (&hub->tt.lock, flags);
491 while (--limit && !list_empty (&hub->tt.clear_list)) {
492 struct list_head *next;
493 struct usb_tt_clear *clear;
494 struct usb_device *hdev = hub->hdev;
495 const struct hc_driver *drv;
496 int status;
498 next = hub->tt.clear_list.next;
499 clear = list_entry (next, struct usb_tt_clear, clear_list);
500 list_del (&clear->clear_list);
502 /* drop lock so HCD can concurrently report other TT errors */
503 spin_unlock_irqrestore (&hub->tt.lock, flags);
504 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
505 if (status)
506 dev_err (&hdev->dev,
507 "clear tt %d (%04x) error %d\n",
508 clear->tt, clear->devinfo, status);
510 /* Tell the HCD, even if the operation failed */
511 drv = clear->hcd->driver;
512 if (drv->clear_tt_buffer_complete)
513 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
515 kfree(clear);
516 spin_lock_irqsave(&hub->tt.lock, flags);
518 spin_unlock_irqrestore (&hub->tt.lock, flags);
522 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
523 * @urb: an URB associated with the failed or incomplete split transaction
525 * High speed HCDs use this to tell the hub driver that some split control or
526 * bulk transaction failed in a way that requires clearing internal state of
527 * a transaction translator. This is normally detected (and reported) from
528 * interrupt context.
530 * It may not be possible for that hub to handle additional full (or low)
531 * speed transactions until that state is fully cleared out.
533 int usb_hub_clear_tt_buffer(struct urb *urb)
535 struct usb_device *udev = urb->dev;
536 int pipe = urb->pipe;
537 struct usb_tt *tt = udev->tt;
538 unsigned long flags;
539 struct usb_tt_clear *clear;
541 /* we've got to cope with an arbitrary number of pending TT clears,
542 * since each TT has "at least two" buffers that can need it (and
543 * there can be many TTs per hub). even if they're uncommon.
545 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
546 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
547 /* FIXME recover somehow ... RESET_TT? */
548 return -ENOMEM;
551 /* info that CLEAR_TT_BUFFER needs */
552 clear->tt = tt->multi ? udev->ttport : 1;
553 clear->devinfo = usb_pipeendpoint (pipe);
554 clear->devinfo |= udev->devnum << 4;
555 clear->devinfo |= usb_pipecontrol (pipe)
556 ? (USB_ENDPOINT_XFER_CONTROL << 11)
557 : (USB_ENDPOINT_XFER_BULK << 11);
558 if (usb_pipein (pipe))
559 clear->devinfo |= 1 << 15;
561 /* info for completion callback */
562 clear->hcd = bus_to_hcd(udev->bus);
563 clear->ep = urb->ep;
565 /* tell keventd to clear state for this TT */
566 spin_lock_irqsave (&tt->lock, flags);
567 list_add_tail (&clear->clear_list, &tt->clear_list);
568 schedule_work(&tt->clear_work);
569 spin_unlock_irqrestore (&tt->lock, flags);
570 return 0;
572 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
574 /* If do_delay is false, return the number of milliseconds the caller
575 * needs to delay.
577 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
579 int port1;
580 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
581 unsigned delay;
582 u16 wHubCharacteristics =
583 le16_to_cpu(hub->descriptor->wHubCharacteristics);
585 /* Enable power on each port. Some hubs have reserved values
586 * of LPSM (> 2) in their descriptors, even though they are
587 * USB 2.0 hubs. Some hubs do not implement port-power switching
588 * but only emulate it. In all cases, the ports won't work
589 * unless we send these messages to the hub.
591 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
592 dev_dbg(hub->intfdev, "enabling power on all ports\n");
593 else
594 dev_dbg(hub->intfdev, "trying to enable port power on "
595 "non-switchable hub\n");
596 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
597 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
599 /* Wait at least 100 msec for power to become stable */
600 delay = max(pgood_delay, (unsigned) 100);
601 if (do_delay)
602 msleep(delay);
603 return delay;
606 static int hub_hub_status(struct usb_hub *hub,
607 u16 *status, u16 *change)
609 int ret;
611 mutex_lock(&hub->status_mutex);
612 ret = get_hub_status(hub->hdev, &hub->status->hub);
613 if (ret < 0)
614 dev_err (hub->intfdev,
615 "%s failed (err = %d)\n", __func__, ret);
616 else {
617 *status = le16_to_cpu(hub->status->hub.wHubStatus);
618 *change = le16_to_cpu(hub->status->hub.wHubChange);
619 ret = 0;
621 mutex_unlock(&hub->status_mutex);
622 return ret;
625 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
627 struct usb_device *hdev = hub->hdev;
628 int ret = 0;
630 if (hdev->children[port1-1] && set_state)
631 usb_set_device_state(hdev->children[port1-1],
632 USB_STATE_NOTATTACHED);
633 if (!hub->error && !hub_is_superspeed(hub->hdev))
634 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
635 if (ret)
636 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
637 port1, ret);
638 return ret;
642 * Disable a port and mark a logical connect-change event, so that some
643 * time later khubd will disconnect() any existing usb_device on the port
644 * and will re-enumerate if there actually is a device attached.
646 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
648 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
649 hub_port_disable(hub, port1, 1);
651 /* FIXME let caller ask to power down the port:
652 * - some devices won't enumerate without a VBUS power cycle
653 * - SRP saves power that way
654 * - ... new call, TBD ...
655 * That's easy if this hub can switch power per-port, and
656 * khubd reactivates the port later (timer, SRP, etc).
657 * Powerdown must be optional, because of reset/DFU.
660 set_bit(port1, hub->change_bits);
661 kick_khubd(hub);
665 * usb_remove_device - disable a device's port on its parent hub
666 * @udev: device to be disabled and removed
667 * Context: @udev locked, must be able to sleep.
669 * After @udev's port has been disabled, khubd is notified and it will
670 * see that the device has been disconnected. When the device is
671 * physically unplugged and something is plugged in, the events will
672 * be received and processed normally.
674 int usb_remove_device(struct usb_device *udev)
676 struct usb_hub *hub;
677 struct usb_interface *intf;
679 if (!udev->parent) /* Can't remove a root hub */
680 return -EINVAL;
681 hub = hdev_to_hub(udev->parent);
682 intf = to_usb_interface(hub->intfdev);
684 usb_autopm_get_interface(intf);
685 set_bit(udev->portnum, hub->removed_bits);
686 hub_port_logical_disconnect(hub, udev->portnum);
687 usb_autopm_put_interface(intf);
688 return 0;
691 enum hub_activation_type {
692 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
693 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
696 static void hub_init_func2(struct work_struct *ws);
697 static void hub_init_func3(struct work_struct *ws);
699 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
701 struct usb_device *hdev = hub->hdev;
702 struct usb_hcd *hcd;
703 int ret;
704 int port1;
705 int status;
706 bool need_debounce_delay = false;
707 unsigned delay;
709 /* Continue a partial initialization */
710 if (type == HUB_INIT2)
711 goto init2;
712 if (type == HUB_INIT3)
713 goto init3;
715 /* After a resume, port power should still be on.
716 * For any other type of activation, turn it on.
718 if (type != HUB_RESUME) {
720 /* Speed up system boot by using a delayed_work for the
721 * hub's initial power-up delays. This is pretty awkward
722 * and the implementation looks like a home-brewed sort of
723 * setjmp/longjmp, but it saves at least 100 ms for each
724 * root hub (assuming usbcore is compiled into the kernel
725 * rather than as a module). It adds up.
727 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
728 * because for those activation types the ports have to be
729 * operational when we return. In theory this could be done
730 * for HUB_POST_RESET, but it's easier not to.
732 if (type == HUB_INIT) {
733 delay = hub_power_on(hub, false);
734 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
735 schedule_delayed_work(&hub->init_work,
736 msecs_to_jiffies(delay));
738 /* Suppress autosuspend until init is done */
739 usb_autopm_get_interface_no_resume(
740 to_usb_interface(hub->intfdev));
741 return; /* Continues at init2: below */
742 } else if (type == HUB_RESET_RESUME) {
743 /* The internal host controller state for the hub device
744 * may be gone after a host power loss on system resume.
745 * Update the device's info so the HW knows it's a hub.
747 hcd = bus_to_hcd(hdev->bus);
748 if (hcd->driver->update_hub_device) {
749 ret = hcd->driver->update_hub_device(hcd, hdev,
750 &hub->tt, GFP_NOIO);
751 if (ret < 0) {
752 dev_err(hub->intfdev, "Host not "
753 "accepting hub info "
754 "update.\n");
755 dev_err(hub->intfdev, "LS/FS devices "
756 "and hubs may not work "
757 "under this hub\n.");
760 hub_power_on(hub, true);
761 } else {
762 hub_power_on(hub, true);
765 init2:
767 /* Check each port and set hub->change_bits to let khubd know
768 * which ports need attention.
770 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
771 struct usb_device *udev = hdev->children[port1-1];
772 u16 portstatus, portchange;
774 portstatus = portchange = 0;
775 status = hub_port_status(hub, port1, &portstatus, &portchange);
776 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
777 dev_dbg(hub->intfdev,
778 "port %d: status %04x change %04x\n",
779 port1, portstatus, portchange);
781 /* After anything other than HUB_RESUME (i.e., initialization
782 * or any sort of reset), every port should be disabled.
783 * Unconnected ports should likewise be disabled (paranoia),
784 * and so should ports for which we have no usb_device.
786 if ((portstatus & USB_PORT_STAT_ENABLE) && (
787 type != HUB_RESUME ||
788 !(portstatus & USB_PORT_STAT_CONNECTION) ||
789 !udev ||
790 udev->state == USB_STATE_NOTATTACHED)) {
792 * USB3 protocol ports will automatically transition
793 * to Enabled state when detect an USB3.0 device attach.
794 * Do not disable USB3 protocol ports.
796 if (!hub_is_superspeed(hdev)) {
797 clear_port_feature(hdev, port1,
798 USB_PORT_FEAT_ENABLE);
799 portstatus &= ~USB_PORT_STAT_ENABLE;
800 } else {
801 /* Pretend that power was lost for USB3 devs */
802 portstatus &= ~USB_PORT_STAT_ENABLE;
806 /* Clear status-change flags; we'll debounce later */
807 if (portchange & USB_PORT_STAT_C_CONNECTION) {
808 need_debounce_delay = true;
809 clear_port_feature(hub->hdev, port1,
810 USB_PORT_FEAT_C_CONNECTION);
812 if (portchange & USB_PORT_STAT_C_ENABLE) {
813 need_debounce_delay = true;
814 clear_port_feature(hub->hdev, port1,
815 USB_PORT_FEAT_C_ENABLE);
817 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
818 need_debounce_delay = true;
819 clear_port_feature(hub->hdev, port1,
820 USB_PORT_FEAT_C_PORT_LINK_STATE);
823 /* We can forget about a "removed" device when there's a
824 * physical disconnect or the connect status changes.
826 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
827 (portchange & USB_PORT_STAT_C_CONNECTION))
828 clear_bit(port1, hub->removed_bits);
830 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
831 /* Tell khubd to disconnect the device or
832 * check for a new connection
834 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
835 set_bit(port1, hub->change_bits);
837 } else if (portstatus & USB_PORT_STAT_ENABLE) {
838 /* The power session apparently survived the resume.
839 * If there was an overcurrent or suspend change
840 * (i.e., remote wakeup request), have khubd
841 * take care of it.
843 if (portchange)
844 set_bit(port1, hub->change_bits);
846 } else if (udev->persist_enabled) {
847 #ifdef CONFIG_PM
848 udev->reset_resume = 1;
849 #endif
850 set_bit(port1, hub->change_bits);
852 } else {
853 /* The power session is gone; tell khubd */
854 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
855 set_bit(port1, hub->change_bits);
859 /* If no port-status-change flags were set, we don't need any
860 * debouncing. If flags were set we can try to debounce the
861 * ports all at once right now, instead of letting khubd do them
862 * one at a time later on.
864 * If any port-status changes do occur during this delay, khubd
865 * will see them later and handle them normally.
867 if (need_debounce_delay) {
868 delay = HUB_DEBOUNCE_STABLE;
870 /* Don't do a long sleep inside a workqueue routine */
871 if (type == HUB_INIT2) {
872 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
873 schedule_delayed_work(&hub->init_work,
874 msecs_to_jiffies(delay));
875 return; /* Continues at init3: below */
876 } else {
877 msleep(delay);
880 init3:
881 hub->quiescing = 0;
883 status = usb_submit_urb(hub->urb, GFP_NOIO);
884 if (status < 0)
885 dev_err(hub->intfdev, "activate --> %d\n", status);
886 if (hub->has_indicators && blinkenlights)
887 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
889 /* Scan all ports that need attention */
890 kick_khubd(hub);
892 /* Allow autosuspend if it was suppressed */
893 if (type <= HUB_INIT3)
894 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
897 /* Implement the continuations for the delays above */
898 static void hub_init_func2(struct work_struct *ws)
900 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
902 hub_activate(hub, HUB_INIT2);
905 static void hub_init_func3(struct work_struct *ws)
907 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
909 hub_activate(hub, HUB_INIT3);
912 enum hub_quiescing_type {
913 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
916 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
918 struct usb_device *hdev = hub->hdev;
919 int i;
921 cancel_delayed_work_sync(&hub->init_work);
923 /* khubd and related activity won't re-trigger */
924 hub->quiescing = 1;
926 if (type != HUB_SUSPEND) {
927 /* Disconnect all the children */
928 for (i = 0; i < hdev->maxchild; ++i) {
929 if (hdev->children[i])
930 usb_disconnect(&hdev->children[i]);
934 /* Stop khubd and related activity */
935 usb_kill_urb(hub->urb);
936 if (hub->has_indicators)
937 cancel_delayed_work_sync(&hub->leds);
938 if (hub->tt.hub)
939 cancel_work_sync(&hub->tt.clear_work);
942 /* caller has locked the hub device */
943 static int hub_pre_reset(struct usb_interface *intf)
945 struct usb_hub *hub = usb_get_intfdata(intf);
947 hub_quiesce(hub, HUB_PRE_RESET);
948 return 0;
951 /* caller has locked the hub device */
952 static int hub_post_reset(struct usb_interface *intf)
954 struct usb_hub *hub = usb_get_intfdata(intf);
956 hub_activate(hub, HUB_POST_RESET);
957 return 0;
960 static int hub_configure(struct usb_hub *hub,
961 struct usb_endpoint_descriptor *endpoint)
963 struct usb_hcd *hcd;
964 struct usb_device *hdev = hub->hdev;
965 struct device *hub_dev = hub->intfdev;
966 u16 hubstatus, hubchange;
967 u16 wHubCharacteristics;
968 unsigned int pipe;
969 int maxp, ret;
970 char *message = "out of memory";
972 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
973 if (!hub->buffer) {
974 ret = -ENOMEM;
975 goto fail;
978 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
979 if (!hub->status) {
980 ret = -ENOMEM;
981 goto fail;
983 mutex_init(&hub->status_mutex);
985 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
986 if (!hub->descriptor) {
987 ret = -ENOMEM;
988 goto fail;
991 if (hub_is_superspeed(hdev) && (hdev->parent != NULL)) {
992 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
993 HUB_SET_DEPTH, USB_RT_HUB,
994 hdev->level - 1, 0, NULL, 0,
995 USB_CTRL_SET_TIMEOUT);
997 if (ret < 0) {
998 message = "can't set hub depth";
999 goto fail;
1003 /* Request the entire hub descriptor.
1004 * hub->descriptor can handle USB_MAXCHILDREN ports,
1005 * but the hub can/will return fewer bytes here.
1007 ret = get_hub_descriptor(hdev, hub->descriptor);
1008 if (ret < 0) {
1009 message = "can't read hub descriptor";
1010 goto fail;
1011 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1012 message = "hub has too many ports!";
1013 ret = -ENODEV;
1014 goto fail;
1017 hdev->maxchild = hub->descriptor->bNbrPorts;
1018 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
1019 (hdev->maxchild == 1) ? "" : "s");
1021 hub->port_owners = kzalloc(hdev->maxchild * sizeof(void *), GFP_KERNEL);
1022 if (!hub->port_owners) {
1023 ret = -ENOMEM;
1024 goto fail;
1027 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1029 /* FIXME for USB 3.0, skip for now */
1030 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1031 !(hub_is_superspeed(hdev))) {
1032 int i;
1033 char portstr [USB_MAXCHILDREN + 1];
1035 for (i = 0; i < hdev->maxchild; i++)
1036 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1037 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1038 ? 'F' : 'R';
1039 portstr[hdev->maxchild] = 0;
1040 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1041 } else
1042 dev_dbg(hub_dev, "standalone hub\n");
1044 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1045 case 0x00:
1046 dev_dbg(hub_dev, "ganged power switching\n");
1047 break;
1048 case 0x01:
1049 dev_dbg(hub_dev, "individual port power switching\n");
1050 break;
1051 case 0x02:
1052 case 0x03:
1053 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1054 break;
1057 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1058 case 0x00:
1059 dev_dbg(hub_dev, "global over-current protection\n");
1060 break;
1061 case 0x08:
1062 dev_dbg(hub_dev, "individual port over-current protection\n");
1063 break;
1064 case 0x10:
1065 case 0x18:
1066 dev_dbg(hub_dev, "no over-current protection\n");
1067 break;
1070 spin_lock_init (&hub->tt.lock);
1071 INIT_LIST_HEAD (&hub->tt.clear_list);
1072 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1073 switch (hdev->descriptor.bDeviceProtocol) {
1074 case 0:
1075 break;
1076 case 1:
1077 dev_dbg(hub_dev, "Single TT\n");
1078 hub->tt.hub = hdev;
1079 break;
1080 case 2:
1081 ret = usb_set_interface(hdev, 0, 1);
1082 if (ret == 0) {
1083 dev_dbg(hub_dev, "TT per port\n");
1084 hub->tt.multi = 1;
1085 } else
1086 dev_err(hub_dev, "Using single TT (err %d)\n",
1087 ret);
1088 hub->tt.hub = hdev;
1089 break;
1090 case 3:
1091 /* USB 3.0 hubs don't have a TT */
1092 break;
1093 default:
1094 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1095 hdev->descriptor.bDeviceProtocol);
1096 break;
1099 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1100 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1101 case HUB_TTTT_8_BITS:
1102 if (hdev->descriptor.bDeviceProtocol != 0) {
1103 hub->tt.think_time = 666;
1104 dev_dbg(hub_dev, "TT requires at most %d "
1105 "FS bit times (%d ns)\n",
1106 8, hub->tt.think_time);
1108 break;
1109 case HUB_TTTT_16_BITS:
1110 hub->tt.think_time = 666 * 2;
1111 dev_dbg(hub_dev, "TT requires at most %d "
1112 "FS bit times (%d ns)\n",
1113 16, hub->tt.think_time);
1114 break;
1115 case HUB_TTTT_24_BITS:
1116 hub->tt.think_time = 666 * 3;
1117 dev_dbg(hub_dev, "TT requires at most %d "
1118 "FS bit times (%d ns)\n",
1119 24, hub->tt.think_time);
1120 break;
1121 case HUB_TTTT_32_BITS:
1122 hub->tt.think_time = 666 * 4;
1123 dev_dbg(hub_dev, "TT requires at most %d "
1124 "FS bit times (%d ns)\n",
1125 32, hub->tt.think_time);
1126 break;
1129 /* probe() zeroes hub->indicator[] */
1130 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1131 hub->has_indicators = 1;
1132 dev_dbg(hub_dev, "Port indicators are supported\n");
1135 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1136 hub->descriptor->bPwrOn2PwrGood * 2);
1138 /* power budgeting mostly matters with bus-powered hubs,
1139 * and battery-powered root hubs (may provide just 8 mA).
1141 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1142 if (ret < 2) {
1143 message = "can't get hub status";
1144 goto fail;
1146 le16_to_cpus(&hubstatus);
1147 if (hdev == hdev->bus->root_hub) {
1148 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
1149 hub->mA_per_port = 500;
1150 else {
1151 hub->mA_per_port = hdev->bus_mA;
1152 hub->limited_power = 1;
1154 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1155 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1156 hub->descriptor->bHubContrCurrent);
1157 hub->limited_power = 1;
1158 if (hdev->maxchild > 0) {
1159 int remaining = hdev->bus_mA -
1160 hub->descriptor->bHubContrCurrent;
1162 if (remaining < hdev->maxchild * 100)
1163 dev_warn(hub_dev,
1164 "insufficient power available "
1165 "to use all downstream ports\n");
1166 hub->mA_per_port = 100; /* 7.2.1.1 */
1168 } else { /* Self-powered external hub */
1169 /* FIXME: What about battery-powered external hubs that
1170 * provide less current per port? */
1171 hub->mA_per_port = 500;
1173 if (hub->mA_per_port < 500)
1174 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1175 hub->mA_per_port);
1177 /* Update the HCD's internal representation of this hub before khubd
1178 * starts getting port status changes for devices under the hub.
1180 hcd = bus_to_hcd(hdev->bus);
1181 if (hcd->driver->update_hub_device) {
1182 ret = hcd->driver->update_hub_device(hcd, hdev,
1183 &hub->tt, GFP_KERNEL);
1184 if (ret < 0) {
1185 message = "can't update HCD hub info";
1186 goto fail;
1190 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1191 if (ret < 0) {
1192 message = "can't get hub status";
1193 goto fail;
1196 /* local power status reports aren't always correct */
1197 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1198 dev_dbg(hub_dev, "local power source is %s\n",
1199 (hubstatus & HUB_STATUS_LOCAL_POWER)
1200 ? "lost (inactive)" : "good");
1202 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1203 dev_dbg(hub_dev, "%sover-current condition exists\n",
1204 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1206 /* set up the interrupt endpoint
1207 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1208 * bytes as USB2.0[11.12.3] says because some hubs are known
1209 * to send more data (and thus cause overflow). For root hubs,
1210 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1211 * to be big enough for at least USB_MAXCHILDREN ports. */
1212 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1213 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1215 if (maxp > sizeof(*hub->buffer))
1216 maxp = sizeof(*hub->buffer);
1218 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1219 if (!hub->urb) {
1220 ret = -ENOMEM;
1221 goto fail;
1224 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1225 hub, endpoint->bInterval);
1227 /* maybe cycle the hub leds */
1228 if (hub->has_indicators && blinkenlights)
1229 hub->indicator [0] = INDICATOR_CYCLE;
1231 hub_activate(hub, HUB_INIT);
1232 return 0;
1234 fail:
1235 dev_err (hub_dev, "config failed, %s (err %d)\n",
1236 message, ret);
1237 /* hub_disconnect() frees urb and descriptor */
1238 return ret;
1241 static void hub_release(struct kref *kref)
1243 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1245 usb_put_intf(to_usb_interface(hub->intfdev));
1246 kfree(hub);
1249 static unsigned highspeed_hubs;
1251 static void hub_disconnect(struct usb_interface *intf)
1253 struct usb_hub *hub = usb_get_intfdata (intf);
1255 /* Take the hub off the event list and don't let it be added again */
1256 spin_lock_irq(&hub_event_lock);
1257 if (!list_empty(&hub->event_list)) {
1258 list_del_init(&hub->event_list);
1259 usb_autopm_put_interface_no_suspend(intf);
1261 hub->disconnected = 1;
1262 spin_unlock_irq(&hub_event_lock);
1264 /* Disconnect all children and quiesce the hub */
1265 hub->error = 0;
1266 hub_quiesce(hub, HUB_DISCONNECT);
1268 usb_set_intfdata (intf, NULL);
1269 hub->hdev->maxchild = 0;
1271 if (hub->hdev->speed == USB_SPEED_HIGH)
1272 highspeed_hubs--;
1274 usb_free_urb(hub->urb);
1275 kfree(hub->port_owners);
1276 kfree(hub->descriptor);
1277 kfree(hub->status);
1278 kfree(hub->buffer);
1280 kref_put(&hub->kref, hub_release);
1283 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1285 struct usb_host_interface *desc;
1286 struct usb_endpoint_descriptor *endpoint;
1287 struct usb_device *hdev;
1288 struct usb_hub *hub;
1290 desc = intf->cur_altsetting;
1291 hdev = interface_to_usbdev(intf);
1293 /* Hubs have proper suspend/resume support. USB 3.0 device suspend is
1294 * different from USB 2.0/1.1 device suspend, and unfortunately we
1295 * don't support it yet. So leave autosuspend disabled for USB 3.0
1296 * external hubs for now. Enable autosuspend for USB 3.0 roothubs,
1297 * since that isn't a "real" hub.
1299 if (!hub_is_superspeed(hdev) || !hdev->parent)
1300 usb_enable_autosuspend(hdev);
1302 if (hdev->level == MAX_TOPO_LEVEL) {
1303 dev_err(&intf->dev,
1304 "Unsupported bus topology: hub nested too deep\n");
1305 return -E2BIG;
1308 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1309 if (hdev->parent) {
1310 dev_warn(&intf->dev, "ignoring external hub\n");
1311 return -ENODEV;
1313 #endif
1315 /* Some hubs have a subclass of 1, which AFAICT according to the */
1316 /* specs is not defined, but it works */
1317 if ((desc->desc.bInterfaceSubClass != 0) &&
1318 (desc->desc.bInterfaceSubClass != 1)) {
1319 descriptor_error:
1320 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1321 return -EIO;
1324 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1325 if (desc->desc.bNumEndpoints != 1)
1326 goto descriptor_error;
1328 endpoint = &desc->endpoint[0].desc;
1330 /* If it's not an interrupt in endpoint, we'd better punt! */
1331 if (!usb_endpoint_is_int_in(endpoint))
1332 goto descriptor_error;
1334 /* We found a hub */
1335 dev_info (&intf->dev, "USB hub found\n");
1337 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1338 if (!hub) {
1339 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1340 return -ENOMEM;
1343 kref_init(&hub->kref);
1344 INIT_LIST_HEAD(&hub->event_list);
1345 hub->intfdev = &intf->dev;
1346 hub->hdev = hdev;
1347 INIT_DELAYED_WORK(&hub->leds, led_work);
1348 INIT_DELAYED_WORK(&hub->init_work, NULL);
1349 usb_get_intf(intf);
1351 usb_set_intfdata (intf, hub);
1352 intf->needs_remote_wakeup = 1;
1354 if (hdev->speed == USB_SPEED_HIGH)
1355 highspeed_hubs++;
1357 if (hub_configure(hub, endpoint) >= 0)
1358 return 0;
1360 hub_disconnect (intf);
1361 return -ENODEV;
1364 /* No BKL needed */
1365 static int
1366 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1368 struct usb_device *hdev = interface_to_usbdev (intf);
1370 /* assert ifno == 0 (part of hub spec) */
1371 switch (code) {
1372 case USBDEVFS_HUB_PORTINFO: {
1373 struct usbdevfs_hub_portinfo *info = user_data;
1374 int i;
1376 spin_lock_irq(&device_state_lock);
1377 if (hdev->devnum <= 0)
1378 info->nports = 0;
1379 else {
1380 info->nports = hdev->maxchild;
1381 for (i = 0; i < info->nports; i++) {
1382 if (hdev->children[i] == NULL)
1383 info->port[i] = 0;
1384 else
1385 info->port[i] =
1386 hdev->children[i]->devnum;
1389 spin_unlock_irq(&device_state_lock);
1391 return info->nports + 1;
1394 default:
1395 return -ENOSYS;
1400 * Allow user programs to claim ports on a hub. When a device is attached
1401 * to one of these "claimed" ports, the program will "own" the device.
1403 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1404 void ***ppowner)
1406 if (hdev->state == USB_STATE_NOTATTACHED)
1407 return -ENODEV;
1408 if (port1 == 0 || port1 > hdev->maxchild)
1409 return -EINVAL;
1411 /* This assumes that devices not managed by the hub driver
1412 * will always have maxchild equal to 0.
1414 *ppowner = &(hdev_to_hub(hdev)->port_owners[port1 - 1]);
1415 return 0;
1418 /* In the following three functions, the caller must hold hdev's lock */
1419 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1, void *owner)
1421 int rc;
1422 void **powner;
1424 rc = find_port_owner(hdev, port1, &powner);
1425 if (rc)
1426 return rc;
1427 if (*powner)
1428 return -EBUSY;
1429 *powner = owner;
1430 return rc;
1433 int usb_hub_release_port(struct usb_device *hdev, unsigned port1, void *owner)
1435 int rc;
1436 void **powner;
1438 rc = find_port_owner(hdev, port1, &powner);
1439 if (rc)
1440 return rc;
1441 if (*powner != owner)
1442 return -ENOENT;
1443 *powner = NULL;
1444 return rc;
1447 void usb_hub_release_all_ports(struct usb_device *hdev, void *owner)
1449 int n;
1450 void **powner;
1452 n = find_port_owner(hdev, 1, &powner);
1453 if (n == 0) {
1454 for (; n < hdev->maxchild; (++n, ++powner)) {
1455 if (*powner == owner)
1456 *powner = NULL;
1461 /* The caller must hold udev's lock */
1462 bool usb_device_is_owned(struct usb_device *udev)
1464 struct usb_hub *hub;
1466 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1467 return false;
1468 hub = hdev_to_hub(udev->parent);
1469 return !!hub->port_owners[udev->portnum - 1];
1473 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1475 int i;
1477 for (i = 0; i < udev->maxchild; ++i) {
1478 if (udev->children[i])
1479 recursively_mark_NOTATTACHED(udev->children[i]);
1481 if (udev->state == USB_STATE_SUSPENDED)
1482 udev->active_duration -= jiffies;
1483 udev->state = USB_STATE_NOTATTACHED;
1487 * usb_set_device_state - change a device's current state (usbcore, hcds)
1488 * @udev: pointer to device whose state should be changed
1489 * @new_state: new state value to be stored
1491 * udev->state is _not_ fully protected by the device lock. Although
1492 * most transitions are made only while holding the lock, the state can
1493 * can change to USB_STATE_NOTATTACHED at almost any time. This
1494 * is so that devices can be marked as disconnected as soon as possible,
1495 * without having to wait for any semaphores to be released. As a result,
1496 * all changes to any device's state must be protected by the
1497 * device_state_lock spinlock.
1499 * Once a device has been added to the device tree, all changes to its state
1500 * should be made using this routine. The state should _not_ be set directly.
1502 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1503 * Otherwise udev->state is set to new_state, and if new_state is
1504 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1505 * to USB_STATE_NOTATTACHED.
1507 void usb_set_device_state(struct usb_device *udev,
1508 enum usb_device_state new_state)
1510 unsigned long flags;
1512 spin_lock_irqsave(&device_state_lock, flags);
1513 if (udev->state == USB_STATE_NOTATTACHED)
1514 ; /* do nothing */
1515 else if (new_state != USB_STATE_NOTATTACHED) {
1517 /* root hub wakeup capabilities are managed out-of-band
1518 * and may involve silicon errata ... ignore them here.
1520 if (udev->parent) {
1521 if (udev->state == USB_STATE_SUSPENDED
1522 || new_state == USB_STATE_SUSPENDED)
1523 ; /* No change to wakeup settings */
1524 else if (new_state == USB_STATE_CONFIGURED)
1525 device_set_wakeup_capable(&udev->dev,
1526 (udev->actconfig->desc.bmAttributes
1527 & USB_CONFIG_ATT_WAKEUP));
1528 else
1529 device_set_wakeup_capable(&udev->dev, 0);
1531 if (udev->state == USB_STATE_SUSPENDED &&
1532 new_state != USB_STATE_SUSPENDED)
1533 udev->active_duration -= jiffies;
1534 else if (new_state == USB_STATE_SUSPENDED &&
1535 udev->state != USB_STATE_SUSPENDED)
1536 udev->active_duration += jiffies;
1537 udev->state = new_state;
1538 } else
1539 recursively_mark_NOTATTACHED(udev);
1540 spin_unlock_irqrestore(&device_state_lock, flags);
1542 EXPORT_SYMBOL_GPL(usb_set_device_state);
1545 * Choose a device number.
1547 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1548 * USB-2.0 buses they are also used as device addresses, however on
1549 * USB-3.0 buses the address is assigned by the controller hardware
1550 * and it usually is not the same as the device number.
1552 * WUSB devices are simple: they have no hubs behind, so the mapping
1553 * device <-> virtual port number becomes 1:1. Why? to simplify the
1554 * life of the device connection logic in
1555 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1556 * handshake we need to assign a temporary address in the unauthorized
1557 * space. For simplicity we use the first virtual port number found to
1558 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1559 * and that becomes it's address [X < 128] or its unauthorized address
1560 * [X | 0x80].
1562 * We add 1 as an offset to the one-based USB-stack port number
1563 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1564 * 0 is reserved by USB for default address; (b) Linux's USB stack
1565 * uses always #1 for the root hub of the controller. So USB stack's
1566 * port #1, which is wusb virtual-port #0 has address #2.
1568 * Devices connected under xHCI are not as simple. The host controller
1569 * supports virtualization, so the hardware assigns device addresses and
1570 * the HCD must setup data structures before issuing a set address
1571 * command to the hardware.
1573 static void choose_devnum(struct usb_device *udev)
1575 int devnum;
1576 struct usb_bus *bus = udev->bus;
1578 /* If khubd ever becomes multithreaded, this will need a lock */
1579 if (udev->wusb) {
1580 devnum = udev->portnum + 1;
1581 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1582 } else {
1583 /* Try to allocate the next devnum beginning at
1584 * bus->devnum_next. */
1585 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1586 bus->devnum_next);
1587 if (devnum >= 128)
1588 devnum = find_next_zero_bit(bus->devmap.devicemap,
1589 128, 1);
1590 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1592 if (devnum < 128) {
1593 set_bit(devnum, bus->devmap.devicemap);
1594 udev->devnum = devnum;
1598 static void release_devnum(struct usb_device *udev)
1600 if (udev->devnum > 0) {
1601 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1602 udev->devnum = -1;
1606 static void update_devnum(struct usb_device *udev, int devnum)
1608 /* The address for a WUSB device is managed by wusbcore. */
1609 if (!udev->wusb)
1610 udev->devnum = devnum;
1613 static void hub_free_dev(struct usb_device *udev)
1615 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1617 /* Root hubs aren't real devices, so don't free HCD resources */
1618 if (hcd->driver->free_dev && udev->parent)
1619 hcd->driver->free_dev(hcd, udev);
1623 * usb_disconnect - disconnect a device (usbcore-internal)
1624 * @pdev: pointer to device being disconnected
1625 * Context: !in_interrupt ()
1627 * Something got disconnected. Get rid of it and all of its children.
1629 * If *pdev is a normal device then the parent hub must already be locked.
1630 * If *pdev is a root hub then this routine will acquire the
1631 * usb_bus_list_lock on behalf of the caller.
1633 * Only hub drivers (including virtual root hub drivers for host
1634 * controllers) should ever call this.
1636 * This call is synchronous, and may not be used in an interrupt context.
1638 void usb_disconnect(struct usb_device **pdev)
1640 struct usb_device *udev = *pdev;
1641 int i;
1643 if (!udev) {
1644 pr_debug ("%s nodev\n", __func__);
1645 return;
1648 /* mark the device as inactive, so any further urb submissions for
1649 * this device (and any of its children) will fail immediately.
1650 * this quiesces everyting except pending urbs.
1652 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1653 dev_info(&udev->dev, "USB disconnect, device number %d\n",
1654 udev->devnum);
1656 usb_lock_device(udev);
1658 /* Free up all the children before we remove this device */
1659 for (i = 0; i < USB_MAXCHILDREN; i++) {
1660 if (udev->children[i])
1661 usb_disconnect(&udev->children[i]);
1664 /* deallocate hcd/hardware state ... nuking all pending urbs and
1665 * cleaning up all state associated with the current configuration
1666 * so that the hardware is now fully quiesced.
1668 dev_dbg (&udev->dev, "unregistering device\n");
1669 usb_disable_device(udev, 0);
1670 usb_hcd_synchronize_unlinks(udev);
1672 usb_remove_ep_devs(&udev->ep0);
1673 usb_unlock_device(udev);
1675 /* Unregister the device. The device driver is responsible
1676 * for de-configuring the device and invoking the remove-device
1677 * notifier chain (used by usbfs and possibly others).
1679 device_del(&udev->dev);
1681 /* Free the device number and delete the parent's children[]
1682 * (or root_hub) pointer.
1684 release_devnum(udev);
1686 /* Avoid races with recursively_mark_NOTATTACHED() */
1687 spin_lock_irq(&device_state_lock);
1688 *pdev = NULL;
1689 spin_unlock_irq(&device_state_lock);
1691 hub_free_dev(udev);
1693 put_device(&udev->dev);
1696 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1697 static void show_string(struct usb_device *udev, char *id, char *string)
1699 if (!string)
1700 return;
1701 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1704 static void announce_device(struct usb_device *udev)
1706 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1707 le16_to_cpu(udev->descriptor.idVendor),
1708 le16_to_cpu(udev->descriptor.idProduct));
1709 dev_info(&udev->dev,
1710 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1711 udev->descriptor.iManufacturer,
1712 udev->descriptor.iProduct,
1713 udev->descriptor.iSerialNumber);
1714 show_string(udev, "Product", udev->product);
1715 show_string(udev, "Manufacturer", udev->manufacturer);
1716 show_string(udev, "SerialNumber", udev->serial);
1718 #else
1719 static inline void announce_device(struct usb_device *udev) { }
1720 #endif
1722 #ifdef CONFIG_USB_OTG
1723 #include "otg_whitelist.h"
1724 #endif
1727 * usb_enumerate_device_otg - FIXME (usbcore-internal)
1728 * @udev: newly addressed device (in ADDRESS state)
1730 * Finish enumeration for On-The-Go devices
1732 static int usb_enumerate_device_otg(struct usb_device *udev)
1734 int err = 0;
1736 #ifdef CONFIG_USB_OTG
1738 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1739 * to wake us after we've powered off VBUS; and HNP, switching roles
1740 * "host" to "peripheral". The OTG descriptor helps figure this out.
1742 if (!udev->bus->is_b_host
1743 && udev->config
1744 && udev->parent == udev->bus->root_hub) {
1745 struct usb_otg_descriptor *desc = NULL;
1746 struct usb_bus *bus = udev->bus;
1748 /* descriptor may appear anywhere in config */
1749 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1750 le16_to_cpu(udev->config[0].desc.wTotalLength),
1751 USB_DT_OTG, (void **) &desc) == 0) {
1752 if (desc->bmAttributes & USB_OTG_HNP) {
1753 unsigned port1 = udev->portnum;
1755 dev_info(&udev->dev,
1756 "Dual-Role OTG device on %sHNP port\n",
1757 (port1 == bus->otg_port)
1758 ? "" : "non-");
1760 /* enable HNP before suspend, it's simpler */
1761 if (port1 == bus->otg_port)
1762 bus->b_hnp_enable = 1;
1763 err = usb_control_msg(udev,
1764 usb_sndctrlpipe(udev, 0),
1765 USB_REQ_SET_FEATURE, 0,
1766 bus->b_hnp_enable
1767 ? USB_DEVICE_B_HNP_ENABLE
1768 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1769 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1770 if (err < 0) {
1771 /* OTG MESSAGE: report errors here,
1772 * customize to match your product.
1774 dev_info(&udev->dev,
1775 "can't set HNP mode: %d\n",
1776 err);
1777 bus->b_hnp_enable = 0;
1783 if (!is_targeted(udev)) {
1785 /* Maybe it can talk to us, though we can't talk to it.
1786 * (Includes HNP test device.)
1788 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1789 err = usb_port_suspend(udev, PMSG_SUSPEND);
1790 if (err < 0)
1791 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1793 err = -ENOTSUPP;
1794 goto fail;
1796 fail:
1797 #endif
1798 return err;
1803 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
1804 * @udev: newly addressed device (in ADDRESS state)
1806 * This is only called by usb_new_device() and usb_authorize_device()
1807 * and FIXME -- all comments that apply to them apply here wrt to
1808 * environment.
1810 * If the device is WUSB and not authorized, we don't attempt to read
1811 * the string descriptors, as they will be errored out by the device
1812 * until it has been authorized.
1814 static int usb_enumerate_device(struct usb_device *udev)
1816 int err;
1818 if (udev->config == NULL) {
1819 err = usb_get_configuration(udev);
1820 if (err < 0) {
1821 dev_err(&udev->dev, "can't read configurations, error %d\n",
1822 err);
1823 goto fail;
1826 if (udev->wusb == 1 && udev->authorized == 0) {
1827 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1828 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1829 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1831 else {
1832 /* read the standard strings and cache them if present */
1833 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1834 udev->manufacturer = usb_cache_string(udev,
1835 udev->descriptor.iManufacturer);
1836 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1838 err = usb_enumerate_device_otg(udev);
1839 fail:
1840 return err;
1845 * usb_new_device - perform initial device setup (usbcore-internal)
1846 * @udev: newly addressed device (in ADDRESS state)
1848 * This is called with devices which have been detected but not fully
1849 * enumerated. The device descriptor is available, but not descriptors
1850 * for any device configuration. The caller must have locked either
1851 * the parent hub (if udev is a normal device) or else the
1852 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1853 * udev has already been installed, but udev is not yet visible through
1854 * sysfs or other filesystem code.
1856 * It will return if the device is configured properly or not. Zero if
1857 * the interface was registered with the driver core; else a negative
1858 * errno value.
1860 * This call is synchronous, and may not be used in an interrupt context.
1862 * Only the hub driver or root-hub registrar should ever call this.
1864 int usb_new_device(struct usb_device *udev)
1866 int err;
1868 if (udev->parent) {
1869 /* Initialize non-root-hub device wakeup to disabled;
1870 * device (un)configuration controls wakeup capable
1871 * sysfs power/wakeup controls wakeup enabled/disabled
1873 device_init_wakeup(&udev->dev, 0);
1876 /* Tell the runtime-PM framework the device is active */
1877 pm_runtime_set_active(&udev->dev);
1878 pm_runtime_get_noresume(&udev->dev);
1879 pm_runtime_use_autosuspend(&udev->dev);
1880 pm_runtime_enable(&udev->dev);
1882 /* By default, forbid autosuspend for all devices. It will be
1883 * allowed for hubs during binding.
1885 usb_disable_autosuspend(udev);
1887 err = usb_enumerate_device(udev); /* Read descriptors */
1888 if (err < 0)
1889 goto fail;
1890 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
1891 udev->devnum, udev->bus->busnum,
1892 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1893 /* export the usbdev device-node for libusb */
1894 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1895 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1897 /* Tell the world! */
1898 announce_device(udev);
1900 device_enable_async_suspend(&udev->dev);
1901 /* Register the device. The device driver is responsible
1902 * for configuring the device and invoking the add-device
1903 * notifier chain (used by usbfs and possibly others).
1905 err = device_add(&udev->dev);
1906 if (err) {
1907 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1908 goto fail;
1911 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
1912 usb_mark_last_busy(udev);
1913 pm_runtime_put_sync_autosuspend(&udev->dev);
1914 return err;
1916 fail:
1917 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1918 pm_runtime_disable(&udev->dev);
1919 pm_runtime_set_suspended(&udev->dev);
1920 return err;
1925 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1926 * @usb_dev: USB device
1928 * Move the USB device to a very basic state where interfaces are disabled
1929 * and the device is in fact unconfigured and unusable.
1931 * We share a lock (that we have) with device_del(), so we need to
1932 * defer its call.
1934 int usb_deauthorize_device(struct usb_device *usb_dev)
1936 usb_lock_device(usb_dev);
1937 if (usb_dev->authorized == 0)
1938 goto out_unauthorized;
1940 usb_dev->authorized = 0;
1941 usb_set_configuration(usb_dev, -1);
1943 kfree(usb_dev->product);
1944 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1945 kfree(usb_dev->manufacturer);
1946 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1947 kfree(usb_dev->serial);
1948 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1950 usb_destroy_configuration(usb_dev);
1951 usb_dev->descriptor.bNumConfigurations = 0;
1953 out_unauthorized:
1954 usb_unlock_device(usb_dev);
1955 return 0;
1959 int usb_authorize_device(struct usb_device *usb_dev)
1961 int result = 0, c;
1963 usb_lock_device(usb_dev);
1964 if (usb_dev->authorized == 1)
1965 goto out_authorized;
1967 result = usb_autoresume_device(usb_dev);
1968 if (result < 0) {
1969 dev_err(&usb_dev->dev,
1970 "can't autoresume for authorization: %d\n", result);
1971 goto error_autoresume;
1973 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
1974 if (result < 0) {
1975 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
1976 "authorization: %d\n", result);
1977 goto error_device_descriptor;
1980 kfree(usb_dev->product);
1981 usb_dev->product = NULL;
1982 kfree(usb_dev->manufacturer);
1983 usb_dev->manufacturer = NULL;
1984 kfree(usb_dev->serial);
1985 usb_dev->serial = NULL;
1987 usb_dev->authorized = 1;
1988 result = usb_enumerate_device(usb_dev);
1989 if (result < 0)
1990 goto error_enumerate;
1991 /* Choose and set the configuration. This registers the interfaces
1992 * with the driver core and lets interface drivers bind to them.
1994 c = usb_choose_configuration(usb_dev);
1995 if (c >= 0) {
1996 result = usb_set_configuration(usb_dev, c);
1997 if (result) {
1998 dev_err(&usb_dev->dev,
1999 "can't set config #%d, error %d\n", c, result);
2000 /* This need not be fatal. The user can try to
2001 * set other configurations. */
2004 dev_info(&usb_dev->dev, "authorized to connect\n");
2006 error_enumerate:
2007 error_device_descriptor:
2008 usb_autosuspend_device(usb_dev);
2009 error_autoresume:
2010 out_authorized:
2011 usb_unlock_device(usb_dev); // complements locktree
2012 return result;
2016 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2017 static unsigned hub_is_wusb(struct usb_hub *hub)
2019 struct usb_hcd *hcd;
2020 if (hub->hdev->parent != NULL) /* not a root hub? */
2021 return 0;
2022 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2023 return hcd->wireless;
2027 #define PORT_RESET_TRIES 5
2028 #define SET_ADDRESS_TRIES 2
2029 #define GET_DESCRIPTOR_TRIES 2
2030 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2031 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
2033 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2034 #define HUB_SHORT_RESET_TIME 10
2035 #define HUB_LONG_RESET_TIME 200
2036 #define HUB_RESET_TIMEOUT 500
2038 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2039 struct usb_device *udev, unsigned int delay)
2041 int delay_time, ret;
2042 u16 portstatus;
2043 u16 portchange;
2045 for (delay_time = 0;
2046 delay_time < HUB_RESET_TIMEOUT;
2047 delay_time += delay) {
2048 /* wait to give the device a chance to reset */
2049 msleep(delay);
2051 /* read and decode port status */
2052 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2053 if (ret < 0)
2054 return ret;
2056 /* Device went away? */
2057 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2058 return -ENOTCONN;
2060 /* bomb out completely if the connection bounced */
2061 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2062 return -ENOTCONN;
2064 /* if we`ve finished resetting, then break out of the loop */
2065 if (!(portstatus & USB_PORT_STAT_RESET) &&
2066 (portstatus & USB_PORT_STAT_ENABLE)) {
2067 if (hub_is_wusb(hub))
2068 udev->speed = USB_SPEED_WIRELESS;
2069 else if (hub_is_superspeed(hub->hdev))
2070 udev->speed = USB_SPEED_SUPER;
2071 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2072 udev->speed = USB_SPEED_HIGH;
2073 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2074 udev->speed = USB_SPEED_LOW;
2075 else
2076 udev->speed = USB_SPEED_FULL;
2077 return 0;
2080 /* switch to the long delay after two short delay failures */
2081 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2082 delay = HUB_LONG_RESET_TIME;
2084 dev_dbg (hub->intfdev,
2085 "port %d not reset yet, waiting %dms\n",
2086 port1, delay);
2089 return -EBUSY;
2092 static int hub_port_reset(struct usb_hub *hub, int port1,
2093 struct usb_device *udev, unsigned int delay)
2095 int i, status;
2096 struct usb_hcd *hcd;
2098 hcd = bus_to_hcd(udev->bus);
2099 /* Block EHCI CF initialization during the port reset.
2100 * Some companion controllers don't like it when they mix.
2102 down_read(&ehci_cf_port_reset_rwsem);
2104 /* Reset the port */
2105 for (i = 0; i < PORT_RESET_TRIES; i++) {
2106 status = set_port_feature(hub->hdev,
2107 port1, USB_PORT_FEAT_RESET);
2108 if (status)
2109 dev_err(hub->intfdev,
2110 "cannot reset port %d (err = %d)\n",
2111 port1, status);
2112 else {
2113 status = hub_port_wait_reset(hub, port1, udev, delay);
2114 if (status && status != -ENOTCONN)
2115 dev_dbg(hub->intfdev,
2116 "port_wait_reset: err = %d\n",
2117 status);
2120 /* return on disconnect or reset */
2121 switch (status) {
2122 case 0:
2123 /* TRSTRCY = 10 ms; plus some extra */
2124 msleep(10 + 40);
2125 update_devnum(udev, 0);
2126 if (hcd->driver->reset_device) {
2127 status = hcd->driver->reset_device(hcd, udev);
2128 if (status < 0) {
2129 dev_err(&udev->dev, "Cannot reset "
2130 "HCD device state\n");
2131 break;
2134 /* FALL THROUGH */
2135 case -ENOTCONN:
2136 case -ENODEV:
2137 clear_port_feature(hub->hdev,
2138 port1, USB_PORT_FEAT_C_RESET);
2139 /* FIXME need disconnect() for NOTATTACHED device */
2140 usb_set_device_state(udev, status
2141 ? USB_STATE_NOTATTACHED
2142 : USB_STATE_DEFAULT);
2143 goto done;
2146 dev_dbg (hub->intfdev,
2147 "port %d not enabled, trying reset again...\n",
2148 port1);
2149 delay = HUB_LONG_RESET_TIME;
2152 dev_err (hub->intfdev,
2153 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2154 port1);
2156 done:
2157 up_read(&ehci_cf_port_reset_rwsem);
2158 return status;
2161 #ifdef CONFIG_PM
2163 #define MASK_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION | \
2164 USB_PORT_STAT_SUSPEND)
2165 #define WANT_BITS (USB_PORT_STAT_POWER | USB_PORT_STAT_CONNECTION)
2167 /* Determine whether the device on a port is ready for a normal resume,
2168 * is ready for a reset-resume, or should be disconnected.
2170 static int check_port_resume_type(struct usb_device *udev,
2171 struct usb_hub *hub, int port1,
2172 int status, unsigned portchange, unsigned portstatus)
2174 /* Is the device still present? */
2175 if (status || (portstatus & MASK_BITS) != WANT_BITS) {
2176 if (status >= 0)
2177 status = -ENODEV;
2180 /* Can't do a normal resume if the port isn't enabled,
2181 * so try a reset-resume instead.
2183 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2184 if (udev->persist_enabled)
2185 udev->reset_resume = 1;
2186 else
2187 status = -ENODEV;
2190 if (status) {
2191 dev_dbg(hub->intfdev,
2192 "port %d status %04x.%04x after resume, %d\n",
2193 port1, portchange, portstatus, status);
2194 } else if (udev->reset_resume) {
2196 /* Late port handoff can set status-change bits */
2197 if (portchange & USB_PORT_STAT_C_CONNECTION)
2198 clear_port_feature(hub->hdev, port1,
2199 USB_PORT_FEAT_C_CONNECTION);
2200 if (portchange & USB_PORT_STAT_C_ENABLE)
2201 clear_port_feature(hub->hdev, port1,
2202 USB_PORT_FEAT_C_ENABLE);
2205 return status;
2208 #ifdef CONFIG_USB_SUSPEND
2211 * usb_port_suspend - suspend a usb device's upstream port
2212 * @udev: device that's no longer in active use, not a root hub
2213 * Context: must be able to sleep; device not locked; pm locks held
2215 * Suspends a USB device that isn't in active use, conserving power.
2216 * Devices may wake out of a suspend, if anything important happens,
2217 * using the remote wakeup mechanism. They may also be taken out of
2218 * suspend by the host, using usb_port_resume(). It's also routine
2219 * to disconnect devices while they are suspended.
2221 * This only affects the USB hardware for a device; its interfaces
2222 * (and, for hubs, child devices) must already have been suspended.
2224 * Selective port suspend reduces power; most suspended devices draw
2225 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2226 * All devices below the suspended port are also suspended.
2228 * Devices leave suspend state when the host wakes them up. Some devices
2229 * also support "remote wakeup", where the device can activate the USB
2230 * tree above them to deliver data, such as a keypress or packet. In
2231 * some cases, this wakes the USB host.
2233 * Suspending OTG devices may trigger HNP, if that's been enabled
2234 * between a pair of dual-role devices. That will change roles, such
2235 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2237 * Devices on USB hub ports have only one "suspend" state, corresponding
2238 * to ACPI D2, "may cause the device to lose some context".
2239 * State transitions include:
2241 * - suspend, resume ... when the VBUS power link stays live
2242 * - suspend, disconnect ... VBUS lost
2244 * Once VBUS drop breaks the circuit, the port it's using has to go through
2245 * normal re-enumeration procedures, starting with enabling VBUS power.
2246 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2247 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2248 * timer, no SRP, no requests through sysfs.
2250 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2251 * the root hub for their bus goes into global suspend ... so we don't
2252 * (falsely) update the device power state to say it suspended.
2254 * Returns 0 on success, else negative errno.
2256 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2258 struct usb_hub *hub = hdev_to_hub(udev->parent);
2259 int port1 = udev->portnum;
2260 int status;
2262 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
2264 /* enable remote wakeup when appropriate; this lets the device
2265 * wake up the upstream hub (including maybe the root hub).
2267 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2268 * we don't explicitly enable it here.
2270 if (udev->do_remote_wakeup) {
2271 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2272 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2273 USB_DEVICE_REMOTE_WAKEUP, 0,
2274 NULL, 0,
2275 USB_CTRL_SET_TIMEOUT);
2276 if (status) {
2277 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2278 status);
2279 /* bail if autosuspend is requested */
2280 if (msg.event & PM_EVENT_AUTO)
2281 return status;
2285 /* see 7.1.7.6 */
2286 status = set_port_feature(hub->hdev, port1, USB_PORT_FEAT_SUSPEND);
2287 if (status) {
2288 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
2289 port1, status);
2290 /* paranoia: "should not happen" */
2291 if (udev->do_remote_wakeup)
2292 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2293 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2294 USB_DEVICE_REMOTE_WAKEUP, 0,
2295 NULL, 0,
2296 USB_CTRL_SET_TIMEOUT);
2297 } else {
2298 /* device has up to 10 msec to fully suspend */
2299 dev_dbg(&udev->dev, "usb %ssuspend\n",
2300 (msg.event & PM_EVENT_AUTO ? "auto-" : ""));
2301 usb_set_device_state(udev, USB_STATE_SUSPENDED);
2302 msleep(10);
2304 usb_mark_last_busy(hub->hdev);
2305 return status;
2309 * If the USB "suspend" state is in use (rather than "global suspend"),
2310 * many devices will be individually taken out of suspend state using
2311 * special "resume" signaling. This routine kicks in shortly after
2312 * hardware resume signaling is finished, either because of selective
2313 * resume (by host) or remote wakeup (by device) ... now see what changed
2314 * in the tree that's rooted at this device.
2316 * If @udev->reset_resume is set then the device is reset before the
2317 * status check is done.
2319 static int finish_port_resume(struct usb_device *udev)
2321 int status = 0;
2322 u16 devstatus;
2324 /* caller owns the udev device lock */
2325 dev_dbg(&udev->dev, "%s\n",
2326 udev->reset_resume ? "finish reset-resume" : "finish resume");
2328 /* usb ch9 identifies four variants of SUSPENDED, based on what
2329 * state the device resumes to. Linux currently won't see the
2330 * first two on the host side; they'd be inside hub_port_init()
2331 * during many timeouts, but khubd can't suspend until later.
2333 usb_set_device_state(udev, udev->actconfig
2334 ? USB_STATE_CONFIGURED
2335 : USB_STATE_ADDRESS);
2337 /* 10.5.4.5 says not to reset a suspended port if the attached
2338 * device is enabled for remote wakeup. Hence the reset
2339 * operation is carried out here, after the port has been
2340 * resumed.
2342 if (udev->reset_resume)
2343 retry_reset_resume:
2344 status = usb_reset_and_verify_device(udev);
2346 /* 10.5.4.5 says be sure devices in the tree are still there.
2347 * For now let's assume the device didn't go crazy on resume,
2348 * and device drivers will know about any resume quirks.
2350 if (status == 0) {
2351 devstatus = 0;
2352 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
2353 if (status >= 0)
2354 status = (status > 0 ? 0 : -ENODEV);
2356 /* If a normal resume failed, try doing a reset-resume */
2357 if (status && !udev->reset_resume && udev->persist_enabled) {
2358 dev_dbg(&udev->dev, "retry with reset-resume\n");
2359 udev->reset_resume = 1;
2360 goto retry_reset_resume;
2364 if (status) {
2365 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
2366 status);
2367 } else if (udev->actconfig) {
2368 le16_to_cpus(&devstatus);
2369 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
2370 status = usb_control_msg(udev,
2371 usb_sndctrlpipe(udev, 0),
2372 USB_REQ_CLEAR_FEATURE,
2373 USB_RECIP_DEVICE,
2374 USB_DEVICE_REMOTE_WAKEUP, 0,
2375 NULL, 0,
2376 USB_CTRL_SET_TIMEOUT);
2377 if (status)
2378 dev_dbg(&udev->dev,
2379 "disable remote wakeup, status %d\n",
2380 status);
2382 status = 0;
2384 return status;
2388 * usb_port_resume - re-activate a suspended usb device's upstream port
2389 * @udev: device to re-activate, not a root hub
2390 * Context: must be able to sleep; device not locked; pm locks held
2392 * This will re-activate the suspended device, increasing power usage
2393 * while letting drivers communicate again with its endpoints.
2394 * USB resume explicitly guarantees that the power session between
2395 * the host and the device is the same as it was when the device
2396 * suspended.
2398 * If @udev->reset_resume is set then this routine won't check that the
2399 * port is still enabled. Furthermore, finish_port_resume() above will
2400 * reset @udev. The end result is that a broken power session can be
2401 * recovered and @udev will appear to persist across a loss of VBUS power.
2403 * For example, if a host controller doesn't maintain VBUS suspend current
2404 * during a system sleep or is reset when the system wakes up, all the USB
2405 * power sessions below it will be broken. This is especially troublesome
2406 * for mass-storage devices containing mounted filesystems, since the
2407 * device will appear to have disconnected and all the memory mappings
2408 * to it will be lost. Using the USB_PERSIST facility, the device can be
2409 * made to appear as if it had not disconnected.
2411 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
2412 * every effort to insure that the same device is present after the
2413 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2414 * quite possible for a device to remain unaltered but its media to be
2415 * changed. If the user replaces a flash memory card while the system is
2416 * asleep, he will have only himself to blame when the filesystem on the
2417 * new card is corrupted and the system crashes.
2419 * Returns 0 on success, else negative errno.
2421 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2423 struct usb_hub *hub = hdev_to_hub(udev->parent);
2424 int port1 = udev->portnum;
2425 int status;
2426 u16 portchange, portstatus;
2428 /* Skip the initial Clear-Suspend step for a remote wakeup */
2429 status = hub_port_status(hub, port1, &portstatus, &portchange);
2430 if (status == 0 && !(portstatus & USB_PORT_STAT_SUSPEND))
2431 goto SuspendCleared;
2433 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2435 set_bit(port1, hub->busy_bits);
2437 /* see 7.1.7.7; affects power usage, but not budgeting */
2438 status = clear_port_feature(hub->hdev,
2439 port1, USB_PORT_FEAT_SUSPEND);
2440 if (status) {
2441 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
2442 port1, status);
2443 } else {
2444 /* drive resume for at least 20 msec */
2445 dev_dbg(&udev->dev, "usb %sresume\n",
2446 (msg.event & PM_EVENT_AUTO ? "auto-" : ""));
2447 msleep(25);
2449 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2450 * stop resume signaling. Then finish the resume
2451 * sequence.
2453 status = hub_port_status(hub, port1, &portstatus, &portchange);
2455 /* TRSMRCY = 10 msec */
2456 msleep(10);
2459 SuspendCleared:
2460 if (status == 0) {
2461 if (portchange & USB_PORT_STAT_C_SUSPEND)
2462 clear_port_feature(hub->hdev, port1,
2463 USB_PORT_FEAT_C_SUSPEND);
2466 clear_bit(port1, hub->busy_bits);
2468 status = check_port_resume_type(udev,
2469 hub, port1, status, portchange, portstatus);
2470 if (status == 0)
2471 status = finish_port_resume(udev);
2472 if (status < 0) {
2473 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2474 hub_port_logical_disconnect(hub, port1);
2476 return status;
2479 /* caller has locked udev */
2480 int usb_remote_wakeup(struct usb_device *udev)
2482 int status = 0;
2484 if (udev->state == USB_STATE_SUSPENDED) {
2485 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
2486 status = usb_autoresume_device(udev);
2487 if (status == 0) {
2488 /* Let the drivers do their thing, then... */
2489 usb_autosuspend_device(udev);
2492 return status;
2495 #else /* CONFIG_USB_SUSPEND */
2497 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2499 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2501 return 0;
2504 /* However we may need to do a reset-resume */
2506 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2508 struct usb_hub *hub = hdev_to_hub(udev->parent);
2509 int port1 = udev->portnum;
2510 int status;
2511 u16 portchange, portstatus;
2513 status = hub_port_status(hub, port1, &portstatus, &portchange);
2514 status = check_port_resume_type(udev,
2515 hub, port1, status, portchange, portstatus);
2517 if (status) {
2518 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2519 hub_port_logical_disconnect(hub, port1);
2520 } else if (udev->reset_resume) {
2521 dev_dbg(&udev->dev, "reset-resume\n");
2522 status = usb_reset_and_verify_device(udev);
2524 return status;
2527 #endif
2529 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
2531 struct usb_hub *hub = usb_get_intfdata (intf);
2532 struct usb_device *hdev = hub->hdev;
2533 unsigned port1;
2535 /* fail if children aren't already suspended */
2536 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2537 struct usb_device *udev;
2539 udev = hdev->children [port1-1];
2540 if (udev && udev->can_submit) {
2541 if (!(msg.event & PM_EVENT_AUTO))
2542 dev_dbg(&intf->dev, "port %d nyet suspended\n",
2543 port1);
2544 return -EBUSY;
2548 dev_dbg(&intf->dev, "%s\n", __func__);
2550 /* stop khubd and related activity */
2551 hub_quiesce(hub, HUB_SUSPEND);
2552 return 0;
2555 static int hub_resume(struct usb_interface *intf)
2557 struct usb_hub *hub = usb_get_intfdata(intf);
2559 dev_dbg(&intf->dev, "%s\n", __func__);
2560 hub_activate(hub, HUB_RESUME);
2561 return 0;
2564 static int hub_reset_resume(struct usb_interface *intf)
2566 struct usb_hub *hub = usb_get_intfdata(intf);
2568 dev_dbg(&intf->dev, "%s\n", __func__);
2569 hub_activate(hub, HUB_RESET_RESUME);
2570 return 0;
2574 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2575 * @rhdev: struct usb_device for the root hub
2577 * The USB host controller driver calls this function when its root hub
2578 * is resumed and Vbus power has been interrupted or the controller
2579 * has been reset. The routine marks @rhdev as having lost power.
2580 * When the hub driver is resumed it will take notice and carry out
2581 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2582 * the others will be disconnected.
2584 void usb_root_hub_lost_power(struct usb_device *rhdev)
2586 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
2587 rhdev->reset_resume = 1;
2589 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
2591 #else /* CONFIG_PM */
2593 #define hub_suspend NULL
2594 #define hub_resume NULL
2595 #define hub_reset_resume NULL
2596 #endif
2599 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2601 * Between connect detection and reset signaling there must be a delay
2602 * of 100ms at least for debounce and power-settling. The corresponding
2603 * timer shall restart whenever the downstream port detects a disconnect.
2605 * Apparently there are some bluetooth and irda-dongles and a number of
2606 * low-speed devices for which this debounce period may last over a second.
2607 * Not covered by the spec - but easy to deal with.
2609 * This implementation uses a 1500ms total debounce timeout; if the
2610 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2611 * every 25ms for transient disconnects. When the port status has been
2612 * unchanged for 100ms it returns the port status.
2614 static int hub_port_debounce(struct usb_hub *hub, int port1)
2616 int ret;
2617 int total_time, stable_time = 0;
2618 u16 portchange, portstatus;
2619 unsigned connection = 0xffff;
2621 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2622 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2623 if (ret < 0)
2624 return ret;
2626 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2627 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2628 stable_time += HUB_DEBOUNCE_STEP;
2629 if (stable_time >= HUB_DEBOUNCE_STABLE)
2630 break;
2631 } else {
2632 stable_time = 0;
2633 connection = portstatus & USB_PORT_STAT_CONNECTION;
2636 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2637 clear_port_feature(hub->hdev, port1,
2638 USB_PORT_FEAT_C_CONNECTION);
2641 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2642 break;
2643 msleep(HUB_DEBOUNCE_STEP);
2646 dev_dbg (hub->intfdev,
2647 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2648 port1, total_time, stable_time, portstatus);
2650 if (stable_time < HUB_DEBOUNCE_STABLE)
2651 return -ETIMEDOUT;
2652 return portstatus;
2655 void usb_ep0_reinit(struct usb_device *udev)
2657 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
2658 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
2659 usb_enable_endpoint(udev, &udev->ep0, true);
2661 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
2663 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2664 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2666 static int hub_set_address(struct usb_device *udev, int devnum)
2668 int retval;
2669 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2672 * The host controller will choose the device address,
2673 * instead of the core having chosen it earlier
2675 if (!hcd->driver->address_device && devnum <= 1)
2676 return -EINVAL;
2677 if (udev->state == USB_STATE_ADDRESS)
2678 return 0;
2679 if (udev->state != USB_STATE_DEFAULT)
2680 return -EINVAL;
2681 if (hcd->driver->address_device)
2682 retval = hcd->driver->address_device(hcd, udev);
2683 else
2684 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2685 USB_REQ_SET_ADDRESS, 0, devnum, 0,
2686 NULL, 0, USB_CTRL_SET_TIMEOUT);
2687 if (retval == 0) {
2688 update_devnum(udev, devnum);
2689 /* Device now using proper address. */
2690 usb_set_device_state(udev, USB_STATE_ADDRESS);
2691 usb_ep0_reinit(udev);
2693 return retval;
2696 /* Reset device, (re)assign address, get device descriptor.
2697 * Device connection must be stable, no more debouncing needed.
2698 * Returns device in USB_STATE_ADDRESS, except on error.
2700 * If this is called for an already-existing device (as part of
2701 * usb_reset_and_verify_device), the caller must own the device lock. For a
2702 * newly detected device that is not accessible through any global
2703 * pointers, it's not necessary to lock the device.
2705 static int
2706 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2707 int retry_counter)
2709 static DEFINE_MUTEX(usb_address0_mutex);
2711 struct usb_device *hdev = hub->hdev;
2712 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
2713 int i, j, retval;
2714 unsigned delay = HUB_SHORT_RESET_TIME;
2715 enum usb_device_speed oldspeed = udev->speed;
2716 char *speed, *type;
2717 int devnum = udev->devnum;
2719 /* root hub ports have a slightly longer reset period
2720 * (from USB 2.0 spec, section 7.1.7.5)
2722 if (!hdev->parent) {
2723 delay = HUB_ROOT_RESET_TIME;
2724 if (port1 == hdev->bus->otg_port)
2725 hdev->bus->b_hnp_enable = 0;
2728 /* Some low speed devices have problems with the quick delay, so */
2729 /* be a bit pessimistic with those devices. RHbug #23670 */
2730 if (oldspeed == USB_SPEED_LOW)
2731 delay = HUB_LONG_RESET_TIME;
2733 mutex_lock(&usb_address0_mutex);
2735 if (!udev->config && oldspeed == USB_SPEED_SUPER) {
2736 /* Don't reset USB 3.0 devices during an initial setup */
2737 usb_set_device_state(udev, USB_STATE_DEFAULT);
2738 } else {
2739 /* Reset the device; full speed may morph to high speed */
2740 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
2741 retval = hub_port_reset(hub, port1, udev, delay);
2742 if (retval < 0) /* error or disconnect */
2743 goto fail;
2744 /* success, speed is known */
2746 retval = -ENODEV;
2748 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2749 dev_dbg(&udev->dev, "device reset changed speed!\n");
2750 goto fail;
2752 oldspeed = udev->speed;
2754 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2755 * it's fixed size except for full speed devices.
2756 * For Wireless USB devices, ep0 max packet is always 512 (tho
2757 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2759 switch (udev->speed) {
2760 case USB_SPEED_SUPER:
2761 case USB_SPEED_WIRELESS: /* fixed at 512 */
2762 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
2763 break;
2764 case USB_SPEED_HIGH: /* fixed at 64 */
2765 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
2766 break;
2767 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2768 /* to determine the ep0 maxpacket size, try to read
2769 * the device descriptor to get bMaxPacketSize0 and
2770 * then correct our initial guess.
2772 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
2773 break;
2774 case USB_SPEED_LOW: /* fixed at 8 */
2775 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
2776 break;
2777 default:
2778 goto fail;
2781 type = "";
2782 switch (udev->speed) {
2783 case USB_SPEED_LOW: speed = "low"; break;
2784 case USB_SPEED_FULL: speed = "full"; break;
2785 case USB_SPEED_HIGH: speed = "high"; break;
2786 case USB_SPEED_SUPER:
2787 speed = "super";
2788 break;
2789 case USB_SPEED_WIRELESS:
2790 speed = "variable";
2791 type = "Wireless ";
2792 break;
2793 default: speed = "?"; break;
2795 if (udev->speed != USB_SPEED_SUPER)
2796 dev_info(&udev->dev,
2797 "%s %s speed %sUSB device number %d using %s\n",
2798 (udev->config) ? "reset" : "new", speed, type,
2799 devnum, udev->bus->controller->driver->name);
2801 /* Set up TT records, if needed */
2802 if (hdev->tt) {
2803 udev->tt = hdev->tt;
2804 udev->ttport = hdev->ttport;
2805 } else if (udev->speed != USB_SPEED_HIGH
2806 && hdev->speed == USB_SPEED_HIGH) {
2807 if (!hub->tt.hub) {
2808 dev_err(&udev->dev, "parent hub has no TT\n");
2809 retval = -EINVAL;
2810 goto fail;
2812 udev->tt = &hub->tt;
2813 udev->ttport = port1;
2816 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2817 * Because device hardware and firmware is sometimes buggy in
2818 * this area, and this is how Linux has done it for ages.
2819 * Change it cautiously.
2821 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2822 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2823 * so it may help with some non-standards-compliant devices.
2824 * Otherwise we start with SET_ADDRESS and then try to read the
2825 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2826 * value.
2828 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2829 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
2830 struct usb_device_descriptor *buf;
2831 int r = 0;
2833 #define GET_DESCRIPTOR_BUFSIZE 64
2834 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2835 if (!buf) {
2836 retval = -ENOMEM;
2837 continue;
2840 /* Retry on all errors; some devices are flakey.
2841 * 255 is for WUSB devices, we actually need to use
2842 * 512 (WUSB1.0[4.8.1]).
2844 for (j = 0; j < 3; ++j) {
2845 buf->bMaxPacketSize0 = 0;
2846 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2847 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2848 USB_DT_DEVICE << 8, 0,
2849 buf, GET_DESCRIPTOR_BUFSIZE,
2850 initial_descriptor_timeout);
2851 switch (buf->bMaxPacketSize0) {
2852 case 8: case 16: case 32: case 64: case 255:
2853 if (buf->bDescriptorType ==
2854 USB_DT_DEVICE) {
2855 r = 0;
2856 break;
2858 /* FALL THROUGH */
2859 default:
2860 if (r == 0)
2861 r = -EPROTO;
2862 break;
2864 if (r == 0)
2865 break;
2867 udev->descriptor.bMaxPacketSize0 =
2868 buf->bMaxPacketSize0;
2869 kfree(buf);
2871 retval = hub_port_reset(hub, port1, udev, delay);
2872 if (retval < 0) /* error or disconnect */
2873 goto fail;
2874 if (oldspeed != udev->speed) {
2875 dev_dbg(&udev->dev,
2876 "device reset changed speed!\n");
2877 retval = -ENODEV;
2878 goto fail;
2880 if (r) {
2881 dev_err(&udev->dev,
2882 "device descriptor read/64, error %d\n",
2884 retval = -EMSGSIZE;
2885 continue;
2887 #undef GET_DESCRIPTOR_BUFSIZE
2891 * If device is WUSB, we already assigned an
2892 * unauthorized address in the Connect Ack sequence;
2893 * authorization will assign the final address.
2895 if (udev->wusb == 0) {
2896 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2897 retval = hub_set_address(udev, devnum);
2898 if (retval >= 0)
2899 break;
2900 msleep(200);
2902 if (retval < 0) {
2903 dev_err(&udev->dev,
2904 "device not accepting address %d, error %d\n",
2905 devnum, retval);
2906 goto fail;
2908 if (udev->speed == USB_SPEED_SUPER) {
2909 devnum = udev->devnum;
2910 dev_info(&udev->dev,
2911 "%s SuperSpeed USB device number %d using %s\n",
2912 (udev->config) ? "reset" : "new",
2913 devnum, udev->bus->controller->driver->name);
2916 /* cope with hardware quirkiness:
2917 * - let SET_ADDRESS settle, some device hardware wants it
2918 * - read ep0 maxpacket even for high and low speed,
2920 msleep(10);
2921 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
2922 break;
2925 retval = usb_get_device_descriptor(udev, 8);
2926 if (retval < 8) {
2927 dev_err(&udev->dev,
2928 "device descriptor read/8, error %d\n",
2929 retval);
2930 if (retval >= 0)
2931 retval = -EMSGSIZE;
2932 } else {
2933 retval = 0;
2934 break;
2937 if (retval)
2938 goto fail;
2940 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
2941 udev->speed == USB_SPEED_SUPER)
2942 i = 512;
2943 else
2944 i = udev->descriptor.bMaxPacketSize0;
2945 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
2946 if (udev->speed == USB_SPEED_LOW ||
2947 !(i == 8 || i == 16 || i == 32 || i == 64)) {
2948 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
2949 retval = -EMSGSIZE;
2950 goto fail;
2952 if (udev->speed == USB_SPEED_FULL)
2953 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
2954 else
2955 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
2956 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
2957 usb_ep0_reinit(udev);
2960 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
2961 if (retval < (signed)sizeof(udev->descriptor)) {
2962 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
2963 retval);
2964 if (retval >= 0)
2965 retval = -ENOMSG;
2966 goto fail;
2969 retval = 0;
2970 /* notify HCD that we have a device connected and addressed */
2971 if (hcd->driver->update_device)
2972 hcd->driver->update_device(hcd, udev);
2973 fail:
2974 if (retval) {
2975 hub_port_disable(hub, port1, 0);
2976 update_devnum(udev, devnum); /* for disconnect processing */
2978 mutex_unlock(&usb_address0_mutex);
2979 return retval;
2982 static void
2983 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
2985 struct usb_qualifier_descriptor *qual;
2986 int status;
2988 qual = kmalloc (sizeof *qual, GFP_KERNEL);
2989 if (qual == NULL)
2990 return;
2992 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
2993 qual, sizeof *qual);
2994 if (status == sizeof *qual) {
2995 dev_info(&udev->dev, "not running at top speed; "
2996 "connect to a high speed hub\n");
2997 /* hub LEDs are probably harder to miss than syslog */
2998 if (hub->has_indicators) {
2999 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
3000 schedule_delayed_work (&hub->leds, 0);
3003 kfree(qual);
3006 static unsigned
3007 hub_power_remaining (struct usb_hub *hub)
3009 struct usb_device *hdev = hub->hdev;
3010 int remaining;
3011 int port1;
3013 if (!hub->limited_power)
3014 return 0;
3016 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
3017 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
3018 struct usb_device *udev = hdev->children[port1 - 1];
3019 int delta;
3021 if (!udev)
3022 continue;
3024 /* Unconfigured devices may not use more than 100mA,
3025 * or 8mA for OTG ports */
3026 if (udev->actconfig)
3027 delta = udev->actconfig->desc.bMaxPower * 2;
3028 else if (port1 != udev->bus->otg_port || hdev->parent)
3029 delta = 100;
3030 else
3031 delta = 8;
3032 if (delta > hub->mA_per_port)
3033 dev_warn(&udev->dev,
3034 "%dmA is over %umA budget for port %d!\n",
3035 delta, hub->mA_per_port, port1);
3036 remaining -= delta;
3038 if (remaining < 0) {
3039 dev_warn(hub->intfdev, "%dmA over power budget!\n",
3040 - remaining);
3041 remaining = 0;
3043 return remaining;
3046 /* Handle physical or logical connection change events.
3047 * This routine is called when:
3048 * a port connection-change occurs;
3049 * a port enable-change occurs (often caused by EMI);
3050 * usb_reset_and_verify_device() encounters changed descriptors (as from
3051 * a firmware download)
3052 * caller already locked the hub
3054 static void hub_port_connect_change(struct usb_hub *hub, int port1,
3055 u16 portstatus, u16 portchange)
3057 struct usb_device *hdev = hub->hdev;
3058 struct device *hub_dev = hub->intfdev;
3059 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
3060 unsigned wHubCharacteristics =
3061 le16_to_cpu(hub->descriptor->wHubCharacteristics);
3062 struct usb_device *udev;
3063 int status, i;
3065 dev_dbg (hub_dev,
3066 "port %d, status %04x, change %04x, %s\n",
3067 port1, portstatus, portchange, portspeed(hub, portstatus));
3069 if (hub->has_indicators) {
3070 set_port_led(hub, port1, HUB_LED_AUTO);
3071 hub->indicator[port1-1] = INDICATOR_AUTO;
3074 #ifdef CONFIG_USB_OTG
3075 /* during HNP, don't repeat the debounce */
3076 if (hdev->bus->is_b_host)
3077 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
3078 USB_PORT_STAT_C_ENABLE);
3079 #endif
3081 /* Try to resuscitate an existing device */
3082 udev = hdev->children[port1-1];
3083 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
3084 udev->state != USB_STATE_NOTATTACHED) {
3085 usb_lock_device(udev);
3086 if (portstatus & USB_PORT_STAT_ENABLE) {
3087 status = 0; /* Nothing to do */
3089 #ifdef CONFIG_USB_SUSPEND
3090 } else if (udev->state == USB_STATE_SUSPENDED &&
3091 udev->persist_enabled) {
3092 /* For a suspended device, treat this as a
3093 * remote wakeup event.
3095 status = usb_remote_wakeup(udev);
3096 #endif
3098 } else {
3099 status = -ENODEV; /* Don't resuscitate */
3101 usb_unlock_device(udev);
3103 if (status == 0) {
3104 clear_bit(port1, hub->change_bits);
3105 return;
3109 /* Disconnect any existing devices under this port */
3110 if (udev)
3111 usb_disconnect(&hdev->children[port1-1]);
3112 clear_bit(port1, hub->change_bits);
3114 /* We can forget about a "removed" device when there's a physical
3115 * disconnect or the connect status changes.
3117 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3118 (portchange & USB_PORT_STAT_C_CONNECTION))
3119 clear_bit(port1, hub->removed_bits);
3121 if (portchange & (USB_PORT_STAT_C_CONNECTION |
3122 USB_PORT_STAT_C_ENABLE)) {
3123 status = hub_port_debounce(hub, port1);
3124 if (status < 0) {
3125 if (printk_ratelimit())
3126 dev_err(hub_dev, "connect-debounce failed, "
3127 "port %d disabled\n", port1);
3128 portstatus &= ~USB_PORT_STAT_CONNECTION;
3129 } else {
3130 portstatus = status;
3134 /* Return now if debouncing failed or nothing is connected or
3135 * the device was "removed".
3137 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3138 test_bit(port1, hub->removed_bits)) {
3140 /* maybe switch power back on (e.g. root hub was reset) */
3141 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
3142 && !(portstatus & USB_PORT_STAT_POWER))
3143 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
3145 if (portstatus & USB_PORT_STAT_ENABLE)
3146 goto done;
3147 return;
3150 for (i = 0; i < SET_CONFIG_TRIES; i++) {
3152 /* reallocate for each attempt, since references
3153 * to the previous one can escape in various ways
3155 udev = usb_alloc_dev(hdev, hdev->bus, port1);
3156 if (!udev) {
3157 dev_err (hub_dev,
3158 "couldn't allocate port %d usb_device\n",
3159 port1);
3160 goto done;
3163 usb_set_device_state(udev, USB_STATE_POWERED);
3164 udev->bus_mA = hub->mA_per_port;
3165 udev->level = hdev->level + 1;
3166 udev->wusb = hub_is_wusb(hub);
3168 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
3169 if (hub_is_superspeed(hub->hdev))
3170 udev->speed = USB_SPEED_SUPER;
3171 else
3172 udev->speed = USB_SPEED_UNKNOWN;
3174 choose_devnum(udev);
3175 if (udev->devnum <= 0) {
3176 status = -ENOTCONN; /* Don't retry */
3177 goto loop;
3180 /* reset (non-USB 3.0 devices) and get descriptor */
3181 status = hub_port_init(hub, udev, port1, i);
3182 if (status < 0)
3183 goto loop;
3185 usb_detect_quirks(udev);
3186 if (udev->quirks & USB_QUIRK_DELAY_INIT)
3187 msleep(1000);
3189 /* consecutive bus-powered hubs aren't reliable; they can
3190 * violate the voltage drop budget. if the new child has
3191 * a "powered" LED, users should notice we didn't enable it
3192 * (without reading syslog), even without per-port LEDs
3193 * on the parent.
3195 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
3196 && udev->bus_mA <= 100) {
3197 u16 devstat;
3199 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
3200 &devstat);
3201 if (status < 2) {
3202 dev_dbg(&udev->dev, "get status %d ?\n", status);
3203 goto loop_disable;
3205 le16_to_cpus(&devstat);
3206 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
3207 dev_err(&udev->dev,
3208 "can't connect bus-powered hub "
3209 "to this port\n");
3210 if (hub->has_indicators) {
3211 hub->indicator[port1-1] =
3212 INDICATOR_AMBER_BLINK;
3213 schedule_delayed_work (&hub->leds, 0);
3215 status = -ENOTCONN; /* Don't retry */
3216 goto loop_disable;
3220 /* check for devices running slower than they could */
3221 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
3222 && udev->speed == USB_SPEED_FULL
3223 && highspeed_hubs != 0)
3224 check_highspeed (hub, udev, port1);
3226 /* Store the parent's children[] pointer. At this point
3227 * udev becomes globally accessible, although presumably
3228 * no one will look at it until hdev is unlocked.
3230 status = 0;
3232 /* We mustn't add new devices if the parent hub has
3233 * been disconnected; we would race with the
3234 * recursively_mark_NOTATTACHED() routine.
3236 spin_lock_irq(&device_state_lock);
3237 if (hdev->state == USB_STATE_NOTATTACHED)
3238 status = -ENOTCONN;
3239 else
3240 hdev->children[port1-1] = udev;
3241 spin_unlock_irq(&device_state_lock);
3243 /* Run it through the hoops (find a driver, etc) */
3244 if (!status) {
3245 status = usb_new_device(udev);
3246 if (status) {
3247 spin_lock_irq(&device_state_lock);
3248 hdev->children[port1-1] = NULL;
3249 spin_unlock_irq(&device_state_lock);
3253 if (status)
3254 goto loop_disable;
3256 status = hub_power_remaining(hub);
3257 if (status)
3258 dev_dbg(hub_dev, "%dmA power budget left\n", status);
3260 return;
3262 loop_disable:
3263 hub_port_disable(hub, port1, 1);
3264 loop:
3265 usb_ep0_reinit(udev);
3266 release_devnum(udev);
3267 hub_free_dev(udev);
3268 usb_put_dev(udev);
3269 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
3270 break;
3272 if (hub->hdev->parent ||
3273 !hcd->driver->port_handed_over ||
3274 !(hcd->driver->port_handed_over)(hcd, port1))
3275 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
3276 port1);
3278 done:
3279 hub_port_disable(hub, port1, 1);
3280 if (hcd->driver->relinquish_port && !hub->hdev->parent)
3281 hcd->driver->relinquish_port(hcd, port1);
3284 static void hub_events(void)
3286 struct list_head *tmp;
3287 struct usb_device *hdev;
3288 struct usb_interface *intf;
3289 struct usb_hub *hub;
3290 struct device *hub_dev;
3291 u16 hubstatus;
3292 u16 hubchange;
3293 u16 portstatus;
3294 u16 portchange;
3295 int i, ret;
3296 int connect_change;
3299 * We restart the list every time to avoid a deadlock with
3300 * deleting hubs downstream from this one. This should be
3301 * safe since we delete the hub from the event list.
3302 * Not the most efficient, but avoids deadlocks.
3304 while (1) {
3306 /* Grab the first entry at the beginning of the list */
3307 spin_lock_irq(&hub_event_lock);
3308 if (list_empty(&hub_event_list)) {
3309 spin_unlock_irq(&hub_event_lock);
3310 break;
3313 tmp = hub_event_list.next;
3314 list_del_init(tmp);
3316 hub = list_entry(tmp, struct usb_hub, event_list);
3317 kref_get(&hub->kref);
3318 spin_unlock_irq(&hub_event_lock);
3320 hdev = hub->hdev;
3321 hub_dev = hub->intfdev;
3322 intf = to_usb_interface(hub_dev);
3323 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
3324 hdev->state, hub->descriptor
3325 ? hub->descriptor->bNbrPorts
3326 : 0,
3327 /* NOTE: expects max 15 ports... */
3328 (u16) hub->change_bits[0],
3329 (u16) hub->event_bits[0]);
3331 /* Lock the device, then check to see if we were
3332 * disconnected while waiting for the lock to succeed. */
3333 usb_lock_device(hdev);
3334 if (unlikely(hub->disconnected))
3335 goto loop_disconnected;
3337 /* If the hub has died, clean up after it */
3338 if (hdev->state == USB_STATE_NOTATTACHED) {
3339 hub->error = -ENODEV;
3340 hub_quiesce(hub, HUB_DISCONNECT);
3341 goto loop;
3344 /* Autoresume */
3345 ret = usb_autopm_get_interface(intf);
3346 if (ret) {
3347 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
3348 goto loop;
3351 /* If this is an inactive hub, do nothing */
3352 if (hub->quiescing)
3353 goto loop_autopm;
3355 if (hub->error) {
3356 dev_dbg (hub_dev, "resetting for error %d\n",
3357 hub->error);
3359 ret = usb_reset_device(hdev);
3360 if (ret) {
3361 dev_dbg (hub_dev,
3362 "error resetting hub: %d\n", ret);
3363 goto loop_autopm;
3366 hub->nerrors = 0;
3367 hub->error = 0;
3370 /* deal with port status changes */
3371 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
3372 if (test_bit(i, hub->busy_bits))
3373 continue;
3374 connect_change = test_bit(i, hub->change_bits);
3375 if (!test_and_clear_bit(i, hub->event_bits) &&
3376 !connect_change)
3377 continue;
3379 ret = hub_port_status(hub, i,
3380 &portstatus, &portchange);
3381 if (ret < 0)
3382 continue;
3384 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3385 clear_port_feature(hdev, i,
3386 USB_PORT_FEAT_C_CONNECTION);
3387 connect_change = 1;
3390 if (portchange & USB_PORT_STAT_C_ENABLE) {
3391 if (!connect_change)
3392 dev_dbg (hub_dev,
3393 "port %d enable change, "
3394 "status %08x\n",
3395 i, portstatus);
3396 clear_port_feature(hdev, i,
3397 USB_PORT_FEAT_C_ENABLE);
3400 * EM interference sometimes causes badly
3401 * shielded USB devices to be shutdown by
3402 * the hub, this hack enables them again.
3403 * Works at least with mouse driver.
3405 if (!(portstatus & USB_PORT_STAT_ENABLE)
3406 && !connect_change
3407 && hdev->children[i-1]) {
3408 dev_err (hub_dev,
3409 "port %i "
3410 "disabled by hub (EMI?), "
3411 "re-enabling...\n",
3413 connect_change = 1;
3417 if (portchange & USB_PORT_STAT_C_SUSPEND) {
3418 struct usb_device *udev;
3420 clear_port_feature(hdev, i,
3421 USB_PORT_FEAT_C_SUSPEND);
3422 udev = hdev->children[i-1];
3423 if (udev) {
3424 /* TRSMRCY = 10 msec */
3425 msleep(10);
3427 usb_lock_device(udev);
3428 ret = usb_remote_wakeup(hdev->
3429 children[i-1]);
3430 usb_unlock_device(udev);
3431 if (ret < 0)
3432 connect_change = 1;
3433 } else {
3434 ret = -ENODEV;
3435 hub_port_disable(hub, i, 1);
3437 dev_dbg (hub_dev,
3438 "resume on port %d, status %d\n",
3439 i, ret);
3442 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
3443 u16 status = 0;
3444 u16 unused;
3446 dev_dbg(hub_dev, "over-current change on port "
3447 "%d\n", i);
3448 clear_port_feature(hdev, i,
3449 USB_PORT_FEAT_C_OVER_CURRENT);
3450 msleep(100); /* Cool down */
3451 hub_power_on(hub, true);
3452 hub_port_status(hub, i, &status, &unused);
3453 if (status & USB_PORT_STAT_OVERCURRENT)
3454 dev_err(hub_dev, "over-current "
3455 "condition on port %d\n", i);
3458 if (portchange & USB_PORT_STAT_C_RESET) {
3459 dev_dbg (hub_dev,
3460 "reset change on port %d\n",
3462 clear_port_feature(hdev, i,
3463 USB_PORT_FEAT_C_RESET);
3465 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
3466 hub_is_superspeed(hub->hdev)) {
3467 dev_dbg(hub_dev,
3468 "warm reset change on port %d\n",
3470 clear_port_feature(hdev, i,
3471 USB_PORT_FEAT_C_BH_PORT_RESET);
3473 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
3474 clear_port_feature(hub->hdev, i,
3475 USB_PORT_FEAT_C_PORT_LINK_STATE);
3477 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
3478 dev_warn(hub_dev,
3479 "config error on port %d\n",
3481 clear_port_feature(hub->hdev, i,
3482 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
3485 if (connect_change)
3486 hub_port_connect_change(hub, i,
3487 portstatus, portchange);
3488 } /* end for i */
3490 /* deal with hub status changes */
3491 if (test_and_clear_bit(0, hub->event_bits) == 0)
3492 ; /* do nothing */
3493 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
3494 dev_err (hub_dev, "get_hub_status failed\n");
3495 else {
3496 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
3497 dev_dbg (hub_dev, "power change\n");
3498 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
3499 if (hubstatus & HUB_STATUS_LOCAL_POWER)
3500 /* FIXME: Is this always true? */
3501 hub->limited_power = 1;
3502 else
3503 hub->limited_power = 0;
3505 if (hubchange & HUB_CHANGE_OVERCURRENT) {
3506 u16 status = 0;
3507 u16 unused;
3509 dev_dbg(hub_dev, "over-current change\n");
3510 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
3511 msleep(500); /* Cool down */
3512 hub_power_on(hub, true);
3513 hub_hub_status(hub, &status, &unused);
3514 if (status & HUB_STATUS_OVERCURRENT)
3515 dev_err(hub_dev, "over-current "
3516 "condition\n");
3520 loop_autopm:
3521 /* Balance the usb_autopm_get_interface() above */
3522 usb_autopm_put_interface_no_suspend(intf);
3523 loop:
3524 /* Balance the usb_autopm_get_interface_no_resume() in
3525 * kick_khubd() and allow autosuspend.
3527 usb_autopm_put_interface(intf);
3528 loop_disconnected:
3529 usb_unlock_device(hdev);
3530 kref_put(&hub->kref, hub_release);
3532 } /* end while (1) */
3535 static int hub_thread(void *__unused)
3537 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3538 * port handover. Otherwise it might see that a full-speed device
3539 * was gone before the EHCI controller had handed its port over to
3540 * the companion full-speed controller.
3542 set_freezable();
3544 do {
3545 hub_events();
3546 wait_event_freezable(khubd_wait,
3547 !list_empty(&hub_event_list) ||
3548 kthread_should_stop());
3549 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
3551 pr_debug("%s: khubd exiting\n", usbcore_name);
3552 return 0;
3555 static const struct usb_device_id hub_id_table[] = {
3556 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
3557 .bDeviceClass = USB_CLASS_HUB},
3558 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
3559 .bInterfaceClass = USB_CLASS_HUB},
3560 { } /* Terminating entry */
3563 MODULE_DEVICE_TABLE (usb, hub_id_table);
3565 static struct usb_driver hub_driver = {
3566 .name = "hub",
3567 .probe = hub_probe,
3568 .disconnect = hub_disconnect,
3569 .suspend = hub_suspend,
3570 .resume = hub_resume,
3571 .reset_resume = hub_reset_resume,
3572 .pre_reset = hub_pre_reset,
3573 .post_reset = hub_post_reset,
3574 .unlocked_ioctl = hub_ioctl,
3575 .id_table = hub_id_table,
3576 .supports_autosuspend = 1,
3579 int usb_hub_init(void)
3581 if (usb_register(&hub_driver) < 0) {
3582 printk(KERN_ERR "%s: can't register hub driver\n",
3583 usbcore_name);
3584 return -1;
3587 khubd_task = kthread_run(hub_thread, NULL, "khubd");
3588 if (!IS_ERR(khubd_task))
3589 return 0;
3591 /* Fall through if kernel_thread failed */
3592 usb_deregister(&hub_driver);
3593 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
3595 return -1;
3598 void usb_hub_cleanup(void)
3600 kthread_stop(khubd_task);
3603 * Hub resources are freed for us by usb_deregister. It calls
3604 * usb_driver_purge on every device which in turn calls that
3605 * devices disconnect function if it is using this driver.
3606 * The hub_disconnect function takes care of releasing the
3607 * individual hub resources. -greg
3609 usb_deregister(&hub_driver);
3610 } /* usb_hub_cleanup() */
3612 static int descriptors_changed(struct usb_device *udev,
3613 struct usb_device_descriptor *old_device_descriptor)
3615 int changed = 0;
3616 unsigned index;
3617 unsigned serial_len = 0;
3618 unsigned len;
3619 unsigned old_length;
3620 int length;
3621 char *buf;
3623 if (memcmp(&udev->descriptor, old_device_descriptor,
3624 sizeof(*old_device_descriptor)) != 0)
3625 return 1;
3627 /* Since the idVendor, idProduct, and bcdDevice values in the
3628 * device descriptor haven't changed, we will assume the
3629 * Manufacturer and Product strings haven't changed either.
3630 * But the SerialNumber string could be different (e.g., a
3631 * different flash card of the same brand).
3633 if (udev->serial)
3634 serial_len = strlen(udev->serial) + 1;
3636 len = serial_len;
3637 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3638 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3639 len = max(len, old_length);
3642 buf = kmalloc(len, GFP_NOIO);
3643 if (buf == NULL) {
3644 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
3645 /* assume the worst */
3646 return 1;
3648 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3649 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3650 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
3651 old_length);
3652 if (length != old_length) {
3653 dev_dbg(&udev->dev, "config index %d, error %d\n",
3654 index, length);
3655 changed = 1;
3656 break;
3658 if (memcmp (buf, udev->rawdescriptors[index], old_length)
3659 != 0) {
3660 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
3661 index,
3662 ((struct usb_config_descriptor *) buf)->
3663 bConfigurationValue);
3664 changed = 1;
3665 break;
3669 if (!changed && serial_len) {
3670 length = usb_string(udev, udev->descriptor.iSerialNumber,
3671 buf, serial_len);
3672 if (length + 1 != serial_len) {
3673 dev_dbg(&udev->dev, "serial string error %d\n",
3674 length);
3675 changed = 1;
3676 } else if (memcmp(buf, udev->serial, length) != 0) {
3677 dev_dbg(&udev->dev, "serial string changed\n");
3678 changed = 1;
3682 kfree(buf);
3683 return changed;
3687 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
3688 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3690 * WARNING - don't use this routine to reset a composite device
3691 * (one with multiple interfaces owned by separate drivers)!
3692 * Use usb_reset_device() instead.
3694 * Do a port reset, reassign the device's address, and establish its
3695 * former operating configuration. If the reset fails, or the device's
3696 * descriptors change from their values before the reset, or the original
3697 * configuration and altsettings cannot be restored, a flag will be set
3698 * telling khubd to pretend the device has been disconnected and then
3699 * re-connected. All drivers will be unbound, and the device will be
3700 * re-enumerated and probed all over again.
3702 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3703 * flagged for logical disconnection, or some other negative error code
3704 * if the reset wasn't even attempted.
3706 * The caller must own the device lock. For example, it's safe to use
3707 * this from a driver probe() routine after downloading new firmware.
3708 * For calls that might not occur during probe(), drivers should lock
3709 * the device using usb_lock_device_for_reset().
3711 * Locking exception: This routine may also be called from within an
3712 * autoresume handler. Such usage won't conflict with other tasks
3713 * holding the device lock because these tasks should always call
3714 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
3716 static int usb_reset_and_verify_device(struct usb_device *udev)
3718 struct usb_device *parent_hdev = udev->parent;
3719 struct usb_hub *parent_hub;
3720 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3721 struct usb_device_descriptor descriptor = udev->descriptor;
3722 int i, ret = 0;
3723 int port1 = udev->portnum;
3725 if (udev->state == USB_STATE_NOTATTACHED ||
3726 udev->state == USB_STATE_SUSPENDED) {
3727 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3728 udev->state);
3729 return -EINVAL;
3732 if (!parent_hdev) {
3733 /* this requires hcd-specific logic; see ohci_restart() */
3734 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
3735 return -EISDIR;
3737 parent_hub = hdev_to_hub(parent_hdev);
3739 set_bit(port1, parent_hub->busy_bits);
3740 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3742 /* ep0 maxpacket size may change; let the HCD know about it.
3743 * Other endpoints will be handled by re-enumeration. */
3744 usb_ep0_reinit(udev);
3745 ret = hub_port_init(parent_hub, udev, port1, i);
3746 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
3747 break;
3749 clear_bit(port1, parent_hub->busy_bits);
3751 if (ret < 0)
3752 goto re_enumerate;
3754 /* Device might have changed firmware (DFU or similar) */
3755 if (descriptors_changed(udev, &descriptor)) {
3756 dev_info(&udev->dev, "device firmware changed\n");
3757 udev->descriptor = descriptor; /* for disconnect() calls */
3758 goto re_enumerate;
3761 /* Restore the device's previous configuration */
3762 if (!udev->actconfig)
3763 goto done;
3765 mutex_lock(hcd->bandwidth_mutex);
3766 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
3767 if (ret < 0) {
3768 dev_warn(&udev->dev,
3769 "Busted HC? Not enough HCD resources for "
3770 "old configuration.\n");
3771 mutex_unlock(hcd->bandwidth_mutex);
3772 goto re_enumerate;
3774 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3775 USB_REQ_SET_CONFIGURATION, 0,
3776 udev->actconfig->desc.bConfigurationValue, 0,
3777 NULL, 0, USB_CTRL_SET_TIMEOUT);
3778 if (ret < 0) {
3779 dev_err(&udev->dev,
3780 "can't restore configuration #%d (error=%d)\n",
3781 udev->actconfig->desc.bConfigurationValue, ret);
3782 mutex_unlock(hcd->bandwidth_mutex);
3783 goto re_enumerate;
3785 mutex_unlock(hcd->bandwidth_mutex);
3786 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3788 /* Put interfaces back into the same altsettings as before.
3789 * Don't bother to send the Set-Interface request for interfaces
3790 * that were already in altsetting 0; besides being unnecessary,
3791 * many devices can't handle it. Instead just reset the host-side
3792 * endpoint state.
3794 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3795 struct usb_host_config *config = udev->actconfig;
3796 struct usb_interface *intf = config->interface[i];
3797 struct usb_interface_descriptor *desc;
3799 desc = &intf->cur_altsetting->desc;
3800 if (desc->bAlternateSetting == 0) {
3801 usb_disable_interface(udev, intf, true);
3802 usb_enable_interface(udev, intf, true);
3803 ret = 0;
3804 } else {
3805 /* Let the bandwidth allocation function know that this
3806 * device has been reset, and it will have to use
3807 * alternate setting 0 as the current alternate setting.
3809 intf->resetting_device = 1;
3810 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3811 desc->bAlternateSetting);
3812 intf->resetting_device = 0;
3814 if (ret < 0) {
3815 dev_err(&udev->dev, "failed to restore interface %d "
3816 "altsetting %d (error=%d)\n",
3817 desc->bInterfaceNumber,
3818 desc->bAlternateSetting,
3819 ret);
3820 goto re_enumerate;
3824 done:
3825 return 0;
3827 re_enumerate:
3828 hub_port_logical_disconnect(parent_hub, port1);
3829 return -ENODEV;
3833 * usb_reset_device - warn interface drivers and perform a USB port reset
3834 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3836 * Warns all drivers bound to registered interfaces (using their pre_reset
3837 * method), performs the port reset, and then lets the drivers know that
3838 * the reset is over (using their post_reset method).
3840 * Return value is the same as for usb_reset_and_verify_device().
3842 * The caller must own the device lock. For example, it's safe to use
3843 * this from a driver probe() routine after downloading new firmware.
3844 * For calls that might not occur during probe(), drivers should lock
3845 * the device using usb_lock_device_for_reset().
3847 * If an interface is currently being probed or disconnected, we assume
3848 * its driver knows how to handle resets. For all other interfaces,
3849 * if the driver doesn't have pre_reset and post_reset methods then
3850 * we attempt to unbind it and rebind afterward.
3852 int usb_reset_device(struct usb_device *udev)
3854 int ret;
3855 int i;
3856 struct usb_host_config *config = udev->actconfig;
3858 if (udev->state == USB_STATE_NOTATTACHED ||
3859 udev->state == USB_STATE_SUSPENDED) {
3860 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3861 udev->state);
3862 return -EINVAL;
3865 /* Prevent autosuspend during the reset */
3866 usb_autoresume_device(udev);
3868 if (config) {
3869 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
3870 struct usb_interface *cintf = config->interface[i];
3871 struct usb_driver *drv;
3872 int unbind = 0;
3874 if (cintf->dev.driver) {
3875 drv = to_usb_driver(cintf->dev.driver);
3876 if (drv->pre_reset && drv->post_reset)
3877 unbind = (drv->pre_reset)(cintf);
3878 else if (cintf->condition ==
3879 USB_INTERFACE_BOUND)
3880 unbind = 1;
3881 if (unbind)
3882 usb_forced_unbind_intf(cintf);
3887 ret = usb_reset_and_verify_device(udev);
3889 if (config) {
3890 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
3891 struct usb_interface *cintf = config->interface[i];
3892 struct usb_driver *drv;
3893 int rebind = cintf->needs_binding;
3895 if (!rebind && cintf->dev.driver) {
3896 drv = to_usb_driver(cintf->dev.driver);
3897 if (drv->post_reset)
3898 rebind = (drv->post_reset)(cintf);
3899 else if (cintf->condition ==
3900 USB_INTERFACE_BOUND)
3901 rebind = 1;
3903 if (ret == 0 && rebind)
3904 usb_rebind_intf(cintf);
3908 usb_autosuspend_device(udev);
3909 return ret;
3911 EXPORT_SYMBOL_GPL(usb_reset_device);
3915 * usb_queue_reset_device - Reset a USB device from an atomic context
3916 * @iface: USB interface belonging to the device to reset
3918 * This function can be used to reset a USB device from an atomic
3919 * context, where usb_reset_device() won't work (as it blocks).
3921 * Doing a reset via this method is functionally equivalent to calling
3922 * usb_reset_device(), except for the fact that it is delayed to a
3923 * workqueue. This means that any drivers bound to other interfaces
3924 * might be unbound, as well as users from usbfs in user space.
3926 * Corner cases:
3928 * - Scheduling two resets at the same time from two different drivers
3929 * attached to two different interfaces of the same device is
3930 * possible; depending on how the driver attached to each interface
3931 * handles ->pre_reset(), the second reset might happen or not.
3933 * - If a driver is unbound and it had a pending reset, the reset will
3934 * be cancelled.
3936 * - This function can be called during .probe() or .disconnect()
3937 * times. On return from .disconnect(), any pending resets will be
3938 * cancelled.
3940 * There is no no need to lock/unlock the @reset_ws as schedule_work()
3941 * does its own.
3943 * NOTE: We don't do any reference count tracking because it is not
3944 * needed. The lifecycle of the work_struct is tied to the
3945 * usb_interface. Before destroying the interface we cancel the
3946 * work_struct, so the fact that work_struct is queued and or
3947 * running means the interface (and thus, the device) exist and
3948 * are referenced.
3950 void usb_queue_reset_device(struct usb_interface *iface)
3952 schedule_work(&iface->reset_ws);
3954 EXPORT_SYMBOL_GPL(usb_queue_reset_device);