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