1 /*
2 * USB hub driver.
3 *
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)
8 *
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;
83 };
85 static inline int hub_is_superspeed(struct usb_device *hdev)
86 {
87 return (hdev->descriptor.bDeviceProtocol == 3);
88 }
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");
109 /*
110 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
111 * 10 seconds to send reply for the initial 64-byte descriptor request.
112 */
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)");
120 /*
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.
127 *
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.
133 */
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.
147 */
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)
159 {
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";
168 }
170 /* Note that hdev or one of its children must be locked! */
171 static struct usb_hub *hdev_to_hub(struct usb_device *hdev)
172 {
173 if (!hdev || !hdev->actconfig)
174 return NULL;
175 return usb_get_intfdata(hdev->actconfig->interface[0]);
176 }
178 /* USB 2.0 spec Section 11.24.4.5 */
179 static int get_hub_descriptor(struct usb_device *hdev, void *data)
180 {
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);
190 }
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;
199 }
200 return -EINVAL;
201 }
203 /*
204 * USB 2.0 spec Section 11.24.2.1
205 */
206 static int clear_hub_feature(struct usb_device *hdev, int feature)
207 {
208 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
209 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
210 }
212 /*
213 * USB 2.0 spec Section 11.24.2.2
214 */
215 static int clear_port_feature(struct usb_device *hdev, int port1, int feature)
216 {
217 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
218 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
219 NULL, 0, 1000);
220 }
222 /*
223 * USB 2.0 spec Section 11.24.2.13
224 */
225 static int set_port_feature(struct usb_device *hdev, int port1, int feature)
226 {
227 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
228 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
229 NULL, 0, 1000);
230 }
232 /*
233 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
234 * for info about using port indicators
235 */
236 static void set_port_led(
237 struct usb_hub *hub,
238 int port1,
239 int selector
240 )
241 {
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);
256 }
258 #define LED_CYCLE_PERIOD ((2*HZ)/3)
260 static void led_work (struct work_struct *work)
261 {
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;
313 }
314 if (selector != HUB_LED_AUTO)
315 changed = 1;
316 set_port_led(hub, i + 1, selector);
317 hub->indicator[i] = mode;
318 }
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++;
325 }
326 if (changed)
327 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
328 }
330 /* use a short timeout for hub/port status fetches */
331 #define USB_STS_TIMEOUT 1000
332 #define USB_STS_RETRIES 5
334 /*
335 * USB 2.0 spec Section 11.24.2.6
336 */
337 static int get_hub_status(struct usb_device *hdev,
338 struct usb_hub_status *data)
339 {
340 int i, status = -ETIMEDOUT;
342 for (i = 0; i < USB_STS_RETRIES &&
343 (status == -ETIMEDOUT || status == -EPIPE); i++) {
344 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
345 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
346 data, sizeof(*data), USB_STS_TIMEOUT);
347 }
348 return status;
349 }
351 /*
352 * USB 2.0 spec Section 11.24.2.7
353 */
354 static int get_port_status(struct usb_device *hdev, int port1,
355 struct usb_port_status *data)
356 {
357 int i, status = -ETIMEDOUT;
359 for (i = 0; i < USB_STS_RETRIES &&
360 (status == -ETIMEDOUT || status == -EPIPE); i++) {
361 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
362 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port1,
363 data, sizeof(*data), USB_STS_TIMEOUT);
364 }
365 return status;
366 }
368 static int hub_port_status(struct usb_hub *hub, int port1,
369 u16 *status, u16 *change)
370 {
371 int ret;
373 mutex_lock(&hub->status_mutex);
374 ret = get_port_status(hub->hdev, port1, &hub->status->port);
375 if (ret < 4) {
376 dev_err(hub->intfdev,
377 "%s failed (err = %d)\n", __func__, ret);
378 if (ret >= 0)
379 ret = -EIO;
380 } else {
381 *status = le16_to_cpu(hub->status->port.wPortStatus);
382 *change = le16_to_cpu(hub->status->port.wPortChange);
384 ret = 0;
385 }
386 mutex_unlock(&hub->status_mutex);
387 return ret;
388 }
390 static void kick_khubd(struct usb_hub *hub)
391 {
392 unsigned long flags;
394 spin_lock_irqsave(&hub_event_lock, flags);
395 if (!hub->disconnected && list_empty(&hub->event_list)) {
396 list_add_tail(&hub->event_list, &hub_event_list);
398 /* Suppress autosuspend until khubd runs */
399 usb_autopm_get_interface_no_resume(
400 to_usb_interface(hub->intfdev));
401 wake_up(&khubd_wait);
402 }
403 spin_unlock_irqrestore(&hub_event_lock, flags);
404 }
406 void usb_kick_khubd(struct usb_device *hdev)
407 {
408 struct usb_hub *hub = hdev_to_hub(hdev);
410 if (hub)
411 kick_khubd(hub);
412 }
415 /* completion function, fires on port status changes and various faults */
416 static void hub_irq(struct urb *urb)
417 {
418 struct usb_hub *hub = urb->context;
419 int status = urb->status;
420 unsigned i;
421 unsigned long bits;
423 switch (status) {
424 case -ENOENT: /* synchronous unlink */
425 case -ECONNRESET: /* async unlink */
426 case -ESHUTDOWN: /* hardware going away */
427 return;
429 default: /* presumably an error */
430 /* Cause a hub reset after 10 consecutive errors */
431 dev_dbg (hub->intfdev, "transfer --> %d\n", status);
432 if ((++hub->nerrors < 10) || hub->error)
433 goto resubmit;
434 hub->error = status;
435 /* FALL THROUGH */
437 /* let khubd handle things */
438 case 0: /* we got data: port status changed */
439 bits = 0;
440 for (i = 0; i < urb->actual_length; ++i)
441 bits |= ((unsigned long) ((*hub->buffer)[i]))
442 << (i*8);
443 hub->event_bits[0] = bits;
444 break;
445 }
447 hub->nerrors = 0;
449 /* Something happened, let khubd figure it out */
450 kick_khubd(hub);
452 resubmit:
453 if (hub->quiescing)
454 return;
456 if ((status = usb_submit_urb (hub->urb, GFP_ATOMIC)) != 0
457 && status != -ENODEV && status != -EPERM)
458 dev_err (hub->intfdev, "resubmit --> %d\n", status);
459 }
461 /* USB 2.0 spec Section 11.24.2.3 */
462 static inline int
463 hub_clear_tt_buffer (struct usb_device *hdev, u16 devinfo, u16 tt)
464 {
465 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
466 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
467 tt, NULL, 0, 1000);
468 }
470 /*
471 * enumeration blocks khubd for a long time. we use keventd instead, since
472 * long blocking there is the exception, not the rule. accordingly, HCDs
473 * talking to TTs must queue control transfers (not just bulk and iso), so
474 * both can talk to the same hub concurrently.
475 */
476 static void hub_tt_work(struct work_struct *work)
477 {
478 struct usb_hub *hub =
479 container_of(work, struct usb_hub, tt.clear_work);
480 unsigned long flags;
481 int limit = 100;
483 spin_lock_irqsave (&hub->tt.lock, flags);
484 while (--limit && !list_empty (&hub->tt.clear_list)) {
485 struct list_head *next;
486 struct usb_tt_clear *clear;
487 struct usb_device *hdev = hub->hdev;
488 const struct hc_driver *drv;
489 int status;
491 next = hub->tt.clear_list.next;
492 clear = list_entry (next, struct usb_tt_clear, clear_list);
493 list_del (&clear->clear_list);
495 /* drop lock so HCD can concurrently report other TT errors */
496 spin_unlock_irqrestore (&hub->tt.lock, flags);
497 status = hub_clear_tt_buffer (hdev, clear->devinfo, clear->tt);
498 if (status)
499 dev_err (&hdev->dev,
500 "clear tt %d (%04x) error %d\n",
501 clear->tt, clear->devinfo, status);
503 /* Tell the HCD, even if the operation failed */
504 drv = clear->hcd->driver;
505 if (drv->clear_tt_buffer_complete)
506 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
508 kfree(clear);
509 spin_lock_irqsave(&hub->tt.lock, flags);
510 }
511 spin_unlock_irqrestore (&hub->tt.lock, flags);
512 }
514 /**
515 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
516 * @urb: an URB associated with the failed or incomplete split transaction
517 *
518 * High speed HCDs use this to tell the hub driver that some split control or
519 * bulk transaction failed in a way that requires clearing internal state of
520 * a transaction translator. This is normally detected (and reported) from
521 * interrupt context.
522 *
523 * It may not be possible for that hub to handle additional full (or low)
524 * speed transactions until that state is fully cleared out.
525 */
526 int usb_hub_clear_tt_buffer(struct urb *urb)
527 {
528 struct usb_device *udev = urb->dev;
529 int pipe = urb->pipe;
530 struct usb_tt *tt = udev->tt;
531 unsigned long flags;
532 struct usb_tt_clear *clear;
534 /* we've got to cope with an arbitrary number of pending TT clears,
535 * since each TT has "at least two" buffers that can need it (and
536 * there can be many TTs per hub). even if they're uncommon.
537 */
538 if ((clear = kmalloc (sizeof *clear, GFP_ATOMIC)) == NULL) {
539 dev_err (&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
540 /* FIXME recover somehow ... RESET_TT? */
541 return -ENOMEM;
542 }
544 /* info that CLEAR_TT_BUFFER needs */
545 clear->tt = tt->multi ? udev->ttport : 1;
546 clear->devinfo = usb_pipeendpoint (pipe);
547 clear->devinfo |= udev->devnum << 4;
548 clear->devinfo |= usb_pipecontrol (pipe)
549 ? (USB_ENDPOINT_XFER_CONTROL << 11)
550 : (USB_ENDPOINT_XFER_BULK << 11);
551 if (usb_pipein (pipe))
552 clear->devinfo |= 1 << 15;
554 /* info for completion callback */
555 clear->hcd = bus_to_hcd(udev->bus);
556 clear->ep = urb->ep;
558 /* tell keventd to clear state for this TT */
559 spin_lock_irqsave (&tt->lock, flags);
560 list_add_tail (&clear->clear_list, &tt->clear_list);
561 schedule_work(&tt->clear_work);
562 spin_unlock_irqrestore (&tt->lock, flags);
563 return 0;
564 }
565 EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
567 /* If do_delay is false, return the number of milliseconds the caller
568 * needs to delay.
569 */
570 static unsigned hub_power_on(struct usb_hub *hub, bool do_delay)
571 {
572 int port1;
573 unsigned pgood_delay = hub->descriptor->bPwrOn2PwrGood * 2;
574 unsigned delay;
575 u16 wHubCharacteristics =
576 le16_to_cpu(hub->descriptor->wHubCharacteristics);
578 /* Enable power on each port. Some hubs have reserved values
579 * of LPSM (> 2) in their descriptors, even though they are
580 * USB 2.0 hubs. Some hubs do not implement port-power switching
581 * but only emulate it. In all cases, the ports won't work
582 * unless we send these messages to the hub.
583 */
584 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2)
585 dev_dbg(hub->intfdev, "enabling power on all ports\n");
586 else
587 dev_dbg(hub->intfdev, "trying to enable port power on "
588 "non-switchable hub\n");
589 for (port1 = 1; port1 <= hub->descriptor->bNbrPorts; port1++)
590 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
592 /* Wait at least 100 msec for power to become stable */
593 delay = max(pgood_delay, (unsigned) 100);
594 if (do_delay)
595 msleep(delay);
596 return delay;
597 }
599 static int hub_hub_status(struct usb_hub *hub,
600 u16 *status, u16 *change)
601 {
602 int ret;
604 mutex_lock(&hub->status_mutex);
605 ret = get_hub_status(hub->hdev, &hub->status->hub);
606 if (ret < 0)
607 dev_err (hub->intfdev,
608 "%s failed (err = %d)\n", __func__, ret);
609 else {
610 *status = le16_to_cpu(hub->status->hub.wHubStatus);
611 *change = le16_to_cpu(hub->status->hub.wHubChange);
612 ret = 0;
613 }
614 mutex_unlock(&hub->status_mutex);
615 return ret;
616 }
618 static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
619 {
620 struct usb_device *hdev = hub->hdev;
621 int ret = 0;
623 if (hdev->children[port1-1] && set_state)
624 usb_set_device_state(hdev->children[port1-1],
625 USB_STATE_NOTATTACHED);
626 if (!hub->error && !hub_is_superspeed(hub->hdev))
627 ret = clear_port_feature(hdev, port1, USB_PORT_FEAT_ENABLE);
628 if (ret)
629 dev_err(hub->intfdev, "cannot disable port %d (err = %d)\n",
630 port1, ret);
631 return ret;
632 }
634 /*
635 * Disable a port and mark a logical connect-change event, so that some
636 * time later khubd will disconnect() any existing usb_device on the port
637 * and will re-enumerate if there actually is a device attached.
638 */
639 static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
640 {
641 dev_dbg(hub->intfdev, "logical disconnect on port %d\n", port1);
642 hub_port_disable(hub, port1, 1);
644 /* FIXME let caller ask to power down the port:
645 * - some devices won't enumerate without a VBUS power cycle
646 * - SRP saves power that way
647 * - ... new call, TBD ...
648 * That's easy if this hub can switch power per-port, and
649 * khubd reactivates the port later (timer, SRP, etc).
650 * Powerdown must be optional, because of reset/DFU.
651 */
653 set_bit(port1, hub->change_bits);
654 kick_khubd(hub);
655 }
657 /**
658 * usb_remove_device - disable a device's port on its parent hub
659 * @udev: device to be disabled and removed
660 * Context: @udev locked, must be able to sleep.
661 *
662 * After @udev's port has been disabled, khubd is notified and it will
663 * see that the device has been disconnected. When the device is
664 * physically unplugged and something is plugged in, the events will
665 * be received and processed normally.
666 */
667 int usb_remove_device(struct usb_device *udev)
668 {
669 struct usb_hub *hub;
670 struct usb_interface *intf;
672 if (!udev->parent) /* Can't remove a root hub */
673 return -EINVAL;
674 hub = hdev_to_hub(udev->parent);
675 intf = to_usb_interface(hub->intfdev);
677 usb_autopm_get_interface(intf);
678 set_bit(udev->portnum, hub->removed_bits);
679 hub_port_logical_disconnect(hub, udev->portnum);
680 usb_autopm_put_interface(intf);
681 return 0;
682 }
684 enum hub_activation_type {
685 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
686 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
687 };
689 static void hub_init_func2(struct work_struct *ws);
690 static void hub_init_func3(struct work_struct *ws);
692 static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
693 {
694 struct usb_device *hdev = hub->hdev;
695 struct usb_hcd *hcd;
696 int ret;
697 int port1;
698 int status;
699 bool need_debounce_delay = false;
700 unsigned delay;
702 /* Continue a partial initialization */
703 if (type == HUB_INIT2)
704 goto init2;
705 if (type == HUB_INIT3)
706 goto init3;
708 /* After a resume, port power should still be on.
709 * For any other type of activation, turn it on.
710 */
711 if (type != HUB_RESUME) {
713 /* Speed up system boot by using a delayed_work for the
714 * hub's initial power-up delays. This is pretty awkward
715 * and the implementation looks like a home-brewed sort of
716 * setjmp/longjmp, but it saves at least 100 ms for each
717 * root hub (assuming usbcore is compiled into the kernel
718 * rather than as a module). It adds up.
719 *
720 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
721 * because for those activation types the ports have to be
722 * operational when we return. In theory this could be done
723 * for HUB_POST_RESET, but it's easier not to.
724 */
725 if (type == HUB_INIT) {
726 delay = hub_power_on(hub, false);
727 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func2);
728 schedule_delayed_work(&hub->init_work,
729 msecs_to_jiffies(delay));
731 /* Suppress autosuspend until init is done */
732 usb_autopm_get_interface_no_resume(
733 to_usb_interface(hub->intfdev));
734 return; /* Continues at init2: below */
735 } else if (type == HUB_RESET_RESUME) {
736 /* The internal host controller state for the hub device
737 * may be gone after a host power loss on system resume.
738 * Update the device's info so the HW knows it's a hub.
739 */
740 hcd = bus_to_hcd(hdev->bus);
741 if (hcd->driver->update_hub_device) {
742 ret = hcd->driver->update_hub_device(hcd, hdev,
743 &hub->tt, GFP_NOIO);
744 if (ret < 0) {
745 dev_err(hub->intfdev, "Host not "
746 "accepting hub info "
747 "update.\n");
748 dev_err(hub->intfdev, "LS/FS devices "
749 "and hubs may not work "
750 "under this hub\n.");
751 }
752 }
753 hub_power_on(hub, true);
754 } else {
755 hub_power_on(hub, true);
756 }
757 }
758 init2:
760 /* Check each port and set hub->change_bits to let khubd know
761 * which ports need attention.
762 */
763 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
764 struct usb_device *udev = hdev->children[port1-1];
765 u16 portstatus, portchange;
767 portstatus = portchange = 0;
768 status = hub_port_status(hub, port1, &portstatus, &portchange);
769 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
770 dev_dbg(hub->intfdev,
771 "port %d: status %04x change %04x\n",
772 port1, portstatus, portchange);
774 /* After anything other than HUB_RESUME (i.e., initialization
775 * or any sort of reset), every port should be disabled.
776 * Unconnected ports should likewise be disabled (paranoia),
777 * and so should ports for which we have no usb_device.
778 */
779 if ((portstatus & USB_PORT_STAT_ENABLE) && (
780 type != HUB_RESUME ||
781 !(portstatus & USB_PORT_STAT_CONNECTION) ||
782 !udev ||
783 udev->state == USB_STATE_NOTATTACHED)) {
784 /*
785 * USB3 protocol ports will automatically transition
786 * to Enabled state when detect an USB3.0 device attach.
787 * Do not disable USB3 protocol ports.
788 */
789 if (!hub_is_superspeed(hdev)) {
790 clear_port_feature(hdev, port1,
791 USB_PORT_FEAT_ENABLE);
792 portstatus &= ~USB_PORT_STAT_ENABLE;
793 } else {
794 /* Pretend that power was lost for USB3 devs */
795 portstatus &= ~USB_PORT_STAT_ENABLE;
796 }
797 }
799 /* Clear status-change flags; we'll debounce later */
800 if (portchange & USB_PORT_STAT_C_CONNECTION) {
801 need_debounce_delay = true;
802 clear_port_feature(hub->hdev, port1,
803 USB_PORT_FEAT_C_CONNECTION);
804 }
805 if (portchange & USB_PORT_STAT_C_ENABLE) {
806 need_debounce_delay = true;
807 clear_port_feature(hub->hdev, port1,
808 USB_PORT_FEAT_C_ENABLE);
809 }
810 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
811 need_debounce_delay = true;
812 clear_port_feature(hub->hdev, port1,
813 USB_PORT_FEAT_C_PORT_LINK_STATE);
814 }
816 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
817 hub_is_superspeed(hub->hdev)) {
818 need_debounce_delay = true;
819 clear_port_feature(hub->hdev, port1,
820 USB_PORT_FEAT_C_BH_PORT_RESET);
821 }
822 /* We can forget about a "removed" device when there's a
823 * physical disconnect or the connect status changes.
824 */
825 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
826 (portchange & USB_PORT_STAT_C_CONNECTION))
827 clear_bit(port1, hub->removed_bits);
829 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
830 /* Tell khubd to disconnect the device or
831 * check for a new connection
832 */
833 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
834 set_bit(port1, hub->change_bits);
836 } else if (portstatus & USB_PORT_STAT_ENABLE) {
837 /* The power session apparently survived the resume.
838 * If there was an overcurrent or suspend change
839 * (i.e., remote wakeup request), have khubd
840 * take care of it.
841 */
842 if (portchange)
843 set_bit(port1, hub->change_bits);
845 } else if (udev->persist_enabled) {
846 #ifdef CONFIG_PM
847 udev->reset_resume = 1;
848 #endif
849 set_bit(port1, hub->change_bits);
851 } else {
852 /* The power session is gone; tell khubd */
853 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
854 set_bit(port1, hub->change_bits);
855 }
856 }
858 /* If no port-status-change flags were set, we don't need any
859 * debouncing. If flags were set we can try to debounce the
860 * ports all at once right now, instead of letting khubd do them
861 * one at a time later on.
862 *
863 * If any port-status changes do occur during this delay, khubd
864 * will see them later and handle them normally.
865 */
866 if (need_debounce_delay) {
867 delay = HUB_DEBOUNCE_STABLE;
869 /* Don't do a long sleep inside a workqueue routine */
870 if (type == HUB_INIT2) {
871 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
872 schedule_delayed_work(&hub->init_work,
873 msecs_to_jiffies(delay));
874 return; /* Continues at init3: below */
875 } else {
876 msleep(delay);
877 }
878 }
879 init3:
880 hub->quiescing = 0;
882 status = usb_submit_urb(hub->urb, GFP_NOIO);
883 if (status < 0)
884 dev_err(hub->intfdev, "activate --> %d\n", status);
885 if (hub->has_indicators && blinkenlights)
886 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
888 /* Scan all ports that need attention */
889 kick_khubd(hub);
891 /* Allow autosuspend if it was suppressed */
892 if (type <= HUB_INIT3)
893 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
894 }
896 /* Implement the continuations for the delays above */
897 static void hub_init_func2(struct work_struct *ws)
898 {
899 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
901 hub_activate(hub, HUB_INIT2);
902 }
904 static void hub_init_func3(struct work_struct *ws)
905 {
906 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
908 hub_activate(hub, HUB_INIT3);
909 }
911 enum hub_quiescing_type {
912 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
913 };
915 static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
916 {
917 struct usb_device *hdev = hub->hdev;
918 int i;
920 cancel_delayed_work_sync(&hub->init_work);
922 /* khubd and related activity won't re-trigger */
923 hub->quiescing = 1;
925 if (type != HUB_SUSPEND) {
926 /* Disconnect all the children */
927 for (i = 0; i < hdev->maxchild; ++i) {
928 if (hdev->children[i])
929 usb_disconnect(&hdev->children[i]);
930 }
931 }
933 /* Stop khubd and related activity */
934 usb_kill_urb(hub->urb);
935 if (hub->has_indicators)
936 cancel_delayed_work_sync(&hub->leds);
937 if (hub->tt.hub)
938 cancel_work_sync(&hub->tt.clear_work);
939 }
941 /* caller has locked the hub device */
942 static int hub_pre_reset(struct usb_interface *intf)
943 {
944 struct usb_hub *hub = usb_get_intfdata(intf);
946 hub_quiesce(hub, HUB_PRE_RESET);
947 return 0;
948 }
950 /* caller has locked the hub device */
951 static int hub_post_reset(struct usb_interface *intf)
952 {
953 struct usb_hub *hub = usb_get_intfdata(intf);
955 hub_activate(hub, HUB_POST_RESET);
956 return 0;
957 }
959 static int hub_configure(struct usb_hub *hub,
960 struct usb_endpoint_descriptor *endpoint)
961 {
962 struct usb_hcd *hcd;
963 struct usb_device *hdev = hub->hdev;
964 struct device *hub_dev = hub->intfdev;
965 u16 hubstatus, hubchange;
966 u16 wHubCharacteristics;
967 unsigned int pipe;
968 int maxp, ret;
969 char *message = "out of memory";
971 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
972 if (!hub->buffer) {
973 ret = -ENOMEM;
974 goto fail;
975 }
977 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
978 if (!hub->status) {
979 ret = -ENOMEM;
980 goto fail;
981 }
982 mutex_init(&hub->status_mutex);
984 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
985 if (!hub->descriptor) {
986 ret = -ENOMEM;
987 goto fail;
988 }
990 if (hub_is_superspeed(hdev) && (hdev->parent != NULL)) {
991 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
992 HUB_SET_DEPTH, USB_RT_HUB,
993 hdev->level - 1, 0, NULL, 0,
994 USB_CTRL_SET_TIMEOUT);
996 if (ret < 0) {
997 message = "can't set hub depth";
998 goto fail;
999 }
1000 }
1002 /* Request the entire hub descriptor.
1003 * hub->descriptor can handle USB_MAXCHILDREN ports,
1004 * but the hub can/will return fewer bytes here.
1005 */
1006 ret = get_hub_descriptor(hdev, hub->descriptor);
1007 if (ret < 0) {
1008 message = "can't read hub descriptor";
1009 goto fail;
1010 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1011 message = "hub has too many ports!";
1012 ret = -ENODEV;
1013 goto fail;
1014 }
1016 hdev->maxchild = hub->descriptor->bNbrPorts;
1017 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
1018 (hdev->maxchild == 1) ? "" : "s");
1020 hub->port_owners = kzalloc(hdev->maxchild * sizeof(void *), GFP_KERNEL);
1021 if (!hub->port_owners) {
1022 ret = -ENOMEM;
1023 goto fail;
1024 }
1026 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1028 /* FIXME for USB 3.0, skip for now */
1029 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1030 !(hub_is_superspeed(hdev))) {
1031 int i;
1032 char portstr [USB_MAXCHILDREN + 1];
1034 for (i = 0; i < hdev->maxchild; i++)
1035 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1036 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1037 ? 'F' : 'R';
1038 portstr[hdev->maxchild] = 0;
1039 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1040 } else
1041 dev_dbg(hub_dev, "standalone hub\n");
1043 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1044 case 0x00:
1045 dev_dbg(hub_dev, "ganged power switching\n");
1046 break;
1047 case 0x01:
1048 dev_dbg(hub_dev, "individual port power switching\n");
1049 break;
1050 case 0x02:
1051 case 0x03:
1052 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1053 break;
1054 }
1056 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1057 case 0x00:
1058 dev_dbg(hub_dev, "global over-current protection\n");
1059 break;
1060 case 0x08:
1061 dev_dbg(hub_dev, "individual port over-current protection\n");
1062 break;
1063 case 0x10:
1064 case 0x18:
1065 dev_dbg(hub_dev, "no over-current protection\n");
1066 break;
1067 }
1069 spin_lock_init (&hub->tt.lock);
1070 INIT_LIST_HEAD (&hub->tt.clear_list);
1071 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1072 switch (hdev->descriptor.bDeviceProtocol) {
1073 case 0:
1074 break;
1075 case 1:
1076 dev_dbg(hub_dev, "Single TT\n");
1077 hub->tt.hub = hdev;
1078 break;
1079 case 2:
1080 ret = usb_set_interface(hdev, 0, 1);
1081 if (ret == 0) {
1082 dev_dbg(hub_dev, "TT per port\n");
1083 hub->tt.multi = 1;
1084 } else
1085 dev_err(hub_dev, "Using single TT (err %d)\n",
1086 ret);
1087 hub->tt.hub = hdev;
1088 break;
1089 case 3:
1090 /* USB 3.0 hubs don't have a TT */
1091 break;
1092 default:
1093 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1094 hdev->descriptor.bDeviceProtocol);
1095 break;
1096 }
1098 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1099 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1100 case HUB_TTTT_8_BITS:
1101 if (hdev->descriptor.bDeviceProtocol != 0) {
1102 hub->tt.think_time = 666;
1103 dev_dbg(hub_dev, "TT requires at most %d "
1104 "FS bit times (%d ns)\n",
1105 8, hub->tt.think_time);
1106 }
1107 break;
1108 case HUB_TTTT_16_BITS:
1109 hub->tt.think_time = 666 * 2;
1110 dev_dbg(hub_dev, "TT requires at most %d "
1111 "FS bit times (%d ns)\n",
1112 16, hub->tt.think_time);
1113 break;
1114 case HUB_TTTT_24_BITS:
1115 hub->tt.think_time = 666 * 3;
1116 dev_dbg(hub_dev, "TT requires at most %d "
1117 "FS bit times (%d ns)\n",
1118 24, hub->tt.think_time);
1119 break;
1120 case HUB_TTTT_32_BITS:
1121 hub->tt.think_time = 666 * 4;
1122 dev_dbg(hub_dev, "TT requires at most %d "
1123 "FS bit times (%d ns)\n",
1124 32, hub->tt.think_time);
1125 break;
1126 }
1128 /* probe() zeroes hub->indicator[] */
1129 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1130 hub->has_indicators = 1;
1131 dev_dbg(hub_dev, "Port indicators are supported\n");
1132 }
1134 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1135 hub->descriptor->bPwrOn2PwrGood * 2);
1137 /* power budgeting mostly matters with bus-powered hubs,
1138 * and battery-powered root hubs (may provide just 8 mA).
1139 */
1140 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1141 if (ret < 2) {
1142 message = "can't get hub status";
1143 goto fail;
1144 }
1145 le16_to_cpus(&hubstatus);
1146 if (hdev == hdev->bus->root_hub) {
1147 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
1148 hub->mA_per_port = 500;
1149 else {
1150 hub->mA_per_port = hdev->bus_mA;
1151 hub->limited_power = 1;
1152 }
1153 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1154 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1155 hub->descriptor->bHubContrCurrent);
1156 hub->limited_power = 1;
1157 if (hdev->maxchild > 0) {
1158 int remaining = hdev->bus_mA -
1159 hub->descriptor->bHubContrCurrent;
1161 if (remaining < hdev->maxchild * 100)
1162 dev_warn(hub_dev,
1163 "insufficient power available "
1164 "to use all downstream ports\n");
1165 hub->mA_per_port = 100; /* 7.2.1.1 */
1166 }
1167 } else { /* Self-powered external hub */
1168 /* FIXME: What about battery-powered external hubs that
1169 * provide less current per port? */
1170 hub->mA_per_port = 500;
1171 }
1172 if (hub->mA_per_port < 500)
1173 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1174 hub->mA_per_port);
1176 /* Update the HCD's internal representation of this hub before khubd
1177 * starts getting port status changes for devices under the hub.
1178 */
1179 hcd = bus_to_hcd(hdev->bus);
1180 if (hcd->driver->update_hub_device) {
1181 ret = hcd->driver->update_hub_device(hcd, hdev,
1182 &hub->tt, GFP_KERNEL);
1183 if (ret < 0) {
1184 message = "can't update HCD hub info";
1185 goto fail;
1186 }
1187 }
1189 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1190 if (ret < 0) {
1191 message = "can't get hub status";
1192 goto fail;
1193 }
1195 /* local power status reports aren't always correct */
1196 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1197 dev_dbg(hub_dev, "local power source is %s\n",
1198 (hubstatus & HUB_STATUS_LOCAL_POWER)
1199 ? "lost (inactive)" : "good");
1201 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1202 dev_dbg(hub_dev, "%sover-current condition exists\n",
1203 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1205 /* set up the interrupt endpoint
1206 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1207 * bytes as USB2.0[11.12.3] says because some hubs are known
1208 * to send more data (and thus cause overflow). For root hubs,
1209 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1210 * to be big enough for at least USB_MAXCHILDREN ports. */
1211 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1212 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1214 if (maxp > sizeof(*hub->buffer))
1215 maxp = sizeof(*hub->buffer);
1217 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1218 if (!hub->urb) {
1219 ret = -ENOMEM;
1220 goto fail;
1221 }
1223 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1224 hub, endpoint->bInterval);
1226 /* maybe cycle the hub leds */
1227 if (hub->has_indicators && blinkenlights)
1228 hub->indicator [0] = INDICATOR_CYCLE;
1230 hub_activate(hub, HUB_INIT);
1231 return 0;
1233 fail:
1234 dev_err (hub_dev, "config failed, %s (err %d)\n",
1235 message, ret);
1236 /* hub_disconnect() frees urb and descriptor */
1237 return ret;
1238 }
1240 static void hub_release(struct kref *kref)
1241 {
1242 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1244 usb_put_intf(to_usb_interface(hub->intfdev));
1245 kfree(hub);
1246 }
1248 static unsigned highspeed_hubs;
1250 static void hub_disconnect(struct usb_interface *intf)
1251 {
1252 struct usb_hub *hub = usb_get_intfdata (intf);
1254 /* Take the hub off the event list and don't let it be added again */
1255 spin_lock_irq(&hub_event_lock);
1256 if (!list_empty(&hub->event_list)) {
1257 list_del_init(&hub->event_list);
1258 usb_autopm_put_interface_no_suspend(intf);
1259 }
1260 hub->disconnected = 1;
1261 spin_unlock_irq(&hub_event_lock);
1263 /* Disconnect all children and quiesce the hub */
1264 hub->error = 0;
1265 hub_quiesce(hub, HUB_DISCONNECT);
1267 usb_set_intfdata (intf, NULL);
1268 hub->hdev->maxchild = 0;
1270 if (hub->hdev->speed == USB_SPEED_HIGH)
1271 highspeed_hubs--;
1273 usb_free_urb(hub->urb);
1274 kfree(hub->port_owners);
1275 kfree(hub->descriptor);
1276 kfree(hub->status);
1277 kfree(hub->buffer);
1279 kref_put(&hub->kref, hub_release);
1280 }
1282 static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1283 {
1284 struct usb_host_interface *desc;
1285 struct usb_endpoint_descriptor *endpoint;
1286 struct usb_device *hdev;
1287 struct usb_hub *hub;
1289 desc = intf->cur_altsetting;
1290 hdev = interface_to_usbdev(intf);
1292 /* Hubs have proper suspend/resume support. USB 3.0 device suspend is
1293 * different from USB 2.0/1.1 device suspend, and unfortunately we
1294 * don't support it yet. So leave autosuspend disabled for USB 3.0
1295 * external hubs for now. Enable autosuspend for USB 3.0 roothubs,
1296 * since that isn't a "real" hub.
1297 */
1298 if (!hub_is_superspeed(hdev) || !hdev->parent)
1299 usb_enable_autosuspend(hdev);
1301 if (hdev->level == MAX_TOPO_LEVEL) {
1302 dev_err(&intf->dev,
1303 "Unsupported bus topology: hub nested too deep\n");
1304 return -E2BIG;
1305 }
1307 #ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1308 if (hdev->parent) {
1309 dev_warn(&intf->dev, "ignoring external hub\n");
1310 return -ENODEV;
1311 }
1312 #endif
1314 /* Some hubs have a subclass of 1, which AFAICT according to the */
1315 /* specs is not defined, but it works */
1316 if ((desc->desc.bInterfaceSubClass != 0) &&
1317 (desc->desc.bInterfaceSubClass != 1)) {
1318 descriptor_error:
1319 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1320 return -EIO;
1321 }
1323 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1324 if (desc->desc.bNumEndpoints != 1)
1325 goto descriptor_error;
1327 endpoint = &desc->endpoint[0].desc;
1329 /* If it's not an interrupt in endpoint, we'd better punt! */
1330 if (!usb_endpoint_is_int_in(endpoint))
1331 goto descriptor_error;
1333 /* We found a hub */
1334 dev_info (&intf->dev, "USB hub found\n");
1336 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1337 if (!hub) {
1338 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1339 return -ENOMEM;
1340 }
1342 kref_init(&hub->kref);
1343 INIT_LIST_HEAD(&hub->event_list);
1344 hub->intfdev = &intf->dev;
1345 hub->hdev = hdev;
1346 INIT_DELAYED_WORK(&hub->leds, led_work);
1347 INIT_DELAYED_WORK(&hub->init_work, NULL);
1348 usb_get_intf(intf);
1350 usb_set_intfdata (intf, hub);
1351 intf->needs_remote_wakeup = 1;
1353 if (hdev->speed == USB_SPEED_HIGH)
1354 highspeed_hubs++;
1356 if (hub_configure(hub, endpoint) >= 0)
1357 return 0;
1359 hub_disconnect (intf);
1360 return -ENODEV;
1361 }
1363 /* No BKL needed */
1364 static int
1365 hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1366 {
1367 struct usb_device *hdev = interface_to_usbdev (intf);
1369 /* assert ifno == 0 (part of hub spec) */
1370 switch (code) {
1371 case USBDEVFS_HUB_PORTINFO: {
1372 struct usbdevfs_hub_portinfo *info = user_data;
1373 int i;
1375 spin_lock_irq(&device_state_lock);
1376 if (hdev->devnum <= 0)
1377 info->nports = 0;
1378 else {
1379 info->nports = hdev->maxchild;
1380 for (i = 0; i < info->nports; i++) {
1381 if (hdev->children[i] == NULL)
1382 info->port[i] = 0;
1383 else
1384 info->port[i] =
1385 hdev->children[i]->devnum;
1386 }
1387 }
1388 spin_unlock_irq(&device_state_lock);
1390 return info->nports + 1;
1391 }
1393 default:
1394 return -ENOSYS;
1395 }
1396 }
1398 /*
1399 * Allow user programs to claim ports on a hub. When a device is attached
1400 * to one of these "claimed" ports, the program will "own" the device.
1401 */
1402 static int find_port_owner(struct usb_device *hdev, unsigned port1,
1403 void ***ppowner)
1404 {
1405 if (hdev->state == USB_STATE_NOTATTACHED)
1406 return -ENODEV;
1407 if (port1 == 0 || port1 > hdev->maxchild)
1408 return -EINVAL;
1410 /* This assumes that devices not managed by the hub driver
1411 * will always have maxchild equal to 0.
1412 */
1413 *ppowner = &(hdev_to_hub(hdev)->port_owners[port1 - 1]);
1414 return 0;
1415 }
1417 /* In the following three functions, the caller must hold hdev's lock */
1418 int usb_hub_claim_port(struct usb_device *hdev, unsigned port1, void *owner)
1419 {
1420 int rc;
1421 void **powner;
1423 rc = find_port_owner(hdev, port1, &powner);
1424 if (rc)
1425 return rc;
1426 if (*powner)
1427 return -EBUSY;
1428 *powner = owner;
1429 return rc;
1430 }
1432 int usb_hub_release_port(struct usb_device *hdev, unsigned port1, void *owner)
1433 {
1434 int rc;
1435 void **powner;
1437 rc = find_port_owner(hdev, port1, &powner);
1438 if (rc)
1439 return rc;
1440 if (*powner != owner)
1441 return -ENOENT;
1442 *powner = NULL;
1443 return rc;
1444 }
1446 void usb_hub_release_all_ports(struct usb_device *hdev, void *owner)
1447 {
1448 int n;
1449 void **powner;
1451 n = find_port_owner(hdev, 1, &powner);
1452 if (n == 0) {
1453 for (; n < hdev->maxchild; (++n, ++powner)) {
1454 if (*powner == owner)
1455 *powner = NULL;
1456 }
1457 }
1458 }
1460 /* The caller must hold udev's lock */
1461 bool usb_device_is_owned(struct usb_device *udev)
1462 {
1463 struct usb_hub *hub;
1465 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1466 return false;
1467 hub = hdev_to_hub(udev->parent);
1468 return !!hub->port_owners[udev->portnum - 1];
1469 }
1472 static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1473 {
1474 int i;
1476 for (i = 0; i < udev->maxchild; ++i) {
1477 if (udev->children[i])
1478 recursively_mark_NOTATTACHED(udev->children[i]);
1479 }
1480 if (udev->state == USB_STATE_SUSPENDED)
1481 udev->active_duration -= jiffies;
1482 udev->state = USB_STATE_NOTATTACHED;
1483 }
1485 /**
1486 * usb_set_device_state - change a device's current state (usbcore, hcds)
1487 * @udev: pointer to device whose state should be changed
1488 * @new_state: new state value to be stored
1489 *
1490 * udev->state is _not_ fully protected by the device lock. Although
1491 * most transitions are made only while holding the lock, the state can
1492 * can change to USB_STATE_NOTATTACHED at almost any time. This
1493 * is so that devices can be marked as disconnected as soon as possible,
1494 * without having to wait for any semaphores to be released. As a result,
1495 * all changes to any device's state must be protected by the
1496 * device_state_lock spinlock.
1497 *
1498 * Once a device has been added to the device tree, all changes to its state
1499 * should be made using this routine. The state should _not_ be set directly.
1500 *
1501 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1502 * Otherwise udev->state is set to new_state, and if new_state is
1503 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1504 * to USB_STATE_NOTATTACHED.
1505 */
1506 void usb_set_device_state(struct usb_device *udev,
1507 enum usb_device_state new_state)
1508 {
1509 unsigned long flags;
1510 int wakeup = -1;
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.
1519 */
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 wakeup = udev->actconfig->desc.bmAttributes
1526 & USB_CONFIG_ATT_WAKEUP;
1527 else
1528 wakeup = 0;
1529 }
1530 if (udev->state == USB_STATE_SUSPENDED &&
1531 new_state != USB_STATE_SUSPENDED)
1532 udev->active_duration -= jiffies;
1533 else if (new_state == USB_STATE_SUSPENDED &&
1534 udev->state != USB_STATE_SUSPENDED)
1535 udev->active_duration += jiffies;
1536 udev->state = new_state;
1537 } else
1538 recursively_mark_NOTATTACHED(udev);
1539 spin_unlock_irqrestore(&device_state_lock, flags);
1540 if (wakeup >= 0)
1541 device_set_wakeup_capable(&udev->dev, wakeup);
1542 }
1543 EXPORT_SYMBOL_GPL(usb_set_device_state);
1545 /*
1546 * Choose a device number.
1547 *
1548 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1549 * USB-2.0 buses they are also used as device addresses, however on
1550 * USB-3.0 buses the address is assigned by the controller hardware
1551 * and it usually is not the same as the device number.
1552 *
1553 * WUSB devices are simple: they have no hubs behind, so the mapping
1554 * device <-> virtual port number becomes 1:1. Why? to simplify the
1555 * life of the device connection logic in
1556 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1557 * handshake we need to assign a temporary address in the unauthorized
1558 * space. For simplicity we use the first virtual port number found to
1559 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1560 * and that becomes it's address [X < 128] or its unauthorized address
1561 * [X | 0x80].
1562 *
1563 * We add 1 as an offset to the one-based USB-stack port number
1564 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1565 * 0 is reserved by USB for default address; (b) Linux's USB stack
1566 * uses always #1 for the root hub of the controller. So USB stack's
1567 * port #1, which is wusb virtual-port #0 has address #2.
1568 *
1569 * Devices connected under xHCI are not as simple. The host controller
1570 * supports virtualization, so the hardware assigns device addresses and
1571 * the HCD must setup data structures before issuing a set address
1572 * command to the hardware.
1573 */
1574 static void choose_devnum(struct usb_device *udev)
1575 {
1576 int devnum;
1577 struct usb_bus *bus = udev->bus;
1579 /* If khubd ever becomes multithreaded, this will need a lock */
1580 if (udev->wusb) {
1581 devnum = udev->portnum + 1;
1582 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1583 } else {
1584 /* Try to allocate the next devnum beginning at
1585 * bus->devnum_next. */
1586 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1587 bus->devnum_next);
1588 if (devnum >= 128)
1589 devnum = find_next_zero_bit(bus->devmap.devicemap,
1590 128, 1);
1591 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1592 }
1593 if (devnum < 128) {
1594 set_bit(devnum, bus->devmap.devicemap);
1595 udev->devnum = devnum;
1596 }
1597 }
1599 static void release_devnum(struct usb_device *udev)
1600 {
1601 if (udev->devnum > 0) {
1602 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1603 udev->devnum = -1;
1604 }
1605 }
1607 static void update_devnum(struct usb_device *udev, int devnum)
1608 {
1609 /* The address for a WUSB device is managed by wusbcore. */
1610 if (!udev->wusb)
1611 udev->devnum = devnum;
1612 }
1614 static void hub_free_dev(struct usb_device *udev)
1615 {
1616 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1618 /* Root hubs aren't real devices, so don't free HCD resources */
1619 if (hcd->driver->free_dev && udev->parent)
1620 hcd->driver->free_dev(hcd, udev);
1621 }
1623 /**
1624 * usb_disconnect - disconnect a device (usbcore-internal)
1625 * @pdev: pointer to device being disconnected
1626 * Context: !in_interrupt ()
1627 *
1628 * Something got disconnected. Get rid of it and all of its children.
1629 *
1630 * If *pdev is a normal device then the parent hub must already be locked.
1631 * If *pdev is a root hub then this routine will acquire the
1632 * usb_bus_list_lock on behalf of the caller.
1633 *
1634 * Only hub drivers (including virtual root hub drivers for host
1635 * controllers) should ever call this.
1636 *
1637 * This call is synchronous, and may not be used in an interrupt context.
1638 */
1639 void usb_disconnect(struct usb_device **pdev)
1640 {
1641 struct usb_device *udev = *pdev;
1642 int i;
1643 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1645 /* mark the device as inactive, so any further urb submissions for
1646 * this device (and any of its children) will fail immediately.
1647 * this quiesces everything except pending urbs.
1648 */
1649 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1650 dev_info(&udev->dev, "USB disconnect, device number %d\n",
1651 udev->devnum);
1653 usb_lock_device(udev);
1655 /* Free up all the children before we remove this device */
1656 for (i = 0; i < USB_MAXCHILDREN; i++) {
1657 if (udev->children[i])
1658 usb_disconnect(&udev->children[i]);
1659 }
1661 /* deallocate hcd/hardware state ... nuking all pending urbs and
1662 * cleaning up all state associated with the current configuration
1663 * so that the hardware is now fully quiesced.
1664 */
1665 dev_dbg (&udev->dev, "unregistering device\n");
1666 mutex_lock(hcd->bandwidth_mutex);
1667 usb_disable_device(udev, 0);
1668 mutex_unlock(hcd->bandwidth_mutex);
1669 usb_hcd_synchronize_unlinks(udev);
1671 usb_remove_ep_devs(&udev->ep0);
1672 usb_unlock_device(udev);
1674 /* Unregister the device. The device driver is responsible
1675 * for de-configuring the device and invoking the remove-device
1676 * notifier chain (used by usbfs and possibly others).
1677 */
1678 device_del(&udev->dev);
1680 /* Free the device number and delete the parent's children[]
1681 * (or root_hub) pointer.
1682 */
1683 release_devnum(udev);
1685 /* Avoid races with recursively_mark_NOTATTACHED() */
1686 spin_lock_irq(&device_state_lock);
1687 *pdev = NULL;
1688 spin_unlock_irq(&device_state_lock);
1690 hub_free_dev(udev);
1692 put_device(&udev->dev);
1693 }
1695 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1696 static void show_string(struct usb_device *udev, char *id, char *string)
1697 {
1698 if (!string)
1699 return;
1700 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1701 }
1703 static void announce_device(struct usb_device *udev)
1704 {
1705 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1706 le16_to_cpu(udev->descriptor.idVendor),
1707 le16_to_cpu(udev->descriptor.idProduct));
1708 dev_info(&udev->dev,
1709 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1710 udev->descriptor.iManufacturer,
1711 udev->descriptor.iProduct,
1712 udev->descriptor.iSerialNumber);
1713 show_string(udev, "Product", udev->product);
1714 show_string(udev, "Manufacturer", udev->manufacturer);
1715 show_string(udev, "SerialNumber", udev->serial);
1716 }
1717 #else
1718 static inline void announce_device(struct usb_device *udev) { }
1719 #endif
1721 #ifdef CONFIG_USB_OTG
1722 #include "otg_whitelist.h"
1723 #endif
1725 /**
1726 * usb_enumerate_device_otg - FIXME (usbcore-internal)
1727 * @udev: newly addressed device (in ADDRESS state)
1728 *
1729 * Finish enumeration for On-The-Go devices
1730 */
1731 static int usb_enumerate_device_otg(struct usb_device *udev)
1732 {
1733 int err = 0;
1735 #ifdef CONFIG_USB_OTG
1736 /*
1737 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1738 * to wake us after we've powered off VBUS; and HNP, switching roles
1739 * "host" to "peripheral". The OTG descriptor helps figure this out.
1740 */
1741 if (!udev->bus->is_b_host
1742 && udev->config
1743 && udev->parent == udev->bus->root_hub) {
1744 struct usb_otg_descriptor *desc = NULL;
1745 struct usb_bus *bus = udev->bus;
1747 /* descriptor may appear anywhere in config */
1748 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1749 le16_to_cpu(udev->config[0].desc.wTotalLength),
1750 USB_DT_OTG, (void **) &desc) == 0) {
1751 if (desc->bmAttributes & USB_OTG_HNP) {
1752 unsigned port1 = udev->portnum;
1754 dev_info(&udev->dev,
1755 "Dual-Role OTG device on %sHNP port\n",
1756 (port1 == bus->otg_port)
1757 ? "" : "non-");
1759 /* enable HNP before suspend, it's simpler */
1760 if (port1 == bus->otg_port)
1761 bus->b_hnp_enable = 1;
1762 err = usb_control_msg(udev,
1763 usb_sndctrlpipe(udev, 0),
1764 USB_REQ_SET_FEATURE, 0,
1765 bus->b_hnp_enable
1766 ? USB_DEVICE_B_HNP_ENABLE
1767 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1768 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1769 if (err < 0) {
1770 /* OTG MESSAGE: report errors here,
1771 * customize to match your product.
1772 */
1773 dev_info(&udev->dev,
1774 "can't set HNP mode: %d\n",
1775 err);
1776 bus->b_hnp_enable = 0;
1777 }
1778 }
1779 }
1780 }
1782 if (!is_targeted(udev)) {
1784 /* Maybe it can talk to us, though we can't talk to it.
1785 * (Includes HNP test device.)
1786 */
1787 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1788 err = usb_port_suspend(udev, PMSG_SUSPEND);
1789 if (err < 0)
1790 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1791 }
1792 err = -ENOTSUPP;
1793 goto fail;
1794 }
1795 fail:
1796 #endif
1797 return err;
1798 }
1801 /**
1802 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
1803 * @udev: newly addressed device (in ADDRESS state)
1804 *
1805 * This is only called by usb_new_device() and usb_authorize_device()
1806 * and FIXME -- all comments that apply to them apply here wrt to
1807 * environment.
1808 *
1809 * If the device is WUSB and not authorized, we don't attempt to read
1810 * the string descriptors, as they will be errored out by the device
1811 * until it has been authorized.
1812 */
1813 static int usb_enumerate_device(struct usb_device *udev)
1814 {
1815 int err;
1817 if (udev->config == NULL) {
1818 err = usb_get_configuration(udev);
1819 if (err < 0) {
1820 dev_err(&udev->dev, "can't read configurations, error %d\n",
1821 err);
1822 goto fail;
1823 }
1824 }
1825 if (udev->wusb == 1 && udev->authorized == 0) {
1826 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1827 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1828 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1829 }
1830 else {
1831 /* read the standard strings and cache them if present */
1832 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1833 udev->manufacturer = usb_cache_string(udev,
1834 udev->descriptor.iManufacturer);
1835 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1836 }
1837 err = usb_enumerate_device_otg(udev);
1838 fail:
1839 return err;
1840 }
1843 /**
1844 * usb_new_device - perform initial device setup (usbcore-internal)
1845 * @udev: newly addressed device (in ADDRESS state)
1846 *
1847 * This is called with devices which have been detected but not fully
1848 * enumerated. The device descriptor is available, but not descriptors
1849 * for any device configuration. The caller must have locked either
1850 * the parent hub (if udev is a normal device) or else the
1851 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1852 * udev has already been installed, but udev is not yet visible through
1853 * sysfs or other filesystem code.
1854 *
1855 * It will return if the device is configured properly or not. Zero if
1856 * the interface was registered with the driver core; else a negative
1857 * errno value.
1858 *
1859 * This call is synchronous, and may not be used in an interrupt context.
1860 *
1861 * Only the hub driver or root-hub registrar should ever call this.
1862 */
1863 int usb_new_device(struct usb_device *udev)
1864 {
1865 int err;
1867 if (udev->parent) {
1868 /* Initialize non-root-hub device wakeup to disabled;
1869 * device (un)configuration controls wakeup capable
1870 * sysfs power/wakeup controls wakeup enabled/disabled
1871 */
1872 device_init_wakeup(&udev->dev, 0);
1873 }
1875 /* Tell the runtime-PM framework the device is active */
1876 pm_runtime_set_active(&udev->dev);
1877 pm_runtime_get_noresume(&udev->dev);
1878 pm_runtime_use_autosuspend(&udev->dev);
1879 pm_runtime_enable(&udev->dev);
1881 /* By default, forbid autosuspend for all devices. It will be
1882 * allowed for hubs during binding.
1883 */
1884 usb_disable_autosuspend(udev);
1886 err = usb_enumerate_device(udev); /* Read descriptors */
1887 if (err < 0)
1888 goto fail;
1889 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
1890 udev->devnum, udev->bus->busnum,
1891 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1892 /* export the usbdev device-node for libusb */
1893 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1894 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1896 /* Tell the world! */
1897 announce_device(udev);
1899 device_enable_async_suspend(&udev->dev);
1900 /* Register the device. The device driver is responsible
1901 * for configuring the device and invoking the add-device
1902 * notifier chain (used by usbfs and possibly others).
1903 */
1904 err = device_add(&udev->dev);
1905 if (err) {
1906 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1907 goto fail;
1908 }
1910 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
1911 usb_mark_last_busy(udev);
1912 pm_runtime_put_sync_autosuspend(&udev->dev);
1913 return err;
1915 fail:
1916 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1917 pm_runtime_disable(&udev->dev);
1918 pm_runtime_set_suspended(&udev->dev);
1919 return err;
1920 }
1923 /**
1924 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1925 * @usb_dev: USB device
1926 *
1927 * Move the USB device to a very basic state where interfaces are disabled
1928 * and the device is in fact unconfigured and unusable.
1929 *
1930 * We share a lock (that we have) with device_del(), so we need to
1931 * defer its call.
1932 */
1933 int usb_deauthorize_device(struct usb_device *usb_dev)
1934 {
1935 usb_lock_device(usb_dev);
1936 if (usb_dev->authorized == 0)
1937 goto out_unauthorized;
1939 usb_dev->authorized = 0;
1940 usb_set_configuration(usb_dev, -1);
1942 kfree(usb_dev->product);
1943 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1944 kfree(usb_dev->manufacturer);
1945 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1946 kfree(usb_dev->serial);
1947 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1949 usb_destroy_configuration(usb_dev);
1950 usb_dev->descriptor.bNumConfigurations = 0;
1952 out_unauthorized:
1953 usb_unlock_device(usb_dev);
1954 return 0;
1955 }
1958 int usb_authorize_device(struct usb_device *usb_dev)
1959 {
1960 int result = 0, c;
1962 usb_lock_device(usb_dev);
1963 if (usb_dev->authorized == 1)
1964 goto out_authorized;
1966 result = usb_autoresume_device(usb_dev);
1967 if (result < 0) {
1968 dev_err(&usb_dev->dev,
1969 "can't autoresume for authorization: %d\n", result);
1970 goto error_autoresume;
1971 }
1972 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
1973 if (result < 0) {
1974 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
1975 "authorization: %d\n", result);
1976 goto error_device_descriptor;
1977 }
1979 kfree(usb_dev->product);
1980 usb_dev->product = NULL;
1981 kfree(usb_dev->manufacturer);
1982 usb_dev->manufacturer = NULL;
1983 kfree(usb_dev->serial);
1984 usb_dev->serial = NULL;
1986 usb_dev->authorized = 1;
1987 result = usb_enumerate_device(usb_dev);
1988 if (result < 0)
1989 goto error_enumerate;
1990 /* Choose and set the configuration. This registers the interfaces
1991 * with the driver core and lets interface drivers bind to them.
1992 */
1993 c = usb_choose_configuration(usb_dev);
1994 if (c >= 0) {
1995 result = usb_set_configuration(usb_dev, c);
1996 if (result) {
1997 dev_err(&usb_dev->dev,
1998 "can't set config #%d, error %d\n", c, result);
1999 /* This need not be fatal. The user can try to
2000 * set other configurations. */
2001 }
2002 }
2003 dev_info(&usb_dev->dev, "authorized to connect\n");
2005 error_enumerate:
2006 error_device_descriptor:
2007 usb_autosuspend_device(usb_dev);
2008 error_autoresume:
2009 out_authorized:
2010 usb_unlock_device(usb_dev); // complements locktree
2011 return result;
2012 }
2015 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2016 static unsigned hub_is_wusb(struct usb_hub *hub)
2017 {
2018 struct usb_hcd *hcd;
2019 if (hub->hdev->parent != NULL) /* not a root hub? */
2020 return 0;
2021 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2022 return hcd->wireless;
2023 }
2026 #define PORT_RESET_TRIES 5
2027 #define SET_ADDRESS_TRIES 2
2028 #define GET_DESCRIPTOR_TRIES 2
2029 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2030 #define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
2032 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2033 #define HUB_SHORT_RESET_TIME 10
2034 #define HUB_BH_RESET_TIME 50
2035 #define HUB_LONG_RESET_TIME 200
2036 #define HUB_RESET_TIMEOUT 500
2038 static int hub_port_reset(struct usb_hub *hub, int port1,
2039 struct usb_device *udev, unsigned int delay, bool warm);
2041 /* Is a USB 3.0 port in the Inactive state? */
2042 static bool hub_port_inactive(struct usb_hub *hub, u16 portstatus)
2043 {
2044 return hub_is_superspeed(hub->hdev) &&
2045 (portstatus & USB_PORT_STAT_LINK_STATE) ==
2046 USB_SS_PORT_LS_SS_INACTIVE;
2047 }
2049 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2050 struct usb_device *udev, unsigned int delay, bool warm)
2051 {
2052 int delay_time, ret;
2053 u16 portstatus;
2054 u16 portchange;
2056 for (delay_time = 0;
2057 delay_time < HUB_RESET_TIMEOUT;
2058 delay_time += delay) {
2059 /* wait to give the device a chance to reset */
2060 msleep(delay);
2062 /* read and decode port status */
2063 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2064 if (ret < 0)
2065 return ret;
2067 /*
2068 * Some buggy devices require a warm reset to be issued even
2069 * when the port appears not to be connected.
2070 */
2071 if (!warm) {
2072 /*
2073 * Some buggy devices can cause an NEC host controller
2074 * to transition to the "Error" state after a hot port
2075 * reset. This will show up as the port state in
2076 * "Inactive", and the port may also report a
2077 * disconnect. Forcing a warm port reset seems to make
2078 * the device work.
2079 *
2080 * See https://bugzilla.kernel.org/show_bug.cgi?id=41752
2081 */
2082 if (hub_port_inactive(hub, portstatus)) {
2083 int ret;
2085 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2086 clear_port_feature(hub->hdev, port1,
2087 USB_PORT_FEAT_C_CONNECTION);
2088 if (portchange & USB_PORT_STAT_C_LINK_STATE)
2089 clear_port_feature(hub->hdev, port1,
2090 USB_PORT_FEAT_C_PORT_LINK_STATE);
2091 if (portchange & USB_PORT_STAT_C_RESET)
2092 clear_port_feature(hub->hdev, port1,
2093 USB_PORT_FEAT_C_RESET);
2094 dev_dbg(hub->intfdev, "hot reset failed, warm reset port %d\n",
2095 port1);
2096 ret = hub_port_reset(hub, port1,
2097 udev, HUB_BH_RESET_TIME,
2098 true);
2099 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2100 clear_port_feature(hub->hdev, port1,
2101 USB_PORT_FEAT_C_CONNECTION);
2102 return ret;
2103 }
2104 /* Device went away? */
2105 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2106 return -ENOTCONN;
2108 /* bomb out completely if the connection bounced */
2109 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2110 return -ENOTCONN;
2112 /* if we`ve finished resetting, then break out of
2113 * the loop
2114 */
2115 if (!(portstatus & USB_PORT_STAT_RESET) &&
2116 (portstatus & USB_PORT_STAT_ENABLE)) {
2117 if (hub_is_wusb(hub))
2118 udev->speed = USB_SPEED_WIRELESS;
2119 else if (hub_is_superspeed(hub->hdev))
2120 udev->speed = USB_SPEED_SUPER;
2121 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2122 udev->speed = USB_SPEED_HIGH;
2123 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2124 udev->speed = USB_SPEED_LOW;
2125 else
2126 udev->speed = USB_SPEED_FULL;
2127 return 0;
2128 }
2129 } else {
2130 if (portchange & USB_PORT_STAT_C_BH_RESET)
2131 return 0;
2132 }
2134 /* switch to the long delay after two short delay failures */
2135 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2136 delay = HUB_LONG_RESET_TIME;
2138 dev_dbg (hub->intfdev,
2139 "port %d not %sreset yet, waiting %dms\n",
2140 port1, warm ? "warm " : "", delay);
2141 }
2143 return -EBUSY;
2144 }
2146 static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2147 struct usb_device *udev, int *status, bool warm)
2148 {
2149 switch (*status) {
2150 case 0:
2151 if (!warm) {
2152 struct usb_hcd *hcd;
2153 /* TRSTRCY = 10 ms; plus some extra */
2154 msleep(10 + 40);
2155 update_devnum(udev, 0);
2156 hcd = bus_to_hcd(udev->bus);
2157 if (hcd->driver->reset_device) {
2158 *status = hcd->driver->reset_device(hcd, udev);
2159 if (*status < 0) {
2160 dev_err(&udev->dev, "Cannot reset "
2161 "HCD device state\n");
2162 break;
2163 }
2164 }
2165 }
2166 /* FALL THROUGH */
2167 case -ENOTCONN:
2168 case -ENODEV:
2169 clear_port_feature(hub->hdev,
2170 port1, USB_PORT_FEAT_C_RESET);
2171 /* FIXME need disconnect() for NOTATTACHED device */
2172 if (warm) {
2173 clear_port_feature(hub->hdev, port1,
2174 USB_PORT_FEAT_C_BH_PORT_RESET);
2175 clear_port_feature(hub->hdev, port1,
2176 USB_PORT_FEAT_C_PORT_LINK_STATE);
2177 } else {
2178 usb_set_device_state(udev, *status
2179 ? USB_STATE_NOTATTACHED
2180 : USB_STATE_DEFAULT);
2181 }
2182 break;
2183 }
2184 }
2186 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2187 static int hub_port_reset(struct usb_hub *hub, int port1,
2188 struct usb_device *udev, unsigned int delay, bool warm)
2189 {
2190 int i, status;
2192 if (!warm) {
2193 /* Block EHCI CF initialization during the port reset.
2194 * Some companion controllers don't like it when they mix.
2195 */
2196 down_read(&ehci_cf_port_reset_rwsem);
2197 } else {
2198 if (!hub_is_superspeed(hub->hdev)) {
2199 dev_err(hub->intfdev, "only USB3 hub support "
2200 "warm reset\n");
2201 return -EINVAL;
2202 }
2203 }
2205 /* Reset the port */
2206 for (i = 0; i < PORT_RESET_TRIES; i++) {
2207 status = set_port_feature(hub->hdev, port1, (warm ?
2208 USB_PORT_FEAT_BH_PORT_RESET :
2209 USB_PORT_FEAT_RESET));
2210 if (status) {
2211 dev_err(hub->intfdev,
2212 "cannot %sreset port %d (err = %d)\n",
2213 warm ? "warm " : "", port1, status);
2214 } else {
2215 status = hub_port_wait_reset(hub, port1, udev, delay,
2216 warm);
2217 if (status && status != -ENOTCONN)
2218 dev_dbg(hub->intfdev,
2219 "port_wait_reset: err = %d\n",
2220 status);
2221 }
2223 /* return on disconnect or reset */
2224 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2225 hub_port_finish_reset(hub, port1, udev, &status, warm);
2226 goto done;
2227 }
2229 dev_dbg (hub->intfdev,
2230 "port %d not enabled, trying %sreset again...\n",
2231 port1, warm ? "warm " : "");
2232 delay = HUB_LONG_RESET_TIME;
2233 }
2235 dev_err (hub->intfdev,
2236 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2237 port1);
2239 done:
2240 if (!warm)
2241 up_read(&ehci_cf_port_reset_rwsem);
2243 return status;
2244 }
2246 /* Check if a port is power on */
2247 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2248 {
2249 int ret = 0;
2251 if (hub_is_superspeed(hub->hdev)) {
2252 if (portstatus & USB_SS_PORT_STAT_POWER)
2253 ret = 1;
2254 } else {
2255 if (portstatus & USB_PORT_STAT_POWER)
2256 ret = 1;
2257 }
2259 return ret;
2260 }
2262 #ifdef CONFIG_PM
2264 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2265 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2266 {
2267 int ret = 0;
2269 if (hub_is_superspeed(hub->hdev)) {
2270 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2271 == USB_SS_PORT_LS_U3)
2272 ret = 1;
2273 } else {
2274 if (portstatus & USB_PORT_STAT_SUSPEND)
2275 ret = 1;
2276 }
2278 return ret;
2279 }
2281 /* Determine whether the device on a port is ready for a normal resume,
2282 * is ready for a reset-resume, or should be disconnected.
2283 */
2284 static int check_port_resume_type(struct usb_device *udev,
2285 struct usb_hub *hub, int port1,
2286 int status, unsigned portchange, unsigned portstatus)
2287 {
2288 /* Is the device still present? */
2289 if (status || port_is_suspended(hub, portstatus) ||
2290 !port_is_power_on(hub, portstatus) ||
2291 !(portstatus & USB_PORT_STAT_CONNECTION)) {
2292 if (status >= 0)
2293 status = -ENODEV;
2294 }
2296 /* Can't do a normal resume if the port isn't enabled,
2297 * so try a reset-resume instead.
2298 */
2299 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2300 if (udev->persist_enabled)
2301 udev->reset_resume = 1;
2302 else
2303 status = -ENODEV;
2304 }
2306 if (status) {
2307 dev_dbg(hub->intfdev,
2308 "port %d status %04x.%04x after resume, %d\n",
2309 port1, portchange, portstatus, status);
2310 } else if (udev->reset_resume) {
2312 /* Late port handoff can set status-change bits */
2313 if (portchange & USB_PORT_STAT_C_CONNECTION)
2314 clear_port_feature(hub->hdev, port1,
2315 USB_PORT_FEAT_C_CONNECTION);
2316 if (portchange & USB_PORT_STAT_C_ENABLE)
2317 clear_port_feature(hub->hdev, port1,
2318 USB_PORT_FEAT_C_ENABLE);
2319 }
2321 return status;
2322 }
2324 #ifdef CONFIG_USB_SUSPEND
2326 /*
2327 * usb_port_suspend - suspend a usb device's upstream port
2328 * @udev: device that's no longer in active use, not a root hub
2329 * Context: must be able to sleep; device not locked; pm locks held
2330 *
2331 * Suspends a USB device that isn't in active use, conserving power.
2332 * Devices may wake out of a suspend, if anything important happens,
2333 * using the remote wakeup mechanism. They may also be taken out of
2334 * suspend by the host, using usb_port_resume(). It's also routine
2335 * to disconnect devices while they are suspended.
2336 *
2337 * This only affects the USB hardware for a device; its interfaces
2338 * (and, for hubs, child devices) must already have been suspended.
2339 *
2340 * Selective port suspend reduces power; most suspended devices draw
2341 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2342 * All devices below the suspended port are also suspended.
2343 *
2344 * Devices leave suspend state when the host wakes them up. Some devices
2345 * also support "remote wakeup", where the device can activate the USB
2346 * tree above them to deliver data, such as a keypress or packet. In
2347 * some cases, this wakes the USB host.
2348 *
2349 * Suspending OTG devices may trigger HNP, if that's been enabled
2350 * between a pair of dual-role devices. That will change roles, such
2351 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2352 *
2353 * Devices on USB hub ports have only one "suspend" state, corresponding
2354 * to ACPI D2, "may cause the device to lose some context".
2355 * State transitions include:
2356 *
2357 * - suspend, resume ... when the VBUS power link stays live
2358 * - suspend, disconnect ... VBUS lost
2359 *
2360 * Once VBUS drop breaks the circuit, the port it's using has to go through
2361 * normal re-enumeration procedures, starting with enabling VBUS power.
2362 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2363 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2364 * timer, no SRP, no requests through sysfs.
2365 *
2366 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2367 * the root hub for their bus goes into global suspend ... so we don't
2368 * (falsely) update the device power state to say it suspended.
2369 *
2370 * Returns 0 on success, else negative errno.
2371 */
2372 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2373 {
2374 struct usb_hub *hub = hdev_to_hub(udev->parent);
2375 int port1 = udev->portnum;
2376 int status;
2378 /* enable remote wakeup when appropriate; this lets the device
2379 * wake up the upstream hub (including maybe the root hub).
2380 *
2381 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2382 * we don't explicitly enable it here.
2383 */
2384 if (udev->do_remote_wakeup) {
2385 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2386 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2387 USB_DEVICE_REMOTE_WAKEUP, 0,
2388 NULL, 0,
2389 USB_CTRL_SET_TIMEOUT);
2390 if (status) {
2391 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2392 status);
2393 /* bail if autosuspend is requested */
2394 if (PMSG_IS_AUTO(msg))
2395 return status;
2396 }
2397 }
2399 /* disable USB2 hardware LPM */
2400 if (udev->usb2_hw_lpm_enabled == 1)
2401 usb_set_usb2_hardware_lpm(udev, 0);
2403 /* see 7.1.7.6 */
2404 if (hub_is_superspeed(hub->hdev))
2405 status = set_port_feature(hub->hdev,
2406 port1 | (USB_SS_PORT_LS_U3 << 3),
2407 USB_PORT_FEAT_LINK_STATE);
2408 else
2409 status = set_port_feature(hub->hdev, port1,
2410 USB_PORT_FEAT_SUSPEND);
2411 if (status) {
2412 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
2413 port1, status);
2414 /* paranoia: "should not happen" */
2415 if (udev->do_remote_wakeup)
2416 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2417 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2418 USB_DEVICE_REMOTE_WAKEUP, 0,
2419 NULL, 0,
2420 USB_CTRL_SET_TIMEOUT);
2422 /* System sleep transitions should never fail */
2423 if (!PMSG_IS_AUTO(msg))
2424 status = 0;
2425 } else {
2426 /* device has up to 10 msec to fully suspend */
2427 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
2428 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
2429 udev->do_remote_wakeup);
2430 usb_set_device_state(udev, USB_STATE_SUSPENDED);
2431 msleep(10);
2432 }
2433 usb_mark_last_busy(hub->hdev);
2434 return status;
2435 }
2437 /*
2438 * If the USB "suspend" state is in use (rather than "global suspend"),
2439 * many devices will be individually taken out of suspend state using
2440 * special "resume" signaling. This routine kicks in shortly after
2441 * hardware resume signaling is finished, either because of selective
2442 * resume (by host) or remote wakeup (by device) ... now see what changed
2443 * in the tree that's rooted at this device.
2444 *
2445 * If @udev->reset_resume is set then the device is reset before the
2446 * status check is done.
2447 */
2448 static int finish_port_resume(struct usb_device *udev)
2449 {
2450 int status = 0;
2451 u16 devstatus;
2453 /* caller owns the udev device lock */
2454 dev_dbg(&udev->dev, "%s\n",
2455 udev->reset_resume ? "finish reset-resume" : "finish resume");
2457 /* usb ch9 identifies four variants of SUSPENDED, based on what
2458 * state the device resumes to. Linux currently won't see the
2459 * first two on the host side; they'd be inside hub_port_init()
2460 * during many timeouts, but khubd can't suspend until later.
2461 */
2462 usb_set_device_state(udev, udev->actconfig
2463 ? USB_STATE_CONFIGURED
2464 : USB_STATE_ADDRESS);
2466 /* 10.5.4.5 says not to reset a suspended port if the attached
2467 * device is enabled for remote wakeup. Hence the reset
2468 * operation is carried out here, after the port has been
2469 * resumed.
2470 */
2471 if (udev->reset_resume)
2472 retry_reset_resume:
2473 status = usb_reset_and_verify_device(udev);
2475 /* 10.5.4.5 says be sure devices in the tree are still there.
2476 * For now let's assume the device didn't go crazy on resume,
2477 * and device drivers will know about any resume quirks.
2478 */
2479 if (status == 0) {
2480 devstatus = 0;
2481 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
2482 if (status >= 0)
2483 status = (status > 0 ? 0 : -ENODEV);
2485 /* If a normal resume failed, try doing a reset-resume */
2486 if (status && !udev->reset_resume && udev->persist_enabled) {
2487 dev_dbg(&udev->dev, "retry with reset-resume\n");
2488 udev->reset_resume = 1;
2489 goto retry_reset_resume;
2490 }
2491 }
2493 if (status) {
2494 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
2495 status);
2496 } else if (udev->actconfig) {
2497 le16_to_cpus(&devstatus);
2498 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
2499 status = usb_control_msg(udev,
2500 usb_sndctrlpipe(udev, 0),
2501 USB_REQ_CLEAR_FEATURE,
2502 USB_RECIP_DEVICE,
2503 USB_DEVICE_REMOTE_WAKEUP, 0,
2504 NULL, 0,
2505 USB_CTRL_SET_TIMEOUT);
2506 if (status)
2507 dev_dbg(&udev->dev,
2508 "disable remote wakeup, status %d\n",
2509 status);
2510 }
2511 status = 0;
2512 }
2513 return status;
2514 }
2516 /*
2517 * usb_port_resume - re-activate a suspended usb device's upstream port
2518 * @udev: device to re-activate, not a root hub
2519 * Context: must be able to sleep; device not locked; pm locks held
2520 *
2521 * This will re-activate the suspended device, increasing power usage
2522 * while letting drivers communicate again with its endpoints.
2523 * USB resume explicitly guarantees that the power session between
2524 * the host and the device is the same as it was when the device
2525 * suspended.
2526 *
2527 * If @udev->reset_resume is set then this routine won't check that the
2528 * port is still enabled. Furthermore, finish_port_resume() above will
2529 * reset @udev. The end result is that a broken power session can be
2530 * recovered and @udev will appear to persist across a loss of VBUS power.
2531 *
2532 * For example, if a host controller doesn't maintain VBUS suspend current
2533 * during a system sleep or is reset when the system wakes up, all the USB
2534 * power sessions below it will be broken. This is especially troublesome
2535 * for mass-storage devices containing mounted filesystems, since the
2536 * device will appear to have disconnected and all the memory mappings
2537 * to it will be lost. Using the USB_PERSIST facility, the device can be
2538 * made to appear as if it had not disconnected.
2539 *
2540 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
2541 * every effort to insure that the same device is present after the
2542 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2543 * quite possible for a device to remain unaltered but its media to be
2544 * changed. If the user replaces a flash memory card while the system is
2545 * asleep, he will have only himself to blame when the filesystem on the
2546 * new card is corrupted and the system crashes.
2547 *
2548 * Returns 0 on success, else negative errno.
2549 */
2550 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2551 {
2552 struct usb_hub *hub = hdev_to_hub(udev->parent);
2553 int port1 = udev->portnum;
2554 int status;
2555 u16 portchange, portstatus;
2557 /* Skip the initial Clear-Suspend step for a remote wakeup */
2558 status = hub_port_status(hub, port1, &portstatus, &portchange);
2559 if (status == 0 && !port_is_suspended(hub, portstatus))
2560 goto SuspendCleared;
2562 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2564 set_bit(port1, hub->busy_bits);
2566 /* see 7.1.7.7; affects power usage, but not budgeting */
2567 if (hub_is_superspeed(hub->hdev))
2568 status = set_port_feature(hub->hdev,
2569 port1 | (USB_SS_PORT_LS_U0 << 3),
2570 USB_PORT_FEAT_LINK_STATE);
2571 else
2572 status = clear_port_feature(hub->hdev,
2573 port1, USB_PORT_FEAT_SUSPEND);
2574 if (status) {
2575 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
2576 port1, status);
2577 } else {
2578 /* drive resume for at least 20 msec */
2579 dev_dbg(&udev->dev, "usb %sresume\n",
2580 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
2581 msleep(25);
2583 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2584 * stop resume signaling. Then finish the resume
2585 * sequence.
2586 */
2587 status = hub_port_status(hub, port1, &portstatus, &portchange);
2589 /* TRSMRCY = 10 msec */
2590 msleep(10);
2591 }
2593 SuspendCleared:
2594 if (status == 0) {
2595 if (hub_is_superspeed(hub->hdev)) {
2596 if (portchange & USB_PORT_STAT_C_LINK_STATE)
2597 clear_port_feature(hub->hdev, port1,
2598 USB_PORT_FEAT_C_PORT_LINK_STATE);
2599 } else {
2600 if (portchange & USB_PORT_STAT_C_SUSPEND)
2601 clear_port_feature(hub->hdev, port1,
2602 USB_PORT_FEAT_C_SUSPEND);
2603 }
2604 }
2606 clear_bit(port1, hub->busy_bits);
2608 status = check_port_resume_type(udev,
2609 hub, port1, status, portchange, portstatus);
2610 if (status == 0)
2611 status = finish_port_resume(udev);
2612 if (status < 0) {
2613 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2614 hub_port_logical_disconnect(hub, port1);
2615 } else {
2616 /* Try to enable USB2 hardware LPM */
2617 if (udev->usb2_hw_lpm_capable == 1)
2618 usb_set_usb2_hardware_lpm(udev, 1);
2619 }
2621 return status;
2622 }
2624 /* caller has locked udev */
2625 int usb_remote_wakeup(struct usb_device *udev)
2626 {
2627 int status = 0;
2629 if (udev->state == USB_STATE_SUSPENDED) {
2630 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
2631 status = usb_autoresume_device(udev);
2632 if (status == 0) {
2633 /* Let the drivers do their thing, then... */
2634 usb_autosuspend_device(udev);
2635 }
2636 }
2637 return status;
2638 }
2640 #else /* CONFIG_USB_SUSPEND */
2642 /* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2644 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2645 {
2646 return 0;
2647 }
2649 /* However we may need to do a reset-resume */
2651 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2652 {
2653 struct usb_hub *hub = hdev_to_hub(udev->parent);
2654 int port1 = udev->portnum;
2655 int status;
2656 u16 portchange, portstatus;
2658 status = hub_port_status(hub, port1, &portstatus, &portchange);
2659 status = check_port_resume_type(udev,
2660 hub, port1, status, portchange, portstatus);
2662 if (status) {
2663 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2664 hub_port_logical_disconnect(hub, port1);
2665 } else if (udev->reset_resume) {
2666 dev_dbg(&udev->dev, "reset-resume\n");
2667 status = usb_reset_and_verify_device(udev);
2668 }
2669 return status;
2670 }
2672 #endif
2674 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
2675 {
2676 struct usb_hub *hub = usb_get_intfdata (intf);
2677 struct usb_device *hdev = hub->hdev;
2678 unsigned port1;
2680 /* Warn if children aren't already suspended */
2681 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2682 struct usb_device *udev;
2684 udev = hdev->children [port1-1];
2685 if (udev && udev->can_submit) {
2686 dev_warn(&intf->dev, "port %d nyet suspended\n", port1);
2687 if (PMSG_IS_AUTO(msg))
2688 return -EBUSY;
2689 }
2690 }
2692 dev_dbg(&intf->dev, "%s\n", __func__);
2694 /* stop khubd and related activity */
2695 hub_quiesce(hub, HUB_SUSPEND);
2696 return 0;
2697 }
2699 static int hub_resume(struct usb_interface *intf)
2700 {
2701 struct usb_hub *hub = usb_get_intfdata(intf);
2703 dev_dbg(&intf->dev, "%s\n", __func__);
2704 hub_activate(hub, HUB_RESUME);
2705 return 0;
2706 }
2708 static int hub_reset_resume(struct usb_interface *intf)
2709 {
2710 struct usb_hub *hub = usb_get_intfdata(intf);
2712 dev_dbg(&intf->dev, "%s\n", __func__);
2713 hub_activate(hub, HUB_RESET_RESUME);
2714 return 0;
2715 }
2717 /**
2718 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2719 * @rhdev: struct usb_device for the root hub
2720 *
2721 * The USB host controller driver calls this function when its root hub
2722 * is resumed and Vbus power has been interrupted or the controller
2723 * has been reset. The routine marks @rhdev as having lost power.
2724 * When the hub driver is resumed it will take notice and carry out
2725 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2726 * the others will be disconnected.
2727 */
2728 void usb_root_hub_lost_power(struct usb_device *rhdev)
2729 {
2730 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
2731 rhdev->reset_resume = 1;
2732 }
2733 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
2735 #else /* CONFIG_PM */
2737 #define hub_suspend NULL
2738 #define hub_resume NULL
2739 #define hub_reset_resume NULL
2740 #endif
2743 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2744 *
2745 * Between connect detection and reset signaling there must be a delay
2746 * of 100ms at least for debounce and power-settling. The corresponding
2747 * timer shall restart whenever the downstream port detects a disconnect.
2748 *
2749 * Apparently there are some bluetooth and irda-dongles and a number of
2750 * low-speed devices for which this debounce period may last over a second.
2751 * Not covered by the spec - but easy to deal with.
2752 *
2753 * This implementation uses a 1500ms total debounce timeout; if the
2754 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2755 * every 25ms for transient disconnects. When the port status has been
2756 * unchanged for 100ms it returns the port status.
2757 */
2758 static int hub_port_debounce(struct usb_hub *hub, int port1)
2759 {
2760 int ret;
2761 int total_time, stable_time = 0;
2762 u16 portchange, portstatus;
2763 unsigned connection = 0xffff;
2765 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2766 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2767 if (ret < 0)
2768 return ret;
2770 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2771 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2772 stable_time += HUB_DEBOUNCE_STEP;
2773 if (stable_time >= HUB_DEBOUNCE_STABLE)
2774 break;
2775 } else {
2776 stable_time = 0;
2777 connection = portstatus & USB_PORT_STAT_CONNECTION;
2778 }
2780 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2781 clear_port_feature(hub->hdev, port1,
2782 USB_PORT_FEAT_C_CONNECTION);
2783 }
2785 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2786 break;
2787 msleep(HUB_DEBOUNCE_STEP);
2788 }
2790 dev_dbg (hub->intfdev,
2791 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2792 port1, total_time, stable_time, portstatus);
2794 if (stable_time < HUB_DEBOUNCE_STABLE)
2795 return -ETIMEDOUT;
2796 return portstatus;
2797 }
2799 void usb_ep0_reinit(struct usb_device *udev)
2800 {
2801 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
2802 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
2803 usb_enable_endpoint(udev, &udev->ep0, true);
2804 }
2805 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
2807 #define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2808 #define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2810 static int hub_set_address(struct usb_device *udev, int devnum)
2811 {
2812 int retval;
2813 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2815 /*
2816 * The host controller will choose the device address,
2817 * instead of the core having chosen it earlier
2818 */
2819 if (!hcd->driver->address_device && devnum <= 1)
2820 return -EINVAL;
2821 if (udev->state == USB_STATE_ADDRESS)
2822 return 0;
2823 if (udev->state != USB_STATE_DEFAULT)
2824 return -EINVAL;
2825 if (hcd->driver->address_device)
2826 retval = hcd->driver->address_device(hcd, udev);
2827 else
2828 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2829 USB_REQ_SET_ADDRESS, 0, devnum, 0,
2830 NULL, 0, USB_CTRL_SET_TIMEOUT);
2831 if (retval == 0) {
2832 update_devnum(udev, devnum);
2833 /* Device now using proper address. */
2834 usb_set_device_state(udev, USB_STATE_ADDRESS);
2835 usb_ep0_reinit(udev);
2836 }
2837 return retval;
2838 }
2840 /* Reset device, (re)assign address, get device descriptor.
2841 * Device connection must be stable, no more debouncing needed.
2842 * Returns device in USB_STATE_ADDRESS, except on error.
2843 *
2844 * If this is called for an already-existing device (as part of
2845 * usb_reset_and_verify_device), the caller must own the device lock. For a
2846 * newly detected device that is not accessible through any global
2847 * pointers, it's not necessary to lock the device.
2848 */
2849 static int
2850 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2851 int retry_counter)
2852 {
2853 static DEFINE_MUTEX(usb_address0_mutex);
2855 struct usb_device *hdev = hub->hdev;
2856 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
2857 int i, j, retval;
2858 unsigned delay = HUB_SHORT_RESET_TIME;
2859 enum usb_device_speed oldspeed = udev->speed;
2860 const char *speed;
2861 int devnum = udev->devnum;
2863 /* root hub ports have a slightly longer reset period
2864 * (from USB 2.0 spec, section 7.1.7.5)
2865 */
2866 if (!hdev->parent) {
2867 delay = HUB_ROOT_RESET_TIME;
2868 if (port1 == hdev->bus->otg_port)
2869 hdev->bus->b_hnp_enable = 0;
2870 }
2872 /* Some low speed devices have problems with the quick delay, so */
2873 /* be a bit pessimistic with those devices. RHbug #23670 */
2874 if (oldspeed == USB_SPEED_LOW)
2875 delay = HUB_LONG_RESET_TIME;
2877 mutex_lock(&usb_address0_mutex);
2879 /* Reset the device; full speed may morph to high speed */
2880 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
2881 retval = hub_port_reset(hub, port1, udev, delay, false);
2882 if (retval < 0) /* error or disconnect */
2883 goto fail;
2884 /* success, speed is known */
2886 retval = -ENODEV;
2888 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2889 dev_dbg(&udev->dev, "device reset changed speed!\n");
2890 goto fail;
2891 }
2892 oldspeed = udev->speed;
2894 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2895 * it's fixed size except for full speed devices.
2896 * For Wireless USB devices, ep0 max packet is always 512 (tho
2897 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2898 */
2899 switch (udev->speed) {
2900 case USB_SPEED_SUPER:
2901 case USB_SPEED_WIRELESS: /* fixed at 512 */
2902 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
2903 break;
2904 case USB_SPEED_HIGH: /* fixed at 64 */
2905 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
2906 break;
2907 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2908 /* to determine the ep0 maxpacket size, try to read
2909 * the device descriptor to get bMaxPacketSize0 and
2910 * then correct our initial guess.
2911 */
2912 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
2913 break;
2914 case USB_SPEED_LOW: /* fixed at 8 */
2915 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
2916 break;
2917 default:
2918 goto fail;
2919 }
2921 if (udev->speed == USB_SPEED_WIRELESS)
2922 speed = "variable speed Wireless";
2923 else
2924 speed = usb_speed_string(udev->speed);
2926 if (udev->speed != USB_SPEED_SUPER)
2927 dev_info(&udev->dev,
2928 "%s %s USB device number %d using %s\n",
2929 (udev->config) ? "reset" : "new", speed,
2930 devnum, udev->bus->controller->driver->name);
2932 /* Set up TT records, if needed */
2933 if (hdev->tt) {
2934 udev->tt = hdev->tt;
2935 udev->ttport = hdev->ttport;
2936 } else if (udev->speed != USB_SPEED_HIGH
2937 && hdev->speed == USB_SPEED_HIGH) {
2938 if (!hub->tt.hub) {
2939 dev_err(&udev->dev, "parent hub has no TT\n");
2940 retval = -EINVAL;
2941 goto fail;
2942 }
2943 udev->tt = &hub->tt;
2944 udev->ttport = port1;
2945 }
2947 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2948 * Because device hardware and firmware is sometimes buggy in
2949 * this area, and this is how Linux has done it for ages.
2950 * Change it cautiously.
2951 *
2952 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2953 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2954 * so it may help with some non-standards-compliant devices.
2955 * Otherwise we start with SET_ADDRESS and then try to read the
2956 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2957 * value.
2958 */
2959 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2960 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
2961 struct usb_device_descriptor *buf;
2962 int r = 0;
2964 #define GET_DESCRIPTOR_BUFSIZE 64
2965 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2966 if (!buf) {
2967 retval = -ENOMEM;
2968 continue;
2969 }
2971 /* Retry on all errors; some devices are flakey.
2972 * 255 is for WUSB devices, we actually need to use
2973 * 512 (WUSB1.0[4.8.1]).
2974 */
2975 for (j = 0; j < 3; ++j) {
2976 buf->bMaxPacketSize0 = 0;
2977 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2978 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2979 USB_DT_DEVICE << 8, 0,
2980 buf, GET_DESCRIPTOR_BUFSIZE,
2981 initial_descriptor_timeout);
2982 switch (buf->bMaxPacketSize0) {
2983 case 8: case 16: case 32: case 64: case 255:
2984 if (buf->bDescriptorType ==
2985 USB_DT_DEVICE) {
2986 r = 0;
2987 break;
2988 }
2989 /* FALL THROUGH */
2990 default:
2991 if (r == 0)
2992 r = -EPROTO;
2993 break;
2994 }
2995 if (r == 0)
2996 break;
2997 }
2998 udev->descriptor.bMaxPacketSize0 =
2999 buf->bMaxPacketSize0;
3000 kfree(buf);
3002 retval = hub_port_reset(hub, port1, udev, delay, false);
3003 if (retval < 0) /* error or disconnect */
3004 goto fail;
3005 if (oldspeed != udev->speed) {
3006 dev_dbg(&udev->dev,
3007 "device reset changed speed!\n");
3008 retval = -ENODEV;
3009 goto fail;
3010 }
3011 if (r) {
3012 dev_err(&udev->dev,
3013 "device descriptor read/64, error %d\n",
3014 r);
3015 retval = -EMSGSIZE;
3016 continue;
3017 }
3018 #undef GET_DESCRIPTOR_BUFSIZE
3019 }
3021 /*
3022 * If device is WUSB, we already assigned an
3023 * unauthorized address in the Connect Ack sequence;
3024 * authorization will assign the final address.
3025 */
3026 if (udev->wusb == 0) {
3027 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
3028 retval = hub_set_address(udev, devnum);
3029 if (retval >= 0)
3030 break;
3031 msleep(200);
3032 }
3033 if (retval < 0) {
3034 dev_err(&udev->dev,
3035 "device not accepting address %d, error %d\n",
3036 devnum, retval);
3037 goto fail;
3038 }
3039 if (udev->speed == USB_SPEED_SUPER) {
3040 devnum = udev->devnum;
3041 dev_info(&udev->dev,
3042 "%s SuperSpeed USB device number %d using %s\n",
3043 (udev->config) ? "reset" : "new",
3044 devnum, udev->bus->controller->driver->name);
3045 }
3047 /* cope with hardware quirkiness:
3048 * - let SET_ADDRESS settle, some device hardware wants it
3049 * - read ep0 maxpacket even for high and low speed,
3050 */
3051 msleep(10);
3052 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
3053 break;
3054 }
3056 retval = usb_get_device_descriptor(udev, 8);
3057 if (retval < 8) {
3058 dev_err(&udev->dev,
3059 "device descriptor read/8, error %d\n",
3060 retval);
3061 if (retval >= 0)
3062 retval = -EMSGSIZE;
3063 } else {
3064 retval = 0;
3065 break;
3066 }
3067 }
3068 if (retval)
3069 goto fail;
3071 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
3072 udev->speed == USB_SPEED_SUPER)
3073 i = 512;
3074 else
3075 i = udev->descriptor.bMaxPacketSize0;
3076 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
3077 if (udev->speed == USB_SPEED_LOW ||
3078 !(i == 8 || i == 16 || i == 32 || i == 64)) {
3079 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
3080 retval = -EMSGSIZE;
3081 goto fail;
3082 }
3083 if (udev->speed == USB_SPEED_FULL)
3084 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
3085 else
3086 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
3087 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
3088 usb_ep0_reinit(udev);
3089 }
3091 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
3092 if (retval < (signed)sizeof(udev->descriptor)) {
3093 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
3094 retval);
3095 if (retval >= 0)
3096 retval = -ENOMSG;
3097 goto fail;
3098 }
3100 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
3101 retval = usb_get_bos_descriptor(udev);
3102 if (!retval) {
3103 if (udev->bos->ext_cap && (USB_LPM_SUPPORT &
3104 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
3105 udev->lpm_capable = 1;
3106 }
3107 }
3109 retval = 0;
3110 /* notify HCD that we have a device connected and addressed */
3111 if (hcd->driver->update_device)
3112 hcd->driver->update_device(hcd, udev);
3113 fail:
3114 if (retval) {
3115 hub_port_disable(hub, port1, 0);
3116 update_devnum(udev, devnum); /* for disconnect processing */
3117 }
3118 mutex_unlock(&usb_address0_mutex);
3119 return retval;
3120 }
3122 static void
3123 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
3124 {
3125 struct usb_qualifier_descriptor *qual;
3126 int status;
3128 qual = kmalloc (sizeof *qual, GFP_KERNEL);
3129 if (qual == NULL)
3130 return;
3132 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
3133 qual, sizeof *qual);
3134 if (status == sizeof *qual) {
3135 dev_info(&udev->dev, "not running at top speed; "
3136 "connect to a high speed hub\n");
3137 /* hub LEDs are probably harder to miss than syslog */
3138 if (hub->has_indicators) {
3139 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
3140 schedule_delayed_work (&hub->leds, 0);
3141 }
3142 }
3143 kfree(qual);
3144 }
3146 static unsigned
3147 hub_power_remaining (struct usb_hub *hub)
3148 {
3149 struct usb_device *hdev = hub->hdev;
3150 int remaining;
3151 int port1;
3153 if (!hub->limited_power)
3154 return 0;
3156 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
3157 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
3158 struct usb_device *udev = hdev->children[port1 - 1];
3159 int delta;
3161 if (!udev)
3162 continue;
3164 /* Unconfigured devices may not use more than 100mA,
3165 * or 8mA for OTG ports */
3166 if (udev->actconfig)
3167 delta = udev->actconfig->desc.bMaxPower * 2;
3168 else if (port1 != udev->bus->otg_port || hdev->parent)
3169 delta = 100;
3170 else
3171 delta = 8;
3172 if (delta > hub->mA_per_port)
3173 dev_warn(&udev->dev,
3174 "%dmA is over %umA budget for port %d!\n",
3175 delta, hub->mA_per_port, port1);
3176 remaining -= delta;
3177 }
3178 if (remaining < 0) {
3179 dev_warn(hub->intfdev, "%dmA over power budget!\n",
3180 - remaining);
3181 remaining = 0;
3182 }
3183 return remaining;
3184 }
3186 /* Handle physical or logical connection change events.
3187 * This routine is called when:
3188 * a port connection-change occurs;
3189 * a port enable-change occurs (often caused by EMI);
3190 * usb_reset_and_verify_device() encounters changed descriptors (as from
3191 * a firmware download)
3192 * caller already locked the hub
3193 */
3194 static void hub_port_connect_change(struct usb_hub *hub, int port1,
3195 u16 portstatus, u16 portchange)
3196 {
3197 struct usb_device *hdev = hub->hdev;
3198 struct device *hub_dev = hub->intfdev;
3199 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
3200 unsigned wHubCharacteristics =
3201 le16_to_cpu(hub->descriptor->wHubCharacteristics);
3202 struct usb_device *udev;
3203 int status, i;
3205 dev_dbg (hub_dev,
3206 "port %d, status %04x, change %04x, %s\n",
3207 port1, portstatus, portchange, portspeed(hub, portstatus));
3209 if (hub->has_indicators) {
3210 set_port_led(hub, port1, HUB_LED_AUTO);
3211 hub->indicator[port1-1] = INDICATOR_AUTO;
3212 }
3214 #ifdef CONFIG_USB_OTG
3215 /* during HNP, don't repeat the debounce */
3216 if (hdev->bus->is_b_host)
3217 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
3218 USB_PORT_STAT_C_ENABLE);
3219 #endif
3221 /* Try to resuscitate an existing device */
3222 udev = hdev->children[port1-1];
3223 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
3224 udev->state != USB_STATE_NOTATTACHED) {
3225 usb_lock_device(udev);
3226 if (portstatus & USB_PORT_STAT_ENABLE) {
3227 status = 0; /* Nothing to do */
3229 #ifdef CONFIG_USB_SUSPEND
3230 } else if (udev->state == USB_STATE_SUSPENDED &&
3231 udev->persist_enabled) {
3232 /* For a suspended device, treat this as a
3233 * remote wakeup event.
3234 */
3235 status = usb_remote_wakeup(udev);
3236 #endif
3238 } else {
3239 status = -ENODEV; /* Don't resuscitate */
3240 }
3241 usb_unlock_device(udev);
3243 if (status == 0) {
3244 clear_bit(port1, hub->change_bits);
3245 return;
3246 }
3247 }
3249 /* Disconnect any existing devices under this port */
3250 if (udev)
3251 usb_disconnect(&hdev->children[port1-1]);
3252 clear_bit(port1, hub->change_bits);
3254 /* We can forget about a "removed" device when there's a physical
3255 * disconnect or the connect status changes.
3256 */
3257 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3258 (portchange & USB_PORT_STAT_C_CONNECTION))
3259 clear_bit(port1, hub->removed_bits);
3261 if (portchange & (USB_PORT_STAT_C_CONNECTION |
3262 USB_PORT_STAT_C_ENABLE)) {
3263 status = hub_port_debounce(hub, port1);
3264 if (status < 0) {
3265 if (printk_ratelimit())
3266 dev_err(hub_dev, "connect-debounce failed, "
3267 "port %d disabled\n", port1);
3268 portstatus &= ~USB_PORT_STAT_CONNECTION;
3269 } else {
3270 portstatus = status;
3271 }
3272 }
3274 /* Return now if debouncing failed or nothing is connected or
3275 * the device was "removed".
3276 */
3277 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3278 test_bit(port1, hub->removed_bits)) {
3280 /* maybe switch power back on (e.g. root hub was reset) */
3281 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
3282 && !port_is_power_on(hub, portstatus))
3283 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
3285 if (portstatus & USB_PORT_STAT_ENABLE)
3286 goto done;
3287 return;
3288 }
3290 for (i = 0; i < SET_CONFIG_TRIES; i++) {
3292 /* reallocate for each attempt, since references
3293 * to the previous one can escape in various ways
3294 */
3295 udev = usb_alloc_dev(hdev, hdev->bus, port1);
3296 if (!udev) {
3297 dev_err (hub_dev,
3298 "couldn't allocate port %d usb_device\n",
3299 port1);
3300 goto done;
3301 }
3303 usb_set_device_state(udev, USB_STATE_POWERED);
3304 udev->bus_mA = hub->mA_per_port;
3305 udev->level = hdev->level + 1;
3306 udev->wusb = hub_is_wusb(hub);
3308 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
3309 if (hub_is_superspeed(hub->hdev))
3310 udev->speed = USB_SPEED_SUPER;
3311 else
3312 udev->speed = USB_SPEED_UNKNOWN;
3314 choose_devnum(udev);
3315 if (udev->devnum <= 0) {
3316 status = -ENOTCONN; /* Don't retry */
3317 goto loop;
3318 }
3320 /* reset (non-USB 3.0 devices) and get descriptor */
3321 status = hub_port_init(hub, udev, port1, i);
3322 if (status < 0)
3323 goto loop;
3325 usb_detect_quirks(udev);
3326 if (udev->quirks & USB_QUIRK_DELAY_INIT)
3327 msleep(1000);
3329 /* consecutive bus-powered hubs aren't reliable; they can
3330 * violate the voltage drop budget. if the new child has
3331 * a "powered" LED, users should notice we didn't enable it
3332 * (without reading syslog), even without per-port LEDs
3333 * on the parent.
3334 */
3335 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
3336 && udev->bus_mA <= 100) {
3337 u16 devstat;
3339 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
3340 &devstat);
3341 if (status < 2) {
3342 dev_dbg(&udev->dev, "get status %d ?\n", status);
3343 goto loop_disable;
3344 }
3345 le16_to_cpus(&devstat);
3346 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
3347 dev_err(&udev->dev,
3348 "can't connect bus-powered hub "
3349 "to this port\n");
3350 if (hub->has_indicators) {
3351 hub->indicator[port1-1] =
3352 INDICATOR_AMBER_BLINK;
3353 schedule_delayed_work (&hub->leds, 0);
3354 }
3355 status = -ENOTCONN; /* Don't retry */
3356 goto loop_disable;
3357 }
3358 }
3360 /* check for devices running slower than they could */
3361 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
3362 && udev->speed == USB_SPEED_FULL
3363 && highspeed_hubs != 0)
3364 check_highspeed (hub, udev, port1);
3366 /* Store the parent's children[] pointer. At this point
3367 * udev becomes globally accessible, although presumably
3368 * no one will look at it until hdev is unlocked.
3369 */
3370 status = 0;
3372 /* We mustn't add new devices if the parent hub has
3373 * been disconnected; we would race with the
3374 * recursively_mark_NOTATTACHED() routine.
3375 */
3376 spin_lock_irq(&device_state_lock);
3377 if (hdev->state == USB_STATE_NOTATTACHED)
3378 status = -ENOTCONN;
3379 else
3380 hdev->children[port1-1] = udev;
3381 spin_unlock_irq(&device_state_lock);
3383 /* Run it through the hoops (find a driver, etc) */
3384 if (!status) {
3385 status = usb_new_device(udev);
3386 if (status) {
3387 spin_lock_irq(&device_state_lock);
3388 hdev->children[port1-1] = NULL;
3389 spin_unlock_irq(&device_state_lock);
3390 }
3391 }
3393 if (status)
3394 goto loop_disable;
3396 status = hub_power_remaining(hub);
3397 if (status)
3398 dev_dbg(hub_dev, "%dmA power budget left\n", status);
3400 return;
3402 loop_disable:
3403 hub_port_disable(hub, port1, 1);
3404 loop:
3405 usb_ep0_reinit(udev);
3406 release_devnum(udev);
3407 hub_free_dev(udev);
3408 usb_put_dev(udev);
3409 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
3410 break;
3411 }
3412 if (hub->hdev->parent ||
3413 !hcd->driver->port_handed_over ||
3414 !(hcd->driver->port_handed_over)(hcd, port1))
3415 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
3416 port1);
3418 done:
3419 hub_port_disable(hub, port1, 1);
3420 if (hcd->driver->relinquish_port && !hub->hdev->parent)
3421 hcd->driver->relinquish_port(hcd, port1);
3422 }
3424 static void hub_events(void)
3425 {
3426 struct list_head *tmp;
3427 struct usb_device *hdev;
3428 struct usb_interface *intf;
3429 struct usb_hub *hub;
3430 struct device *hub_dev;
3431 u16 hubstatus;
3432 u16 hubchange;
3433 u16 portstatus;
3434 u16 portchange;
3435 int i, ret;
3436 int connect_change;
3438 /*
3439 * We restart the list every time to avoid a deadlock with
3440 * deleting hubs downstream from this one. This should be
3441 * safe since we delete the hub from the event list.
3442 * Not the most efficient, but avoids deadlocks.
3443 */
3444 while (1) {
3446 /* Grab the first entry at the beginning of the list */
3447 spin_lock_irq(&hub_event_lock);
3448 if (list_empty(&hub_event_list)) {
3449 spin_unlock_irq(&hub_event_lock);
3450 break;
3451 }
3453 tmp = hub_event_list.next;
3454 list_del_init(tmp);
3456 hub = list_entry(tmp, struct usb_hub, event_list);
3457 kref_get(&hub->kref);
3458 spin_unlock_irq(&hub_event_lock);
3460 hdev = hub->hdev;
3461 hub_dev = hub->intfdev;
3462 intf = to_usb_interface(hub_dev);
3463 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
3464 hdev->state, hub->descriptor
3465 ? hub->descriptor->bNbrPorts
3466 : 0,
3467 /* NOTE: expects max 15 ports... */
3468 (u16) hub->change_bits[0],
3469 (u16) hub->event_bits[0]);
3471 /* Lock the device, then check to see if we were
3472 * disconnected while waiting for the lock to succeed. */
3473 usb_lock_device(hdev);
3474 if (unlikely(hub->disconnected))
3475 goto loop_disconnected;
3477 /* If the hub has died, clean up after it */
3478 if (hdev->state == USB_STATE_NOTATTACHED) {
3479 hub->error = -ENODEV;
3480 hub_quiesce(hub, HUB_DISCONNECT);
3481 goto loop;
3482 }
3484 /* Autoresume */
3485 ret = usb_autopm_get_interface(intf);
3486 if (ret) {
3487 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
3488 goto loop;
3489 }
3491 /* If this is an inactive hub, do nothing */
3492 if (hub->quiescing)
3493 goto loop_autopm;
3495 if (hub->error) {
3496 dev_dbg (hub_dev, "resetting for error %d\n",
3497 hub->error);
3499 ret = usb_reset_device(hdev);
3500 if (ret) {
3501 dev_dbg (hub_dev,
3502 "error resetting hub: %d\n", ret);
3503 goto loop_autopm;
3504 }
3506 hub->nerrors = 0;
3507 hub->error = 0;
3508 }
3510 /* deal with port status changes */
3511 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
3512 if (test_bit(i, hub->busy_bits))
3513 continue;
3514 connect_change = test_bit(i, hub->change_bits);
3515 if (!test_and_clear_bit(i, hub->event_bits) &&
3516 !connect_change)
3517 continue;
3519 ret = hub_port_status(hub, i,
3520 &portstatus, &portchange);
3521 if (ret < 0)
3522 continue;
3524 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3525 clear_port_feature(hdev, i,
3526 USB_PORT_FEAT_C_CONNECTION);
3527 connect_change = 1;
3528 }
3530 if (portchange & USB_PORT_STAT_C_ENABLE) {
3531 if (!connect_change)
3532 dev_dbg (hub_dev,
3533 "port %d enable change, "
3534 "status %08x\n",
3535 i, portstatus);
3536 clear_port_feature(hdev, i,
3537 USB_PORT_FEAT_C_ENABLE);
3539 /*
3540 * EM interference sometimes causes badly
3541 * shielded USB devices to be shutdown by
3542 * the hub, this hack enables them again.
3543 * Works at least with mouse driver.
3544 */
3545 if (!(portstatus & USB_PORT_STAT_ENABLE)
3546 && !connect_change
3547 && hdev->children[i-1]) {
3548 dev_err (hub_dev,
3549 "port %i "
3550 "disabled by hub (EMI?), "
3551 "re-enabling...\n",
3552 i);
3553 connect_change = 1;
3554 }
3555 }
3557 if (portchange & USB_PORT_STAT_C_SUSPEND) {
3558 struct usb_device *udev;
3560 clear_port_feature(hdev, i,
3561 USB_PORT_FEAT_C_SUSPEND);
3562 udev = hdev->children[i-1];
3563 if (udev) {
3564 /* TRSMRCY = 10 msec */
3565 msleep(10);
3567 usb_lock_device(udev);
3568 ret = usb_remote_wakeup(hdev->
3569 children[i-1]);
3570 usb_unlock_device(udev);
3571 if (ret < 0)
3572 connect_change = 1;
3573 } else {
3574 ret = -ENODEV;
3575 hub_port_disable(hub, i, 1);
3576 }
3577 dev_dbg (hub_dev,
3578 "resume on port %d, status %d\n",
3579 i, ret);
3580 }
3582 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
3583 u16 status = 0;
3584 u16 unused;
3586 dev_dbg(hub_dev, "over-current change on port "
3587 "%d\n", i);
3588 clear_port_feature(hdev, i,
3589 USB_PORT_FEAT_C_OVER_CURRENT);
3590 msleep(100); /* Cool down */
3591 hub_power_on(hub, true);
3592 hub_port_status(hub, i, &status, &unused);
3593 if (status & USB_PORT_STAT_OVERCURRENT)
3594 dev_err(hub_dev, "over-current "
3595 "condition on port %d\n", i);
3596 }
3598 if (portchange & USB_PORT_STAT_C_RESET) {
3599 dev_dbg (hub_dev,
3600 "reset change on port %d\n",
3601 i);
3602 clear_port_feature(hdev, i,
3603 USB_PORT_FEAT_C_RESET);
3604 }
3605 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
3606 hub_is_superspeed(hub->hdev)) {
3607 dev_dbg(hub_dev,
3608 "warm reset change on port %d\n",
3609 i);
3610 clear_port_feature(hdev, i,
3611 USB_PORT_FEAT_C_BH_PORT_RESET);
3612 }
3613 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
3614 clear_port_feature(hub->hdev, i,
3615 USB_PORT_FEAT_C_PORT_LINK_STATE);
3616 }
3617 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
3618 dev_warn(hub_dev,
3619 "config error on port %d\n",
3620 i);
3621 clear_port_feature(hub->hdev, i,
3622 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
3623 }
3625 /* Warm reset a USB3 protocol port if it's in
3626 * SS.Inactive state.
3627 */
3628 if (hub_is_superspeed(hub->hdev) &&
3629 (portstatus & USB_PORT_STAT_LINK_STATE)
3630 == USB_SS_PORT_LS_SS_INACTIVE) {
3631 dev_dbg(hub_dev, "warm reset port %d\n", i);
3632 hub_port_reset(hub, i, NULL,
3633 HUB_BH_RESET_TIME, true);
3634 }
3636 if (connect_change)
3637 hub_port_connect_change(hub, i,
3638 portstatus, portchange);
3639 } /* end for i */
3641 /* deal with hub status changes */
3642 if (test_and_clear_bit(0, hub->event_bits) == 0)
3643 ; /* do nothing */
3644 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
3645 dev_err (hub_dev, "get_hub_status failed\n");
3646 else {
3647 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
3648 dev_dbg (hub_dev, "power change\n");
3649 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
3650 if (hubstatus & HUB_STATUS_LOCAL_POWER)
3651 /* FIXME: Is this always true? */
3652 hub->limited_power = 1;
3653 else
3654 hub->limited_power = 0;
3655 }
3656 if (hubchange & HUB_CHANGE_OVERCURRENT) {
3657 u16 status = 0;
3658 u16 unused;
3660 dev_dbg(hub_dev, "over-current change\n");
3661 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
3662 msleep(500); /* Cool down */
3663 hub_power_on(hub, true);
3664 hub_hub_status(hub, &status, &unused);
3665 if (status & HUB_STATUS_OVERCURRENT)
3666 dev_err(hub_dev, "over-current "
3667 "condition\n");
3668 }
3669 }
3671 loop_autopm:
3672 /* Balance the usb_autopm_get_interface() above */
3673 usb_autopm_put_interface_no_suspend(intf);
3674 loop:
3675 /* Balance the usb_autopm_get_interface_no_resume() in
3676 * kick_khubd() and allow autosuspend.
3677 */
3678 usb_autopm_put_interface(intf);
3679 loop_disconnected:
3680 usb_unlock_device(hdev);
3681 kref_put(&hub->kref, hub_release);
3683 } /* end while (1) */
3684 }
3686 static int hub_thread(void *__unused)
3687 {
3688 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3689 * port handover. Otherwise it might see that a full-speed device
3690 * was gone before the EHCI controller had handed its port over to
3691 * the companion full-speed controller.
3692 */
3693 set_freezable();
3695 do {
3696 hub_events();
3697 wait_event_freezable(khubd_wait,
3698 !list_empty(&hub_event_list) ||
3699 kthread_should_stop());
3700 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
3702 pr_debug("%s: khubd exiting\n", usbcore_name);
3703 return 0;
3704 }
3706 static const struct usb_device_id hub_id_table[] = {
3707 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
3708 .bDeviceClass = USB_CLASS_HUB},
3709 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
3710 .bInterfaceClass = USB_CLASS_HUB},
3711 { } /* Terminating entry */
3712 };
3714 MODULE_DEVICE_TABLE (usb, hub_id_table);
3716 static struct usb_driver hub_driver = {
3717 .name = "hub",
3718 .probe = hub_probe,
3719 .disconnect = hub_disconnect,
3720 .suspend = hub_suspend,
3721 .resume = hub_resume,
3722 .reset_resume = hub_reset_resume,
3723 .pre_reset = hub_pre_reset,
3724 .post_reset = hub_post_reset,
3725 .unlocked_ioctl = hub_ioctl,
3726 .id_table = hub_id_table,
3727 .supports_autosuspend = 1,
3728 };
3730 int usb_hub_init(void)
3731 {
3732 if (usb_register(&hub_driver) < 0) {
3733 printk(KERN_ERR "%s: can't register hub driver\n",
3734 usbcore_name);
3735 return -1;
3736 }
3738 khubd_task = kthread_run(hub_thread, NULL, "khubd");
3739 if (!IS_ERR(khubd_task))
3740 return 0;
3742 /* Fall through if kernel_thread failed */
3743 usb_deregister(&hub_driver);
3744 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
3746 return -1;
3747 }
3749 void usb_hub_cleanup(void)
3750 {
3751 kthread_stop(khubd_task);
3753 /*
3754 * Hub resources are freed for us by usb_deregister. It calls
3755 * usb_driver_purge on every device which in turn calls that
3756 * devices disconnect function if it is using this driver.
3757 * The hub_disconnect function takes care of releasing the
3758 * individual hub resources. -greg
3759 */
3760 usb_deregister(&hub_driver);
3761 } /* usb_hub_cleanup() */
3763 static int descriptors_changed(struct usb_device *udev,
3764 struct usb_device_descriptor *old_device_descriptor)
3765 {
3766 int changed = 0;
3767 unsigned index;
3768 unsigned serial_len = 0;
3769 unsigned len;
3770 unsigned old_length;
3771 int length;
3772 char *buf;
3774 if (memcmp(&udev->descriptor, old_device_descriptor,
3775 sizeof(*old_device_descriptor)) != 0)
3776 return 1;
3778 /* Since the idVendor, idProduct, and bcdDevice values in the
3779 * device descriptor haven't changed, we will assume the
3780 * Manufacturer and Product strings haven't changed either.
3781 * But the SerialNumber string could be different (e.g., a
3782 * different flash card of the same brand).
3783 */
3784 if (udev->serial)
3785 serial_len = strlen(udev->serial) + 1;
3787 len = serial_len;
3788 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3789 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3790 len = max(len, old_length);
3791 }
3793 buf = kmalloc(len, GFP_NOIO);
3794 if (buf == NULL) {
3795 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
3796 /* assume the worst */
3797 return 1;
3798 }
3799 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3800 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3801 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
3802 old_length);
3803 if (length != old_length) {
3804 dev_dbg(&udev->dev, "config index %d, error %d\n",
3805 index, length);
3806 changed = 1;
3807 break;
3808 }
3809 if (memcmp (buf, udev->rawdescriptors[index], old_length)
3810 != 0) {
3811 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
3812 index,
3813 ((struct usb_config_descriptor *) buf)->
3814 bConfigurationValue);
3815 changed = 1;
3816 break;
3817 }
3818 }
3820 if (!changed && serial_len) {
3821 length = usb_string(udev, udev->descriptor.iSerialNumber,
3822 buf, serial_len);
3823 if (length + 1 != serial_len) {
3824 dev_dbg(&udev->dev, "serial string error %d\n",
3825 length);
3826 changed = 1;
3827 } else if (memcmp(buf, udev->serial, length) != 0) {
3828 dev_dbg(&udev->dev, "serial string changed\n");
3829 changed = 1;
3830 }
3831 }
3833 kfree(buf);
3834 return changed;
3835 }
3837 /**
3838 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
3839 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3840 *
3841 * WARNING - don't use this routine to reset a composite device
3842 * (one with multiple interfaces owned by separate drivers)!
3843 * Use usb_reset_device() instead.
3844 *
3845 * Do a port reset, reassign the device's address, and establish its
3846 * former operating configuration. If the reset fails, or the device's
3847 * descriptors change from their values before the reset, or the original
3848 * configuration and altsettings cannot be restored, a flag will be set
3849 * telling khubd to pretend the device has been disconnected and then
3850 * re-connected. All drivers will be unbound, and the device will be
3851 * re-enumerated and probed all over again.
3852 *
3853 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3854 * flagged for logical disconnection, or some other negative error code
3855 * if the reset wasn't even attempted.
3856 *
3857 * The caller must own the device lock. For example, it's safe to use
3858 * this from a driver probe() routine after downloading new firmware.
3859 * For calls that might not occur during probe(), drivers should lock
3860 * the device using usb_lock_device_for_reset().
3861 *
3862 * Locking exception: This routine may also be called from within an
3863 * autoresume handler. Such usage won't conflict with other tasks
3864 * holding the device lock because these tasks should always call
3865 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
3866 */
3867 static int usb_reset_and_verify_device(struct usb_device *udev)
3868 {
3869 struct usb_device *parent_hdev = udev->parent;
3870 struct usb_hub *parent_hub;
3871 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3872 struct usb_device_descriptor descriptor = udev->descriptor;
3873 int i, ret = 0;
3874 int port1 = udev->portnum;
3876 if (udev->state == USB_STATE_NOTATTACHED ||
3877 udev->state == USB_STATE_SUSPENDED) {
3878 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3879 udev->state);
3880 return -EINVAL;
3881 }
3883 if (!parent_hdev) {
3884 /* this requires hcd-specific logic; see ohci_restart() */
3885 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
3886 return -EISDIR;
3887 }
3888 parent_hub = hdev_to_hub(parent_hdev);
3890 set_bit(port1, parent_hub->busy_bits);
3891 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3893 /* ep0 maxpacket size may change; let the HCD know about it.
3894 * Other endpoints will be handled by re-enumeration. */
3895 usb_ep0_reinit(udev);
3896 ret = hub_port_init(parent_hub, udev, port1, i);
3897 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
3898 break;
3899 }
3900 clear_bit(port1, parent_hub->busy_bits);
3902 if (ret < 0)
3903 goto re_enumerate;
3905 /* Device might have changed firmware (DFU or similar) */
3906 if (descriptors_changed(udev, &descriptor)) {
3907 dev_info(&udev->dev, "device firmware changed\n");
3908 udev->descriptor = descriptor; /* for disconnect() calls */
3909 goto re_enumerate;
3910 }
3912 /* Restore the device's previous configuration */
3913 if (!udev->actconfig)
3914 goto done;
3916 mutex_lock(hcd->bandwidth_mutex);
3917 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
3918 if (ret < 0) {
3919 dev_warn(&udev->dev,
3920 "Busted HC? Not enough HCD resources for "
3921 "old configuration.\n");
3922 mutex_unlock(hcd->bandwidth_mutex);
3923 goto re_enumerate;
3924 }
3925 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3926 USB_REQ_SET_CONFIGURATION, 0,
3927 udev->actconfig->desc.bConfigurationValue, 0,
3928 NULL, 0, USB_CTRL_SET_TIMEOUT);
3929 if (ret < 0) {
3930 dev_err(&udev->dev,
3931 "can't restore configuration #%d (error=%d)\n",
3932 udev->actconfig->desc.bConfigurationValue, ret);
3933 mutex_unlock(hcd->bandwidth_mutex);
3934 goto re_enumerate;
3935 }
3936 mutex_unlock(hcd->bandwidth_mutex);
3937 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3939 /* Put interfaces back into the same altsettings as before.
3940 * Don't bother to send the Set-Interface request for interfaces
3941 * that were already in altsetting 0; besides being unnecessary,
3942 * many devices can't handle it. Instead just reset the host-side
3943 * endpoint state.
3944 */
3945 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3946 struct usb_host_config *config = udev->actconfig;
3947 struct usb_interface *intf = config->interface[i];
3948 struct usb_interface_descriptor *desc;
3950 desc = &intf->cur_altsetting->desc;
3951 if (desc->bAlternateSetting == 0) {
3952 usb_disable_interface(udev, intf, true);
3953 usb_enable_interface(udev, intf, true);
3954 ret = 0;
3955 } else {
3956 /* Let the bandwidth allocation function know that this
3957 * device has been reset, and it will have to use
3958 * alternate setting 0 as the current alternate setting.
3959 */
3960 intf->resetting_device = 1;
3961 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3962 desc->bAlternateSetting);
3963 intf->resetting_device = 0;
3964 }
3965 if (ret < 0) {
3966 dev_err(&udev->dev, "failed to restore interface %d "
3967 "altsetting %d (error=%d)\n",
3968 desc->bInterfaceNumber,
3969 desc->bAlternateSetting,
3970 ret);
3971 goto re_enumerate;
3972 }
3973 }
3975 done:
3976 return 0;
3978 re_enumerate:
3979 hub_port_logical_disconnect(parent_hub, port1);
3980 return -ENODEV;
3981 }
3983 /**
3984 * usb_reset_device - warn interface drivers and perform a USB port reset
3985 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3986 *
3987 * Warns all drivers bound to registered interfaces (using their pre_reset
3988 * method), performs the port reset, and then lets the drivers know that
3989 * the reset is over (using their post_reset method).
3990 *
3991 * Return value is the same as for usb_reset_and_verify_device().
3992 *
3993 * The caller must own the device lock. For example, it's safe to use
3994 * this from a driver probe() routine after downloading new firmware.
3995 * For calls that might not occur during probe(), drivers should lock
3996 * the device using usb_lock_device_for_reset().
3997 *
3998 * If an interface is currently being probed or disconnected, we assume
3999 * its driver knows how to handle resets. For all other interfaces,
4000 * if the driver doesn't have pre_reset and post_reset methods then
4001 * we attempt to unbind it and rebind afterward.
4002 */
4003 int usb_reset_device(struct usb_device *udev)
4004 {
4005 int ret;
4006 int i;
4007 struct usb_host_config *config = udev->actconfig;
4009 if (udev->state == USB_STATE_NOTATTACHED ||
4010 udev->state == USB_STATE_SUSPENDED) {
4011 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
4012 udev->state);
4013 return -EINVAL;
4014 }
4016 /* Prevent autosuspend during the reset */
4017 usb_autoresume_device(udev);
4019 if (config) {
4020 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
4021 struct usb_interface *cintf = config->interface[i];
4022 struct usb_driver *drv;
4023 int unbind = 0;
4025 if (cintf->dev.driver) {
4026 drv = to_usb_driver(cintf->dev.driver);
4027 if (drv->pre_reset && drv->post_reset)
4028 unbind = (drv->pre_reset)(cintf);
4029 else if (cintf->condition ==
4030 USB_INTERFACE_BOUND)
4031 unbind = 1;
4032 if (unbind)
4033 usb_forced_unbind_intf(cintf);
4034 }
4035 }
4036 }
4038 ret = usb_reset_and_verify_device(udev);
4040 if (config) {
4041 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
4042 struct usb_interface *cintf = config->interface[i];
4043 struct usb_driver *drv;
4044 int rebind = cintf->needs_binding;
4046 if (!rebind && cintf->dev.driver) {
4047 drv = to_usb_driver(cintf->dev.driver);
4048 if (drv->post_reset)
4049 rebind = (drv->post_reset)(cintf);
4050 else if (cintf->condition ==
4051 USB_INTERFACE_BOUND)
4052 rebind = 1;
4053 }
4054 if (ret == 0 && rebind)
4055 usb_rebind_intf(cintf);
4056 }
4057 }
4059 usb_autosuspend_device(udev);
4060 return ret;
4061 }
4062 EXPORT_SYMBOL_GPL(usb_reset_device);
4065 /**
4066 * usb_queue_reset_device - Reset a USB device from an atomic context
4067 * @iface: USB interface belonging to the device to reset
4068 *
4069 * This function can be used to reset a USB device from an atomic
4070 * context, where usb_reset_device() won't work (as it blocks).
4071 *
4072 * Doing a reset via this method is functionally equivalent to calling
4073 * usb_reset_device(), except for the fact that it is delayed to a
4074 * workqueue. This means that any drivers bound to other interfaces
4075 * might be unbound, as well as users from usbfs in user space.
4076 *
4077 * Corner cases:
4078 *
4079 * - Scheduling two resets at the same time from two different drivers
4080 * attached to two different interfaces of the same device is
4081 * possible; depending on how the driver attached to each interface
4082 * handles ->pre_reset(), the second reset might happen or not.
4083 *
4084 * - If a driver is unbound and it had a pending reset, the reset will
4085 * be cancelled.
4086 *
4087 * - This function can be called during .probe() or .disconnect()
4088 * times. On return from .disconnect(), any pending resets will be
4089 * cancelled.
4090 *
4091 * There is no no need to lock/unlock the @reset_ws as schedule_work()
4092 * does its own.
4093 *
4094 * NOTE: We don't do any reference count tracking because it is not
4095 * needed. The lifecycle of the work_struct is tied to the
4096 * usb_interface. Before destroying the interface we cancel the
4097 * work_struct, so the fact that work_struct is queued and or
4098 * running means the interface (and thus, the device) exist and
4099 * are referenced.
4100 */
4101 void usb_queue_reset_device(struct usb_interface *iface)
4102 {
4103 schedule_work(&iface->reset_ws);
4104 }
4105 EXPORT_SYMBOL_GPL(usb_queue_reset_device);