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