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