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