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