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