Loading...
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 */
10
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>
27
28#include <asm/uaccess.h>
29#include <asm/byteorder.h>
30
31#include "usb.h"
32
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
39
40struct 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 */
45
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 */
53
54 int error; /* last reported error */
55 int nerrors; /* track consecutive errors */
56
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
68
69 struct usb_hub_descriptor *descriptor; /* class descriptor */
70 struct usb_tt tt; /* Transaction Translator */
71
72 unsigned mA_per_port; /* current for each child */
73
74 unsigned limited_power:1;
75 unsigned quiescing:1;
76 unsigned disconnected:1;
77
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};
84
85static inline int hub_is_superspeed(struct usb_device *hdev)
86{
87 return (hdev->descriptor.bDeviceProtocol == 3);
88}
89
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. */
93static DEFINE_SPINLOCK(device_state_lock);
94
95/* khubd's worklist and its lock */
96static DEFINE_SPINLOCK(hub_event_lock);
97static LIST_HEAD(hub_event_list); /* List of hubs needing servicing */
98
99/* Wakes up khubd */
100static DECLARE_WAIT_QUEUE_HEAD(khubd_wait);
101
102static struct task_struct *khubd_task;
103
104/* cycle leds on hubs that aren't blinking for attention */
105static int blinkenlights = 0;
106module_param (blinkenlights, bool, S_IRUGO);
107MODULE_PARM_DESC (blinkenlights, "true to cycle leds on hubs");
108
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 */
114static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
115module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
116MODULE_PARM_DESC(initial_descriptor_timeout,
117 "initial 64-byte descriptor request timeout in milliseconds "
118 "(default 5000 - 5.0 seconds)");
119
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 */
134static int old_scheme_first = 0;
135module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
136MODULE_PARM_DESC(old_scheme_first,
137 "start with the old device initialization scheme");
138
139static int use_both_schemes = 1;
140module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
141MODULE_PARM_DESC(use_both_schemes,
142 "try the other device initialization scheme if the "
143 "first one fails");
144
145/* Mutual exclusion for EHCI CF initialization. This interferes with
146 * port reset on some companion controllers.
147 */
148DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
149EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
150
151#define HUB_DEBOUNCE_TIMEOUT 1500
152#define HUB_DEBOUNCE_STEP 25
153#define HUB_DEBOUNCE_STABLE 100
154
155
156static int usb_reset_and_verify_device(struct usb_device *udev);
157
158static 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}
169
170/* Note that hdev or one of its children must be locked! */
171static 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}
177
178/* USB 2.0 spec Section 11.24.4.5 */
179static int get_hub_descriptor(struct usb_device *hdev, void *data)
180{
181 int i, ret, size;
182 unsigned dtype;
183
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 }
191
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}
202
203/*
204 * USB 2.0 spec Section 11.24.2.1
205 */
206static 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}
211
212/*
213 * USB 2.0 spec Section 11.24.2.2
214 */
215static 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}
221
222/*
223 * USB 2.0 spec Section 11.24.2.13
224 */
225static 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}
231
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 */
236static 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}
257
258#define LED_CYCLE_PERIOD ((2*HZ)/3)
259
260static 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;
268
269 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
270 return;
271
272 for (i = 0; i < hub->descriptor->bNbrPorts; i++) {
273 unsigned selector, mode;
274
275 /* 30%-50% duty cycle */
276
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}
329
330/* use a short timeout for hub/port status fetches */
331#define USB_STS_TIMEOUT 1000
332#define USB_STS_RETRIES 5
333
334/*
335 * USB 2.0 spec Section 11.24.2.6
336 */
337static int get_hub_status(struct usb_device *hdev,
338 struct usb_hub_status *data)
339{
340 int i, status = -ETIMEDOUT;
341
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}
350
351/*
352 * USB 2.0 spec Section 11.24.2.7
353 */
354static int get_port_status(struct usb_device *hdev, int port1,
355 struct usb_port_status *data)
356{
357 int i, status = -ETIMEDOUT;
358
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}
367
368static int hub_port_status(struct usb_hub *hub, int port1,
369 u16 *status, u16 *change)
370{
371 int ret;
372
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);
383
384 ret = 0;
385 }
386 mutex_unlock(&hub->status_mutex);
387 return ret;
388}
389
390static void kick_khubd(struct usb_hub *hub)
391{
392 unsigned long flags;
393
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);
397
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}
405
406void usb_kick_khubd(struct usb_device *hdev)
407{
408 struct usb_hub *hub = hdev_to_hub(hdev);
409
410 if (hub)
411 kick_khubd(hub);
412}
413
414
415/* completion function, fires on port status changes and various faults */
416static 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;
422
423 switch (status) {
424 case -ENOENT: /* synchronous unlink */
425 case -ECONNRESET: /* async unlink */
426 case -ESHUTDOWN: /* hardware going away */
427 return;
428
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 */
436
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 }
446
447 hub->nerrors = 0;
448
449 /* Something happened, let khubd figure it out */
450 kick_khubd(hub);
451
452resubmit:
453 if (hub->quiescing)
454 return;
455
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}
460
461/* USB 2.0 spec Section 11.24.2.3 */
462static inline int
463hub_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}
469
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 */
476static 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;
482
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;
490
491 next = hub->tt.clear_list.next;
492 clear = list_entry (next, struct usb_tt_clear, clear_list);
493 list_del (&clear->clear_list);
494
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);
502
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);
507
508 kfree(clear);
509 spin_lock_irqsave(&hub->tt.lock, flags);
510 }
511 spin_unlock_irqrestore (&hub->tt.lock, flags);
512}
513
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 */
526int 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;
533
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 }
543
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;
553
554 /* info for completion callback */
555 clear->hcd = bus_to_hcd(udev->bus);
556 clear->ep = urb->ep;
557
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}
565EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
566
567/* If do_delay is false, return the number of milliseconds the caller
568 * needs to delay.
569 */
570static 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);
577
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);
591
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}
598
599static int hub_hub_status(struct usb_hub *hub,
600 u16 *status, u16 *change)
601{
602 int ret;
603
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}
617
618static 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;
622
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}
633
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 */
639static 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);
643
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 */
652
653 set_bit(port1, hub->change_bits);
654 kick_khubd(hub);
655}
656
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 */
667int usb_remove_device(struct usb_device *udev)
668{
669 struct usb_hub *hub;
670 struct usb_interface *intf;
671
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);
676
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}
683
684enum hub_activation_type {
685 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
686 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
687};
688
689static void hub_init_func2(struct work_struct *ws);
690static void hub_init_func3(struct work_struct *ws);
691
692static 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;
701
702 /* Continue a partial initialization */
703 if (type == HUB_INIT2)
704 goto init2;
705 if (type == HUB_INIT3)
706 goto init3;
707
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) {
712
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));
730
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:
759
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;
766
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);
773
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 }
798
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 }
815
816 /* We can forget about a "removed" device when there's a
817 * physical disconnect or the connect status changes.
818 */
819 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
820 (portchange & USB_PORT_STAT_C_CONNECTION))
821 clear_bit(port1, hub->removed_bits);
822
823 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
824 /* Tell khubd to disconnect the device or
825 * check for a new connection
826 */
827 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
828 set_bit(port1, hub->change_bits);
829
830 } else if (portstatus & USB_PORT_STAT_ENABLE) {
831 /* The power session apparently survived the resume.
832 * If there was an overcurrent or suspend change
833 * (i.e., remote wakeup request), have khubd
834 * take care of it.
835 */
836 if (portchange)
837 set_bit(port1, hub->change_bits);
838
839 } else if (udev->persist_enabled) {
840#ifdef CONFIG_PM
841 udev->reset_resume = 1;
842#endif
843 set_bit(port1, hub->change_bits);
844
845 } else {
846 /* The power session is gone; tell khubd */
847 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
848 set_bit(port1, hub->change_bits);
849 }
850 }
851
852 /* If no port-status-change flags were set, we don't need any
853 * debouncing. If flags were set we can try to debounce the
854 * ports all at once right now, instead of letting khubd do them
855 * one at a time later on.
856 *
857 * If any port-status changes do occur during this delay, khubd
858 * will see them later and handle them normally.
859 */
860 if (need_debounce_delay) {
861 delay = HUB_DEBOUNCE_STABLE;
862
863 /* Don't do a long sleep inside a workqueue routine */
864 if (type == HUB_INIT2) {
865 PREPARE_DELAYED_WORK(&hub->init_work, hub_init_func3);
866 schedule_delayed_work(&hub->init_work,
867 msecs_to_jiffies(delay));
868 return; /* Continues at init3: below */
869 } else {
870 msleep(delay);
871 }
872 }
873 init3:
874 hub->quiescing = 0;
875
876 status = usb_submit_urb(hub->urb, GFP_NOIO);
877 if (status < 0)
878 dev_err(hub->intfdev, "activate --> %d\n", status);
879 if (hub->has_indicators && blinkenlights)
880 schedule_delayed_work(&hub->leds, LED_CYCLE_PERIOD);
881
882 /* Scan all ports that need attention */
883 kick_khubd(hub);
884
885 /* Allow autosuspend if it was suppressed */
886 if (type <= HUB_INIT3)
887 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
888}
889
890/* Implement the continuations for the delays above */
891static void hub_init_func2(struct work_struct *ws)
892{
893 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
894
895 hub_activate(hub, HUB_INIT2);
896}
897
898static void hub_init_func3(struct work_struct *ws)
899{
900 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
901
902 hub_activate(hub, HUB_INIT3);
903}
904
905enum hub_quiescing_type {
906 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
907};
908
909static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
910{
911 struct usb_device *hdev = hub->hdev;
912 int i;
913
914 cancel_delayed_work_sync(&hub->init_work);
915
916 /* khubd and related activity won't re-trigger */
917 hub->quiescing = 1;
918
919 if (type != HUB_SUSPEND) {
920 /* Disconnect all the children */
921 for (i = 0; i < hdev->maxchild; ++i) {
922 if (hdev->children[i])
923 usb_disconnect(&hdev->children[i]);
924 }
925 }
926
927 /* Stop khubd and related activity */
928 usb_kill_urb(hub->urb);
929 if (hub->has_indicators)
930 cancel_delayed_work_sync(&hub->leds);
931 if (hub->tt.hub)
932 cancel_work_sync(&hub->tt.clear_work);
933}
934
935/* caller has locked the hub device */
936static int hub_pre_reset(struct usb_interface *intf)
937{
938 struct usb_hub *hub = usb_get_intfdata(intf);
939
940 hub_quiesce(hub, HUB_PRE_RESET);
941 return 0;
942}
943
944/* caller has locked the hub device */
945static int hub_post_reset(struct usb_interface *intf)
946{
947 struct usb_hub *hub = usb_get_intfdata(intf);
948
949 hub_activate(hub, HUB_POST_RESET);
950 return 0;
951}
952
953static int hub_configure(struct usb_hub *hub,
954 struct usb_endpoint_descriptor *endpoint)
955{
956 struct usb_hcd *hcd;
957 struct usb_device *hdev = hub->hdev;
958 struct device *hub_dev = hub->intfdev;
959 u16 hubstatus, hubchange;
960 u16 wHubCharacteristics;
961 unsigned int pipe;
962 int maxp, ret;
963 char *message = "out of memory";
964
965 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
966 if (!hub->buffer) {
967 ret = -ENOMEM;
968 goto fail;
969 }
970
971 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
972 if (!hub->status) {
973 ret = -ENOMEM;
974 goto fail;
975 }
976 mutex_init(&hub->status_mutex);
977
978 hub->descriptor = kmalloc(sizeof(*hub->descriptor), GFP_KERNEL);
979 if (!hub->descriptor) {
980 ret = -ENOMEM;
981 goto fail;
982 }
983
984 if (hub_is_superspeed(hdev) && (hdev->parent != NULL)) {
985 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
986 HUB_SET_DEPTH, USB_RT_HUB,
987 hdev->level - 1, 0, NULL, 0,
988 USB_CTRL_SET_TIMEOUT);
989
990 if (ret < 0) {
991 message = "can't set hub depth";
992 goto fail;
993 }
994 }
995
996 /* Request the entire hub descriptor.
997 * hub->descriptor can handle USB_MAXCHILDREN ports,
998 * but the hub can/will return fewer bytes here.
999 */
1000 ret = get_hub_descriptor(hdev, hub->descriptor);
1001 if (ret < 0) {
1002 message = "can't read hub descriptor";
1003 goto fail;
1004 } else if (hub->descriptor->bNbrPorts > USB_MAXCHILDREN) {
1005 message = "hub has too many ports!";
1006 ret = -ENODEV;
1007 goto fail;
1008 }
1009
1010 hdev->maxchild = hub->descriptor->bNbrPorts;
1011 dev_info (hub_dev, "%d port%s detected\n", hdev->maxchild,
1012 (hdev->maxchild == 1) ? "" : "s");
1013
1014 hub->port_owners = kzalloc(hdev->maxchild * sizeof(void *), GFP_KERNEL);
1015 if (!hub->port_owners) {
1016 ret = -ENOMEM;
1017 goto fail;
1018 }
1019
1020 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1021
1022 /* FIXME for USB 3.0, skip for now */
1023 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1024 !(hub_is_superspeed(hdev))) {
1025 int i;
1026 char portstr [USB_MAXCHILDREN + 1];
1027
1028 for (i = 0; i < hdev->maxchild; i++)
1029 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1030 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1031 ? 'F' : 'R';
1032 portstr[hdev->maxchild] = 0;
1033 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1034 } else
1035 dev_dbg(hub_dev, "standalone hub\n");
1036
1037 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1038 case 0x00:
1039 dev_dbg(hub_dev, "ganged power switching\n");
1040 break;
1041 case 0x01:
1042 dev_dbg(hub_dev, "individual port power switching\n");
1043 break;
1044 case 0x02:
1045 case 0x03:
1046 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1047 break;
1048 }
1049
1050 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1051 case 0x00:
1052 dev_dbg(hub_dev, "global over-current protection\n");
1053 break;
1054 case 0x08:
1055 dev_dbg(hub_dev, "individual port over-current protection\n");
1056 break;
1057 case 0x10:
1058 case 0x18:
1059 dev_dbg(hub_dev, "no over-current protection\n");
1060 break;
1061 }
1062
1063 spin_lock_init (&hub->tt.lock);
1064 INIT_LIST_HEAD (&hub->tt.clear_list);
1065 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1066 switch (hdev->descriptor.bDeviceProtocol) {
1067 case 0:
1068 break;
1069 case 1:
1070 dev_dbg(hub_dev, "Single TT\n");
1071 hub->tt.hub = hdev;
1072 break;
1073 case 2:
1074 ret = usb_set_interface(hdev, 0, 1);
1075 if (ret == 0) {
1076 dev_dbg(hub_dev, "TT per port\n");
1077 hub->tt.multi = 1;
1078 } else
1079 dev_err(hub_dev, "Using single TT (err %d)\n",
1080 ret);
1081 hub->tt.hub = hdev;
1082 break;
1083 case 3:
1084 /* USB 3.0 hubs don't have a TT */
1085 break;
1086 default:
1087 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1088 hdev->descriptor.bDeviceProtocol);
1089 break;
1090 }
1091
1092 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1093 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1094 case HUB_TTTT_8_BITS:
1095 if (hdev->descriptor.bDeviceProtocol != 0) {
1096 hub->tt.think_time = 666;
1097 dev_dbg(hub_dev, "TT requires at most %d "
1098 "FS bit times (%d ns)\n",
1099 8, hub->tt.think_time);
1100 }
1101 break;
1102 case HUB_TTTT_16_BITS:
1103 hub->tt.think_time = 666 * 2;
1104 dev_dbg(hub_dev, "TT requires at most %d "
1105 "FS bit times (%d ns)\n",
1106 16, hub->tt.think_time);
1107 break;
1108 case HUB_TTTT_24_BITS:
1109 hub->tt.think_time = 666 * 3;
1110 dev_dbg(hub_dev, "TT requires at most %d "
1111 "FS bit times (%d ns)\n",
1112 24, hub->tt.think_time);
1113 break;
1114 case HUB_TTTT_32_BITS:
1115 hub->tt.think_time = 666 * 4;
1116 dev_dbg(hub_dev, "TT requires at most %d "
1117 "FS bit times (%d ns)\n",
1118 32, hub->tt.think_time);
1119 break;
1120 }
1121
1122 /* probe() zeroes hub->indicator[] */
1123 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1124 hub->has_indicators = 1;
1125 dev_dbg(hub_dev, "Port indicators are supported\n");
1126 }
1127
1128 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1129 hub->descriptor->bPwrOn2PwrGood * 2);
1130
1131 /* power budgeting mostly matters with bus-powered hubs,
1132 * and battery-powered root hubs (may provide just 8 mA).
1133 */
1134 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1135 if (ret < 2) {
1136 message = "can't get hub status";
1137 goto fail;
1138 }
1139 le16_to_cpus(&hubstatus);
1140 if (hdev == hdev->bus->root_hub) {
1141 if (hdev->bus_mA == 0 || hdev->bus_mA >= 500)
1142 hub->mA_per_port = 500;
1143 else {
1144 hub->mA_per_port = hdev->bus_mA;
1145 hub->limited_power = 1;
1146 }
1147 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1148 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1149 hub->descriptor->bHubContrCurrent);
1150 hub->limited_power = 1;
1151 if (hdev->maxchild > 0) {
1152 int remaining = hdev->bus_mA -
1153 hub->descriptor->bHubContrCurrent;
1154
1155 if (remaining < hdev->maxchild * 100)
1156 dev_warn(hub_dev,
1157 "insufficient power available "
1158 "to use all downstream ports\n");
1159 hub->mA_per_port = 100; /* 7.2.1.1 */
1160 }
1161 } else { /* Self-powered external hub */
1162 /* FIXME: What about battery-powered external hubs that
1163 * provide less current per port? */
1164 hub->mA_per_port = 500;
1165 }
1166 if (hub->mA_per_port < 500)
1167 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1168 hub->mA_per_port);
1169
1170 /* Update the HCD's internal representation of this hub before khubd
1171 * starts getting port status changes for devices under the hub.
1172 */
1173 hcd = bus_to_hcd(hdev->bus);
1174 if (hcd->driver->update_hub_device) {
1175 ret = hcd->driver->update_hub_device(hcd, hdev,
1176 &hub->tt, GFP_KERNEL);
1177 if (ret < 0) {
1178 message = "can't update HCD hub info";
1179 goto fail;
1180 }
1181 }
1182
1183 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1184 if (ret < 0) {
1185 message = "can't get hub status";
1186 goto fail;
1187 }
1188
1189 /* local power status reports aren't always correct */
1190 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1191 dev_dbg(hub_dev, "local power source is %s\n",
1192 (hubstatus & HUB_STATUS_LOCAL_POWER)
1193 ? "lost (inactive)" : "good");
1194
1195 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1196 dev_dbg(hub_dev, "%sover-current condition exists\n",
1197 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1198
1199 /* set up the interrupt endpoint
1200 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1201 * bytes as USB2.0[11.12.3] says because some hubs are known
1202 * to send more data (and thus cause overflow). For root hubs,
1203 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1204 * to be big enough for at least USB_MAXCHILDREN ports. */
1205 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1206 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1207
1208 if (maxp > sizeof(*hub->buffer))
1209 maxp = sizeof(*hub->buffer);
1210
1211 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1212 if (!hub->urb) {
1213 ret = -ENOMEM;
1214 goto fail;
1215 }
1216
1217 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1218 hub, endpoint->bInterval);
1219
1220 /* maybe cycle the hub leds */
1221 if (hub->has_indicators && blinkenlights)
1222 hub->indicator [0] = INDICATOR_CYCLE;
1223
1224 hub_activate(hub, HUB_INIT);
1225 return 0;
1226
1227fail:
1228 dev_err (hub_dev, "config failed, %s (err %d)\n",
1229 message, ret);
1230 /* hub_disconnect() frees urb and descriptor */
1231 return ret;
1232}
1233
1234static void hub_release(struct kref *kref)
1235{
1236 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1237
1238 usb_put_intf(to_usb_interface(hub->intfdev));
1239 kfree(hub);
1240}
1241
1242static unsigned highspeed_hubs;
1243
1244static void hub_disconnect(struct usb_interface *intf)
1245{
1246 struct usb_hub *hub = usb_get_intfdata (intf);
1247
1248 /* Take the hub off the event list and don't let it be added again */
1249 spin_lock_irq(&hub_event_lock);
1250 if (!list_empty(&hub->event_list)) {
1251 list_del_init(&hub->event_list);
1252 usb_autopm_put_interface_no_suspend(intf);
1253 }
1254 hub->disconnected = 1;
1255 spin_unlock_irq(&hub_event_lock);
1256
1257 /* Disconnect all children and quiesce the hub */
1258 hub->error = 0;
1259 hub_quiesce(hub, HUB_DISCONNECT);
1260
1261 usb_set_intfdata (intf, NULL);
1262 hub->hdev->maxchild = 0;
1263
1264 if (hub->hdev->speed == USB_SPEED_HIGH)
1265 highspeed_hubs--;
1266
1267 usb_free_urb(hub->urb);
1268 kfree(hub->port_owners);
1269 kfree(hub->descriptor);
1270 kfree(hub->status);
1271 kfree(hub->buffer);
1272
1273 kref_put(&hub->kref, hub_release);
1274}
1275
1276static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1277{
1278 struct usb_host_interface *desc;
1279 struct usb_endpoint_descriptor *endpoint;
1280 struct usb_device *hdev;
1281 struct usb_hub *hub;
1282
1283 desc = intf->cur_altsetting;
1284 hdev = interface_to_usbdev(intf);
1285
1286 /* Hubs have proper suspend/resume support. USB 3.0 device suspend is
1287 * different from USB 2.0/1.1 device suspend, and unfortunately we
1288 * don't support it yet. So leave autosuspend disabled for USB 3.0
1289 * external hubs for now. Enable autosuspend for USB 3.0 roothubs,
1290 * since that isn't a "real" hub.
1291 */
1292 if (!hub_is_superspeed(hdev) || !hdev->parent)
1293 usb_enable_autosuspend(hdev);
1294
1295 if (hdev->level == MAX_TOPO_LEVEL) {
1296 dev_err(&intf->dev,
1297 "Unsupported bus topology: hub nested too deep\n");
1298 return -E2BIG;
1299 }
1300
1301#ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1302 if (hdev->parent) {
1303 dev_warn(&intf->dev, "ignoring external hub\n");
1304 return -ENODEV;
1305 }
1306#endif
1307
1308 /* Some hubs have a subclass of 1, which AFAICT according to the */
1309 /* specs is not defined, but it works */
1310 if ((desc->desc.bInterfaceSubClass != 0) &&
1311 (desc->desc.bInterfaceSubClass != 1)) {
1312descriptor_error:
1313 dev_err (&intf->dev, "bad descriptor, ignoring hub\n");
1314 return -EIO;
1315 }
1316
1317 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1318 if (desc->desc.bNumEndpoints != 1)
1319 goto descriptor_error;
1320
1321 endpoint = &desc->endpoint[0].desc;
1322
1323 /* If it's not an interrupt in endpoint, we'd better punt! */
1324 if (!usb_endpoint_is_int_in(endpoint))
1325 goto descriptor_error;
1326
1327 /* We found a hub */
1328 dev_info (&intf->dev, "USB hub found\n");
1329
1330 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1331 if (!hub) {
1332 dev_dbg (&intf->dev, "couldn't kmalloc hub struct\n");
1333 return -ENOMEM;
1334 }
1335
1336 kref_init(&hub->kref);
1337 INIT_LIST_HEAD(&hub->event_list);
1338 hub->intfdev = &intf->dev;
1339 hub->hdev = hdev;
1340 INIT_DELAYED_WORK(&hub->leds, led_work);
1341 INIT_DELAYED_WORK(&hub->init_work, NULL);
1342 usb_get_intf(intf);
1343
1344 usb_set_intfdata (intf, hub);
1345 intf->needs_remote_wakeup = 1;
1346
1347 if (hdev->speed == USB_SPEED_HIGH)
1348 highspeed_hubs++;
1349
1350 if (hub_configure(hub, endpoint) >= 0)
1351 return 0;
1352
1353 hub_disconnect (intf);
1354 return -ENODEV;
1355}
1356
1357/* No BKL needed */
1358static int
1359hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1360{
1361 struct usb_device *hdev = interface_to_usbdev (intf);
1362
1363 /* assert ifno == 0 (part of hub spec) */
1364 switch (code) {
1365 case USBDEVFS_HUB_PORTINFO: {
1366 struct usbdevfs_hub_portinfo *info = user_data;
1367 int i;
1368
1369 spin_lock_irq(&device_state_lock);
1370 if (hdev->devnum <= 0)
1371 info->nports = 0;
1372 else {
1373 info->nports = hdev->maxchild;
1374 for (i = 0; i < info->nports; i++) {
1375 if (hdev->children[i] == NULL)
1376 info->port[i] = 0;
1377 else
1378 info->port[i] =
1379 hdev->children[i]->devnum;
1380 }
1381 }
1382 spin_unlock_irq(&device_state_lock);
1383
1384 return info->nports + 1;
1385 }
1386
1387 default:
1388 return -ENOSYS;
1389 }
1390}
1391
1392/*
1393 * Allow user programs to claim ports on a hub. When a device is attached
1394 * to one of these "claimed" ports, the program will "own" the device.
1395 */
1396static int find_port_owner(struct usb_device *hdev, unsigned port1,
1397 void ***ppowner)
1398{
1399 if (hdev->state == USB_STATE_NOTATTACHED)
1400 return -ENODEV;
1401 if (port1 == 0 || port1 > hdev->maxchild)
1402 return -EINVAL;
1403
1404 /* This assumes that devices not managed by the hub driver
1405 * will always have maxchild equal to 0.
1406 */
1407 *ppowner = &(hdev_to_hub(hdev)->port_owners[port1 - 1]);
1408 return 0;
1409}
1410
1411/* In the following three functions, the caller must hold hdev's lock */
1412int usb_hub_claim_port(struct usb_device *hdev, unsigned port1, void *owner)
1413{
1414 int rc;
1415 void **powner;
1416
1417 rc = find_port_owner(hdev, port1, &powner);
1418 if (rc)
1419 return rc;
1420 if (*powner)
1421 return -EBUSY;
1422 *powner = owner;
1423 return rc;
1424}
1425
1426int usb_hub_release_port(struct usb_device *hdev, unsigned port1, void *owner)
1427{
1428 int rc;
1429 void **powner;
1430
1431 rc = find_port_owner(hdev, port1, &powner);
1432 if (rc)
1433 return rc;
1434 if (*powner != owner)
1435 return -ENOENT;
1436 *powner = NULL;
1437 return rc;
1438}
1439
1440void usb_hub_release_all_ports(struct usb_device *hdev, void *owner)
1441{
1442 int n;
1443 void **powner;
1444
1445 n = find_port_owner(hdev, 1, &powner);
1446 if (n == 0) {
1447 for (; n < hdev->maxchild; (++n, ++powner)) {
1448 if (*powner == owner)
1449 *powner = NULL;
1450 }
1451 }
1452}
1453
1454/* The caller must hold udev's lock */
1455bool usb_device_is_owned(struct usb_device *udev)
1456{
1457 struct usb_hub *hub;
1458
1459 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1460 return false;
1461 hub = hdev_to_hub(udev->parent);
1462 return !!hub->port_owners[udev->portnum - 1];
1463}
1464
1465
1466static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1467{
1468 int i;
1469
1470 for (i = 0; i < udev->maxchild; ++i) {
1471 if (udev->children[i])
1472 recursively_mark_NOTATTACHED(udev->children[i]);
1473 }
1474 if (udev->state == USB_STATE_SUSPENDED)
1475 udev->active_duration -= jiffies;
1476 udev->state = USB_STATE_NOTATTACHED;
1477}
1478
1479/**
1480 * usb_set_device_state - change a device's current state (usbcore, hcds)
1481 * @udev: pointer to device whose state should be changed
1482 * @new_state: new state value to be stored
1483 *
1484 * udev->state is _not_ fully protected by the device lock. Although
1485 * most transitions are made only while holding the lock, the state can
1486 * can change to USB_STATE_NOTATTACHED at almost any time. This
1487 * is so that devices can be marked as disconnected as soon as possible,
1488 * without having to wait for any semaphores to be released. As a result,
1489 * all changes to any device's state must be protected by the
1490 * device_state_lock spinlock.
1491 *
1492 * Once a device has been added to the device tree, all changes to its state
1493 * should be made using this routine. The state should _not_ be set directly.
1494 *
1495 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1496 * Otherwise udev->state is set to new_state, and if new_state is
1497 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1498 * to USB_STATE_NOTATTACHED.
1499 */
1500void usb_set_device_state(struct usb_device *udev,
1501 enum usb_device_state new_state)
1502{
1503 unsigned long flags;
1504 int wakeup = -1;
1505
1506 spin_lock_irqsave(&device_state_lock, flags);
1507 if (udev->state == USB_STATE_NOTATTACHED)
1508 ; /* do nothing */
1509 else if (new_state != USB_STATE_NOTATTACHED) {
1510
1511 /* root hub wakeup capabilities are managed out-of-band
1512 * and may involve silicon errata ... ignore them here.
1513 */
1514 if (udev->parent) {
1515 if (udev->state == USB_STATE_SUSPENDED
1516 || new_state == USB_STATE_SUSPENDED)
1517 ; /* No change to wakeup settings */
1518 else if (new_state == USB_STATE_CONFIGURED)
1519 wakeup = udev->actconfig->desc.bmAttributes
1520 & USB_CONFIG_ATT_WAKEUP;
1521 else
1522 wakeup = 0;
1523 }
1524 if (udev->state == USB_STATE_SUSPENDED &&
1525 new_state != USB_STATE_SUSPENDED)
1526 udev->active_duration -= jiffies;
1527 else if (new_state == USB_STATE_SUSPENDED &&
1528 udev->state != USB_STATE_SUSPENDED)
1529 udev->active_duration += jiffies;
1530 udev->state = new_state;
1531 } else
1532 recursively_mark_NOTATTACHED(udev);
1533 spin_unlock_irqrestore(&device_state_lock, flags);
1534 if (wakeup >= 0)
1535 device_set_wakeup_capable(&udev->dev, wakeup);
1536}
1537EXPORT_SYMBOL_GPL(usb_set_device_state);
1538
1539/*
1540 * Choose a device number.
1541 *
1542 * Device numbers are used as filenames in usbfs. On USB-1.1 and
1543 * USB-2.0 buses they are also used as device addresses, however on
1544 * USB-3.0 buses the address is assigned by the controller hardware
1545 * and it usually is not the same as the device number.
1546 *
1547 * WUSB devices are simple: they have no hubs behind, so the mapping
1548 * device <-> virtual port number becomes 1:1. Why? to simplify the
1549 * life of the device connection logic in
1550 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
1551 * handshake we need to assign a temporary address in the unauthorized
1552 * space. For simplicity we use the first virtual port number found to
1553 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
1554 * and that becomes it's address [X < 128] or its unauthorized address
1555 * [X | 0x80].
1556 *
1557 * We add 1 as an offset to the one-based USB-stack port number
1558 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
1559 * 0 is reserved by USB for default address; (b) Linux's USB stack
1560 * uses always #1 for the root hub of the controller. So USB stack's
1561 * port #1, which is wusb virtual-port #0 has address #2.
1562 *
1563 * Devices connected under xHCI are not as simple. The host controller
1564 * supports virtualization, so the hardware assigns device addresses and
1565 * the HCD must setup data structures before issuing a set address
1566 * command to the hardware.
1567 */
1568static void choose_devnum(struct usb_device *udev)
1569{
1570 int devnum;
1571 struct usb_bus *bus = udev->bus;
1572
1573 /* If khubd ever becomes multithreaded, this will need a lock */
1574 if (udev->wusb) {
1575 devnum = udev->portnum + 1;
1576 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
1577 } else {
1578 /* Try to allocate the next devnum beginning at
1579 * bus->devnum_next. */
1580 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
1581 bus->devnum_next);
1582 if (devnum >= 128)
1583 devnum = find_next_zero_bit(bus->devmap.devicemap,
1584 128, 1);
1585 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
1586 }
1587 if (devnum < 128) {
1588 set_bit(devnum, bus->devmap.devicemap);
1589 udev->devnum = devnum;
1590 }
1591}
1592
1593static void release_devnum(struct usb_device *udev)
1594{
1595 if (udev->devnum > 0) {
1596 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
1597 udev->devnum = -1;
1598 }
1599}
1600
1601static void update_devnum(struct usb_device *udev, int devnum)
1602{
1603 /* The address for a WUSB device is managed by wusbcore. */
1604 if (!udev->wusb)
1605 udev->devnum = devnum;
1606}
1607
1608static void hub_free_dev(struct usb_device *udev)
1609{
1610 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1611
1612 /* Root hubs aren't real devices, so don't free HCD resources */
1613 if (hcd->driver->free_dev && udev->parent)
1614 hcd->driver->free_dev(hcd, udev);
1615}
1616
1617/**
1618 * usb_disconnect - disconnect a device (usbcore-internal)
1619 * @pdev: pointer to device being disconnected
1620 * Context: !in_interrupt ()
1621 *
1622 * Something got disconnected. Get rid of it and all of its children.
1623 *
1624 * If *pdev is a normal device then the parent hub must already be locked.
1625 * If *pdev is a root hub then this routine will acquire the
1626 * usb_bus_list_lock on behalf of the caller.
1627 *
1628 * Only hub drivers (including virtual root hub drivers for host
1629 * controllers) should ever call this.
1630 *
1631 * This call is synchronous, and may not be used in an interrupt context.
1632 */
1633void usb_disconnect(struct usb_device **pdev)
1634{
1635 struct usb_device *udev = *pdev;
1636 int i;
1637 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
1638
1639 if (!udev) {
1640 pr_debug ("%s nodev\n", __func__);
1641 return;
1642 }
1643
1644 /* mark the device as inactive, so any further urb submissions for
1645 * this device (and any of its children) will fail immediately.
1646 * this quiesces everything except pending urbs.
1647 */
1648 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1649 dev_info(&udev->dev, "USB disconnect, device number %d\n",
1650 udev->devnum);
1651
1652 usb_lock_device(udev);
1653
1654 /* Free up all the children before we remove this device */
1655 for (i = 0; i < USB_MAXCHILDREN; i++) {
1656 if (udev->children[i])
1657 usb_disconnect(&udev->children[i]);
1658 }
1659
1660 /* deallocate hcd/hardware state ... nuking all pending urbs and
1661 * cleaning up all state associated with the current configuration
1662 * so that the hardware is now fully quiesced.
1663 */
1664 dev_dbg (&udev->dev, "unregistering device\n");
1665 mutex_lock(hcd->bandwidth_mutex);
1666 usb_disable_device(udev, 0);
1667 mutex_unlock(hcd->bandwidth_mutex);
1668 usb_hcd_synchronize_unlinks(udev);
1669
1670 usb_remove_ep_devs(&udev->ep0);
1671 usb_unlock_device(udev);
1672
1673 /* Unregister the device. The device driver is responsible
1674 * for de-configuring the device and invoking the remove-device
1675 * notifier chain (used by usbfs and possibly others).
1676 */
1677 device_del(&udev->dev);
1678
1679 /* Free the device number and delete the parent's children[]
1680 * (or root_hub) pointer.
1681 */
1682 release_devnum(udev);
1683
1684 /* Avoid races with recursively_mark_NOTATTACHED() */
1685 spin_lock_irq(&device_state_lock);
1686 *pdev = NULL;
1687 spin_unlock_irq(&device_state_lock);
1688
1689 hub_free_dev(udev);
1690
1691 put_device(&udev->dev);
1692}
1693
1694#ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
1695static void show_string(struct usb_device *udev, char *id, char *string)
1696{
1697 if (!string)
1698 return;
1699 dev_printk(KERN_INFO, &udev->dev, "%s: %s\n", id, string);
1700}
1701
1702static void announce_device(struct usb_device *udev)
1703{
1704 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
1705 le16_to_cpu(udev->descriptor.idVendor),
1706 le16_to_cpu(udev->descriptor.idProduct));
1707 dev_info(&udev->dev,
1708 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1709 udev->descriptor.iManufacturer,
1710 udev->descriptor.iProduct,
1711 udev->descriptor.iSerialNumber);
1712 show_string(udev, "Product", udev->product);
1713 show_string(udev, "Manufacturer", udev->manufacturer);
1714 show_string(udev, "SerialNumber", udev->serial);
1715}
1716#else
1717static inline void announce_device(struct usb_device *udev) { }
1718#endif
1719
1720#ifdef CONFIG_USB_OTG
1721#include "otg_whitelist.h"
1722#endif
1723
1724/**
1725 * usb_enumerate_device_otg - FIXME (usbcore-internal)
1726 * @udev: newly addressed device (in ADDRESS state)
1727 *
1728 * Finish enumeration for On-The-Go devices
1729 */
1730static int usb_enumerate_device_otg(struct usb_device *udev)
1731{
1732 int err = 0;
1733
1734#ifdef CONFIG_USB_OTG
1735 /*
1736 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
1737 * to wake us after we've powered off VBUS; and HNP, switching roles
1738 * "host" to "peripheral". The OTG descriptor helps figure this out.
1739 */
1740 if (!udev->bus->is_b_host
1741 && udev->config
1742 && udev->parent == udev->bus->root_hub) {
1743 struct usb_otg_descriptor *desc = NULL;
1744 struct usb_bus *bus = udev->bus;
1745
1746 /* descriptor may appear anywhere in config */
1747 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
1748 le16_to_cpu(udev->config[0].desc.wTotalLength),
1749 USB_DT_OTG, (void **) &desc) == 0) {
1750 if (desc->bmAttributes & USB_OTG_HNP) {
1751 unsigned port1 = udev->portnum;
1752
1753 dev_info(&udev->dev,
1754 "Dual-Role OTG device on %sHNP port\n",
1755 (port1 == bus->otg_port)
1756 ? "" : "non-");
1757
1758 /* enable HNP before suspend, it's simpler */
1759 if (port1 == bus->otg_port)
1760 bus->b_hnp_enable = 1;
1761 err = usb_control_msg(udev,
1762 usb_sndctrlpipe(udev, 0),
1763 USB_REQ_SET_FEATURE, 0,
1764 bus->b_hnp_enable
1765 ? USB_DEVICE_B_HNP_ENABLE
1766 : USB_DEVICE_A_ALT_HNP_SUPPORT,
1767 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
1768 if (err < 0) {
1769 /* OTG MESSAGE: report errors here,
1770 * customize to match your product.
1771 */
1772 dev_info(&udev->dev,
1773 "can't set HNP mode: %d\n",
1774 err);
1775 bus->b_hnp_enable = 0;
1776 }
1777 }
1778 }
1779 }
1780
1781 if (!is_targeted(udev)) {
1782
1783 /* Maybe it can talk to us, though we can't talk to it.
1784 * (Includes HNP test device.)
1785 */
1786 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
1787 err = usb_port_suspend(udev, PMSG_SUSPEND);
1788 if (err < 0)
1789 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
1790 }
1791 err = -ENOTSUPP;
1792 goto fail;
1793 }
1794fail:
1795#endif
1796 return err;
1797}
1798
1799
1800/**
1801 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
1802 * @udev: newly addressed device (in ADDRESS state)
1803 *
1804 * This is only called by usb_new_device() and usb_authorize_device()
1805 * and FIXME -- all comments that apply to them apply here wrt to
1806 * environment.
1807 *
1808 * If the device is WUSB and not authorized, we don't attempt to read
1809 * the string descriptors, as they will be errored out by the device
1810 * until it has been authorized.
1811 */
1812static int usb_enumerate_device(struct usb_device *udev)
1813{
1814 int err;
1815
1816 if (udev->config == NULL) {
1817 err = usb_get_configuration(udev);
1818 if (err < 0) {
1819 dev_err(&udev->dev, "can't read configurations, error %d\n",
1820 err);
1821 goto fail;
1822 }
1823 }
1824 if (udev->wusb == 1 && udev->authorized == 0) {
1825 udev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1826 udev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1827 udev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1828 }
1829 else {
1830 /* read the standard strings and cache them if present */
1831 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
1832 udev->manufacturer = usb_cache_string(udev,
1833 udev->descriptor.iManufacturer);
1834 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
1835 }
1836 err = usb_enumerate_device_otg(udev);
1837fail:
1838 return err;
1839}
1840
1841
1842/**
1843 * usb_new_device - perform initial device setup (usbcore-internal)
1844 * @udev: newly addressed device (in ADDRESS state)
1845 *
1846 * This is called with devices which have been detected but not fully
1847 * enumerated. The device descriptor is available, but not descriptors
1848 * for any device configuration. The caller must have locked either
1849 * the parent hub (if udev is a normal device) or else the
1850 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
1851 * udev has already been installed, but udev is not yet visible through
1852 * sysfs or other filesystem code.
1853 *
1854 * It will return if the device is configured properly or not. Zero if
1855 * the interface was registered with the driver core; else a negative
1856 * errno value.
1857 *
1858 * This call is synchronous, and may not be used in an interrupt context.
1859 *
1860 * Only the hub driver or root-hub registrar should ever call this.
1861 */
1862int usb_new_device(struct usb_device *udev)
1863{
1864 int err;
1865
1866 if (udev->parent) {
1867 /* Initialize non-root-hub device wakeup to disabled;
1868 * device (un)configuration controls wakeup capable
1869 * sysfs power/wakeup controls wakeup enabled/disabled
1870 */
1871 device_init_wakeup(&udev->dev, 0);
1872 }
1873
1874 /* Tell the runtime-PM framework the device is active */
1875 pm_runtime_set_active(&udev->dev);
1876 pm_runtime_get_noresume(&udev->dev);
1877 pm_runtime_use_autosuspend(&udev->dev);
1878 pm_runtime_enable(&udev->dev);
1879
1880 /* By default, forbid autosuspend for all devices. It will be
1881 * allowed for hubs during binding.
1882 */
1883 usb_disable_autosuspend(udev);
1884
1885 err = usb_enumerate_device(udev); /* Read descriptors */
1886 if (err < 0)
1887 goto fail;
1888 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
1889 udev->devnum, udev->bus->busnum,
1890 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1891 /* export the usbdev device-node for libusb */
1892 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
1893 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
1894
1895 /* Tell the world! */
1896 announce_device(udev);
1897
1898 device_enable_async_suspend(&udev->dev);
1899 /* Register the device. The device driver is responsible
1900 * for configuring the device and invoking the add-device
1901 * notifier chain (used by usbfs and possibly others).
1902 */
1903 err = device_add(&udev->dev);
1904 if (err) {
1905 dev_err(&udev->dev, "can't device_add, error %d\n", err);
1906 goto fail;
1907 }
1908
1909 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
1910 usb_mark_last_busy(udev);
1911 pm_runtime_put_sync_autosuspend(&udev->dev);
1912 return err;
1913
1914fail:
1915 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1916 pm_runtime_disable(&udev->dev);
1917 pm_runtime_set_suspended(&udev->dev);
1918 return err;
1919}
1920
1921
1922/**
1923 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
1924 * @usb_dev: USB device
1925 *
1926 * Move the USB device to a very basic state where interfaces are disabled
1927 * and the device is in fact unconfigured and unusable.
1928 *
1929 * We share a lock (that we have) with device_del(), so we need to
1930 * defer its call.
1931 */
1932int usb_deauthorize_device(struct usb_device *usb_dev)
1933{
1934 usb_lock_device(usb_dev);
1935 if (usb_dev->authorized == 0)
1936 goto out_unauthorized;
1937
1938 usb_dev->authorized = 0;
1939 usb_set_configuration(usb_dev, -1);
1940
1941 kfree(usb_dev->product);
1942 usb_dev->product = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1943 kfree(usb_dev->manufacturer);
1944 usb_dev->manufacturer = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1945 kfree(usb_dev->serial);
1946 usb_dev->serial = kstrdup("n/a (unauthorized)", GFP_KERNEL);
1947
1948 usb_destroy_configuration(usb_dev);
1949 usb_dev->descriptor.bNumConfigurations = 0;
1950
1951out_unauthorized:
1952 usb_unlock_device(usb_dev);
1953 return 0;
1954}
1955
1956
1957int usb_authorize_device(struct usb_device *usb_dev)
1958{
1959 int result = 0, c;
1960
1961 usb_lock_device(usb_dev);
1962 if (usb_dev->authorized == 1)
1963 goto out_authorized;
1964
1965 result = usb_autoresume_device(usb_dev);
1966 if (result < 0) {
1967 dev_err(&usb_dev->dev,
1968 "can't autoresume for authorization: %d\n", result);
1969 goto error_autoresume;
1970 }
1971 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
1972 if (result < 0) {
1973 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
1974 "authorization: %d\n", result);
1975 goto error_device_descriptor;
1976 }
1977
1978 kfree(usb_dev->product);
1979 usb_dev->product = NULL;
1980 kfree(usb_dev->manufacturer);
1981 usb_dev->manufacturer = NULL;
1982 kfree(usb_dev->serial);
1983 usb_dev->serial = NULL;
1984
1985 usb_dev->authorized = 1;
1986 result = usb_enumerate_device(usb_dev);
1987 if (result < 0)
1988 goto error_enumerate;
1989 /* Choose and set the configuration. This registers the interfaces
1990 * with the driver core and lets interface drivers bind to them.
1991 */
1992 c = usb_choose_configuration(usb_dev);
1993 if (c >= 0) {
1994 result = usb_set_configuration(usb_dev, c);
1995 if (result) {
1996 dev_err(&usb_dev->dev,
1997 "can't set config #%d, error %d\n", c, result);
1998 /* This need not be fatal. The user can try to
1999 * set other configurations. */
2000 }
2001 }
2002 dev_info(&usb_dev->dev, "authorized to connect\n");
2003
2004error_enumerate:
2005error_device_descriptor:
2006 usb_autosuspend_device(usb_dev);
2007error_autoresume:
2008out_authorized:
2009 usb_unlock_device(usb_dev); // complements locktree
2010 return result;
2011}
2012
2013
2014/* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2015static unsigned hub_is_wusb(struct usb_hub *hub)
2016{
2017 struct usb_hcd *hcd;
2018 if (hub->hdev->parent != NULL) /* not a root hub? */
2019 return 0;
2020 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2021 return hcd->wireless;
2022}
2023
2024
2025#define PORT_RESET_TRIES 5
2026#define SET_ADDRESS_TRIES 2
2027#define GET_DESCRIPTOR_TRIES 2
2028#define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2029#define USE_NEW_SCHEME(i) ((i) / 2 == old_scheme_first)
2030
2031#define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2032#define HUB_SHORT_RESET_TIME 10
2033#define HUB_LONG_RESET_TIME 200
2034#define HUB_RESET_TIMEOUT 500
2035
2036static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2037 struct usb_device *udev, unsigned int delay)
2038{
2039 int delay_time, ret;
2040 u16 portstatus;
2041 u16 portchange;
2042
2043 for (delay_time = 0;
2044 delay_time < HUB_RESET_TIMEOUT;
2045 delay_time += delay) {
2046 /* wait to give the device a chance to reset */
2047 msleep(delay);
2048
2049 /* read and decode port status */
2050 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2051 if (ret < 0)
2052 return ret;
2053
2054 /* Device went away? */
2055 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2056 return -ENOTCONN;
2057
2058 /* bomb out completely if the connection bounced */
2059 if ((portchange & USB_PORT_STAT_C_CONNECTION))
2060 return -ENOTCONN;
2061
2062 /* if we`ve finished resetting, then break out of the loop */
2063 if (!(portstatus & USB_PORT_STAT_RESET) &&
2064 (portstatus & USB_PORT_STAT_ENABLE)) {
2065 if (hub_is_wusb(hub))
2066 udev->speed = USB_SPEED_WIRELESS;
2067 else if (hub_is_superspeed(hub->hdev))
2068 udev->speed = USB_SPEED_SUPER;
2069 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2070 udev->speed = USB_SPEED_HIGH;
2071 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2072 udev->speed = USB_SPEED_LOW;
2073 else
2074 udev->speed = USB_SPEED_FULL;
2075 return 0;
2076 }
2077
2078 /* switch to the long delay after two short delay failures */
2079 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2080 delay = HUB_LONG_RESET_TIME;
2081
2082 dev_dbg (hub->intfdev,
2083 "port %d not reset yet, waiting %dms\n",
2084 port1, delay);
2085 }
2086
2087 return -EBUSY;
2088}
2089
2090static int hub_port_reset(struct usb_hub *hub, int port1,
2091 struct usb_device *udev, unsigned int delay)
2092{
2093 int i, status;
2094 struct usb_hcd *hcd;
2095
2096 hcd = bus_to_hcd(udev->bus);
2097 /* Block EHCI CF initialization during the port reset.
2098 * Some companion controllers don't like it when they mix.
2099 */
2100 down_read(&ehci_cf_port_reset_rwsem);
2101
2102 /* Reset the port */
2103 for (i = 0; i < PORT_RESET_TRIES; i++) {
2104 status = set_port_feature(hub->hdev,
2105 port1, USB_PORT_FEAT_RESET);
2106 if (status)
2107 dev_err(hub->intfdev,
2108 "cannot reset port %d (err = %d)\n",
2109 port1, status);
2110 else {
2111 status = hub_port_wait_reset(hub, port1, udev, delay);
2112 if (status && status != -ENOTCONN)
2113 dev_dbg(hub->intfdev,
2114 "port_wait_reset: err = %d\n",
2115 status);
2116 }
2117
2118 /* return on disconnect or reset */
2119 switch (status) {
2120 case 0:
2121 /* TRSTRCY = 10 ms; plus some extra */
2122 msleep(10 + 40);
2123 update_devnum(udev, 0);
2124 if (hcd->driver->reset_device) {
2125 status = hcd->driver->reset_device(hcd, udev);
2126 if (status < 0) {
2127 dev_err(&udev->dev, "Cannot reset "
2128 "HCD device state\n");
2129 break;
2130 }
2131 }
2132 /* FALL THROUGH */
2133 case -ENOTCONN:
2134 case -ENODEV:
2135 clear_port_feature(hub->hdev,
2136 port1, USB_PORT_FEAT_C_RESET);
2137 /* FIXME need disconnect() for NOTATTACHED device */
2138 usb_set_device_state(udev, status
2139 ? USB_STATE_NOTATTACHED
2140 : USB_STATE_DEFAULT);
2141 goto done;
2142 }
2143
2144 dev_dbg (hub->intfdev,
2145 "port %d not enabled, trying reset again...\n",
2146 port1);
2147 delay = HUB_LONG_RESET_TIME;
2148 }
2149
2150 dev_err (hub->intfdev,
2151 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2152 port1);
2153
2154 done:
2155 up_read(&ehci_cf_port_reset_rwsem);
2156 return status;
2157}
2158
2159/* Warm reset a USB3 protocol port */
2160static int hub_port_warm_reset(struct usb_hub *hub, int port)
2161{
2162 int ret;
2163 u16 portstatus, portchange;
2164
2165 if (!hub_is_superspeed(hub->hdev)) {
2166 dev_err(hub->intfdev, "only USB3 hub support warm reset\n");
2167 return -EINVAL;
2168 }
2169
2170 /* Warm reset the port */
2171 ret = set_port_feature(hub->hdev,
2172 port, USB_PORT_FEAT_BH_PORT_RESET);
2173 if (ret) {
2174 dev_err(hub->intfdev, "cannot warm reset port %d\n", port);
2175 return ret;
2176 }
2177
2178 msleep(20);
2179 ret = hub_port_status(hub, port, &portstatus, &portchange);
2180
2181 if (portchange & USB_PORT_STAT_C_RESET)
2182 clear_port_feature(hub->hdev, port, USB_PORT_FEAT_C_RESET);
2183
2184 if (portchange & USB_PORT_STAT_C_BH_RESET)
2185 clear_port_feature(hub->hdev, port,
2186 USB_PORT_FEAT_C_BH_PORT_RESET);
2187
2188 if (portchange & USB_PORT_STAT_C_LINK_STATE)
2189 clear_port_feature(hub->hdev, port,
2190 USB_PORT_FEAT_C_PORT_LINK_STATE);
2191
2192 return ret;
2193}
2194
2195/* Check if a port is power on */
2196static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2197{
2198 int ret = 0;
2199
2200 if (hub_is_superspeed(hub->hdev)) {
2201 if (portstatus & USB_SS_PORT_STAT_POWER)
2202 ret = 1;
2203 } else {
2204 if (portstatus & USB_PORT_STAT_POWER)
2205 ret = 1;
2206 }
2207
2208 return ret;
2209}
2210
2211#ifdef CONFIG_PM
2212
2213/* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2214static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2215{
2216 int ret = 0;
2217
2218 if (hub_is_superspeed(hub->hdev)) {
2219 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2220 == USB_SS_PORT_LS_U3)
2221 ret = 1;
2222 } else {
2223 if (portstatus & USB_PORT_STAT_SUSPEND)
2224 ret = 1;
2225 }
2226
2227 return ret;
2228}
2229
2230/* Determine whether the device on a port is ready for a normal resume,
2231 * is ready for a reset-resume, or should be disconnected.
2232 */
2233static int check_port_resume_type(struct usb_device *udev,
2234 struct usb_hub *hub, int port1,
2235 int status, unsigned portchange, unsigned portstatus)
2236{
2237 /* Is the device still present? */
2238 if (status || port_is_suspended(hub, portstatus) ||
2239 !port_is_power_on(hub, portstatus) ||
2240 !(portstatus & USB_PORT_STAT_CONNECTION)) {
2241 if (status >= 0)
2242 status = -ENODEV;
2243 }
2244
2245 /* Can't do a normal resume if the port isn't enabled,
2246 * so try a reset-resume instead.
2247 */
2248 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2249 if (udev->persist_enabled)
2250 udev->reset_resume = 1;
2251 else
2252 status = -ENODEV;
2253 }
2254
2255 if (status) {
2256 dev_dbg(hub->intfdev,
2257 "port %d status %04x.%04x after resume, %d\n",
2258 port1, portchange, portstatus, status);
2259 } else if (udev->reset_resume) {
2260
2261 /* Late port handoff can set status-change bits */
2262 if (portchange & USB_PORT_STAT_C_CONNECTION)
2263 clear_port_feature(hub->hdev, port1,
2264 USB_PORT_FEAT_C_CONNECTION);
2265 if (portchange & USB_PORT_STAT_C_ENABLE)
2266 clear_port_feature(hub->hdev, port1,
2267 USB_PORT_FEAT_C_ENABLE);
2268 }
2269
2270 return status;
2271}
2272
2273#ifdef CONFIG_USB_SUSPEND
2274
2275/*
2276 * usb_port_suspend - suspend a usb device's upstream port
2277 * @udev: device that's no longer in active use, not a root hub
2278 * Context: must be able to sleep; device not locked; pm locks held
2279 *
2280 * Suspends a USB device that isn't in active use, conserving power.
2281 * Devices may wake out of a suspend, if anything important happens,
2282 * using the remote wakeup mechanism. They may also be taken out of
2283 * suspend by the host, using usb_port_resume(). It's also routine
2284 * to disconnect devices while they are suspended.
2285 *
2286 * This only affects the USB hardware for a device; its interfaces
2287 * (and, for hubs, child devices) must already have been suspended.
2288 *
2289 * Selective port suspend reduces power; most suspended devices draw
2290 * less than 500 uA. It's also used in OTG, along with remote wakeup.
2291 * All devices below the suspended port are also suspended.
2292 *
2293 * Devices leave suspend state when the host wakes them up. Some devices
2294 * also support "remote wakeup", where the device can activate the USB
2295 * tree above them to deliver data, such as a keypress or packet. In
2296 * some cases, this wakes the USB host.
2297 *
2298 * Suspending OTG devices may trigger HNP, if that's been enabled
2299 * between a pair of dual-role devices. That will change roles, such
2300 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
2301 *
2302 * Devices on USB hub ports have only one "suspend" state, corresponding
2303 * to ACPI D2, "may cause the device to lose some context".
2304 * State transitions include:
2305 *
2306 * - suspend, resume ... when the VBUS power link stays live
2307 * - suspend, disconnect ... VBUS lost
2308 *
2309 * Once VBUS drop breaks the circuit, the port it's using has to go through
2310 * normal re-enumeration procedures, starting with enabling VBUS power.
2311 * Other than re-initializing the hub (plug/unplug, except for root hubs),
2312 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
2313 * timer, no SRP, no requests through sysfs.
2314 *
2315 * If CONFIG_USB_SUSPEND isn't enabled, devices only really suspend when
2316 * the root hub for their bus goes into global suspend ... so we don't
2317 * (falsely) update the device power state to say it suspended.
2318 *
2319 * Returns 0 on success, else negative errno.
2320 */
2321int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2322{
2323 struct usb_hub *hub = hdev_to_hub(udev->parent);
2324 int port1 = udev->portnum;
2325 int status;
2326
2327 // dev_dbg(hub->intfdev, "suspend port %d\n", port1);
2328
2329 /* enable remote wakeup when appropriate; this lets the device
2330 * wake up the upstream hub (including maybe the root hub).
2331 *
2332 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
2333 * we don't explicitly enable it here.
2334 */
2335 if (udev->do_remote_wakeup) {
2336 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2337 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
2338 USB_DEVICE_REMOTE_WAKEUP, 0,
2339 NULL, 0,
2340 USB_CTRL_SET_TIMEOUT);
2341 if (status) {
2342 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
2343 status);
2344 /* bail if autosuspend is requested */
2345 if (msg.event & PM_EVENT_AUTO)
2346 return status;
2347 }
2348 }
2349
2350 /* see 7.1.7.6 */
2351 if (hub_is_superspeed(hub->hdev))
2352 status = set_port_feature(hub->hdev,
2353 port1 | (USB_SS_PORT_LS_U3 << 3),
2354 USB_PORT_FEAT_LINK_STATE);
2355 else
2356 status = set_port_feature(hub->hdev, port1,
2357 USB_PORT_FEAT_SUSPEND);
2358 if (status) {
2359 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
2360 port1, status);
2361 /* paranoia: "should not happen" */
2362 if (udev->do_remote_wakeup)
2363 (void) usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
2364 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
2365 USB_DEVICE_REMOTE_WAKEUP, 0,
2366 NULL, 0,
2367 USB_CTRL_SET_TIMEOUT);
2368
2369 /* System sleep transitions should never fail */
2370 if (!(msg.event & PM_EVENT_AUTO))
2371 status = 0;
2372 } else {
2373 /* device has up to 10 msec to fully suspend */
2374 dev_dbg(&udev->dev, "usb %ssuspend\n",
2375 (msg.event & PM_EVENT_AUTO ? "auto-" : ""));
2376 usb_set_device_state(udev, USB_STATE_SUSPENDED);
2377 msleep(10);
2378 }
2379 usb_mark_last_busy(hub->hdev);
2380 return status;
2381}
2382
2383/*
2384 * If the USB "suspend" state is in use (rather than "global suspend"),
2385 * many devices will be individually taken out of suspend state using
2386 * special "resume" signaling. This routine kicks in shortly after
2387 * hardware resume signaling is finished, either because of selective
2388 * resume (by host) or remote wakeup (by device) ... now see what changed
2389 * in the tree that's rooted at this device.
2390 *
2391 * If @udev->reset_resume is set then the device is reset before the
2392 * status check is done.
2393 */
2394static int finish_port_resume(struct usb_device *udev)
2395{
2396 int status = 0;
2397 u16 devstatus;
2398
2399 /* caller owns the udev device lock */
2400 dev_dbg(&udev->dev, "%s\n",
2401 udev->reset_resume ? "finish reset-resume" : "finish resume");
2402
2403 /* usb ch9 identifies four variants of SUSPENDED, based on what
2404 * state the device resumes to. Linux currently won't see the
2405 * first two on the host side; they'd be inside hub_port_init()
2406 * during many timeouts, but khubd can't suspend until later.
2407 */
2408 usb_set_device_state(udev, udev->actconfig
2409 ? USB_STATE_CONFIGURED
2410 : USB_STATE_ADDRESS);
2411
2412 /* 10.5.4.5 says not to reset a suspended port if the attached
2413 * device is enabled for remote wakeup. Hence the reset
2414 * operation is carried out here, after the port has been
2415 * resumed.
2416 */
2417 if (udev->reset_resume)
2418 retry_reset_resume:
2419 status = usb_reset_and_verify_device(udev);
2420
2421 /* 10.5.4.5 says be sure devices in the tree are still there.
2422 * For now let's assume the device didn't go crazy on resume,
2423 * and device drivers will know about any resume quirks.
2424 */
2425 if (status == 0) {
2426 devstatus = 0;
2427 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
2428 if (status >= 0)
2429 status = (status > 0 ? 0 : -ENODEV);
2430
2431 /* If a normal resume failed, try doing a reset-resume */
2432 if (status && !udev->reset_resume && udev->persist_enabled) {
2433 dev_dbg(&udev->dev, "retry with reset-resume\n");
2434 udev->reset_resume = 1;
2435 goto retry_reset_resume;
2436 }
2437 }
2438
2439 if (status) {
2440 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
2441 status);
2442 } else if (udev->actconfig) {
2443 le16_to_cpus(&devstatus);
2444 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP)) {
2445 status = usb_control_msg(udev,
2446 usb_sndctrlpipe(udev, 0),
2447 USB_REQ_CLEAR_FEATURE,
2448 USB_RECIP_DEVICE,
2449 USB_DEVICE_REMOTE_WAKEUP, 0,
2450 NULL, 0,
2451 USB_CTRL_SET_TIMEOUT);
2452 if (status)
2453 dev_dbg(&udev->dev,
2454 "disable remote wakeup, status %d\n",
2455 status);
2456 }
2457 status = 0;
2458 }
2459 return status;
2460}
2461
2462/*
2463 * usb_port_resume - re-activate a suspended usb device's upstream port
2464 * @udev: device to re-activate, not a root hub
2465 * Context: must be able to sleep; device not locked; pm locks held
2466 *
2467 * This will re-activate the suspended device, increasing power usage
2468 * while letting drivers communicate again with its endpoints.
2469 * USB resume explicitly guarantees that the power session between
2470 * the host and the device is the same as it was when the device
2471 * suspended.
2472 *
2473 * If @udev->reset_resume is set then this routine won't check that the
2474 * port is still enabled. Furthermore, finish_port_resume() above will
2475 * reset @udev. The end result is that a broken power session can be
2476 * recovered and @udev will appear to persist across a loss of VBUS power.
2477 *
2478 * For example, if a host controller doesn't maintain VBUS suspend current
2479 * during a system sleep or is reset when the system wakes up, all the USB
2480 * power sessions below it will be broken. This is especially troublesome
2481 * for mass-storage devices containing mounted filesystems, since the
2482 * device will appear to have disconnected and all the memory mappings
2483 * to it will be lost. Using the USB_PERSIST facility, the device can be
2484 * made to appear as if it had not disconnected.
2485 *
2486 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
2487 * every effort to insure that the same device is present after the
2488 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
2489 * quite possible for a device to remain unaltered but its media to be
2490 * changed. If the user replaces a flash memory card while the system is
2491 * asleep, he will have only himself to blame when the filesystem on the
2492 * new card is corrupted and the system crashes.
2493 *
2494 * Returns 0 on success, else negative errno.
2495 */
2496int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2497{
2498 struct usb_hub *hub = hdev_to_hub(udev->parent);
2499 int port1 = udev->portnum;
2500 int status;
2501 u16 portchange, portstatus;
2502
2503 /* Skip the initial Clear-Suspend step for a remote wakeup */
2504 status = hub_port_status(hub, port1, &portstatus, &portchange);
2505 if (status == 0 && !port_is_suspended(hub, portstatus))
2506 goto SuspendCleared;
2507
2508 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
2509
2510 set_bit(port1, hub->busy_bits);
2511
2512 /* see 7.1.7.7; affects power usage, but not budgeting */
2513 if (hub_is_superspeed(hub->hdev))
2514 status = set_port_feature(hub->hdev,
2515 port1 | (USB_SS_PORT_LS_U0 << 3),
2516 USB_PORT_FEAT_LINK_STATE);
2517 else
2518 status = clear_port_feature(hub->hdev,
2519 port1, USB_PORT_FEAT_SUSPEND);
2520 if (status) {
2521 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
2522 port1, status);
2523 } else {
2524 /* drive resume for at least 20 msec */
2525 dev_dbg(&udev->dev, "usb %sresume\n",
2526 (msg.event & PM_EVENT_AUTO ? "auto-" : ""));
2527 msleep(25);
2528
2529 /* Virtual root hubs can trigger on GET_PORT_STATUS to
2530 * stop resume signaling. Then finish the resume
2531 * sequence.
2532 */
2533 status = hub_port_status(hub, port1, &portstatus, &portchange);
2534
2535 /* TRSMRCY = 10 msec */
2536 msleep(10);
2537 }
2538
2539 SuspendCleared:
2540 if (status == 0) {
2541 if (hub_is_superspeed(hub->hdev)) {
2542 if (portchange & USB_PORT_STAT_C_LINK_STATE)
2543 clear_port_feature(hub->hdev, port1,
2544 USB_PORT_FEAT_C_PORT_LINK_STATE);
2545 } else {
2546 if (portchange & USB_PORT_STAT_C_SUSPEND)
2547 clear_port_feature(hub->hdev, port1,
2548 USB_PORT_FEAT_C_SUSPEND);
2549 }
2550 }
2551
2552 clear_bit(port1, hub->busy_bits);
2553
2554 status = check_port_resume_type(udev,
2555 hub, port1, status, portchange, portstatus);
2556 if (status == 0)
2557 status = finish_port_resume(udev);
2558 if (status < 0) {
2559 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2560 hub_port_logical_disconnect(hub, port1);
2561 }
2562 return status;
2563}
2564
2565/* caller has locked udev */
2566int usb_remote_wakeup(struct usb_device *udev)
2567{
2568 int status = 0;
2569
2570 if (udev->state == USB_STATE_SUSPENDED) {
2571 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
2572 status = usb_autoresume_device(udev);
2573 if (status == 0) {
2574 /* Let the drivers do their thing, then... */
2575 usb_autosuspend_device(udev);
2576 }
2577 }
2578 return status;
2579}
2580
2581#else /* CONFIG_USB_SUSPEND */
2582
2583/* When CONFIG_USB_SUSPEND isn't set, we never suspend or resume any ports. */
2584
2585int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
2586{
2587 return 0;
2588}
2589
2590/* However we may need to do a reset-resume */
2591
2592int usb_port_resume(struct usb_device *udev, pm_message_t msg)
2593{
2594 struct usb_hub *hub = hdev_to_hub(udev->parent);
2595 int port1 = udev->portnum;
2596 int status;
2597 u16 portchange, portstatus;
2598
2599 status = hub_port_status(hub, port1, &portstatus, &portchange);
2600 status = check_port_resume_type(udev,
2601 hub, port1, status, portchange, portstatus);
2602
2603 if (status) {
2604 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
2605 hub_port_logical_disconnect(hub, port1);
2606 } else if (udev->reset_resume) {
2607 dev_dbg(&udev->dev, "reset-resume\n");
2608 status = usb_reset_and_verify_device(udev);
2609 }
2610 return status;
2611}
2612
2613#endif
2614
2615static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
2616{
2617 struct usb_hub *hub = usb_get_intfdata (intf);
2618 struct usb_device *hdev = hub->hdev;
2619 unsigned port1;
2620
2621 /* Warn if children aren't already suspended */
2622 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
2623 struct usb_device *udev;
2624
2625 udev = hdev->children [port1-1];
2626 if (udev && udev->can_submit) {
2627 dev_warn(&intf->dev, "port %d nyet suspended\n", port1);
2628 if (msg.event & PM_EVENT_AUTO)
2629 return -EBUSY;
2630 }
2631 }
2632
2633 dev_dbg(&intf->dev, "%s\n", __func__);
2634
2635 /* stop khubd and related activity */
2636 hub_quiesce(hub, HUB_SUSPEND);
2637 return 0;
2638}
2639
2640static int hub_resume(struct usb_interface *intf)
2641{
2642 struct usb_hub *hub = usb_get_intfdata(intf);
2643
2644 dev_dbg(&intf->dev, "%s\n", __func__);
2645 hub_activate(hub, HUB_RESUME);
2646 return 0;
2647}
2648
2649static int hub_reset_resume(struct usb_interface *intf)
2650{
2651 struct usb_hub *hub = usb_get_intfdata(intf);
2652
2653 dev_dbg(&intf->dev, "%s\n", __func__);
2654 hub_activate(hub, HUB_RESET_RESUME);
2655 return 0;
2656}
2657
2658/**
2659 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
2660 * @rhdev: struct usb_device for the root hub
2661 *
2662 * The USB host controller driver calls this function when its root hub
2663 * is resumed and Vbus power has been interrupted or the controller
2664 * has been reset. The routine marks @rhdev as having lost power.
2665 * When the hub driver is resumed it will take notice and carry out
2666 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
2667 * the others will be disconnected.
2668 */
2669void usb_root_hub_lost_power(struct usb_device *rhdev)
2670{
2671 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
2672 rhdev->reset_resume = 1;
2673}
2674EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
2675
2676#else /* CONFIG_PM */
2677
2678#define hub_suspend NULL
2679#define hub_resume NULL
2680#define hub_reset_resume NULL
2681#endif
2682
2683
2684/* USB 2.0 spec, 7.1.7.3 / fig 7-29:
2685 *
2686 * Between connect detection and reset signaling there must be a delay
2687 * of 100ms at least for debounce and power-settling. The corresponding
2688 * timer shall restart whenever the downstream port detects a disconnect.
2689 *
2690 * Apparently there are some bluetooth and irda-dongles and a number of
2691 * low-speed devices for which this debounce period may last over a second.
2692 * Not covered by the spec - but easy to deal with.
2693 *
2694 * This implementation uses a 1500ms total debounce timeout; if the
2695 * connection isn't stable by then it returns -ETIMEDOUT. It checks
2696 * every 25ms for transient disconnects. When the port status has been
2697 * unchanged for 100ms it returns the port status.
2698 */
2699static int hub_port_debounce(struct usb_hub *hub, int port1)
2700{
2701 int ret;
2702 int total_time, stable_time = 0;
2703 u16 portchange, portstatus;
2704 unsigned connection = 0xffff;
2705
2706 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
2707 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2708 if (ret < 0)
2709 return ret;
2710
2711 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
2712 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
2713 stable_time += HUB_DEBOUNCE_STEP;
2714 if (stable_time >= HUB_DEBOUNCE_STABLE)
2715 break;
2716 } else {
2717 stable_time = 0;
2718 connection = portstatus & USB_PORT_STAT_CONNECTION;
2719 }
2720
2721 if (portchange & USB_PORT_STAT_C_CONNECTION) {
2722 clear_port_feature(hub->hdev, port1,
2723 USB_PORT_FEAT_C_CONNECTION);
2724 }
2725
2726 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
2727 break;
2728 msleep(HUB_DEBOUNCE_STEP);
2729 }
2730
2731 dev_dbg (hub->intfdev,
2732 "debounce: port %d: total %dms stable %dms status 0x%x\n",
2733 port1, total_time, stable_time, portstatus);
2734
2735 if (stable_time < HUB_DEBOUNCE_STABLE)
2736 return -ETIMEDOUT;
2737 return portstatus;
2738}
2739
2740void usb_ep0_reinit(struct usb_device *udev)
2741{
2742 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
2743 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
2744 usb_enable_endpoint(udev, &udev->ep0, true);
2745}
2746EXPORT_SYMBOL_GPL(usb_ep0_reinit);
2747
2748#define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
2749#define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
2750
2751static int hub_set_address(struct usb_device *udev, int devnum)
2752{
2753 int retval;
2754 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2755
2756 /*
2757 * The host controller will choose the device address,
2758 * instead of the core having chosen it earlier
2759 */
2760 if (!hcd->driver->address_device && devnum <= 1)
2761 return -EINVAL;
2762 if (udev->state == USB_STATE_ADDRESS)
2763 return 0;
2764 if (udev->state != USB_STATE_DEFAULT)
2765 return -EINVAL;
2766 if (hcd->driver->address_device)
2767 retval = hcd->driver->address_device(hcd, udev);
2768 else
2769 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
2770 USB_REQ_SET_ADDRESS, 0, devnum, 0,
2771 NULL, 0, USB_CTRL_SET_TIMEOUT);
2772 if (retval == 0) {
2773 update_devnum(udev, devnum);
2774 /* Device now using proper address. */
2775 usb_set_device_state(udev, USB_STATE_ADDRESS);
2776 usb_ep0_reinit(udev);
2777 }
2778 return retval;
2779}
2780
2781/* Reset device, (re)assign address, get device descriptor.
2782 * Device connection must be stable, no more debouncing needed.
2783 * Returns device in USB_STATE_ADDRESS, except on error.
2784 *
2785 * If this is called for an already-existing device (as part of
2786 * usb_reset_and_verify_device), the caller must own the device lock. For a
2787 * newly detected device that is not accessible through any global
2788 * pointers, it's not necessary to lock the device.
2789 */
2790static int
2791hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
2792 int retry_counter)
2793{
2794 static DEFINE_MUTEX(usb_address0_mutex);
2795
2796 struct usb_device *hdev = hub->hdev;
2797 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
2798 int i, j, retval;
2799 unsigned delay = HUB_SHORT_RESET_TIME;
2800 enum usb_device_speed oldspeed = udev->speed;
2801 char *speed, *type;
2802 int devnum = udev->devnum;
2803
2804 /* root hub ports have a slightly longer reset period
2805 * (from USB 2.0 spec, section 7.1.7.5)
2806 */
2807 if (!hdev->parent) {
2808 delay = HUB_ROOT_RESET_TIME;
2809 if (port1 == hdev->bus->otg_port)
2810 hdev->bus->b_hnp_enable = 0;
2811 }
2812
2813 /* Some low speed devices have problems with the quick delay, so */
2814 /* be a bit pessimistic with those devices. RHbug #23670 */
2815 if (oldspeed == USB_SPEED_LOW)
2816 delay = HUB_LONG_RESET_TIME;
2817
2818 mutex_lock(&usb_address0_mutex);
2819
2820 /* Reset the device; full speed may morph to high speed */
2821 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
2822 retval = hub_port_reset(hub, port1, udev, delay);
2823 if (retval < 0) /* error or disconnect */
2824 goto fail;
2825 /* success, speed is known */
2826
2827 retval = -ENODEV;
2828
2829 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
2830 dev_dbg(&udev->dev, "device reset changed speed!\n");
2831 goto fail;
2832 }
2833 oldspeed = udev->speed;
2834
2835 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
2836 * it's fixed size except for full speed devices.
2837 * For Wireless USB devices, ep0 max packet is always 512 (tho
2838 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
2839 */
2840 switch (udev->speed) {
2841 case USB_SPEED_SUPER:
2842 case USB_SPEED_WIRELESS: /* fixed at 512 */
2843 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
2844 break;
2845 case USB_SPEED_HIGH: /* fixed at 64 */
2846 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
2847 break;
2848 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
2849 /* to determine the ep0 maxpacket size, try to read
2850 * the device descriptor to get bMaxPacketSize0 and
2851 * then correct our initial guess.
2852 */
2853 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
2854 break;
2855 case USB_SPEED_LOW: /* fixed at 8 */
2856 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
2857 break;
2858 default:
2859 goto fail;
2860 }
2861
2862 type = "";
2863 switch (udev->speed) {
2864 case USB_SPEED_LOW: speed = "low"; break;
2865 case USB_SPEED_FULL: speed = "full"; break;
2866 case USB_SPEED_HIGH: speed = "high"; break;
2867 case USB_SPEED_SUPER:
2868 speed = "super";
2869 break;
2870 case USB_SPEED_WIRELESS:
2871 speed = "variable";
2872 type = "Wireless ";
2873 break;
2874 default: speed = "?"; break;
2875 }
2876 if (udev->speed != USB_SPEED_SUPER)
2877 dev_info(&udev->dev,
2878 "%s %s speed %sUSB device number %d using %s\n",
2879 (udev->config) ? "reset" : "new", speed, type,
2880 devnum, udev->bus->controller->driver->name);
2881
2882 /* Set up TT records, if needed */
2883 if (hdev->tt) {
2884 udev->tt = hdev->tt;
2885 udev->ttport = hdev->ttport;
2886 } else if (udev->speed != USB_SPEED_HIGH
2887 && hdev->speed == USB_SPEED_HIGH) {
2888 if (!hub->tt.hub) {
2889 dev_err(&udev->dev, "parent hub has no TT\n");
2890 retval = -EINVAL;
2891 goto fail;
2892 }
2893 udev->tt = &hub->tt;
2894 udev->ttport = port1;
2895 }
2896
2897 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
2898 * Because device hardware and firmware is sometimes buggy in
2899 * this area, and this is how Linux has done it for ages.
2900 * Change it cautiously.
2901 *
2902 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
2903 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
2904 * so it may help with some non-standards-compliant devices.
2905 * Otherwise we start with SET_ADDRESS and then try to read the
2906 * first 8 bytes of the device descriptor to get the ep0 maxpacket
2907 * value.
2908 */
2909 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
2910 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
2911 struct usb_device_descriptor *buf;
2912 int r = 0;
2913
2914#define GET_DESCRIPTOR_BUFSIZE 64
2915 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
2916 if (!buf) {
2917 retval = -ENOMEM;
2918 continue;
2919 }
2920
2921 /* Retry on all errors; some devices are flakey.
2922 * 255 is for WUSB devices, we actually need to use
2923 * 512 (WUSB1.0[4.8.1]).
2924 */
2925 for (j = 0; j < 3; ++j) {
2926 buf->bMaxPacketSize0 = 0;
2927 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
2928 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
2929 USB_DT_DEVICE << 8, 0,
2930 buf, GET_DESCRIPTOR_BUFSIZE,
2931 initial_descriptor_timeout);
2932 switch (buf->bMaxPacketSize0) {
2933 case 8: case 16: case 32: case 64: case 255:
2934 if (buf->bDescriptorType ==
2935 USB_DT_DEVICE) {
2936 r = 0;
2937 break;
2938 }
2939 /* FALL THROUGH */
2940 default:
2941 if (r == 0)
2942 r = -EPROTO;
2943 break;
2944 }
2945 if (r == 0)
2946 break;
2947 }
2948 udev->descriptor.bMaxPacketSize0 =
2949 buf->bMaxPacketSize0;
2950 kfree(buf);
2951
2952 retval = hub_port_reset(hub, port1, udev, delay);
2953 if (retval < 0) /* error or disconnect */
2954 goto fail;
2955 if (oldspeed != udev->speed) {
2956 dev_dbg(&udev->dev,
2957 "device reset changed speed!\n");
2958 retval = -ENODEV;
2959 goto fail;
2960 }
2961 if (r) {
2962 dev_err(&udev->dev,
2963 "device descriptor read/64, error %d\n",
2964 r);
2965 retval = -EMSGSIZE;
2966 continue;
2967 }
2968#undef GET_DESCRIPTOR_BUFSIZE
2969 }
2970
2971 /*
2972 * If device is WUSB, we already assigned an
2973 * unauthorized address in the Connect Ack sequence;
2974 * authorization will assign the final address.
2975 */
2976 if (udev->wusb == 0) {
2977 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
2978 retval = hub_set_address(udev, devnum);
2979 if (retval >= 0)
2980 break;
2981 msleep(200);
2982 }
2983 if (retval < 0) {
2984 dev_err(&udev->dev,
2985 "device not accepting address %d, error %d\n",
2986 devnum, retval);
2987 goto fail;
2988 }
2989 if (udev->speed == USB_SPEED_SUPER) {
2990 devnum = udev->devnum;
2991 dev_info(&udev->dev,
2992 "%s SuperSpeed USB device number %d using %s\n",
2993 (udev->config) ? "reset" : "new",
2994 devnum, udev->bus->controller->driver->name);
2995 }
2996
2997 /* cope with hardware quirkiness:
2998 * - let SET_ADDRESS settle, some device hardware wants it
2999 * - read ep0 maxpacket even for high and low speed,
3000 */
3001 msleep(10);
3002 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
3003 break;
3004 }
3005
3006 retval = usb_get_device_descriptor(udev, 8);
3007 if (retval < 8) {
3008 dev_err(&udev->dev,
3009 "device descriptor read/8, error %d\n",
3010 retval);
3011 if (retval >= 0)
3012 retval = -EMSGSIZE;
3013 } else {
3014 retval = 0;
3015 break;
3016 }
3017 }
3018 if (retval)
3019 goto fail;
3020
3021 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
3022 udev->speed == USB_SPEED_SUPER)
3023 i = 512;
3024 else
3025 i = udev->descriptor.bMaxPacketSize0;
3026 if (le16_to_cpu(udev->ep0.desc.wMaxPacketSize) != i) {
3027 if (udev->speed == USB_SPEED_LOW ||
3028 !(i == 8 || i == 16 || i == 32 || i == 64)) {
3029 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
3030 retval = -EMSGSIZE;
3031 goto fail;
3032 }
3033 if (udev->speed == USB_SPEED_FULL)
3034 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
3035 else
3036 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
3037 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
3038 usb_ep0_reinit(udev);
3039 }
3040
3041 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
3042 if (retval < (signed)sizeof(udev->descriptor)) {
3043 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
3044 retval);
3045 if (retval >= 0)
3046 retval = -ENOMSG;
3047 goto fail;
3048 }
3049
3050 retval = 0;
3051 /* notify HCD that we have a device connected and addressed */
3052 if (hcd->driver->update_device)
3053 hcd->driver->update_device(hcd, udev);
3054fail:
3055 if (retval) {
3056 hub_port_disable(hub, port1, 0);
3057 update_devnum(udev, devnum); /* for disconnect processing */
3058 }
3059 mutex_unlock(&usb_address0_mutex);
3060 return retval;
3061}
3062
3063static void
3064check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
3065{
3066 struct usb_qualifier_descriptor *qual;
3067 int status;
3068
3069 qual = kmalloc (sizeof *qual, GFP_KERNEL);
3070 if (qual == NULL)
3071 return;
3072
3073 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
3074 qual, sizeof *qual);
3075 if (status == sizeof *qual) {
3076 dev_info(&udev->dev, "not running at top speed; "
3077 "connect to a high speed hub\n");
3078 /* hub LEDs are probably harder to miss than syslog */
3079 if (hub->has_indicators) {
3080 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
3081 schedule_delayed_work (&hub->leds, 0);
3082 }
3083 }
3084 kfree(qual);
3085}
3086
3087static unsigned
3088hub_power_remaining (struct usb_hub *hub)
3089{
3090 struct usb_device *hdev = hub->hdev;
3091 int remaining;
3092 int port1;
3093
3094 if (!hub->limited_power)
3095 return 0;
3096
3097 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
3098 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
3099 struct usb_device *udev = hdev->children[port1 - 1];
3100 int delta;
3101
3102 if (!udev)
3103 continue;
3104
3105 /* Unconfigured devices may not use more than 100mA,
3106 * or 8mA for OTG ports */
3107 if (udev->actconfig)
3108 delta = udev->actconfig->desc.bMaxPower * 2;
3109 else if (port1 != udev->bus->otg_port || hdev->parent)
3110 delta = 100;
3111 else
3112 delta = 8;
3113 if (delta > hub->mA_per_port)
3114 dev_warn(&udev->dev,
3115 "%dmA is over %umA budget for port %d!\n",
3116 delta, hub->mA_per_port, port1);
3117 remaining -= delta;
3118 }
3119 if (remaining < 0) {
3120 dev_warn(hub->intfdev, "%dmA over power budget!\n",
3121 - remaining);
3122 remaining = 0;
3123 }
3124 return remaining;
3125}
3126
3127/* Handle physical or logical connection change events.
3128 * This routine is called when:
3129 * a port connection-change occurs;
3130 * a port enable-change occurs (often caused by EMI);
3131 * usb_reset_and_verify_device() encounters changed descriptors (as from
3132 * a firmware download)
3133 * caller already locked the hub
3134 */
3135static void hub_port_connect_change(struct usb_hub *hub, int port1,
3136 u16 portstatus, u16 portchange)
3137{
3138 struct usb_device *hdev = hub->hdev;
3139 struct device *hub_dev = hub->intfdev;
3140 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
3141 unsigned wHubCharacteristics =
3142 le16_to_cpu(hub->descriptor->wHubCharacteristics);
3143 struct usb_device *udev;
3144 int status, i;
3145
3146 dev_dbg (hub_dev,
3147 "port %d, status %04x, change %04x, %s\n",
3148 port1, portstatus, portchange, portspeed(hub, portstatus));
3149
3150 if (hub->has_indicators) {
3151 set_port_led(hub, port1, HUB_LED_AUTO);
3152 hub->indicator[port1-1] = INDICATOR_AUTO;
3153 }
3154
3155#ifdef CONFIG_USB_OTG
3156 /* during HNP, don't repeat the debounce */
3157 if (hdev->bus->is_b_host)
3158 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
3159 USB_PORT_STAT_C_ENABLE);
3160#endif
3161
3162 /* Try to resuscitate an existing device */
3163 udev = hdev->children[port1-1];
3164 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
3165 udev->state != USB_STATE_NOTATTACHED) {
3166 usb_lock_device(udev);
3167 if (portstatus & USB_PORT_STAT_ENABLE) {
3168 status = 0; /* Nothing to do */
3169
3170#ifdef CONFIG_USB_SUSPEND
3171 } else if (udev->state == USB_STATE_SUSPENDED &&
3172 udev->persist_enabled) {
3173 /* For a suspended device, treat this as a
3174 * remote wakeup event.
3175 */
3176 status = usb_remote_wakeup(udev);
3177#endif
3178
3179 } else {
3180 status = -ENODEV; /* Don't resuscitate */
3181 }
3182 usb_unlock_device(udev);
3183
3184 if (status == 0) {
3185 clear_bit(port1, hub->change_bits);
3186 return;
3187 }
3188 }
3189
3190 /* Disconnect any existing devices under this port */
3191 if (udev)
3192 usb_disconnect(&hdev->children[port1-1]);
3193 clear_bit(port1, hub->change_bits);
3194
3195 /* We can forget about a "removed" device when there's a physical
3196 * disconnect or the connect status changes.
3197 */
3198 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3199 (portchange & USB_PORT_STAT_C_CONNECTION))
3200 clear_bit(port1, hub->removed_bits);
3201
3202 if (portchange & (USB_PORT_STAT_C_CONNECTION |
3203 USB_PORT_STAT_C_ENABLE)) {
3204 status = hub_port_debounce(hub, port1);
3205 if (status < 0) {
3206 if (printk_ratelimit())
3207 dev_err(hub_dev, "connect-debounce failed, "
3208 "port %d disabled\n", port1);
3209 portstatus &= ~USB_PORT_STAT_CONNECTION;
3210 } else {
3211 portstatus = status;
3212 }
3213 }
3214
3215 /* Return now if debouncing failed or nothing is connected or
3216 * the device was "removed".
3217 */
3218 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
3219 test_bit(port1, hub->removed_bits)) {
3220
3221 /* maybe switch power back on (e.g. root hub was reset) */
3222 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
3223 && !port_is_power_on(hub, portstatus))
3224 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
3225
3226 if (portstatus & USB_PORT_STAT_ENABLE)
3227 goto done;
3228 return;
3229 }
3230
3231 for (i = 0; i < SET_CONFIG_TRIES; i++) {
3232
3233 /* reallocate for each attempt, since references
3234 * to the previous one can escape in various ways
3235 */
3236 udev = usb_alloc_dev(hdev, hdev->bus, port1);
3237 if (!udev) {
3238 dev_err (hub_dev,
3239 "couldn't allocate port %d usb_device\n",
3240 port1);
3241 goto done;
3242 }
3243
3244 usb_set_device_state(udev, USB_STATE_POWERED);
3245 udev->bus_mA = hub->mA_per_port;
3246 udev->level = hdev->level + 1;
3247 udev->wusb = hub_is_wusb(hub);
3248
3249 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
3250 if (hub_is_superspeed(hub->hdev))
3251 udev->speed = USB_SPEED_SUPER;
3252 else
3253 udev->speed = USB_SPEED_UNKNOWN;
3254
3255 choose_devnum(udev);
3256 if (udev->devnum <= 0) {
3257 status = -ENOTCONN; /* Don't retry */
3258 goto loop;
3259 }
3260
3261 /* reset (non-USB 3.0 devices) and get descriptor */
3262 status = hub_port_init(hub, udev, port1, i);
3263 if (status < 0)
3264 goto loop;
3265
3266 usb_detect_quirks(udev);
3267 if (udev->quirks & USB_QUIRK_DELAY_INIT)
3268 msleep(1000);
3269
3270 /* consecutive bus-powered hubs aren't reliable; they can
3271 * violate the voltage drop budget. if the new child has
3272 * a "powered" LED, users should notice we didn't enable it
3273 * (without reading syslog), even without per-port LEDs
3274 * on the parent.
3275 */
3276 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
3277 && udev->bus_mA <= 100) {
3278 u16 devstat;
3279
3280 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
3281 &devstat);
3282 if (status < 2) {
3283 dev_dbg(&udev->dev, "get status %d ?\n", status);
3284 goto loop_disable;
3285 }
3286 le16_to_cpus(&devstat);
3287 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
3288 dev_err(&udev->dev,
3289 "can't connect bus-powered hub "
3290 "to this port\n");
3291 if (hub->has_indicators) {
3292 hub->indicator[port1-1] =
3293 INDICATOR_AMBER_BLINK;
3294 schedule_delayed_work (&hub->leds, 0);
3295 }
3296 status = -ENOTCONN; /* Don't retry */
3297 goto loop_disable;
3298 }
3299 }
3300
3301 /* check for devices running slower than they could */
3302 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
3303 && udev->speed == USB_SPEED_FULL
3304 && highspeed_hubs != 0)
3305 check_highspeed (hub, udev, port1);
3306
3307 /* Store the parent's children[] pointer. At this point
3308 * udev becomes globally accessible, although presumably
3309 * no one will look at it until hdev is unlocked.
3310 */
3311 status = 0;
3312
3313 /* We mustn't add new devices if the parent hub has
3314 * been disconnected; we would race with the
3315 * recursively_mark_NOTATTACHED() routine.
3316 */
3317 spin_lock_irq(&device_state_lock);
3318 if (hdev->state == USB_STATE_NOTATTACHED)
3319 status = -ENOTCONN;
3320 else
3321 hdev->children[port1-1] = udev;
3322 spin_unlock_irq(&device_state_lock);
3323
3324 /* Run it through the hoops (find a driver, etc) */
3325 if (!status) {
3326 status = usb_new_device(udev);
3327 if (status) {
3328 spin_lock_irq(&device_state_lock);
3329 hdev->children[port1-1] = NULL;
3330 spin_unlock_irq(&device_state_lock);
3331 }
3332 }
3333
3334 if (status)
3335 goto loop_disable;
3336
3337 status = hub_power_remaining(hub);
3338 if (status)
3339 dev_dbg(hub_dev, "%dmA power budget left\n", status);
3340
3341 return;
3342
3343loop_disable:
3344 hub_port_disable(hub, port1, 1);
3345loop:
3346 usb_ep0_reinit(udev);
3347 release_devnum(udev);
3348 hub_free_dev(udev);
3349 usb_put_dev(udev);
3350 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
3351 break;
3352 }
3353 if (hub->hdev->parent ||
3354 !hcd->driver->port_handed_over ||
3355 !(hcd->driver->port_handed_over)(hcd, port1))
3356 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
3357 port1);
3358
3359done:
3360 hub_port_disable(hub, port1, 1);
3361 if (hcd->driver->relinquish_port && !hub->hdev->parent)
3362 hcd->driver->relinquish_port(hcd, port1);
3363}
3364
3365static void hub_events(void)
3366{
3367 struct list_head *tmp;
3368 struct usb_device *hdev;
3369 struct usb_interface *intf;
3370 struct usb_hub *hub;
3371 struct device *hub_dev;
3372 u16 hubstatus;
3373 u16 hubchange;
3374 u16 portstatus;
3375 u16 portchange;
3376 int i, ret;
3377 int connect_change;
3378
3379 /*
3380 * We restart the list every time to avoid a deadlock with
3381 * deleting hubs downstream from this one. This should be
3382 * safe since we delete the hub from the event list.
3383 * Not the most efficient, but avoids deadlocks.
3384 */
3385 while (1) {
3386
3387 /* Grab the first entry at the beginning of the list */
3388 spin_lock_irq(&hub_event_lock);
3389 if (list_empty(&hub_event_list)) {
3390 spin_unlock_irq(&hub_event_lock);
3391 break;
3392 }
3393
3394 tmp = hub_event_list.next;
3395 list_del_init(tmp);
3396
3397 hub = list_entry(tmp, struct usb_hub, event_list);
3398 kref_get(&hub->kref);
3399 spin_unlock_irq(&hub_event_lock);
3400
3401 hdev = hub->hdev;
3402 hub_dev = hub->intfdev;
3403 intf = to_usb_interface(hub_dev);
3404 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
3405 hdev->state, hub->descriptor
3406 ? hub->descriptor->bNbrPorts
3407 : 0,
3408 /* NOTE: expects max 15 ports... */
3409 (u16) hub->change_bits[0],
3410 (u16) hub->event_bits[0]);
3411
3412 /* Lock the device, then check to see if we were
3413 * disconnected while waiting for the lock to succeed. */
3414 usb_lock_device(hdev);
3415 if (unlikely(hub->disconnected))
3416 goto loop_disconnected;
3417
3418 /* If the hub has died, clean up after it */
3419 if (hdev->state == USB_STATE_NOTATTACHED) {
3420 hub->error = -ENODEV;
3421 hub_quiesce(hub, HUB_DISCONNECT);
3422 goto loop;
3423 }
3424
3425 /* Autoresume */
3426 ret = usb_autopm_get_interface(intf);
3427 if (ret) {
3428 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
3429 goto loop;
3430 }
3431
3432 /* If this is an inactive hub, do nothing */
3433 if (hub->quiescing)
3434 goto loop_autopm;
3435
3436 if (hub->error) {
3437 dev_dbg (hub_dev, "resetting for error %d\n",
3438 hub->error);
3439
3440 ret = usb_reset_device(hdev);
3441 if (ret) {
3442 dev_dbg (hub_dev,
3443 "error resetting hub: %d\n", ret);
3444 goto loop_autopm;
3445 }
3446
3447 hub->nerrors = 0;
3448 hub->error = 0;
3449 }
3450
3451 /* deal with port status changes */
3452 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
3453 if (test_bit(i, hub->busy_bits))
3454 continue;
3455 connect_change = test_bit(i, hub->change_bits);
3456 if (!test_and_clear_bit(i, hub->event_bits) &&
3457 !connect_change)
3458 continue;
3459
3460 ret = hub_port_status(hub, i,
3461 &portstatus, &portchange);
3462 if (ret < 0)
3463 continue;
3464
3465 if (portchange & USB_PORT_STAT_C_CONNECTION) {
3466 clear_port_feature(hdev, i,
3467 USB_PORT_FEAT_C_CONNECTION);
3468 connect_change = 1;
3469 }
3470
3471 if (portchange & USB_PORT_STAT_C_ENABLE) {
3472 if (!connect_change)
3473 dev_dbg (hub_dev,
3474 "port %d enable change, "
3475 "status %08x\n",
3476 i, portstatus);
3477 clear_port_feature(hdev, i,
3478 USB_PORT_FEAT_C_ENABLE);
3479
3480 /*
3481 * EM interference sometimes causes badly
3482 * shielded USB devices to be shutdown by
3483 * the hub, this hack enables them again.
3484 * Works at least with mouse driver.
3485 */
3486 if (!(portstatus & USB_PORT_STAT_ENABLE)
3487 && !connect_change
3488 && hdev->children[i-1]) {
3489 dev_err (hub_dev,
3490 "port %i "
3491 "disabled by hub (EMI?), "
3492 "re-enabling...\n",
3493 i);
3494 connect_change = 1;
3495 }
3496 }
3497
3498 if (portchange & USB_PORT_STAT_C_SUSPEND) {
3499 struct usb_device *udev;
3500
3501 clear_port_feature(hdev, i,
3502 USB_PORT_FEAT_C_SUSPEND);
3503 udev = hdev->children[i-1];
3504 if (udev) {
3505 /* TRSMRCY = 10 msec */
3506 msleep(10);
3507
3508 usb_lock_device(udev);
3509 ret = usb_remote_wakeup(hdev->
3510 children[i-1]);
3511 usb_unlock_device(udev);
3512 if (ret < 0)
3513 connect_change = 1;
3514 } else {
3515 ret = -ENODEV;
3516 hub_port_disable(hub, i, 1);
3517 }
3518 dev_dbg (hub_dev,
3519 "resume on port %d, status %d\n",
3520 i, ret);
3521 }
3522
3523 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
3524 u16 status = 0;
3525 u16 unused;
3526
3527 dev_dbg(hub_dev, "over-current change on port "
3528 "%d\n", i);
3529 clear_port_feature(hdev, i,
3530 USB_PORT_FEAT_C_OVER_CURRENT);
3531 msleep(100); /* Cool down */
3532 hub_power_on(hub, true);
3533 hub_port_status(hub, i, &status, &unused);
3534 if (status & USB_PORT_STAT_OVERCURRENT)
3535 dev_err(hub_dev, "over-current "
3536 "condition on port %d\n", i);
3537 }
3538
3539 if (portchange & USB_PORT_STAT_C_RESET) {
3540 dev_dbg (hub_dev,
3541 "reset change on port %d\n",
3542 i);
3543 clear_port_feature(hdev, i,
3544 USB_PORT_FEAT_C_RESET);
3545 }
3546 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
3547 hub_is_superspeed(hub->hdev)) {
3548 dev_dbg(hub_dev,
3549 "warm reset change on port %d\n",
3550 i);
3551 clear_port_feature(hdev, i,
3552 USB_PORT_FEAT_C_BH_PORT_RESET);
3553 }
3554 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
3555 clear_port_feature(hub->hdev, i,
3556 USB_PORT_FEAT_C_PORT_LINK_STATE);
3557 }
3558 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
3559 dev_warn(hub_dev,
3560 "config error on port %d\n",
3561 i);
3562 clear_port_feature(hub->hdev, i,
3563 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
3564 }
3565
3566 /* Warm reset a USB3 protocol port if it's in
3567 * SS.Inactive state.
3568 */
3569 if (hub_is_superspeed(hub->hdev) &&
3570 (portstatus & USB_PORT_STAT_LINK_STATE)
3571 == USB_SS_PORT_LS_SS_INACTIVE) {
3572 dev_dbg(hub_dev, "warm reset port %d\n", i);
3573 hub_port_warm_reset(hub, i);
3574 }
3575
3576 if (connect_change)
3577 hub_port_connect_change(hub, i,
3578 portstatus, portchange);
3579 } /* end for i */
3580
3581 /* deal with hub status changes */
3582 if (test_and_clear_bit(0, hub->event_bits) == 0)
3583 ; /* do nothing */
3584 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
3585 dev_err (hub_dev, "get_hub_status failed\n");
3586 else {
3587 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
3588 dev_dbg (hub_dev, "power change\n");
3589 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
3590 if (hubstatus & HUB_STATUS_LOCAL_POWER)
3591 /* FIXME: Is this always true? */
3592 hub->limited_power = 1;
3593 else
3594 hub->limited_power = 0;
3595 }
3596 if (hubchange & HUB_CHANGE_OVERCURRENT) {
3597 u16 status = 0;
3598 u16 unused;
3599
3600 dev_dbg(hub_dev, "over-current change\n");
3601 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
3602 msleep(500); /* Cool down */
3603 hub_power_on(hub, true);
3604 hub_hub_status(hub, &status, &unused);
3605 if (status & HUB_STATUS_OVERCURRENT)
3606 dev_err(hub_dev, "over-current "
3607 "condition\n");
3608 }
3609 }
3610
3611 loop_autopm:
3612 /* Balance the usb_autopm_get_interface() above */
3613 usb_autopm_put_interface_no_suspend(intf);
3614 loop:
3615 /* Balance the usb_autopm_get_interface_no_resume() in
3616 * kick_khubd() and allow autosuspend.
3617 */
3618 usb_autopm_put_interface(intf);
3619 loop_disconnected:
3620 usb_unlock_device(hdev);
3621 kref_put(&hub->kref, hub_release);
3622
3623 } /* end while (1) */
3624}
3625
3626static int hub_thread(void *__unused)
3627{
3628 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
3629 * port handover. Otherwise it might see that a full-speed device
3630 * was gone before the EHCI controller had handed its port over to
3631 * the companion full-speed controller.
3632 */
3633 set_freezable();
3634
3635 do {
3636 hub_events();
3637 wait_event_freezable(khubd_wait,
3638 !list_empty(&hub_event_list) ||
3639 kthread_should_stop());
3640 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
3641
3642 pr_debug("%s: khubd exiting\n", usbcore_name);
3643 return 0;
3644}
3645
3646static const struct usb_device_id hub_id_table[] = {
3647 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
3648 .bDeviceClass = USB_CLASS_HUB},
3649 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
3650 .bInterfaceClass = USB_CLASS_HUB},
3651 { } /* Terminating entry */
3652};
3653
3654MODULE_DEVICE_TABLE (usb, hub_id_table);
3655
3656static struct usb_driver hub_driver = {
3657 .name = "hub",
3658 .probe = hub_probe,
3659 .disconnect = hub_disconnect,
3660 .suspend = hub_suspend,
3661 .resume = hub_resume,
3662 .reset_resume = hub_reset_resume,
3663 .pre_reset = hub_pre_reset,
3664 .post_reset = hub_post_reset,
3665 .unlocked_ioctl = hub_ioctl,
3666 .id_table = hub_id_table,
3667 .supports_autosuspend = 1,
3668};
3669
3670int usb_hub_init(void)
3671{
3672 if (usb_register(&hub_driver) < 0) {
3673 printk(KERN_ERR "%s: can't register hub driver\n",
3674 usbcore_name);
3675 return -1;
3676 }
3677
3678 khubd_task = kthread_run(hub_thread, NULL, "khubd");
3679 if (!IS_ERR(khubd_task))
3680 return 0;
3681
3682 /* Fall through if kernel_thread failed */
3683 usb_deregister(&hub_driver);
3684 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
3685
3686 return -1;
3687}
3688
3689void usb_hub_cleanup(void)
3690{
3691 kthread_stop(khubd_task);
3692
3693 /*
3694 * Hub resources are freed for us by usb_deregister. It calls
3695 * usb_driver_purge on every device which in turn calls that
3696 * devices disconnect function if it is using this driver.
3697 * The hub_disconnect function takes care of releasing the
3698 * individual hub resources. -greg
3699 */
3700 usb_deregister(&hub_driver);
3701} /* usb_hub_cleanup() */
3702
3703static int descriptors_changed(struct usb_device *udev,
3704 struct usb_device_descriptor *old_device_descriptor)
3705{
3706 int changed = 0;
3707 unsigned index;
3708 unsigned serial_len = 0;
3709 unsigned len;
3710 unsigned old_length;
3711 int length;
3712 char *buf;
3713
3714 if (memcmp(&udev->descriptor, old_device_descriptor,
3715 sizeof(*old_device_descriptor)) != 0)
3716 return 1;
3717
3718 /* Since the idVendor, idProduct, and bcdDevice values in the
3719 * device descriptor haven't changed, we will assume the
3720 * Manufacturer and Product strings haven't changed either.
3721 * But the SerialNumber string could be different (e.g., a
3722 * different flash card of the same brand).
3723 */
3724 if (udev->serial)
3725 serial_len = strlen(udev->serial) + 1;
3726
3727 len = serial_len;
3728 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3729 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3730 len = max(len, old_length);
3731 }
3732
3733 buf = kmalloc(len, GFP_NOIO);
3734 if (buf == NULL) {
3735 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
3736 /* assume the worst */
3737 return 1;
3738 }
3739 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
3740 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
3741 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
3742 old_length);
3743 if (length != old_length) {
3744 dev_dbg(&udev->dev, "config index %d, error %d\n",
3745 index, length);
3746 changed = 1;
3747 break;
3748 }
3749 if (memcmp (buf, udev->rawdescriptors[index], old_length)
3750 != 0) {
3751 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
3752 index,
3753 ((struct usb_config_descriptor *) buf)->
3754 bConfigurationValue);
3755 changed = 1;
3756 break;
3757 }
3758 }
3759
3760 if (!changed && serial_len) {
3761 length = usb_string(udev, udev->descriptor.iSerialNumber,
3762 buf, serial_len);
3763 if (length + 1 != serial_len) {
3764 dev_dbg(&udev->dev, "serial string error %d\n",
3765 length);
3766 changed = 1;
3767 } else if (memcmp(buf, udev->serial, length) != 0) {
3768 dev_dbg(&udev->dev, "serial string changed\n");
3769 changed = 1;
3770 }
3771 }
3772
3773 kfree(buf);
3774 return changed;
3775}
3776
3777/**
3778 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
3779 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3780 *
3781 * WARNING - don't use this routine to reset a composite device
3782 * (one with multiple interfaces owned by separate drivers)!
3783 * Use usb_reset_device() instead.
3784 *
3785 * Do a port reset, reassign the device's address, and establish its
3786 * former operating configuration. If the reset fails, or the device's
3787 * descriptors change from their values before the reset, or the original
3788 * configuration and altsettings cannot be restored, a flag will be set
3789 * telling khubd to pretend the device has been disconnected and then
3790 * re-connected. All drivers will be unbound, and the device will be
3791 * re-enumerated and probed all over again.
3792 *
3793 * Returns 0 if the reset succeeded, -ENODEV if the device has been
3794 * flagged for logical disconnection, or some other negative error code
3795 * if the reset wasn't even attempted.
3796 *
3797 * The caller must own the device lock. For example, it's safe to use
3798 * this from a driver probe() routine after downloading new firmware.
3799 * For calls that might not occur during probe(), drivers should lock
3800 * the device using usb_lock_device_for_reset().
3801 *
3802 * Locking exception: This routine may also be called from within an
3803 * autoresume handler. Such usage won't conflict with other tasks
3804 * holding the device lock because these tasks should always call
3805 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
3806 */
3807static int usb_reset_and_verify_device(struct usb_device *udev)
3808{
3809 struct usb_device *parent_hdev = udev->parent;
3810 struct usb_hub *parent_hub;
3811 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3812 struct usb_device_descriptor descriptor = udev->descriptor;
3813 int i, ret = 0;
3814 int port1 = udev->portnum;
3815
3816 if (udev->state == USB_STATE_NOTATTACHED ||
3817 udev->state == USB_STATE_SUSPENDED) {
3818 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3819 udev->state);
3820 return -EINVAL;
3821 }
3822
3823 if (!parent_hdev) {
3824 /* this requires hcd-specific logic; see ohci_restart() */
3825 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
3826 return -EISDIR;
3827 }
3828 parent_hub = hdev_to_hub(parent_hdev);
3829
3830 set_bit(port1, parent_hub->busy_bits);
3831 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
3832
3833 /* ep0 maxpacket size may change; let the HCD know about it.
3834 * Other endpoints will be handled by re-enumeration. */
3835 usb_ep0_reinit(udev);
3836 ret = hub_port_init(parent_hub, udev, port1, i);
3837 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
3838 break;
3839 }
3840 clear_bit(port1, parent_hub->busy_bits);
3841
3842 if (ret < 0)
3843 goto re_enumerate;
3844
3845 /* Device might have changed firmware (DFU or similar) */
3846 if (descriptors_changed(udev, &descriptor)) {
3847 dev_info(&udev->dev, "device firmware changed\n");
3848 udev->descriptor = descriptor; /* for disconnect() calls */
3849 goto re_enumerate;
3850 }
3851
3852 /* Restore the device's previous configuration */
3853 if (!udev->actconfig)
3854 goto done;
3855
3856 mutex_lock(hcd->bandwidth_mutex);
3857 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
3858 if (ret < 0) {
3859 dev_warn(&udev->dev,
3860 "Busted HC? Not enough HCD resources for "
3861 "old configuration.\n");
3862 mutex_unlock(hcd->bandwidth_mutex);
3863 goto re_enumerate;
3864 }
3865 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3866 USB_REQ_SET_CONFIGURATION, 0,
3867 udev->actconfig->desc.bConfigurationValue, 0,
3868 NULL, 0, USB_CTRL_SET_TIMEOUT);
3869 if (ret < 0) {
3870 dev_err(&udev->dev,
3871 "can't restore configuration #%d (error=%d)\n",
3872 udev->actconfig->desc.bConfigurationValue, ret);
3873 mutex_unlock(hcd->bandwidth_mutex);
3874 goto re_enumerate;
3875 }
3876 mutex_unlock(hcd->bandwidth_mutex);
3877 usb_set_device_state(udev, USB_STATE_CONFIGURED);
3878
3879 /* Put interfaces back into the same altsettings as before.
3880 * Don't bother to send the Set-Interface request for interfaces
3881 * that were already in altsetting 0; besides being unnecessary,
3882 * many devices can't handle it. Instead just reset the host-side
3883 * endpoint state.
3884 */
3885 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
3886 struct usb_host_config *config = udev->actconfig;
3887 struct usb_interface *intf = config->interface[i];
3888 struct usb_interface_descriptor *desc;
3889
3890 desc = &intf->cur_altsetting->desc;
3891 if (desc->bAlternateSetting == 0) {
3892 usb_disable_interface(udev, intf, true);
3893 usb_enable_interface(udev, intf, true);
3894 ret = 0;
3895 } else {
3896 /* Let the bandwidth allocation function know that this
3897 * device has been reset, and it will have to use
3898 * alternate setting 0 as the current alternate setting.
3899 */
3900 intf->resetting_device = 1;
3901 ret = usb_set_interface(udev, desc->bInterfaceNumber,
3902 desc->bAlternateSetting);
3903 intf->resetting_device = 0;
3904 }
3905 if (ret < 0) {
3906 dev_err(&udev->dev, "failed to restore interface %d "
3907 "altsetting %d (error=%d)\n",
3908 desc->bInterfaceNumber,
3909 desc->bAlternateSetting,
3910 ret);
3911 goto re_enumerate;
3912 }
3913 }
3914
3915done:
3916 return 0;
3917
3918re_enumerate:
3919 hub_port_logical_disconnect(parent_hub, port1);
3920 return -ENODEV;
3921}
3922
3923/**
3924 * usb_reset_device - warn interface drivers and perform a USB port reset
3925 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
3926 *
3927 * Warns all drivers bound to registered interfaces (using their pre_reset
3928 * method), performs the port reset, and then lets the drivers know that
3929 * the reset is over (using their post_reset method).
3930 *
3931 * Return value is the same as for usb_reset_and_verify_device().
3932 *
3933 * The caller must own the device lock. For example, it's safe to use
3934 * this from a driver probe() routine after downloading new firmware.
3935 * For calls that might not occur during probe(), drivers should lock
3936 * the device using usb_lock_device_for_reset().
3937 *
3938 * If an interface is currently being probed or disconnected, we assume
3939 * its driver knows how to handle resets. For all other interfaces,
3940 * if the driver doesn't have pre_reset and post_reset methods then
3941 * we attempt to unbind it and rebind afterward.
3942 */
3943int usb_reset_device(struct usb_device *udev)
3944{
3945 int ret;
3946 int i;
3947 struct usb_host_config *config = udev->actconfig;
3948
3949 if (udev->state == USB_STATE_NOTATTACHED ||
3950 udev->state == USB_STATE_SUSPENDED) {
3951 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
3952 udev->state);
3953 return -EINVAL;
3954 }
3955
3956 /* Prevent autosuspend during the reset */
3957 usb_autoresume_device(udev);
3958
3959 if (config) {
3960 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
3961 struct usb_interface *cintf = config->interface[i];
3962 struct usb_driver *drv;
3963 int unbind = 0;
3964
3965 if (cintf->dev.driver) {
3966 drv = to_usb_driver(cintf->dev.driver);
3967 if (drv->pre_reset && drv->post_reset)
3968 unbind = (drv->pre_reset)(cintf);
3969 else if (cintf->condition ==
3970 USB_INTERFACE_BOUND)
3971 unbind = 1;
3972 if (unbind)
3973 usb_forced_unbind_intf(cintf);
3974 }
3975 }
3976 }
3977
3978 ret = usb_reset_and_verify_device(udev);
3979
3980 if (config) {
3981 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
3982 struct usb_interface *cintf = config->interface[i];
3983 struct usb_driver *drv;
3984 int rebind = cintf->needs_binding;
3985
3986 if (!rebind && cintf->dev.driver) {
3987 drv = to_usb_driver(cintf->dev.driver);
3988 if (drv->post_reset)
3989 rebind = (drv->post_reset)(cintf);
3990 else if (cintf->condition ==
3991 USB_INTERFACE_BOUND)
3992 rebind = 1;
3993 }
3994 if (ret == 0 && rebind)
3995 usb_rebind_intf(cintf);
3996 }
3997 }
3998
3999 usb_autosuspend_device(udev);
4000 return ret;
4001}
4002EXPORT_SYMBOL_GPL(usb_reset_device);
4003
4004
4005/**
4006 * usb_queue_reset_device - Reset a USB device from an atomic context
4007 * @iface: USB interface belonging to the device to reset
4008 *
4009 * This function can be used to reset a USB device from an atomic
4010 * context, where usb_reset_device() won't work (as it blocks).
4011 *
4012 * Doing a reset via this method is functionally equivalent to calling
4013 * usb_reset_device(), except for the fact that it is delayed to a
4014 * workqueue. This means that any drivers bound to other interfaces
4015 * might be unbound, as well as users from usbfs in user space.
4016 *
4017 * Corner cases:
4018 *
4019 * - Scheduling two resets at the same time from two different drivers
4020 * attached to two different interfaces of the same device is
4021 * possible; depending on how the driver attached to each interface
4022 * handles ->pre_reset(), the second reset might happen or not.
4023 *
4024 * - If a driver is unbound and it had a pending reset, the reset will
4025 * be cancelled.
4026 *
4027 * - This function can be called during .probe() or .disconnect()
4028 * times. On return from .disconnect(), any pending resets will be
4029 * cancelled.
4030 *
4031 * There is no no need to lock/unlock the @reset_ws as schedule_work()
4032 * does its own.
4033 *
4034 * NOTE: We don't do any reference count tracking because it is not
4035 * needed. The lifecycle of the work_struct is tied to the
4036 * usb_interface. Before destroying the interface we cancel the
4037 * work_struct, so the fact that work_struct is queued and or
4038 * running means the interface (and thus, the device) exist and
4039 * are referenced.
4040 */
4041void usb_queue_reset_device(struct usb_interface *iface)
4042{
4043 schedule_work(&iface->reset_ws);
4044}
4045EXPORT_SYMBOL_GPL(usb_queue_reset_device);
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * USB hub driver.
4 *
5 * (C) Copyright 1999 Linus Torvalds
6 * (C) Copyright 1999 Johannes Erdfelt
7 * (C) Copyright 1999 Gregory P. Smith
8 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
9 *
10 * Released under the GPLv2 only.
11 */
12
13#include <linux/kernel.h>
14#include <linux/errno.h>
15#include <linux/module.h>
16#include <linux/moduleparam.h>
17#include <linux/completion.h>
18#include <linux/sched/mm.h>
19#include <linux/list.h>
20#include <linux/slab.h>
21#include <linux/kcov.h>
22#include <linux/ioctl.h>
23#include <linux/usb.h>
24#include <linux/usbdevice_fs.h>
25#include <linux/usb/hcd.h>
26#include <linux/usb/otg.h>
27#include <linux/usb/quirks.h>
28#include <linux/workqueue.h>
29#include <linux/mutex.h>
30#include <linux/random.h>
31#include <linux/pm_qos.h>
32#include <linux/kobject.h>
33
34#include <linux/bitfield.h>
35#include <linux/uaccess.h>
36#include <asm/byteorder.h>
37
38#include "hub.h"
39#include "otg_productlist.h"
40
41#define USB_VENDOR_GENESYS_LOGIC 0x05e3
42#define USB_VENDOR_SMSC 0x0424
43#define USB_PRODUCT_USB5534B 0x5534
44#define USB_VENDOR_CYPRESS 0x04b4
45#define USB_PRODUCT_CY7C65632 0x6570
46#define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
47#define HUB_QUIRK_DISABLE_AUTOSUSPEND 0x02
48
49#define USB_TP_TRANSMISSION_DELAY 40 /* ns */
50#define USB_TP_TRANSMISSION_DELAY_MAX 65535 /* ns */
51#define USB_PING_RESPONSE_TIME 400 /* ns */
52
53/* Protect struct usb_device->state and ->children members
54 * Note: Both are also protected by ->dev.sem, except that ->state can
55 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
56static DEFINE_SPINLOCK(device_state_lock);
57
58/* workqueue to process hub events */
59static struct workqueue_struct *hub_wq;
60static void hub_event(struct work_struct *work);
61
62/* synchronize hub-port add/remove and peering operations */
63DEFINE_MUTEX(usb_port_peer_mutex);
64
65/* cycle leds on hubs that aren't blinking for attention */
66static bool blinkenlights;
67module_param(blinkenlights, bool, S_IRUGO);
68MODULE_PARM_DESC(blinkenlights, "true to cycle leds on hubs");
69
70/*
71 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
72 * 10 seconds to send reply for the initial 64-byte descriptor request.
73 */
74/* define initial 64-byte descriptor request timeout in milliseconds */
75static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
76module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
77MODULE_PARM_DESC(initial_descriptor_timeout,
78 "initial 64-byte descriptor request timeout in milliseconds "
79 "(default 5000 - 5.0 seconds)");
80
81/*
82 * As of 2.6.10 we introduce a new USB device initialization scheme which
83 * closely resembles the way Windows works. Hopefully it will be compatible
84 * with a wider range of devices than the old scheme. However some previously
85 * working devices may start giving rise to "device not accepting address"
86 * errors; if that happens the user can try the old scheme by adjusting the
87 * following module parameters.
88 *
89 * For maximum flexibility there are two boolean parameters to control the
90 * hub driver's behavior. On the first initialization attempt, if the
91 * "old_scheme_first" parameter is set then the old scheme will be used,
92 * otherwise the new scheme is used. If that fails and "use_both_schemes"
93 * is set, then the driver will make another attempt, using the other scheme.
94 */
95static bool old_scheme_first;
96module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
97MODULE_PARM_DESC(old_scheme_first,
98 "start with the old device initialization scheme");
99
100static bool use_both_schemes = true;
101module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
102MODULE_PARM_DESC(use_both_schemes,
103 "try the other device initialization scheme if the "
104 "first one fails");
105
106/* Mutual exclusion for EHCI CF initialization. This interferes with
107 * port reset on some companion controllers.
108 */
109DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
110EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
111
112#define HUB_DEBOUNCE_TIMEOUT 2000
113#define HUB_DEBOUNCE_STEP 25
114#define HUB_DEBOUNCE_STABLE 100
115
116static void hub_release(struct kref *kref);
117static int usb_reset_and_verify_device(struct usb_device *udev);
118static int hub_port_disable(struct usb_hub *hub, int port1, int set_state);
119static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
120 u16 portstatus);
121
122static inline char *portspeed(struct usb_hub *hub, int portstatus)
123{
124 if (hub_is_superspeedplus(hub->hdev))
125 return "10.0 Gb/s";
126 if (hub_is_superspeed(hub->hdev))
127 return "5.0 Gb/s";
128 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
129 return "480 Mb/s";
130 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
131 return "1.5 Mb/s";
132 else
133 return "12 Mb/s";
134}
135
136/* Note that hdev or one of its children must be locked! */
137struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev)
138{
139 if (!hdev || !hdev->actconfig || !hdev->maxchild)
140 return NULL;
141 return usb_get_intfdata(hdev->actconfig->interface[0]);
142}
143
144int usb_device_supports_lpm(struct usb_device *udev)
145{
146 /* Some devices have trouble with LPM */
147 if (udev->quirks & USB_QUIRK_NO_LPM)
148 return 0;
149
150 /* USB 2.1 (and greater) devices indicate LPM support through
151 * their USB 2.0 Extended Capabilities BOS descriptor.
152 */
153 if (udev->speed == USB_SPEED_HIGH || udev->speed == USB_SPEED_FULL) {
154 if (udev->bos->ext_cap &&
155 (USB_LPM_SUPPORT &
156 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
157 return 1;
158 return 0;
159 }
160
161 /*
162 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
163 * However, there are some that don't, and they set the U1/U2 exit
164 * latencies to zero.
165 */
166 if (!udev->bos->ss_cap) {
167 dev_info(&udev->dev, "No LPM exit latency info found, disabling LPM.\n");
168 return 0;
169 }
170
171 if (udev->bos->ss_cap->bU1devExitLat == 0 &&
172 udev->bos->ss_cap->bU2DevExitLat == 0) {
173 if (udev->parent)
174 dev_info(&udev->dev, "LPM exit latency is zeroed, disabling LPM.\n");
175 else
176 dev_info(&udev->dev, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
177 return 0;
178 }
179
180 if (!udev->parent || udev->parent->lpm_capable)
181 return 1;
182 return 0;
183}
184
185/*
186 * Set the Maximum Exit Latency (MEL) for the host to wakup up the path from
187 * U1/U2, send a PING to the device and receive a PING_RESPONSE.
188 * See USB 3.1 section C.1.5.2
189 */
190static void usb_set_lpm_mel(struct usb_device *udev,
191 struct usb3_lpm_parameters *udev_lpm_params,
192 unsigned int udev_exit_latency,
193 struct usb_hub *hub,
194 struct usb3_lpm_parameters *hub_lpm_params,
195 unsigned int hub_exit_latency)
196{
197 unsigned int total_mel;
198
199 /*
200 * tMEL1. time to transition path from host to device into U0.
201 * MEL for parent already contains the delay up to parent, so only add
202 * the exit latency for the last link (pick the slower exit latency),
203 * and the hub header decode latency. See USB 3.1 section C 2.2.1
204 * Store MEL in nanoseconds
205 */
206 total_mel = hub_lpm_params->mel +
207 max(udev_exit_latency, hub_exit_latency) * 1000 +
208 hub->descriptor->u.ss.bHubHdrDecLat * 100;
209
210 /*
211 * tMEL2. Time to submit PING packet. Sum of tTPTransmissionDelay for
212 * each link + wHubDelay for each hub. Add only for last link.
213 * tMEL4, the time for PING_RESPONSE to traverse upstream is similar.
214 * Multiply by 2 to include it as well.
215 */
216 total_mel += (__le16_to_cpu(hub->descriptor->u.ss.wHubDelay) +
217 USB_TP_TRANSMISSION_DELAY) * 2;
218
219 /*
220 * tMEL3, tPingResponse. Time taken by device to generate PING_RESPONSE
221 * after receiving PING. Also add 2100ns as stated in USB 3.1 C 1.5.2.4
222 * to cover the delay if the PING_RESPONSE is queued behind a Max Packet
223 * Size DP.
224 * Note these delays should be added only once for the entire path, so
225 * add them to the MEL of the device connected to the roothub.
226 */
227 if (!hub->hdev->parent)
228 total_mel += USB_PING_RESPONSE_TIME + 2100;
229
230 udev_lpm_params->mel = total_mel;
231}
232
233/*
234 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
235 * a transition from either U1 or U2.
236 */
237static void usb_set_lpm_pel(struct usb_device *udev,
238 struct usb3_lpm_parameters *udev_lpm_params,
239 unsigned int udev_exit_latency,
240 struct usb_hub *hub,
241 struct usb3_lpm_parameters *hub_lpm_params,
242 unsigned int hub_exit_latency,
243 unsigned int port_to_port_exit_latency)
244{
245 unsigned int first_link_pel;
246 unsigned int hub_pel;
247
248 /*
249 * First, the device sends an LFPS to transition the link between the
250 * device and the parent hub into U0. The exit latency is the bigger of
251 * the device exit latency or the hub exit latency.
252 */
253 if (udev_exit_latency > hub_exit_latency)
254 first_link_pel = udev_exit_latency * 1000;
255 else
256 first_link_pel = hub_exit_latency * 1000;
257
258 /*
259 * When the hub starts to receive the LFPS, there is a slight delay for
260 * it to figure out that one of the ports is sending an LFPS. Then it
261 * will forward the LFPS to its upstream link. The exit latency is the
262 * delay, plus the PEL that we calculated for this hub.
263 */
264 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
265
266 /*
267 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
268 * is the greater of the two exit latencies.
269 */
270 if (first_link_pel > hub_pel)
271 udev_lpm_params->pel = first_link_pel;
272 else
273 udev_lpm_params->pel = hub_pel;
274}
275
276/*
277 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
278 * when a device initiates a transition to U0, until when it will receive the
279 * first packet from the host controller.
280 *
281 * Section C.1.5.1 describes the four components to this:
282 * - t1: device PEL
283 * - t2: time for the ERDY to make it from the device to the host.
284 * - t3: a host-specific delay to process the ERDY.
285 * - t4: time for the packet to make it from the host to the device.
286 *
287 * t3 is specific to both the xHCI host and the platform the host is integrated
288 * into. The Intel HW folks have said it's negligible, FIXME if a different
289 * vendor says otherwise.
290 */
291static void usb_set_lpm_sel(struct usb_device *udev,
292 struct usb3_lpm_parameters *udev_lpm_params)
293{
294 struct usb_device *parent;
295 unsigned int num_hubs;
296 unsigned int total_sel;
297
298 /* t1 = device PEL */
299 total_sel = udev_lpm_params->pel;
300 /* How many external hubs are in between the device & the root port. */
301 for (parent = udev->parent, num_hubs = 0; parent->parent;
302 parent = parent->parent)
303 num_hubs++;
304 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
305 if (num_hubs > 0)
306 total_sel += 2100 + 250 * (num_hubs - 1);
307
308 /* t4 = 250ns * num_hubs */
309 total_sel += 250 * num_hubs;
310
311 udev_lpm_params->sel = total_sel;
312}
313
314static void usb_set_lpm_parameters(struct usb_device *udev)
315{
316 struct usb_hub *hub;
317 unsigned int port_to_port_delay;
318 unsigned int udev_u1_del;
319 unsigned int udev_u2_del;
320 unsigned int hub_u1_del;
321 unsigned int hub_u2_del;
322
323 if (!udev->lpm_capable || udev->speed < USB_SPEED_SUPER)
324 return;
325
326 hub = usb_hub_to_struct_hub(udev->parent);
327 /* It doesn't take time to transition the roothub into U0, since it
328 * doesn't have an upstream link.
329 */
330 if (!hub)
331 return;
332
333 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
334 udev_u2_del = le16_to_cpu(udev->bos->ss_cap->bU2DevExitLat);
335 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
336 hub_u2_del = le16_to_cpu(udev->parent->bos->ss_cap->bU2DevExitLat);
337
338 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
339 hub, &udev->parent->u1_params, hub_u1_del);
340
341 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
342 hub, &udev->parent->u2_params, hub_u2_del);
343
344 /*
345 * Appendix C, section C.2.2.2, says that there is a slight delay from
346 * when the parent hub notices the downstream port is trying to
347 * transition to U0 to when the hub initiates a U0 transition on its
348 * upstream port. The section says the delays are tPort2PortU1EL and
349 * tPort2PortU2EL, but it doesn't define what they are.
350 *
351 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
352 * about the same delays. Use the maximum delay calculations from those
353 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
354 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
355 * assume the device exit latencies they are talking about are the hub
356 * exit latencies.
357 *
358 * What do we do if the U2 exit latency is less than the U1 exit
359 * latency? It's possible, although not likely...
360 */
361 port_to_port_delay = 1;
362
363 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
364 hub, &udev->parent->u1_params, hub_u1_del,
365 port_to_port_delay);
366
367 if (hub_u2_del > hub_u1_del)
368 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
369 else
370 port_to_port_delay = 1 + hub_u1_del;
371
372 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
373 hub, &udev->parent->u2_params, hub_u2_del,
374 port_to_port_delay);
375
376 /* Now that we've got PEL, calculate SEL. */
377 usb_set_lpm_sel(udev, &udev->u1_params);
378 usb_set_lpm_sel(udev, &udev->u2_params);
379}
380
381/* USB 2.0 spec Section 11.24.4.5 */
382static int get_hub_descriptor(struct usb_device *hdev,
383 struct usb_hub_descriptor *desc)
384{
385 int i, ret, size;
386 unsigned dtype;
387
388 if (hub_is_superspeed(hdev)) {
389 dtype = USB_DT_SS_HUB;
390 size = USB_DT_SS_HUB_SIZE;
391 } else {
392 dtype = USB_DT_HUB;
393 size = sizeof(struct usb_hub_descriptor);
394 }
395
396 for (i = 0; i < 3; i++) {
397 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
398 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
399 dtype << 8, 0, desc, size,
400 USB_CTRL_GET_TIMEOUT);
401 if (hub_is_superspeed(hdev)) {
402 if (ret == size)
403 return ret;
404 } else if (ret >= USB_DT_HUB_NONVAR_SIZE + 2) {
405 /* Make sure we have the DeviceRemovable field. */
406 size = USB_DT_HUB_NONVAR_SIZE + desc->bNbrPorts / 8 + 1;
407 if (ret < size)
408 return -EMSGSIZE;
409 return ret;
410 }
411 }
412 return -EINVAL;
413}
414
415/*
416 * USB 2.0 spec Section 11.24.2.1
417 */
418static int clear_hub_feature(struct usb_device *hdev, int feature)
419{
420 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
421 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
422}
423
424/*
425 * USB 2.0 spec Section 11.24.2.2
426 */
427int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature)
428{
429 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
430 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
431 NULL, 0, 1000);
432}
433
434/*
435 * USB 2.0 spec Section 11.24.2.13
436 */
437static int set_port_feature(struct usb_device *hdev, int port1, int feature)
438{
439 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
440 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
441 NULL, 0, 1000);
442}
443
444static char *to_led_name(int selector)
445{
446 switch (selector) {
447 case HUB_LED_AMBER:
448 return "amber";
449 case HUB_LED_GREEN:
450 return "green";
451 case HUB_LED_OFF:
452 return "off";
453 case HUB_LED_AUTO:
454 return "auto";
455 default:
456 return "??";
457 }
458}
459
460/*
461 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
462 * for info about using port indicators
463 */
464static void set_port_led(struct usb_hub *hub, int port1, int selector)
465{
466 struct usb_port *port_dev = hub->ports[port1 - 1];
467 int status;
468
469 status = set_port_feature(hub->hdev, (selector << 8) | port1,
470 USB_PORT_FEAT_INDICATOR);
471 dev_dbg(&port_dev->dev, "indicator %s status %d\n",
472 to_led_name(selector), status);
473}
474
475#define LED_CYCLE_PERIOD ((2*HZ)/3)
476
477static void led_work(struct work_struct *work)
478{
479 struct usb_hub *hub =
480 container_of(work, struct usb_hub, leds.work);
481 struct usb_device *hdev = hub->hdev;
482 unsigned i;
483 unsigned changed = 0;
484 int cursor = -1;
485
486 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
487 return;
488
489 for (i = 0; i < hdev->maxchild; i++) {
490 unsigned selector, mode;
491
492 /* 30%-50% duty cycle */
493
494 switch (hub->indicator[i]) {
495 /* cycle marker */
496 case INDICATOR_CYCLE:
497 cursor = i;
498 selector = HUB_LED_AUTO;
499 mode = INDICATOR_AUTO;
500 break;
501 /* blinking green = sw attention */
502 case INDICATOR_GREEN_BLINK:
503 selector = HUB_LED_GREEN;
504 mode = INDICATOR_GREEN_BLINK_OFF;
505 break;
506 case INDICATOR_GREEN_BLINK_OFF:
507 selector = HUB_LED_OFF;
508 mode = INDICATOR_GREEN_BLINK;
509 break;
510 /* blinking amber = hw attention */
511 case INDICATOR_AMBER_BLINK:
512 selector = HUB_LED_AMBER;
513 mode = INDICATOR_AMBER_BLINK_OFF;
514 break;
515 case INDICATOR_AMBER_BLINK_OFF:
516 selector = HUB_LED_OFF;
517 mode = INDICATOR_AMBER_BLINK;
518 break;
519 /* blink green/amber = reserved */
520 case INDICATOR_ALT_BLINK:
521 selector = HUB_LED_GREEN;
522 mode = INDICATOR_ALT_BLINK_OFF;
523 break;
524 case INDICATOR_ALT_BLINK_OFF:
525 selector = HUB_LED_AMBER;
526 mode = INDICATOR_ALT_BLINK;
527 break;
528 default:
529 continue;
530 }
531 if (selector != HUB_LED_AUTO)
532 changed = 1;
533 set_port_led(hub, i + 1, selector);
534 hub->indicator[i] = mode;
535 }
536 if (!changed && blinkenlights) {
537 cursor++;
538 cursor %= hdev->maxchild;
539 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
540 hub->indicator[cursor] = INDICATOR_CYCLE;
541 changed++;
542 }
543 if (changed)
544 queue_delayed_work(system_power_efficient_wq,
545 &hub->leds, LED_CYCLE_PERIOD);
546}
547
548/* use a short timeout for hub/port status fetches */
549#define USB_STS_TIMEOUT 1000
550#define USB_STS_RETRIES 5
551
552/*
553 * USB 2.0 spec Section 11.24.2.6
554 */
555static int get_hub_status(struct usb_device *hdev,
556 struct usb_hub_status *data)
557{
558 int i, status = -ETIMEDOUT;
559
560 for (i = 0; i < USB_STS_RETRIES &&
561 (status == -ETIMEDOUT || status == -EPIPE); i++) {
562 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
563 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
564 data, sizeof(*data), USB_STS_TIMEOUT);
565 }
566 return status;
567}
568
569/*
570 * USB 2.0 spec Section 11.24.2.7
571 * USB 3.1 takes into use the wValue and wLength fields, spec Section 10.16.2.6
572 */
573static int get_port_status(struct usb_device *hdev, int port1,
574 void *data, u16 value, u16 length)
575{
576 int i, status = -ETIMEDOUT;
577
578 for (i = 0; i < USB_STS_RETRIES &&
579 (status == -ETIMEDOUT || status == -EPIPE); i++) {
580 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
581 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, value,
582 port1, data, length, USB_STS_TIMEOUT);
583 }
584 return status;
585}
586
587static int hub_ext_port_status(struct usb_hub *hub, int port1, int type,
588 u16 *status, u16 *change, u32 *ext_status)
589{
590 int ret;
591 int len = 4;
592
593 if (type != HUB_PORT_STATUS)
594 len = 8;
595
596 mutex_lock(&hub->status_mutex);
597 ret = get_port_status(hub->hdev, port1, &hub->status->port, type, len);
598 if (ret < len) {
599 if (ret != -ENODEV)
600 dev_err(hub->intfdev,
601 "%s failed (err = %d)\n", __func__, ret);
602 if (ret >= 0)
603 ret = -EIO;
604 } else {
605 *status = le16_to_cpu(hub->status->port.wPortStatus);
606 *change = le16_to_cpu(hub->status->port.wPortChange);
607 if (type != HUB_PORT_STATUS && ext_status)
608 *ext_status = le32_to_cpu(
609 hub->status->port.dwExtPortStatus);
610 ret = 0;
611 }
612 mutex_unlock(&hub->status_mutex);
613 return ret;
614}
615
616static int hub_port_status(struct usb_hub *hub, int port1,
617 u16 *status, u16 *change)
618{
619 return hub_ext_port_status(hub, port1, HUB_PORT_STATUS,
620 status, change, NULL);
621}
622
623static void hub_resubmit_irq_urb(struct usb_hub *hub)
624{
625 unsigned long flags;
626 int status;
627
628 spin_lock_irqsave(&hub->irq_urb_lock, flags);
629
630 if (hub->quiescing) {
631 spin_unlock_irqrestore(&hub->irq_urb_lock, flags);
632 return;
633 }
634
635 status = usb_submit_urb(hub->urb, GFP_ATOMIC);
636 if (status && status != -ENODEV && status != -EPERM &&
637 status != -ESHUTDOWN) {
638 dev_err(hub->intfdev, "resubmit --> %d\n", status);
639 mod_timer(&hub->irq_urb_retry, jiffies + HZ);
640 }
641
642 spin_unlock_irqrestore(&hub->irq_urb_lock, flags);
643}
644
645static void hub_retry_irq_urb(struct timer_list *t)
646{
647 struct usb_hub *hub = from_timer(hub, t, irq_urb_retry);
648
649 hub_resubmit_irq_urb(hub);
650}
651
652
653static void kick_hub_wq(struct usb_hub *hub)
654{
655 struct usb_interface *intf;
656
657 if (hub->disconnected || work_pending(&hub->events))
658 return;
659
660 /*
661 * Suppress autosuspend until the event is proceed.
662 *
663 * Be careful and make sure that the symmetric operation is
664 * always called. We are here only when there is no pending
665 * work for this hub. Therefore put the interface either when
666 * the new work is called or when it is canceled.
667 */
668 intf = to_usb_interface(hub->intfdev);
669 usb_autopm_get_interface_no_resume(intf);
670 kref_get(&hub->kref);
671
672 if (queue_work(hub_wq, &hub->events))
673 return;
674
675 /* the work has already been scheduled */
676 usb_autopm_put_interface_async(intf);
677 kref_put(&hub->kref, hub_release);
678}
679
680void usb_kick_hub_wq(struct usb_device *hdev)
681{
682 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
683
684 if (hub)
685 kick_hub_wq(hub);
686}
687
688/*
689 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
690 * Notification, which indicates it had initiated remote wakeup.
691 *
692 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
693 * device initiates resume, so the USB core will not receive notice of the
694 * resume through the normal hub interrupt URB.
695 */
696void usb_wakeup_notification(struct usb_device *hdev,
697 unsigned int portnum)
698{
699 struct usb_hub *hub;
700 struct usb_port *port_dev;
701
702 if (!hdev)
703 return;
704
705 hub = usb_hub_to_struct_hub(hdev);
706 if (hub) {
707 port_dev = hub->ports[portnum - 1];
708 if (port_dev && port_dev->child)
709 pm_wakeup_event(&port_dev->child->dev, 0);
710
711 set_bit(portnum, hub->wakeup_bits);
712 kick_hub_wq(hub);
713 }
714}
715EXPORT_SYMBOL_GPL(usb_wakeup_notification);
716
717/* completion function, fires on port status changes and various faults */
718static void hub_irq(struct urb *urb)
719{
720 struct usb_hub *hub = urb->context;
721 int status = urb->status;
722 unsigned i;
723 unsigned long bits;
724
725 switch (status) {
726 case -ENOENT: /* synchronous unlink */
727 case -ECONNRESET: /* async unlink */
728 case -ESHUTDOWN: /* hardware going away */
729 return;
730
731 default: /* presumably an error */
732 /* Cause a hub reset after 10 consecutive errors */
733 dev_dbg(hub->intfdev, "transfer --> %d\n", status);
734 if ((++hub->nerrors < 10) || hub->error)
735 goto resubmit;
736 hub->error = status;
737 fallthrough;
738
739 /* let hub_wq handle things */
740 case 0: /* we got data: port status changed */
741 bits = 0;
742 for (i = 0; i < urb->actual_length; ++i)
743 bits |= ((unsigned long) ((*hub->buffer)[i]))
744 << (i*8);
745 hub->event_bits[0] = bits;
746 break;
747 }
748
749 hub->nerrors = 0;
750
751 /* Something happened, let hub_wq figure it out */
752 kick_hub_wq(hub);
753
754resubmit:
755 hub_resubmit_irq_urb(hub);
756}
757
758/* USB 2.0 spec Section 11.24.2.3 */
759static inline int
760hub_clear_tt_buffer(struct usb_device *hdev, u16 devinfo, u16 tt)
761{
762 /* Need to clear both directions for control ep */
763 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
764 USB_ENDPOINT_XFER_CONTROL) {
765 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
766 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
767 devinfo ^ 0x8000, tt, NULL, 0, 1000);
768 if (status)
769 return status;
770 }
771 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
772 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
773 tt, NULL, 0, 1000);
774}
775
776/*
777 * enumeration blocks hub_wq for a long time. we use keventd instead, since
778 * long blocking there is the exception, not the rule. accordingly, HCDs
779 * talking to TTs must queue control transfers (not just bulk and iso), so
780 * both can talk to the same hub concurrently.
781 */
782static void hub_tt_work(struct work_struct *work)
783{
784 struct usb_hub *hub =
785 container_of(work, struct usb_hub, tt.clear_work);
786 unsigned long flags;
787
788 spin_lock_irqsave(&hub->tt.lock, flags);
789 while (!list_empty(&hub->tt.clear_list)) {
790 struct list_head *next;
791 struct usb_tt_clear *clear;
792 struct usb_device *hdev = hub->hdev;
793 const struct hc_driver *drv;
794 int status;
795
796 next = hub->tt.clear_list.next;
797 clear = list_entry(next, struct usb_tt_clear, clear_list);
798 list_del(&clear->clear_list);
799
800 /* drop lock so HCD can concurrently report other TT errors */
801 spin_unlock_irqrestore(&hub->tt.lock, flags);
802 status = hub_clear_tt_buffer(hdev, clear->devinfo, clear->tt);
803 if (status && status != -ENODEV)
804 dev_err(&hdev->dev,
805 "clear tt %d (%04x) error %d\n",
806 clear->tt, clear->devinfo, status);
807
808 /* Tell the HCD, even if the operation failed */
809 drv = clear->hcd->driver;
810 if (drv->clear_tt_buffer_complete)
811 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
812
813 kfree(clear);
814 spin_lock_irqsave(&hub->tt.lock, flags);
815 }
816 spin_unlock_irqrestore(&hub->tt.lock, flags);
817}
818
819/**
820 * usb_hub_set_port_power - control hub port's power state
821 * @hdev: USB device belonging to the usb hub
822 * @hub: target hub
823 * @port1: port index
824 * @set: expected status
825 *
826 * call this function to control port's power via setting or
827 * clearing the port's PORT_POWER feature.
828 *
829 * Return: 0 if successful. A negative error code otherwise.
830 */
831int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
832 int port1, bool set)
833{
834 int ret;
835
836 if (set)
837 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
838 else
839 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
840
841 if (ret)
842 return ret;
843
844 if (set)
845 set_bit(port1, hub->power_bits);
846 else
847 clear_bit(port1, hub->power_bits);
848 return 0;
849}
850
851/**
852 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
853 * @urb: an URB associated with the failed or incomplete split transaction
854 *
855 * High speed HCDs use this to tell the hub driver that some split control or
856 * bulk transaction failed in a way that requires clearing internal state of
857 * a transaction translator. This is normally detected (and reported) from
858 * interrupt context.
859 *
860 * It may not be possible for that hub to handle additional full (or low)
861 * speed transactions until that state is fully cleared out.
862 *
863 * Return: 0 if successful. A negative error code otherwise.
864 */
865int usb_hub_clear_tt_buffer(struct urb *urb)
866{
867 struct usb_device *udev = urb->dev;
868 int pipe = urb->pipe;
869 struct usb_tt *tt = udev->tt;
870 unsigned long flags;
871 struct usb_tt_clear *clear;
872
873 /* we've got to cope with an arbitrary number of pending TT clears,
874 * since each TT has "at least two" buffers that can need it (and
875 * there can be many TTs per hub). even if they're uncommon.
876 */
877 clear = kmalloc(sizeof *clear, GFP_ATOMIC);
878 if (clear == NULL) {
879 dev_err(&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
880 /* FIXME recover somehow ... RESET_TT? */
881 return -ENOMEM;
882 }
883
884 /* info that CLEAR_TT_BUFFER needs */
885 clear->tt = tt->multi ? udev->ttport : 1;
886 clear->devinfo = usb_pipeendpoint (pipe);
887 clear->devinfo |= ((u16)udev->devaddr) << 4;
888 clear->devinfo |= usb_pipecontrol(pipe)
889 ? (USB_ENDPOINT_XFER_CONTROL << 11)
890 : (USB_ENDPOINT_XFER_BULK << 11);
891 if (usb_pipein(pipe))
892 clear->devinfo |= 1 << 15;
893
894 /* info for completion callback */
895 clear->hcd = bus_to_hcd(udev->bus);
896 clear->ep = urb->ep;
897
898 /* tell keventd to clear state for this TT */
899 spin_lock_irqsave(&tt->lock, flags);
900 list_add_tail(&clear->clear_list, &tt->clear_list);
901 schedule_work(&tt->clear_work);
902 spin_unlock_irqrestore(&tt->lock, flags);
903 return 0;
904}
905EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
906
907static void hub_power_on(struct usb_hub *hub, bool do_delay)
908{
909 int port1;
910
911 /* Enable power on each port. Some hubs have reserved values
912 * of LPSM (> 2) in their descriptors, even though they are
913 * USB 2.0 hubs. Some hubs do not implement port-power switching
914 * but only emulate it. In all cases, the ports won't work
915 * unless we send these messages to the hub.
916 */
917 if (hub_is_port_power_switchable(hub))
918 dev_dbg(hub->intfdev, "enabling power on all ports\n");
919 else
920 dev_dbg(hub->intfdev, "trying to enable port power on "
921 "non-switchable hub\n");
922 for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
923 if (test_bit(port1, hub->power_bits))
924 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
925 else
926 usb_clear_port_feature(hub->hdev, port1,
927 USB_PORT_FEAT_POWER);
928 if (do_delay)
929 msleep(hub_power_on_good_delay(hub));
930}
931
932static int hub_hub_status(struct usb_hub *hub,
933 u16 *status, u16 *change)
934{
935 int ret;
936
937 mutex_lock(&hub->status_mutex);
938 ret = get_hub_status(hub->hdev, &hub->status->hub);
939 if (ret < 0) {
940 if (ret != -ENODEV)
941 dev_err(hub->intfdev,
942 "%s failed (err = %d)\n", __func__, ret);
943 } else {
944 *status = le16_to_cpu(hub->status->hub.wHubStatus);
945 *change = le16_to_cpu(hub->status->hub.wHubChange);
946 ret = 0;
947 }
948 mutex_unlock(&hub->status_mutex);
949 return ret;
950}
951
952static int hub_set_port_link_state(struct usb_hub *hub, int port1,
953 unsigned int link_status)
954{
955 return set_port_feature(hub->hdev,
956 port1 | (link_status << 3),
957 USB_PORT_FEAT_LINK_STATE);
958}
959
960/*
961 * Disable a port and mark a logical connect-change event, so that some
962 * time later hub_wq will disconnect() any existing usb_device on the port
963 * and will re-enumerate if there actually is a device attached.
964 */
965static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
966{
967 dev_dbg(&hub->ports[port1 - 1]->dev, "logical disconnect\n");
968 hub_port_disable(hub, port1, 1);
969
970 /* FIXME let caller ask to power down the port:
971 * - some devices won't enumerate without a VBUS power cycle
972 * - SRP saves power that way
973 * - ... new call, TBD ...
974 * That's easy if this hub can switch power per-port, and
975 * hub_wq reactivates the port later (timer, SRP, etc).
976 * Powerdown must be optional, because of reset/DFU.
977 */
978
979 set_bit(port1, hub->change_bits);
980 kick_hub_wq(hub);
981}
982
983/**
984 * usb_remove_device - disable a device's port on its parent hub
985 * @udev: device to be disabled and removed
986 * Context: @udev locked, must be able to sleep.
987 *
988 * After @udev's port has been disabled, hub_wq is notified and it will
989 * see that the device has been disconnected. When the device is
990 * physically unplugged and something is plugged in, the events will
991 * be received and processed normally.
992 *
993 * Return: 0 if successful. A negative error code otherwise.
994 */
995int usb_remove_device(struct usb_device *udev)
996{
997 struct usb_hub *hub;
998 struct usb_interface *intf;
999 int ret;
1000
1001 if (!udev->parent) /* Can't remove a root hub */
1002 return -EINVAL;
1003 hub = usb_hub_to_struct_hub(udev->parent);
1004 intf = to_usb_interface(hub->intfdev);
1005
1006 ret = usb_autopm_get_interface(intf);
1007 if (ret < 0)
1008 return ret;
1009
1010 set_bit(udev->portnum, hub->removed_bits);
1011 hub_port_logical_disconnect(hub, udev->portnum);
1012 usb_autopm_put_interface(intf);
1013 return 0;
1014}
1015
1016enum hub_activation_type {
1017 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
1018 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
1019};
1020
1021static void hub_init_func2(struct work_struct *ws);
1022static void hub_init_func3(struct work_struct *ws);
1023
1024static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
1025{
1026 struct usb_device *hdev = hub->hdev;
1027 struct usb_hcd *hcd;
1028 int ret;
1029 int port1;
1030 int status;
1031 bool need_debounce_delay = false;
1032 unsigned delay;
1033
1034 /* Continue a partial initialization */
1035 if (type == HUB_INIT2 || type == HUB_INIT3) {
1036 device_lock(&hdev->dev);
1037
1038 /* Was the hub disconnected while we were waiting? */
1039 if (hub->disconnected)
1040 goto disconnected;
1041 if (type == HUB_INIT2)
1042 goto init2;
1043 goto init3;
1044 }
1045 kref_get(&hub->kref);
1046
1047 /* The superspeed hub except for root hub has to use Hub Depth
1048 * value as an offset into the route string to locate the bits
1049 * it uses to determine the downstream port number. So hub driver
1050 * should send a set hub depth request to superspeed hub after
1051 * the superspeed hub is set configuration in initialization or
1052 * reset procedure.
1053 *
1054 * After a resume, port power should still be on.
1055 * For any other type of activation, turn it on.
1056 */
1057 if (type != HUB_RESUME) {
1058 if (hdev->parent && hub_is_superspeed(hdev)) {
1059 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1060 HUB_SET_DEPTH, USB_RT_HUB,
1061 hdev->level - 1, 0, NULL, 0,
1062 USB_CTRL_SET_TIMEOUT);
1063 if (ret < 0)
1064 dev_err(hub->intfdev,
1065 "set hub depth failed\n");
1066 }
1067
1068 /* Speed up system boot by using a delayed_work for the
1069 * hub's initial power-up delays. This is pretty awkward
1070 * and the implementation looks like a home-brewed sort of
1071 * setjmp/longjmp, but it saves at least 100 ms for each
1072 * root hub (assuming usbcore is compiled into the kernel
1073 * rather than as a module). It adds up.
1074 *
1075 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1076 * because for those activation types the ports have to be
1077 * operational when we return. In theory this could be done
1078 * for HUB_POST_RESET, but it's easier not to.
1079 */
1080 if (type == HUB_INIT) {
1081 delay = hub_power_on_good_delay(hub);
1082
1083 hub_power_on(hub, false);
1084 INIT_DELAYED_WORK(&hub->init_work, hub_init_func2);
1085 queue_delayed_work(system_power_efficient_wq,
1086 &hub->init_work,
1087 msecs_to_jiffies(delay));
1088
1089 /* Suppress autosuspend until init is done */
1090 usb_autopm_get_interface_no_resume(
1091 to_usb_interface(hub->intfdev));
1092 return; /* Continues at init2: below */
1093 } else if (type == HUB_RESET_RESUME) {
1094 /* The internal host controller state for the hub device
1095 * may be gone after a host power loss on system resume.
1096 * Update the device's info so the HW knows it's a hub.
1097 */
1098 hcd = bus_to_hcd(hdev->bus);
1099 if (hcd->driver->update_hub_device) {
1100 ret = hcd->driver->update_hub_device(hcd, hdev,
1101 &hub->tt, GFP_NOIO);
1102 if (ret < 0) {
1103 dev_err(hub->intfdev,
1104 "Host not accepting hub info update\n");
1105 dev_err(hub->intfdev,
1106 "LS/FS devices and hubs may not work under this hub\n");
1107 }
1108 }
1109 hub_power_on(hub, true);
1110 } else {
1111 hub_power_on(hub, true);
1112 }
1113 }
1114 init2:
1115
1116 /*
1117 * Check each port and set hub->change_bits to let hub_wq know
1118 * which ports need attention.
1119 */
1120 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
1121 struct usb_port *port_dev = hub->ports[port1 - 1];
1122 struct usb_device *udev = port_dev->child;
1123 u16 portstatus, portchange;
1124
1125 portstatus = portchange = 0;
1126 status = hub_port_status(hub, port1, &portstatus, &portchange);
1127 if (status)
1128 goto abort;
1129
1130 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
1131 dev_dbg(&port_dev->dev, "status %04x change %04x\n",
1132 portstatus, portchange);
1133
1134 /*
1135 * After anything other than HUB_RESUME (i.e., initialization
1136 * or any sort of reset), every port should be disabled.
1137 * Unconnected ports should likewise be disabled (paranoia),
1138 * and so should ports for which we have no usb_device.
1139 */
1140 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1141 type != HUB_RESUME ||
1142 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1143 !udev ||
1144 udev->state == USB_STATE_NOTATTACHED)) {
1145 /*
1146 * USB3 protocol ports will automatically transition
1147 * to Enabled state when detect an USB3.0 device attach.
1148 * Do not disable USB3 protocol ports, just pretend
1149 * power was lost
1150 */
1151 portstatus &= ~USB_PORT_STAT_ENABLE;
1152 if (!hub_is_superspeed(hdev))
1153 usb_clear_port_feature(hdev, port1,
1154 USB_PORT_FEAT_ENABLE);
1155 }
1156
1157 /* Make sure a warm-reset request is handled by port_event */
1158 if (type == HUB_RESUME &&
1159 hub_port_warm_reset_required(hub, port1, portstatus))
1160 set_bit(port1, hub->event_bits);
1161
1162 /*
1163 * Add debounce if USB3 link is in polling/link training state.
1164 * Link will automatically transition to Enabled state after
1165 * link training completes.
1166 */
1167 if (hub_is_superspeed(hdev) &&
1168 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
1169 USB_SS_PORT_LS_POLLING))
1170 need_debounce_delay = true;
1171
1172 /* Clear status-change flags; we'll debounce later */
1173 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1174 need_debounce_delay = true;
1175 usb_clear_port_feature(hub->hdev, port1,
1176 USB_PORT_FEAT_C_CONNECTION);
1177 }
1178 if (portchange & USB_PORT_STAT_C_ENABLE) {
1179 need_debounce_delay = true;
1180 usb_clear_port_feature(hub->hdev, port1,
1181 USB_PORT_FEAT_C_ENABLE);
1182 }
1183 if (portchange & USB_PORT_STAT_C_RESET) {
1184 need_debounce_delay = true;
1185 usb_clear_port_feature(hub->hdev, port1,
1186 USB_PORT_FEAT_C_RESET);
1187 }
1188 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1189 hub_is_superspeed(hub->hdev)) {
1190 need_debounce_delay = true;
1191 usb_clear_port_feature(hub->hdev, port1,
1192 USB_PORT_FEAT_C_BH_PORT_RESET);
1193 }
1194 /* We can forget about a "removed" device when there's a
1195 * physical disconnect or the connect status changes.
1196 */
1197 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1198 (portchange & USB_PORT_STAT_C_CONNECTION))
1199 clear_bit(port1, hub->removed_bits);
1200
1201 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
1202 /* Tell hub_wq to disconnect the device or
1203 * check for a new connection or over current condition.
1204 * Based on USB2.0 Spec Section 11.12.5,
1205 * C_PORT_OVER_CURRENT could be set while
1206 * PORT_OVER_CURRENT is not. So check for any of them.
1207 */
1208 if (udev || (portstatus & USB_PORT_STAT_CONNECTION) ||
1209 (portchange & USB_PORT_STAT_C_CONNECTION) ||
1210 (portstatus & USB_PORT_STAT_OVERCURRENT) ||
1211 (portchange & USB_PORT_STAT_C_OVERCURRENT))
1212 set_bit(port1, hub->change_bits);
1213
1214 } else if (portstatus & USB_PORT_STAT_ENABLE) {
1215 bool port_resumed = (portstatus &
1216 USB_PORT_STAT_LINK_STATE) ==
1217 USB_SS_PORT_LS_U0;
1218 /* The power session apparently survived the resume.
1219 * If there was an overcurrent or suspend change
1220 * (i.e., remote wakeup request), have hub_wq
1221 * take care of it. Look at the port link state
1222 * for USB 3.0 hubs, since they don't have a suspend
1223 * change bit, and they don't set the port link change
1224 * bit on device-initiated resume.
1225 */
1226 if (portchange || (hub_is_superspeed(hub->hdev) &&
1227 port_resumed))
1228 set_bit(port1, hub->change_bits);
1229
1230 } else if (udev->persist_enabled) {
1231#ifdef CONFIG_PM
1232 udev->reset_resume = 1;
1233#endif
1234 /* Don't set the change_bits when the device
1235 * was powered off.
1236 */
1237 if (test_bit(port1, hub->power_bits))
1238 set_bit(port1, hub->change_bits);
1239
1240 } else {
1241 /* The power session is gone; tell hub_wq */
1242 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1243 set_bit(port1, hub->change_bits);
1244 }
1245 }
1246
1247 /* If no port-status-change flags were set, we don't need any
1248 * debouncing. If flags were set we can try to debounce the
1249 * ports all at once right now, instead of letting hub_wq do them
1250 * one at a time later on.
1251 *
1252 * If any port-status changes do occur during this delay, hub_wq
1253 * will see them later and handle them normally.
1254 */
1255 if (need_debounce_delay) {
1256 delay = HUB_DEBOUNCE_STABLE;
1257
1258 /* Don't do a long sleep inside a workqueue routine */
1259 if (type == HUB_INIT2) {
1260 INIT_DELAYED_WORK(&hub->init_work, hub_init_func3);
1261 queue_delayed_work(system_power_efficient_wq,
1262 &hub->init_work,
1263 msecs_to_jiffies(delay));
1264 device_unlock(&hdev->dev);
1265 return; /* Continues at init3: below */
1266 } else {
1267 msleep(delay);
1268 }
1269 }
1270 init3:
1271 hub->quiescing = 0;
1272
1273 status = usb_submit_urb(hub->urb, GFP_NOIO);
1274 if (status < 0)
1275 dev_err(hub->intfdev, "activate --> %d\n", status);
1276 if (hub->has_indicators && blinkenlights)
1277 queue_delayed_work(system_power_efficient_wq,
1278 &hub->leds, LED_CYCLE_PERIOD);
1279
1280 /* Scan all ports that need attention */
1281 kick_hub_wq(hub);
1282 abort:
1283 if (type == HUB_INIT2 || type == HUB_INIT3) {
1284 /* Allow autosuspend if it was suppressed */
1285 disconnected:
1286 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
1287 device_unlock(&hdev->dev);
1288 }
1289
1290 kref_put(&hub->kref, hub_release);
1291}
1292
1293/* Implement the continuations for the delays above */
1294static void hub_init_func2(struct work_struct *ws)
1295{
1296 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1297
1298 hub_activate(hub, HUB_INIT2);
1299}
1300
1301static void hub_init_func3(struct work_struct *ws)
1302{
1303 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1304
1305 hub_activate(hub, HUB_INIT3);
1306}
1307
1308enum hub_quiescing_type {
1309 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1310};
1311
1312static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1313{
1314 struct usb_device *hdev = hub->hdev;
1315 unsigned long flags;
1316 int i;
1317
1318 /* hub_wq and related activity won't re-trigger */
1319 spin_lock_irqsave(&hub->irq_urb_lock, flags);
1320 hub->quiescing = 1;
1321 spin_unlock_irqrestore(&hub->irq_urb_lock, flags);
1322
1323 if (type != HUB_SUSPEND) {
1324 /* Disconnect all the children */
1325 for (i = 0; i < hdev->maxchild; ++i) {
1326 if (hub->ports[i]->child)
1327 usb_disconnect(&hub->ports[i]->child);
1328 }
1329 }
1330
1331 /* Stop hub_wq and related activity */
1332 del_timer_sync(&hub->irq_urb_retry);
1333 usb_kill_urb(hub->urb);
1334 if (hub->has_indicators)
1335 cancel_delayed_work_sync(&hub->leds);
1336 if (hub->tt.hub)
1337 flush_work(&hub->tt.clear_work);
1338}
1339
1340static void hub_pm_barrier_for_all_ports(struct usb_hub *hub)
1341{
1342 int i;
1343
1344 for (i = 0; i < hub->hdev->maxchild; ++i)
1345 pm_runtime_barrier(&hub->ports[i]->dev);
1346}
1347
1348/* caller has locked the hub device */
1349static int hub_pre_reset(struct usb_interface *intf)
1350{
1351 struct usb_hub *hub = usb_get_intfdata(intf);
1352
1353 hub_quiesce(hub, HUB_PRE_RESET);
1354 hub->in_reset = 1;
1355 hub_pm_barrier_for_all_ports(hub);
1356 return 0;
1357}
1358
1359/* caller has locked the hub device */
1360static int hub_post_reset(struct usb_interface *intf)
1361{
1362 struct usb_hub *hub = usb_get_intfdata(intf);
1363
1364 hub->in_reset = 0;
1365 hub_pm_barrier_for_all_ports(hub);
1366 hub_activate(hub, HUB_POST_RESET);
1367 return 0;
1368}
1369
1370static int hub_configure(struct usb_hub *hub,
1371 struct usb_endpoint_descriptor *endpoint)
1372{
1373 struct usb_hcd *hcd;
1374 struct usb_device *hdev = hub->hdev;
1375 struct device *hub_dev = hub->intfdev;
1376 u16 hubstatus, hubchange;
1377 u16 wHubCharacteristics;
1378 unsigned int pipe;
1379 int maxp, ret, i;
1380 char *message = "out of memory";
1381 unsigned unit_load;
1382 unsigned full_load;
1383 unsigned maxchild;
1384
1385 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
1386 if (!hub->buffer) {
1387 ret = -ENOMEM;
1388 goto fail;
1389 }
1390
1391 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1392 if (!hub->status) {
1393 ret = -ENOMEM;
1394 goto fail;
1395 }
1396 mutex_init(&hub->status_mutex);
1397
1398 hub->descriptor = kzalloc(sizeof(*hub->descriptor), GFP_KERNEL);
1399 if (!hub->descriptor) {
1400 ret = -ENOMEM;
1401 goto fail;
1402 }
1403
1404 /* Request the entire hub descriptor.
1405 * hub->descriptor can handle USB_MAXCHILDREN ports,
1406 * but a (non-SS) hub can/will return fewer bytes here.
1407 */
1408 ret = get_hub_descriptor(hdev, hub->descriptor);
1409 if (ret < 0) {
1410 message = "can't read hub descriptor";
1411 goto fail;
1412 }
1413
1414 maxchild = USB_MAXCHILDREN;
1415 if (hub_is_superspeed(hdev))
1416 maxchild = min_t(unsigned, maxchild, USB_SS_MAXPORTS);
1417
1418 if (hub->descriptor->bNbrPorts > maxchild) {
1419 message = "hub has too many ports!";
1420 ret = -ENODEV;
1421 goto fail;
1422 } else if (hub->descriptor->bNbrPorts == 0) {
1423 message = "hub doesn't have any ports!";
1424 ret = -ENODEV;
1425 goto fail;
1426 }
1427
1428 /*
1429 * Accumulate wHubDelay + 40ns for every hub in the tree of devices.
1430 * The resulting value will be used for SetIsochDelay() request.
1431 */
1432 if (hub_is_superspeed(hdev) || hub_is_superspeedplus(hdev)) {
1433 u32 delay = __le16_to_cpu(hub->descriptor->u.ss.wHubDelay);
1434
1435 if (hdev->parent)
1436 delay += hdev->parent->hub_delay;
1437
1438 delay += USB_TP_TRANSMISSION_DELAY;
1439 hdev->hub_delay = min_t(u32, delay, USB_TP_TRANSMISSION_DELAY_MAX);
1440 }
1441
1442 maxchild = hub->descriptor->bNbrPorts;
1443 dev_info(hub_dev, "%d port%s detected\n", maxchild,
1444 (maxchild == 1) ? "" : "s");
1445
1446 hub->ports = kcalloc(maxchild, sizeof(struct usb_port *), GFP_KERNEL);
1447 if (!hub->ports) {
1448 ret = -ENOMEM;
1449 goto fail;
1450 }
1451
1452 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
1453 if (hub_is_superspeed(hdev)) {
1454 unit_load = 150;
1455 full_load = 900;
1456 } else {
1457 unit_load = 100;
1458 full_load = 500;
1459 }
1460
1461 /* FIXME for USB 3.0, skip for now */
1462 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1463 !(hub_is_superspeed(hdev))) {
1464 char portstr[USB_MAXCHILDREN + 1];
1465
1466 for (i = 0; i < maxchild; i++)
1467 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
1468 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1469 ? 'F' : 'R';
1470 portstr[maxchild] = 0;
1471 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1472 } else
1473 dev_dbg(hub_dev, "standalone hub\n");
1474
1475 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
1476 case HUB_CHAR_COMMON_LPSM:
1477 dev_dbg(hub_dev, "ganged power switching\n");
1478 break;
1479 case HUB_CHAR_INDV_PORT_LPSM:
1480 dev_dbg(hub_dev, "individual port power switching\n");
1481 break;
1482 case HUB_CHAR_NO_LPSM:
1483 case HUB_CHAR_LPSM:
1484 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1485 break;
1486 }
1487
1488 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
1489 case HUB_CHAR_COMMON_OCPM:
1490 dev_dbg(hub_dev, "global over-current protection\n");
1491 break;
1492 case HUB_CHAR_INDV_PORT_OCPM:
1493 dev_dbg(hub_dev, "individual port over-current protection\n");
1494 break;
1495 case HUB_CHAR_NO_OCPM:
1496 case HUB_CHAR_OCPM:
1497 dev_dbg(hub_dev, "no over-current protection\n");
1498 break;
1499 }
1500
1501 spin_lock_init(&hub->tt.lock);
1502 INIT_LIST_HEAD(&hub->tt.clear_list);
1503 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
1504 switch (hdev->descriptor.bDeviceProtocol) {
1505 case USB_HUB_PR_FS:
1506 break;
1507 case USB_HUB_PR_HS_SINGLE_TT:
1508 dev_dbg(hub_dev, "Single TT\n");
1509 hub->tt.hub = hdev;
1510 break;
1511 case USB_HUB_PR_HS_MULTI_TT:
1512 ret = usb_set_interface(hdev, 0, 1);
1513 if (ret == 0) {
1514 dev_dbg(hub_dev, "TT per port\n");
1515 hub->tt.multi = 1;
1516 } else
1517 dev_err(hub_dev, "Using single TT (err %d)\n",
1518 ret);
1519 hub->tt.hub = hdev;
1520 break;
1521 case USB_HUB_PR_SS:
1522 /* USB 3.0 hubs don't have a TT */
1523 break;
1524 default:
1525 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1526 hdev->descriptor.bDeviceProtocol);
1527 break;
1528 }
1529
1530 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
1531 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
1532 case HUB_TTTT_8_BITS:
1533 if (hdev->descriptor.bDeviceProtocol != 0) {
1534 hub->tt.think_time = 666;
1535 dev_dbg(hub_dev, "TT requires at most %d "
1536 "FS bit times (%d ns)\n",
1537 8, hub->tt.think_time);
1538 }
1539 break;
1540 case HUB_TTTT_16_BITS:
1541 hub->tt.think_time = 666 * 2;
1542 dev_dbg(hub_dev, "TT requires at most %d "
1543 "FS bit times (%d ns)\n",
1544 16, hub->tt.think_time);
1545 break;
1546 case HUB_TTTT_24_BITS:
1547 hub->tt.think_time = 666 * 3;
1548 dev_dbg(hub_dev, "TT requires at most %d "
1549 "FS bit times (%d ns)\n",
1550 24, hub->tt.think_time);
1551 break;
1552 case HUB_TTTT_32_BITS:
1553 hub->tt.think_time = 666 * 4;
1554 dev_dbg(hub_dev, "TT requires at most %d "
1555 "FS bit times (%d ns)\n",
1556 32, hub->tt.think_time);
1557 break;
1558 }
1559
1560 /* probe() zeroes hub->indicator[] */
1561 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
1562 hub->has_indicators = 1;
1563 dev_dbg(hub_dev, "Port indicators are supported\n");
1564 }
1565
1566 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1567 hub->descriptor->bPwrOn2PwrGood * 2);
1568
1569 /* power budgeting mostly matters with bus-powered hubs,
1570 * and battery-powered root hubs (may provide just 8 mA).
1571 */
1572 ret = usb_get_std_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
1573 if (ret) {
1574 message = "can't get hub status";
1575 goto fail;
1576 }
1577 hcd = bus_to_hcd(hdev->bus);
1578 if (hdev == hdev->bus->root_hub) {
1579 if (hcd->power_budget > 0)
1580 hdev->bus_mA = hcd->power_budget;
1581 else
1582 hdev->bus_mA = full_load * maxchild;
1583 if (hdev->bus_mA >= full_load)
1584 hub->mA_per_port = full_load;
1585 else {
1586 hub->mA_per_port = hdev->bus_mA;
1587 hub->limited_power = 1;
1588 }
1589 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
1590 int remaining = hdev->bus_mA -
1591 hub->descriptor->bHubContrCurrent;
1592
1593 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1594 hub->descriptor->bHubContrCurrent);
1595 hub->limited_power = 1;
1596
1597 if (remaining < maxchild * unit_load)
1598 dev_warn(hub_dev,
1599 "insufficient power available "
1600 "to use all downstream ports\n");
1601 hub->mA_per_port = unit_load; /* 7.2.1 */
1602
1603 } else { /* Self-powered external hub */
1604 /* FIXME: What about battery-powered external hubs that
1605 * provide less current per port? */
1606 hub->mA_per_port = full_load;
1607 }
1608 if (hub->mA_per_port < full_load)
1609 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1610 hub->mA_per_port);
1611
1612 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1613 if (ret < 0) {
1614 message = "can't get hub status";
1615 goto fail;
1616 }
1617
1618 /* local power status reports aren't always correct */
1619 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1620 dev_dbg(hub_dev, "local power source is %s\n",
1621 (hubstatus & HUB_STATUS_LOCAL_POWER)
1622 ? "lost (inactive)" : "good");
1623
1624 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
1625 dev_dbg(hub_dev, "%sover-current condition exists\n",
1626 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1627
1628 /* set up the interrupt endpoint
1629 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1630 * bytes as USB2.0[11.12.3] says because some hubs are known
1631 * to send more data (and thus cause overflow). For root hubs,
1632 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1633 * to be big enough for at least USB_MAXCHILDREN ports. */
1634 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1635 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1636
1637 if (maxp > sizeof(*hub->buffer))
1638 maxp = sizeof(*hub->buffer);
1639
1640 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1641 if (!hub->urb) {
1642 ret = -ENOMEM;
1643 goto fail;
1644 }
1645
1646 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1647 hub, endpoint->bInterval);
1648
1649 /* maybe cycle the hub leds */
1650 if (hub->has_indicators && blinkenlights)
1651 hub->indicator[0] = INDICATOR_CYCLE;
1652
1653 mutex_lock(&usb_port_peer_mutex);
1654 for (i = 0; i < maxchild; i++) {
1655 ret = usb_hub_create_port_device(hub, i + 1);
1656 if (ret < 0) {
1657 dev_err(hub->intfdev,
1658 "couldn't create port%d device.\n", i + 1);
1659 break;
1660 }
1661 }
1662 hdev->maxchild = i;
1663 for (i = 0; i < hdev->maxchild; i++) {
1664 struct usb_port *port_dev = hub->ports[i];
1665
1666 pm_runtime_put(&port_dev->dev);
1667 }
1668
1669 mutex_unlock(&usb_port_peer_mutex);
1670 if (ret < 0)
1671 goto fail;
1672
1673 /* Update the HCD's internal representation of this hub before hub_wq
1674 * starts getting port status changes for devices under the hub.
1675 */
1676 if (hcd->driver->update_hub_device) {
1677 ret = hcd->driver->update_hub_device(hcd, hdev,
1678 &hub->tt, GFP_KERNEL);
1679 if (ret < 0) {
1680 message = "can't update HCD hub info";
1681 goto fail;
1682 }
1683 }
1684
1685 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1686
1687 hub_activate(hub, HUB_INIT);
1688 return 0;
1689
1690fail:
1691 dev_err(hub_dev, "config failed, %s (err %d)\n",
1692 message, ret);
1693 /* hub_disconnect() frees urb and descriptor */
1694 return ret;
1695}
1696
1697static void hub_release(struct kref *kref)
1698{
1699 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1700
1701 usb_put_dev(hub->hdev);
1702 usb_put_intf(to_usb_interface(hub->intfdev));
1703 kfree(hub);
1704}
1705
1706static unsigned highspeed_hubs;
1707
1708static void hub_disconnect(struct usb_interface *intf)
1709{
1710 struct usb_hub *hub = usb_get_intfdata(intf);
1711 struct usb_device *hdev = interface_to_usbdev(intf);
1712 int port1;
1713
1714 /*
1715 * Stop adding new hub events. We do not want to block here and thus
1716 * will not try to remove any pending work item.
1717 */
1718 hub->disconnected = 1;
1719
1720 /* Disconnect all children and quiesce the hub */
1721 hub->error = 0;
1722 hub_quiesce(hub, HUB_DISCONNECT);
1723
1724 mutex_lock(&usb_port_peer_mutex);
1725
1726 /* Avoid races with recursively_mark_NOTATTACHED() */
1727 spin_lock_irq(&device_state_lock);
1728 port1 = hdev->maxchild;
1729 hdev->maxchild = 0;
1730 usb_set_intfdata(intf, NULL);
1731 spin_unlock_irq(&device_state_lock);
1732
1733 for (; port1 > 0; --port1)
1734 usb_hub_remove_port_device(hub, port1);
1735
1736 mutex_unlock(&usb_port_peer_mutex);
1737
1738 if (hub->hdev->speed == USB_SPEED_HIGH)
1739 highspeed_hubs--;
1740
1741 usb_free_urb(hub->urb);
1742 kfree(hub->ports);
1743 kfree(hub->descriptor);
1744 kfree(hub->status);
1745 kfree(hub->buffer);
1746
1747 pm_suspend_ignore_children(&intf->dev, false);
1748
1749 if (hub->quirk_disable_autosuspend)
1750 usb_autopm_put_interface(intf);
1751
1752 kref_put(&hub->kref, hub_release);
1753}
1754
1755static bool hub_descriptor_is_sane(struct usb_host_interface *desc)
1756{
1757 /* Some hubs have a subclass of 1, which AFAICT according to the */
1758 /* specs is not defined, but it works */
1759 if (desc->desc.bInterfaceSubClass != 0 &&
1760 desc->desc.bInterfaceSubClass != 1)
1761 return false;
1762
1763 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1764 if (desc->desc.bNumEndpoints != 1)
1765 return false;
1766
1767 /* If the first endpoint is not interrupt IN, we'd better punt! */
1768 if (!usb_endpoint_is_int_in(&desc->endpoint[0].desc))
1769 return false;
1770
1771 return true;
1772}
1773
1774static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1775{
1776 struct usb_host_interface *desc;
1777 struct usb_device *hdev;
1778 struct usb_hub *hub;
1779
1780 desc = intf->cur_altsetting;
1781 hdev = interface_to_usbdev(intf);
1782
1783 /*
1784 * Set default autosuspend delay as 0 to speedup bus suspend,
1785 * based on the below considerations:
1786 *
1787 * - Unlike other drivers, the hub driver does not rely on the
1788 * autosuspend delay to provide enough time to handle a wakeup
1789 * event, and the submitted status URB is just to check future
1790 * change on hub downstream ports, so it is safe to do it.
1791 *
1792 * - The patch might cause one or more auto supend/resume for
1793 * below very rare devices when they are plugged into hub
1794 * first time:
1795 *
1796 * devices having trouble initializing, and disconnect
1797 * themselves from the bus and then reconnect a second
1798 * or so later
1799 *
1800 * devices just for downloading firmware, and disconnects
1801 * themselves after completing it
1802 *
1803 * For these quite rare devices, their drivers may change the
1804 * autosuspend delay of their parent hub in the probe() to one
1805 * appropriate value to avoid the subtle problem if someone
1806 * does care it.
1807 *
1808 * - The patch may cause one or more auto suspend/resume on
1809 * hub during running 'lsusb', but it is probably too
1810 * infrequent to worry about.
1811 *
1812 * - Change autosuspend delay of hub can avoid unnecessary auto
1813 * suspend timer for hub, also may decrease power consumption
1814 * of USB bus.
1815 *
1816 * - If user has indicated to prevent autosuspend by passing
1817 * usbcore.autosuspend = -1 then keep autosuspend disabled.
1818 */
1819#ifdef CONFIG_PM
1820 if (hdev->dev.power.autosuspend_delay >= 0)
1821 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
1822#endif
1823
1824 /*
1825 * Hubs have proper suspend/resume support, except for root hubs
1826 * where the controller driver doesn't have bus_suspend and
1827 * bus_resume methods.
1828 */
1829 if (hdev->parent) { /* normal device */
1830 usb_enable_autosuspend(hdev);
1831 } else { /* root hub */
1832 const struct hc_driver *drv = bus_to_hcd(hdev->bus)->driver;
1833
1834 if (drv->bus_suspend && drv->bus_resume)
1835 usb_enable_autosuspend(hdev);
1836 }
1837
1838 if (hdev->level == MAX_TOPO_LEVEL) {
1839 dev_err(&intf->dev,
1840 "Unsupported bus topology: hub nested too deep\n");
1841 return -E2BIG;
1842 }
1843
1844#ifdef CONFIG_USB_OTG_DISABLE_EXTERNAL_HUB
1845 if (hdev->parent) {
1846 dev_warn(&intf->dev, "ignoring external hub\n");
1847 return -ENODEV;
1848 }
1849#endif
1850
1851 if (!hub_descriptor_is_sane(desc)) {
1852 dev_err(&intf->dev, "bad descriptor, ignoring hub\n");
1853 return -EIO;
1854 }
1855
1856 /* We found a hub */
1857 dev_info(&intf->dev, "USB hub found\n");
1858
1859 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
1860 if (!hub)
1861 return -ENOMEM;
1862
1863 kref_init(&hub->kref);
1864 hub->intfdev = &intf->dev;
1865 hub->hdev = hdev;
1866 INIT_DELAYED_WORK(&hub->leds, led_work);
1867 INIT_DELAYED_WORK(&hub->init_work, NULL);
1868 INIT_WORK(&hub->events, hub_event);
1869 spin_lock_init(&hub->irq_urb_lock);
1870 timer_setup(&hub->irq_urb_retry, hub_retry_irq_urb, 0);
1871 usb_get_intf(intf);
1872 usb_get_dev(hdev);
1873
1874 usb_set_intfdata(intf, hub);
1875 intf->needs_remote_wakeup = 1;
1876 pm_suspend_ignore_children(&intf->dev, true);
1877
1878 if (hdev->speed == USB_SPEED_HIGH)
1879 highspeed_hubs++;
1880
1881 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1882 hub->quirk_check_port_auto_suspend = 1;
1883
1884 if (id->driver_info & HUB_QUIRK_DISABLE_AUTOSUSPEND) {
1885 hub->quirk_disable_autosuspend = 1;
1886 usb_autopm_get_interface_no_resume(intf);
1887 }
1888
1889 if (hub_configure(hub, &desc->endpoint[0].desc) >= 0)
1890 return 0;
1891
1892 hub_disconnect(intf);
1893 return -ENODEV;
1894}
1895
1896static int
1897hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1898{
1899 struct usb_device *hdev = interface_to_usbdev(intf);
1900 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1901
1902 /* assert ifno == 0 (part of hub spec) */
1903 switch (code) {
1904 case USBDEVFS_HUB_PORTINFO: {
1905 struct usbdevfs_hub_portinfo *info = user_data;
1906 int i;
1907
1908 spin_lock_irq(&device_state_lock);
1909 if (hdev->devnum <= 0)
1910 info->nports = 0;
1911 else {
1912 info->nports = hdev->maxchild;
1913 for (i = 0; i < info->nports; i++) {
1914 if (hub->ports[i]->child == NULL)
1915 info->port[i] = 0;
1916 else
1917 info->port[i] =
1918 hub->ports[i]->child->devnum;
1919 }
1920 }
1921 spin_unlock_irq(&device_state_lock);
1922
1923 return info->nports + 1;
1924 }
1925
1926 default:
1927 return -ENOSYS;
1928 }
1929}
1930
1931/*
1932 * Allow user programs to claim ports on a hub. When a device is attached
1933 * to one of these "claimed" ports, the program will "own" the device.
1934 */
1935static int find_port_owner(struct usb_device *hdev, unsigned port1,
1936 struct usb_dev_state ***ppowner)
1937{
1938 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1939
1940 if (hdev->state == USB_STATE_NOTATTACHED)
1941 return -ENODEV;
1942 if (port1 == 0 || port1 > hdev->maxchild)
1943 return -EINVAL;
1944
1945 /* Devices not managed by the hub driver
1946 * will always have maxchild equal to 0.
1947 */
1948 *ppowner = &(hub->ports[port1 - 1]->port_owner);
1949 return 0;
1950}
1951
1952/* In the following three functions, the caller must hold hdev's lock */
1953int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
1954 struct usb_dev_state *owner)
1955{
1956 int rc;
1957 struct usb_dev_state **powner;
1958
1959 rc = find_port_owner(hdev, port1, &powner);
1960 if (rc)
1961 return rc;
1962 if (*powner)
1963 return -EBUSY;
1964 *powner = owner;
1965 return rc;
1966}
1967EXPORT_SYMBOL_GPL(usb_hub_claim_port);
1968
1969int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
1970 struct usb_dev_state *owner)
1971{
1972 int rc;
1973 struct usb_dev_state **powner;
1974
1975 rc = find_port_owner(hdev, port1, &powner);
1976 if (rc)
1977 return rc;
1978 if (*powner != owner)
1979 return -ENOENT;
1980 *powner = NULL;
1981 return rc;
1982}
1983EXPORT_SYMBOL_GPL(usb_hub_release_port);
1984
1985void usb_hub_release_all_ports(struct usb_device *hdev, struct usb_dev_state *owner)
1986{
1987 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1988 int n;
1989
1990 for (n = 0; n < hdev->maxchild; n++) {
1991 if (hub->ports[n]->port_owner == owner)
1992 hub->ports[n]->port_owner = NULL;
1993 }
1994
1995}
1996
1997/* The caller must hold udev's lock */
1998bool usb_device_is_owned(struct usb_device *udev)
1999{
2000 struct usb_hub *hub;
2001
2002 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
2003 return false;
2004 hub = usb_hub_to_struct_hub(udev->parent);
2005 return !!hub->ports[udev->portnum - 1]->port_owner;
2006}
2007
2008static void recursively_mark_NOTATTACHED(struct usb_device *udev)
2009{
2010 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2011 int i;
2012
2013 for (i = 0; i < udev->maxchild; ++i) {
2014 if (hub->ports[i]->child)
2015 recursively_mark_NOTATTACHED(hub->ports[i]->child);
2016 }
2017 if (udev->state == USB_STATE_SUSPENDED)
2018 udev->active_duration -= jiffies;
2019 udev->state = USB_STATE_NOTATTACHED;
2020}
2021
2022/**
2023 * usb_set_device_state - change a device's current state (usbcore, hcds)
2024 * @udev: pointer to device whose state should be changed
2025 * @new_state: new state value to be stored
2026 *
2027 * udev->state is _not_ fully protected by the device lock. Although
2028 * most transitions are made only while holding the lock, the state can
2029 * can change to USB_STATE_NOTATTACHED at almost any time. This
2030 * is so that devices can be marked as disconnected as soon as possible,
2031 * without having to wait for any semaphores to be released. As a result,
2032 * all changes to any device's state must be protected by the
2033 * device_state_lock spinlock.
2034 *
2035 * Once a device has been added to the device tree, all changes to its state
2036 * should be made using this routine. The state should _not_ be set directly.
2037 *
2038 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
2039 * Otherwise udev->state is set to new_state, and if new_state is
2040 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
2041 * to USB_STATE_NOTATTACHED.
2042 */
2043void usb_set_device_state(struct usb_device *udev,
2044 enum usb_device_state new_state)
2045{
2046 unsigned long flags;
2047 int wakeup = -1;
2048
2049 spin_lock_irqsave(&device_state_lock, flags);
2050 if (udev->state == USB_STATE_NOTATTACHED)
2051 ; /* do nothing */
2052 else if (new_state != USB_STATE_NOTATTACHED) {
2053
2054 /* root hub wakeup capabilities are managed out-of-band
2055 * and may involve silicon errata ... ignore them here.
2056 */
2057 if (udev->parent) {
2058 if (udev->state == USB_STATE_SUSPENDED
2059 || new_state == USB_STATE_SUSPENDED)
2060 ; /* No change to wakeup settings */
2061 else if (new_state == USB_STATE_CONFIGURED)
2062 wakeup = (udev->quirks &
2063 USB_QUIRK_IGNORE_REMOTE_WAKEUP) ? 0 :
2064 udev->actconfig->desc.bmAttributes &
2065 USB_CONFIG_ATT_WAKEUP;
2066 else
2067 wakeup = 0;
2068 }
2069 if (udev->state == USB_STATE_SUSPENDED &&
2070 new_state != USB_STATE_SUSPENDED)
2071 udev->active_duration -= jiffies;
2072 else if (new_state == USB_STATE_SUSPENDED &&
2073 udev->state != USB_STATE_SUSPENDED)
2074 udev->active_duration += jiffies;
2075 udev->state = new_state;
2076 } else
2077 recursively_mark_NOTATTACHED(udev);
2078 spin_unlock_irqrestore(&device_state_lock, flags);
2079 if (wakeup >= 0)
2080 device_set_wakeup_capable(&udev->dev, wakeup);
2081}
2082EXPORT_SYMBOL_GPL(usb_set_device_state);
2083
2084/*
2085 * Choose a device number.
2086 *
2087 * Device numbers are used as filenames in usbfs. On USB-1.1 and
2088 * USB-2.0 buses they are also used as device addresses, however on
2089 * USB-3.0 buses the address is assigned by the controller hardware
2090 * and it usually is not the same as the device number.
2091 *
2092 * WUSB devices are simple: they have no hubs behind, so the mapping
2093 * device <-> virtual port number becomes 1:1. Why? to simplify the
2094 * life of the device connection logic in
2095 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
2096 * handshake we need to assign a temporary address in the unauthorized
2097 * space. For simplicity we use the first virtual port number found to
2098 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
2099 * and that becomes it's address [X < 128] or its unauthorized address
2100 * [X | 0x80].
2101 *
2102 * We add 1 as an offset to the one-based USB-stack port number
2103 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
2104 * 0 is reserved by USB for default address; (b) Linux's USB stack
2105 * uses always #1 for the root hub of the controller. So USB stack's
2106 * port #1, which is wusb virtual-port #0 has address #2.
2107 *
2108 * Devices connected under xHCI are not as simple. The host controller
2109 * supports virtualization, so the hardware assigns device addresses and
2110 * the HCD must setup data structures before issuing a set address
2111 * command to the hardware.
2112 */
2113static void choose_devnum(struct usb_device *udev)
2114{
2115 int devnum;
2116 struct usb_bus *bus = udev->bus;
2117
2118 /* be safe when more hub events are proceed in parallel */
2119 mutex_lock(&bus->devnum_next_mutex);
2120 if (udev->wusb) {
2121 devnum = udev->portnum + 1;
2122 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
2123 } else {
2124 /* Try to allocate the next devnum beginning at
2125 * bus->devnum_next. */
2126 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
2127 bus->devnum_next);
2128 if (devnum >= 128)
2129 devnum = find_next_zero_bit(bus->devmap.devicemap,
2130 128, 1);
2131 bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
2132 }
2133 if (devnum < 128) {
2134 set_bit(devnum, bus->devmap.devicemap);
2135 udev->devnum = devnum;
2136 }
2137 mutex_unlock(&bus->devnum_next_mutex);
2138}
2139
2140static void release_devnum(struct usb_device *udev)
2141{
2142 if (udev->devnum > 0) {
2143 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2144 udev->devnum = -1;
2145 }
2146}
2147
2148static void update_devnum(struct usb_device *udev, int devnum)
2149{
2150 /* The address for a WUSB device is managed by wusbcore. */
2151 if (!udev->wusb)
2152 udev->devnum = devnum;
2153 if (!udev->devaddr)
2154 udev->devaddr = (u8)devnum;
2155}
2156
2157static void hub_free_dev(struct usb_device *udev)
2158{
2159 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2160
2161 /* Root hubs aren't real devices, so don't free HCD resources */
2162 if (hcd->driver->free_dev && udev->parent)
2163 hcd->driver->free_dev(hcd, udev);
2164}
2165
2166static void hub_disconnect_children(struct usb_device *udev)
2167{
2168 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2169 int i;
2170
2171 /* Free up all the children before we remove this device */
2172 for (i = 0; i < udev->maxchild; i++) {
2173 if (hub->ports[i]->child)
2174 usb_disconnect(&hub->ports[i]->child);
2175 }
2176}
2177
2178/**
2179 * usb_disconnect - disconnect a device (usbcore-internal)
2180 * @pdev: pointer to device being disconnected
2181 *
2182 * Context: task context, might sleep
2183 *
2184 * Something got disconnected. Get rid of it and all of its children.
2185 *
2186 * If *pdev is a normal device then the parent hub must already be locked.
2187 * If *pdev is a root hub then the caller must hold the usb_bus_idr_lock,
2188 * which protects the set of root hubs as well as the list of buses.
2189 *
2190 * Only hub drivers (including virtual root hub drivers for host
2191 * controllers) should ever call this.
2192 *
2193 * This call is synchronous, and may not be used in an interrupt context.
2194 */
2195void usb_disconnect(struct usb_device **pdev)
2196{
2197 struct usb_port *port_dev = NULL;
2198 struct usb_device *udev = *pdev;
2199 struct usb_hub *hub = NULL;
2200 int port1 = 1;
2201
2202 /* mark the device as inactive, so any further urb submissions for
2203 * this device (and any of its children) will fail immediately.
2204 * this quiesces everything except pending urbs.
2205 */
2206 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2207 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2208 udev->devnum);
2209
2210 /*
2211 * Ensure that the pm runtime code knows that the USB device
2212 * is in the process of being disconnected.
2213 */
2214 pm_runtime_barrier(&udev->dev);
2215
2216 usb_lock_device(udev);
2217
2218 hub_disconnect_children(udev);
2219
2220 /* deallocate hcd/hardware state ... nuking all pending urbs and
2221 * cleaning up all state associated with the current configuration
2222 * so that the hardware is now fully quiesced.
2223 */
2224 dev_dbg(&udev->dev, "unregistering device\n");
2225 usb_disable_device(udev, 0);
2226 usb_hcd_synchronize_unlinks(udev);
2227
2228 if (udev->parent) {
2229 port1 = udev->portnum;
2230 hub = usb_hub_to_struct_hub(udev->parent);
2231 port_dev = hub->ports[port1 - 1];
2232
2233 sysfs_remove_link(&udev->dev.kobj, "port");
2234 sysfs_remove_link(&port_dev->dev.kobj, "device");
2235
2236 /*
2237 * As usb_port_runtime_resume() de-references udev, make
2238 * sure no resumes occur during removal
2239 */
2240 if (!test_and_set_bit(port1, hub->child_usage_bits))
2241 pm_runtime_get_sync(&port_dev->dev);
2242 }
2243
2244 usb_remove_ep_devs(&udev->ep0);
2245 usb_unlock_device(udev);
2246
2247 /* Unregister the device. The device driver is responsible
2248 * for de-configuring the device and invoking the remove-device
2249 * notifier chain (used by usbfs and possibly others).
2250 */
2251 device_del(&udev->dev);
2252
2253 /* Free the device number and delete the parent's children[]
2254 * (or root_hub) pointer.
2255 */
2256 release_devnum(udev);
2257
2258 /* Avoid races with recursively_mark_NOTATTACHED() */
2259 spin_lock_irq(&device_state_lock);
2260 *pdev = NULL;
2261 spin_unlock_irq(&device_state_lock);
2262
2263 if (port_dev && test_and_clear_bit(port1, hub->child_usage_bits))
2264 pm_runtime_put(&port_dev->dev);
2265
2266 hub_free_dev(udev);
2267
2268 put_device(&udev->dev);
2269}
2270
2271#ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2272static void show_string(struct usb_device *udev, char *id, char *string)
2273{
2274 if (!string)
2275 return;
2276 dev_info(&udev->dev, "%s: %s\n", id, string);
2277}
2278
2279static void announce_device(struct usb_device *udev)
2280{
2281 u16 bcdDevice = le16_to_cpu(udev->descriptor.bcdDevice);
2282
2283 dev_info(&udev->dev,
2284 "New USB device found, idVendor=%04x, idProduct=%04x, bcdDevice=%2x.%02x\n",
2285 le16_to_cpu(udev->descriptor.idVendor),
2286 le16_to_cpu(udev->descriptor.idProduct),
2287 bcdDevice >> 8, bcdDevice & 0xff);
2288 dev_info(&udev->dev,
2289 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2290 udev->descriptor.iManufacturer,
2291 udev->descriptor.iProduct,
2292 udev->descriptor.iSerialNumber);
2293 show_string(udev, "Product", udev->product);
2294 show_string(udev, "Manufacturer", udev->manufacturer);
2295 show_string(udev, "SerialNumber", udev->serial);
2296}
2297#else
2298static inline void announce_device(struct usb_device *udev) { }
2299#endif
2300
2301
2302/**
2303 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2304 * @udev: newly addressed device (in ADDRESS state)
2305 *
2306 * Finish enumeration for On-The-Go devices
2307 *
2308 * Return: 0 if successful. A negative error code otherwise.
2309 */
2310static int usb_enumerate_device_otg(struct usb_device *udev)
2311{
2312 int err = 0;
2313
2314#ifdef CONFIG_USB_OTG
2315 /*
2316 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2317 * to wake us after we've powered off VBUS; and HNP, switching roles
2318 * "host" to "peripheral". The OTG descriptor helps figure this out.
2319 */
2320 if (!udev->bus->is_b_host
2321 && udev->config
2322 && udev->parent == udev->bus->root_hub) {
2323 struct usb_otg_descriptor *desc = NULL;
2324 struct usb_bus *bus = udev->bus;
2325 unsigned port1 = udev->portnum;
2326
2327 /* descriptor may appear anywhere in config */
2328 err = __usb_get_extra_descriptor(udev->rawdescriptors[0],
2329 le16_to_cpu(udev->config[0].desc.wTotalLength),
2330 USB_DT_OTG, (void **) &desc, sizeof(*desc));
2331 if (err || !(desc->bmAttributes & USB_OTG_HNP))
2332 return 0;
2333
2334 dev_info(&udev->dev, "Dual-Role OTG device on %sHNP port\n",
2335 (port1 == bus->otg_port) ? "" : "non-");
2336
2337 /* enable HNP before suspend, it's simpler */
2338 if (port1 == bus->otg_port) {
2339 bus->b_hnp_enable = 1;
2340 err = usb_control_msg(udev,
2341 usb_sndctrlpipe(udev, 0),
2342 USB_REQ_SET_FEATURE, 0,
2343 USB_DEVICE_B_HNP_ENABLE,
2344 0, NULL, 0,
2345 USB_CTRL_SET_TIMEOUT);
2346 if (err < 0) {
2347 /*
2348 * OTG MESSAGE: report errors here,
2349 * customize to match your product.
2350 */
2351 dev_err(&udev->dev, "can't set HNP mode: %d\n",
2352 err);
2353 bus->b_hnp_enable = 0;
2354 }
2355 } else if (desc->bLength == sizeof
2356 (struct usb_otg_descriptor)) {
2357 /* Set a_alt_hnp_support for legacy otg device */
2358 err = usb_control_msg(udev,
2359 usb_sndctrlpipe(udev, 0),
2360 USB_REQ_SET_FEATURE, 0,
2361 USB_DEVICE_A_ALT_HNP_SUPPORT,
2362 0, NULL, 0,
2363 USB_CTRL_SET_TIMEOUT);
2364 if (err < 0)
2365 dev_err(&udev->dev,
2366 "set a_alt_hnp_support failed: %d\n",
2367 err);
2368 }
2369 }
2370#endif
2371 return err;
2372}
2373
2374
2375/**
2376 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2377 * @udev: newly addressed device (in ADDRESS state)
2378 *
2379 * This is only called by usb_new_device() and usb_authorize_device()
2380 * and FIXME -- all comments that apply to them apply here wrt to
2381 * environment.
2382 *
2383 * If the device is WUSB and not authorized, we don't attempt to read
2384 * the string descriptors, as they will be errored out by the device
2385 * until it has been authorized.
2386 *
2387 * Return: 0 if successful. A negative error code otherwise.
2388 */
2389static int usb_enumerate_device(struct usb_device *udev)
2390{
2391 int err;
2392 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2393
2394 if (udev->config == NULL) {
2395 err = usb_get_configuration(udev);
2396 if (err < 0) {
2397 if (err != -ENODEV)
2398 dev_err(&udev->dev, "can't read configurations, error %d\n",
2399 err);
2400 return err;
2401 }
2402 }
2403
2404 /* read the standard strings and cache them if present */
2405 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2406 udev->manufacturer = usb_cache_string(udev,
2407 udev->descriptor.iManufacturer);
2408 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2409
2410 err = usb_enumerate_device_otg(udev);
2411 if (err < 0)
2412 return err;
2413
2414 if (IS_ENABLED(CONFIG_USB_OTG_PRODUCTLIST) && hcd->tpl_support &&
2415 !is_targeted(udev)) {
2416 /* Maybe it can talk to us, though we can't talk to it.
2417 * (Includes HNP test device.)
2418 */
2419 if (IS_ENABLED(CONFIG_USB_OTG) && (udev->bus->b_hnp_enable
2420 || udev->bus->is_b_host)) {
2421 err = usb_port_suspend(udev, PMSG_AUTO_SUSPEND);
2422 if (err < 0)
2423 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2424 }
2425 return -ENOTSUPP;
2426 }
2427
2428 usb_detect_interface_quirks(udev);
2429
2430 return 0;
2431}
2432
2433static void set_usb_port_removable(struct usb_device *udev)
2434{
2435 struct usb_device *hdev = udev->parent;
2436 struct usb_hub *hub;
2437 u8 port = udev->portnum;
2438 u16 wHubCharacteristics;
2439 bool removable = true;
2440
2441 dev_set_removable(&udev->dev, DEVICE_REMOVABLE_UNKNOWN);
2442
2443 if (!hdev)
2444 return;
2445
2446 hub = usb_hub_to_struct_hub(udev->parent);
2447
2448 /*
2449 * If the platform firmware has provided information about a port,
2450 * use that to determine whether it's removable.
2451 */
2452 switch (hub->ports[udev->portnum - 1]->connect_type) {
2453 case USB_PORT_CONNECT_TYPE_HOT_PLUG:
2454 dev_set_removable(&udev->dev, DEVICE_REMOVABLE);
2455 return;
2456 case USB_PORT_CONNECT_TYPE_HARD_WIRED:
2457 case USB_PORT_NOT_USED:
2458 dev_set_removable(&udev->dev, DEVICE_FIXED);
2459 return;
2460 default:
2461 break;
2462 }
2463
2464 /*
2465 * Otherwise, check whether the hub knows whether a port is removable
2466 * or not
2467 */
2468 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2469
2470 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2471 return;
2472
2473 if (hub_is_superspeed(hdev)) {
2474 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2475 & (1 << port))
2476 removable = false;
2477 } else {
2478 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2479 removable = false;
2480 }
2481
2482 if (removable)
2483 dev_set_removable(&udev->dev, DEVICE_REMOVABLE);
2484 else
2485 dev_set_removable(&udev->dev, DEVICE_FIXED);
2486
2487}
2488
2489/**
2490 * usb_new_device - perform initial device setup (usbcore-internal)
2491 * @udev: newly addressed device (in ADDRESS state)
2492 *
2493 * This is called with devices which have been detected but not fully
2494 * enumerated. The device descriptor is available, but not descriptors
2495 * for any device configuration. The caller must have locked either
2496 * the parent hub (if udev is a normal device) or else the
2497 * usb_bus_idr_lock (if udev is a root hub). The parent's pointer to
2498 * udev has already been installed, but udev is not yet visible through
2499 * sysfs or other filesystem code.
2500 *
2501 * This call is synchronous, and may not be used in an interrupt context.
2502 *
2503 * Only the hub driver or root-hub registrar should ever call this.
2504 *
2505 * Return: Whether the device is configured properly or not. Zero if the
2506 * interface was registered with the driver core; else a negative errno
2507 * value.
2508 *
2509 */
2510int usb_new_device(struct usb_device *udev)
2511{
2512 int err;
2513
2514 if (udev->parent) {
2515 /* Initialize non-root-hub device wakeup to disabled;
2516 * device (un)configuration controls wakeup capable
2517 * sysfs power/wakeup controls wakeup enabled/disabled
2518 */
2519 device_init_wakeup(&udev->dev, 0);
2520 }
2521
2522 /* Tell the runtime-PM framework the device is active */
2523 pm_runtime_set_active(&udev->dev);
2524 pm_runtime_get_noresume(&udev->dev);
2525 pm_runtime_use_autosuspend(&udev->dev);
2526 pm_runtime_enable(&udev->dev);
2527
2528 /* By default, forbid autosuspend for all devices. It will be
2529 * allowed for hubs during binding.
2530 */
2531 usb_disable_autosuspend(udev);
2532
2533 err = usb_enumerate_device(udev); /* Read descriptors */
2534 if (err < 0)
2535 goto fail;
2536 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2537 udev->devnum, udev->bus->busnum,
2538 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2539 /* export the usbdev device-node for libusb */
2540 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2541 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2542
2543 /* Tell the world! */
2544 announce_device(udev);
2545
2546 if (udev->serial)
2547 add_device_randomness(udev->serial, strlen(udev->serial));
2548 if (udev->product)
2549 add_device_randomness(udev->product, strlen(udev->product));
2550 if (udev->manufacturer)
2551 add_device_randomness(udev->manufacturer,
2552 strlen(udev->manufacturer));
2553
2554 device_enable_async_suspend(&udev->dev);
2555
2556 /* check whether the hub or firmware marks this port as non-removable */
2557 set_usb_port_removable(udev);
2558
2559 /* Register the device. The device driver is responsible
2560 * for configuring the device and invoking the add-device
2561 * notifier chain (used by usbfs and possibly others).
2562 */
2563 err = device_add(&udev->dev);
2564 if (err) {
2565 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2566 goto fail;
2567 }
2568
2569 /* Create link files between child device and usb port device. */
2570 if (udev->parent) {
2571 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2572 int port1 = udev->portnum;
2573 struct usb_port *port_dev = hub->ports[port1 - 1];
2574
2575 err = sysfs_create_link(&udev->dev.kobj,
2576 &port_dev->dev.kobj, "port");
2577 if (err)
2578 goto fail;
2579
2580 err = sysfs_create_link(&port_dev->dev.kobj,
2581 &udev->dev.kobj, "device");
2582 if (err) {
2583 sysfs_remove_link(&udev->dev.kobj, "port");
2584 goto fail;
2585 }
2586
2587 if (!test_and_set_bit(port1, hub->child_usage_bits))
2588 pm_runtime_get_sync(&port_dev->dev);
2589 }
2590
2591 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2592 usb_mark_last_busy(udev);
2593 pm_runtime_put_sync_autosuspend(&udev->dev);
2594 return err;
2595
2596fail:
2597 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2598 pm_runtime_disable(&udev->dev);
2599 pm_runtime_set_suspended(&udev->dev);
2600 return err;
2601}
2602
2603
2604/**
2605 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2606 * @usb_dev: USB device
2607 *
2608 * Move the USB device to a very basic state where interfaces are disabled
2609 * and the device is in fact unconfigured and unusable.
2610 *
2611 * We share a lock (that we have) with device_del(), so we need to
2612 * defer its call.
2613 *
2614 * Return: 0.
2615 */
2616int usb_deauthorize_device(struct usb_device *usb_dev)
2617{
2618 usb_lock_device(usb_dev);
2619 if (usb_dev->authorized == 0)
2620 goto out_unauthorized;
2621
2622 usb_dev->authorized = 0;
2623 usb_set_configuration(usb_dev, -1);
2624
2625out_unauthorized:
2626 usb_unlock_device(usb_dev);
2627 return 0;
2628}
2629
2630
2631int usb_authorize_device(struct usb_device *usb_dev)
2632{
2633 int result = 0, c;
2634
2635 usb_lock_device(usb_dev);
2636 if (usb_dev->authorized == 1)
2637 goto out_authorized;
2638
2639 result = usb_autoresume_device(usb_dev);
2640 if (result < 0) {
2641 dev_err(&usb_dev->dev,
2642 "can't autoresume for authorization: %d\n", result);
2643 goto error_autoresume;
2644 }
2645
2646 if (usb_dev->wusb) {
2647 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2648 if (result < 0) {
2649 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2650 "authorization: %d\n", result);
2651 goto error_device_descriptor;
2652 }
2653 }
2654
2655 usb_dev->authorized = 1;
2656 /* Choose and set the configuration. This registers the interfaces
2657 * with the driver core and lets interface drivers bind to them.
2658 */
2659 c = usb_choose_configuration(usb_dev);
2660 if (c >= 0) {
2661 result = usb_set_configuration(usb_dev, c);
2662 if (result) {
2663 dev_err(&usb_dev->dev,
2664 "can't set config #%d, error %d\n", c, result);
2665 /* This need not be fatal. The user can try to
2666 * set other configurations. */
2667 }
2668 }
2669 dev_info(&usb_dev->dev, "authorized to connect\n");
2670
2671error_device_descriptor:
2672 usb_autosuspend_device(usb_dev);
2673error_autoresume:
2674out_authorized:
2675 usb_unlock_device(usb_dev); /* complements locktree */
2676 return result;
2677}
2678
2679/**
2680 * get_port_ssp_rate - Match the extended port status to SSP rate
2681 * @hdev: The hub device
2682 * @ext_portstatus: extended port status
2683 *
2684 * Match the extended port status speed id to the SuperSpeed Plus sublink speed
2685 * capability attributes. Base on the number of connected lanes and speed,
2686 * return the corresponding enum usb_ssp_rate.
2687 */
2688static enum usb_ssp_rate get_port_ssp_rate(struct usb_device *hdev,
2689 u32 ext_portstatus)
2690{
2691 struct usb_ssp_cap_descriptor *ssp_cap = hdev->bos->ssp_cap;
2692 u32 attr;
2693 u8 speed_id;
2694 u8 ssac;
2695 u8 lanes;
2696 int i;
2697
2698 if (!ssp_cap)
2699 goto out;
2700
2701 speed_id = ext_portstatus & USB_EXT_PORT_STAT_RX_SPEED_ID;
2702 lanes = USB_EXT_PORT_RX_LANES(ext_portstatus) + 1;
2703
2704 ssac = le32_to_cpu(ssp_cap->bmAttributes) &
2705 USB_SSP_SUBLINK_SPEED_ATTRIBS;
2706
2707 for (i = 0; i <= ssac; i++) {
2708 u8 ssid;
2709
2710 attr = le32_to_cpu(ssp_cap->bmSublinkSpeedAttr[i]);
2711 ssid = FIELD_GET(USB_SSP_SUBLINK_SPEED_SSID, attr);
2712 if (speed_id == ssid) {
2713 u16 mantissa;
2714 u8 lse;
2715 u8 type;
2716
2717 /*
2718 * Note: currently asymmetric lane types are only
2719 * applicable for SSIC operate in SuperSpeed protocol
2720 */
2721 type = FIELD_GET(USB_SSP_SUBLINK_SPEED_ST, attr);
2722 if (type == USB_SSP_SUBLINK_SPEED_ST_ASYM_RX ||
2723 type == USB_SSP_SUBLINK_SPEED_ST_ASYM_TX)
2724 goto out;
2725
2726 if (FIELD_GET(USB_SSP_SUBLINK_SPEED_LP, attr) !=
2727 USB_SSP_SUBLINK_SPEED_LP_SSP)
2728 goto out;
2729
2730 lse = FIELD_GET(USB_SSP_SUBLINK_SPEED_LSE, attr);
2731 mantissa = FIELD_GET(USB_SSP_SUBLINK_SPEED_LSM, attr);
2732
2733 /* Convert to Gbps */
2734 for (; lse < USB_SSP_SUBLINK_SPEED_LSE_GBPS; lse++)
2735 mantissa /= 1000;
2736
2737 if (mantissa >= 10 && lanes == 1)
2738 return USB_SSP_GEN_2x1;
2739
2740 if (mantissa >= 10 && lanes == 2)
2741 return USB_SSP_GEN_2x2;
2742
2743 if (mantissa >= 5 && lanes == 2)
2744 return USB_SSP_GEN_1x2;
2745
2746 goto out;
2747 }
2748 }
2749
2750out:
2751 return USB_SSP_GEN_UNKNOWN;
2752}
2753
2754/* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2755static unsigned hub_is_wusb(struct usb_hub *hub)
2756{
2757 struct usb_hcd *hcd;
2758 if (hub->hdev->parent != NULL) /* not a root hub? */
2759 return 0;
2760 hcd = bus_to_hcd(hub->hdev->bus);
2761 return hcd->wireless;
2762}
2763
2764
2765#ifdef CONFIG_USB_FEW_INIT_RETRIES
2766#define PORT_RESET_TRIES 2
2767#define SET_ADDRESS_TRIES 1
2768#define GET_DESCRIPTOR_TRIES 1
2769#define GET_MAXPACKET0_TRIES 1
2770#define PORT_INIT_TRIES 4
2771
2772#else
2773#define PORT_RESET_TRIES 5
2774#define SET_ADDRESS_TRIES 2
2775#define GET_DESCRIPTOR_TRIES 2
2776#define GET_MAXPACKET0_TRIES 3
2777#define PORT_INIT_TRIES 4
2778#endif /* CONFIG_USB_FEW_INIT_RETRIES */
2779
2780#define HUB_ROOT_RESET_TIME 60 /* times are in msec */
2781#define HUB_SHORT_RESET_TIME 10
2782#define HUB_BH_RESET_TIME 50
2783#define HUB_LONG_RESET_TIME 200
2784#define HUB_RESET_TIMEOUT 800
2785
2786static bool use_new_scheme(struct usb_device *udev, int retry,
2787 struct usb_port *port_dev)
2788{
2789 int old_scheme_first_port =
2790 (port_dev->quirks & USB_PORT_QUIRK_OLD_SCHEME) ||
2791 old_scheme_first;
2792
2793 /*
2794 * "New scheme" enumeration causes an extra state transition to be
2795 * exposed to an xhci host and causes USB3 devices to receive control
2796 * commands in the default state. This has been seen to cause
2797 * enumeration failures, so disable this enumeration scheme for USB3
2798 * devices.
2799 */
2800 if (udev->speed >= USB_SPEED_SUPER)
2801 return false;
2802
2803 /*
2804 * If use_both_schemes is set, use the first scheme (whichever
2805 * it is) for the larger half of the retries, then use the other
2806 * scheme. Otherwise, use the first scheme for all the retries.
2807 */
2808 if (use_both_schemes && retry >= (PORT_INIT_TRIES + 1) / 2)
2809 return old_scheme_first_port; /* Second half */
2810 return !old_scheme_first_port; /* First half or all */
2811}
2812
2813/* Is a USB 3.0 port in the Inactive or Compliance Mode state?
2814 * Port warm reset is required to recover
2815 */
2816static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
2817 u16 portstatus)
2818{
2819 u16 link_state;
2820
2821 if (!hub_is_superspeed(hub->hdev))
2822 return false;
2823
2824 if (test_bit(port1, hub->warm_reset_bits))
2825 return true;
2826
2827 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
2828 return link_state == USB_SS_PORT_LS_SS_INACTIVE
2829 || link_state == USB_SS_PORT_LS_COMP_MOD;
2830}
2831
2832static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2833 struct usb_device *udev, unsigned int delay, bool warm)
2834{
2835 int delay_time, ret;
2836 u16 portstatus;
2837 u16 portchange;
2838 u32 ext_portstatus = 0;
2839
2840 for (delay_time = 0;
2841 delay_time < HUB_RESET_TIMEOUT;
2842 delay_time += delay) {
2843 /* wait to give the device a chance to reset */
2844 msleep(delay);
2845
2846 /* read and decode port status */
2847 if (hub_is_superspeedplus(hub->hdev))
2848 ret = hub_ext_port_status(hub, port1,
2849 HUB_EXT_PORT_STATUS,
2850 &portstatus, &portchange,
2851 &ext_portstatus);
2852 else
2853 ret = hub_port_status(hub, port1, &portstatus,
2854 &portchange);
2855 if (ret < 0)
2856 return ret;
2857
2858 /*
2859 * The port state is unknown until the reset completes.
2860 *
2861 * On top of that, some chips may require additional time
2862 * to re-establish a connection after the reset is complete,
2863 * so also wait for the connection to be re-established.
2864 */
2865 if (!(portstatus & USB_PORT_STAT_RESET) &&
2866 (portstatus & USB_PORT_STAT_CONNECTION))
2867 break;
2868
2869 /* switch to the long delay after two short delay failures */
2870 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2871 delay = HUB_LONG_RESET_TIME;
2872
2873 dev_dbg(&hub->ports[port1 - 1]->dev,
2874 "not %sreset yet, waiting %dms\n",
2875 warm ? "warm " : "", delay);
2876 }
2877
2878 if ((portstatus & USB_PORT_STAT_RESET))
2879 return -EBUSY;
2880
2881 if (hub_port_warm_reset_required(hub, port1, portstatus))
2882 return -ENOTCONN;
2883
2884 /* Device went away? */
2885 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2886 return -ENOTCONN;
2887
2888 /* Retry if connect change is set but status is still connected.
2889 * A USB 3.0 connection may bounce if multiple warm resets were issued,
2890 * but the device may have successfully re-connected. Ignore it.
2891 */
2892 if (!hub_is_superspeed(hub->hdev) &&
2893 (portchange & USB_PORT_STAT_C_CONNECTION)) {
2894 usb_clear_port_feature(hub->hdev, port1,
2895 USB_PORT_FEAT_C_CONNECTION);
2896 return -EAGAIN;
2897 }
2898
2899 if (!(portstatus & USB_PORT_STAT_ENABLE))
2900 return -EBUSY;
2901
2902 if (!udev)
2903 return 0;
2904
2905 if (hub_is_superspeedplus(hub->hdev)) {
2906 /* extended portstatus Rx and Tx lane count are zero based */
2907 udev->rx_lanes = USB_EXT_PORT_RX_LANES(ext_portstatus) + 1;
2908 udev->tx_lanes = USB_EXT_PORT_TX_LANES(ext_portstatus) + 1;
2909 udev->ssp_rate = get_port_ssp_rate(hub->hdev, ext_portstatus);
2910 } else {
2911 udev->rx_lanes = 1;
2912 udev->tx_lanes = 1;
2913 udev->ssp_rate = USB_SSP_GEN_UNKNOWN;
2914 }
2915 if (hub_is_wusb(hub))
2916 udev->speed = USB_SPEED_WIRELESS;
2917 else if (udev->ssp_rate != USB_SSP_GEN_UNKNOWN)
2918 udev->speed = USB_SPEED_SUPER_PLUS;
2919 else if (hub_is_superspeed(hub->hdev))
2920 udev->speed = USB_SPEED_SUPER;
2921 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2922 udev->speed = USB_SPEED_HIGH;
2923 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2924 udev->speed = USB_SPEED_LOW;
2925 else
2926 udev->speed = USB_SPEED_FULL;
2927 return 0;
2928}
2929
2930/* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2931static int hub_port_reset(struct usb_hub *hub, int port1,
2932 struct usb_device *udev, unsigned int delay, bool warm)
2933{
2934 int i, status;
2935 u16 portchange, portstatus;
2936 struct usb_port *port_dev = hub->ports[port1 - 1];
2937 int reset_recovery_time;
2938
2939 if (!hub_is_superspeed(hub->hdev)) {
2940 if (warm) {
2941 dev_err(hub->intfdev, "only USB3 hub support "
2942 "warm reset\n");
2943 return -EINVAL;
2944 }
2945 /* Block EHCI CF initialization during the port reset.
2946 * Some companion controllers don't like it when they mix.
2947 */
2948 down_read(&ehci_cf_port_reset_rwsem);
2949 } else if (!warm) {
2950 /*
2951 * If the caller hasn't explicitly requested a warm reset,
2952 * double check and see if one is needed.
2953 */
2954 if (hub_port_status(hub, port1, &portstatus, &portchange) == 0)
2955 if (hub_port_warm_reset_required(hub, port1,
2956 portstatus))
2957 warm = true;
2958 }
2959 clear_bit(port1, hub->warm_reset_bits);
2960
2961 /* Reset the port */
2962 for (i = 0; i < PORT_RESET_TRIES; i++) {
2963 status = set_port_feature(hub->hdev, port1, (warm ?
2964 USB_PORT_FEAT_BH_PORT_RESET :
2965 USB_PORT_FEAT_RESET));
2966 if (status == -ENODEV) {
2967 ; /* The hub is gone */
2968 } else if (status) {
2969 dev_err(&port_dev->dev,
2970 "cannot %sreset (err = %d)\n",
2971 warm ? "warm " : "", status);
2972 } else {
2973 status = hub_port_wait_reset(hub, port1, udev, delay,
2974 warm);
2975 if (status && status != -ENOTCONN && status != -ENODEV)
2976 dev_dbg(hub->intfdev,
2977 "port_wait_reset: err = %d\n",
2978 status);
2979 }
2980
2981 /* Check for disconnect or reset */
2982 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2983 usb_clear_port_feature(hub->hdev, port1,
2984 USB_PORT_FEAT_C_RESET);
2985
2986 if (!hub_is_superspeed(hub->hdev))
2987 goto done;
2988
2989 usb_clear_port_feature(hub->hdev, port1,
2990 USB_PORT_FEAT_C_BH_PORT_RESET);
2991 usb_clear_port_feature(hub->hdev, port1,
2992 USB_PORT_FEAT_C_PORT_LINK_STATE);
2993
2994 if (udev)
2995 usb_clear_port_feature(hub->hdev, port1,
2996 USB_PORT_FEAT_C_CONNECTION);
2997
2998 /*
2999 * If a USB 3.0 device migrates from reset to an error
3000 * state, re-issue the warm reset.
3001 */
3002 if (hub_port_status(hub, port1,
3003 &portstatus, &portchange) < 0)
3004 goto done;
3005
3006 if (!hub_port_warm_reset_required(hub, port1,
3007 portstatus))
3008 goto done;
3009
3010 /*
3011 * If the port is in SS.Inactive or Compliance Mode, the
3012 * hot or warm reset failed. Try another warm reset.
3013 */
3014 if (!warm) {
3015 dev_dbg(&port_dev->dev,
3016 "hot reset failed, warm reset\n");
3017 warm = true;
3018 }
3019 }
3020
3021 dev_dbg(&port_dev->dev,
3022 "not enabled, trying %sreset again...\n",
3023 warm ? "warm " : "");
3024 delay = HUB_LONG_RESET_TIME;
3025 }
3026
3027 dev_err(&port_dev->dev, "Cannot enable. Maybe the USB cable is bad?\n");
3028
3029done:
3030 if (status == 0) {
3031 if (port_dev->quirks & USB_PORT_QUIRK_FAST_ENUM)
3032 usleep_range(10000, 12000);
3033 else {
3034 /* TRSTRCY = 10 ms; plus some extra */
3035 reset_recovery_time = 10 + 40;
3036
3037 /* Hub needs extra delay after resetting its port. */
3038 if (hub->hdev->quirks & USB_QUIRK_HUB_SLOW_RESET)
3039 reset_recovery_time += 100;
3040
3041 msleep(reset_recovery_time);
3042 }
3043
3044 if (udev) {
3045 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3046
3047 update_devnum(udev, 0);
3048 /* The xHC may think the device is already reset,
3049 * so ignore the status.
3050 */
3051 if (hcd->driver->reset_device)
3052 hcd->driver->reset_device(hcd, udev);
3053
3054 usb_set_device_state(udev, USB_STATE_DEFAULT);
3055 }
3056 } else {
3057 if (udev)
3058 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
3059 }
3060
3061 if (!hub_is_superspeed(hub->hdev))
3062 up_read(&ehci_cf_port_reset_rwsem);
3063
3064 return status;
3065}
3066
3067/* Check if a port is power on */
3068static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
3069{
3070 int ret = 0;
3071
3072 if (hub_is_superspeed(hub->hdev)) {
3073 if (portstatus & USB_SS_PORT_STAT_POWER)
3074 ret = 1;
3075 } else {
3076 if (portstatus & USB_PORT_STAT_POWER)
3077 ret = 1;
3078 }
3079
3080 return ret;
3081}
3082
3083static void usb_lock_port(struct usb_port *port_dev)
3084 __acquires(&port_dev->status_lock)
3085{
3086 mutex_lock(&port_dev->status_lock);
3087 __acquire(&port_dev->status_lock);
3088}
3089
3090static void usb_unlock_port(struct usb_port *port_dev)
3091 __releases(&port_dev->status_lock)
3092{
3093 mutex_unlock(&port_dev->status_lock);
3094 __release(&port_dev->status_lock);
3095}
3096
3097#ifdef CONFIG_PM
3098
3099/* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
3100static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
3101{
3102 int ret = 0;
3103
3104 if (hub_is_superspeed(hub->hdev)) {
3105 if ((portstatus & USB_PORT_STAT_LINK_STATE)
3106 == USB_SS_PORT_LS_U3)
3107 ret = 1;
3108 } else {
3109 if (portstatus & USB_PORT_STAT_SUSPEND)
3110 ret = 1;
3111 }
3112
3113 return ret;
3114}
3115
3116/* Determine whether the device on a port is ready for a normal resume,
3117 * is ready for a reset-resume, or should be disconnected.
3118 */
3119static int check_port_resume_type(struct usb_device *udev,
3120 struct usb_hub *hub, int port1,
3121 int status, u16 portchange, u16 portstatus)
3122{
3123 struct usb_port *port_dev = hub->ports[port1 - 1];
3124 int retries = 3;
3125
3126 retry:
3127 /* Is a warm reset needed to recover the connection? */
3128 if (status == 0 && udev->reset_resume
3129 && hub_port_warm_reset_required(hub, port1, portstatus)) {
3130 /* pass */;
3131 }
3132 /* Is the device still present? */
3133 else if (status || port_is_suspended(hub, portstatus) ||
3134 !port_is_power_on(hub, portstatus)) {
3135 if (status >= 0)
3136 status = -ENODEV;
3137 } else if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
3138 if (retries--) {
3139 usleep_range(200, 300);
3140 status = hub_port_status(hub, port1, &portstatus,
3141 &portchange);
3142 goto retry;
3143 }
3144 status = -ENODEV;
3145 }
3146
3147 /* Can't do a normal resume if the port isn't enabled,
3148 * so try a reset-resume instead.
3149 */
3150 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
3151 if (udev->persist_enabled)
3152 udev->reset_resume = 1;
3153 else
3154 status = -ENODEV;
3155 }
3156
3157 if (status) {
3158 dev_dbg(&port_dev->dev, "status %04x.%04x after resume, %d\n",
3159 portchange, portstatus, status);
3160 } else if (udev->reset_resume) {
3161
3162 /* Late port handoff can set status-change bits */
3163 if (portchange & USB_PORT_STAT_C_CONNECTION)
3164 usb_clear_port_feature(hub->hdev, port1,
3165 USB_PORT_FEAT_C_CONNECTION);
3166 if (portchange & USB_PORT_STAT_C_ENABLE)
3167 usb_clear_port_feature(hub->hdev, port1,
3168 USB_PORT_FEAT_C_ENABLE);
3169
3170 /*
3171 * Whatever made this reset-resume necessary may have
3172 * turned on the port1 bit in hub->change_bits. But after
3173 * a successful reset-resume we want the bit to be clear;
3174 * if it was on it would indicate that something happened
3175 * following the reset-resume.
3176 */
3177 clear_bit(port1, hub->change_bits);
3178 }
3179
3180 return status;
3181}
3182
3183int usb_disable_ltm(struct usb_device *udev)
3184{
3185 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3186
3187 /* Check if the roothub and device supports LTM. */
3188 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3189 !usb_device_supports_ltm(udev))
3190 return 0;
3191
3192 /* Clear Feature LTM Enable can only be sent if the device is
3193 * configured.
3194 */
3195 if (!udev->actconfig)
3196 return 0;
3197
3198 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3199 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3200 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3201 USB_CTRL_SET_TIMEOUT);
3202}
3203EXPORT_SYMBOL_GPL(usb_disable_ltm);
3204
3205void usb_enable_ltm(struct usb_device *udev)
3206{
3207 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3208
3209 /* Check if the roothub and device supports LTM. */
3210 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3211 !usb_device_supports_ltm(udev))
3212 return;
3213
3214 /* Set Feature LTM Enable can only be sent if the device is
3215 * configured.
3216 */
3217 if (!udev->actconfig)
3218 return;
3219
3220 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3221 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3222 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3223 USB_CTRL_SET_TIMEOUT);
3224}
3225EXPORT_SYMBOL_GPL(usb_enable_ltm);
3226
3227/*
3228 * usb_enable_remote_wakeup - enable remote wakeup for a device
3229 * @udev: target device
3230 *
3231 * For USB-2 devices: Set the device's remote wakeup feature.
3232 *
3233 * For USB-3 devices: Assume there's only one function on the device and
3234 * enable remote wake for the first interface. FIXME if the interface
3235 * association descriptor shows there's more than one function.
3236 */
3237static int usb_enable_remote_wakeup(struct usb_device *udev)
3238{
3239 if (udev->speed < USB_SPEED_SUPER)
3240 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3241 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3242 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3243 USB_CTRL_SET_TIMEOUT);
3244 else
3245 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3246 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3247 USB_INTRF_FUNC_SUSPEND,
3248 USB_INTRF_FUNC_SUSPEND_RW |
3249 USB_INTRF_FUNC_SUSPEND_LP,
3250 NULL, 0, USB_CTRL_SET_TIMEOUT);
3251}
3252
3253/*
3254 * usb_disable_remote_wakeup - disable remote wakeup for a device
3255 * @udev: target device
3256 *
3257 * For USB-2 devices: Clear the device's remote wakeup feature.
3258 *
3259 * For USB-3 devices: Assume there's only one function on the device and
3260 * disable remote wake for the first interface. FIXME if the interface
3261 * association descriptor shows there's more than one function.
3262 */
3263static int usb_disable_remote_wakeup(struct usb_device *udev)
3264{
3265 if (udev->speed < USB_SPEED_SUPER)
3266 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3267 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3268 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3269 USB_CTRL_SET_TIMEOUT);
3270 else
3271 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3272 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3273 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
3274 USB_CTRL_SET_TIMEOUT);
3275}
3276
3277/* Count of wakeup-enabled devices at or below udev */
3278unsigned usb_wakeup_enabled_descendants(struct usb_device *udev)
3279{
3280 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
3281
3282 return udev->do_remote_wakeup +
3283 (hub ? hub->wakeup_enabled_descendants : 0);
3284}
3285EXPORT_SYMBOL_GPL(usb_wakeup_enabled_descendants);
3286
3287/*
3288 * usb_port_suspend - suspend a usb device's upstream port
3289 * @udev: device that's no longer in active use, not a root hub
3290 * Context: must be able to sleep; device not locked; pm locks held
3291 *
3292 * Suspends a USB device that isn't in active use, conserving power.
3293 * Devices may wake out of a suspend, if anything important happens,
3294 * using the remote wakeup mechanism. They may also be taken out of
3295 * suspend by the host, using usb_port_resume(). It's also routine
3296 * to disconnect devices while they are suspended.
3297 *
3298 * This only affects the USB hardware for a device; its interfaces
3299 * (and, for hubs, child devices) must already have been suspended.
3300 *
3301 * Selective port suspend reduces power; most suspended devices draw
3302 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3303 * All devices below the suspended port are also suspended.
3304 *
3305 * Devices leave suspend state when the host wakes them up. Some devices
3306 * also support "remote wakeup", where the device can activate the USB
3307 * tree above them to deliver data, such as a keypress or packet. In
3308 * some cases, this wakes the USB host.
3309 *
3310 * Suspending OTG devices may trigger HNP, if that's been enabled
3311 * between a pair of dual-role devices. That will change roles, such
3312 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3313 *
3314 * Devices on USB hub ports have only one "suspend" state, corresponding
3315 * to ACPI D2, "may cause the device to lose some context".
3316 * State transitions include:
3317 *
3318 * - suspend, resume ... when the VBUS power link stays live
3319 * - suspend, disconnect ... VBUS lost
3320 *
3321 * Once VBUS drop breaks the circuit, the port it's using has to go through
3322 * normal re-enumeration procedures, starting with enabling VBUS power.
3323 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3324 * Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq
3325 * timer, no SRP, no requests through sysfs.
3326 *
3327 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3328 * suspended until their bus goes into global suspend (i.e., the root
3329 * hub is suspended). Nevertheless, we change @udev->state to
3330 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3331 * upstream port setting is stored in @udev->port_is_suspended.
3332 *
3333 * Returns 0 on success, else negative errno.
3334 */
3335int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
3336{
3337 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3338 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3339 int port1 = udev->portnum;
3340 int status;
3341 bool really_suspend = true;
3342
3343 usb_lock_port(port_dev);
3344
3345 /* enable remote wakeup when appropriate; this lets the device
3346 * wake up the upstream hub (including maybe the root hub).
3347 *
3348 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3349 * we don't explicitly enable it here.
3350 */
3351 if (udev->do_remote_wakeup) {
3352 status = usb_enable_remote_wakeup(udev);
3353 if (status) {
3354 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3355 status);
3356 /* bail if autosuspend is requested */
3357 if (PMSG_IS_AUTO(msg))
3358 goto err_wakeup;
3359 }
3360 }
3361
3362 /* disable USB2 hardware LPM */
3363 usb_disable_usb2_hardware_lpm(udev);
3364
3365 if (usb_disable_ltm(udev)) {
3366 dev_err(&udev->dev, "Failed to disable LTM before suspend\n");
3367 status = -ENOMEM;
3368 if (PMSG_IS_AUTO(msg))
3369 goto err_ltm;
3370 }
3371
3372 /* see 7.1.7.6 */
3373 if (hub_is_superspeed(hub->hdev))
3374 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3375
3376 /*
3377 * For system suspend, we do not need to enable the suspend feature
3378 * on individual USB-2 ports. The devices will automatically go
3379 * into suspend a few ms after the root hub stops sending packets.
3380 * The USB 2.0 spec calls this "global suspend".
3381 *
3382 * However, many USB hubs have a bug: They don't relay wakeup requests
3383 * from a downstream port if the port's suspend feature isn't on.
3384 * Therefore we will turn on the suspend feature if udev or any of its
3385 * descendants is enabled for remote wakeup.
3386 */
3387 else if (PMSG_IS_AUTO(msg) || usb_wakeup_enabled_descendants(udev) > 0)
3388 status = set_port_feature(hub->hdev, port1,
3389 USB_PORT_FEAT_SUSPEND);
3390 else {
3391 really_suspend = false;
3392 status = 0;
3393 }
3394 if (status) {
3395 /* Check if the port has been suspended for the timeout case
3396 * to prevent the suspended port from incorrect handling.
3397 */
3398 if (status == -ETIMEDOUT) {
3399 int ret;
3400 u16 portstatus, portchange;
3401
3402 portstatus = portchange = 0;
3403 ret = hub_port_status(hub, port1, &portstatus,
3404 &portchange);
3405
3406 dev_dbg(&port_dev->dev,
3407 "suspend timeout, status %04x\n", portstatus);
3408
3409 if (ret == 0 && port_is_suspended(hub, portstatus)) {
3410 status = 0;
3411 goto suspend_done;
3412 }
3413 }
3414
3415 dev_dbg(&port_dev->dev, "can't suspend, status %d\n", status);
3416
3417 /* Try to enable USB3 LTM again */
3418 usb_enable_ltm(udev);
3419 err_ltm:
3420 /* Try to enable USB2 hardware LPM again */
3421 usb_enable_usb2_hardware_lpm(udev);
3422
3423 if (udev->do_remote_wakeup)
3424 (void) usb_disable_remote_wakeup(udev);
3425 err_wakeup:
3426
3427 /* System sleep transitions should never fail */
3428 if (!PMSG_IS_AUTO(msg))
3429 status = 0;
3430 } else {
3431 suspend_done:
3432 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3433 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3434 udev->do_remote_wakeup);
3435 if (really_suspend) {
3436 udev->port_is_suspended = 1;
3437
3438 /* device has up to 10 msec to fully suspend */
3439 msleep(10);
3440 }
3441 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3442 }
3443
3444 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled
3445 && test_and_clear_bit(port1, hub->child_usage_bits))
3446 pm_runtime_put_sync(&port_dev->dev);
3447
3448 usb_mark_last_busy(hub->hdev);
3449
3450 usb_unlock_port(port_dev);
3451 return status;
3452}
3453
3454/*
3455 * If the USB "suspend" state is in use (rather than "global suspend"),
3456 * many devices will be individually taken out of suspend state using
3457 * special "resume" signaling. This routine kicks in shortly after
3458 * hardware resume signaling is finished, either because of selective
3459 * resume (by host) or remote wakeup (by device) ... now see what changed
3460 * in the tree that's rooted at this device.
3461 *
3462 * If @udev->reset_resume is set then the device is reset before the
3463 * status check is done.
3464 */
3465static int finish_port_resume(struct usb_device *udev)
3466{
3467 int status = 0;
3468 u16 devstatus = 0;
3469
3470 /* caller owns the udev device lock */
3471 dev_dbg(&udev->dev, "%s\n",
3472 udev->reset_resume ? "finish reset-resume" : "finish resume");
3473
3474 /* usb ch9 identifies four variants of SUSPENDED, based on what
3475 * state the device resumes to. Linux currently won't see the
3476 * first two on the host side; they'd be inside hub_port_init()
3477 * during many timeouts, but hub_wq can't suspend until later.
3478 */
3479 usb_set_device_state(udev, udev->actconfig
3480 ? USB_STATE_CONFIGURED
3481 : USB_STATE_ADDRESS);
3482
3483 /* 10.5.4.5 says not to reset a suspended port if the attached
3484 * device is enabled for remote wakeup. Hence the reset
3485 * operation is carried out here, after the port has been
3486 * resumed.
3487 */
3488 if (udev->reset_resume) {
3489 /*
3490 * If the device morphs or switches modes when it is reset,
3491 * we don't want to perform a reset-resume. We'll fail the
3492 * resume, which will cause a logical disconnect, and then
3493 * the device will be rediscovered.
3494 */
3495 retry_reset_resume:
3496 if (udev->quirks & USB_QUIRK_RESET)
3497 status = -ENODEV;
3498 else
3499 status = usb_reset_and_verify_device(udev);
3500 }
3501
3502 /* 10.5.4.5 says be sure devices in the tree are still there.
3503 * For now let's assume the device didn't go crazy on resume,
3504 * and device drivers will know about any resume quirks.
3505 */
3506 if (status == 0) {
3507 devstatus = 0;
3508 status = usb_get_std_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3509
3510 /* If a normal resume failed, try doing a reset-resume */
3511 if (status && !udev->reset_resume && udev->persist_enabled) {
3512 dev_dbg(&udev->dev, "retry with reset-resume\n");
3513 udev->reset_resume = 1;
3514 goto retry_reset_resume;
3515 }
3516 }
3517
3518 if (status) {
3519 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3520 status);
3521 /*
3522 * There are a few quirky devices which violate the standard
3523 * by claiming to have remote wakeup enabled after a reset,
3524 * which crash if the feature is cleared, hence check for
3525 * udev->reset_resume
3526 */
3527 } else if (udev->actconfig && !udev->reset_resume) {
3528 if (udev->speed < USB_SPEED_SUPER) {
3529 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3530 status = usb_disable_remote_wakeup(udev);
3531 } else {
3532 status = usb_get_std_status(udev, USB_RECIP_INTERFACE, 0,
3533 &devstatus);
3534 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3535 | USB_INTRF_STAT_FUNC_RW))
3536 status = usb_disable_remote_wakeup(udev);
3537 }
3538
3539 if (status)
3540 dev_dbg(&udev->dev,
3541 "disable remote wakeup, status %d\n",
3542 status);
3543 status = 0;
3544 }
3545 return status;
3546}
3547
3548/*
3549 * There are some SS USB devices which take longer time for link training.
3550 * XHCI specs 4.19.4 says that when Link training is successful, port
3551 * sets CCS bit to 1. So if SW reads port status before successful link
3552 * training, then it will not find device to be present.
3553 * USB Analyzer log with such buggy devices show that in some cases
3554 * device switch on the RX termination after long delay of host enabling
3555 * the VBUS. In few other cases it has been seen that device fails to
3556 * negotiate link training in first attempt. It has been
3557 * reported till now that few devices take as long as 2000 ms to train
3558 * the link after host enabling its VBUS and termination. Following
3559 * routine implements a 2000 ms timeout for link training. If in a case
3560 * link trains before timeout, loop will exit earlier.
3561 *
3562 * There are also some 2.0 hard drive based devices and 3.0 thumb
3563 * drives that, when plugged into a 2.0 only port, take a long
3564 * time to set CCS after VBUS enable.
3565 *
3566 * FIXME: If a device was connected before suspend, but was removed
3567 * while system was asleep, then the loop in the following routine will
3568 * only exit at timeout.
3569 *
3570 * This routine should only be called when persist is enabled.
3571 */
3572static int wait_for_connected(struct usb_device *udev,
3573 struct usb_hub *hub, int *port1,
3574 u16 *portchange, u16 *portstatus)
3575{
3576 int status = 0, delay_ms = 0;
3577
3578 while (delay_ms < 2000) {
3579 if (status || *portstatus & USB_PORT_STAT_CONNECTION)
3580 break;
3581 if (!port_is_power_on(hub, *portstatus)) {
3582 status = -ENODEV;
3583 break;
3584 }
3585 msleep(20);
3586 delay_ms += 20;
3587 status = hub_port_status(hub, *port1, portstatus, portchange);
3588 }
3589 dev_dbg(&udev->dev, "Waited %dms for CONNECT\n", delay_ms);
3590 return status;
3591}
3592
3593/*
3594 * usb_port_resume - re-activate a suspended usb device's upstream port
3595 * @udev: device to re-activate, not a root hub
3596 * Context: must be able to sleep; device not locked; pm locks held
3597 *
3598 * This will re-activate the suspended device, increasing power usage
3599 * while letting drivers communicate again with its endpoints.
3600 * USB resume explicitly guarantees that the power session between
3601 * the host and the device is the same as it was when the device
3602 * suspended.
3603 *
3604 * If @udev->reset_resume is set then this routine won't check that the
3605 * port is still enabled. Furthermore, finish_port_resume() above will
3606 * reset @udev. The end result is that a broken power session can be
3607 * recovered and @udev will appear to persist across a loss of VBUS power.
3608 *
3609 * For example, if a host controller doesn't maintain VBUS suspend current
3610 * during a system sleep or is reset when the system wakes up, all the USB
3611 * power sessions below it will be broken. This is especially troublesome
3612 * for mass-storage devices containing mounted filesystems, since the
3613 * device will appear to have disconnected and all the memory mappings
3614 * to it will be lost. Using the USB_PERSIST facility, the device can be
3615 * made to appear as if it had not disconnected.
3616 *
3617 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3618 * every effort to insure that the same device is present after the
3619 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3620 * quite possible for a device to remain unaltered but its media to be
3621 * changed. If the user replaces a flash memory card while the system is
3622 * asleep, he will have only himself to blame when the filesystem on the
3623 * new card is corrupted and the system crashes.
3624 *
3625 * Returns 0 on success, else negative errno.
3626 */
3627int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3628{
3629 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3630 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3631 int port1 = udev->portnum;
3632 int status;
3633 u16 portchange, portstatus;
3634
3635 if (!test_and_set_bit(port1, hub->child_usage_bits)) {
3636 status = pm_runtime_resume_and_get(&port_dev->dev);
3637 if (status < 0) {
3638 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3639 status);
3640 return status;
3641 }
3642 }
3643
3644 usb_lock_port(port_dev);
3645
3646 /* Skip the initial Clear-Suspend step for a remote wakeup */
3647 status = hub_port_status(hub, port1, &portstatus, &portchange);
3648 if (status == 0 && !port_is_suspended(hub, portstatus)) {
3649 if (portchange & USB_PORT_STAT_C_SUSPEND)
3650 pm_wakeup_event(&udev->dev, 0);
3651 goto SuspendCleared;
3652 }
3653
3654 /* see 7.1.7.7; affects power usage, but not budgeting */
3655 if (hub_is_superspeed(hub->hdev))
3656 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3657 else
3658 status = usb_clear_port_feature(hub->hdev,
3659 port1, USB_PORT_FEAT_SUSPEND);
3660 if (status) {
3661 dev_dbg(&port_dev->dev, "can't resume, status %d\n", status);
3662 } else {
3663 /* drive resume for USB_RESUME_TIMEOUT msec */
3664 dev_dbg(&udev->dev, "usb %sresume\n",
3665 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3666 msleep(USB_RESUME_TIMEOUT);
3667
3668 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3669 * stop resume signaling. Then finish the resume
3670 * sequence.
3671 */
3672 status = hub_port_status(hub, port1, &portstatus, &portchange);
3673 }
3674
3675 SuspendCleared:
3676 if (status == 0) {
3677 udev->port_is_suspended = 0;
3678 if (hub_is_superspeed(hub->hdev)) {
3679 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3680 usb_clear_port_feature(hub->hdev, port1,
3681 USB_PORT_FEAT_C_PORT_LINK_STATE);
3682 } else {
3683 if (portchange & USB_PORT_STAT_C_SUSPEND)
3684 usb_clear_port_feature(hub->hdev, port1,
3685 USB_PORT_FEAT_C_SUSPEND);
3686 }
3687
3688 /* TRSMRCY = 10 msec */
3689 msleep(10);
3690 }
3691
3692 if (udev->persist_enabled)
3693 status = wait_for_connected(udev, hub, &port1, &portchange,
3694 &portstatus);
3695
3696 status = check_port_resume_type(udev,
3697 hub, port1, status, portchange, portstatus);
3698 if (status == 0)
3699 status = finish_port_resume(udev);
3700 if (status < 0) {
3701 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3702 hub_port_logical_disconnect(hub, port1);
3703 } else {
3704 /* Try to enable USB2 hardware LPM */
3705 usb_enable_usb2_hardware_lpm(udev);
3706
3707 /* Try to enable USB3 LTM */
3708 usb_enable_ltm(udev);
3709 }
3710
3711 usb_unlock_port(port_dev);
3712
3713 return status;
3714}
3715
3716int usb_remote_wakeup(struct usb_device *udev)
3717{
3718 int status = 0;
3719
3720 usb_lock_device(udev);
3721 if (udev->state == USB_STATE_SUSPENDED) {
3722 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3723 status = usb_autoresume_device(udev);
3724 if (status == 0) {
3725 /* Let the drivers do their thing, then... */
3726 usb_autosuspend_device(udev);
3727 }
3728 }
3729 usb_unlock_device(udev);
3730 return status;
3731}
3732
3733/* Returns 1 if there was a remote wakeup and a connect status change. */
3734static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3735 u16 portstatus, u16 portchange)
3736 __must_hold(&port_dev->status_lock)
3737{
3738 struct usb_port *port_dev = hub->ports[port - 1];
3739 struct usb_device *hdev;
3740 struct usb_device *udev;
3741 int connect_change = 0;
3742 u16 link_state;
3743 int ret;
3744
3745 hdev = hub->hdev;
3746 udev = port_dev->child;
3747 if (!hub_is_superspeed(hdev)) {
3748 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
3749 return 0;
3750 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
3751 } else {
3752 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
3753 if (!udev || udev->state != USB_STATE_SUSPENDED ||
3754 (link_state != USB_SS_PORT_LS_U0 &&
3755 link_state != USB_SS_PORT_LS_U1 &&
3756 link_state != USB_SS_PORT_LS_U2))
3757 return 0;
3758 }
3759
3760 if (udev) {
3761 /* TRSMRCY = 10 msec */
3762 msleep(10);
3763
3764 usb_unlock_port(port_dev);
3765 ret = usb_remote_wakeup(udev);
3766 usb_lock_port(port_dev);
3767 if (ret < 0)
3768 connect_change = 1;
3769 } else {
3770 ret = -ENODEV;
3771 hub_port_disable(hub, port, 1);
3772 }
3773 dev_dbg(&port_dev->dev, "resume, status %d\n", ret);
3774 return connect_change;
3775}
3776
3777static int check_ports_changed(struct usb_hub *hub)
3778{
3779 int port1;
3780
3781 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3782 u16 portstatus, portchange;
3783 int status;
3784
3785 status = hub_port_status(hub, port1, &portstatus, &portchange);
3786 if (!status && portchange)
3787 return 1;
3788 }
3789 return 0;
3790}
3791
3792static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3793{
3794 struct usb_hub *hub = usb_get_intfdata(intf);
3795 struct usb_device *hdev = hub->hdev;
3796 unsigned port1;
3797
3798 /*
3799 * Warn if children aren't already suspended.
3800 * Also, add up the number of wakeup-enabled descendants.
3801 */
3802 hub->wakeup_enabled_descendants = 0;
3803 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3804 struct usb_port *port_dev = hub->ports[port1 - 1];
3805 struct usb_device *udev = port_dev->child;
3806
3807 if (udev && udev->can_submit) {
3808 dev_warn(&port_dev->dev, "device %s not suspended yet\n",
3809 dev_name(&udev->dev));
3810 if (PMSG_IS_AUTO(msg))
3811 return -EBUSY;
3812 }
3813 if (udev)
3814 hub->wakeup_enabled_descendants +=
3815 usb_wakeup_enabled_descendants(udev);
3816 }
3817
3818 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3819 /* check if there are changes pending on hub ports */
3820 if (check_ports_changed(hub)) {
3821 if (PMSG_IS_AUTO(msg))
3822 return -EBUSY;
3823 pm_wakeup_event(&hdev->dev, 2000);
3824 }
3825 }
3826
3827 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3828 /* Enable hub to send remote wakeup for all ports. */
3829 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3830 set_port_feature(hdev,
3831 port1 |
3832 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3833 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3834 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3835 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3836 }
3837 }
3838
3839 dev_dbg(&intf->dev, "%s\n", __func__);
3840
3841 /* stop hub_wq and related activity */
3842 hub_quiesce(hub, HUB_SUSPEND);
3843 return 0;
3844}
3845
3846/* Report wakeup requests from the ports of a resuming root hub */
3847static void report_wakeup_requests(struct usb_hub *hub)
3848{
3849 struct usb_device *hdev = hub->hdev;
3850 struct usb_device *udev;
3851 struct usb_hcd *hcd;
3852 unsigned long resuming_ports;
3853 int i;
3854
3855 if (hdev->parent)
3856 return; /* Not a root hub */
3857
3858 hcd = bus_to_hcd(hdev->bus);
3859 if (hcd->driver->get_resuming_ports) {
3860
3861 /*
3862 * The get_resuming_ports() method returns a bitmap (origin 0)
3863 * of ports which have started wakeup signaling but have not
3864 * yet finished resuming. During system resume we will
3865 * resume all the enabled ports, regardless of any wakeup
3866 * signals, which means the wakeup requests would be lost.
3867 * To prevent this, report them to the PM core here.
3868 */
3869 resuming_ports = hcd->driver->get_resuming_ports(hcd);
3870 for (i = 0; i < hdev->maxchild; ++i) {
3871 if (test_bit(i, &resuming_ports)) {
3872 udev = hub->ports[i]->child;
3873 if (udev)
3874 pm_wakeup_event(&udev->dev, 0);
3875 }
3876 }
3877 }
3878}
3879
3880static int hub_resume(struct usb_interface *intf)
3881{
3882 struct usb_hub *hub = usb_get_intfdata(intf);
3883
3884 dev_dbg(&intf->dev, "%s\n", __func__);
3885 hub_activate(hub, HUB_RESUME);
3886
3887 /*
3888 * This should be called only for system resume, not runtime resume.
3889 * We can't tell the difference here, so some wakeup requests will be
3890 * reported at the wrong time or more than once. This shouldn't
3891 * matter much, so long as they do get reported.
3892 */
3893 report_wakeup_requests(hub);
3894 return 0;
3895}
3896
3897static int hub_reset_resume(struct usb_interface *intf)
3898{
3899 struct usb_hub *hub = usb_get_intfdata(intf);
3900
3901 dev_dbg(&intf->dev, "%s\n", __func__);
3902 hub_activate(hub, HUB_RESET_RESUME);
3903 return 0;
3904}
3905
3906/**
3907 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3908 * @rhdev: struct usb_device for the root hub
3909 *
3910 * The USB host controller driver calls this function when its root hub
3911 * is resumed and Vbus power has been interrupted or the controller
3912 * has been reset. The routine marks @rhdev as having lost power.
3913 * When the hub driver is resumed it will take notice and carry out
3914 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3915 * the others will be disconnected.
3916 */
3917void usb_root_hub_lost_power(struct usb_device *rhdev)
3918{
3919 dev_notice(&rhdev->dev, "root hub lost power or was reset\n");
3920 rhdev->reset_resume = 1;
3921}
3922EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3923
3924static const char * const usb3_lpm_names[] = {
3925 "U0",
3926 "U1",
3927 "U2",
3928 "U3",
3929};
3930
3931/*
3932 * Send a Set SEL control transfer to the device, prior to enabling
3933 * device-initiated U1 or U2. This lets the device know the exit latencies from
3934 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3935 * packet from the host.
3936 *
3937 * This function will fail if the SEL or PEL values for udev are greater than
3938 * the maximum allowed values for the link state to be enabled.
3939 */
3940static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3941{
3942 struct usb_set_sel_req *sel_values;
3943 unsigned long long u1_sel;
3944 unsigned long long u1_pel;
3945 unsigned long long u2_sel;
3946 unsigned long long u2_pel;
3947 int ret;
3948
3949 if (udev->state != USB_STATE_CONFIGURED)
3950 return 0;
3951
3952 /* Convert SEL and PEL stored in ns to us */
3953 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3954 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3955 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3956 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3957
3958 /*
3959 * Make sure that the calculated SEL and PEL values for the link
3960 * state we're enabling aren't bigger than the max SEL/PEL
3961 * value that will fit in the SET SEL control transfer.
3962 * Otherwise the device would get an incorrect idea of the exit
3963 * latency for the link state, and could start a device-initiated
3964 * U1/U2 when the exit latencies are too high.
3965 */
3966 if ((state == USB3_LPM_U1 &&
3967 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3968 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3969 (state == USB3_LPM_U2 &&
3970 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3971 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3972 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3973 usb3_lpm_names[state], u1_sel, u1_pel);
3974 return -EINVAL;
3975 }
3976
3977 /*
3978 * If we're enabling device-initiated LPM for one link state,
3979 * but the other link state has a too high SEL or PEL value,
3980 * just set those values to the max in the Set SEL request.
3981 */
3982 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3983 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3984
3985 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3986 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3987
3988 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3989 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3990
3991 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3992 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3993
3994 /*
3995 * usb_enable_lpm() can be called as part of a failed device reset,
3996 * which may be initiated by an error path of a mass storage driver.
3997 * Therefore, use GFP_NOIO.
3998 */
3999 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
4000 if (!sel_values)
4001 return -ENOMEM;
4002
4003 sel_values->u1_sel = u1_sel;
4004 sel_values->u1_pel = u1_pel;
4005 sel_values->u2_sel = cpu_to_le16(u2_sel);
4006 sel_values->u2_pel = cpu_to_le16(u2_pel);
4007
4008 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4009 USB_REQ_SET_SEL,
4010 USB_RECIP_DEVICE,
4011 0, 0,
4012 sel_values, sizeof *(sel_values),
4013 USB_CTRL_SET_TIMEOUT);
4014 kfree(sel_values);
4015 return ret;
4016}
4017
4018/*
4019 * Enable or disable device-initiated U1 or U2 transitions.
4020 */
4021static int usb_set_device_initiated_lpm(struct usb_device *udev,
4022 enum usb3_link_state state, bool enable)
4023{
4024 int ret;
4025 int feature;
4026
4027 switch (state) {
4028 case USB3_LPM_U1:
4029 feature = USB_DEVICE_U1_ENABLE;
4030 break;
4031 case USB3_LPM_U2:
4032 feature = USB_DEVICE_U2_ENABLE;
4033 break;
4034 default:
4035 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
4036 __func__, enable ? "enable" : "disable");
4037 return -EINVAL;
4038 }
4039
4040 if (udev->state != USB_STATE_CONFIGURED) {
4041 dev_dbg(&udev->dev, "%s: Can't %s %s state "
4042 "for unconfigured device.\n",
4043 __func__, enable ? "enable" : "disable",
4044 usb3_lpm_names[state]);
4045 return 0;
4046 }
4047
4048 if (enable) {
4049 /*
4050 * Now send the control transfer to enable device-initiated LPM
4051 * for either U1 or U2.
4052 */
4053 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4054 USB_REQ_SET_FEATURE,
4055 USB_RECIP_DEVICE,
4056 feature,
4057 0, NULL, 0,
4058 USB_CTRL_SET_TIMEOUT);
4059 } else {
4060 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
4061 USB_REQ_CLEAR_FEATURE,
4062 USB_RECIP_DEVICE,
4063 feature,
4064 0, NULL, 0,
4065 USB_CTRL_SET_TIMEOUT);
4066 }
4067 if (ret < 0) {
4068 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
4069 enable ? "Enable" : "Disable",
4070 usb3_lpm_names[state]);
4071 return -EBUSY;
4072 }
4073 return 0;
4074}
4075
4076static int usb_set_lpm_timeout(struct usb_device *udev,
4077 enum usb3_link_state state, int timeout)
4078{
4079 int ret;
4080 int feature;
4081
4082 switch (state) {
4083 case USB3_LPM_U1:
4084 feature = USB_PORT_FEAT_U1_TIMEOUT;
4085 break;
4086 case USB3_LPM_U2:
4087 feature = USB_PORT_FEAT_U2_TIMEOUT;
4088 break;
4089 default:
4090 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
4091 __func__);
4092 return -EINVAL;
4093 }
4094
4095 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
4096 timeout != USB3_LPM_DEVICE_INITIATED) {
4097 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
4098 "which is a reserved value.\n",
4099 usb3_lpm_names[state], timeout);
4100 return -EINVAL;
4101 }
4102
4103 ret = set_port_feature(udev->parent,
4104 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
4105 feature);
4106 if (ret < 0) {
4107 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
4108 "error code %i\n", usb3_lpm_names[state],
4109 timeout, ret);
4110 return -EBUSY;
4111 }
4112 if (state == USB3_LPM_U1)
4113 udev->u1_params.timeout = timeout;
4114 else
4115 udev->u2_params.timeout = timeout;
4116 return 0;
4117}
4118
4119/*
4120 * Don't allow device intiated U1/U2 if the system exit latency + one bus
4121 * interval is greater than the minimum service interval of any active
4122 * periodic endpoint. See USB 3.2 section 9.4.9
4123 */
4124static bool usb_device_may_initiate_lpm(struct usb_device *udev,
4125 enum usb3_link_state state)
4126{
4127 unsigned int sel; /* us */
4128 int i, j;
4129
4130 if (state == USB3_LPM_U1)
4131 sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
4132 else if (state == USB3_LPM_U2)
4133 sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
4134 else
4135 return false;
4136
4137 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
4138 struct usb_interface *intf;
4139 struct usb_endpoint_descriptor *desc;
4140 unsigned int interval;
4141
4142 intf = udev->actconfig->interface[i];
4143 if (!intf)
4144 continue;
4145
4146 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++) {
4147 desc = &intf->cur_altsetting->endpoint[j].desc;
4148
4149 if (usb_endpoint_xfer_int(desc) ||
4150 usb_endpoint_xfer_isoc(desc)) {
4151 interval = (1 << (desc->bInterval - 1)) * 125;
4152 if (sel + 125 > interval)
4153 return false;
4154 }
4155 }
4156 }
4157 return true;
4158}
4159
4160/*
4161 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
4162 * U1/U2 entry.
4163 *
4164 * We will attempt to enable U1 or U2, but there are no guarantees that the
4165 * control transfers to set the hub timeout or enable device-initiated U1/U2
4166 * will be successful.
4167 *
4168 * If the control transfer to enable device-initiated U1/U2 entry fails, then
4169 * hub-initiated U1/U2 will be disabled.
4170 *
4171 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
4172 * driver know about it. If that call fails, it should be harmless, and just
4173 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
4174 */
4175static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
4176 enum usb3_link_state state)
4177{
4178 int timeout, ret;
4179 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
4180 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
4181
4182 /* If the device says it doesn't have *any* exit latency to come out of
4183 * U1 or U2, it's probably lying. Assume it doesn't implement that link
4184 * state.
4185 */
4186 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
4187 (state == USB3_LPM_U2 && u2_mel == 0))
4188 return;
4189
4190 /*
4191 * First, let the device know about the exit latencies
4192 * associated with the link state we're about to enable.
4193 */
4194 ret = usb_req_set_sel(udev, state);
4195 if (ret < 0) {
4196 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
4197 usb3_lpm_names[state]);
4198 return;
4199 }
4200
4201 /* We allow the host controller to set the U1/U2 timeout internally
4202 * first, so that it can change its schedule to account for the
4203 * additional latency to send data to a device in a lower power
4204 * link state.
4205 */
4206 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
4207
4208 /* xHCI host controller doesn't want to enable this LPM state. */
4209 if (timeout == 0)
4210 return;
4211
4212 if (timeout < 0) {
4213 dev_warn(&udev->dev, "Could not enable %s link state, "
4214 "xHCI error %i.\n", usb3_lpm_names[state],
4215 timeout);
4216 return;
4217 }
4218
4219 if (usb_set_lpm_timeout(udev, state, timeout)) {
4220 /* If we can't set the parent hub U1/U2 timeout,
4221 * device-initiated LPM won't be allowed either, so let the xHCI
4222 * host know that this link state won't be enabled.
4223 */
4224 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4225 return;
4226 }
4227
4228 /* Only a configured device will accept the Set Feature
4229 * U1/U2_ENABLE
4230 */
4231 if (udev->actconfig &&
4232 usb_device_may_initiate_lpm(udev, state)) {
4233 if (usb_set_device_initiated_lpm(udev, state, true)) {
4234 /*
4235 * Request to enable device initiated U1/U2 failed,
4236 * better to turn off lpm in this case.
4237 */
4238 usb_set_lpm_timeout(udev, state, 0);
4239 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
4240 return;
4241 }
4242 }
4243
4244 if (state == USB3_LPM_U1)
4245 udev->usb3_lpm_u1_enabled = 1;
4246 else if (state == USB3_LPM_U2)
4247 udev->usb3_lpm_u2_enabled = 1;
4248}
4249/*
4250 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
4251 * U1/U2 entry.
4252 *
4253 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
4254 * If zero is returned, the parent will not allow the link to go into U1/U2.
4255 *
4256 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
4257 * it won't have an effect on the bus link state because the parent hub will
4258 * still disallow device-initiated U1/U2 entry.
4259 *
4260 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
4261 * possible. The result will be slightly more bus bandwidth will be taken up
4262 * (to account for U1/U2 exit latency), but it should be harmless.
4263 */
4264static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
4265 enum usb3_link_state state)
4266{
4267 switch (state) {
4268 case USB3_LPM_U1:
4269 case USB3_LPM_U2:
4270 break;
4271 default:
4272 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
4273 __func__);
4274 return -EINVAL;
4275 }
4276
4277 if (usb_set_lpm_timeout(udev, state, 0))
4278 return -EBUSY;
4279
4280 usb_set_device_initiated_lpm(udev, state, false);
4281
4282 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
4283 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
4284 "bus schedule bandwidth may be impacted.\n",
4285 usb3_lpm_names[state]);
4286
4287 /* As soon as usb_set_lpm_timeout(0) return 0, hub initiated LPM
4288 * is disabled. Hub will disallows link to enter U1/U2 as well,
4289 * even device is initiating LPM. Hence LPM is disabled if hub LPM
4290 * timeout set to 0, no matter device-initiated LPM is disabled or
4291 * not.
4292 */
4293 if (state == USB3_LPM_U1)
4294 udev->usb3_lpm_u1_enabled = 0;
4295 else if (state == USB3_LPM_U2)
4296 udev->usb3_lpm_u2_enabled = 0;
4297
4298 return 0;
4299}
4300
4301/*
4302 * Disable hub-initiated and device-initiated U1 and U2 entry.
4303 * Caller must own the bandwidth_mutex.
4304 *
4305 * This will call usb_enable_lpm() on failure, which will decrement
4306 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
4307 */
4308int usb_disable_lpm(struct usb_device *udev)
4309{
4310 struct usb_hcd *hcd;
4311
4312 if (!udev || !udev->parent ||
4313 udev->speed < USB_SPEED_SUPER ||
4314 !udev->lpm_capable ||
4315 udev->state < USB_STATE_CONFIGURED)
4316 return 0;
4317
4318 hcd = bus_to_hcd(udev->bus);
4319 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
4320 return 0;
4321
4322 udev->lpm_disable_count++;
4323 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
4324 return 0;
4325
4326 /* If LPM is enabled, attempt to disable it. */
4327 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
4328 goto enable_lpm;
4329 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
4330 goto enable_lpm;
4331
4332 return 0;
4333
4334enable_lpm:
4335 usb_enable_lpm(udev);
4336 return -EBUSY;
4337}
4338EXPORT_SYMBOL_GPL(usb_disable_lpm);
4339
4340/* Grab the bandwidth_mutex before calling usb_disable_lpm() */
4341int usb_unlocked_disable_lpm(struct usb_device *udev)
4342{
4343 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4344 int ret;
4345
4346 if (!hcd)
4347 return -EINVAL;
4348
4349 mutex_lock(hcd->bandwidth_mutex);
4350 ret = usb_disable_lpm(udev);
4351 mutex_unlock(hcd->bandwidth_mutex);
4352
4353 return ret;
4354}
4355EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4356
4357/*
4358 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
4359 * xHCI host policy may prevent U1 or U2 from being enabled.
4360 *
4361 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
4362 * until the lpm_disable_count drops to zero. Caller must own the
4363 * bandwidth_mutex.
4364 */
4365void usb_enable_lpm(struct usb_device *udev)
4366{
4367 struct usb_hcd *hcd;
4368 struct usb_hub *hub;
4369 struct usb_port *port_dev;
4370
4371 if (!udev || !udev->parent ||
4372 udev->speed < USB_SPEED_SUPER ||
4373 !udev->lpm_capable ||
4374 udev->state < USB_STATE_CONFIGURED)
4375 return;
4376
4377 udev->lpm_disable_count--;
4378 hcd = bus_to_hcd(udev->bus);
4379 /* Double check that we can both enable and disable LPM.
4380 * Device must be configured to accept set feature U1/U2 timeout.
4381 */
4382 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
4383 !hcd->driver->disable_usb3_lpm_timeout)
4384 return;
4385
4386 if (udev->lpm_disable_count > 0)
4387 return;
4388
4389 hub = usb_hub_to_struct_hub(udev->parent);
4390 if (!hub)
4391 return;
4392
4393 port_dev = hub->ports[udev->portnum - 1];
4394
4395 if (port_dev->usb3_lpm_u1_permit)
4396 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
4397
4398 if (port_dev->usb3_lpm_u2_permit)
4399 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
4400}
4401EXPORT_SYMBOL_GPL(usb_enable_lpm);
4402
4403/* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4404void usb_unlocked_enable_lpm(struct usb_device *udev)
4405{
4406 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4407
4408 if (!hcd)
4409 return;
4410
4411 mutex_lock(hcd->bandwidth_mutex);
4412 usb_enable_lpm(udev);
4413 mutex_unlock(hcd->bandwidth_mutex);
4414}
4415EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4416
4417/* usb3 devices use U3 for disabled, make sure remote wakeup is disabled */
4418static void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4419 struct usb_port *port_dev)
4420{
4421 struct usb_device *udev = port_dev->child;
4422 int ret;
4423
4424 if (udev && udev->port_is_suspended && udev->do_remote_wakeup) {
4425 ret = hub_set_port_link_state(hub, port_dev->portnum,
4426 USB_SS_PORT_LS_U0);
4427 if (!ret) {
4428 msleep(USB_RESUME_TIMEOUT);
4429 ret = usb_disable_remote_wakeup(udev);
4430 }
4431 if (ret)
4432 dev_warn(&udev->dev,
4433 "Port disable: can't disable remote wake\n");
4434 udev->do_remote_wakeup = 0;
4435 }
4436}
4437
4438#else /* CONFIG_PM */
4439
4440#define hub_suspend NULL
4441#define hub_resume NULL
4442#define hub_reset_resume NULL
4443
4444static inline void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4445 struct usb_port *port_dev) { }
4446
4447int usb_disable_lpm(struct usb_device *udev)
4448{
4449 return 0;
4450}
4451EXPORT_SYMBOL_GPL(usb_disable_lpm);
4452
4453void usb_enable_lpm(struct usb_device *udev) { }
4454EXPORT_SYMBOL_GPL(usb_enable_lpm);
4455
4456int usb_unlocked_disable_lpm(struct usb_device *udev)
4457{
4458 return 0;
4459}
4460EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4461
4462void usb_unlocked_enable_lpm(struct usb_device *udev) { }
4463EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4464
4465int usb_disable_ltm(struct usb_device *udev)
4466{
4467 return 0;
4468}
4469EXPORT_SYMBOL_GPL(usb_disable_ltm);
4470
4471void usb_enable_ltm(struct usb_device *udev) { }
4472EXPORT_SYMBOL_GPL(usb_enable_ltm);
4473
4474static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4475 u16 portstatus, u16 portchange)
4476{
4477 return 0;
4478}
4479
4480#endif /* CONFIG_PM */
4481
4482/*
4483 * USB-3 does not have a similar link state as USB-2 that will avoid negotiating
4484 * a connection with a plugged-in cable but will signal the host when the cable
4485 * is unplugged. Disable remote wake and set link state to U3 for USB-3 devices
4486 */
4487static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
4488{
4489 struct usb_port *port_dev = hub->ports[port1 - 1];
4490 struct usb_device *hdev = hub->hdev;
4491 int ret = 0;
4492
4493 if (!hub->error) {
4494 if (hub_is_superspeed(hub->hdev)) {
4495 hub_usb3_port_prepare_disable(hub, port_dev);
4496 ret = hub_set_port_link_state(hub, port_dev->portnum,
4497 USB_SS_PORT_LS_U3);
4498 } else {
4499 ret = usb_clear_port_feature(hdev, port1,
4500 USB_PORT_FEAT_ENABLE);
4501 }
4502 }
4503 if (port_dev->child && set_state)
4504 usb_set_device_state(port_dev->child, USB_STATE_NOTATTACHED);
4505 if (ret && ret != -ENODEV)
4506 dev_err(&port_dev->dev, "cannot disable (err = %d)\n", ret);
4507 return ret;
4508}
4509
4510/*
4511 * usb_port_disable - disable a usb device's upstream port
4512 * @udev: device to disable
4513 * Context: @udev locked, must be able to sleep.
4514 *
4515 * Disables a USB device that isn't in active use.
4516 */
4517int usb_port_disable(struct usb_device *udev)
4518{
4519 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4520
4521 return hub_port_disable(hub, udev->portnum, 0);
4522}
4523
4524/* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4525 *
4526 * Between connect detection and reset signaling there must be a delay
4527 * of 100ms at least for debounce and power-settling. The corresponding
4528 * timer shall restart whenever the downstream port detects a disconnect.
4529 *
4530 * Apparently there are some bluetooth and irda-dongles and a number of
4531 * low-speed devices for which this debounce period may last over a second.
4532 * Not covered by the spec - but easy to deal with.
4533 *
4534 * This implementation uses a 1500ms total debounce timeout; if the
4535 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4536 * every 25ms for transient disconnects. When the port status has been
4537 * unchanged for 100ms it returns the port status.
4538 */
4539int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
4540{
4541 int ret;
4542 u16 portchange, portstatus;
4543 unsigned connection = 0xffff;
4544 int total_time, stable_time = 0;
4545 struct usb_port *port_dev = hub->ports[port1 - 1];
4546
4547 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
4548 ret = hub_port_status(hub, port1, &portstatus, &portchange);
4549 if (ret < 0)
4550 return ret;
4551
4552 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
4553 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
4554 if (!must_be_connected ||
4555 (connection == USB_PORT_STAT_CONNECTION))
4556 stable_time += HUB_DEBOUNCE_STEP;
4557 if (stable_time >= HUB_DEBOUNCE_STABLE)
4558 break;
4559 } else {
4560 stable_time = 0;
4561 connection = portstatus & USB_PORT_STAT_CONNECTION;
4562 }
4563
4564 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4565 usb_clear_port_feature(hub->hdev, port1,
4566 USB_PORT_FEAT_C_CONNECTION);
4567 }
4568
4569 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
4570 break;
4571 msleep(HUB_DEBOUNCE_STEP);
4572 }
4573
4574 dev_dbg(&port_dev->dev, "debounce total %dms stable %dms status 0x%x\n",
4575 total_time, stable_time, portstatus);
4576
4577 if (stable_time < HUB_DEBOUNCE_STABLE)
4578 return -ETIMEDOUT;
4579 return portstatus;
4580}
4581
4582void usb_ep0_reinit(struct usb_device *udev)
4583{
4584 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
4585 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
4586 usb_enable_endpoint(udev, &udev->ep0, true);
4587}
4588EXPORT_SYMBOL_GPL(usb_ep0_reinit);
4589
4590#define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4591#define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4592
4593static int hub_set_address(struct usb_device *udev, int devnum)
4594{
4595 int retval;
4596 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4597
4598 /*
4599 * The host controller will choose the device address,
4600 * instead of the core having chosen it earlier
4601 */
4602 if (!hcd->driver->address_device && devnum <= 1)
4603 return -EINVAL;
4604 if (udev->state == USB_STATE_ADDRESS)
4605 return 0;
4606 if (udev->state != USB_STATE_DEFAULT)
4607 return -EINVAL;
4608 if (hcd->driver->address_device)
4609 retval = hcd->driver->address_device(hcd, udev);
4610 else
4611 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
4612 USB_REQ_SET_ADDRESS, 0, devnum, 0,
4613 NULL, 0, USB_CTRL_SET_TIMEOUT);
4614 if (retval == 0) {
4615 update_devnum(udev, devnum);
4616 /* Device now using proper address. */
4617 usb_set_device_state(udev, USB_STATE_ADDRESS);
4618 usb_ep0_reinit(udev);
4619 }
4620 return retval;
4621}
4622
4623/*
4624 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4625 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4626 * enabled.
4627 *
4628 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4629 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4630 * support bit in the BOS descriptor.
4631 */
4632static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
4633{
4634 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4635 int connect_type = USB_PORT_CONNECT_TYPE_UNKNOWN;
4636
4637 if (!udev->usb2_hw_lpm_capable || !udev->bos)
4638 return;
4639
4640 if (hub)
4641 connect_type = hub->ports[udev->portnum - 1]->connect_type;
4642
4643 if ((udev->bos->ext_cap->bmAttributes & cpu_to_le32(USB_BESL_SUPPORT)) ||
4644 connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
4645 udev->usb2_hw_lpm_allowed = 1;
4646 usb_enable_usb2_hardware_lpm(udev);
4647 }
4648}
4649
4650static int hub_enable_device(struct usb_device *udev)
4651{
4652 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4653
4654 if (!hcd->driver->enable_device)
4655 return 0;
4656 if (udev->state == USB_STATE_ADDRESS)
4657 return 0;
4658 if (udev->state != USB_STATE_DEFAULT)
4659 return -EINVAL;
4660
4661 return hcd->driver->enable_device(hcd, udev);
4662}
4663
4664/* Reset device, (re)assign address, get device descriptor.
4665 * Device connection must be stable, no more debouncing needed.
4666 * Returns device in USB_STATE_ADDRESS, except on error.
4667 *
4668 * If this is called for an already-existing device (as part of
4669 * usb_reset_and_verify_device), the caller must own the device lock and
4670 * the port lock. For a newly detected device that is not accessible
4671 * through any global pointers, it's not necessary to lock the device,
4672 * but it is still necessary to lock the port.
4673 */
4674static int
4675hub_port_init(struct usb_hub *hub, struct usb_device *udev, int port1,
4676 int retry_counter)
4677{
4678 struct usb_device *hdev = hub->hdev;
4679 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4680 struct usb_port *port_dev = hub->ports[port1 - 1];
4681 int retries, operations, retval, i;
4682 unsigned delay = HUB_SHORT_RESET_TIME;
4683 enum usb_device_speed oldspeed = udev->speed;
4684 const char *speed;
4685 int devnum = udev->devnum;
4686 const char *driver_name;
4687 bool do_new_scheme;
4688
4689 /* root hub ports have a slightly longer reset period
4690 * (from USB 2.0 spec, section 7.1.7.5)
4691 */
4692 if (!hdev->parent) {
4693 delay = HUB_ROOT_RESET_TIME;
4694 if (port1 == hdev->bus->otg_port)
4695 hdev->bus->b_hnp_enable = 0;
4696 }
4697
4698 /* Some low speed devices have problems with the quick delay, so */
4699 /* be a bit pessimistic with those devices. RHbug #23670 */
4700 if (oldspeed == USB_SPEED_LOW)
4701 delay = HUB_LONG_RESET_TIME;
4702
4703 mutex_lock(hcd->address0_mutex);
4704
4705 /* Reset the device; full speed may morph to high speed */
4706 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4707 retval = hub_port_reset(hub, port1, udev, delay, false);
4708 if (retval < 0) /* error or disconnect */
4709 goto fail;
4710 /* success, speed is known */
4711
4712 retval = -ENODEV;
4713
4714 /* Don't allow speed changes at reset, except usb 3.0 to faster */
4715 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed &&
4716 !(oldspeed == USB_SPEED_SUPER && udev->speed > oldspeed)) {
4717 dev_dbg(&udev->dev, "device reset changed speed!\n");
4718 goto fail;
4719 }
4720 oldspeed = udev->speed;
4721
4722 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4723 * it's fixed size except for full speed devices.
4724 * For Wireless USB devices, ep0 max packet is always 512 (tho
4725 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4726 */
4727 switch (udev->speed) {
4728 case USB_SPEED_SUPER_PLUS:
4729 case USB_SPEED_SUPER:
4730 case USB_SPEED_WIRELESS: /* fixed at 512 */
4731 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4732 break;
4733 case USB_SPEED_HIGH: /* fixed at 64 */
4734 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4735 break;
4736 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4737 /* to determine the ep0 maxpacket size, try to read
4738 * the device descriptor to get bMaxPacketSize0 and
4739 * then correct our initial guess.
4740 */
4741 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4742 break;
4743 case USB_SPEED_LOW: /* fixed at 8 */
4744 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4745 break;
4746 default:
4747 goto fail;
4748 }
4749
4750 if (udev->speed == USB_SPEED_WIRELESS)
4751 speed = "variable speed Wireless";
4752 else
4753 speed = usb_speed_string(udev->speed);
4754
4755 /*
4756 * The controller driver may be NULL if the controller device
4757 * is the middle device between platform device and roothub.
4758 * This middle device may not need a device driver due to
4759 * all hardware control can be at platform device driver, this
4760 * platform device is usually a dual-role USB controller device.
4761 */
4762 if (udev->bus->controller->driver)
4763 driver_name = udev->bus->controller->driver->name;
4764 else
4765 driver_name = udev->bus->sysdev->driver->name;
4766
4767 if (udev->speed < USB_SPEED_SUPER)
4768 dev_info(&udev->dev,
4769 "%s %s USB device number %d using %s\n",
4770 (udev->config) ? "reset" : "new", speed,
4771 devnum, driver_name);
4772
4773 /* Set up TT records, if needed */
4774 if (hdev->tt) {
4775 udev->tt = hdev->tt;
4776 udev->ttport = hdev->ttport;
4777 } else if (udev->speed != USB_SPEED_HIGH
4778 && hdev->speed == USB_SPEED_HIGH) {
4779 if (!hub->tt.hub) {
4780 dev_err(&udev->dev, "parent hub has no TT\n");
4781 retval = -EINVAL;
4782 goto fail;
4783 }
4784 udev->tt = &hub->tt;
4785 udev->ttport = port1;
4786 }
4787
4788 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4789 * Because device hardware and firmware is sometimes buggy in
4790 * this area, and this is how Linux has done it for ages.
4791 * Change it cautiously.
4792 *
4793 * NOTE: If use_new_scheme() is true we will start by issuing
4794 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4795 * so it may help with some non-standards-compliant devices.
4796 * Otherwise we start with SET_ADDRESS and then try to read the
4797 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4798 * value.
4799 */
4800 do_new_scheme = use_new_scheme(udev, retry_counter, port_dev);
4801
4802 for (retries = 0; retries < GET_DESCRIPTOR_TRIES; (++retries, msleep(100))) {
4803 if (do_new_scheme) {
4804 struct usb_device_descriptor *buf;
4805 int r = 0;
4806
4807 retval = hub_enable_device(udev);
4808 if (retval < 0) {
4809 dev_err(&udev->dev,
4810 "hub failed to enable device, error %d\n",
4811 retval);
4812 goto fail;
4813 }
4814
4815#define GET_DESCRIPTOR_BUFSIZE 64
4816 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4817 if (!buf) {
4818 retval = -ENOMEM;
4819 continue;
4820 }
4821
4822 /* Retry on all errors; some devices are flakey.
4823 * 255 is for WUSB devices, we actually need to use
4824 * 512 (WUSB1.0[4.8.1]).
4825 */
4826 for (operations = 0; operations < GET_MAXPACKET0_TRIES;
4827 ++operations) {
4828 buf->bMaxPacketSize0 = 0;
4829 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4830 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4831 USB_DT_DEVICE << 8, 0,
4832 buf, GET_DESCRIPTOR_BUFSIZE,
4833 initial_descriptor_timeout);
4834 switch (buf->bMaxPacketSize0) {
4835 case 8: case 16: case 32: case 64: case 255:
4836 if (buf->bDescriptorType ==
4837 USB_DT_DEVICE) {
4838 r = 0;
4839 break;
4840 }
4841 fallthrough;
4842 default:
4843 if (r == 0)
4844 r = -EPROTO;
4845 break;
4846 }
4847 /*
4848 * Some devices time out if they are powered on
4849 * when already connected. They need a second
4850 * reset. But only on the first attempt,
4851 * lest we get into a time out/reset loop
4852 */
4853 if (r == 0 || (r == -ETIMEDOUT &&
4854 retries == 0 &&
4855 udev->speed > USB_SPEED_FULL))
4856 break;
4857 }
4858 udev->descriptor.bMaxPacketSize0 =
4859 buf->bMaxPacketSize0;
4860 kfree(buf);
4861
4862 retval = hub_port_reset(hub, port1, udev, delay, false);
4863 if (retval < 0) /* error or disconnect */
4864 goto fail;
4865 if (oldspeed != udev->speed) {
4866 dev_dbg(&udev->dev,
4867 "device reset changed speed!\n");
4868 retval = -ENODEV;
4869 goto fail;
4870 }
4871 if (r) {
4872 if (r != -ENODEV)
4873 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4874 r);
4875 retval = -EMSGSIZE;
4876 continue;
4877 }
4878#undef GET_DESCRIPTOR_BUFSIZE
4879 }
4880
4881 /*
4882 * If device is WUSB, we already assigned an
4883 * unauthorized address in the Connect Ack sequence;
4884 * authorization will assign the final address.
4885 */
4886 if (udev->wusb == 0) {
4887 for (operations = 0; operations < SET_ADDRESS_TRIES; ++operations) {
4888 retval = hub_set_address(udev, devnum);
4889 if (retval >= 0)
4890 break;
4891 msleep(200);
4892 }
4893 if (retval < 0) {
4894 if (retval != -ENODEV)
4895 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4896 devnum, retval);
4897 goto fail;
4898 }
4899 if (udev->speed >= USB_SPEED_SUPER) {
4900 devnum = udev->devnum;
4901 dev_info(&udev->dev,
4902 "%s SuperSpeed%s%s USB device number %d using %s\n",
4903 (udev->config) ? "reset" : "new",
4904 (udev->speed == USB_SPEED_SUPER_PLUS) ?
4905 " Plus" : "",
4906 (udev->ssp_rate == USB_SSP_GEN_2x2) ?
4907 " Gen 2x2" :
4908 (udev->ssp_rate == USB_SSP_GEN_2x1) ?
4909 " Gen 2x1" :
4910 (udev->ssp_rate == USB_SSP_GEN_1x2) ?
4911 " Gen 1x2" : "",
4912 devnum, driver_name);
4913 }
4914
4915 /* cope with hardware quirkiness:
4916 * - let SET_ADDRESS settle, some device hardware wants it
4917 * - read ep0 maxpacket even for high and low speed,
4918 */
4919 msleep(10);
4920 if (do_new_scheme)
4921 break;
4922 }
4923
4924 retval = usb_get_device_descriptor(udev, 8);
4925 if (retval < 8) {
4926 if (retval != -ENODEV)
4927 dev_err(&udev->dev,
4928 "device descriptor read/8, error %d\n",
4929 retval);
4930 if (retval >= 0)
4931 retval = -EMSGSIZE;
4932 } else {
4933 u32 delay;
4934
4935 retval = 0;
4936
4937 delay = udev->parent->hub_delay;
4938 udev->hub_delay = min_t(u32, delay,
4939 USB_TP_TRANSMISSION_DELAY_MAX);
4940 retval = usb_set_isoch_delay(udev);
4941 if (retval) {
4942 dev_dbg(&udev->dev,
4943 "Failed set isoch delay, error %d\n",
4944 retval);
4945 retval = 0;
4946 }
4947 break;
4948 }
4949 }
4950 if (retval)
4951 goto fail;
4952
4953 /*
4954 * Some superspeed devices have finished the link training process
4955 * and attached to a superspeed hub port, but the device descriptor
4956 * got from those devices show they aren't superspeed devices. Warm
4957 * reset the port attached by the devices can fix them.
4958 */
4959 if ((udev->speed >= USB_SPEED_SUPER) &&
4960 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4961 dev_err(&udev->dev, "got a wrong device descriptor, "
4962 "warm reset device\n");
4963 hub_port_reset(hub, port1, udev,
4964 HUB_BH_RESET_TIME, true);
4965 retval = -EINVAL;
4966 goto fail;
4967 }
4968
4969 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4970 udev->speed >= USB_SPEED_SUPER)
4971 i = 512;
4972 else
4973 i = udev->descriptor.bMaxPacketSize0;
4974 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4975 if (udev->speed == USB_SPEED_LOW ||
4976 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4977 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4978 retval = -EMSGSIZE;
4979 goto fail;
4980 }
4981 if (udev->speed == USB_SPEED_FULL)
4982 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4983 else
4984 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4985 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4986 usb_ep0_reinit(udev);
4987 }
4988
4989 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4990 if (retval < (signed)sizeof(udev->descriptor)) {
4991 if (retval != -ENODEV)
4992 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4993 retval);
4994 if (retval >= 0)
4995 retval = -ENOMSG;
4996 goto fail;
4997 }
4998
4999 usb_detect_quirks(udev);
5000
5001 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
5002 retval = usb_get_bos_descriptor(udev);
5003 if (!retval) {
5004 udev->lpm_capable = usb_device_supports_lpm(udev);
5005 usb_set_lpm_parameters(udev);
5006 }
5007 }
5008
5009 retval = 0;
5010 /* notify HCD that we have a device connected and addressed */
5011 if (hcd->driver->update_device)
5012 hcd->driver->update_device(hcd, udev);
5013 hub_set_initial_usb2_lpm_policy(udev);
5014fail:
5015 if (retval) {
5016 hub_port_disable(hub, port1, 0);
5017 update_devnum(udev, devnum); /* for disconnect processing */
5018 }
5019 mutex_unlock(hcd->address0_mutex);
5020 return retval;
5021}
5022
5023static void
5024check_highspeed(struct usb_hub *hub, struct usb_device *udev, int port1)
5025{
5026 struct usb_qualifier_descriptor *qual;
5027 int status;
5028
5029 if (udev->quirks & USB_QUIRK_DEVICE_QUALIFIER)
5030 return;
5031
5032 qual = kmalloc(sizeof *qual, GFP_KERNEL);
5033 if (qual == NULL)
5034 return;
5035
5036 status = usb_get_descriptor(udev, USB_DT_DEVICE_QUALIFIER, 0,
5037 qual, sizeof *qual);
5038 if (status == sizeof *qual) {
5039 dev_info(&udev->dev, "not running at top speed; "
5040 "connect to a high speed hub\n");
5041 /* hub LEDs are probably harder to miss than syslog */
5042 if (hub->has_indicators) {
5043 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
5044 queue_delayed_work(system_power_efficient_wq,
5045 &hub->leds, 0);
5046 }
5047 }
5048 kfree(qual);
5049}
5050
5051static unsigned
5052hub_power_remaining(struct usb_hub *hub)
5053{
5054 struct usb_device *hdev = hub->hdev;
5055 int remaining;
5056 int port1;
5057
5058 if (!hub->limited_power)
5059 return 0;
5060
5061 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
5062 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
5063 struct usb_port *port_dev = hub->ports[port1 - 1];
5064 struct usb_device *udev = port_dev->child;
5065 unsigned unit_load;
5066 int delta;
5067
5068 if (!udev)
5069 continue;
5070 if (hub_is_superspeed(udev))
5071 unit_load = 150;
5072 else
5073 unit_load = 100;
5074
5075 /*
5076 * Unconfigured devices may not use more than one unit load,
5077 * or 8mA for OTG ports
5078 */
5079 if (udev->actconfig)
5080 delta = usb_get_max_power(udev, udev->actconfig);
5081 else if (port1 != udev->bus->otg_port || hdev->parent)
5082 delta = unit_load;
5083 else
5084 delta = 8;
5085 if (delta > hub->mA_per_port)
5086 dev_warn(&port_dev->dev, "%dmA is over %umA budget!\n",
5087 delta, hub->mA_per_port);
5088 remaining -= delta;
5089 }
5090 if (remaining < 0) {
5091 dev_warn(hub->intfdev, "%dmA over power budget!\n",
5092 -remaining);
5093 remaining = 0;
5094 }
5095 return remaining;
5096}
5097
5098
5099static int descriptors_changed(struct usb_device *udev,
5100 struct usb_device_descriptor *old_device_descriptor,
5101 struct usb_host_bos *old_bos)
5102{
5103 int changed = 0;
5104 unsigned index;
5105 unsigned serial_len = 0;
5106 unsigned len;
5107 unsigned old_length;
5108 int length;
5109 char *buf;
5110
5111 if (memcmp(&udev->descriptor, old_device_descriptor,
5112 sizeof(*old_device_descriptor)) != 0)
5113 return 1;
5114
5115 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5116 return 1;
5117 if (udev->bos) {
5118 len = le16_to_cpu(udev->bos->desc->wTotalLength);
5119 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
5120 return 1;
5121 if (memcmp(udev->bos->desc, old_bos->desc, len))
5122 return 1;
5123 }
5124
5125 /* Since the idVendor, idProduct, and bcdDevice values in the
5126 * device descriptor haven't changed, we will assume the
5127 * Manufacturer and Product strings haven't changed either.
5128 * But the SerialNumber string could be different (e.g., a
5129 * different flash card of the same brand).
5130 */
5131 if (udev->serial)
5132 serial_len = strlen(udev->serial) + 1;
5133
5134 len = serial_len;
5135 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5136 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5137 len = max(len, old_length);
5138 }
5139
5140 buf = kmalloc(len, GFP_NOIO);
5141 if (!buf)
5142 /* assume the worst */
5143 return 1;
5144
5145 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5146 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5147 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5148 old_length);
5149 if (length != old_length) {
5150 dev_dbg(&udev->dev, "config index %d, error %d\n",
5151 index, length);
5152 changed = 1;
5153 break;
5154 }
5155 if (memcmp(buf, udev->rawdescriptors[index], old_length)
5156 != 0) {
5157 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5158 index,
5159 ((struct usb_config_descriptor *) buf)->
5160 bConfigurationValue);
5161 changed = 1;
5162 break;
5163 }
5164 }
5165
5166 if (!changed && serial_len) {
5167 length = usb_string(udev, udev->descriptor.iSerialNumber,
5168 buf, serial_len);
5169 if (length + 1 != serial_len) {
5170 dev_dbg(&udev->dev, "serial string error %d\n",
5171 length);
5172 changed = 1;
5173 } else if (memcmp(buf, udev->serial, length) != 0) {
5174 dev_dbg(&udev->dev, "serial string changed\n");
5175 changed = 1;
5176 }
5177 }
5178
5179 kfree(buf);
5180 return changed;
5181}
5182
5183static void hub_port_connect(struct usb_hub *hub, int port1, u16 portstatus,
5184 u16 portchange)
5185{
5186 int status = -ENODEV;
5187 int i;
5188 unsigned unit_load;
5189 struct usb_device *hdev = hub->hdev;
5190 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
5191 struct usb_port *port_dev = hub->ports[port1 - 1];
5192 struct usb_device *udev = port_dev->child;
5193 static int unreliable_port = -1;
5194
5195 /* Disconnect any existing devices under this port */
5196 if (udev) {
5197 if (hcd->usb_phy && !hdev->parent)
5198 usb_phy_notify_disconnect(hcd->usb_phy, udev->speed);
5199 usb_disconnect(&port_dev->child);
5200 }
5201
5202 /* We can forget about a "removed" device when there's a physical
5203 * disconnect or the connect status changes.
5204 */
5205 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
5206 (portchange & USB_PORT_STAT_C_CONNECTION))
5207 clear_bit(port1, hub->removed_bits);
5208
5209 if (portchange & (USB_PORT_STAT_C_CONNECTION |
5210 USB_PORT_STAT_C_ENABLE)) {
5211 status = hub_port_debounce_be_stable(hub, port1);
5212 if (status < 0) {
5213 if (status != -ENODEV &&
5214 port1 != unreliable_port &&
5215 printk_ratelimit())
5216 dev_err(&port_dev->dev, "connect-debounce failed\n");
5217 portstatus &= ~USB_PORT_STAT_CONNECTION;
5218 unreliable_port = port1;
5219 } else {
5220 portstatus = status;
5221 }
5222 }
5223
5224 /* Return now if debouncing failed or nothing is connected or
5225 * the device was "removed".
5226 */
5227 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
5228 test_bit(port1, hub->removed_bits)) {
5229
5230 /*
5231 * maybe switch power back on (e.g. root hub was reset)
5232 * but only if the port isn't owned by someone else.
5233 */
5234 if (hub_is_port_power_switchable(hub)
5235 && !port_is_power_on(hub, portstatus)
5236 && !port_dev->port_owner)
5237 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
5238
5239 if (portstatus & USB_PORT_STAT_ENABLE)
5240 goto done;
5241 return;
5242 }
5243 if (hub_is_superspeed(hub->hdev))
5244 unit_load = 150;
5245 else
5246 unit_load = 100;
5247
5248 status = 0;
5249 for (i = 0; i < PORT_INIT_TRIES; i++) {
5250
5251 /* reallocate for each attempt, since references
5252 * to the previous one can escape in various ways
5253 */
5254 udev = usb_alloc_dev(hdev, hdev->bus, port1);
5255 if (!udev) {
5256 dev_err(&port_dev->dev,
5257 "couldn't allocate usb_device\n");
5258 goto done;
5259 }
5260
5261 usb_set_device_state(udev, USB_STATE_POWERED);
5262 udev->bus_mA = hub->mA_per_port;
5263 udev->level = hdev->level + 1;
5264 udev->wusb = hub_is_wusb(hub);
5265
5266 /* Devices connected to SuperSpeed hubs are USB 3.0 or later */
5267 if (hub_is_superspeed(hub->hdev))
5268 udev->speed = USB_SPEED_SUPER;
5269 else
5270 udev->speed = USB_SPEED_UNKNOWN;
5271
5272 choose_devnum(udev);
5273 if (udev->devnum <= 0) {
5274 status = -ENOTCONN; /* Don't retry */
5275 goto loop;
5276 }
5277
5278 /* reset (non-USB 3.0 devices) and get descriptor */
5279 usb_lock_port(port_dev);
5280 status = hub_port_init(hub, udev, port1, i);
5281 usb_unlock_port(port_dev);
5282 if (status < 0)
5283 goto loop;
5284
5285 if (udev->quirks & USB_QUIRK_DELAY_INIT)
5286 msleep(2000);
5287
5288 /* consecutive bus-powered hubs aren't reliable; they can
5289 * violate the voltage drop budget. if the new child has
5290 * a "powered" LED, users should notice we didn't enable it
5291 * (without reading syslog), even without per-port LEDs
5292 * on the parent.
5293 */
5294 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
5295 && udev->bus_mA <= unit_load) {
5296 u16 devstat;
5297
5298 status = usb_get_std_status(udev, USB_RECIP_DEVICE, 0,
5299 &devstat);
5300 if (status) {
5301 dev_dbg(&udev->dev, "get status %d ?\n", status);
5302 goto loop_disable;
5303 }
5304 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
5305 dev_err(&udev->dev,
5306 "can't connect bus-powered hub "
5307 "to this port\n");
5308 if (hub->has_indicators) {
5309 hub->indicator[port1-1] =
5310 INDICATOR_AMBER_BLINK;
5311 queue_delayed_work(
5312 system_power_efficient_wq,
5313 &hub->leds, 0);
5314 }
5315 status = -ENOTCONN; /* Don't retry */
5316 goto loop_disable;
5317 }
5318 }
5319
5320 /* check for devices running slower than they could */
5321 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
5322 && udev->speed == USB_SPEED_FULL
5323 && highspeed_hubs != 0)
5324 check_highspeed(hub, udev, port1);
5325
5326 /* Store the parent's children[] pointer. At this point
5327 * udev becomes globally accessible, although presumably
5328 * no one will look at it until hdev is unlocked.
5329 */
5330 status = 0;
5331
5332 mutex_lock(&usb_port_peer_mutex);
5333
5334 /* We mustn't add new devices if the parent hub has
5335 * been disconnected; we would race with the
5336 * recursively_mark_NOTATTACHED() routine.
5337 */
5338 spin_lock_irq(&device_state_lock);
5339 if (hdev->state == USB_STATE_NOTATTACHED)
5340 status = -ENOTCONN;
5341 else
5342 port_dev->child = udev;
5343 spin_unlock_irq(&device_state_lock);
5344 mutex_unlock(&usb_port_peer_mutex);
5345
5346 /* Run it through the hoops (find a driver, etc) */
5347 if (!status) {
5348 status = usb_new_device(udev);
5349 if (status) {
5350 mutex_lock(&usb_port_peer_mutex);
5351 spin_lock_irq(&device_state_lock);
5352 port_dev->child = NULL;
5353 spin_unlock_irq(&device_state_lock);
5354 mutex_unlock(&usb_port_peer_mutex);
5355 } else {
5356 if (hcd->usb_phy && !hdev->parent)
5357 usb_phy_notify_connect(hcd->usb_phy,
5358 udev->speed);
5359 }
5360 }
5361
5362 if (status)
5363 goto loop_disable;
5364
5365 status = hub_power_remaining(hub);
5366 if (status)
5367 dev_dbg(hub->intfdev, "%dmA power budget left\n", status);
5368
5369 return;
5370
5371loop_disable:
5372 hub_port_disable(hub, port1, 1);
5373loop:
5374 usb_ep0_reinit(udev);
5375 release_devnum(udev);
5376 hub_free_dev(udev);
5377 usb_put_dev(udev);
5378 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
5379 break;
5380
5381 /* When halfway through our retry count, power-cycle the port */
5382 if (i == (PORT_INIT_TRIES - 1) / 2) {
5383 dev_info(&port_dev->dev, "attempt power cycle\n");
5384 usb_hub_set_port_power(hdev, hub, port1, false);
5385 msleep(2 * hub_power_on_good_delay(hub));
5386 usb_hub_set_port_power(hdev, hub, port1, true);
5387 msleep(hub_power_on_good_delay(hub));
5388 }
5389 }
5390 if (hub->hdev->parent ||
5391 !hcd->driver->port_handed_over ||
5392 !(hcd->driver->port_handed_over)(hcd, port1)) {
5393 if (status != -ENOTCONN && status != -ENODEV)
5394 dev_err(&port_dev->dev,
5395 "unable to enumerate USB device\n");
5396 }
5397
5398done:
5399 hub_port_disable(hub, port1, 1);
5400 if (hcd->driver->relinquish_port && !hub->hdev->parent) {
5401 if (status != -ENOTCONN && status != -ENODEV)
5402 hcd->driver->relinquish_port(hcd, port1);
5403 }
5404}
5405
5406/* Handle physical or logical connection change events.
5407 * This routine is called when:
5408 * a port connection-change occurs;
5409 * a port enable-change occurs (often caused by EMI);
5410 * usb_reset_and_verify_device() encounters changed descriptors (as from
5411 * a firmware download)
5412 * caller already locked the hub
5413 */
5414static void hub_port_connect_change(struct usb_hub *hub, int port1,
5415 u16 portstatus, u16 portchange)
5416 __must_hold(&port_dev->status_lock)
5417{
5418 struct usb_port *port_dev = hub->ports[port1 - 1];
5419 struct usb_device *udev = port_dev->child;
5420 struct usb_device_descriptor descriptor;
5421 int status = -ENODEV;
5422 int retval;
5423
5424 dev_dbg(&port_dev->dev, "status %04x, change %04x, %s\n", portstatus,
5425 portchange, portspeed(hub, portstatus));
5426
5427 if (hub->has_indicators) {
5428 set_port_led(hub, port1, HUB_LED_AUTO);
5429 hub->indicator[port1-1] = INDICATOR_AUTO;
5430 }
5431
5432#ifdef CONFIG_USB_OTG
5433 /* during HNP, don't repeat the debounce */
5434 if (hub->hdev->bus->is_b_host)
5435 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
5436 USB_PORT_STAT_C_ENABLE);
5437#endif
5438
5439 /* Try to resuscitate an existing device */
5440 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
5441 udev->state != USB_STATE_NOTATTACHED) {
5442 if (portstatus & USB_PORT_STAT_ENABLE) {
5443 /*
5444 * USB-3 connections are initialized automatically by
5445 * the hostcontroller hardware. Therefore check for
5446 * changed device descriptors before resuscitating the
5447 * device.
5448 */
5449 descriptor = udev->descriptor;
5450 retval = usb_get_device_descriptor(udev,
5451 sizeof(udev->descriptor));
5452 if (retval < 0) {
5453 dev_dbg(&udev->dev,
5454 "can't read device descriptor %d\n",
5455 retval);
5456 } else {
5457 if (descriptors_changed(udev, &descriptor,
5458 udev->bos)) {
5459 dev_dbg(&udev->dev,
5460 "device descriptor has changed\n");
5461 /* for disconnect() calls */
5462 udev->descriptor = descriptor;
5463 } else {
5464 status = 0; /* Nothing to do */
5465 }
5466 }
5467#ifdef CONFIG_PM
5468 } else if (udev->state == USB_STATE_SUSPENDED &&
5469 udev->persist_enabled) {
5470 /* For a suspended device, treat this as a
5471 * remote wakeup event.
5472 */
5473 usb_unlock_port(port_dev);
5474 status = usb_remote_wakeup(udev);
5475 usb_lock_port(port_dev);
5476#endif
5477 } else {
5478 /* Don't resuscitate */;
5479 }
5480 }
5481 clear_bit(port1, hub->change_bits);
5482
5483 /* successfully revalidated the connection */
5484 if (status == 0)
5485 return;
5486
5487 usb_unlock_port(port_dev);
5488 hub_port_connect(hub, port1, portstatus, portchange);
5489 usb_lock_port(port_dev);
5490}
5491
5492/* Handle notifying userspace about hub over-current events */
5493static void port_over_current_notify(struct usb_port *port_dev)
5494{
5495 char *envp[3];
5496 struct device *hub_dev;
5497 char *port_dev_path;
5498
5499 sysfs_notify(&port_dev->dev.kobj, NULL, "over_current_count");
5500
5501 hub_dev = port_dev->dev.parent;
5502
5503 if (!hub_dev)
5504 return;
5505
5506 port_dev_path = kobject_get_path(&port_dev->dev.kobj, GFP_KERNEL);
5507 if (!port_dev_path)
5508 return;
5509
5510 envp[0] = kasprintf(GFP_KERNEL, "OVER_CURRENT_PORT=%s", port_dev_path);
5511 if (!envp[0])
5512 goto exit_path;
5513
5514 envp[1] = kasprintf(GFP_KERNEL, "OVER_CURRENT_COUNT=%u",
5515 port_dev->over_current_count);
5516 if (!envp[1])
5517 goto exit;
5518
5519 envp[2] = NULL;
5520 kobject_uevent_env(&hub_dev->kobj, KOBJ_CHANGE, envp);
5521
5522 kfree(envp[1]);
5523exit:
5524 kfree(envp[0]);
5525exit_path:
5526 kfree(port_dev_path);
5527}
5528
5529static void port_event(struct usb_hub *hub, int port1)
5530 __must_hold(&port_dev->status_lock)
5531{
5532 int connect_change;
5533 struct usb_port *port_dev = hub->ports[port1 - 1];
5534 struct usb_device *udev = port_dev->child;
5535 struct usb_device *hdev = hub->hdev;
5536 u16 portstatus, portchange;
5537
5538 connect_change = test_bit(port1, hub->change_bits);
5539 clear_bit(port1, hub->event_bits);
5540 clear_bit(port1, hub->wakeup_bits);
5541
5542 if (hub_port_status(hub, port1, &portstatus, &portchange) < 0)
5543 return;
5544
5545 if (portchange & USB_PORT_STAT_C_CONNECTION) {
5546 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_CONNECTION);
5547 connect_change = 1;
5548 }
5549
5550 if (portchange & USB_PORT_STAT_C_ENABLE) {
5551 if (!connect_change)
5552 dev_dbg(&port_dev->dev, "enable change, status %08x\n",
5553 portstatus);
5554 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_ENABLE);
5555
5556 /*
5557 * EM interference sometimes causes badly shielded USB devices
5558 * to be shutdown by the hub, this hack enables them again.
5559 * Works at least with mouse driver.
5560 */
5561 if (!(portstatus & USB_PORT_STAT_ENABLE)
5562 && !connect_change && udev) {
5563 dev_err(&port_dev->dev, "disabled by hub (EMI?), re-enabling...\n");
5564 connect_change = 1;
5565 }
5566 }
5567
5568 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
5569 u16 status = 0, unused;
5570 port_dev->over_current_count++;
5571 port_over_current_notify(port_dev);
5572
5573 dev_dbg(&port_dev->dev, "over-current change #%u\n",
5574 port_dev->over_current_count);
5575 usb_clear_port_feature(hdev, port1,
5576 USB_PORT_FEAT_C_OVER_CURRENT);
5577 msleep(100); /* Cool down */
5578 hub_power_on(hub, true);
5579 hub_port_status(hub, port1, &status, &unused);
5580 if (status & USB_PORT_STAT_OVERCURRENT)
5581 dev_err(&port_dev->dev, "over-current condition\n");
5582 }
5583
5584 if (portchange & USB_PORT_STAT_C_RESET) {
5585 dev_dbg(&port_dev->dev, "reset change\n");
5586 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_RESET);
5587 }
5588 if ((portchange & USB_PORT_STAT_C_BH_RESET)
5589 && hub_is_superspeed(hdev)) {
5590 dev_dbg(&port_dev->dev, "warm reset change\n");
5591 usb_clear_port_feature(hdev, port1,
5592 USB_PORT_FEAT_C_BH_PORT_RESET);
5593 }
5594 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
5595 dev_dbg(&port_dev->dev, "link state change\n");
5596 usb_clear_port_feature(hdev, port1,
5597 USB_PORT_FEAT_C_PORT_LINK_STATE);
5598 }
5599 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
5600 dev_warn(&port_dev->dev, "config error\n");
5601 usb_clear_port_feature(hdev, port1,
5602 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
5603 }
5604
5605 /* skip port actions that require the port to be powered on */
5606 if (!pm_runtime_active(&port_dev->dev))
5607 return;
5608
5609 if (hub_handle_remote_wakeup(hub, port1, portstatus, portchange))
5610 connect_change = 1;
5611
5612 /*
5613 * Warm reset a USB3 protocol port if it's in
5614 * SS.Inactive state.
5615 */
5616 if (hub_port_warm_reset_required(hub, port1, portstatus)) {
5617 dev_dbg(&port_dev->dev, "do warm reset\n");
5618 if (!udev || !(portstatus & USB_PORT_STAT_CONNECTION)
5619 || udev->state == USB_STATE_NOTATTACHED) {
5620 if (hub_port_reset(hub, port1, NULL,
5621 HUB_BH_RESET_TIME, true) < 0)
5622 hub_port_disable(hub, port1, 1);
5623 } else {
5624 usb_unlock_port(port_dev);
5625 usb_lock_device(udev);
5626 usb_reset_device(udev);
5627 usb_unlock_device(udev);
5628 usb_lock_port(port_dev);
5629 connect_change = 0;
5630 }
5631 }
5632
5633 if (connect_change)
5634 hub_port_connect_change(hub, port1, portstatus, portchange);
5635}
5636
5637static void hub_event(struct work_struct *work)
5638{
5639 struct usb_device *hdev;
5640 struct usb_interface *intf;
5641 struct usb_hub *hub;
5642 struct device *hub_dev;
5643 u16 hubstatus;
5644 u16 hubchange;
5645 int i, ret;
5646
5647 hub = container_of(work, struct usb_hub, events);
5648 hdev = hub->hdev;
5649 hub_dev = hub->intfdev;
5650 intf = to_usb_interface(hub_dev);
5651
5652 kcov_remote_start_usb((u64)hdev->bus->busnum);
5653
5654 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
5655 hdev->state, hdev->maxchild,
5656 /* NOTE: expects max 15 ports... */
5657 (u16) hub->change_bits[0],
5658 (u16) hub->event_bits[0]);
5659
5660 /* Lock the device, then check to see if we were
5661 * disconnected while waiting for the lock to succeed. */
5662 usb_lock_device(hdev);
5663 if (unlikely(hub->disconnected))
5664 goto out_hdev_lock;
5665
5666 /* If the hub has died, clean up after it */
5667 if (hdev->state == USB_STATE_NOTATTACHED) {
5668 hub->error = -ENODEV;
5669 hub_quiesce(hub, HUB_DISCONNECT);
5670 goto out_hdev_lock;
5671 }
5672
5673 /* Autoresume */
5674 ret = usb_autopm_get_interface(intf);
5675 if (ret) {
5676 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
5677 goto out_hdev_lock;
5678 }
5679
5680 /* If this is an inactive hub, do nothing */
5681 if (hub->quiescing)
5682 goto out_autopm;
5683
5684 if (hub->error) {
5685 dev_dbg(hub_dev, "resetting for error %d\n", hub->error);
5686
5687 ret = usb_reset_device(hdev);
5688 if (ret) {
5689 dev_dbg(hub_dev, "error resetting hub: %d\n", ret);
5690 goto out_autopm;
5691 }
5692
5693 hub->nerrors = 0;
5694 hub->error = 0;
5695 }
5696
5697 /* deal with port status changes */
5698 for (i = 1; i <= hdev->maxchild; i++) {
5699 struct usb_port *port_dev = hub->ports[i - 1];
5700
5701 if (test_bit(i, hub->event_bits)
5702 || test_bit(i, hub->change_bits)
5703 || test_bit(i, hub->wakeup_bits)) {
5704 /*
5705 * The get_noresume and barrier ensure that if
5706 * the port was in the process of resuming, we
5707 * flush that work and keep the port active for
5708 * the duration of the port_event(). However,
5709 * if the port is runtime pm suspended
5710 * (powered-off), we leave it in that state, run
5711 * an abbreviated port_event(), and move on.
5712 */
5713 pm_runtime_get_noresume(&port_dev->dev);
5714 pm_runtime_barrier(&port_dev->dev);
5715 usb_lock_port(port_dev);
5716 port_event(hub, i);
5717 usb_unlock_port(port_dev);
5718 pm_runtime_put_sync(&port_dev->dev);
5719 }
5720 }
5721
5722 /* deal with hub status changes */
5723 if (test_and_clear_bit(0, hub->event_bits) == 0)
5724 ; /* do nothing */
5725 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
5726 dev_err(hub_dev, "get_hub_status failed\n");
5727 else {
5728 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
5729 dev_dbg(hub_dev, "power change\n");
5730 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
5731 if (hubstatus & HUB_STATUS_LOCAL_POWER)
5732 /* FIXME: Is this always true? */
5733 hub->limited_power = 1;
5734 else
5735 hub->limited_power = 0;
5736 }
5737 if (hubchange & HUB_CHANGE_OVERCURRENT) {
5738 u16 status = 0;
5739 u16 unused;
5740
5741 dev_dbg(hub_dev, "over-current change\n");
5742 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
5743 msleep(500); /* Cool down */
5744 hub_power_on(hub, true);
5745 hub_hub_status(hub, &status, &unused);
5746 if (status & HUB_STATUS_OVERCURRENT)
5747 dev_err(hub_dev, "over-current condition\n");
5748 }
5749 }
5750
5751out_autopm:
5752 /* Balance the usb_autopm_get_interface() above */
5753 usb_autopm_put_interface_no_suspend(intf);
5754out_hdev_lock:
5755 usb_unlock_device(hdev);
5756
5757 /* Balance the stuff in kick_hub_wq() and allow autosuspend */
5758 usb_autopm_put_interface(intf);
5759 kref_put(&hub->kref, hub_release);
5760
5761 kcov_remote_stop();
5762}
5763
5764static const struct usb_device_id hub_id_table[] = {
5765 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5766 | USB_DEVICE_ID_MATCH_PRODUCT
5767 | USB_DEVICE_ID_MATCH_INT_CLASS,
5768 .idVendor = USB_VENDOR_SMSC,
5769 .idProduct = USB_PRODUCT_USB5534B,
5770 .bInterfaceClass = USB_CLASS_HUB,
5771 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5772 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5773 | USB_DEVICE_ID_MATCH_PRODUCT,
5774 .idVendor = USB_VENDOR_CYPRESS,
5775 .idProduct = USB_PRODUCT_CY7C65632,
5776 .driver_info = HUB_QUIRK_DISABLE_AUTOSUSPEND},
5777 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5778 | USB_DEVICE_ID_MATCH_INT_CLASS,
5779 .idVendor = USB_VENDOR_GENESYS_LOGIC,
5780 .bInterfaceClass = USB_CLASS_HUB,
5781 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
5782 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
5783 .bDeviceClass = USB_CLASS_HUB},
5784 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
5785 .bInterfaceClass = USB_CLASS_HUB},
5786 { } /* Terminating entry */
5787};
5788
5789MODULE_DEVICE_TABLE(usb, hub_id_table);
5790
5791static struct usb_driver hub_driver = {
5792 .name = "hub",
5793 .probe = hub_probe,
5794 .disconnect = hub_disconnect,
5795 .suspend = hub_suspend,
5796 .resume = hub_resume,
5797 .reset_resume = hub_reset_resume,
5798 .pre_reset = hub_pre_reset,
5799 .post_reset = hub_post_reset,
5800 .unlocked_ioctl = hub_ioctl,
5801 .id_table = hub_id_table,
5802 .supports_autosuspend = 1,
5803};
5804
5805int usb_hub_init(void)
5806{
5807 if (usb_register(&hub_driver) < 0) {
5808 printk(KERN_ERR "%s: can't register hub driver\n",
5809 usbcore_name);
5810 return -1;
5811 }
5812
5813 /*
5814 * The workqueue needs to be freezable to avoid interfering with
5815 * USB-PERSIST port handover. Otherwise it might see that a full-speed
5816 * device was gone before the EHCI controller had handed its port
5817 * over to the companion full-speed controller.
5818 */
5819 hub_wq = alloc_workqueue("usb_hub_wq", WQ_FREEZABLE, 0);
5820 if (hub_wq)
5821 return 0;
5822
5823 /* Fall through if kernel_thread failed */
5824 usb_deregister(&hub_driver);
5825 pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name);
5826
5827 return -1;
5828}
5829
5830void usb_hub_cleanup(void)
5831{
5832 destroy_workqueue(hub_wq);
5833
5834 /*
5835 * Hub resources are freed for us by usb_deregister. It calls
5836 * usb_driver_purge on every device which in turn calls that
5837 * devices disconnect function if it is using this driver.
5838 * The hub_disconnect function takes care of releasing the
5839 * individual hub resources. -greg
5840 */
5841 usb_deregister(&hub_driver);
5842} /* usb_hub_cleanup() */
5843
5844/**
5845 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5846 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5847 *
5848 * WARNING - don't use this routine to reset a composite device
5849 * (one with multiple interfaces owned by separate drivers)!
5850 * Use usb_reset_device() instead.
5851 *
5852 * Do a port reset, reassign the device's address, and establish its
5853 * former operating configuration. If the reset fails, or the device's
5854 * descriptors change from their values before the reset, or the original
5855 * configuration and altsettings cannot be restored, a flag will be set
5856 * telling hub_wq to pretend the device has been disconnected and then
5857 * re-connected. All drivers will be unbound, and the device will be
5858 * re-enumerated and probed all over again.
5859 *
5860 * Return: 0 if the reset succeeded, -ENODEV if the device has been
5861 * flagged for logical disconnection, or some other negative error code
5862 * if the reset wasn't even attempted.
5863 *
5864 * Note:
5865 * The caller must own the device lock and the port lock, the latter is
5866 * taken by usb_reset_device(). For example, it's safe to use
5867 * usb_reset_device() from a driver probe() routine after downloading
5868 * new firmware. For calls that might not occur during probe(), drivers
5869 * should lock the device using usb_lock_device_for_reset().
5870 *
5871 * Locking exception: This routine may also be called from within an
5872 * autoresume handler. Such usage won't conflict with other tasks
5873 * holding the device lock because these tasks should always call
5874 * usb_autopm_resume_device(), thereby preventing any unwanted
5875 * autoresume. The autoresume handler is expected to have already
5876 * acquired the port lock before calling this routine.
5877 */
5878static int usb_reset_and_verify_device(struct usb_device *udev)
5879{
5880 struct usb_device *parent_hdev = udev->parent;
5881 struct usb_hub *parent_hub;
5882 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
5883 struct usb_device_descriptor descriptor = udev->descriptor;
5884 struct usb_host_bos *bos;
5885 int i, j, ret = 0;
5886 int port1 = udev->portnum;
5887
5888 if (udev->state == USB_STATE_NOTATTACHED ||
5889 udev->state == USB_STATE_SUSPENDED) {
5890 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5891 udev->state);
5892 return -EINVAL;
5893 }
5894
5895 if (!parent_hdev)
5896 return -EISDIR;
5897
5898 parent_hub = usb_hub_to_struct_hub(parent_hdev);
5899
5900 /* Disable USB2 hardware LPM.
5901 * It will be re-enabled by the enumeration process.
5902 */
5903 usb_disable_usb2_hardware_lpm(udev);
5904
5905 /* Disable LPM while we reset the device and reinstall the alt settings.
5906 * Device-initiated LPM, and system exit latency settings are cleared
5907 * when the device is reset, so we have to set them up again.
5908 */
5909 ret = usb_unlocked_disable_lpm(udev);
5910 if (ret) {
5911 dev_err(&udev->dev, "%s Failed to disable LPM\n", __func__);
5912 goto re_enumerate_no_bos;
5913 }
5914
5915 bos = udev->bos;
5916 udev->bos = NULL;
5917
5918 for (i = 0; i < PORT_INIT_TRIES; ++i) {
5919
5920 /* ep0 maxpacket size may change; let the HCD know about it.
5921 * Other endpoints will be handled by re-enumeration. */
5922 usb_ep0_reinit(udev);
5923 ret = hub_port_init(parent_hub, udev, port1, i);
5924 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
5925 break;
5926 }
5927
5928 if (ret < 0)
5929 goto re_enumerate;
5930
5931 /* Device might have changed firmware (DFU or similar) */
5932 if (descriptors_changed(udev, &descriptor, bos)) {
5933 dev_info(&udev->dev, "device firmware changed\n");
5934 udev->descriptor = descriptor; /* for disconnect() calls */
5935 goto re_enumerate;
5936 }
5937
5938 /* Restore the device's previous configuration */
5939 if (!udev->actconfig)
5940 goto done;
5941
5942 mutex_lock(hcd->bandwidth_mutex);
5943 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5944 if (ret < 0) {
5945 dev_warn(&udev->dev,
5946 "Busted HC? Not enough HCD resources for "
5947 "old configuration.\n");
5948 mutex_unlock(hcd->bandwidth_mutex);
5949 goto re_enumerate;
5950 }
5951 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5952 USB_REQ_SET_CONFIGURATION, 0,
5953 udev->actconfig->desc.bConfigurationValue, 0,
5954 NULL, 0, USB_CTRL_SET_TIMEOUT);
5955 if (ret < 0) {
5956 dev_err(&udev->dev,
5957 "can't restore configuration #%d (error=%d)\n",
5958 udev->actconfig->desc.bConfigurationValue, ret);
5959 mutex_unlock(hcd->bandwidth_mutex);
5960 goto re_enumerate;
5961 }
5962 mutex_unlock(hcd->bandwidth_mutex);
5963 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5964
5965 /* Put interfaces back into the same altsettings as before.
5966 * Don't bother to send the Set-Interface request for interfaces
5967 * that were already in altsetting 0; besides being unnecessary,
5968 * many devices can't handle it. Instead just reset the host-side
5969 * endpoint state.
5970 */
5971 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5972 struct usb_host_config *config = udev->actconfig;
5973 struct usb_interface *intf = config->interface[i];
5974 struct usb_interface_descriptor *desc;
5975
5976 desc = &intf->cur_altsetting->desc;
5977 if (desc->bAlternateSetting == 0) {
5978 usb_disable_interface(udev, intf, true);
5979 usb_enable_interface(udev, intf, true);
5980 ret = 0;
5981 } else {
5982 /* Let the bandwidth allocation function know that this
5983 * device has been reset, and it will have to use
5984 * alternate setting 0 as the current alternate setting.
5985 */
5986 intf->resetting_device = 1;
5987 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5988 desc->bAlternateSetting);
5989 intf->resetting_device = 0;
5990 }
5991 if (ret < 0) {
5992 dev_err(&udev->dev, "failed to restore interface %d "
5993 "altsetting %d (error=%d)\n",
5994 desc->bInterfaceNumber,
5995 desc->bAlternateSetting,
5996 ret);
5997 goto re_enumerate;
5998 }
5999 /* Resetting also frees any allocated streams */
6000 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++)
6001 intf->cur_altsetting->endpoint[j].streams = 0;
6002 }
6003
6004done:
6005 /* Now that the alt settings are re-installed, enable LTM and LPM. */
6006 usb_enable_usb2_hardware_lpm(udev);
6007 usb_unlocked_enable_lpm(udev);
6008 usb_enable_ltm(udev);
6009 usb_release_bos_descriptor(udev);
6010 udev->bos = bos;
6011 return 0;
6012
6013re_enumerate:
6014 usb_release_bos_descriptor(udev);
6015 udev->bos = bos;
6016re_enumerate_no_bos:
6017 /* LPM state doesn't matter when we're about to destroy the device. */
6018 hub_port_logical_disconnect(parent_hub, port1);
6019 return -ENODEV;
6020}
6021
6022/**
6023 * usb_reset_device - warn interface drivers and perform a USB port reset
6024 * @udev: device to reset (not in NOTATTACHED state)
6025 *
6026 * Warns all drivers bound to registered interfaces (using their pre_reset
6027 * method), performs the port reset, and then lets the drivers know that
6028 * the reset is over (using their post_reset method).
6029 *
6030 * Return: The same as for usb_reset_and_verify_device().
6031 *
6032 * Note:
6033 * The caller must own the device lock. For example, it's safe to use
6034 * this from a driver probe() routine after downloading new firmware.
6035 * For calls that might not occur during probe(), drivers should lock
6036 * the device using usb_lock_device_for_reset().
6037 *
6038 * If an interface is currently being probed or disconnected, we assume
6039 * its driver knows how to handle resets. For all other interfaces,
6040 * if the driver doesn't have pre_reset and post_reset methods then
6041 * we attempt to unbind it and rebind afterward.
6042 */
6043int usb_reset_device(struct usb_device *udev)
6044{
6045 int ret;
6046 int i;
6047 unsigned int noio_flag;
6048 struct usb_port *port_dev;
6049 struct usb_host_config *config = udev->actconfig;
6050 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
6051
6052 if (udev->state == USB_STATE_NOTATTACHED) {
6053 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
6054 udev->state);
6055 return -EINVAL;
6056 }
6057
6058 if (!udev->parent) {
6059 /* this requires hcd-specific logic; see ohci_restart() */
6060 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
6061 return -EISDIR;
6062 }
6063
6064 port_dev = hub->ports[udev->portnum - 1];
6065
6066 /*
6067 * Don't allocate memory with GFP_KERNEL in current
6068 * context to avoid possible deadlock if usb mass
6069 * storage interface or usbnet interface(iSCSI case)
6070 * is included in current configuration. The easist
6071 * approach is to do it for every device reset,
6072 * because the device 'memalloc_noio' flag may have
6073 * not been set before reseting the usb device.
6074 */
6075 noio_flag = memalloc_noio_save();
6076
6077 /* Prevent autosuspend during the reset */
6078 usb_autoresume_device(udev);
6079
6080 if (config) {
6081 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
6082 struct usb_interface *cintf = config->interface[i];
6083 struct usb_driver *drv;
6084 int unbind = 0;
6085
6086 if (cintf->dev.driver) {
6087 drv = to_usb_driver(cintf->dev.driver);
6088 if (drv->pre_reset && drv->post_reset)
6089 unbind = (drv->pre_reset)(cintf);
6090 else if (cintf->condition ==
6091 USB_INTERFACE_BOUND)
6092 unbind = 1;
6093 if (unbind)
6094 usb_forced_unbind_intf(cintf);
6095 }
6096 }
6097 }
6098
6099 usb_lock_port(port_dev);
6100 ret = usb_reset_and_verify_device(udev);
6101 usb_unlock_port(port_dev);
6102
6103 if (config) {
6104 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
6105 struct usb_interface *cintf = config->interface[i];
6106 struct usb_driver *drv;
6107 int rebind = cintf->needs_binding;
6108
6109 if (!rebind && cintf->dev.driver) {
6110 drv = to_usb_driver(cintf->dev.driver);
6111 if (drv->post_reset)
6112 rebind = (drv->post_reset)(cintf);
6113 else if (cintf->condition ==
6114 USB_INTERFACE_BOUND)
6115 rebind = 1;
6116 if (rebind)
6117 cintf->needs_binding = 1;
6118 }
6119 }
6120
6121 /* If the reset failed, hub_wq will unbind drivers later */
6122 if (ret == 0)
6123 usb_unbind_and_rebind_marked_interfaces(udev);
6124 }
6125
6126 usb_autosuspend_device(udev);
6127 memalloc_noio_restore(noio_flag);
6128 return ret;
6129}
6130EXPORT_SYMBOL_GPL(usb_reset_device);
6131
6132
6133/**
6134 * usb_queue_reset_device - Reset a USB device from an atomic context
6135 * @iface: USB interface belonging to the device to reset
6136 *
6137 * This function can be used to reset a USB device from an atomic
6138 * context, where usb_reset_device() won't work (as it blocks).
6139 *
6140 * Doing a reset via this method is functionally equivalent to calling
6141 * usb_reset_device(), except for the fact that it is delayed to a
6142 * workqueue. This means that any drivers bound to other interfaces
6143 * might be unbound, as well as users from usbfs in user space.
6144 *
6145 * Corner cases:
6146 *
6147 * - Scheduling two resets at the same time from two different drivers
6148 * attached to two different interfaces of the same device is
6149 * possible; depending on how the driver attached to each interface
6150 * handles ->pre_reset(), the second reset might happen or not.
6151 *
6152 * - If the reset is delayed so long that the interface is unbound from
6153 * its driver, the reset will be skipped.
6154 *
6155 * - This function can be called during .probe(). It can also be called
6156 * during .disconnect(), but doing so is pointless because the reset
6157 * will not occur. If you really want to reset the device during
6158 * .disconnect(), call usb_reset_device() directly -- but watch out
6159 * for nested unbinding issues!
6160 */
6161void usb_queue_reset_device(struct usb_interface *iface)
6162{
6163 if (schedule_work(&iface->reset_ws))
6164 usb_get_intf(iface);
6165}
6166EXPORT_SYMBOL_GPL(usb_queue_reset_device);
6167
6168/**
6169 * usb_hub_find_child - Get the pointer of child device
6170 * attached to the port which is specified by @port1.
6171 * @hdev: USB device belonging to the usb hub
6172 * @port1: port num to indicate which port the child device
6173 * is attached to.
6174 *
6175 * USB drivers call this function to get hub's child device
6176 * pointer.
6177 *
6178 * Return: %NULL if input param is invalid and
6179 * child's usb_device pointer if non-NULL.
6180 */
6181struct usb_device *usb_hub_find_child(struct usb_device *hdev,
6182 int port1)
6183{
6184 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6185
6186 if (port1 < 1 || port1 > hdev->maxchild)
6187 return NULL;
6188 return hub->ports[port1 - 1]->child;
6189}
6190EXPORT_SYMBOL_GPL(usb_hub_find_child);
6191
6192void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
6193 struct usb_hub_descriptor *desc)
6194{
6195 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6196 enum usb_port_connect_type connect_type;
6197 int i;
6198
6199 if (!hub)
6200 return;
6201
6202 if (!hub_is_superspeed(hdev)) {
6203 for (i = 1; i <= hdev->maxchild; i++) {
6204 struct usb_port *port_dev = hub->ports[i - 1];
6205
6206 connect_type = port_dev->connect_type;
6207 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
6208 u8 mask = 1 << (i%8);
6209
6210 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
6211 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
6212 desc->u.hs.DeviceRemovable[i/8] |= mask;
6213 }
6214 }
6215 }
6216 } else {
6217 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
6218
6219 for (i = 1; i <= hdev->maxchild; i++) {
6220 struct usb_port *port_dev = hub->ports[i - 1];
6221
6222 connect_type = port_dev->connect_type;
6223 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
6224 u16 mask = 1 << i;
6225
6226 if (!(port_removable & mask)) {
6227 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
6228 port_removable |= mask;
6229 }
6230 }
6231 }
6232
6233 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
6234 }
6235}
6236
6237#ifdef CONFIG_ACPI
6238/**
6239 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
6240 * @hdev: USB device belonging to the usb hub
6241 * @port1: port num of the port
6242 *
6243 * Return: Port's acpi handle if successful, %NULL if params are
6244 * invalid.
6245 */
6246acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
6247 int port1)
6248{
6249 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
6250
6251 if (!hub)
6252 return NULL;
6253
6254 return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);
6255}
6256#endif