blob: 3941df076ccacef0c5d8b41df4ca35cca1ba7ea2 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * USB hub driver.
3 *
4 * (C) Copyright 1999 Linus Torvalds
5 * (C) Copyright 1999 Johannes Erdfelt
6 * (C) Copyright 1999 Gregory P. Smith
7 * (C) Copyright 2001 Brad Hards (bhards@bigpond.net.au)
8 *
9 */
10
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include <linux/kernel.h>
12#include <linux/errno.h>
13#include <linux/module.h>
14#include <linux/moduleparam.h>
15#include <linux/completion.h>
16#include <linux/sched.h>
17#include <linux/list.h>
18#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/ioctl.h>
20#include <linux/usb.h>
21#include <linux/usbdevice_fs.h>
Eric Lescouet27729aa2010-04-24 23:21:52 +020022#include <linux/usb/hcd.h>
Richard Zhao925aa462012-07-11 11:09:28 +080023#include <linux/usb/otg.h>
Phil Dibowitz93362a82010-07-22 00:05:01 +020024#include <linux/usb/quirks.h>
Petr Mladek32a695892014-09-19 17:32:21 +020025#include <linux/workqueue.h>
Arjan van de Ven4186ecf2006-01-11 15:55:29 +010026#include <linux/mutex.h>
Theodore Ts'ob04b3152012-07-04 11:22:20 -040027#include <linux/random.h>
Lan Tianyuad493e52013-01-23 04:26:30 +080028#include <linux/pm_qos.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
Linus Torvalds1da177e2005-04-16 15:20:36 -070030#include <asm/uaccess.h>
31#include <asm/byteorder.h>
32
Lan Tianyu6e30d7c2013-01-11 20:10:38 +080033#include "hub.h"
Peter Chen026f3fc2014-08-19 09:51:53 +080034#include "otg_whitelist.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
Ming Leie6f30de2012-10-24 11:59:24 +080036#define USB_VENDOR_GENESYS_LOGIC 0x05e3
37#define HUB_QUIRK_CHECK_PORT_AUTOSUSPEND 0x01
38
Greg Kroah-Hartmanfa286182012-05-14 09:20:37 -070039/* Protect struct usb_device->state and ->children members
Alan Stern9ad3d6c2005-11-17 17:10:32 -050040 * Note: Both are also protected by ->dev.sem, except that ->state can
Linus Torvalds1da177e2005-04-16 15:20:36 -070041 * change to USB_STATE_NOTATTACHED even when the semaphore isn't held. */
42static DEFINE_SPINLOCK(device_state_lock);
43
Petr Mladek32a695892014-09-19 17:32:21 +020044/* workqueue to process hub events */
45static struct workqueue_struct *hub_wq;
46static void hub_event(struct work_struct *work);
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
Dan Williamsd8521af2014-05-20 18:08:28 -070048/* synchronize hub-port add/remove and peering operations */
49DEFINE_MUTEX(usb_port_peer_mutex);
50
Linus Torvalds1da177e2005-04-16 15:20:36 -070051/* cycle leds on hubs that aren't blinking for attention */
Saurabh Sengara44007a42015-10-26 09:25:36 +053052static bool blinkenlights;
Chase Metzger166b8632015-08-08 01:03:34 -070053module_param(blinkenlights, bool, S_IRUGO);
54MODULE_PARM_DESC(blinkenlights, "true to cycle leds on hubs");
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
56/*
Jaroslav Kyselafd7c5192008-10-10 16:24:45 +020057 * Device SATA8000 FW1.0 from DATAST0R Technology Corp requires about
58 * 10 seconds to send reply for the initial 64-byte descriptor request.
59 */
60/* define initial 64-byte descriptor request timeout in milliseconds */
61static int initial_descriptor_timeout = USB_CTRL_GET_TIMEOUT;
62module_param(initial_descriptor_timeout, int, S_IRUGO|S_IWUSR);
Wu Fengguangb9cef6c2008-12-15 15:32:01 +080063MODULE_PARM_DESC(initial_descriptor_timeout,
64 "initial 64-byte descriptor request timeout in milliseconds "
65 "(default 5000 - 5.0 seconds)");
Jaroslav Kyselafd7c5192008-10-10 16:24:45 +020066
67/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070068 * As of 2.6.10 we introduce a new USB device initialization scheme which
69 * closely resembles the way Windows works. Hopefully it will be compatible
70 * with a wider range of devices than the old scheme. However some previously
71 * working devices may start giving rise to "device not accepting address"
72 * errors; if that happens the user can try the old scheme by adjusting the
73 * following module parameters.
74 *
75 * For maximum flexibility there are two boolean parameters to control the
76 * hub driver's behavior. On the first initialization attempt, if the
77 * "old_scheme_first" parameter is set then the old scheme will be used,
78 * otherwise the new scheme is used. If that fails and "use_both_schemes"
79 * is set, then the driver will make another attempt, using the other scheme.
80 */
Saurabh Sengara44007a42015-10-26 09:25:36 +053081static bool old_scheme_first;
Linus Torvalds1da177e2005-04-16 15:20:36 -070082module_param(old_scheme_first, bool, S_IRUGO | S_IWUSR);
83MODULE_PARM_DESC(old_scheme_first,
84 "start with the old device initialization scheme");
85
Rusty Russell90ab5ee2012-01-13 09:32:20 +103086static bool use_both_schemes = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070087module_param(use_both_schemes, bool, S_IRUGO | S_IWUSR);
88MODULE_PARM_DESC(use_both_schemes,
89 "try the other device initialization scheme if the "
90 "first one fails");
91
Alan Stern32fe0192007-10-10 16:27:07 -040092/* Mutual exclusion for EHCI CF initialization. This interferes with
93 * port reset on some companion controllers.
94 */
95DECLARE_RWSEM(ehci_cf_port_reset_rwsem);
96EXPORT_SYMBOL_GPL(ehci_cf_port_reset_rwsem);
97
Lan Tianyuad493e52013-01-23 04:26:30 +080098#define HUB_DEBOUNCE_TIMEOUT 2000
Alan Stern948fea32008-04-28 11:07:07 -040099#define HUB_DEBOUNCE_STEP 25
100#define HUB_DEBOUNCE_STABLE 100
101
Petr Mladek32a695892014-09-19 17:32:21 +0200102static void hub_release(struct kref *kref);
Ming Lei742120c2008-06-18 22:00:29 +0800103static int usb_reset_and_verify_device(struct usb_device *udev);
Geert Uytterhoeven8ecf70f2016-12-14 15:37:30 +0100104static int hub_port_disable(struct usb_hub *hub, int port1, int set_state);
Ming Lei742120c2008-06-18 22:00:29 +0800105
Sarah Sharp131dec32010-12-06 21:00:19 -0800106static inline char *portspeed(struct usb_hub *hub, int portstatus)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107{
Oliver Neukumd64aab02016-04-20 16:28:09 +0200108 if (hub_is_superspeedplus(hub->hdev))
109 return "10.0 Gb/s";
Sarah Sharp131dec32010-12-06 21:00:19 -0800110 if (hub_is_superspeed(hub->hdev))
111 return "5.0 Gb/s";
Alan Stern288ead42010-03-04 11:32:30 -0500112 if (portstatus & USB_PORT_STAT_HIGH_SPEED)
Matthias Beyer469271f2013-10-10 23:41:27 +0200113 return "480 Mb/s";
Alan Stern288ead42010-03-04 11:32:30 -0500114 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 return "1.5 Mb/s";
116 else
117 return "12 Mb/s";
118}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
120/* Note that hdev or one of its children must be locked! */
Lan Tianyuad493e52013-01-23 04:26:30 +0800121struct usb_hub *usb_hub_to_struct_hub(struct usb_device *hdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122{
Lan Tianyuff823c72012-09-05 13:44:32 +0800123 if (!hdev || !hdev->actconfig || !hdev->maxchild)
Alan Stern251180842009-07-22 14:41:18 -0400124 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 return usb_get_intfdata(hdev->actconfig->interface[0]);
126}
127
Lu Baolu2d2a3162015-06-16 09:08:26 +0800128int usb_device_supports_lpm(struct usb_device *udev)
Sarah Sharpd9b20992012-02-20 08:31:26 -0800129{
Alan Sternad87e032015-12-10 15:27:21 -0500130 /* Some devices have trouble with LPM */
131 if (udev->quirks & USB_QUIRK_NO_LPM)
132 return 0;
133
Sarah Sharpd9b20992012-02-20 08:31:26 -0800134 /* USB 2.1 (and greater) devices indicate LPM support through
135 * their USB 2.0 Extended Capabilities BOS descriptor.
136 */
Rupesh Tatiyaa8425292015-04-14 16:36:55 +0530137 if (udev->speed == USB_SPEED_HIGH || udev->speed == USB_SPEED_FULL) {
Sarah Sharpd9b20992012-02-20 08:31:26 -0800138 if (udev->bos->ext_cap &&
139 (USB_LPM_SUPPORT &
140 le32_to_cpu(udev->bos->ext_cap->bmAttributes)))
141 return 1;
142 return 0;
143 }
Sarah Sharp51e0a012012-02-20 12:02:19 -0800144
Sarah Sharp25cd2882014-01-17 14:15:44 -0800145 /*
146 * According to the USB 3.0 spec, all USB 3.0 devices must support LPM.
147 * However, there are some that don't, and they set the U1/U2 exit
148 * latencies to zero.
Sarah Sharp51e0a012012-02-20 12:02:19 -0800149 */
150 if (!udev->bos->ss_cap) {
Sarah Sharp25cd2882014-01-17 14:15:44 -0800151 dev_info(&udev->dev, "No LPM exit latency info found, disabling LPM.\n");
Sarah Sharp51e0a012012-02-20 12:02:19 -0800152 return 0;
153 }
Sarah Sharp51e0a012012-02-20 12:02:19 -0800154
Sarah Sharp25cd2882014-01-17 14:15:44 -0800155 if (udev->bos->ss_cap->bU1devExitLat == 0 &&
156 udev->bos->ss_cap->bU2DevExitLat == 0) {
157 if (udev->parent)
158 dev_info(&udev->dev, "LPM exit latency is zeroed, disabling LPM.\n");
159 else
160 dev_info(&udev->dev, "We don't know the algorithms for LPM for this host, disabling LPM.\n");
161 return 0;
162 }
163
164 if (!udev->parent || udev->parent->lpm_capable)
165 return 1;
Sarah Sharpd9b20992012-02-20 08:31:26 -0800166 return 0;
167}
168
Sarah Sharp51e0a012012-02-20 12:02:19 -0800169/*
170 * Set the Maximum Exit Latency (MEL) for the host to initiate a transition from
171 * either U1 or U2.
172 */
173static void usb_set_lpm_mel(struct usb_device *udev,
174 struct usb3_lpm_parameters *udev_lpm_params,
175 unsigned int udev_exit_latency,
176 struct usb_hub *hub,
177 struct usb3_lpm_parameters *hub_lpm_params,
178 unsigned int hub_exit_latency)
179{
180 unsigned int total_mel;
181 unsigned int device_mel;
182 unsigned int hub_mel;
183
184 /*
185 * Calculate the time it takes to transition all links from the roothub
186 * to the parent hub into U0. The parent hub must then decode the
187 * packet (hub header decode latency) to figure out which port it was
188 * bound for.
189 *
190 * The Hub Header decode latency is expressed in 0.1us intervals (0x1
191 * means 0.1us). Multiply that by 100 to get nanoseconds.
192 */
193 total_mel = hub_lpm_params->mel +
194 (hub->descriptor->u.ss.bHubHdrDecLat * 100);
195
196 /*
197 * How long will it take to transition the downstream hub's port into
198 * U0? The greater of either the hub exit latency or the device exit
199 * latency.
200 *
201 * The BOS U1/U2 exit latencies are expressed in 1us intervals.
202 * Multiply that by 1000 to get nanoseconds.
203 */
204 device_mel = udev_exit_latency * 1000;
205 hub_mel = hub_exit_latency * 1000;
206 if (device_mel > hub_mel)
207 total_mel += device_mel;
208 else
209 total_mel += hub_mel;
210
211 udev_lpm_params->mel = total_mel;
212}
213
214/*
215 * Set the maximum Device to Host Exit Latency (PEL) for the device to initiate
216 * a transition from either U1 or U2.
217 */
218static void usb_set_lpm_pel(struct usb_device *udev,
219 struct usb3_lpm_parameters *udev_lpm_params,
220 unsigned int udev_exit_latency,
221 struct usb_hub *hub,
222 struct usb3_lpm_parameters *hub_lpm_params,
223 unsigned int hub_exit_latency,
224 unsigned int port_to_port_exit_latency)
225{
226 unsigned int first_link_pel;
227 unsigned int hub_pel;
228
229 /*
230 * First, the device sends an LFPS to transition the link between the
231 * device and the parent hub into U0. The exit latency is the bigger of
232 * the device exit latency or the hub exit latency.
233 */
234 if (udev_exit_latency > hub_exit_latency)
235 first_link_pel = udev_exit_latency * 1000;
236 else
237 first_link_pel = hub_exit_latency * 1000;
238
239 /*
240 * When the hub starts to receive the LFPS, there is a slight delay for
241 * it to figure out that one of the ports is sending an LFPS. Then it
242 * will forward the LFPS to its upstream link. The exit latency is the
243 * delay, plus the PEL that we calculated for this hub.
244 */
245 hub_pel = port_to_port_exit_latency * 1000 + hub_lpm_params->pel;
246
247 /*
248 * According to figure C-7 in the USB 3.0 spec, the PEL for this device
249 * is the greater of the two exit latencies.
250 */
251 if (first_link_pel > hub_pel)
252 udev_lpm_params->pel = first_link_pel;
253 else
254 udev_lpm_params->pel = hub_pel;
255}
256
257/*
258 * Set the System Exit Latency (SEL) to indicate the total worst-case time from
259 * when a device initiates a transition to U0, until when it will receive the
260 * first packet from the host controller.
261 *
262 * Section C.1.5.1 describes the four components to this:
263 * - t1: device PEL
264 * - t2: time for the ERDY to make it from the device to the host.
265 * - t3: a host-specific delay to process the ERDY.
266 * - t4: time for the packet to make it from the host to the device.
267 *
268 * t3 is specific to both the xHCI host and the platform the host is integrated
269 * into. The Intel HW folks have said it's negligible, FIXME if a different
270 * vendor says otherwise.
271 */
272static void usb_set_lpm_sel(struct usb_device *udev,
273 struct usb3_lpm_parameters *udev_lpm_params)
274{
275 struct usb_device *parent;
276 unsigned int num_hubs;
277 unsigned int total_sel;
278
279 /* t1 = device PEL */
280 total_sel = udev_lpm_params->pel;
281 /* How many external hubs are in between the device & the root port. */
282 for (parent = udev->parent, num_hubs = 0; parent->parent;
283 parent = parent->parent)
284 num_hubs++;
285 /* t2 = 2.1us + 250ns * (num_hubs - 1) */
286 if (num_hubs > 0)
287 total_sel += 2100 + 250 * (num_hubs - 1);
288
289 /* t4 = 250ns * num_hubs */
290 total_sel += 250 * num_hubs;
291
292 udev_lpm_params->sel = total_sel;
293}
294
295static void usb_set_lpm_parameters(struct usb_device *udev)
296{
297 struct usb_hub *hub;
298 unsigned int port_to_port_delay;
299 unsigned int udev_u1_del;
300 unsigned int udev_u2_del;
301 unsigned int hub_u1_del;
302 unsigned int hub_u2_del;
303
Mathias Nyman8a1b2722015-12-10 09:59:25 +0200304 if (!udev->lpm_capable || udev->speed < USB_SPEED_SUPER)
Sarah Sharp51e0a012012-02-20 12:02:19 -0800305 return;
306
Lan Tianyuad493e52013-01-23 04:26:30 +0800307 hub = usb_hub_to_struct_hub(udev->parent);
Sarah Sharp51e0a012012-02-20 12:02:19 -0800308 /* It doesn't take time to transition the roothub into U0, since it
309 * doesn't have an upstream link.
310 */
311 if (!hub)
312 return;
313
314 udev_u1_del = udev->bos->ss_cap->bU1devExitLat;
Xenia Ragiadakou4d967992013-08-31 18:09:13 +0300315 udev_u2_del = le16_to_cpu(udev->bos->ss_cap->bU2DevExitLat);
Sarah Sharp51e0a012012-02-20 12:02:19 -0800316 hub_u1_del = udev->parent->bos->ss_cap->bU1devExitLat;
Xenia Ragiadakou4d967992013-08-31 18:09:13 +0300317 hub_u2_del = le16_to_cpu(udev->parent->bos->ss_cap->bU2DevExitLat);
Sarah Sharp51e0a012012-02-20 12:02:19 -0800318
319 usb_set_lpm_mel(udev, &udev->u1_params, udev_u1_del,
320 hub, &udev->parent->u1_params, hub_u1_del);
321
322 usb_set_lpm_mel(udev, &udev->u2_params, udev_u2_del,
323 hub, &udev->parent->u2_params, hub_u2_del);
324
325 /*
326 * Appendix C, section C.2.2.2, says that there is a slight delay from
327 * when the parent hub notices the downstream port is trying to
328 * transition to U0 to when the hub initiates a U0 transition on its
329 * upstream port. The section says the delays are tPort2PortU1EL and
330 * tPort2PortU2EL, but it doesn't define what they are.
331 *
332 * The hub chapter, sections 10.4.2.4 and 10.4.2.5 seem to be talking
333 * about the same delays. Use the maximum delay calculations from those
334 * sections. For U1, it's tHubPort2PortExitLat, which is 1us max. For
335 * U2, it's tHubPort2PortExitLat + U2DevExitLat - U1DevExitLat. I
336 * assume the device exit latencies they are talking about are the hub
337 * exit latencies.
338 *
339 * What do we do if the U2 exit latency is less than the U1 exit
340 * latency? It's possible, although not likely...
341 */
342 port_to_port_delay = 1;
343
344 usb_set_lpm_pel(udev, &udev->u1_params, udev_u1_del,
345 hub, &udev->parent->u1_params, hub_u1_del,
346 port_to_port_delay);
347
348 if (hub_u2_del > hub_u1_del)
349 port_to_port_delay = 1 + hub_u2_del - hub_u1_del;
350 else
351 port_to_port_delay = 1 + hub_u1_del;
352
353 usb_set_lpm_pel(udev, &udev->u2_params, udev_u2_del,
354 hub, &udev->parent->u2_params, hub_u2_del,
355 port_to_port_delay);
356
357 /* Now that we've got PEL, calculate SEL. */
358 usb_set_lpm_sel(udev, &udev->u1_params);
359 usb_set_lpm_sel(udev, &udev->u2_params);
360}
361
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362/* USB 2.0 spec Section 11.24.4.5 */
Johan Hovoldc67e87a2017-05-10 18:18:28 +0200363static int get_hub_descriptor(struct usb_device *hdev,
364 struct usb_hub_descriptor *desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365{
John Youndbe79bb2001-09-17 00:00:00 -0700366 int i, ret, size;
367 unsigned dtype;
368
369 if (hub_is_superspeed(hdev)) {
370 dtype = USB_DT_SS_HUB;
371 size = USB_DT_SS_HUB_SIZE;
372 } else {
373 dtype = USB_DT_HUB;
374 size = sizeof(struct usb_hub_descriptor);
375 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376
377 for (i = 0; i < 3; i++) {
378 ret = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
379 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
Johan Hovoldc67e87a2017-05-10 18:18:28 +0200380 dtype << 8, 0, desc, size,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381 USB_CTRL_GET_TIMEOUT);
Johan Hovold3e4a4e62017-05-10 18:18:27 +0200382 if (hub_is_superspeed(hdev)) {
383 if (ret == size)
384 return ret;
Johan Hovoldc67e87a2017-05-10 18:18:28 +0200385 } else if (ret >= USB_DT_HUB_NONVAR_SIZE + 2) {
386 /* Make sure we have the DeviceRemovable field. */
387 size = USB_DT_HUB_NONVAR_SIZE + desc->bNbrPorts / 8 + 1;
388 if (ret < size)
389 return -EMSGSIZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 return ret;
Johan Hovold3e4a4e62017-05-10 18:18:27 +0200391 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392 }
393 return -EINVAL;
394}
395
396/*
397 * USB 2.0 spec Section 11.24.2.1
398 */
399static int clear_hub_feature(struct usb_device *hdev, int feature)
400{
401 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
402 USB_REQ_CLEAR_FEATURE, USB_RT_HUB, feature, 0, NULL, 0, 1000);
403}
404
405/*
406 * USB 2.0 spec Section 11.24.2.2
407 */
Lan Tianyuad493e52013-01-23 04:26:30 +0800408int usb_clear_port_feature(struct usb_device *hdev, int port1, int feature)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409{
410 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
411 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature, port1,
412 NULL, 0, 1000);
413}
414
415/*
416 * USB 2.0 spec Section 11.24.2.13
417 */
418static int set_port_feature(struct usb_device *hdev, int port1, int feature)
419{
420 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
421 USB_REQ_SET_FEATURE, USB_RT_PORT, feature, port1,
422 NULL, 0, 1000);
423}
424
Dan Williamsd99f6b42014-05-20 18:08:17 -0700425static char *to_led_name(int selector)
426{
427 switch (selector) {
428 case HUB_LED_AMBER:
429 return "amber";
430 case HUB_LED_GREEN:
431 return "green";
432 case HUB_LED_OFF:
433 return "off";
434 case HUB_LED_AUTO:
435 return "auto";
436 default:
437 return "??";
438 }
439}
440
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441/*
442 * USB 2.0 spec Section 11.24.2.7.1.10 and table 11-7
443 * for info about using port indicators
444 */
Dan Williamsd99f6b42014-05-20 18:08:17 -0700445static void set_port_led(struct usb_hub *hub, int port1, int selector)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446{
Dan Williamsd99f6b42014-05-20 18:08:17 -0700447 struct usb_port *port_dev = hub->ports[port1 - 1];
448 int status;
449
450 status = set_port_feature(hub->hdev, (selector << 8) | port1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 USB_PORT_FEAT_INDICATOR);
Dan Williamsd99f6b42014-05-20 18:08:17 -0700452 dev_dbg(&port_dev->dev, "indicator %s status %d\n",
453 to_led_name(selector), status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454}
455
456#define LED_CYCLE_PERIOD ((2*HZ)/3)
457
Chase Metzger166b8632015-08-08 01:03:34 -0700458static void led_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459{
David Howellsc4028952006-11-22 14:57:56 +0000460 struct usb_hub *hub =
461 container_of(work, struct usb_hub, leds.work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 struct usb_device *hdev = hub->hdev;
463 unsigned i;
464 unsigned changed = 0;
465 int cursor = -1;
466
467 if (hdev->state != USB_STATE_CONFIGURED || hub->quiescing)
468 return;
469
Krzysztof Mazur3bbc47d2013-08-22 14:49:40 +0200470 for (i = 0; i < hdev->maxchild; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471 unsigned selector, mode;
472
473 /* 30%-50% duty cycle */
474
475 switch (hub->indicator[i]) {
476 /* cycle marker */
477 case INDICATOR_CYCLE:
478 cursor = i;
479 selector = HUB_LED_AUTO;
480 mode = INDICATOR_AUTO;
481 break;
482 /* blinking green = sw attention */
483 case INDICATOR_GREEN_BLINK:
484 selector = HUB_LED_GREEN;
485 mode = INDICATOR_GREEN_BLINK_OFF;
486 break;
487 case INDICATOR_GREEN_BLINK_OFF:
488 selector = HUB_LED_OFF;
489 mode = INDICATOR_GREEN_BLINK;
490 break;
491 /* blinking amber = hw attention */
492 case INDICATOR_AMBER_BLINK:
493 selector = HUB_LED_AMBER;
494 mode = INDICATOR_AMBER_BLINK_OFF;
495 break;
496 case INDICATOR_AMBER_BLINK_OFF:
497 selector = HUB_LED_OFF;
498 mode = INDICATOR_AMBER_BLINK;
499 break;
500 /* blink green/amber = reserved */
501 case INDICATOR_ALT_BLINK:
502 selector = HUB_LED_GREEN;
503 mode = INDICATOR_ALT_BLINK_OFF;
504 break;
505 case INDICATOR_ALT_BLINK_OFF:
506 selector = HUB_LED_AMBER;
507 mode = INDICATOR_ALT_BLINK;
508 break;
509 default:
510 continue;
511 }
512 if (selector != HUB_LED_AUTO)
513 changed = 1;
514 set_port_led(hub, i + 1, selector);
515 hub->indicator[i] = mode;
516 }
517 if (!changed && blinkenlights) {
518 cursor++;
Krzysztof Mazur3bbc47d2013-08-22 14:49:40 +0200519 cursor %= hdev->maxchild;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 set_port_led(hub, cursor + 1, HUB_LED_GREEN);
521 hub->indicator[cursor] = INDICATOR_CYCLE;
522 changed++;
523 }
524 if (changed)
Shaibal Dutta22f6a0f2014-02-01 19:16:46 -0800525 queue_delayed_work(system_power_efficient_wq,
526 &hub->leds, LED_CYCLE_PERIOD);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527}
528
529/* use a short timeout for hub/port status fetches */
530#define USB_STS_TIMEOUT 1000
531#define USB_STS_RETRIES 5
532
533/*
534 * USB 2.0 spec Section 11.24.2.6
535 */
536static int get_hub_status(struct usb_device *hdev,
537 struct usb_hub_status *data)
538{
539 int i, status = -ETIMEDOUT;
540
Libor Pechacek3824c1d2011-05-20 14:53:25 +0200541 for (i = 0; i < USB_STS_RETRIES &&
542 (status == -ETIMEDOUT || status == -EPIPE); i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
544 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
545 data, sizeof(*data), USB_STS_TIMEOUT);
546 }
547 return status;
548}
549
550/*
551 * USB 2.0 spec Section 11.24.2.7
Mathias Nyman0cdd49a2015-12-10 09:59:29 +0200552 * USB 3.1 takes into use the wValue and wLength fields, spec Section 10.16.2.6
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 */
554static int get_port_status(struct usb_device *hdev, int port1,
Mathias Nyman0cdd49a2015-12-10 09:59:29 +0200555 void *data, u16 value, u16 length)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556{
557 int i, status = -ETIMEDOUT;
558
Libor Pechacek3824c1d2011-05-20 14:53:25 +0200559 for (i = 0; i < USB_STS_RETRIES &&
560 (status == -ETIMEDOUT || status == -EPIPE); i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 status = usb_control_msg(hdev, usb_rcvctrlpipe(hdev, 0),
Mathias Nyman0cdd49a2015-12-10 09:59:29 +0200562 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, value,
563 port1, data, length, USB_STS_TIMEOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564 }
565 return status;
566}
567
Mathias Nyman0cdd49a2015-12-10 09:59:29 +0200568static int hub_ext_port_status(struct usb_hub *hub, int port1, int type,
569 u16 *status, u16 *change, u32 *ext_status)
Alan Stern3eb14912008-03-03 15:15:43 -0500570{
571 int ret;
Mathias Nyman0cdd49a2015-12-10 09:59:29 +0200572 int len = 4;
573
574 if (type != HUB_PORT_STATUS)
575 len = 8;
Alan Stern3eb14912008-03-03 15:15:43 -0500576
577 mutex_lock(&hub->status_mutex);
Mathias Nyman0cdd49a2015-12-10 09:59:29 +0200578 ret = get_port_status(hub->hdev, port1, &hub->status->port, type, len);
579 if (ret < len) {
Alan Sterne9e88fb2013-03-27 16:14:01 -0400580 if (ret != -ENODEV)
581 dev_err(hub->intfdev,
582 "%s failed (err = %d)\n", __func__, ret);
Alan Stern3eb14912008-03-03 15:15:43 -0500583 if (ret >= 0)
584 ret = -EIO;
585 } else {
586 *status = le16_to_cpu(hub->status->port.wPortStatus);
587 *change = le16_to_cpu(hub->status->port.wPortChange);
Mathias Nyman0cdd49a2015-12-10 09:59:29 +0200588 if (type != HUB_PORT_STATUS && ext_status)
589 *ext_status = le32_to_cpu(
590 hub->status->port.dwExtPortStatus);
Alan Stern3eb14912008-03-03 15:15:43 -0500591 ret = 0;
592 }
593 mutex_unlock(&hub->status_mutex);
594 return ret;
595}
596
Mathias Nyman0cdd49a2015-12-10 09:59:29 +0200597static int hub_port_status(struct usb_hub *hub, int port1,
598 u16 *status, u16 *change)
599{
600 return hub_ext_port_status(hub, port1, HUB_PORT_STATUS,
601 status, change, NULL);
602}
603
Petr Mladek32a695892014-09-19 17:32:21 +0200604static void kick_hub_wq(struct usb_hub *hub)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605{
Petr Mladek32a695892014-09-19 17:32:21 +0200606 struct usb_interface *intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607
Petr Mladek32a695892014-09-19 17:32:21 +0200608 if (hub->disconnected || work_pending(&hub->events))
609 return;
Alan Stern8e4ceb32009-12-07 13:01:37 -0500610
Petr Mladek32a695892014-09-19 17:32:21 +0200611 /*
612 * Suppress autosuspend until the event is proceed.
613 *
614 * Be careful and make sure that the symmetric operation is
615 * always called. We are here only when there is no pending
616 * work for this hub. Therefore put the interface either when
617 * the new work is called or when it is canceled.
618 */
619 intf = to_usb_interface(hub->intfdev);
620 usb_autopm_get_interface_no_resume(intf);
621 kref_get(&hub->kref);
622
623 if (queue_work(hub_wq, &hub->events))
624 return;
625
626 /* the work has already been scheduled */
627 usb_autopm_put_interface_async(intf);
628 kref_put(&hub->kref, hub_release);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629}
630
Petr Mladek59d48b32014-09-19 17:32:22 +0200631void usb_kick_hub_wq(struct usb_device *hdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632{
Lan Tianyuad493e52013-01-23 04:26:30 +0800633 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
Alan Stern251180842009-07-22 14:41:18 -0400634
635 if (hub)
Petr Mladek32a695892014-09-19 17:32:21 +0200636 kick_hub_wq(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637}
638
Sarah Sharp4ee823b2011-11-14 18:00:01 -0800639/*
640 * Let the USB core know that a USB 3.0 device has sent a Function Wake Device
641 * Notification, which indicates it had initiated remote wakeup.
642 *
643 * USB 3.0 hubs do not report the port link state change from U3 to U0 when the
644 * device initiates resume, so the USB core will not receive notice of the
645 * resume through the normal hub interrupt URB.
646 */
647void usb_wakeup_notification(struct usb_device *hdev,
648 unsigned int portnum)
649{
650 struct usb_hub *hub;
Ravi Chandra Sadineni00bc3482018-04-20 11:08:21 -0700651 struct usb_port *port_dev;
Sarah Sharp4ee823b2011-11-14 18:00:01 -0800652
653 if (!hdev)
654 return;
655
Lan Tianyuad493e52013-01-23 04:26:30 +0800656 hub = usb_hub_to_struct_hub(hdev);
Sarah Sharp4ee823b2011-11-14 18:00:01 -0800657 if (hub) {
Ravi Chandra Sadineni00bc3482018-04-20 11:08:21 -0700658 port_dev = hub->ports[portnum - 1];
659 if (port_dev && port_dev->child)
660 pm_wakeup_event(&port_dev->child->dev, 0);
661
Sarah Sharp4ee823b2011-11-14 18:00:01 -0800662 set_bit(portnum, hub->wakeup_bits);
Petr Mladek32a695892014-09-19 17:32:21 +0200663 kick_hub_wq(hub);
Sarah Sharp4ee823b2011-11-14 18:00:01 -0800664 }
665}
666EXPORT_SYMBOL_GPL(usb_wakeup_notification);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667
668/* completion function, fires on port status changes and various faults */
David Howells7d12e782006-10-05 14:55:46 +0100669static void hub_irq(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670{
Tobias Klauserec17cf12006-09-13 21:38:41 +0200671 struct usb_hub *hub = urb->context;
Alan Sterne0152682007-08-24 15:42:52 -0400672 int status = urb->status;
Roel Kluin71d27182009-03-13 12:19:18 +0100673 unsigned i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674 unsigned long bits;
675
Alan Sterne0152682007-08-24 15:42:52 -0400676 switch (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 case -ENOENT: /* synchronous unlink */
678 case -ECONNRESET: /* async unlink */
679 case -ESHUTDOWN: /* hardware going away */
680 return;
681
682 default: /* presumably an error */
683 /* Cause a hub reset after 10 consecutive errors */
Chase Metzger166b8632015-08-08 01:03:34 -0700684 dev_dbg(hub->intfdev, "transfer --> %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 if ((++hub->nerrors < 10) || hub->error)
686 goto resubmit;
Alan Sterne0152682007-08-24 15:42:52 -0400687 hub->error = status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688 /* FALL THROUGH */
Tobias Klauserec17cf12006-09-13 21:38:41 +0200689
Petr Mladek37ebb542014-09-19 17:32:23 +0200690 /* let hub_wq handle things */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 case 0: /* we got data: port status changed */
692 bits = 0;
693 for (i = 0; i < urb->actual_length; ++i)
694 bits |= ((unsigned long) ((*hub->buffer)[i]))
695 << (i*8);
696 hub->event_bits[0] = bits;
697 break;
698 }
699
700 hub->nerrors = 0;
701
Petr Mladek37ebb542014-09-19 17:32:23 +0200702 /* Something happened, let hub_wq figure it out */
Petr Mladek32a695892014-09-19 17:32:21 +0200703 kick_hub_wq(hub);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704
705resubmit:
706 if (hub->quiescing)
707 return;
708
Kris Borer088a3da2015-08-11 11:12:45 -0400709 status = usb_submit_urb(hub->urb, GFP_ATOMIC);
710 if (status != 0 && status != -ENODEV && status != -EPERM)
Chase Metzger166b8632015-08-08 01:03:34 -0700711 dev_err(hub->intfdev, "resubmit --> %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712}
713
714/* USB 2.0 spec Section 11.24.2.3 */
715static inline int
Chase Metzger166b8632015-08-08 01:03:34 -0700716hub_clear_tt_buffer(struct usb_device *hdev, u16 devinfo, u16 tt)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717{
William Gulland2c7b8712013-06-27 16:10:20 -0700718 /* Need to clear both directions for control ep */
719 if (((devinfo >> 11) & USB_ENDPOINT_XFERTYPE_MASK) ==
720 USB_ENDPOINT_XFER_CONTROL) {
721 int status = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
722 HUB_CLEAR_TT_BUFFER, USB_RT_PORT,
723 devinfo ^ 0x8000, tt, NULL, 0, 1000);
724 if (status)
725 return status;
726 }
Alan Sternc2f65952009-11-18 11:37:15 -0500727 return usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 HUB_CLEAR_TT_BUFFER, USB_RT_PORT, devinfo,
729 tt, NULL, 0, 1000);
730}
731
732/*
Petr Mladek37ebb542014-09-19 17:32:23 +0200733 * enumeration blocks hub_wq for a long time. we use keventd instead, since
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 * long blocking there is the exception, not the rule. accordingly, HCDs
735 * talking to TTs must queue control transfers (not just bulk and iso), so
736 * both can talk to the same hub concurrently.
737 */
Alan Sterncb88a1b2009-06-29 10:43:32 -0400738static void hub_tt_work(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739{
David Howellsc4028952006-11-22 14:57:56 +0000740 struct usb_hub *hub =
Alan Sterncb88a1b2009-06-29 10:43:32 -0400741 container_of(work, struct usb_hub, tt.clear_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 unsigned long flags;
743
Chase Metzger166b8632015-08-08 01:03:34 -0700744 spin_lock_irqsave(&hub->tt.lock, flags);
Octavian Purdila3b6054d2012-10-01 22:21:12 +0300745 while (!list_empty(&hub->tt.clear_list)) {
H Hartley Sweetend0f830d2009-04-22 16:03:05 -0400746 struct list_head *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747 struct usb_tt_clear *clear;
748 struct usb_device *hdev = hub->hdev;
Alan Sterncb88a1b2009-06-29 10:43:32 -0400749 const struct hc_driver *drv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 int status;
751
H Hartley Sweetend0f830d2009-04-22 16:03:05 -0400752 next = hub->tt.clear_list.next;
Chase Metzger166b8632015-08-08 01:03:34 -0700753 clear = list_entry(next, struct usb_tt_clear, clear_list);
754 list_del(&clear->clear_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755
756 /* drop lock so HCD can concurrently report other TT errors */
Chase Metzger166b8632015-08-08 01:03:34 -0700757 spin_unlock_irqrestore(&hub->tt.lock, flags);
758 status = hub_clear_tt_buffer(hdev, clear->devinfo, clear->tt);
Alan Sterne9e88fb2013-03-27 16:14:01 -0400759 if (status && status != -ENODEV)
Chase Metzger166b8632015-08-08 01:03:34 -0700760 dev_err(&hdev->dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 "clear tt %d (%04x) error %d\n",
762 clear->tt, clear->devinfo, status);
Alan Sterncb88a1b2009-06-29 10:43:32 -0400763
764 /* Tell the HCD, even if the operation failed */
765 drv = clear->hcd->driver;
766 if (drv->clear_tt_buffer_complete)
767 (drv->clear_tt_buffer_complete)(clear->hcd, clear->ep);
768
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -0700769 kfree(clear);
Alan Sterncb88a1b2009-06-29 10:43:32 -0400770 spin_lock_irqsave(&hub->tt.lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 }
Chase Metzger166b8632015-08-08 01:03:34 -0700772 spin_unlock_irqrestore(&hub->tt.lock, flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773}
774
775/**
Lan Tianyu971fcd42013-01-23 04:26:29 +0800776 * usb_hub_set_port_power - control hub port's power state
Mathias Nyman41341262013-06-18 17:28:48 +0300777 * @hdev: USB device belonging to the usb hub
778 * @hub: target hub
Lan Tianyu971fcd42013-01-23 04:26:29 +0800779 * @port1: port index
780 * @set: expected status
781 *
782 * call this function to control port's power via setting or
783 * clearing the port's PORT_POWER feature.
Yacine Belkadi626f0902013-08-02 20:10:04 +0200784 *
785 * Return: 0 if successful. A negative error code otherwise.
Lan Tianyu971fcd42013-01-23 04:26:29 +0800786 */
Mathias Nyman41341262013-06-18 17:28:48 +0300787int usb_hub_set_port_power(struct usb_device *hdev, struct usb_hub *hub,
788 int port1, bool set)
Lan Tianyu971fcd42013-01-23 04:26:29 +0800789{
790 int ret;
791
792 if (set)
793 ret = set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
794 else
Lan Tianyuad493e52013-01-23 04:26:30 +0800795 ret = usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
796
Dan Williamsd5c38342014-05-20 18:08:52 -0700797 if (ret)
798 return ret;
799
800 if (set)
801 set_bit(port1, hub->power_bits);
802 else
803 clear_bit(port1, hub->power_bits);
804 return 0;
Lan Tianyu971fcd42013-01-23 04:26:29 +0800805}
806
807/**
Alan Sterncb88a1b2009-06-29 10:43:32 -0400808 * usb_hub_clear_tt_buffer - clear control/bulk TT state in high speed hub
809 * @urb: an URB associated with the failed or incomplete split transaction
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810 *
811 * High speed HCDs use this to tell the hub driver that some split control or
812 * bulk transaction failed in a way that requires clearing internal state of
813 * a transaction translator. This is normally detected (and reported) from
814 * interrupt context.
815 *
816 * It may not be possible for that hub to handle additional full (or low)
817 * speed transactions until that state is fully cleared out.
Yacine Belkadi626f0902013-08-02 20:10:04 +0200818 *
819 * Return: 0 if successful. A negative error code otherwise.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 */
Alan Sterncb88a1b2009-06-29 10:43:32 -0400821int usb_hub_clear_tt_buffer(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822{
Alan Sterncb88a1b2009-06-29 10:43:32 -0400823 struct usb_device *udev = urb->dev;
824 int pipe = urb->pipe;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 struct usb_tt *tt = udev->tt;
826 unsigned long flags;
827 struct usb_tt_clear *clear;
828
829 /* we've got to cope with an arbitrary number of pending TT clears,
830 * since each TT has "at least two" buffers that can need it (and
831 * there can be many TTs per hub). even if they're uncommon.
832 */
Greg Kroah-Hartmand544d272015-04-30 11:32:53 +0200833 clear = kmalloc(sizeof *clear, GFP_ATOMIC);
834 if (clear == NULL) {
Chase Metzger166b8632015-08-08 01:03:34 -0700835 dev_err(&udev->dev, "can't save CLEAR_TT_BUFFER state\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836 /* FIXME recover somehow ... RESET_TT? */
Alan Sterncb88a1b2009-06-29 10:43:32 -0400837 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838 }
839
840 /* info that CLEAR_TT_BUFFER needs */
841 clear->tt = tt->multi ? udev->ttport : 1;
842 clear->devinfo = usb_pipeendpoint (pipe);
843 clear->devinfo |= udev->devnum << 4;
Chase Metzger166b8632015-08-08 01:03:34 -0700844 clear->devinfo |= usb_pipecontrol(pipe)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700845 ? (USB_ENDPOINT_XFER_CONTROL << 11)
846 : (USB_ENDPOINT_XFER_BULK << 11);
Chase Metzger166b8632015-08-08 01:03:34 -0700847 if (usb_pipein(pipe))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700848 clear->devinfo |= 1 << 15;
Alan Sterncb88a1b2009-06-29 10:43:32 -0400849
850 /* info for completion callback */
851 clear->hcd = bus_to_hcd(udev->bus);
852 clear->ep = urb->ep;
853
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 /* tell keventd to clear state for this TT */
Chase Metzger166b8632015-08-08 01:03:34 -0700855 spin_lock_irqsave(&tt->lock, flags);
856 list_add_tail(&clear->clear_list, &tt->clear_list);
Alan Sterncb88a1b2009-06-29 10:43:32 -0400857 schedule_work(&tt->clear_work);
Chase Metzger166b8632015-08-08 01:03:34 -0700858 spin_unlock_irqrestore(&tt->lock, flags);
Alan Sterncb88a1b2009-06-29 10:43:32 -0400859 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860}
Alan Sterncb88a1b2009-06-29 10:43:32 -0400861EXPORT_SYMBOL_GPL(usb_hub_clear_tt_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700862
Dan Williams7ad3c472014-05-20 18:08:57 -0700863static void hub_power_on(struct usb_hub *hub, bool do_delay)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864{
865 int port1;
866
Alan Stern4489a572006-04-27 15:54:22 -0400867 /* Enable power on each port. Some hubs have reserved values
868 * of LPSM (> 2) in their descriptors, even though they are
869 * USB 2.0 hubs. Some hubs do not implement port-power switching
870 * but only emulate it. In all cases, the ports won't work
871 * unless we send these messages to the hub.
872 */
Dan Williams9262c192014-05-20 18:08:12 -0700873 if (hub_is_port_power_switchable(hub))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874 dev_dbg(hub->intfdev, "enabling power on all ports\n");
Alan Stern4489a572006-04-27 15:54:22 -0400875 else
876 dev_dbg(hub->intfdev, "trying to enable port power on "
877 "non-switchable hub\n");
Krzysztof Mazur3bbc47d2013-08-22 14:49:40 +0200878 for (port1 = 1; port1 <= hub->hdev->maxchild; port1++)
Dan Williamsd5c38342014-05-20 18:08:52 -0700879 if (test_bit(port1, hub->power_bits))
Lan Tianyuad493e52013-01-23 04:26:30 +0800880 set_port_feature(hub->hdev, port1, USB_PORT_FEAT_POWER);
881 else
882 usb_clear_port_feature(hub->hdev, port1,
883 USB_PORT_FEAT_POWER);
Alan Stern8520f382008-09-22 14:44:26 -0400884 if (do_delay)
Dan Williams7ad3c472014-05-20 18:08:57 -0700885 msleep(hub_power_on_good_delay(hub));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886}
887
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888static int hub_hub_status(struct usb_hub *hub,
889 u16 *status, u16 *change)
890{
891 int ret;
892
Alan Sterndb90e7a2007-02-05 09:56:15 -0500893 mutex_lock(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894 ret = get_hub_status(hub->hdev, &hub->status->hub);
Alan Sterne9e88fb2013-03-27 16:14:01 -0400895 if (ret < 0) {
896 if (ret != -ENODEV)
897 dev_err(hub->intfdev,
898 "%s failed (err = %d)\n", __func__, ret);
899 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700900 *status = le16_to_cpu(hub->status->hub.wHubStatus);
Matthias Beyer469271f2013-10-10 23:41:27 +0200901 *change = le16_to_cpu(hub->status->hub.wHubChange);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902 ret = 0;
903 }
Alan Sterndb90e7a2007-02-05 09:56:15 -0500904 mutex_unlock(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905 return ret;
906}
907
Sarah Sharp41e7e052012-11-14 16:42:32 -0800908static int hub_set_port_link_state(struct usb_hub *hub, int port1,
909 unsigned int link_status)
910{
911 return set_port_feature(hub->hdev,
912 port1 | (link_status << 3),
913 USB_PORT_FEAT_LINK_STATE);
914}
915
916/*
Justin P. Mattock6d42fcd2011-02-26 20:33:56 -0800917 * Disable a port and mark a logical connect-change event, so that some
Petr Mladek37ebb542014-09-19 17:32:23 +0200918 * time later hub_wq will disconnect() any existing usb_device on the port
Alan Stern0458d5b2007-05-04 11:52:20 -0400919 * and will re-enumerate if there actually is a device attached.
920 */
921static void hub_port_logical_disconnect(struct usb_hub *hub, int port1)
922{
Dan Williamsd99f6b42014-05-20 18:08:17 -0700923 dev_dbg(&hub->ports[port1 - 1]->dev, "logical disconnect\n");
Alan Stern0458d5b2007-05-04 11:52:20 -0400924 hub_port_disable(hub, port1, 1);
925
926 /* FIXME let caller ask to power down the port:
927 * - some devices won't enumerate without a VBUS power cycle
928 * - SRP saves power that way
929 * - ... new call, TBD ...
930 * That's easy if this hub can switch power per-port, and
Petr Mladek37ebb542014-09-19 17:32:23 +0200931 * hub_wq reactivates the port later (timer, SRP, etc).
Alan Stern0458d5b2007-05-04 11:52:20 -0400932 * Powerdown must be optional, because of reset/DFU.
933 */
934
935 set_bit(port1, hub->change_bits);
Petr Mladek32a695892014-09-19 17:32:21 +0200936 kick_hub_wq(hub);
Alan Stern0458d5b2007-05-04 11:52:20 -0400937}
938
Alan Stern253e0572009-10-27 15:20:13 -0400939/**
940 * usb_remove_device - disable a device's port on its parent hub
941 * @udev: device to be disabled and removed
942 * Context: @udev locked, must be able to sleep.
943 *
Petr Mladek37ebb542014-09-19 17:32:23 +0200944 * After @udev's port has been disabled, hub_wq is notified and it will
Alan Stern253e0572009-10-27 15:20:13 -0400945 * see that the device has been disconnected. When the device is
946 * physically unplugged and something is plugged in, the events will
947 * be received and processed normally.
Yacine Belkadi626f0902013-08-02 20:10:04 +0200948 *
949 * Return: 0 if successful. A negative error code otherwise.
Alan Stern253e0572009-10-27 15:20:13 -0400950 */
951int usb_remove_device(struct usb_device *udev)
952{
953 struct usb_hub *hub;
954 struct usb_interface *intf;
955
956 if (!udev->parent) /* Can't remove a root hub */
957 return -EINVAL;
Lan Tianyuad493e52013-01-23 04:26:30 +0800958 hub = usb_hub_to_struct_hub(udev->parent);
Alan Stern253e0572009-10-27 15:20:13 -0400959 intf = to_usb_interface(hub->intfdev);
960
961 usb_autopm_get_interface(intf);
962 set_bit(udev->portnum, hub->removed_bits);
963 hub_port_logical_disconnect(hub, udev->portnum);
964 usb_autopm_put_interface(intf);
965 return 0;
966}
967
Alan Stern6ee0b272008-04-28 11:06:42 -0400968enum hub_activation_type {
Alan Stern8e4ceb32009-12-07 13:01:37 -0500969 HUB_INIT, HUB_INIT2, HUB_INIT3, /* INITs must come first */
Alan Stern8520f382008-09-22 14:44:26 -0400970 HUB_POST_RESET, HUB_RESUME, HUB_RESET_RESUME,
Alan Stern6ee0b272008-04-28 11:06:42 -0400971};
Alan Stern5e6effa2008-03-03 15:15:51 -0500972
Alan Stern8520f382008-09-22 14:44:26 -0400973static void hub_init_func2(struct work_struct *ws);
974static void hub_init_func3(struct work_struct *ws);
975
Alan Sternf2835212008-04-28 11:07:17 -0400976static void hub_activate(struct usb_hub *hub, enum hub_activation_type type)
Alan Stern5e6effa2008-03-03 15:15:51 -0500977{
978 struct usb_device *hdev = hub->hdev;
Sarah Sharp653a39d2010-12-23 11:12:42 -0800979 struct usb_hcd *hcd;
980 int ret;
Alan Stern5e6effa2008-03-03 15:15:51 -0500981 int port1;
Alan Sternf2835212008-04-28 11:07:17 -0400982 int status;
Alan Stern948fea32008-04-28 11:07:07 -0400983 bool need_debounce_delay = false;
Alan Stern8520f382008-09-22 14:44:26 -0400984 unsigned delay;
985
986 /* Continue a partial initialization */
Alan Sterne50293e2015-12-16 13:32:38 -0500987 if (type == HUB_INIT2 || type == HUB_INIT3) {
Alan Stern07d316a2016-08-05 11:51:30 -0400988 device_lock(&hdev->dev);
Alan Sterne50293e2015-12-16 13:32:38 -0500989
990 /* Was the hub disconnected while we were waiting? */
Alan Sternca5cbc82016-08-05 11:49:45 -0400991 if (hub->disconnected)
992 goto disconnected;
Alan Sterne50293e2015-12-16 13:32:38 -0500993 if (type == HUB_INIT2)
994 goto init2;
Alan Stern8520f382008-09-22 14:44:26 -0400995 goto init3;
Alan Sterne50293e2015-12-16 13:32:38 -0500996 }
997 kref_get(&hub->kref);
Alan Stern5e6effa2008-03-03 15:15:51 -0500998
Elric Fua45aa3b2012-02-18 13:32:27 +0800999 /* The superspeed hub except for root hub has to use Hub Depth
1000 * value as an offset into the route string to locate the bits
1001 * it uses to determine the downstream port number. So hub driver
1002 * should send a set hub depth request to superspeed hub after
1003 * the superspeed hub is set configuration in initialization or
1004 * reset procedure.
1005 *
1006 * After a resume, port power should still be on.
Alan Sternf2835212008-04-28 11:07:17 -04001007 * For any other type of activation, turn it on.
1008 */
Alan Stern8520f382008-09-22 14:44:26 -04001009 if (type != HUB_RESUME) {
Elric Fua45aa3b2012-02-18 13:32:27 +08001010 if (hdev->parent && hub_is_superspeed(hdev)) {
1011 ret = usb_control_msg(hdev, usb_sndctrlpipe(hdev, 0),
1012 HUB_SET_DEPTH, USB_RT_HUB,
1013 hdev->level - 1, 0, NULL, 0,
1014 USB_CTRL_SET_TIMEOUT);
1015 if (ret < 0)
1016 dev_err(hub->intfdev,
1017 "set hub depth failed\n");
1018 }
Alan Stern8520f382008-09-22 14:44:26 -04001019
1020 /* Speed up system boot by using a delayed_work for the
1021 * hub's initial power-up delays. This is pretty awkward
1022 * and the implementation looks like a home-brewed sort of
1023 * setjmp/longjmp, but it saves at least 100 ms for each
1024 * root hub (assuming usbcore is compiled into the kernel
1025 * rather than as a module). It adds up.
1026 *
1027 * This can't be done for HUB_RESUME or HUB_RESET_RESUME
1028 * because for those activation types the ports have to be
1029 * operational when we return. In theory this could be done
1030 * for HUB_POST_RESET, but it's easier not to.
1031 */
1032 if (type == HUB_INIT) {
Kris Borer17a364e2015-08-21 10:47:46 +05301033 delay = hub_power_on_good_delay(hub);
Dan Williams7ad3c472014-05-20 18:08:57 -07001034
1035 hub_power_on(hub, false);
Tejun Heo77fa83c2014-03-07 10:24:48 -05001036 INIT_DELAYED_WORK(&hub->init_work, hub_init_func2);
Shaibal Dutta22f6a0f2014-02-01 19:16:46 -08001037 queue_delayed_work(system_power_efficient_wq,
1038 &hub->init_work,
Alan Stern8520f382008-09-22 14:44:26 -04001039 msecs_to_jiffies(delay));
Alan Stern61fbeba2008-10-27 12:07:44 -04001040
1041 /* Suppress autosuspend until init is done */
Alan Stern8e4ceb32009-12-07 13:01:37 -05001042 usb_autopm_get_interface_no_resume(
1043 to_usb_interface(hub->intfdev));
Alan Stern8520f382008-09-22 14:44:26 -04001044 return; /* Continues at init2: below */
Sarah Sharp653a39d2010-12-23 11:12:42 -08001045 } else if (type == HUB_RESET_RESUME) {
1046 /* The internal host controller state for the hub device
1047 * may be gone after a host power loss on system resume.
1048 * Update the device's info so the HW knows it's a hub.
1049 */
1050 hcd = bus_to_hcd(hdev->bus);
1051 if (hcd->driver->update_hub_device) {
1052 ret = hcd->driver->update_hub_device(hcd, hdev,
1053 &hub->tt, GFP_NOIO);
1054 if (ret < 0) {
1055 dev_err(hub->intfdev, "Host not "
1056 "accepting hub info "
1057 "update.\n");
1058 dev_err(hub->intfdev, "LS/FS devices "
1059 "and hubs may not work "
1060 "under this hub\n.");
1061 }
1062 }
1063 hub_power_on(hub, true);
Alan Stern8520f382008-09-22 14:44:26 -04001064 } else {
1065 hub_power_on(hub, true);
1066 }
1067 }
1068 init2:
Alan Sternf2835212008-04-28 11:07:17 -04001069
Dan Williamsd99f6b42014-05-20 18:08:17 -07001070 /*
Petr Mladek37ebb542014-09-19 17:32:23 +02001071 * Check each port and set hub->change_bits to let hub_wq know
Alan Stern6ee0b272008-04-28 11:06:42 -04001072 * which ports need attention.
Alan Stern5e6effa2008-03-03 15:15:51 -05001073 */
1074 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
Dan Williamsd99f6b42014-05-20 18:08:17 -07001075 struct usb_port *port_dev = hub->ports[port1 - 1];
1076 struct usb_device *udev = port_dev->child;
Alan Stern5e6effa2008-03-03 15:15:51 -05001077 u16 portstatus, portchange;
1078
Alan Stern6ee0b272008-04-28 11:06:42 -04001079 portstatus = portchange = 0;
1080 status = hub_port_status(hub, port1, &portstatus, &portchange);
Guenter Roeck181b0de2017-03-20 11:16:11 -07001081 if (status)
1082 goto abort;
1083
Alan Stern6ee0b272008-04-28 11:06:42 -04001084 if (udev || (portstatus & USB_PORT_STAT_CONNECTION))
Dan Williamsd99f6b42014-05-20 18:08:17 -07001085 dev_dbg(&port_dev->dev, "status %04x change %04x\n",
1086 portstatus, portchange);
Alan Stern5e6effa2008-03-03 15:15:51 -05001087
Dan Williamsd99f6b42014-05-20 18:08:17 -07001088 /*
1089 * After anything other than HUB_RESUME (i.e., initialization
Alan Stern6ee0b272008-04-28 11:06:42 -04001090 * or any sort of reset), every port should be disabled.
1091 * Unconnected ports should likewise be disabled (paranoia),
1092 * and so should ports for which we have no usb_device.
Alan Stern5e6effa2008-03-03 15:15:51 -05001093 */
Alan Stern6ee0b272008-04-28 11:06:42 -04001094 if ((portstatus & USB_PORT_STAT_ENABLE) && (
1095 type != HUB_RESUME ||
1096 !(portstatus & USB_PORT_STAT_CONNECTION) ||
1097 !udev ||
1098 udev->state == USB_STATE_NOTATTACHED)) {
Andiry Xu9f0a6cd2010-05-07 18:09:27 +08001099 /*
1100 * USB3 protocol ports will automatically transition
1101 * to Enabled state when detect an USB3.0 device attach.
Dan Williamsfd1ac4c2013-10-07 11:58:20 -07001102 * Do not disable USB3 protocol ports, just pretend
1103 * power was lost
Andiry Xu9f0a6cd2010-05-07 18:09:27 +08001104 */
Dan Williamsfd1ac4c2013-10-07 11:58:20 -07001105 portstatus &= ~USB_PORT_STAT_ENABLE;
1106 if (!hub_is_superspeed(hdev))
Lan Tianyuad493e52013-01-23 04:26:30 +08001107 usb_clear_port_feature(hdev, port1,
Andiry Xu9f0a6cd2010-05-07 18:09:27 +08001108 USB_PORT_FEAT_ENABLE);
Alan Stern6ee0b272008-04-28 11:06:42 -04001109 }
1110
Mathias Nyman1fbecf82018-11-28 15:55:21 +02001111 /*
1112 * Add debounce if USB3 link is in polling/link training state.
1113 * Link will automatically transition to Enabled state after
1114 * link training completes.
1115 */
1116 if (hub_is_superspeed(hdev) &&
1117 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
1118 USB_SS_PORT_LS_POLLING))
1119 need_debounce_delay = true;
1120
Alan Stern948fea32008-04-28 11:07:07 -04001121 /* Clear status-change flags; we'll debounce later */
1122 if (portchange & USB_PORT_STAT_C_CONNECTION) {
1123 need_debounce_delay = true;
Lan Tianyuad493e52013-01-23 04:26:30 +08001124 usb_clear_port_feature(hub->hdev, port1,
Alan Stern948fea32008-04-28 11:07:07 -04001125 USB_PORT_FEAT_C_CONNECTION);
1126 }
1127 if (portchange & USB_PORT_STAT_C_ENABLE) {
1128 need_debounce_delay = true;
Lan Tianyuad493e52013-01-23 04:26:30 +08001129 usb_clear_port_feature(hub->hdev, port1,
Alan Stern948fea32008-04-28 11:07:07 -04001130 USB_PORT_FEAT_C_ENABLE);
1131 }
Julius Wernere92aee32013-10-15 17:45:00 -07001132 if (portchange & USB_PORT_STAT_C_RESET) {
1133 need_debounce_delay = true;
1134 usb_clear_port_feature(hub->hdev, port1,
1135 USB_PORT_FEAT_C_RESET);
1136 }
Don Zickus79c3dd82011-11-03 09:07:18 -04001137 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
1138 hub_is_superspeed(hub->hdev)) {
1139 need_debounce_delay = true;
Lan Tianyuad493e52013-01-23 04:26:30 +08001140 usb_clear_port_feature(hub->hdev, port1,
Don Zickus79c3dd82011-11-03 09:07:18 -04001141 USB_PORT_FEAT_C_BH_PORT_RESET);
1142 }
Alan Stern253e0572009-10-27 15:20:13 -04001143 /* We can forget about a "removed" device when there's a
1144 * physical disconnect or the connect status changes.
1145 */
1146 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
1147 (portchange & USB_PORT_STAT_C_CONNECTION))
1148 clear_bit(port1, hub->removed_bits);
1149
Alan Stern6ee0b272008-04-28 11:06:42 -04001150 if (!udev || udev->state == USB_STATE_NOTATTACHED) {
Petr Mladek37ebb542014-09-19 17:32:23 +02001151 /* Tell hub_wq to disconnect the device or
Bin Liue2996cf2018-07-19 14:39:37 -05001152 * check for a new connection or over current condition.
1153 * Based on USB2.0 Spec Section 11.12.5,
1154 * C_PORT_OVER_CURRENT could be set while
1155 * PORT_OVER_CURRENT is not. So check for any of them.
Alan Stern6ee0b272008-04-28 11:06:42 -04001156 */
Shen Guang08d1dec2014-01-08 14:45:42 +08001157 if (udev || (portstatus & USB_PORT_STAT_CONNECTION) ||
Bin Liue2996cf2018-07-19 14:39:37 -05001158 (portstatus & USB_PORT_STAT_OVERCURRENT) ||
1159 (portchange & USB_PORT_STAT_C_OVERCURRENT))
Alan Stern6ee0b272008-04-28 11:06:42 -04001160 set_bit(port1, hub->change_bits);
1161
1162 } else if (portstatus & USB_PORT_STAT_ENABLE) {
Sarah Sharp72937e12012-01-24 11:46:50 -08001163 bool port_resumed = (portstatus &
1164 USB_PORT_STAT_LINK_STATE) ==
1165 USB_SS_PORT_LS_U0;
Alan Stern6ee0b272008-04-28 11:06:42 -04001166 /* The power session apparently survived the resume.
1167 * If there was an overcurrent or suspend change
Petr Mladek37ebb542014-09-19 17:32:23 +02001168 * (i.e., remote wakeup request), have hub_wq
Sarah Sharp72937e12012-01-24 11:46:50 -08001169 * take care of it. Look at the port link state
1170 * for USB 3.0 hubs, since they don't have a suspend
1171 * change bit, and they don't set the port link change
1172 * bit on device-initiated resume.
Alan Stern6ee0b272008-04-28 11:06:42 -04001173 */
Sarah Sharp72937e12012-01-24 11:46:50 -08001174 if (portchange || (hub_is_superspeed(hub->hdev) &&
1175 port_resumed))
Alan Stern6ee0b272008-04-28 11:06:42 -04001176 set_bit(port1, hub->change_bits);
1177
1178 } else if (udev->persist_enabled) {
Alan Stern6ee0b272008-04-28 11:06:42 -04001179#ifdef CONFIG_PM
Alan Stern5e6effa2008-03-03 15:15:51 -05001180 udev->reset_resume = 1;
Alan Stern6ee0b272008-04-28 11:06:42 -04001181#endif
Lan Tianyuad493e52013-01-23 04:26:30 +08001182 /* Don't set the change_bits when the device
1183 * was powered off.
1184 */
Dan Williamsd5c38342014-05-20 18:08:52 -07001185 if (test_bit(port1, hub->power_bits))
Lan Tianyuad493e52013-01-23 04:26:30 +08001186 set_bit(port1, hub->change_bits);
Alan Stern8808f002008-04-28 11:06:55 -04001187
Alan Stern6ee0b272008-04-28 11:06:42 -04001188 } else {
Petr Mladek37ebb542014-09-19 17:32:23 +02001189 /* The power session is gone; tell hub_wq */
Alan Stern6ee0b272008-04-28 11:06:42 -04001190 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
1191 set_bit(port1, hub->change_bits);
Alan Stern5e6effa2008-03-03 15:15:51 -05001192 }
Alan Stern5e6effa2008-03-03 15:15:51 -05001193 }
1194
Alan Stern948fea32008-04-28 11:07:07 -04001195 /* If no port-status-change flags were set, we don't need any
1196 * debouncing. If flags were set we can try to debounce the
Petr Mladek37ebb542014-09-19 17:32:23 +02001197 * ports all at once right now, instead of letting hub_wq do them
Alan Stern948fea32008-04-28 11:07:07 -04001198 * one at a time later on.
1199 *
Petr Mladek37ebb542014-09-19 17:32:23 +02001200 * If any port-status changes do occur during this delay, hub_wq
Alan Stern948fea32008-04-28 11:07:07 -04001201 * will see them later and handle them normally.
1202 */
Alan Stern8520f382008-09-22 14:44:26 -04001203 if (need_debounce_delay) {
1204 delay = HUB_DEBOUNCE_STABLE;
Alan Sternf2835212008-04-28 11:07:17 -04001205
Alan Stern8520f382008-09-22 14:44:26 -04001206 /* Don't do a long sleep inside a workqueue routine */
1207 if (type == HUB_INIT2) {
Tejun Heo77fa83c2014-03-07 10:24:48 -05001208 INIT_DELAYED_WORK(&hub->init_work, hub_init_func3);
Shaibal Dutta22f6a0f2014-02-01 19:16:46 -08001209 queue_delayed_work(system_power_efficient_wq,
1210 &hub->init_work,
Alan Stern8520f382008-09-22 14:44:26 -04001211 msecs_to_jiffies(delay));
Alan Stern07d316a2016-08-05 11:51:30 -04001212 device_unlock(&hdev->dev);
Alan Stern8520f382008-09-22 14:44:26 -04001213 return; /* Continues at init3: below */
1214 } else {
1215 msleep(delay);
1216 }
1217 }
1218 init3:
Alan Sternf2835212008-04-28 11:07:17 -04001219 hub->quiescing = 0;
1220
1221 status = usb_submit_urb(hub->urb, GFP_NOIO);
1222 if (status < 0)
1223 dev_err(hub->intfdev, "activate --> %d\n", status);
1224 if (hub->has_indicators && blinkenlights)
Shaibal Dutta22f6a0f2014-02-01 19:16:46 -08001225 queue_delayed_work(system_power_efficient_wq,
1226 &hub->leds, LED_CYCLE_PERIOD);
Alan Sternf2835212008-04-28 11:07:17 -04001227
1228 /* Scan all ports that need attention */
Petr Mladek32a695892014-09-19 17:32:21 +02001229 kick_hub_wq(hub);
Guenter Roeck181b0de2017-03-20 11:16:11 -07001230 abort:
Alan Sternca5cbc82016-08-05 11:49:45 -04001231 if (type == HUB_INIT2 || type == HUB_INIT3) {
1232 /* Allow autosuspend if it was suppressed */
1233 disconnected:
Alan Stern8e4ceb32009-12-07 13:01:37 -05001234 usb_autopm_put_interface_async(to_usb_interface(hub->intfdev));
Alan Stern07d316a2016-08-05 11:51:30 -04001235 device_unlock(&hdev->dev);
Alan Sternca5cbc82016-08-05 11:49:45 -04001236 }
Alan Sterne50293e2015-12-16 13:32:38 -05001237
1238 kref_put(&hub->kref, hub_release);
Alan Stern5e6effa2008-03-03 15:15:51 -05001239}
1240
Alan Stern8520f382008-09-22 14:44:26 -04001241/* Implement the continuations for the delays above */
1242static void hub_init_func2(struct work_struct *ws)
1243{
1244 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1245
1246 hub_activate(hub, HUB_INIT2);
1247}
1248
1249static void hub_init_func3(struct work_struct *ws)
1250{
1251 struct usb_hub *hub = container_of(ws, struct usb_hub, init_work.work);
1252
1253 hub_activate(hub, HUB_INIT3);
1254}
1255
Alan Stern43303542008-04-28 11:07:31 -04001256enum hub_quiescing_type {
1257 HUB_DISCONNECT, HUB_PRE_RESET, HUB_SUSPEND
1258};
1259
1260static void hub_quiesce(struct usb_hub *hub, enum hub_quiescing_type type)
1261{
1262 struct usb_device *hdev = hub->hdev;
1263 int i;
1264
Petr Mladek37ebb542014-09-19 17:32:23 +02001265 /* hub_wq and related activity won't re-trigger */
Alan Stern43303542008-04-28 11:07:31 -04001266 hub->quiescing = 1;
1267
1268 if (type != HUB_SUSPEND) {
1269 /* Disconnect all the children */
1270 for (i = 0; i < hdev->maxchild; ++i) {
Lan Tianyuff823c72012-09-05 13:44:32 +08001271 if (hub->ports[i]->child)
1272 usb_disconnect(&hub->ports[i]->child);
Alan Stern43303542008-04-28 11:07:31 -04001273 }
1274 }
1275
Petr Mladek37ebb542014-09-19 17:32:23 +02001276 /* Stop hub_wq and related activity */
Alan Stern43303542008-04-28 11:07:31 -04001277 usb_kill_urb(hub->urb);
1278 if (hub->has_indicators)
1279 cancel_delayed_work_sync(&hub->leds);
1280 if (hub->tt.hub)
Octavian Purdila036546b2012-10-23 11:33:12 +03001281 flush_work(&hub->tt.clear_work);
Alan Stern43303542008-04-28 11:07:31 -04001282}
1283
Alan Stern600856c2014-05-20 18:08:07 -07001284static void hub_pm_barrier_for_all_ports(struct usb_hub *hub)
1285{
1286 int i;
1287
1288 for (i = 0; i < hub->hdev->maxchild; ++i)
1289 pm_runtime_barrier(&hub->ports[i]->dev);
1290}
1291
Alan Stern3eb14912008-03-03 15:15:43 -05001292/* caller has locked the hub device */
1293static int hub_pre_reset(struct usb_interface *intf)
1294{
1295 struct usb_hub *hub = usb_get_intfdata(intf);
1296
Alan Stern43303542008-04-28 11:07:31 -04001297 hub_quiesce(hub, HUB_PRE_RESET);
Alan Stern600856c2014-05-20 18:08:07 -07001298 hub->in_reset = 1;
1299 hub_pm_barrier_for_all_ports(hub);
Alan Sternf07600c2007-05-30 15:38:16 -04001300 return 0;
Alan Stern7d069b72005-11-18 12:06:34 -05001301}
1302
1303/* caller has locked the hub device */
Alan Sternf07600c2007-05-30 15:38:16 -04001304static int hub_post_reset(struct usb_interface *intf)
Alan Stern7d069b72005-11-18 12:06:34 -05001305{
Alan Stern7de18d82006-06-01 13:37:24 -04001306 struct usb_hub *hub = usb_get_intfdata(intf);
1307
Alan Stern600856c2014-05-20 18:08:07 -07001308 hub->in_reset = 0;
1309 hub_pm_barrier_for_all_ports(hub);
Alan Sternf2835212008-04-28 11:07:17 -04001310 hub_activate(hub, HUB_POST_RESET);
Alan Sternf07600c2007-05-30 15:38:16 -04001311 return 0;
Alan Stern7d069b72005-11-18 12:06:34 -05001312}
1313
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314static int hub_configure(struct usb_hub *hub,
1315 struct usb_endpoint_descriptor *endpoint)
1316{
Sarah Sharpb356b7c2009-09-04 10:53:24 -07001317 struct usb_hcd *hcd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318 struct usb_device *hdev = hub->hdev;
1319 struct device *hub_dev = hub->intfdev;
1320 u16 hubstatus, hubchange;
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001321 u16 wHubCharacteristics;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 unsigned int pipe;
Lan Tianyufa2a9562012-09-05 13:44:31 +08001323 int maxp, ret, i;
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001324 char *message = "out of memory";
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001325 unsigned unit_load;
1326 unsigned full_load;
Dan Williamsd8521af2014-05-20 18:08:28 -07001327 unsigned maxchild;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328
Alan Sternd697cdd2009-10-27 15:18:46 -04001329 hub->buffer = kmalloc(sizeof(*hub->buffer), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330 if (!hub->buffer) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001331 ret = -ENOMEM;
1332 goto fail;
1333 }
1334
1335 hub->status = kmalloc(sizeof(*hub->status), GFP_KERNEL);
1336 if (!hub->status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337 ret = -ENOMEM;
1338 goto fail;
1339 }
Alan Sterndb90e7a2007-02-05 09:56:15 -05001340 mutex_init(&hub->status_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341
Johan Hovoldc67e87a2017-05-10 18:18:28 +02001342 hub->descriptor = kzalloc(sizeof(*hub->descriptor), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343 if (!hub->descriptor) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344 ret = -ENOMEM;
1345 goto fail;
1346 }
1347
1348 /* Request the entire hub descriptor.
1349 * hub->descriptor can handle USB_MAXCHILDREN ports,
Johan Hovold3e4a4e62017-05-10 18:18:27 +02001350 * but a (non-SS) hub can/will return fewer bytes here.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351 */
John Youndbe79bb2001-09-17 00:00:00 -07001352 ret = get_hub_descriptor(hdev, hub->descriptor);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353 if (ret < 0) {
1354 message = "can't read hub descriptor";
1355 goto fail;
Johan Hovold12bfbe12017-05-10 18:18:29 +02001356 }
1357
1358 maxchild = USB_MAXCHILDREN;
1359 if (hub_is_superspeed(hdev))
1360 maxchild = min_t(unsigned, maxchild, USB_SS_MAXPORTS);
1361
1362 if (hub->descriptor->bNbrPorts > maxchild) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001363 message = "hub has too many ports!";
1364 ret = -ENODEV;
1365 goto fail;
David Linares769d73682013-03-25 10:50:27 +00001366 } else if (hub->descriptor->bNbrPorts == 0) {
1367 message = "hub doesn't have any ports!";
1368 ret = -ENODEV;
1369 goto fail;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 }
1371
Dan Williamsd8521af2014-05-20 18:08:28 -07001372 maxchild = hub->descriptor->bNbrPorts;
1373 dev_info(hub_dev, "%d port%s detected\n", maxchild,
1374 (maxchild == 1) ? "" : "s");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001375
Dan Williamsd8521af2014-05-20 18:08:28 -07001376 hub->ports = kzalloc(maxchild * sizeof(struct usb_port *), GFP_KERNEL);
Lan Tianyuff823c72012-09-05 13:44:32 +08001377 if (!hub->ports) {
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001378 ret = -ENOMEM;
1379 goto fail;
1380 }
1381
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001382 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001383 if (hub_is_superspeed(hdev)) {
1384 unit_load = 150;
1385 full_load = 900;
1386 } else {
1387 unit_load = 100;
1388 full_load = 500;
1389 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390
John Youndbe79bb2001-09-17 00:00:00 -07001391 /* FIXME for USB 3.0, skip for now */
1392 if ((wHubCharacteristics & HUB_CHAR_COMPOUND) &&
1393 !(hub_is_superspeed(hdev))) {
Matthias Beyer469271f2013-10-10 23:41:27 +02001394 char portstr[USB_MAXCHILDREN + 1];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395
Dan Williamsd8521af2014-05-20 18:08:28 -07001396 for (i = 0; i < maxchild; i++)
John Youndbe79bb2001-09-17 00:00:00 -07001397 portstr[i] = hub->descriptor->u.hs.DeviceRemovable
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398 [((i + 1) / 8)] & (1 << ((i + 1) % 8))
1399 ? 'F' : 'R';
Dan Williamsd8521af2014-05-20 18:08:28 -07001400 portstr[maxchild] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401 dev_dbg(hub_dev, "compound device; port removable status: %s\n", portstr);
1402 } else
1403 dev_dbg(hub_dev, "standalone hub\n");
1404
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001405 switch (wHubCharacteristics & HUB_CHAR_LPSM) {
Aman Deep7bf01182011-12-08 12:05:22 +05301406 case HUB_CHAR_COMMON_LPSM:
1407 dev_dbg(hub_dev, "ganged power switching\n");
1408 break;
1409 case HUB_CHAR_INDV_PORT_LPSM:
1410 dev_dbg(hub_dev, "individual port power switching\n");
1411 break;
1412 case HUB_CHAR_NO_LPSM:
1413 case HUB_CHAR_LPSM:
1414 dev_dbg(hub_dev, "no power switching (usb 1.0)\n");
1415 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001416 }
1417
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001418 switch (wHubCharacteristics & HUB_CHAR_OCPM) {
Aman Deep7bf01182011-12-08 12:05:22 +05301419 case HUB_CHAR_COMMON_OCPM:
1420 dev_dbg(hub_dev, "global over-current protection\n");
1421 break;
1422 case HUB_CHAR_INDV_PORT_OCPM:
1423 dev_dbg(hub_dev, "individual port over-current protection\n");
1424 break;
1425 case HUB_CHAR_NO_OCPM:
1426 case HUB_CHAR_OCPM:
1427 dev_dbg(hub_dev, "no over-current protection\n");
1428 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429 }
1430
Chase Metzger17248562015-08-11 21:34:37 -07001431 spin_lock_init(&hub->tt.lock);
1432 INIT_LIST_HEAD(&hub->tt.clear_list);
Alan Sterncb88a1b2009-06-29 10:43:32 -04001433 INIT_WORK(&hub->tt.clear_work, hub_tt_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434 switch (hdev->descriptor.bDeviceProtocol) {
Aman Deep7bf01182011-12-08 12:05:22 +05301435 case USB_HUB_PR_FS:
1436 break;
1437 case USB_HUB_PR_HS_SINGLE_TT:
1438 dev_dbg(hub_dev, "Single TT\n");
1439 hub->tt.hub = hdev;
1440 break;
1441 case USB_HUB_PR_HS_MULTI_TT:
1442 ret = usb_set_interface(hdev, 0, 1);
1443 if (ret == 0) {
1444 dev_dbg(hub_dev, "TT per port\n");
1445 hub->tt.multi = 1;
1446 } else
1447 dev_err(hub_dev, "Using single TT (err %d)\n",
1448 ret);
1449 hub->tt.hub = hdev;
1450 break;
1451 case USB_HUB_PR_SS:
1452 /* USB 3.0 hubs don't have a TT */
1453 break;
1454 default:
1455 dev_dbg(hub_dev, "Unrecognized hub protocol %d\n",
1456 hdev->descriptor.bDeviceProtocol);
1457 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458 }
1459
david-b@pacbell.nete09711a2005-08-13 18:41:04 -07001460 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001461 switch (wHubCharacteristics & HUB_CHAR_TTTT) {
Matthias Beyer469271f2013-10-10 23:41:27 +02001462 case HUB_TTTT_8_BITS:
1463 if (hdev->descriptor.bDeviceProtocol != 0) {
1464 hub->tt.think_time = 666;
david-b@pacbell.nete09711a2005-08-13 18:41:04 -07001465 dev_dbg(hub_dev, "TT requires at most %d "
1466 "FS bit times (%d ns)\n",
Matthias Beyer469271f2013-10-10 23:41:27 +02001467 8, hub->tt.think_time);
1468 }
1469 break;
1470 case HUB_TTTT_16_BITS:
1471 hub->tt.think_time = 666 * 2;
1472 dev_dbg(hub_dev, "TT requires at most %d "
1473 "FS bit times (%d ns)\n",
1474 16, hub->tt.think_time);
1475 break;
1476 case HUB_TTTT_24_BITS:
1477 hub->tt.think_time = 666 * 3;
1478 dev_dbg(hub_dev, "TT requires at most %d "
1479 "FS bit times (%d ns)\n",
1480 24, hub->tt.think_time);
1481 break;
1482 case HUB_TTTT_32_BITS:
1483 hub->tt.think_time = 666 * 4;
1484 dev_dbg(hub_dev, "TT requires at most %d "
1485 "FS bit times (%d ns)\n",
1486 32, hub->tt.think_time);
1487 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488 }
1489
1490 /* probe() zeroes hub->indicator[] */
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001491 if (wHubCharacteristics & HUB_CHAR_PORTIND) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001492 hub->has_indicators = 1;
1493 dev_dbg(hub_dev, "Port indicators are supported\n");
1494 }
1495
1496 dev_dbg(hub_dev, "power on to power good time: %dms\n",
1497 hub->descriptor->bPwrOn2PwrGood * 2);
1498
1499 /* power budgeting mostly matters with bus-powered hubs,
1500 * and battery-powered root hubs (may provide just 8 mA).
1501 */
1502 ret = usb_get_status(hdev, USB_RECIP_DEVICE, 0, &hubstatus);
Alan Stern15b73362013-07-30 15:35:40 -04001503 if (ret) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504 message = "can't get hub status";
1505 goto fail;
1506 }
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001507 hcd = bus_to_hcd(hdev->bus);
Alan Stern7d35b922005-04-25 11:18:32 -04001508 if (hdev == hdev->bus->root_hub) {
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001509 if (hcd->power_budget > 0)
1510 hdev->bus_mA = hcd->power_budget;
1511 else
Dan Williamsd8521af2014-05-20 18:08:28 -07001512 hdev->bus_mA = full_load * maxchild;
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001513 if (hdev->bus_mA >= full_load)
1514 hub->mA_per_port = full_load;
Alan Stern55c52712005-11-23 12:03:12 -05001515 else {
1516 hub->mA_per_port = hdev->bus_mA;
1517 hub->limited_power = 1;
1518 }
Alan Stern7d35b922005-04-25 11:18:32 -04001519 } else if ((hubstatus & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001520 int remaining = hdev->bus_mA -
1521 hub->descriptor->bHubContrCurrent;
1522
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523 dev_dbg(hub_dev, "hub controller current requirement: %dmA\n",
1524 hub->descriptor->bHubContrCurrent);
Alan Stern55c52712005-11-23 12:03:12 -05001525 hub->limited_power = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001526
Dan Williamsd8521af2014-05-20 18:08:28 -07001527 if (remaining < maxchild * unit_load)
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001528 dev_warn(hub_dev,
Alan Stern55c52712005-11-23 12:03:12 -05001529 "insufficient power available "
1530 "to use all downstream ports\n");
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001531 hub->mA_per_port = unit_load; /* 7.2.1 */
1532
Alan Stern55c52712005-11-23 12:03:12 -05001533 } else { /* Self-powered external hub */
1534 /* FIXME: What about battery-powered external hubs that
1535 * provide less current per port? */
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001536 hub->mA_per_port = full_load;
Alan Stern55c52712005-11-23 12:03:12 -05001537 }
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01001538 if (hub->mA_per_port < full_load)
Alan Stern55c52712005-11-23 12:03:12 -05001539 dev_dbg(hub_dev, "%umA bus power budget for each child\n",
1540 hub->mA_per_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541
1542 ret = hub_hub_status(hub, &hubstatus, &hubchange);
1543 if (ret < 0) {
1544 message = "can't get hub status";
1545 goto fail;
1546 }
1547
1548 /* local power status reports aren't always correct */
1549 if (hdev->actconfig->desc.bmAttributes & USB_CONFIG_ATT_SELFPOWER)
1550 dev_dbg(hub_dev, "local power source is %s\n",
1551 (hubstatus & HUB_STATUS_LOCAL_POWER)
1552 ? "lost (inactive)" : "good");
1553
Greg Kroah-Hartman74ad9bd2005-06-20 21:15:16 -07001554 if ((wHubCharacteristics & HUB_CHAR_OCPM) == 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555 dev_dbg(hub_dev, "%sover-current condition exists\n",
1556 (hubstatus & HUB_STATUS_OVERCURRENT) ? "" : "no ");
1557
inaky@linux.intel.com88fafff2006-10-11 20:05:59 -07001558 /* set up the interrupt endpoint
1559 * We use the EP's maxpacket size instead of (PORTS+1+7)/8
1560 * bytes as USB2.0[11.12.3] says because some hubs are known
1561 * to send more data (and thus cause overflow). For root hubs,
1562 * maxpktsize is defined in hcd.c's fake endpoint descriptors
1563 * to be big enough for at least USB_MAXCHILDREN ports. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001564 pipe = usb_rcvintpipe(hdev, endpoint->bEndpointAddress);
1565 maxp = usb_maxpacket(hdev, pipe, usb_pipeout(pipe));
1566
1567 if (maxp > sizeof(*hub->buffer))
1568 maxp = sizeof(*hub->buffer);
1569
1570 hub->urb = usb_alloc_urb(0, GFP_KERNEL);
1571 if (!hub->urb) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572 ret = -ENOMEM;
1573 goto fail;
1574 }
1575
1576 usb_fill_int_urb(hub->urb, hdev, pipe, *hub->buffer, maxp, hub_irq,
1577 hub, endpoint->bInterval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578
1579 /* maybe cycle the hub leds */
1580 if (hub->has_indicators && blinkenlights)
Matthias Beyer469271f2013-10-10 23:41:27 +02001581 hub->indicator[0] = INDICATOR_CYCLE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582
Dan Williamsd8521af2014-05-20 18:08:28 -07001583 mutex_lock(&usb_port_peer_mutex);
1584 for (i = 0; i < maxchild; i++) {
Krzysztof Mazure58547e2013-08-22 14:49:39 +02001585 ret = usb_hub_create_port_device(hub, i + 1);
1586 if (ret < 0) {
Lan Tianyufa2a9562012-09-05 13:44:31 +08001587 dev_err(hub->intfdev,
1588 "couldn't create port%d device.\n", i + 1);
Dan Williamsd8521af2014-05-20 18:08:28 -07001589 break;
Krzysztof Mazure58547e2013-08-22 14:49:39 +02001590 }
1591 }
Dan Williamsd8521af2014-05-20 18:08:28 -07001592 hdev->maxchild = i;
Dan Williamse3d10502014-06-17 16:16:32 -07001593 for (i = 0; i < hdev->maxchild; i++) {
1594 struct usb_port *port_dev = hub->ports[i];
1595
1596 pm_runtime_put(&port_dev->dev);
1597 }
1598
Dan Williamsd8521af2014-05-20 18:08:28 -07001599 mutex_unlock(&usb_port_peer_mutex);
1600 if (ret < 0)
1601 goto fail;
Lan Tianyufa2a9562012-09-05 13:44:31 +08001602
Petr Mladek37ebb542014-09-19 17:32:23 +02001603 /* Update the HCD's internal representation of this hub before hub_wq
Dan Williamse3d95582014-06-05 14:23:04 -07001604 * starts getting port status changes for devices under the hub.
1605 */
1606 if (hcd->driver->update_hub_device) {
1607 ret = hcd->driver->update_hub_device(hcd, hdev,
1608 &hub->tt, GFP_KERNEL);
1609 if (ret < 0) {
1610 message = "can't update HCD hub info";
1611 goto fail;
1612 }
1613 }
1614
Lan Tianyud2123fd2013-01-21 22:18:00 +08001615 usb_hub_adjust_deviceremovable(hdev, hub->descriptor);
1616
Alan Sternf2835212008-04-28 11:07:17 -04001617 hub_activate(hub, HUB_INIT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618 return 0;
1619
1620fail:
Chase Metzger17248562015-08-11 21:34:37 -07001621 dev_err(hub_dev, "config failed, %s (err %d)\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622 message, ret);
1623 /* hub_disconnect() frees urb and descriptor */
1624 return ret;
1625}
1626
Alan Sterne8054852007-05-04 11:55:11 -04001627static void hub_release(struct kref *kref)
1628{
1629 struct usb_hub *hub = container_of(kref, struct usb_hub, kref);
1630
Petr Mladek5d14f322014-09-19 17:32:19 +02001631 usb_put_dev(hub->hdev);
Alan Sterne8054852007-05-04 11:55:11 -04001632 usb_put_intf(to_usb_interface(hub->intfdev));
1633 kfree(hub);
1634}
1635
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636static unsigned highspeed_hubs;
1637
1638static void hub_disconnect(struct usb_interface *intf)
1639{
Huajun Li88162302012-03-12 21:00:19 +08001640 struct usb_hub *hub = usb_get_intfdata(intf);
Greg Kroah-Hartmanfa286182012-05-14 09:20:37 -07001641 struct usb_device *hdev = interface_to_usbdev(intf);
Alan Stern543d7782014-01-07 10:43:02 -05001642 int port1;
Lan Tianyufa2a9562012-09-05 13:44:31 +08001643
Petr Mladek32a695892014-09-19 17:32:21 +02001644 /*
1645 * Stop adding new hub events. We do not want to block here and thus
1646 * will not try to remove any pending work item.
1647 */
Alan Sterne8054852007-05-04 11:55:11 -04001648 hub->disconnected = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649
Alan Stern7de18d82006-06-01 13:37:24 -04001650 /* Disconnect all children and quiesce the hub */
1651 hub->error = 0;
Alan Stern43303542008-04-28 11:07:31 -04001652 hub_quiesce(hub, HUB_DISCONNECT);
Alan Stern7de18d82006-06-01 13:37:24 -04001653
Dan Williamsd8521af2014-05-20 18:08:28 -07001654 mutex_lock(&usb_port_peer_mutex);
1655
Alan Stern543d7782014-01-07 10:43:02 -05001656 /* Avoid races with recursively_mark_NOTATTACHED() */
1657 spin_lock_irq(&device_state_lock);
1658 port1 = hdev->maxchild;
1659 hdev->maxchild = 0;
1660 usb_set_intfdata(intf, NULL);
1661 spin_unlock_irq(&device_state_lock);
Alexander Shishkin1f2235b2012-09-12 14:48:31 +03001662
Alan Stern543d7782014-01-07 10:43:02 -05001663 for (; port1 > 0; --port1)
1664 usb_hub_remove_port_device(hub, port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001665
Dan Williamsd8521af2014-05-20 18:08:28 -07001666 mutex_unlock(&usb_port_peer_mutex);
1667
Alan Sterne8054852007-05-04 11:55:11 -04001668 if (hub->hdev->speed == USB_SPEED_HIGH)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669 highspeed_hubs--;
1670
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671 usb_free_urb(hub->urb);
Lan Tianyufa2a9562012-09-05 13:44:31 +08001672 kfree(hub->ports);
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07001673 kfree(hub->descriptor);
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07001674 kfree(hub->status);
Alan Sternd697cdd2009-10-27 15:18:46 -04001675 kfree(hub->buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001676
Lan Tianyu971fcd42013-01-23 04:26:29 +08001677 pm_suspend_ignore_children(&intf->dev, false);
Alan Sterne8054852007-05-04 11:55:11 -04001678 kref_put(&hub->kref, hub_release);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679}
1680
1681static int hub_probe(struct usb_interface *intf, const struct usb_device_id *id)
1682{
1683 struct usb_host_interface *desc;
1684 struct usb_endpoint_descriptor *endpoint;
1685 struct usb_device *hdev;
1686 struct usb_hub *hub;
1687
1688 desc = intf->cur_altsetting;
1689 hdev = interface_to_usbdev(intf);
1690
Ming Lei596d7892012-10-24 11:59:25 +08001691 /*
1692 * Set default autosuspend delay as 0 to speedup bus suspend,
1693 * based on the below considerations:
1694 *
1695 * - Unlike other drivers, the hub driver does not rely on the
1696 * autosuspend delay to provide enough time to handle a wakeup
1697 * event, and the submitted status URB is just to check future
1698 * change on hub downstream ports, so it is safe to do it.
1699 *
1700 * - The patch might cause one or more auto supend/resume for
1701 * below very rare devices when they are plugged into hub
1702 * first time:
1703 *
1704 * devices having trouble initializing, and disconnect
1705 * themselves from the bus and then reconnect a second
1706 * or so later
1707 *
1708 * devices just for downloading firmware, and disconnects
1709 * themselves after completing it
1710 *
1711 * For these quite rare devices, their drivers may change the
1712 * autosuspend delay of their parent hub in the probe() to one
1713 * appropriate value to avoid the subtle problem if someone
1714 * does care it.
1715 *
1716 * - The patch may cause one or more auto suspend/resume on
1717 * hub during running 'lsusb', but it is probably too
1718 * infrequent to worry about.
1719 *
1720 * - Change autosuspend delay of hub can avoid unnecessary auto
1721 * suspend timer for hub, also may decrease power consumption
1722 * of USB bus.
Roger Quadrosbdd405d2014-08-04 12:44:46 +03001723 *
1724 * - If user has indicated to prevent autosuspend by passing
1725 * usbcore.autosuspend = -1 then keep autosuspend disabled.
Ming Lei596d7892012-10-24 11:59:25 +08001726 */
Rafael J. Wysockiceb6c9c2014-11-29 23:47:05 +01001727#ifdef CONFIG_PM
Roger Quadrosbdd405d2014-08-04 12:44:46 +03001728 if (hdev->dev.power.autosuspend_delay >= 0)
1729 pm_runtime_set_autosuspend_delay(&hdev->dev, 0);
Greg Kroah-Hartmana9ef8032014-08-27 16:55:29 -07001730#endif
Ming Lei596d7892012-10-24 11:59:25 +08001731
Alan Stern8ef42dd2014-05-23 10:45:54 -04001732 /*
1733 * Hubs have proper suspend/resume support, except for root hubs
1734 * where the controller driver doesn't have bus_suspend and
1735 * bus_resume methods.
1736 */
1737 if (hdev->parent) { /* normal device */
1738 usb_enable_autosuspend(hdev);
1739 } else { /* root hub */
1740 const struct hc_driver *drv = bus_to_hcd(hdev->bus)->driver;
1741
1742 if (drv->bus_suspend && drv->bus_resume)
1743 usb_enable_autosuspend(hdev);
1744 }
Alan Stern088f7fe2010-01-08 12:56:54 -05001745
Felipe Balbi38f3ad52008-06-12 10:49:47 +03001746 if (hdev->level == MAX_TOPO_LEVEL) {
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08001747 dev_err(&intf->dev,
1748 "Unsupported bus topology: hub nested too deep\n");
Felipe Balbi38f3ad52008-06-12 10:49:47 +03001749 return -E2BIG;
1750 }
1751
David Brownell89ccbdc2006-04-02 10:18:09 -08001752#ifdef CONFIG_USB_OTG_BLACKLIST_HUB
1753 if (hdev->parent) {
1754 dev_warn(&intf->dev, "ignoring external hub\n");
1755 return -ENODEV;
1756 }
1757#endif
1758
Linus Torvalds1da177e2005-04-16 15:20:36 -07001759 /* Some hubs have a subclass of 1, which AFAICT according to the */
1760 /* specs is not defined, but it works */
1761 if ((desc->desc.bInterfaceSubClass != 0) &&
1762 (desc->desc.bInterfaceSubClass != 1)) {
1763descriptor_error:
Chase Metzger17248562015-08-11 21:34:37 -07001764 dev_err(&intf->dev, "bad descriptor, ignoring hub\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001765 return -EIO;
1766 }
1767
1768 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
1769 if (desc->desc.bNumEndpoints != 1)
1770 goto descriptor_error;
1771
1772 endpoint = &desc->endpoint[0].desc;
1773
Luiz Fernando N. Capitulinofbf81c22006-09-27 11:58:53 -07001774 /* If it's not an interrupt in endpoint, we'd better punt! */
1775 if (!usb_endpoint_is_int_in(endpoint))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776 goto descriptor_error;
1777
1778 /* We found a hub */
Chase Metzger17248562015-08-11 21:34:37 -07001779 dev_info(&intf->dev, "USB hub found\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780
Alan Stern0a1ef3b2005-10-24 15:38:24 -04001781 hub = kzalloc(sizeof(*hub), GFP_KERNEL);
Wolfram Sangb74e7062016-08-25 19:38:59 +02001782 if (!hub)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784
Alan Sterne8054852007-05-04 11:55:11 -04001785 kref_init(&hub->kref);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786 hub->intfdev = &intf->dev;
1787 hub->hdev = hdev;
David Howellsc4028952006-11-22 14:57:56 +00001788 INIT_DELAYED_WORK(&hub->leds, led_work);
Alan Stern8520f382008-09-22 14:44:26 -04001789 INIT_DELAYED_WORK(&hub->init_work, NULL);
Petr Mladek32a695892014-09-19 17:32:21 +02001790 INIT_WORK(&hub->events, hub_event);
Alan Sterne8054852007-05-04 11:55:11 -04001791 usb_get_intf(intf);
Petr Mladek5d14f322014-09-19 17:32:19 +02001792 usb_get_dev(hdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793
Chase Metzger17248562015-08-11 21:34:37 -07001794 usb_set_intfdata(intf, hub);
Alan Stern40f122f2006-11-09 14:44:33 -05001795 intf->needs_remote_wakeup = 1;
Lan Tianyu971fcd42013-01-23 04:26:29 +08001796 pm_suspend_ignore_children(&intf->dev, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797
1798 if (hdev->speed == USB_SPEED_HIGH)
1799 highspeed_hubs++;
1800
Ming Leie6f30de2012-10-24 11:59:24 +08001801 if (id->driver_info & HUB_QUIRK_CHECK_PORT_AUTOSUSPEND)
1802 hub->quirk_check_port_auto_suspend = 1;
1803
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804 if (hub_configure(hub, endpoint) >= 0)
1805 return 0;
1806
Chase Metzger17248562015-08-11 21:34:37 -07001807 hub_disconnect(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808 return -ENODEV;
1809}
1810
1811static int
1812hub_ioctl(struct usb_interface *intf, unsigned int code, void *user_data)
1813{
Chase Metzger17248562015-08-11 21:34:37 -07001814 struct usb_device *hdev = interface_to_usbdev(intf);
Lan Tianyuad493e52013-01-23 04:26:30 +08001815 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001816
1817 /* assert ifno == 0 (part of hub spec) */
1818 switch (code) {
1819 case USBDEVFS_HUB_PORTINFO: {
1820 struct usbdevfs_hub_portinfo *info = user_data;
1821 int i;
1822
1823 spin_lock_irq(&device_state_lock);
1824 if (hdev->devnum <= 0)
1825 info->nports = 0;
1826 else {
1827 info->nports = hdev->maxchild;
1828 for (i = 0; i < info->nports; i++) {
Lan Tianyuff823c72012-09-05 13:44:32 +08001829 if (hub->ports[i]->child == NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001830 info->port[i] = 0;
1831 else
1832 info->port[i] =
Lan Tianyuff823c72012-09-05 13:44:32 +08001833 hub->ports[i]->child->devnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001834 }
1835 }
1836 spin_unlock_irq(&device_state_lock);
1837
1838 return info->nports + 1;
1839 }
1840
1841 default:
1842 return -ENOSYS;
1843 }
1844}
1845
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001846/*
1847 * Allow user programs to claim ports on a hub. When a device is attached
1848 * to one of these "claimed" ports, the program will "own" the device.
1849 */
1850static int find_port_owner(struct usb_device *hdev, unsigned port1,
Valentina Manea9b6f0c42014-03-10 10:36:40 +02001851 struct usb_dev_state ***ppowner)
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001852{
Mathias Nyman41341262013-06-18 17:28:48 +03001853 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
1854
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001855 if (hdev->state == USB_STATE_NOTATTACHED)
1856 return -ENODEV;
1857 if (port1 == 0 || port1 > hdev->maxchild)
1858 return -EINVAL;
1859
Mathias Nyman41341262013-06-18 17:28:48 +03001860 /* Devices not managed by the hub driver
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001861 * will always have maxchild equal to 0.
1862 */
Mathias Nyman41341262013-06-18 17:28:48 +03001863 *ppowner = &(hub->ports[port1 - 1]->port_owner);
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001864 return 0;
1865}
1866
1867/* In the following three functions, the caller must hold hdev's lock */
Lan Tianyu336c5c32012-07-06 14:13:52 +08001868int usb_hub_claim_port(struct usb_device *hdev, unsigned port1,
Valentina Manea9b6f0c42014-03-10 10:36:40 +02001869 struct usb_dev_state *owner)
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001870{
1871 int rc;
Valentina Manea9b6f0c42014-03-10 10:36:40 +02001872 struct usb_dev_state **powner;
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001873
1874 rc = find_port_owner(hdev, port1, &powner);
1875 if (rc)
1876 return rc;
1877 if (*powner)
1878 return -EBUSY;
1879 *powner = owner;
1880 return rc;
1881}
Valentina Manea6080cd02014-03-08 14:53:34 +02001882EXPORT_SYMBOL_GPL(usb_hub_claim_port);
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001883
Lan Tianyu336c5c32012-07-06 14:13:52 +08001884int usb_hub_release_port(struct usb_device *hdev, unsigned port1,
Valentina Manea9b6f0c42014-03-10 10:36:40 +02001885 struct usb_dev_state *owner)
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001886{
1887 int rc;
Valentina Manea9b6f0c42014-03-10 10:36:40 +02001888 struct usb_dev_state **powner;
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001889
1890 rc = find_port_owner(hdev, port1, &powner);
1891 if (rc)
1892 return rc;
1893 if (*powner != owner)
1894 return -ENOENT;
1895 *powner = NULL;
1896 return rc;
1897}
Valentina Manea6080cd02014-03-08 14:53:34 +02001898EXPORT_SYMBOL_GPL(usb_hub_release_port);
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001899
Valentina Manea9b6f0c42014-03-10 10:36:40 +02001900void usb_hub_release_all_ports(struct usb_device *hdev, struct usb_dev_state *owner)
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001901{
Lan Tianyuad493e52013-01-23 04:26:30 +08001902 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001903 int n;
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001904
Lan Tianyufa2a9562012-09-05 13:44:31 +08001905 for (n = 0; n < hdev->maxchild; n++) {
1906 if (hub->ports[n]->port_owner == owner)
1907 hub->ports[n]->port_owner = NULL;
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001908 }
Lan Tianyufa2a9562012-09-05 13:44:31 +08001909
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001910}
1911
1912/* The caller must hold udev's lock */
1913bool usb_device_is_owned(struct usb_device *udev)
1914{
1915 struct usb_hub *hub;
1916
1917 if (udev->state == USB_STATE_NOTATTACHED || !udev->parent)
1918 return false;
Lan Tianyuad493e52013-01-23 04:26:30 +08001919 hub = usb_hub_to_struct_hub(udev->parent);
Lan Tianyufa2a9562012-09-05 13:44:31 +08001920 return !!hub->ports[udev->portnum - 1]->port_owner;
Alan Stern7cbe5dc2009-06-29 10:56:54 -04001921}
1922
Linus Torvalds1da177e2005-04-16 15:20:36 -07001923static void recursively_mark_NOTATTACHED(struct usb_device *udev)
1924{
Lan Tianyuad493e52013-01-23 04:26:30 +08001925 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926 int i;
1927
1928 for (i = 0; i < udev->maxchild; ++i) {
Lan Tianyuff823c72012-09-05 13:44:32 +08001929 if (hub->ports[i]->child)
1930 recursively_mark_NOTATTACHED(hub->ports[i]->child);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001931 }
Alan Stern9bbdf1e2010-01-08 12:57:28 -05001932 if (udev->state == USB_STATE_SUSPENDED)
Sarah Sharp15123002007-12-21 16:54:15 -08001933 udev->active_duration -= jiffies;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001934 udev->state = USB_STATE_NOTATTACHED;
1935}
1936
1937/**
1938 * usb_set_device_state - change a device's current state (usbcore, hcds)
1939 * @udev: pointer to device whose state should be changed
1940 * @new_state: new state value to be stored
1941 *
1942 * udev->state is _not_ fully protected by the device lock. Although
1943 * most transitions are made only while holding the lock, the state can
1944 * can change to USB_STATE_NOTATTACHED at almost any time. This
1945 * is so that devices can be marked as disconnected as soon as possible,
1946 * without having to wait for any semaphores to be released. As a result,
1947 * all changes to any device's state must be protected by the
1948 * device_state_lock spinlock.
1949 *
1950 * Once a device has been added to the device tree, all changes to its state
1951 * should be made using this routine. The state should _not_ be set directly.
1952 *
1953 * If udev->state is already USB_STATE_NOTATTACHED then no change is made.
1954 * Otherwise udev->state is set to new_state, and if new_state is
1955 * USB_STATE_NOTATTACHED then all of udev's descendants' states are also set
1956 * to USB_STATE_NOTATTACHED.
1957 */
1958void usb_set_device_state(struct usb_device *udev,
1959 enum usb_device_state new_state)
1960{
1961 unsigned long flags;
Rafael J. Wysocki4681b172011-02-08 23:25:48 +01001962 int wakeup = -1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001963
1964 spin_lock_irqsave(&device_state_lock, flags);
1965 if (udev->state == USB_STATE_NOTATTACHED)
1966 ; /* do nothing */
David Brownellb94dc6b2005-09-12 19:39:39 -07001967 else if (new_state != USB_STATE_NOTATTACHED) {
David Brownellfb669cc2006-01-24 08:40:27 -08001968
1969 /* root hub wakeup capabilities are managed out-of-band
1970 * and may involve silicon errata ... ignore them here.
1971 */
1972 if (udev->parent) {
Alan Stern645daaa2006-08-30 15:47:02 -04001973 if (udev->state == USB_STATE_SUSPENDED
1974 || new_state == USB_STATE_SUSPENDED)
1975 ; /* No change to wakeup settings */
1976 else if (new_state == USB_STATE_CONFIGURED)
Lu Baoluddbe1fc2014-09-19 10:13:50 +08001977 wakeup = (udev->quirks &
1978 USB_QUIRK_IGNORE_REMOTE_WAKEUP) ? 0 :
1979 udev->actconfig->desc.bmAttributes &
1980 USB_CONFIG_ATT_WAKEUP;
Alan Stern645daaa2006-08-30 15:47:02 -04001981 else
Rafael J. Wysocki4681b172011-02-08 23:25:48 +01001982 wakeup = 0;
David Brownellfb669cc2006-01-24 08:40:27 -08001983 }
Sarah Sharp15123002007-12-21 16:54:15 -08001984 if (udev->state == USB_STATE_SUSPENDED &&
1985 new_state != USB_STATE_SUSPENDED)
1986 udev->active_duration -= jiffies;
1987 else if (new_state == USB_STATE_SUSPENDED &&
1988 udev->state != USB_STATE_SUSPENDED)
1989 udev->active_duration += jiffies;
Alan Stern645daaa2006-08-30 15:47:02 -04001990 udev->state = new_state;
David Brownellb94dc6b2005-09-12 19:39:39 -07001991 } else
Linus Torvalds1da177e2005-04-16 15:20:36 -07001992 recursively_mark_NOTATTACHED(udev);
1993 spin_unlock_irqrestore(&device_state_lock, flags);
Rafael J. Wysocki4681b172011-02-08 23:25:48 +01001994 if (wakeup >= 0)
1995 device_set_wakeup_capable(&udev->dev, wakeup);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001996}
David Vrabel6da9c992009-02-18 14:43:47 +00001997EXPORT_SYMBOL_GPL(usb_set_device_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001998
Inaky Perez-Gonzalez8af548d2008-04-08 13:24:46 -07001999/*
Alan Stern3b29b682011-02-22 09:53:41 -05002000 * Choose a device number.
2001 *
2002 * Device numbers are used as filenames in usbfs. On USB-1.1 and
2003 * USB-2.0 buses they are also used as device addresses, however on
2004 * USB-3.0 buses the address is assigned by the controller hardware
2005 * and it usually is not the same as the device number.
2006 *
Inaky Perez-Gonzalez8af548d2008-04-08 13:24:46 -07002007 * WUSB devices are simple: they have no hubs behind, so the mapping
2008 * device <-> virtual port number becomes 1:1. Why? to simplify the
2009 * life of the device connection logic in
2010 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
2011 * handshake we need to assign a temporary address in the unauthorized
2012 * space. For simplicity we use the first virtual port number found to
2013 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
2014 * and that becomes it's address [X < 128] or its unauthorized address
2015 * [X | 0x80].
2016 *
2017 * We add 1 as an offset to the one-based USB-stack port number
2018 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
2019 * 0 is reserved by USB for default address; (b) Linux's USB stack
2020 * uses always #1 for the root hub of the controller. So USB stack's
2021 * port #1, which is wusb virtual-port #0 has address #2.
Sarah Sharpc6515272009-04-27 19:57:26 -07002022 *
2023 * Devices connected under xHCI are not as simple. The host controller
2024 * supports virtualization, so the hardware assigns device addresses and
2025 * the HCD must setup data structures before issuing a set address
2026 * command to the hardware.
Inaky Perez-Gonzalez8af548d2008-04-08 13:24:46 -07002027 */
Alan Stern3b29b682011-02-22 09:53:41 -05002028static void choose_devnum(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002029{
2030 int devnum;
2031 struct usb_bus *bus = udev->bus;
2032
Petr Mladek638139e2014-09-19 17:32:24 +02002033 /* be safe when more hub events are proceed in parallel */
Chris Bainbridgefeb26ac2016-04-25 13:48:38 +01002034 mutex_lock(&bus->devnum_next_mutex);
Inaky Perez-Gonzalez8af548d2008-04-08 13:24:46 -07002035 if (udev->wusb) {
2036 devnum = udev->portnum + 1;
2037 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
2038 } else {
2039 /* Try to allocate the next devnum beginning at
2040 * bus->devnum_next. */
2041 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
2042 bus->devnum_next);
2043 if (devnum >= 128)
2044 devnum = find_next_zero_bit(bus->devmap.devicemap,
2045 128, 1);
Matthias Beyer469271f2013-10-10 23:41:27 +02002046 bus->devnum_next = (devnum >= 127 ? 1 : devnum + 1);
Inaky Perez-Gonzalez8af548d2008-04-08 13:24:46 -07002047 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048 if (devnum < 128) {
2049 set_bit(devnum, bus->devmap.devicemap);
2050 udev->devnum = devnum;
2051 }
Chris Bainbridgefeb26ac2016-04-25 13:48:38 +01002052 mutex_unlock(&bus->devnum_next_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002053}
2054
Alan Stern3b29b682011-02-22 09:53:41 -05002055static void release_devnum(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002056{
2057 if (udev->devnum > 0) {
2058 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2059 udev->devnum = -1;
2060 }
2061}
2062
Alan Stern3b29b682011-02-22 09:53:41 -05002063static void update_devnum(struct usb_device *udev, int devnum)
David Vrabel4953d142008-04-08 13:24:46 -07002064{
2065 /* The address for a WUSB device is managed by wusbcore. */
2066 if (!udev->wusb)
2067 udev->devnum = devnum;
2068}
2069
Herbert Xuf7410ce2010-01-10 20:15:03 +11002070static void hub_free_dev(struct usb_device *udev)
2071{
2072 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2073
2074 /* Root hubs aren't real devices, so don't free HCD resources */
2075 if (hcd->driver->free_dev && udev->parent)
2076 hcd->driver->free_dev(hcd, udev);
2077}
2078
Dan Williams7027df32014-05-20 18:09:36 -07002079static void hub_disconnect_children(struct usb_device *udev)
2080{
2081 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2082 int i;
2083
2084 /* Free up all the children before we remove this device */
2085 for (i = 0; i < udev->maxchild; i++) {
2086 if (hub->ports[i]->child)
2087 usb_disconnect(&hub->ports[i]->child);
2088 }
2089}
2090
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091/**
2092 * usb_disconnect - disconnect a device (usbcore-internal)
2093 * @pdev: pointer to device being disconnected
2094 * Context: !in_interrupt ()
2095 *
2096 * Something got disconnected. Get rid of it and all of its children.
2097 *
2098 * If *pdev is a normal device then the parent hub must already be locked.
Heiner Kallweita4b5d602016-02-03 23:35:23 +01002099 * If *pdev is a root hub then the caller must hold the usb_bus_idr_lock,
Bjorn Helgaasdb8f2aa2013-09-13 13:57:34 -06002100 * which protects the set of root hubs as well as the list of buses.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101 *
2102 * Only hub drivers (including virtual root hub drivers for host
2103 * controllers) should ever call this.
2104 *
2105 * This call is synchronous, and may not be used in an interrupt context.
2106 */
2107void usb_disconnect(struct usb_device **pdev)
2108{
Dan Williams7027df32014-05-20 18:09:36 -07002109 struct usb_port *port_dev = NULL;
2110 struct usb_device *udev = *pdev;
Peter Chen5b1dc202014-08-19 08:56:21 +08002111 struct usb_hub *hub = NULL;
2112 int port1 = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113
Linus Torvalds1da177e2005-04-16 15:20:36 -07002114 /* mark the device as inactive, so any further urb submissions for
2115 * this device (and any of its children) will fail immediately.
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002116 * this quiesces everything except pending urbs.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117 */
2118 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
Alan Stern3b29b682011-02-22 09:53:41 -05002119 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2120 udev->devnum);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002121
Guenter Roeck219a99d2017-03-20 14:30:50 -07002122 /*
2123 * Ensure that the pm runtime code knows that the USB device
2124 * is in the process of being disconnected.
2125 */
2126 pm_runtime_barrier(&udev->dev);
2127
Alan Stern9ad3d6c2005-11-17 17:10:32 -05002128 usb_lock_device(udev);
2129
Dan Williams7027df32014-05-20 18:09:36 -07002130 hub_disconnect_children(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002131
2132 /* deallocate hcd/hardware state ... nuking all pending urbs and
2133 * cleaning up all state associated with the current configuration
2134 * so that the hardware is now fully quiesced.
2135 */
Chase Metzger17248562015-08-11 21:34:37 -07002136 dev_dbg(&udev->dev, "unregistering device\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002137 usb_disable_device(udev, 0);
Alan Sterncde217a2008-10-21 15:28:46 -04002138 usb_hcd_synchronize_unlinks(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002139
Lan Tianyufde26382013-01-20 01:53:33 +08002140 if (udev->parent) {
Dan Williams7027df32014-05-20 18:09:36 -07002141 port1 = udev->portnum;
2142 hub = usb_hub_to_struct_hub(udev->parent);
2143 port_dev = hub->ports[port1 - 1];
Lan Tianyufde26382013-01-20 01:53:33 +08002144
2145 sysfs_remove_link(&udev->dev.kobj, "port");
2146 sysfs_remove_link(&port_dev->dev.kobj, "device");
Lan Tianyu971fcd42013-01-23 04:26:29 +08002147
Dan Williams7027df32014-05-20 18:09:36 -07002148 /*
2149 * As usb_port_runtime_resume() de-references udev, make
2150 * sure no resumes occur during removal
2151 */
2152 if (!test_and_set_bit(port1, hub->child_usage_bits))
2153 pm_runtime_get_sync(&port_dev->dev);
Lan Tianyufde26382013-01-20 01:53:33 +08002154 }
2155
Alan Stern3b23dd62008-12-05 14:10:34 -05002156 usb_remove_ep_devs(&udev->ep0);
Alan Stern782da722006-07-01 22:09:35 -04002157 usb_unlock_device(udev);
Greg Kroah-Hartman3099e752005-06-20 21:15:16 -07002158
Alan Stern782da722006-07-01 22:09:35 -04002159 /* Unregister the device. The device driver is responsible
Alan Stern3b23dd62008-12-05 14:10:34 -05002160 * for de-configuring the device and invoking the remove-device
2161 * notifier chain (used by usbfs and possibly others).
Alan Stern782da722006-07-01 22:09:35 -04002162 */
2163 device_del(&udev->dev);
2164
2165 /* Free the device number and delete the parent's children[]
Linus Torvalds1da177e2005-04-16 15:20:36 -07002166 * (or root_hub) pointer.
2167 */
Alan Stern3b29b682011-02-22 09:53:41 -05002168 release_devnum(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002169
2170 /* Avoid races with recursively_mark_NOTATTACHED() */
2171 spin_lock_irq(&device_state_lock);
2172 *pdev = NULL;
2173 spin_unlock_irq(&device_state_lock);
2174
Dan Williams7027df32014-05-20 18:09:36 -07002175 if (port_dev && test_and_clear_bit(port1, hub->child_usage_bits))
2176 pm_runtime_put(&port_dev->dev);
2177
Herbert Xuf7410ce2010-01-10 20:15:03 +11002178 hub_free_dev(udev);
2179
Alan Stern782da722006-07-01 22:09:35 -04002180 put_device(&udev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002181}
2182
Greg Kroah-Hartmanf2a383e2007-11-26 22:11:55 -08002183#ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184static void show_string(struct usb_device *udev, char *id, char *string)
2185{
2186 if (!string)
2187 return;
Joe Perchesf2ec5222012-10-28 01:05:51 -07002188 dev_info(&udev->dev, "%s: %s\n", id, string);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002189}
2190
Greg Kroah-Hartmanf2a383e2007-11-26 22:11:55 -08002191static void announce_device(struct usb_device *udev)
2192{
2193 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2194 le16_to_cpu(udev->descriptor.idVendor),
2195 le16_to_cpu(udev->descriptor.idProduct));
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08002196 dev_info(&udev->dev,
2197 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
Greg Kroah-Hartmanf2a383e2007-11-26 22:11:55 -08002198 udev->descriptor.iManufacturer,
2199 udev->descriptor.iProduct,
2200 udev->descriptor.iSerialNumber);
2201 show_string(udev, "Product", udev->product);
2202 show_string(udev, "Manufacturer", udev->manufacturer);
2203 show_string(udev, "SerialNumber", udev->serial);
2204}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002205#else
Greg Kroah-Hartmanf2a383e2007-11-26 22:11:55 -08002206static inline void announce_device(struct usb_device *udev) { }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002207#endif
2208
Linus Torvalds1da177e2005-04-16 15:20:36 -07002209
Oliver Neukum3ede7602007-01-11 14:35:50 +01002210/**
Alan Stern8d8558d2009-12-08 15:50:41 -05002211 * usb_enumerate_device_otg - FIXME (usbcore-internal)
Oliver Neukum3ede7602007-01-11 14:35:50 +01002212 * @udev: newly addressed device (in ADDRESS state)
2213 *
Alan Stern8d8558d2009-12-08 15:50:41 -05002214 * Finish enumeration for On-The-Go devices
Yacine Belkadi626f0902013-08-02 20:10:04 +02002215 *
2216 * Return: 0 if successful. A negative error code otherwise.
Oliver Neukum3ede7602007-01-11 14:35:50 +01002217 */
Alan Stern8d8558d2009-12-08 15:50:41 -05002218static int usb_enumerate_device_otg(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002219{
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002220 int err = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002221
2222#ifdef CONFIG_USB_OTG
2223 /*
2224 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2225 * to wake us after we've powered off VBUS; and HNP, switching roles
2226 * "host" to "peripheral". The OTG descriptor helps figure this out.
2227 */
2228 if (!udev->bus->is_b_host
2229 && udev->config
2230 && udev->parent == udev->bus->root_hub) {
Felipe Balbi2eb50522009-12-04 15:47:43 +02002231 struct usb_otg_descriptor *desc = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002232 struct usb_bus *bus = udev->bus;
Li Jun7d2d6412015-08-31 16:20:49 +08002233 unsigned port1 = udev->portnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002234
2235 /* descriptor may appear anywhere in config */
Li Jun7d2d6412015-08-31 16:20:49 +08002236 err = __usb_get_extra_descriptor(udev->rawdescriptors[0],
2237 le16_to_cpu(udev->config[0].desc.wTotalLength),
Mathias Payerfe26b8d2018-12-05 21:19:59 +01002238 USB_DT_OTG, (void **) &desc, sizeof(*desc));
Li Jun7d2d6412015-08-31 16:20:49 +08002239 if (err || !(desc->bmAttributes & USB_OTG_HNP))
2240 return 0;
David Brownellfc849b82006-09-18 16:53:26 -07002241
Li Jun7d2d6412015-08-31 16:20:49 +08002242 dev_info(&udev->dev, "Dual-Role OTG device on %sHNP port\n",
2243 (port1 == bus->otg_port) ? "" : "non-");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002244
Li Jun7d2d6412015-08-31 16:20:49 +08002245 /* enable HNP before suspend, it's simpler */
2246 if (port1 == bus->otg_port) {
2247 bus->b_hnp_enable = 1;
2248 err = usb_control_msg(udev,
2249 usb_sndctrlpipe(udev, 0),
2250 USB_REQ_SET_FEATURE, 0,
2251 USB_DEVICE_B_HNP_ENABLE,
2252 0, NULL, 0,
2253 USB_CTRL_SET_TIMEOUT);
2254 if (err < 0) {
2255 /*
2256 * OTG MESSAGE: report errors here,
2257 * customize to match your product.
2258 */
2259 dev_err(&udev->dev, "can't set HNP mode: %d\n",
2260 err);
2261 bus->b_hnp_enable = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002262 }
Li Jun7d2d6412015-08-31 16:20:49 +08002263 } else if (desc->bLength == sizeof
2264 (struct usb_otg_descriptor)) {
2265 /* Set a_alt_hnp_support for legacy otg device */
2266 err = usb_control_msg(udev,
2267 usb_sndctrlpipe(udev, 0),
2268 USB_REQ_SET_FEATURE, 0,
2269 USB_DEVICE_A_ALT_HNP_SUPPORT,
2270 0, NULL, 0,
2271 USB_CTRL_SET_TIMEOUT);
2272 if (err < 0)
2273 dev_err(&udev->dev,
2274 "set a_alt_hnp_support failed: %d\n",
2275 err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002276 }
2277 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002278#endif
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002279 return err;
2280}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002281
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002282
2283/**
Alan Stern8d8558d2009-12-08 15:50:41 -05002284 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002285 * @udev: newly addressed device (in ADDRESS state)
2286 *
2287 * This is only called by usb_new_device() and usb_authorize_device()
2288 * and FIXME -- all comments that apply to them apply here wrt to
2289 * environment.
2290 *
2291 * If the device is WUSB and not authorized, we don't attempt to read
2292 * the string descriptors, as they will be errored out by the device
2293 * until it has been authorized.
Yacine Belkadi626f0902013-08-02 20:10:04 +02002294 *
2295 * Return: 0 if successful. A negative error code otherwise.
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002296 */
Alan Stern8d8558d2009-12-08 15:50:41 -05002297static int usb_enumerate_device(struct usb_device *udev)
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002298{
2299 int err;
Peter Chen026f3fc2014-08-19 09:51:53 +08002300 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002301
2302 if (udev->config == NULL) {
2303 err = usb_get_configuration(udev);
2304 if (err < 0) {
Alan Sterne9e88fb2013-03-27 16:14:01 -04002305 if (err != -ENODEV)
2306 dev_err(&udev->dev, "can't read configurations, error %d\n",
2307 err);
Laurent Pinchart80da2e02012-07-19 12:39:13 +02002308 return err;
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002309 }
2310 }
Thomas Pugliese83e83ec2013-12-09 13:40:29 -06002311
2312 /* read the standard strings and cache them if present */
2313 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2314 udev->manufacturer = usb_cache_string(udev,
2315 udev->descriptor.iManufacturer);
2316 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2317
Alan Stern8d8558d2009-12-08 15:50:41 -05002318 err = usb_enumerate_device_otg(udev);
Laurent Pinchart80da2e02012-07-19 12:39:13 +02002319 if (err < 0)
2320 return err;
2321
Peter Chen026f3fc2014-08-19 09:51:53 +08002322 if (IS_ENABLED(CONFIG_USB_OTG_WHITELIST) && hcd->tpl_support &&
Peter Chene5a9d622014-09-29 10:09:31 +08002323 !is_targeted(udev)) {
Peter Chen026f3fc2014-08-19 09:51:53 +08002324 /* Maybe it can talk to us, though we can't talk to it.
2325 * (Includes HNP test device.)
2326 */
Peter Chene5a9d622014-09-29 10:09:31 +08002327 if (IS_ENABLED(CONFIG_USB_OTG) && (udev->bus->b_hnp_enable
2328 || udev->bus->is_b_host)) {
Peter Chen026f3fc2014-08-19 09:51:53 +08002329 err = usb_port_suspend(udev, PMSG_AUTO_SUSPEND);
2330 if (err < 0)
2331 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2332 }
2333 return -ENOTSUPP;
2334 }
2335
Laurent Pinchart80da2e02012-07-19 12:39:13 +02002336 usb_detect_interface_quirks(udev);
2337
2338 return 0;
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002339}
2340
Matthew Garrettd35e70d2012-02-03 17:11:55 -05002341static void set_usb_port_removable(struct usb_device *udev)
2342{
2343 struct usb_device *hdev = udev->parent;
2344 struct usb_hub *hub;
2345 u8 port = udev->portnum;
2346 u16 wHubCharacteristics;
2347 bool removable = true;
2348
2349 if (!hdev)
2350 return;
2351
Lan Tianyuad493e52013-01-23 04:26:30 +08002352 hub = usb_hub_to_struct_hub(udev->parent);
Matthew Garrettd35e70d2012-02-03 17:11:55 -05002353
Matthew Garrett92bfbf72015-04-08 16:36:00 -07002354 /*
2355 * If the platform firmware has provided information about a port,
2356 * use that to determine whether it's removable.
2357 */
2358 switch (hub->ports[udev->portnum - 1]->connect_type) {
2359 case USB_PORT_CONNECT_TYPE_HOT_PLUG:
2360 udev->removable = USB_DEVICE_REMOVABLE;
2361 return;
2362 case USB_PORT_CONNECT_TYPE_HARD_WIRED:
Matthew Garrett58339c22015-04-08 16:36:01 -07002363 case USB_PORT_NOT_USED:
Matthew Garrett92bfbf72015-04-08 16:36:00 -07002364 udev->removable = USB_DEVICE_FIXED;
2365 return;
Matthew Garrett58339c22015-04-08 16:36:01 -07002366 default:
2367 break;
Matthew Garrett92bfbf72015-04-08 16:36:00 -07002368 }
2369
2370 /*
2371 * Otherwise, check whether the hub knows whether a port is removable
2372 * or not
2373 */
Matthew Garrettd35e70d2012-02-03 17:11:55 -05002374 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2375
2376 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2377 return;
2378
2379 if (hub_is_superspeed(hdev)) {
Lan Tianyuca3c1532012-09-11 04:22:36 +08002380 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2381 & (1 << port))
Matthew Garrettd35e70d2012-02-03 17:11:55 -05002382 removable = false;
2383 } else {
2384 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2385 removable = false;
2386 }
2387
2388 if (removable)
2389 udev->removable = USB_DEVICE_REMOVABLE;
2390 else
2391 udev->removable = USB_DEVICE_FIXED;
Dan Williamsa4204ff2014-05-20 18:08:22 -07002392
Matthew Garrettd35e70d2012-02-03 17:11:55 -05002393}
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002394
2395/**
2396 * usb_new_device - perform initial device setup (usbcore-internal)
2397 * @udev: newly addressed device (in ADDRESS state)
2398 *
Alan Stern8d8558d2009-12-08 15:50:41 -05002399 * This is called with devices which have been detected but not fully
2400 * enumerated. The device descriptor is available, but not descriptors
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002401 * for any device configuration. The caller must have locked either
2402 * the parent hub (if udev is a normal device) or else the
Heiner Kallweita4b5d602016-02-03 23:35:23 +01002403 * usb_bus_idr_lock (if udev is a root hub). The parent's pointer to
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002404 * udev has already been installed, but udev is not yet visible through
2405 * sysfs or other filesystem code.
2406 *
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002407 * This call is synchronous, and may not be used in an interrupt context.
2408 *
2409 * Only the hub driver or root-hub registrar should ever call this.
Yacine Belkadi626f0902013-08-02 20:10:04 +02002410 *
2411 * Return: Whether the device is configured properly or not. Zero if the
2412 * interface was registered with the driver core; else a negative errno
2413 * value.
2414 *
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002415 */
2416int usb_new_device(struct usb_device *udev)
2417{
2418 int err;
2419
Dan Streetman16985402010-01-06 09:56:53 -05002420 if (udev->parent) {
Dan Streetman16985402010-01-06 09:56:53 -05002421 /* Initialize non-root-hub device wakeup to disabled;
2422 * device (un)configuration controls wakeup capable
2423 * sysfs power/wakeup controls wakeup enabled/disabled
2424 */
2425 device_init_wakeup(&udev->dev, 0);
Dan Streetman16985402010-01-06 09:56:53 -05002426 }
2427
Alan Stern9bbdf1e2010-01-08 12:57:28 -05002428 /* Tell the runtime-PM framework the device is active */
2429 pm_runtime_set_active(&udev->dev);
Alan Sternc08512c2010-11-15 15:57:58 -05002430 pm_runtime_get_noresume(&udev->dev);
Alan Sternfcc4a012010-11-15 15:57:51 -05002431 pm_runtime_use_autosuspend(&udev->dev);
Alan Stern9bbdf1e2010-01-08 12:57:28 -05002432 pm_runtime_enable(&udev->dev);
2433
Alan Sternc08512c2010-11-15 15:57:58 -05002434 /* By default, forbid autosuspend for all devices. It will be
2435 * allowed for hubs during binding.
2436 */
2437 usb_disable_autosuspend(udev);
2438
Alan Stern8d8558d2009-12-08 15:50:41 -05002439 err = usb_enumerate_device(udev); /* Read descriptors */
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002440 if (err < 0)
2441 goto fail;
Sarah Sharpc6515272009-04-27 19:57:26 -07002442 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2443 udev->devnum, udev->bus->busnum,
2444 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
Kay Sievers9f8b17e2007-03-13 15:59:31 +01002445 /* export the usbdev device-node for libusb */
2446 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2447 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2448
Alan Stern6cd13202008-11-13 15:08:30 -05002449 /* Tell the world! */
2450 announce_device(udev);
Alan Stern195af2c2007-07-16 15:28:19 -04002451
Theodore Ts'ob04b3152012-07-04 11:22:20 -04002452 if (udev->serial)
2453 add_device_randomness(udev->serial, strlen(udev->serial));
2454 if (udev->product)
2455 add_device_randomness(udev->product, strlen(udev->product));
2456 if (udev->manufacturer)
2457 add_device_randomness(udev->manufacturer,
2458 strlen(udev->manufacturer));
2459
Rafael J. Wysocki927bc912010-02-08 19:18:16 +01002460 device_enable_async_suspend(&udev->dev);
Matthew Garrettd35e70d2012-02-03 17:11:55 -05002461
Dan Williamsa4204ff2014-05-20 18:08:22 -07002462 /* check whether the hub or firmware marks this port as non-removable */
Matthew Garrettd35e70d2012-02-03 17:11:55 -05002463 if (udev->parent)
2464 set_usb_port_removable(udev);
2465
Alan Stern782da722006-07-01 22:09:35 -04002466 /* Register the device. The device driver is responsible
Alan Stern3b23dd62008-12-05 14:10:34 -05002467 * for configuring the device and invoking the add-device
2468 * notifier chain (used by usbfs and possibly others).
Alan Stern782da722006-07-01 22:09:35 -04002469 */
Kay Sievers9f8b17e2007-03-13 15:59:31 +01002470 err = device_add(&udev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002471 if (err) {
2472 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2473 goto fail;
2474 }
Alan Stern9ad3d6c2005-11-17 17:10:32 -05002475
Lan Tianyufde26382013-01-20 01:53:33 +08002476 /* Create link files between child device and usb port device. */
2477 if (udev->parent) {
Lan Tianyuad493e52013-01-23 04:26:30 +08002478 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
Dan Williamsd5c38342014-05-20 18:08:52 -07002479 int port1 = udev->portnum;
2480 struct usb_port *port_dev = hub->ports[port1 - 1];
Lan Tianyufde26382013-01-20 01:53:33 +08002481
2482 err = sysfs_create_link(&udev->dev.kobj,
2483 &port_dev->dev.kobj, "port");
2484 if (err)
2485 goto fail;
2486
2487 err = sysfs_create_link(&port_dev->dev.kobj,
2488 &udev->dev.kobj, "device");
2489 if (err) {
2490 sysfs_remove_link(&udev->dev.kobj, "port");
2491 goto fail;
2492 }
Lan Tianyu971fcd42013-01-23 04:26:29 +08002493
Dan Williamsd5c38342014-05-20 18:08:52 -07002494 if (!test_and_set_bit(port1, hub->child_usage_bits))
2495 pm_runtime_get_sync(&port_dev->dev);
Lan Tianyufde26382013-01-20 01:53:33 +08002496 }
2497
Alan Stern3b23dd62008-12-05 14:10:34 -05002498 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
Alan Sternc08512c2010-11-15 15:57:58 -05002499 usb_mark_last_busy(udev);
2500 pm_runtime_put_sync_autosuspend(&udev->dev);
Greg Kroah-Hartmanc0664752006-08-11 01:55:12 -07002501 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002502
2503fail:
2504 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
Alan Stern9bbdf1e2010-01-08 12:57:28 -05002505 pm_runtime_disable(&udev->dev);
2506 pm_runtime_set_suspended(&udev->dev);
Inaky Perez-Gonzalezd9d16e82007-07-31 20:34:05 -07002507 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002508}
2509
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002510
2511/**
Randy Dunlapfd39c862007-10-15 17:30:02 -07002512 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2513 * @usb_dev: USB device
2514 *
2515 * Move the USB device to a very basic state where interfaces are disabled
2516 * and the device is in fact unconfigured and unusable.
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002517 *
2518 * We share a lock (that we have) with device_del(), so we need to
2519 * defer its call.
Yacine Belkadi626f0902013-08-02 20:10:04 +02002520 *
2521 * Return: 0.
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002522 */
2523int usb_deauthorize_device(struct usb_device *usb_dev)
2524{
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002525 usb_lock_device(usb_dev);
2526 if (usb_dev->authorized == 0)
2527 goto out_unauthorized;
Alan Sternda307122009-12-08 15:54:44 -05002528
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002529 usb_dev->authorized = 0;
2530 usb_set_configuration(usb_dev, -1);
Alan Sternda307122009-12-08 15:54:44 -05002531
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002532out_unauthorized:
2533 usb_unlock_device(usb_dev);
2534 return 0;
2535}
2536
2537
2538int usb_authorize_device(struct usb_device *usb_dev)
2539{
2540 int result = 0, c;
Alan Sternda307122009-12-08 15:54:44 -05002541
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002542 usb_lock_device(usb_dev);
2543 if (usb_dev->authorized == 1)
2544 goto out_authorized;
Alan Sternda307122009-12-08 15:54:44 -05002545
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002546 result = usb_autoresume_device(usb_dev);
2547 if (result < 0) {
2548 dev_err(&usb_dev->dev,
2549 "can't autoresume for authorization: %d\n", result);
2550 goto error_autoresume;
2551 }
Josef Gajduseke50a3222014-10-09 15:47:54 +02002552
2553 if (usb_dev->wusb) {
2554 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2555 if (result < 0) {
2556 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2557 "authorization: %d\n", result);
2558 goto error_device_descriptor;
2559 }
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002560 }
Alan Sternda307122009-12-08 15:54:44 -05002561
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002562 usb_dev->authorized = 1;
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002563 /* Choose and set the configuration. This registers the interfaces
2564 * with the driver core and lets interface drivers bind to them.
2565 */
Greg Kroah-Hartmanb5ea0602007-08-02 22:44:27 -06002566 c = usb_choose_configuration(usb_dev);
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002567 if (c >= 0) {
2568 result = usb_set_configuration(usb_dev, c);
2569 if (result) {
2570 dev_err(&usb_dev->dev,
2571 "can't set config #%d, error %d\n", c, result);
2572 /* This need not be fatal. The user can try to
2573 * set other configurations. */
2574 }
2575 }
2576 dev_info(&usb_dev->dev, "authorized to connect\n");
Alan Sternda307122009-12-08 15:54:44 -05002577
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002578error_device_descriptor:
Alan Sternda307122009-12-08 15:54:44 -05002579 usb_autosuspend_device(usb_dev);
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002580error_autoresume:
2581out_authorized:
Matthias Beyer781b2132013-10-10 23:41:29 +02002582 usb_unlock_device(usb_dev); /* complements locktree */
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002583 return result;
2584}
2585
Mathias Nyman0cdd49a2015-12-10 09:59:29 +02002586/*
2587 * Return 1 if port speed is SuperSpeedPlus, 0 otherwise
2588 * check it from the link protocol field of the current speed ID attribute.
2589 * current speed ID is got from ext port status request. Sublink speed attribute
2590 * table is returned with the hub BOS SSP device capability descriptor
2591 */
2592static int port_speed_is_ssp(struct usb_device *hdev, int speed_id)
2593{
2594 int ssa_count;
2595 u32 ss_attr;
2596 int i;
2597 struct usb_ssp_cap_descriptor *ssp_cap = hdev->bos->ssp_cap;
2598
2599 if (!ssp_cap)
2600 return 0;
2601
2602 ssa_count = le32_to_cpu(ssp_cap->bmAttributes) &
2603 USB_SSP_SUBLINK_SPEED_ATTRIBS;
2604
2605 for (i = 0; i <= ssa_count; i++) {
2606 ss_attr = le32_to_cpu(ssp_cap->bmSublinkSpeedAttr[i]);
2607 if (speed_id == (ss_attr & USB_SSP_SUBLINK_SPEED_SSID))
2608 return !!(ss_attr & USB_SSP_SUBLINK_SPEED_LP);
2609 }
2610 return 0;
2611}
Inaky Perez-Gonzalez93993a02007-07-31 20:34:06 -07002612
Inaky Perez-Gonzalez0165de02006-08-25 19:35:29 -07002613/* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2614static unsigned hub_is_wusb(struct usb_hub *hub)
2615{
2616 struct usb_hcd *hcd;
2617 if (hub->hdev->parent != NULL) /* not a root hub? */
2618 return 0;
Geliang Tang6ae706a2015-12-23 21:26:51 +08002619 hcd = bus_to_hcd(hub->hdev->bus);
Inaky Perez-Gonzalez0165de02006-08-25 19:35:29 -07002620 return hcd->wireless;
2621}
2622
2623
Linus Torvalds1da177e2005-04-16 15:20:36 -07002624#define PORT_RESET_TRIES 5
2625#define SET_ADDRESS_TRIES 2
2626#define GET_DESCRIPTOR_TRIES 2
2627#define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
Rusty Russell90ab5ee2012-01-13 09:32:20 +10302628#define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002629
2630#define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2631#define HUB_SHORT_RESET_TIME 10
Andiry Xu75d7cf72011-09-13 16:41:11 -07002632#define HUB_BH_RESET_TIME 50
Linus Torvalds1da177e2005-04-16 15:20:36 -07002633#define HUB_LONG_RESET_TIME 200
Sarah Sharp77c7f072012-11-14 17:16:52 -08002634#define HUB_RESET_TIMEOUT 800
Linus Torvalds1da177e2005-04-16 15:20:36 -07002635
Dan Williams48fc7db2013-12-05 17:07:27 -08002636/*
2637 * "New scheme" enumeration causes an extra state transition to be
2638 * exposed to an xhci host and causes USB3 devices to receive control
2639 * commands in the default state. This has been seen to cause
2640 * enumeration failures, so disable this enumeration scheme for USB3
2641 * devices.
2642 */
2643static bool use_new_scheme(struct usb_device *udev, int retry)
2644{
Mathias Nyman8a1b2722015-12-10 09:59:25 +02002645 if (udev->speed >= USB_SPEED_SUPER)
Dan Williams48fc7db2013-12-05 17:07:27 -08002646 return false;
2647
2648 return USE_NEW_SCHEME(retry);
2649}
2650
Rahul Bedarkar025d4432014-01-04 11:24:41 +05302651/* Is a USB 3.0 port in the Inactive or Compliance Mode state?
Stanislaw Ledwon8bea2bd2012-06-18 15:20:00 +02002652 * Port worm reset is required to recover
2653 */
Dan Williams3cd12f92014-05-29 12:58:46 -07002654static bool hub_port_warm_reset_required(struct usb_hub *hub, int port1,
2655 u16 portstatus)
Sarah Sharp10d674a2011-09-14 14:24:52 -07002656{
Dan Williams3cd12f92014-05-29 12:58:46 -07002657 u16 link_state;
2658
2659 if (!hub_is_superspeed(hub->hdev))
2660 return false;
2661
2662 if (test_bit(port1, hub->warm_reset_bits))
2663 return true;
2664
2665 link_state = portstatus & USB_PORT_STAT_LINK_STATE;
2666 return link_state == USB_SS_PORT_LS_SS_INACTIVE
2667 || link_state == USB_SS_PORT_LS_COMP_MOD;
Sarah Sharp10d674a2011-09-14 14:24:52 -07002668}
2669
Linus Torvalds1da177e2005-04-16 15:20:36 -07002670static int hub_port_wait_reset(struct usb_hub *hub, int port1,
Andiry Xu75d7cf72011-09-13 16:41:11 -07002671 struct usb_device *udev, unsigned int delay, bool warm)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002672{
2673 int delay_time, ret;
2674 u16 portstatus;
2675 u16 portchange;
Mathias Nyman0cdd49a2015-12-10 09:59:29 +02002676 u32 ext_portstatus = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002677
2678 for (delay_time = 0;
2679 delay_time < HUB_RESET_TIMEOUT;
2680 delay_time += delay) {
2681 /* wait to give the device a chance to reset */
2682 msleep(delay);
2683
2684 /* read and decode port status */
Mathias Nyman0cdd49a2015-12-10 09:59:29 +02002685 if (hub_is_superspeedplus(hub->hdev))
2686 ret = hub_ext_port_status(hub, port1,
2687 HUB_EXT_PORT_STATUS,
2688 &portstatus, &portchange,
2689 &ext_portstatus);
2690 else
2691 ret = hub_port_status(hub, port1, &portstatus,
2692 &portchange);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002693 if (ret < 0)
2694 return ret;
2695
Guenter Roeckec0c5f02016-12-01 13:49:59 -08002696 /*
2697 * The port state is unknown until the reset completes.
2698 *
2699 * On top of that, some chips may require additional time
2700 * to re-establish a connection after the reset is complete,
2701 * so also wait for the connection to be re-established.
2702 */
2703 if (!(portstatus & USB_PORT_STAT_RESET) &&
2704 (portstatus & USB_PORT_STAT_CONNECTION))
Sarah Sharp470f0be2012-12-11 10:14:03 -08002705 break;
Sarah Sharp4f434472012-11-15 14:58:04 -08002706
Linus Torvalds1da177e2005-04-16 15:20:36 -07002707 /* switch to the long delay after two short delay failures */
2708 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2709 delay = HUB_LONG_RESET_TIME;
2710
Dan Williamsd99f6b42014-05-20 18:08:17 -07002711 dev_dbg(&hub->ports[port1 - 1]->dev,
2712 "not %sreset yet, waiting %dms\n",
2713 warm ? "warm " : "", delay);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002714 }
2715
Sarah Sharp470f0be2012-12-11 10:14:03 -08002716 if ((portstatus & USB_PORT_STAT_RESET))
2717 return -EBUSY;
2718
Dan Williams3cd12f92014-05-29 12:58:46 -07002719 if (hub_port_warm_reset_required(hub, port1, portstatus))
Sarah Sharp470f0be2012-12-11 10:14:03 -08002720 return -ENOTCONN;
2721
2722 /* Device went away? */
2723 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2724 return -ENOTCONN;
2725
Mathias Nymand15fc532017-10-17 16:07:33 +03002726 /* Retry if connect change is set but status is still connected.
2727 * A USB 3.0 connection may bounce if multiple warm resets were issued,
Sarah Sharp470f0be2012-12-11 10:14:03 -08002728 * but the device may have successfully re-connected. Ignore it.
2729 */
2730 if (!hub_is_superspeed(hub->hdev) &&
Mathias Nymand15fc532017-10-17 16:07:33 +03002731 (portchange & USB_PORT_STAT_C_CONNECTION)) {
2732 usb_clear_port_feature(hub->hdev, port1,
2733 USB_PORT_FEAT_C_CONNECTION);
2734 return -EAGAIN;
2735 }
Sarah Sharp470f0be2012-12-11 10:14:03 -08002736
2737 if (!(portstatus & USB_PORT_STAT_ENABLE))
2738 return -EBUSY;
2739
2740 if (!udev)
2741 return 0;
2742
2743 if (hub_is_wusb(hub))
2744 udev->speed = USB_SPEED_WIRELESS;
Mathias Nyman0cdd49a2015-12-10 09:59:29 +02002745 else if (hub_is_superspeedplus(hub->hdev) &&
2746 port_speed_is_ssp(hub->hdev, ext_portstatus &
2747 USB_EXT_PORT_STAT_RX_SPEED_ID))
2748 udev->speed = USB_SPEED_SUPER_PLUS;
Sarah Sharp470f0be2012-12-11 10:14:03 -08002749 else if (hub_is_superspeed(hub->hdev))
2750 udev->speed = USB_SPEED_SUPER;
2751 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2752 udev->speed = USB_SPEED_HIGH;
2753 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2754 udev->speed = USB_SPEED_LOW;
2755 else
2756 udev->speed = USB_SPEED_FULL;
2757 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002758}
2759
Andiry Xu75d7cf72011-09-13 16:41:11 -07002760/* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002761static int hub_port_reset(struct usb_hub *hub, int port1,
Andiry Xu75d7cf72011-09-13 16:41:11 -07002762 struct usb_device *udev, unsigned int delay, bool warm)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002763{
2764 int i, status;
Sarah Sharpa24a6072012-11-01 11:20:44 -07002765 u16 portchange, portstatus;
Dan Williamsd99f6b42014-05-20 18:08:17 -07002766 struct usb_port *port_dev = hub->ports[port1 - 1];
Linus Torvalds1da177e2005-04-16 15:20:36 -07002767
Sarah Sharp0fe51aa2012-11-01 11:20:44 -07002768 if (!hub_is_superspeed(hub->hdev)) {
2769 if (warm) {
Andiry Xu75d7cf72011-09-13 16:41:11 -07002770 dev_err(hub->intfdev, "only USB3 hub support "
2771 "warm reset\n");
2772 return -EINVAL;
2773 }
Sarah Sharp0fe51aa2012-11-01 11:20:44 -07002774 /* Block EHCI CF initialization during the port reset.
2775 * Some companion controllers don't like it when they mix.
2776 */
2777 down_read(&ehci_cf_port_reset_rwsem);
Sarah Sharpd3b9d7a2012-11-01 11:20:44 -07002778 } else if (!warm) {
2779 /*
2780 * If the caller hasn't explicitly requested a warm reset,
2781 * double check and see if one is needed.
2782 */
Robert Schlabbachfb6d1f72015-05-26 00:27:30 +02002783 if (hub_port_status(hub, port1, &portstatus, &portchange) == 0)
2784 if (hub_port_warm_reset_required(hub, port1,
2785 portstatus))
2786 warm = true;
Andiry Xu75d7cf72011-09-13 16:41:11 -07002787 }
Dan Williams3cd12f92014-05-29 12:58:46 -07002788 clear_bit(port1, hub->warm_reset_bits);
Alan Stern32fe0192007-10-10 16:27:07 -04002789
Linus Torvalds1da177e2005-04-16 15:20:36 -07002790 /* Reset the port */
2791 for (i = 0; i < PORT_RESET_TRIES; i++) {
Andiry Xu75d7cf72011-09-13 16:41:11 -07002792 status = set_port_feature(hub->hdev, port1, (warm ?
2793 USB_PORT_FEAT_BH_PORT_RESET :
2794 USB_PORT_FEAT_RESET));
Alan Sterne9e88fb2013-03-27 16:14:01 -04002795 if (status == -ENODEV) {
2796 ; /* The hub is gone */
2797 } else if (status) {
Dan Williamsd99f6b42014-05-20 18:08:17 -07002798 dev_err(&port_dev->dev,
2799 "cannot %sreset (err = %d)\n",
2800 warm ? "warm " : "", status);
Andiry Xu75d7cf72011-09-13 16:41:11 -07002801 } else {
2802 status = hub_port_wait_reset(hub, port1, udev, delay,
2803 warm);
Alan Sterne9e88fb2013-03-27 16:14:01 -04002804 if (status && status != -ENOTCONN && status != -ENODEV)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002805 dev_dbg(hub->intfdev,
2806 "port_wait_reset: err = %d\n",
2807 status);
2808 }
2809
Sarah Sharpa24a6072012-11-01 11:20:44 -07002810 /* Check for disconnect or reset */
Andiry Xu75d7cf72011-09-13 16:41:11 -07002811 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
Robert Schlabbachfb6d1f72015-05-26 00:27:30 +02002812 usb_clear_port_feature(hub->hdev, port1,
2813 USB_PORT_FEAT_C_RESET);
Sarah Sharpa24a6072012-11-01 11:20:44 -07002814
2815 if (!hub_is_superspeed(hub->hdev))
2816 goto done;
2817
Robert Schlabbachfb6d1f72015-05-26 00:27:30 +02002818 usb_clear_port_feature(hub->hdev, port1,
2819 USB_PORT_FEAT_C_BH_PORT_RESET);
2820 usb_clear_port_feature(hub->hdev, port1,
2821 USB_PORT_FEAT_C_PORT_LINK_STATE);
Dennis Wassenbergb7e04482018-11-13 14:40:34 +01002822
2823 if (udev)
2824 usb_clear_port_feature(hub->hdev, port1,
Robert Schlabbachfb6d1f72015-05-26 00:27:30 +02002825 USB_PORT_FEAT_C_CONNECTION);
2826
Sarah Sharpa24a6072012-11-01 11:20:44 -07002827 /*
2828 * If a USB 3.0 device migrates from reset to an error
2829 * state, re-issue the warm reset.
2830 */
2831 if (hub_port_status(hub, port1,
2832 &portstatus, &portchange) < 0)
2833 goto done;
2834
Dan Williams3cd12f92014-05-29 12:58:46 -07002835 if (!hub_port_warm_reset_required(hub, port1,
2836 portstatus))
Sarah Sharpa24a6072012-11-01 11:20:44 -07002837 goto done;
2838
2839 /*
2840 * If the port is in SS.Inactive or Compliance Mode, the
2841 * hot or warm reset failed. Try another warm reset.
2842 */
2843 if (!warm) {
Dan Williamsd99f6b42014-05-20 18:08:17 -07002844 dev_dbg(&port_dev->dev,
2845 "hot reset failed, warm reset\n");
Sarah Sharpa24a6072012-11-01 11:20:44 -07002846 warm = true;
2847 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002848 }
2849
Dan Williamsd99f6b42014-05-20 18:08:17 -07002850 dev_dbg(&port_dev->dev,
2851 "not enabled, trying %sreset again...\n",
2852 warm ? "warm " : "");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002853 delay = HUB_LONG_RESET_TIME;
2854 }
2855
Dan Williamsd99f6b42014-05-20 18:08:17 -07002856 dev_err(&port_dev->dev, "Cannot enable. Maybe the USB cable is bad?\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002857
Andiry Xu75d7cf72011-09-13 16:41:11 -07002858done:
Robert Schlabbachfb6d1f72015-05-26 00:27:30 +02002859 if (status == 0) {
2860 /* TRSTRCY = 10 ms; plus some extra */
2861 msleep(10 + 40);
2862 if (udev) {
2863 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2864
2865 update_devnum(udev, 0);
2866 /* The xHC may think the device is already reset,
2867 * so ignore the status.
2868 */
2869 if (hcd->driver->reset_device)
2870 hcd->driver->reset_device(hcd, udev);
2871
2872 usb_set_device_state(udev, USB_STATE_DEFAULT);
2873 }
2874 } else {
2875 if (udev)
2876 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2877 }
2878
Sarah Sharp0fe51aa2012-11-01 11:20:44 -07002879 if (!hub_is_superspeed(hub->hdev))
Andiry Xu75d7cf72011-09-13 16:41:11 -07002880 up_read(&ehci_cf_port_reset_rwsem);
2881
Linus Torvalds1da177e2005-04-16 15:20:36 -07002882 return status;
2883}
2884
Andiry Xu0ed9a572011-04-27 18:07:43 +08002885/* Check if a port is power on */
2886static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2887{
2888 int ret = 0;
2889
2890 if (hub_is_superspeed(hub->hdev)) {
2891 if (portstatus & USB_SS_PORT_STAT_POWER)
2892 ret = 1;
2893 } else {
2894 if (portstatus & USB_PORT_STAT_POWER)
2895 ret = 1;
2896 }
2897
2898 return ret;
2899}
2900
Dan Williams5c79a1e2014-05-20 18:09:26 -07002901static void usb_lock_port(struct usb_port *port_dev)
2902 __acquires(&port_dev->status_lock)
2903{
2904 mutex_lock(&port_dev->status_lock);
2905 __acquire(&port_dev->status_lock);
2906}
2907
2908static void usb_unlock_port(struct usb_port *port_dev)
2909 __releases(&port_dev->status_lock)
2910{
2911 mutex_unlock(&port_dev->status_lock);
2912 __release(&port_dev->status_lock);
2913}
2914
Alan Sternd388dab2006-07-01 22:14:24 -04002915#ifdef CONFIG_PM
Linus Torvalds1da177e2005-04-16 15:20:36 -07002916
Andiry Xu0ed9a572011-04-27 18:07:43 +08002917/* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2918static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2919{
2920 int ret = 0;
2921
2922 if (hub_is_superspeed(hub->hdev)) {
2923 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2924 == USB_SS_PORT_LS_U3)
2925 ret = 1;
2926 } else {
2927 if (portstatus & USB_PORT_STAT_SUSPEND)
2928 ret = 1;
2929 }
2930
2931 return ret;
2932}
Alan Sternb01b03f2008-04-28 11:06:11 -04002933
2934/* Determine whether the device on a port is ready for a normal resume,
2935 * is ready for a reset-resume, or should be disconnected.
2936 */
2937static int check_port_resume_type(struct usb_device *udev,
2938 struct usb_hub *hub, int port1,
Julius Werner7fa40912015-01-27 13:20:12 -08002939 int status, u16 portchange, u16 portstatus)
Alan Sternb01b03f2008-04-28 11:06:11 -04002940{
Dan Williamsd99f6b42014-05-20 18:08:17 -07002941 struct usb_port *port_dev = hub->ports[port1 - 1];
Julius Werner7fa40912015-01-27 13:20:12 -08002942 int retries = 3;
Dan Williamsd99f6b42014-05-20 18:08:17 -07002943
Julius Werner7fa40912015-01-27 13:20:12 -08002944 retry:
Dan Williams3cd12f92014-05-29 12:58:46 -07002945 /* Is a warm reset needed to recover the connection? */
2946 if (status == 0 && udev->reset_resume
2947 && hub_port_warm_reset_required(hub, port1, portstatus)) {
2948 /* pass */;
2949 }
Alan Sternb01b03f2008-04-28 11:06:11 -04002950 /* Is the device still present? */
Dan Williams3cd12f92014-05-29 12:58:46 -07002951 else if (status || port_is_suspended(hub, portstatus) ||
Julius Werner7fa40912015-01-27 13:20:12 -08002952 !port_is_power_on(hub, portstatus)) {
Alan Sternb01b03f2008-04-28 11:06:11 -04002953 if (status >= 0)
2954 status = -ENODEV;
Julius Werner7fa40912015-01-27 13:20:12 -08002955 } else if (!(portstatus & USB_PORT_STAT_CONNECTION)) {
2956 if (retries--) {
2957 usleep_range(200, 300);
2958 status = hub_port_status(hub, port1, &portstatus,
2959 &portchange);
2960 goto retry;
2961 }
2962 status = -ENODEV;
Alan Sternb01b03f2008-04-28 11:06:11 -04002963 }
2964
Alan Stern86c57ed2008-06-30 11:14:43 -04002965 /* Can't do a normal resume if the port isn't enabled,
2966 * so try a reset-resume instead.
2967 */
2968 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
2969 if (udev->persist_enabled)
2970 udev->reset_resume = 1;
2971 else
2972 status = -ENODEV;
2973 }
Alan Sternb01b03f2008-04-28 11:06:11 -04002974
2975 if (status) {
Dan Williamsd99f6b42014-05-20 18:08:17 -07002976 dev_dbg(&port_dev->dev, "status %04x.%04x after resume, %d\n",
2977 portchange, portstatus, status);
Alan Sternb01b03f2008-04-28 11:06:11 -04002978 } else if (udev->reset_resume) {
2979
2980 /* Late port handoff can set status-change bits */
2981 if (portchange & USB_PORT_STAT_C_CONNECTION)
Lan Tianyuad493e52013-01-23 04:26:30 +08002982 usb_clear_port_feature(hub->hdev, port1,
Alan Sternb01b03f2008-04-28 11:06:11 -04002983 USB_PORT_FEAT_C_CONNECTION);
2984 if (portchange & USB_PORT_STAT_C_ENABLE)
Lan Tianyuad493e52013-01-23 04:26:30 +08002985 usb_clear_port_feature(hub->hdev, port1,
Alan Sternb01b03f2008-04-28 11:06:11 -04002986 USB_PORT_FEAT_C_ENABLE);
2987 }
2988
2989 return status;
2990}
2991
Sarah Sharpf74631e2012-06-25 12:08:08 -07002992int usb_disable_ltm(struct usb_device *udev)
2993{
2994 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2995
2996 /* Check if the roothub and device supports LTM. */
2997 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
2998 !usb_device_supports_ltm(udev))
2999 return 0;
3000
3001 /* Clear Feature LTM Enable can only be sent if the device is
3002 * configured.
3003 */
3004 if (!udev->actconfig)
3005 return 0;
3006
3007 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3008 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3009 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3010 USB_CTRL_SET_TIMEOUT);
3011}
3012EXPORT_SYMBOL_GPL(usb_disable_ltm);
3013
3014void usb_enable_ltm(struct usb_device *udev)
3015{
3016 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3017
3018 /* Check if the roothub and device supports LTM. */
3019 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3020 !usb_device_supports_ltm(udev))
3021 return;
3022
3023 /* Set Feature LTM Enable can only be sent if the device is
3024 * configured.
3025 */
3026 if (!udev->actconfig)
3027 return;
3028
3029 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3030 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3031 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3032 USB_CTRL_SET_TIMEOUT);
3033}
3034EXPORT_SYMBOL_GPL(usb_enable_ltm);
3035
Lan Tianyu54a3ac02013-01-24 10:31:28 +08003036/*
Alan Stern28e86162013-07-30 15:37:33 -04003037 * usb_enable_remote_wakeup - enable remote wakeup for a device
Lan Tianyu54a3ac02013-01-24 10:31:28 +08003038 * @udev: target device
3039 *
Alan Stern28e86162013-07-30 15:37:33 -04003040 * For USB-2 devices: Set the device's remote wakeup feature.
3041 *
3042 * For USB-3 devices: Assume there's only one function on the device and
3043 * enable remote wake for the first interface. FIXME if the interface
3044 * association descriptor shows there's more than one function.
Lan Tianyu54a3ac02013-01-24 10:31:28 +08003045 */
Alan Stern28e86162013-07-30 15:37:33 -04003046static int usb_enable_remote_wakeup(struct usb_device *udev)
Lan Tianyu54a3ac02013-01-24 10:31:28 +08003047{
Alan Stern28e86162013-07-30 15:37:33 -04003048 if (udev->speed < USB_SPEED_SUPER)
3049 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3050 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3051 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3052 USB_CTRL_SET_TIMEOUT);
3053 else
3054 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3055 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
3056 USB_INTRF_FUNC_SUSPEND,
3057 USB_INTRF_FUNC_SUSPEND_RW |
3058 USB_INTRF_FUNC_SUSPEND_LP,
3059 NULL, 0, USB_CTRL_SET_TIMEOUT);
3060}
3061
3062/*
3063 * usb_disable_remote_wakeup - disable remote wakeup for a device
3064 * @udev: target device
3065 *
3066 * For USB-2 devices: Clear the device's remote wakeup feature.
3067 *
3068 * For USB-3 devices: Assume there's only one function on the device and
3069 * disable remote wake for the first interface. FIXME if the interface
3070 * association descriptor shows there's more than one function.
3071 */
3072static int usb_disable_remote_wakeup(struct usb_device *udev)
3073{
3074 if (udev->speed < USB_SPEED_SUPER)
3075 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3076 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3077 USB_DEVICE_REMOTE_WAKEUP, 0, NULL, 0,
3078 USB_CTRL_SET_TIMEOUT);
3079 else
3080 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
Yonglong Wu4e248002016-08-19 11:37:26 +08003081 USB_REQ_SET_FEATURE, USB_RECIP_INTERFACE,
Lan Tianyu54a3ac02013-01-24 10:31:28 +08003082 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
3083 USB_CTRL_SET_TIMEOUT);
3084}
Linus Torvalds1da177e2005-04-16 15:20:36 -07003085
Alan Sterne583d9d2013-07-11 14:58:04 -04003086/* Count of wakeup-enabled devices at or below udev */
3087static unsigned wakeup_enabled_descendants(struct usb_device *udev)
3088{
3089 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
3090
3091 return udev->do_remote_wakeup +
3092 (hub ? hub->wakeup_enabled_descendants : 0);
3093}
3094
Linus Torvalds1da177e2005-04-16 15:20:36 -07003095/*
Alan Stern140d8f62006-07-01 22:07:21 -04003096 * usb_port_suspend - suspend a usb device's upstream port
Alan Stern624d6c02007-05-30 15:35:16 -04003097 * @udev: device that's no longer in active use, not a root hub
David Brownell5edbfb72005-09-22 22:45:26 -07003098 * Context: must be able to sleep; device not locked; pm locks held
Linus Torvalds1da177e2005-04-16 15:20:36 -07003099 *
3100 * Suspends a USB device that isn't in active use, conserving power.
3101 * Devices may wake out of a suspend, if anything important happens,
3102 * using the remote wakeup mechanism. They may also be taken out of
Alan Stern140d8f62006-07-01 22:07:21 -04003103 * suspend by the host, using usb_port_resume(). It's also routine
Linus Torvalds1da177e2005-04-16 15:20:36 -07003104 * to disconnect devices while they are suspended.
3105 *
David Brownell390a8c32005-09-13 19:57:27 -07003106 * This only affects the USB hardware for a device; its interfaces
3107 * (and, for hubs, child devices) must already have been suspended.
3108 *
Alan Stern624d6c02007-05-30 15:35:16 -04003109 * Selective port suspend reduces power; most suspended devices draw
3110 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3111 * All devices below the suspended port are also suspended.
3112 *
3113 * Devices leave suspend state when the host wakes them up. Some devices
3114 * also support "remote wakeup", where the device can activate the USB
3115 * tree above them to deliver data, such as a keypress or packet. In
3116 * some cases, this wakes the USB host.
3117 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07003118 * Suspending OTG devices may trigger HNP, if that's been enabled
3119 * between a pair of dual-role devices. That will change roles, such
3120 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3121 *
Alan Stern4956ecc2007-05-30 16:51:28 -04003122 * Devices on USB hub ports have only one "suspend" state, corresponding
3123 * to ACPI D2, "may cause the device to lose some context".
3124 * State transitions include:
3125 *
3126 * - suspend, resume ... when the VBUS power link stays live
3127 * - suspend, disconnect ... VBUS lost
3128 *
3129 * Once VBUS drop breaks the circuit, the port it's using has to go through
3130 * normal re-enumeration procedures, starting with enabling VBUS power.
3131 * Other than re-initializing the hub (plug/unplug, except for root hubs),
Petr Mladek37ebb542014-09-19 17:32:23 +02003132 * Linux (2.6) currently has NO mechanisms to initiate that: no hub_wq
Alan Stern4956ecc2007-05-30 16:51:28 -04003133 * timer, no SRP, no requests through sysfs.
3134 *
Alan Sterne583d9d2013-07-11 14:58:04 -04003135 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3136 * suspended until their bus goes into global suspend (i.e., the root
Alan Stern0aa28322013-03-27 16:14:19 -04003137 * hub is suspended). Nevertheless, we change @udev->state to
3138 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3139 * upstream port setting is stored in @udev->port_is_suspended.
Alan Stern4956ecc2007-05-30 16:51:28 -04003140 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07003141 * Returns 0 on success, else negative errno.
3142 */
Alan Stern65bfd292008-11-25 16:39:18 -05003143int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003144{
Lan Tianyuad493e52013-01-23 04:26:30 +08003145 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3146 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
Alan Stern624d6c02007-05-30 15:35:16 -04003147 int port1 = udev->portnum;
3148 int status;
Alan Stern0aa28322013-03-27 16:14:19 -04003149 bool really_suspend = true;
Alan Stern4956ecc2007-05-30 16:51:28 -04003150
Dan Williams5c79a1e2014-05-20 18:09:26 -07003151 usb_lock_port(port_dev);
3152
Alan Stern624d6c02007-05-30 15:35:16 -04003153 /* enable remote wakeup when appropriate; this lets the device
3154 * wake up the upstream hub (including maybe the root hub).
3155 *
3156 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3157 * we don't explicitly enable it here.
3158 */
3159 if (udev->do_remote_wakeup) {
Alan Stern28e86162013-07-30 15:37:33 -04003160 status = usb_enable_remote_wakeup(udev);
Oliver Neukum0c487202009-10-19 13:19:41 +02003161 if (status) {
Alan Stern624d6c02007-05-30 15:35:16 -04003162 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3163 status);
Oliver Neukum0c487202009-10-19 13:19:41 +02003164 /* bail if autosuspend is requested */
Alan Stern5b1b0b82011-08-19 23:49:48 +02003165 if (PMSG_IS_AUTO(msg))
Alan Stern4fae6f02013-07-30 15:39:02 -04003166 goto err_wakeup;
Oliver Neukum0c487202009-10-19 13:19:41 +02003167 }
Alan Stern624d6c02007-05-30 15:35:16 -04003168 }
3169
Andiry Xu65580b432011-09-23 14:19:52 -07003170 /* disable USB2 hardware LPM */
Kai-Heng Feng9b916af2019-01-12 03:54:25 +08003171 usb_disable_usb2_hardware_lpm(udev);
Andiry Xu65580b432011-09-23 14:19:52 -07003172
Sarah Sharpf74631e2012-06-25 12:08:08 -07003173 if (usb_disable_ltm(udev)) {
Alan Stern4fae6f02013-07-30 15:39:02 -04003174 dev_err(&udev->dev, "Failed to disable LTM before suspend\n.");
3175 status = -ENOMEM;
3176 if (PMSG_IS_AUTO(msg))
3177 goto err_ltm;
Sarah Sharpf74631e2012-06-25 12:08:08 -07003178 }
Sarah Sharp83060952012-05-02 14:25:52 -07003179 if (usb_unlocked_disable_lpm(udev)) {
Alan Stern4fae6f02013-07-30 15:39:02 -04003180 dev_err(&udev->dev, "Failed to disable LPM before suspend\n.");
3181 status = -ENOMEM;
3182 if (PMSG_IS_AUTO(msg))
3183 goto err_lpm3;
Sarah Sharp83060952012-05-02 14:25:52 -07003184 }
3185
Alan Stern624d6c02007-05-30 15:35:16 -04003186 /* see 7.1.7.6 */
Andiry Xua7114232011-04-27 18:07:50 +08003187 if (hub_is_superspeed(hub->hdev))
Sarah Sharpc2f60db2012-12-10 15:43:08 -08003188 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
Alan Sterne583d9d2013-07-11 14:58:04 -04003189
Alan Stern0aa28322013-03-27 16:14:19 -04003190 /*
3191 * For system suspend, we do not need to enable the suspend feature
3192 * on individual USB-2 ports. The devices will automatically go
3193 * into suspend a few ms after the root hub stops sending packets.
3194 * The USB 2.0 spec calls this "global suspend".
Alan Sterne583d9d2013-07-11 14:58:04 -04003195 *
3196 * However, many USB hubs have a bug: They don't relay wakeup requests
3197 * from a downstream port if the port's suspend feature isn't on.
3198 * Therefore we will turn on the suspend feature if udev or any of its
3199 * descendants is enabled for remote wakeup.
Alan Stern0aa28322013-03-27 16:14:19 -04003200 */
Alan Sterne583d9d2013-07-11 14:58:04 -04003201 else if (PMSG_IS_AUTO(msg) || wakeup_enabled_descendants(udev) > 0)
3202 status = set_port_feature(hub->hdev, port1,
3203 USB_PORT_FEAT_SUSPEND);
Alan Stern0aa28322013-03-27 16:14:19 -04003204 else {
3205 really_suspend = false;
3206 status = 0;
3207 }
Alan Stern624d6c02007-05-30 15:35:16 -04003208 if (status) {
Dan Williamsd99f6b42014-05-20 18:08:17 -07003209 dev_dbg(&port_dev->dev, "can't suspend, status %d\n", status);
Alan Sterncbb33002011-06-15 16:29:16 -04003210
Alan Stern4fae6f02013-07-30 15:39:02 -04003211 /* Try to enable USB3 LPM and LTM again */
3212 usb_unlocked_enable_lpm(udev);
3213 err_lpm3:
3214 usb_enable_ltm(udev);
3215 err_ltm:
Andiry Xuc3e751e2012-05-05 00:50:10 +08003216 /* Try to enable USB2 hardware LPM again */
Kai-Heng Feng9b916af2019-01-12 03:54:25 +08003217 usb_enable_usb2_hardware_lpm(udev);
Andiry Xuc3e751e2012-05-05 00:50:10 +08003218
Alan Stern4fae6f02013-07-30 15:39:02 -04003219 if (udev->do_remote_wakeup)
3220 (void) usb_disable_remote_wakeup(udev);
3221 err_wakeup:
Sarah Sharp83060952012-05-02 14:25:52 -07003222
Alan Sterncbb33002011-06-15 16:29:16 -04003223 /* System sleep transitions should never fail */
Alan Stern5b1b0b82011-08-19 23:49:48 +02003224 if (!PMSG_IS_AUTO(msg))
Alan Sterncbb33002011-06-15 16:29:16 -04003225 status = 0;
Alan Stern624d6c02007-05-30 15:35:16 -04003226 } else {
Alan Stern30b1a7a2011-09-27 21:54:22 +02003227 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3228 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3229 udev->do_remote_wakeup);
Alan Stern0aa28322013-03-27 16:14:19 -04003230 if (really_suspend) {
3231 udev->port_is_suspended = 1;
Alan Sterne583d9d2013-07-11 14:58:04 -04003232
3233 /* device has up to 10 msec to fully suspend */
Alan Stern0aa28322013-03-27 16:14:19 -04003234 msleep(10);
3235 }
Alan Sterne583d9d2013-07-11 14:58:04 -04003236 usb_set_device_state(udev, USB_STATE_SUSPENDED);
Alan Stern624d6c02007-05-30 15:35:16 -04003237 }
Lan Tianyuad493e52013-01-23 04:26:30 +08003238
Dan Williamsd5c38342014-05-20 18:08:52 -07003239 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled
3240 && test_and_clear_bit(port1, hub->child_usage_bits))
Lan Tianyu98a4f1f2013-07-03 22:17:54 +08003241 pm_runtime_put_sync(&port_dev->dev);
Lan Tianyuad493e52013-01-23 04:26:30 +08003242
Alan Sternc08512c2010-11-15 15:57:58 -05003243 usb_mark_last_busy(hub->hdev);
Dan Williams5c79a1e2014-05-20 18:09:26 -07003244
3245 usb_unlock_port(port_dev);
Alan Stern4956ecc2007-05-30 16:51:28 -04003246 return status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003247}
David Brownellf3f32532005-09-22 22:37:29 -07003248
Linus Torvalds1da177e2005-04-16 15:20:36 -07003249/*
David Brownell390a8c32005-09-13 19:57:27 -07003250 * If the USB "suspend" state is in use (rather than "global suspend"),
3251 * many devices will be individually taken out of suspend state using
Alan Stern54515fe2007-05-30 15:38:58 -04003252 * special "resume" signaling. This routine kicks in shortly after
Linus Torvalds1da177e2005-04-16 15:20:36 -07003253 * hardware resume signaling is finished, either because of selective
3254 * resume (by host) or remote wakeup (by device) ... now see what changed
3255 * in the tree that's rooted at this device.
Alan Stern54515fe2007-05-30 15:38:58 -04003256 *
3257 * If @udev->reset_resume is set then the device is reset before the
3258 * status check is done.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003259 */
Alan Stern140d8f62006-07-01 22:07:21 -04003260static int finish_port_resume(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003261{
Alan Stern54515fe2007-05-30 15:38:58 -04003262 int status = 0;
Oliver Neukum07e72b92012-11-29 15:05:57 +01003263 u16 devstatus = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003264
3265 /* caller owns the udev device lock */
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08003266 dev_dbg(&udev->dev, "%s\n",
3267 udev->reset_resume ? "finish reset-resume" : "finish resume");
Linus Torvalds1da177e2005-04-16 15:20:36 -07003268
3269 /* usb ch9 identifies four variants of SUSPENDED, based on what
3270 * state the device resumes to. Linux currently won't see the
3271 * first two on the host side; they'd be inside hub_port_init()
Petr Mladek37ebb542014-09-19 17:32:23 +02003272 * during many timeouts, but hub_wq can't suspend until later.
Linus Torvalds1da177e2005-04-16 15:20:36 -07003273 */
3274 usb_set_device_state(udev, udev->actconfig
3275 ? USB_STATE_CONFIGURED
3276 : USB_STATE_ADDRESS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003277
Alan Stern54515fe2007-05-30 15:38:58 -04003278 /* 10.5.4.5 says not to reset a suspended port if the attached
3279 * device is enabled for remote wakeup. Hence the reset
3280 * operation is carried out here, after the port has been
3281 * resumed.
3282 */
Alan Stern1d102552014-03-18 10:39:05 -04003283 if (udev->reset_resume) {
3284 /*
3285 * If the device morphs or switches modes when it is reset,
3286 * we don't want to perform a reset-resume. We'll fail the
3287 * resume, which will cause a logical disconnect, and then
3288 * the device will be rediscovered.
3289 */
Alan Stern86c57ed2008-06-30 11:14:43 -04003290 retry_reset_resume:
Alan Stern1d102552014-03-18 10:39:05 -04003291 if (udev->quirks & USB_QUIRK_RESET)
3292 status = -ENODEV;
3293 else
3294 status = usb_reset_and_verify_device(udev);
3295 }
Alan Stern54515fe2007-05-30 15:38:58 -04003296
Matthias Beyer469271f2013-10-10 23:41:27 +02003297 /* 10.5.4.5 says be sure devices in the tree are still there.
3298 * For now let's assume the device didn't go crazy on resume,
Linus Torvalds1da177e2005-04-16 15:20:36 -07003299 * and device drivers will know about any resume quirks.
3300 */
Alan Stern54515fe2007-05-30 15:38:58 -04003301 if (status == 0) {
Alan Stern46dede42007-08-14 10:56:10 -04003302 devstatus = 0;
Alan Stern54515fe2007-05-30 15:38:58 -04003303 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
Alan Stern86c57ed2008-06-30 11:14:43 -04003304
3305 /* If a normal resume failed, try doing a reset-resume */
3306 if (status && !udev->reset_resume && udev->persist_enabled) {
3307 dev_dbg(&udev->dev, "retry with reset-resume\n");
3308 udev->reset_resume = 1;
3309 goto retry_reset_resume;
3310 }
Alan Stern54515fe2007-05-30 15:38:58 -04003311 }
Alan Sternb40b7a92006-06-19 15:12:38 -04003312
Alan Stern624d6c02007-05-30 15:35:16 -04003313 if (status) {
3314 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3315 status);
Oliver Neukum07e72b92012-11-29 15:05:57 +01003316 /*
3317 * There are a few quirky devices which violate the standard
3318 * by claiming to have remote wakeup enabled after a reset,
3319 * which crash if the feature is cleared, hence check for
3320 * udev->reset_resume
3321 */
3322 } else if (udev->actconfig && !udev->reset_resume) {
Alan Stern28e86162013-07-30 15:37:33 -04003323 if (udev->speed < USB_SPEED_SUPER) {
Lan Tianyu54a3ac02013-01-24 10:31:28 +08003324 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
Alan Stern28e86162013-07-30 15:37:33 -04003325 status = usb_disable_remote_wakeup(udev);
Lan Tianyu54a3ac02013-01-24 10:31:28 +08003326 } else {
3327 status = usb_get_status(udev, USB_RECIP_INTERFACE, 0,
3328 &devstatus);
Lan Tianyu54a3ac02013-01-24 10:31:28 +08003329 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3330 | USB_INTRF_STAT_FUNC_RW))
Alan Stern28e86162013-07-30 15:37:33 -04003331 status = usb_disable_remote_wakeup(udev);
Alan Stern4bf0ba82005-11-21 11:58:07 -05003332 }
Lan Tianyu54a3ac02013-01-24 10:31:28 +08003333
3334 if (status)
3335 dev_dbg(&udev->dev,
3336 "disable remote wakeup, status %d\n",
3337 status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003338 status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003339 }
3340 return status;
3341}
3342
Alan Stern624d6c02007-05-30 15:35:16 -04003343/*
Pratyush Ananda40178b2014-07-18 12:37:10 +05303344 * There are some SS USB devices which take longer time for link training.
3345 * XHCI specs 4.19.4 says that when Link training is successful, port
Al Cooper6b82b122015-12-02 14:55:07 -05003346 * sets CCS bit to 1. So if SW reads port status before successful link
Pratyush Ananda40178b2014-07-18 12:37:10 +05303347 * training, then it will not find device to be present.
3348 * USB Analyzer log with such buggy devices show that in some cases
3349 * device switch on the RX termination after long delay of host enabling
3350 * the VBUS. In few other cases it has been seen that device fails to
3351 * negotiate link training in first attempt. It has been
3352 * reported till now that few devices take as long as 2000 ms to train
3353 * the link after host enabling its VBUS and termination. Following
3354 * routine implements a 2000 ms timeout for link training. If in a case
3355 * link trains before timeout, loop will exit earlier.
3356 *
Al Cooper6b82b122015-12-02 14:55:07 -05003357 * There are also some 2.0 hard drive based devices and 3.0 thumb
3358 * drives that, when plugged into a 2.0 only port, take a long
3359 * time to set CCS after VBUS enable.
3360 *
Pratyush Ananda40178b2014-07-18 12:37:10 +05303361 * FIXME: If a device was connected before suspend, but was removed
3362 * while system was asleep, then the loop in the following routine will
3363 * only exit at timeout.
3364 *
Al Cooper6b82b122015-12-02 14:55:07 -05003365 * This routine should only be called when persist is enabled.
Pratyush Ananda40178b2014-07-18 12:37:10 +05303366 */
Al Cooper6b82b122015-12-02 14:55:07 -05003367static int wait_for_connected(struct usb_device *udev,
Pratyush Ananda40178b2014-07-18 12:37:10 +05303368 struct usb_hub *hub, int *port1,
3369 u16 *portchange, u16 *portstatus)
3370{
3371 int status = 0, delay_ms = 0;
3372
3373 while (delay_ms < 2000) {
3374 if (status || *portstatus & USB_PORT_STAT_CONNECTION)
3375 break;
Dominik Bozek399e5492018-04-13 10:42:31 -07003376 if (!port_is_power_on(hub, *portstatus)) {
3377 status = -ENODEV;
3378 break;
3379 }
Pratyush Ananda40178b2014-07-18 12:37:10 +05303380 msleep(20);
3381 delay_ms += 20;
3382 status = hub_port_status(hub, *port1, portstatus, portchange);
3383 }
Al Cooper6b82b122015-12-02 14:55:07 -05003384 dev_dbg(&udev->dev, "Waited %dms for CONNECT\n", delay_ms);
Pratyush Ananda40178b2014-07-18 12:37:10 +05303385 return status;
3386}
3387
3388/*
Alan Stern624d6c02007-05-30 15:35:16 -04003389 * usb_port_resume - re-activate a suspended usb device's upstream port
3390 * @udev: device to re-activate, not a root hub
3391 * Context: must be able to sleep; device not locked; pm locks held
3392 *
3393 * This will re-activate the suspended device, increasing power usage
3394 * while letting drivers communicate again with its endpoints.
3395 * USB resume explicitly guarantees that the power session between
3396 * the host and the device is the same as it was when the device
3397 * suspended.
3398 *
Alan Sternfeccc302008-03-03 15:15:59 -05003399 * If @udev->reset_resume is set then this routine won't check that the
3400 * port is still enabled. Furthermore, finish_port_resume() above will
Alan Stern54515fe2007-05-30 15:38:58 -04003401 * reset @udev. The end result is that a broken power session can be
3402 * recovered and @udev will appear to persist across a loss of VBUS power.
3403 *
3404 * For example, if a host controller doesn't maintain VBUS suspend current
3405 * during a system sleep or is reset when the system wakes up, all the USB
3406 * power sessions below it will be broken. This is especially troublesome
3407 * for mass-storage devices containing mounted filesystems, since the
3408 * device will appear to have disconnected and all the memory mappings
3409 * to it will be lost. Using the USB_PERSIST facility, the device can be
3410 * made to appear as if it had not disconnected.
3411 *
Ming Lei742120c2008-06-18 22:00:29 +08003412 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
Alan Sternfeccc302008-03-03 15:15:59 -05003413 * every effort to insure that the same device is present after the
Alan Stern54515fe2007-05-30 15:38:58 -04003414 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3415 * quite possible for a device to remain unaltered but its media to be
3416 * changed. If the user replaces a flash memory card while the system is
3417 * asleep, he will have only himself to blame when the filesystem on the
3418 * new card is corrupted and the system crashes.
3419 *
Alan Stern624d6c02007-05-30 15:35:16 -04003420 * Returns 0 on success, else negative errno.
3421 */
Alan Stern65bfd292008-11-25 16:39:18 -05003422int usb_port_resume(struct usb_device *udev, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003423{
Lan Tianyuad493e52013-01-23 04:26:30 +08003424 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3425 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
Alan Stern624d6c02007-05-30 15:35:16 -04003426 int port1 = udev->portnum;
3427 int status;
3428 u16 portchange, portstatus;
Alan Sternd25450c2006-11-20 11:14:30 -05003429
Dan Williamsd5c38342014-05-20 18:08:52 -07003430 if (!test_and_set_bit(port1, hub->child_usage_bits)) {
Lan Tianyuad493e52013-01-23 04:26:30 +08003431 status = pm_runtime_get_sync(&port_dev->dev);
Lan Tianyuad493e52013-01-23 04:26:30 +08003432 if (status < 0) {
3433 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3434 status);
3435 return status;
3436 }
3437 }
3438
Dan Williams5c79a1e2014-05-20 18:09:26 -07003439 usb_lock_port(port_dev);
3440
Alan Sternd25450c2006-11-20 11:14:30 -05003441 /* Skip the initial Clear-Suspend step for a remote wakeup */
3442 status = hub_port_status(hub, port1, &portstatus, &portchange);
Ravi Chandra Sadineni00bc3482018-04-20 11:08:21 -07003443 if (status == 0 && !port_is_suspended(hub, portstatus)) {
3444 if (portchange & USB_PORT_STAT_C_SUSPEND)
3445 pm_wakeup_event(&udev->dev, 0);
Alan Sternd25450c2006-11-20 11:14:30 -05003446 goto SuspendCleared;
Ravi Chandra Sadineni00bc3482018-04-20 11:08:21 -07003447 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003448
Linus Torvalds1da177e2005-04-16 15:20:36 -07003449 /* see 7.1.7.7; affects power usage, but not budgeting */
Andiry Xua7114232011-04-27 18:07:50 +08003450 if (hub_is_superspeed(hub->hdev))
Sarah Sharpc2f60db2012-12-10 15:43:08 -08003451 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
Andiry Xua7114232011-04-27 18:07:50 +08003452 else
Lan Tianyuad493e52013-01-23 04:26:30 +08003453 status = usb_clear_port_feature(hub->hdev,
Andiry Xua7114232011-04-27 18:07:50 +08003454 port1, USB_PORT_FEAT_SUSPEND);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003455 if (status) {
Dan Williamsd99f6b42014-05-20 18:08:17 -07003456 dev_dbg(&port_dev->dev, "can't resume, status %d\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003457 } else {
Felipe Balbibbc78c02015-02-13 15:38:33 -06003458 /* drive resume for USB_RESUME_TIMEOUT msec */
Alan Stern686314c2007-05-30 15:34:36 -04003459 dev_dbg(&udev->dev, "usb %sresume\n",
Alan Stern5b1b0b82011-08-19 23:49:48 +02003460 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
Felipe Balbibbc78c02015-02-13 15:38:33 -06003461 msleep(USB_RESUME_TIMEOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003462
Linus Torvalds1da177e2005-04-16 15:20:36 -07003463 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3464 * stop resume signaling. Then finish the resume
3465 * sequence.
3466 */
Alan Sternd25450c2006-11-20 11:14:30 -05003467 status = hub_port_status(hub, port1, &portstatus, &portchange);
Alan Stern54515fe2007-05-30 15:38:58 -04003468
Alan Sternb01b03f2008-04-28 11:06:11 -04003469 /* TRSMRCY = 10 msec */
3470 msleep(10);
3471 }
Alan Stern54515fe2007-05-30 15:38:58 -04003472
Alan Sternb01b03f2008-04-28 11:06:11 -04003473 SuspendCleared:
3474 if (status == 0) {
Alan Sternbfd1e912012-10-19 11:03:39 -04003475 udev->port_is_suspended = 0;
Andiry Xua7114232011-04-27 18:07:50 +08003476 if (hub_is_superspeed(hub->hdev)) {
3477 if (portchange & USB_PORT_STAT_C_LINK_STATE)
Lan Tianyuad493e52013-01-23 04:26:30 +08003478 usb_clear_port_feature(hub->hdev, port1,
Andiry Xua7114232011-04-27 18:07:50 +08003479 USB_PORT_FEAT_C_PORT_LINK_STATE);
3480 } else {
3481 if (portchange & USB_PORT_STAT_C_SUSPEND)
Lan Tianyuad493e52013-01-23 04:26:30 +08003482 usb_clear_port_feature(hub->hdev, port1,
Andiry Xua7114232011-04-27 18:07:50 +08003483 USB_PORT_FEAT_C_SUSPEND);
3484 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003485 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003486
Al Cooper6b82b122015-12-02 14:55:07 -05003487 if (udev->persist_enabled)
3488 status = wait_for_connected(udev, hub, &port1, &portchange,
Pratyush Ananda40178b2014-07-18 12:37:10 +05303489 &portstatus);
3490
Alan Sternb01b03f2008-04-28 11:06:11 -04003491 status = check_port_resume_type(udev,
3492 hub, port1, status, portchange, portstatus);
Alan Stern54515fe2007-05-30 15:38:58 -04003493 if (status == 0)
3494 status = finish_port_resume(udev);
3495 if (status < 0) {
3496 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3497 hub_port_logical_disconnect(hub, port1);
Andiry Xu65580b432011-09-23 14:19:52 -07003498 } else {
3499 /* Try to enable USB2 hardware LPM */
Kai-Heng Feng9b916af2019-01-12 03:54:25 +08003500 usb_enable_usb2_hardware_lpm(udev);
Sarah Sharp83060952012-05-02 14:25:52 -07003501
Sarah Sharpf74631e2012-06-25 12:08:08 -07003502 /* Try to enable USB3 LTM and LPM */
3503 usb_enable_ltm(udev);
Sarah Sharp83060952012-05-02 14:25:52 -07003504 usb_unlocked_enable_lpm(udev);
Alan Stern54515fe2007-05-30 15:38:58 -04003505 }
Andiry Xu65580b432011-09-23 14:19:52 -07003506
Dan Williams5c79a1e2014-05-20 18:09:26 -07003507 usb_unlock_port(port_dev);
3508
Linus Torvalds1da177e2005-04-16 15:20:36 -07003509 return status;
3510}
3511
Alan Stern0534d462010-01-08 12:56:30 -05003512int usb_remote_wakeup(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003513{
3514 int status = 0;
3515
Dan Williams5c79a1e2014-05-20 18:09:26 -07003516 usb_lock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003517 if (udev->state == USB_STATE_SUSPENDED) {
Alan Stern645daaa2006-08-30 15:47:02 -04003518 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
Alan Stern9bbdf1e2010-01-08 12:57:28 -05003519 status = usb_autoresume_device(udev);
3520 if (status == 0) {
3521 /* Let the drivers do their thing, then... */
3522 usb_autosuspend_device(udev);
3523 }
Alan Sternd25450c2006-11-20 11:14:30 -05003524 }
Dan Williams5c79a1e2014-05-20 18:09:26 -07003525 usb_unlock_device(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003526 return status;
3527}
3528
Dan Williams7e73be22014-05-20 18:09:31 -07003529/* Returns 1 if there was a remote wakeup and a connect status change. */
3530static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
3531 u16 portstatus, u16 portchange)
3532 __must_hold(&port_dev->status_lock)
3533{
3534 struct usb_port *port_dev = hub->ports[port - 1];
3535 struct usb_device *hdev;
3536 struct usb_device *udev;
3537 int connect_change = 0;
3538 int ret;
3539
3540 hdev = hub->hdev;
3541 udev = port_dev->child;
3542 if (!hub_is_superspeed(hdev)) {
3543 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
3544 return 0;
3545 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
3546 } else {
3547 if (!udev || udev->state != USB_STATE_SUSPENDED ||
3548 (portstatus & USB_PORT_STAT_LINK_STATE) !=
3549 USB_SS_PORT_LS_U0)
3550 return 0;
3551 }
3552
3553 if (udev) {
3554 /* TRSMRCY = 10 msec */
3555 msleep(10);
3556
3557 usb_unlock_port(port_dev);
3558 ret = usb_remote_wakeup(udev);
3559 usb_lock_port(port_dev);
3560 if (ret < 0)
3561 connect_change = 1;
3562 } else {
3563 ret = -ENODEV;
3564 hub_port_disable(hub, port, 1);
3565 }
3566 dev_dbg(&port_dev->dev, "resume, status %d\n", ret);
3567 return connect_change;
3568}
3569
Ming Leie6f30de2012-10-24 11:59:24 +08003570static int check_ports_changed(struct usb_hub *hub)
3571{
3572 int port1;
3573
3574 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3575 u16 portstatus, portchange;
3576 int status;
3577
3578 status = hub_port_status(hub, port1, &portstatus, &portchange);
3579 if (!status && portchange)
3580 return 1;
3581 }
3582 return 0;
3583}
3584
David Brownelldb690872005-09-13 19:56:33 -07003585static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003586{
Chase Metzger17248562015-08-11 21:34:37 -07003587 struct usb_hub *hub = usb_get_intfdata(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003588 struct usb_device *hdev = hub->hdev;
3589 unsigned port1;
Sarah Sharp4296c70a2012-01-06 10:34:31 -08003590 int status;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003591
Alan Sterne583d9d2013-07-11 14:58:04 -04003592 /*
3593 * Warn if children aren't already suspended.
3594 * Also, add up the number of wakeup-enabled descendants.
3595 */
3596 hub->wakeup_enabled_descendants = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003597 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
Dan Williamsd99f6b42014-05-20 18:08:17 -07003598 struct usb_port *port_dev = hub->ports[port1 - 1];
3599 struct usb_device *udev = port_dev->child;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003600
Alan Stern6840d252007-09-10 11:34:26 -04003601 if (udev && udev->can_submit) {
Dan Williamsb658b8f2014-06-17 16:16:22 -07003602 dev_warn(&port_dev->dev, "device %s not suspended yet\n",
3603 dev_name(&udev->dev));
Alan Stern5b1b0b82011-08-19 23:49:48 +02003604 if (PMSG_IS_AUTO(msg))
Alan Sterncbb33002011-06-15 16:29:16 -04003605 return -EBUSY;
David Brownellc9f89fa2005-09-13 19:57:04 -07003606 }
Alan Sterne583d9d2013-07-11 14:58:04 -04003607 if (udev)
3608 hub->wakeup_enabled_descendants +=
3609 wakeup_enabled_descendants(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003610 }
Ming Leie6f30de2012-10-24 11:59:24 +08003611
3612 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3613 /* check if there are changes pending on hub ports */
3614 if (check_ports_changed(hub)) {
3615 if (PMSG_IS_AUTO(msg))
3616 return -EBUSY;
3617 pm_wakeup_event(&hdev->dev, 2000);
3618 }
3619 }
3620
Sarah Sharp4296c70a2012-01-06 10:34:31 -08003621 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3622 /* Enable hub to send remote wakeup for all ports. */
3623 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3624 status = set_port_feature(hdev,
3625 port1 |
3626 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3627 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3628 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3629 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3630 }
3631 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07003632
Harvey Harrison441b62c2008-03-03 16:08:34 -08003633 dev_dbg(&intf->dev, "%s\n", __func__);
Alan Stern40f122f2006-11-09 14:44:33 -05003634
Petr Mladek37ebb542014-09-19 17:32:23 +02003635 /* stop hub_wq and related activity */
Alan Stern43303542008-04-28 11:07:31 -04003636 hub_quiesce(hub, HUB_SUSPEND);
Alan Sternb6f64362007-05-04 11:51:54 -04003637 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07003638}
3639
3640static int hub_resume(struct usb_interface *intf)
3641{
Alan Stern5e6effa2008-03-03 15:15:51 -05003642 struct usb_hub *hub = usb_get_intfdata(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003643
Alan Stern5e6effa2008-03-03 15:15:51 -05003644 dev_dbg(&intf->dev, "%s\n", __func__);
Alan Sternf2835212008-04-28 11:07:17 -04003645 hub_activate(hub, HUB_RESUME);
Linus Torvalds1da177e2005-04-16 15:20:36 -07003646 return 0;
3647}
3648
Alan Sternb41a60e2007-05-30 15:39:33 -04003649static int hub_reset_resume(struct usb_interface *intf)
Alan Sternf07600c2007-05-30 15:38:16 -04003650{
Alan Sternb41a60e2007-05-30 15:39:33 -04003651 struct usb_hub *hub = usb_get_intfdata(intf);
Alan Sternf07600c2007-05-30 15:38:16 -04003652
Alan Stern5e6effa2008-03-03 15:15:51 -05003653 dev_dbg(&intf->dev, "%s\n", __func__);
Alan Sternf2835212008-04-28 11:07:17 -04003654 hub_activate(hub, HUB_RESET_RESUME);
Alan Sternf07600c2007-05-30 15:38:16 -04003655 return 0;
3656}
3657
Alan Stern54515fe2007-05-30 15:38:58 -04003658/**
3659 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3660 * @rhdev: struct usb_device for the root hub
3661 *
3662 * The USB host controller driver calls this function when its root hub
3663 * is resumed and Vbus power has been interrupted or the controller
Alan Sternfeccc302008-03-03 15:15:59 -05003664 * has been reset. The routine marks @rhdev as having lost power.
3665 * When the hub driver is resumed it will take notice and carry out
3666 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3667 * the others will be disconnected.
Alan Stern54515fe2007-05-30 15:38:58 -04003668 */
3669void usb_root_hub_lost_power(struct usb_device *rhdev)
3670{
3671 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
3672 rhdev->reset_resume = 1;
3673}
3674EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3675
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003676static const char * const usb3_lpm_names[] = {
3677 "U0",
3678 "U1",
3679 "U2",
3680 "U3",
3681};
3682
3683/*
3684 * Send a Set SEL control transfer to the device, prior to enabling
3685 * device-initiated U1 or U2. This lets the device know the exit latencies from
3686 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3687 * packet from the host.
3688 *
3689 * This function will fail if the SEL or PEL values for udev are greater than
3690 * the maximum allowed values for the link state to be enabled.
3691 */
3692static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3693{
3694 struct usb_set_sel_req *sel_values;
3695 unsigned long long u1_sel;
3696 unsigned long long u1_pel;
3697 unsigned long long u2_sel;
3698 unsigned long long u2_pel;
3699 int ret;
3700
Xenia Ragiadakou38d7f682013-09-04 17:24:45 +03003701 if (udev->state != USB_STATE_CONFIGURED)
3702 return 0;
3703
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003704 /* Convert SEL and PEL stored in ns to us */
3705 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3706 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3707 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3708 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3709
3710 /*
3711 * Make sure that the calculated SEL and PEL values for the link
3712 * state we're enabling aren't bigger than the max SEL/PEL
3713 * value that will fit in the SET SEL control transfer.
3714 * Otherwise the device would get an incorrect idea of the exit
3715 * latency for the link state, and could start a device-initiated
3716 * U1/U2 when the exit latencies are too high.
3717 */
3718 if ((state == USB3_LPM_U1 &&
3719 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3720 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3721 (state == USB3_LPM_U2 &&
3722 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3723 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
Sarah Sharp1510a1a2012-10-05 10:30:35 -07003724 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003725 usb3_lpm_names[state], u1_sel, u1_pel);
3726 return -EINVAL;
3727 }
3728
3729 /*
3730 * If we're enabling device-initiated LPM for one link state,
3731 * but the other link state has a too high SEL or PEL value,
3732 * just set those values to the max in the Set SEL request.
3733 */
3734 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3735 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3736
3737 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3738 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3739
3740 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3741 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3742
3743 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3744 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3745
3746 /*
3747 * usb_enable_lpm() can be called as part of a failed device reset,
3748 * which may be initiated by an error path of a mass storage driver.
3749 * Therefore, use GFP_NOIO.
3750 */
3751 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3752 if (!sel_values)
3753 return -ENOMEM;
3754
3755 sel_values->u1_sel = u1_sel;
3756 sel_values->u1_pel = u1_pel;
3757 sel_values->u2_sel = cpu_to_le16(u2_sel);
3758 sel_values->u2_pel = cpu_to_le16(u2_pel);
3759
3760 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3761 USB_REQ_SET_SEL,
3762 USB_RECIP_DEVICE,
3763 0, 0,
3764 sel_values, sizeof *(sel_values),
3765 USB_CTRL_SET_TIMEOUT);
3766 kfree(sel_values);
3767 return ret;
3768}
3769
3770/*
3771 * Enable or disable device-initiated U1 or U2 transitions.
3772 */
3773static int usb_set_device_initiated_lpm(struct usb_device *udev,
3774 enum usb3_link_state state, bool enable)
3775{
3776 int ret;
3777 int feature;
3778
3779 switch (state) {
3780 case USB3_LPM_U1:
3781 feature = USB_DEVICE_U1_ENABLE;
3782 break;
3783 case USB3_LPM_U2:
3784 feature = USB_DEVICE_U2_ENABLE;
3785 break;
3786 default:
3787 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3788 __func__, enable ? "enable" : "disable");
3789 return -EINVAL;
3790 }
3791
3792 if (udev->state != USB_STATE_CONFIGURED) {
3793 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3794 "for unconfigured device.\n",
3795 __func__, enable ? "enable" : "disable",
3796 usb3_lpm_names[state]);
3797 return 0;
3798 }
3799
3800 if (enable) {
3801 /*
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003802 * Now send the control transfer to enable device-initiated LPM
3803 * for either U1 or U2.
3804 */
3805 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3806 USB_REQ_SET_FEATURE,
3807 USB_RECIP_DEVICE,
3808 feature,
3809 0, NULL, 0,
3810 USB_CTRL_SET_TIMEOUT);
3811 } else {
3812 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3813 USB_REQ_CLEAR_FEATURE,
3814 USB_RECIP_DEVICE,
3815 feature,
3816 0, NULL, 0,
3817 USB_CTRL_SET_TIMEOUT);
3818 }
3819 if (ret < 0) {
3820 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3821 enable ? "Enable" : "Disable",
3822 usb3_lpm_names[state]);
3823 return -EBUSY;
3824 }
3825 return 0;
3826}
3827
3828static int usb_set_lpm_timeout(struct usb_device *udev,
3829 enum usb3_link_state state, int timeout)
3830{
3831 int ret;
3832 int feature;
3833
3834 switch (state) {
3835 case USB3_LPM_U1:
3836 feature = USB_PORT_FEAT_U1_TIMEOUT;
3837 break;
3838 case USB3_LPM_U2:
3839 feature = USB_PORT_FEAT_U2_TIMEOUT;
3840 break;
3841 default:
3842 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3843 __func__);
3844 return -EINVAL;
3845 }
3846
3847 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3848 timeout != USB3_LPM_DEVICE_INITIATED) {
3849 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3850 "which is a reserved value.\n",
3851 usb3_lpm_names[state], timeout);
3852 return -EINVAL;
3853 }
3854
3855 ret = set_port_feature(udev->parent,
3856 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3857 feature);
3858 if (ret < 0) {
3859 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3860 "error code %i\n", usb3_lpm_names[state],
3861 timeout, ret);
3862 return -EBUSY;
3863 }
3864 if (state == USB3_LPM_U1)
3865 udev->u1_params.timeout = timeout;
3866 else
3867 udev->u2_params.timeout = timeout;
3868 return 0;
3869}
3870
3871/*
3872 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3873 * U1/U2 entry.
3874 *
3875 * We will attempt to enable U1 or U2, but there are no guarantees that the
3876 * control transfers to set the hub timeout or enable device-initiated U1/U2
3877 * will be successful.
3878 *
3879 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3880 * driver know about it. If that call fails, it should be harmless, and just
3881 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3882 */
3883static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3884 enum usb3_link_state state)
3885{
Sarah Sharp65a95b72012-10-05 10:32:07 -07003886 int timeout, ret;
Sarah Sharpae8963a2012-10-03 11:18:05 -07003887 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
3888 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
3889
3890 /* If the device says it doesn't have *any* exit latency to come out of
3891 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3892 * state.
3893 */
3894 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
3895 (state == USB3_LPM_U2 && u2_mel == 0))
3896 return;
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003897
Sarah Sharp65a95b72012-10-05 10:32:07 -07003898 /*
3899 * First, let the device know about the exit latencies
3900 * associated with the link state we're about to enable.
3901 */
3902 ret = usb_req_set_sel(udev, state);
3903 if (ret < 0) {
3904 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
3905 usb3_lpm_names[state]);
3906 return;
3907 }
3908
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003909 /* We allow the host controller to set the U1/U2 timeout internally
3910 * first, so that it can change its schedule to account for the
3911 * additional latency to send data to a device in a lower power
3912 * link state.
3913 */
3914 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
3915
3916 /* xHCI host controller doesn't want to enable this LPM state. */
3917 if (timeout == 0)
3918 return;
3919
3920 if (timeout < 0) {
3921 dev_warn(&udev->dev, "Could not enable %s link state, "
3922 "xHCI error %i.\n", usb3_lpm_names[state],
3923 timeout);
3924 return;
3925 }
3926
Lu Baolubf5ce5b2015-11-14 16:26:32 +08003927 if (usb_set_lpm_timeout(udev, state, timeout)) {
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003928 /* If we can't set the parent hub U1/U2 timeout,
3929 * device-initiated LPM won't be allowed either, so let the xHCI
3930 * host know that this link state won't be enabled.
3931 */
3932 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
Lu Baolubf5ce5b2015-11-14 16:26:32 +08003933 } else {
3934 /* Only a configured device will accept the Set Feature
3935 * U1/U2_ENABLE
3936 */
3937 if (udev->actconfig)
3938 usb_set_device_initiated_lpm(udev, state, true);
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003939
Lu Baolubf5ce5b2015-11-14 16:26:32 +08003940 /* As soon as usb_set_lpm_timeout(timeout) returns 0, the
3941 * hub-initiated LPM is enabled. Thus, LPM is enabled no
3942 * matter the result of usb_set_device_initiated_lpm().
3943 * The only difference is whether device is able to initiate
3944 * LPM.
3945 */
3946 if (state == USB3_LPM_U1)
3947 udev->usb3_lpm_u1_enabled = 1;
3948 else if (state == USB3_LPM_U2)
3949 udev->usb3_lpm_u2_enabled = 1;
3950 }
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003951}
3952
3953/*
3954 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3955 * U1/U2 entry.
3956 *
3957 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3958 * If zero is returned, the parent will not allow the link to go into U1/U2.
3959 *
3960 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3961 * it won't have an effect on the bus link state because the parent hub will
3962 * still disallow device-initiated U1/U2 entry.
3963 *
3964 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3965 * possible. The result will be slightly more bus bandwidth will be taken up
3966 * (to account for U1/U2 exit latency), but it should be harmless.
3967 */
3968static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3969 enum usb3_link_state state)
3970{
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003971 switch (state) {
3972 case USB3_LPM_U1:
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003973 case USB3_LPM_U2:
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07003974 break;
3975 default:
3976 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
3977 __func__);
3978 return -EINVAL;
3979 }
3980
3981 if (usb_set_lpm_timeout(udev, state, 0))
3982 return -EBUSY;
3983
3984 usb_set_device_initiated_lpm(udev, state, false);
3985
3986 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
3987 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
3988 "bus schedule bandwidth may be impacted.\n",
3989 usb3_lpm_names[state]);
Lu Baolubf5ce5b2015-11-14 16:26:32 +08003990
3991 /* As soon as usb_set_lpm_timeout(0) return 0, hub initiated LPM
3992 * is disabled. Hub will disallows link to enter U1/U2 as well,
3993 * even device is initiating LPM. Hence LPM is disabled if hub LPM
3994 * timeout set to 0, no matter device-initiated LPM is disabled or
3995 * not.
3996 */
3997 if (state == USB3_LPM_U1)
3998 udev->usb3_lpm_u1_enabled = 0;
3999 else if (state == USB3_LPM_U2)
4000 udev->usb3_lpm_u2_enabled = 0;
4001
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07004002 return 0;
4003}
4004
4005/*
4006 * Disable hub-initiated and device-initiated U1 and U2 entry.
4007 * Caller must own the bandwidth_mutex.
4008 *
4009 * This will call usb_enable_lpm() on failure, which will decrement
4010 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
4011 */
4012int usb_disable_lpm(struct usb_device *udev)
4013{
4014 struct usb_hcd *hcd;
4015
4016 if (!udev || !udev->parent ||
Mathias Nyman8a1b2722015-12-10 09:59:25 +02004017 udev->speed < USB_SPEED_SUPER ||
Pratyush Anand51df62f2014-07-04 17:01:27 +03004018 !udev->lpm_capable ||
4019 udev->state < USB_STATE_DEFAULT)
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07004020 return 0;
4021
4022 hcd = bus_to_hcd(udev->bus);
4023 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
4024 return 0;
4025
4026 udev->lpm_disable_count++;
Dan Carpenter55558c32012-05-22 20:54:34 +03004027 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07004028 return 0;
4029
4030 /* If LPM is enabled, attempt to disable it. */
4031 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
4032 goto enable_lpm;
4033 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
4034 goto enable_lpm;
4035
4036 return 0;
4037
4038enable_lpm:
4039 usb_enable_lpm(udev);
4040 return -EBUSY;
4041}
4042EXPORT_SYMBOL_GPL(usb_disable_lpm);
4043
4044/* Grab the bandwidth_mutex before calling usb_disable_lpm() */
4045int usb_unlocked_disable_lpm(struct usb_device *udev)
4046{
4047 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4048 int ret;
4049
4050 if (!hcd)
4051 return -EINVAL;
4052
4053 mutex_lock(hcd->bandwidth_mutex);
4054 ret = usb_disable_lpm(udev);
4055 mutex_unlock(hcd->bandwidth_mutex);
4056
4057 return ret;
4058}
4059EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4060
4061/*
4062 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
4063 * xHCI host policy may prevent U1 or U2 from being enabled.
4064 *
4065 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
4066 * until the lpm_disable_count drops to zero. Caller must own the
4067 * bandwidth_mutex.
4068 */
4069void usb_enable_lpm(struct usb_device *udev)
4070{
4071 struct usb_hcd *hcd;
Lu Baolu513072d2015-11-14 16:26:33 +08004072 struct usb_hub *hub;
4073 struct usb_port *port_dev;
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07004074
4075 if (!udev || !udev->parent ||
Mathias Nyman8a1b2722015-12-10 09:59:25 +02004076 udev->speed < USB_SPEED_SUPER ||
Pratyush Anand51df62f2014-07-04 17:01:27 +03004077 !udev->lpm_capable ||
4078 udev->state < USB_STATE_DEFAULT)
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07004079 return;
4080
4081 udev->lpm_disable_count--;
4082 hcd = bus_to_hcd(udev->bus);
4083 /* Double check that we can both enable and disable LPM.
4084 * Device must be configured to accept set feature U1/U2 timeout.
4085 */
4086 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
4087 !hcd->driver->disable_usb3_lpm_timeout)
4088 return;
4089
4090 if (udev->lpm_disable_count > 0)
4091 return;
4092
Lu Baolu513072d2015-11-14 16:26:33 +08004093 hub = usb_hub_to_struct_hub(udev->parent);
4094 if (!hub)
4095 return;
4096
4097 port_dev = hub->ports[udev->portnum - 1];
4098
4099 if (port_dev->usb3_lpm_u1_permit)
4100 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
4101
4102 if (port_dev->usb3_lpm_u2_permit)
4103 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07004104}
4105EXPORT_SYMBOL_GPL(usb_enable_lpm);
4106
4107/* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4108void usb_unlocked_enable_lpm(struct usb_device *udev)
4109{
4110 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4111
4112 if (!hcd)
4113 return;
4114
4115 mutex_lock(hcd->bandwidth_mutex);
4116 usb_enable_lpm(udev);
4117 mutex_unlock(hcd->bandwidth_mutex);
4118}
4119EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4120
Mathias Nyman32a35352016-11-17 11:14:14 +02004121/* usb3 devices use U3 for disabled, make sure remote wakeup is disabled */
4122static void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4123 struct usb_port *port_dev)
4124{
4125 struct usb_device *udev = port_dev->child;
4126 int ret;
4127
4128 if (udev && udev->port_is_suspended && udev->do_remote_wakeup) {
4129 ret = hub_set_port_link_state(hub, port_dev->portnum,
4130 USB_SS_PORT_LS_U0);
4131 if (!ret) {
4132 msleep(USB_RESUME_TIMEOUT);
4133 ret = usb_disable_remote_wakeup(udev);
4134 }
4135 if (ret)
4136 dev_warn(&udev->dev,
4137 "Port disable: can't disable remote wake\n");
4138 udev->do_remote_wakeup = 0;
4139 }
4140}
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07004141
Alan Sternd388dab2006-07-01 22:14:24 -04004142#else /* CONFIG_PM */
4143
Alan Sternf07600c2007-05-30 15:38:16 -04004144#define hub_suspend NULL
4145#define hub_resume NULL
4146#define hub_reset_resume NULL
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07004147
Mathias Nyman32a35352016-11-17 11:14:14 +02004148static inline void hub_usb3_port_prepare_disable(struct usb_hub *hub,
4149 struct usb_port *port_dev) { }
4150
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07004151int usb_disable_lpm(struct usb_device *udev)
4152{
4153 return 0;
4154}
Sarah Sharpe9261fb2012-05-21 08:29:01 -07004155EXPORT_SYMBOL_GPL(usb_disable_lpm);
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07004156
4157void usb_enable_lpm(struct usb_device *udev) { }
Sarah Sharpe9261fb2012-05-21 08:29:01 -07004158EXPORT_SYMBOL_GPL(usb_enable_lpm);
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07004159
4160int usb_unlocked_disable_lpm(struct usb_device *udev)
4161{
4162 return 0;
4163}
Sarah Sharpe9261fb2012-05-21 08:29:01 -07004164EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
Sarah Sharp1ea7e0e2012-04-24 17:21:50 -07004165
4166void usb_unlocked_enable_lpm(struct usb_device *udev) { }
Sarah Sharpe9261fb2012-05-21 08:29:01 -07004167EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
Sarah Sharpf74631e2012-06-25 12:08:08 -07004168
4169int usb_disable_ltm(struct usb_device *udev)
4170{
4171 return 0;
4172}
4173EXPORT_SYMBOL_GPL(usb_disable_ltm);
4174
4175void usb_enable_ltm(struct usb_device *udev) { }
4176EXPORT_SYMBOL_GPL(usb_enable_ltm);
Alan Sternc4b51a42013-07-11 14:58:23 -04004177
Stephen Rothwell4a95b1f2014-05-29 18:55:06 +10004178static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4179 u16 portstatus, u16 portchange)
4180{
4181 return 0;
4182}
4183
Alan Sternc4b51a42013-07-11 14:58:23 -04004184#endif /* CONFIG_PM */
Alan Sternd388dab2006-07-01 22:14:24 -04004185
Geert Uytterhoeven8ecf70f2016-12-14 15:37:30 +01004186/*
4187 * USB-3 does not have a similar link state as USB-2 that will avoid negotiating
4188 * a connection with a plugged-in cable but will signal the host when the cable
4189 * is unplugged. Disable remote wake and set link state to U3 for USB-3 devices
4190 */
4191static int hub_port_disable(struct usb_hub *hub, int port1, int set_state)
4192{
4193 struct usb_port *port_dev = hub->ports[port1 - 1];
4194 struct usb_device *hdev = hub->hdev;
4195 int ret = 0;
4196
4197 if (!hub->error) {
4198 if (hub_is_superspeed(hub->hdev)) {
4199 hub_usb3_port_prepare_disable(hub, port_dev);
4200 ret = hub_set_port_link_state(hub, port_dev->portnum,
4201 USB_SS_PORT_LS_U3);
4202 } else {
4203 ret = usb_clear_port_feature(hdev, port1,
4204 USB_PORT_FEAT_ENABLE);
4205 }
4206 }
4207 if (port_dev->child && set_state)
4208 usb_set_device_state(port_dev->child, USB_STATE_NOTATTACHED);
4209 if (ret && ret != -ENODEV)
4210 dev_err(&port_dev->dev, "cannot disable (err = %d)\n", ret);
4211 return ret;
4212}
4213
Linus Torvalds1da177e2005-04-16 15:20:36 -07004214
4215/* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4216 *
4217 * Between connect detection and reset signaling there must be a delay
4218 * of 100ms at least for debounce and power-settling. The corresponding
4219 * timer shall restart whenever the downstream port detects a disconnect.
Matthias Beyer469271f2013-10-10 23:41:27 +02004220 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07004221 * Apparently there are some bluetooth and irda-dongles and a number of
4222 * low-speed devices for which this debounce period may last over a second.
4223 * Not covered by the spec - but easy to deal with.
4224 *
4225 * This implementation uses a 1500ms total debounce timeout; if the
4226 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4227 * every 25ms for transient disconnects. When the port status has been
4228 * unchanged for 100ms it returns the port status.
4229 */
Lan Tianyuad493e52013-01-23 04:26:30 +08004230int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004231{
4232 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004233 u16 portchange, portstatus;
4234 unsigned connection = 0xffff;
Dan Williamsd99f6b42014-05-20 18:08:17 -07004235 int total_time, stable_time = 0;
4236 struct usb_port *port_dev = hub->ports[port1 - 1];
Linus Torvalds1da177e2005-04-16 15:20:36 -07004237
4238 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
4239 ret = hub_port_status(hub, port1, &portstatus, &portchange);
4240 if (ret < 0)
4241 return ret;
4242
4243 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
4244 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
Lan Tianyuad493e52013-01-23 04:26:30 +08004245 if (!must_be_connected ||
4246 (connection == USB_PORT_STAT_CONNECTION))
4247 stable_time += HUB_DEBOUNCE_STEP;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004248 if (stable_time >= HUB_DEBOUNCE_STABLE)
4249 break;
4250 } else {
4251 stable_time = 0;
4252 connection = portstatus & USB_PORT_STAT_CONNECTION;
4253 }
4254
4255 if (portchange & USB_PORT_STAT_C_CONNECTION) {
Lan Tianyuad493e52013-01-23 04:26:30 +08004256 usb_clear_port_feature(hub->hdev, port1,
Linus Torvalds1da177e2005-04-16 15:20:36 -07004257 USB_PORT_FEAT_C_CONNECTION);
4258 }
4259
4260 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
4261 break;
4262 msleep(HUB_DEBOUNCE_STEP);
4263 }
4264
Dan Williamsd99f6b42014-05-20 18:08:17 -07004265 dev_dbg(&port_dev->dev, "debounce total %dms stable %dms status 0x%x\n",
4266 total_time, stable_time, portstatus);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004267
4268 if (stable_time < HUB_DEBOUNCE_STABLE)
4269 return -ETIMEDOUT;
4270 return portstatus;
4271}
4272
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07004273void usb_ep0_reinit(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004274{
Alan Sternddeac4e72009-01-15 17:03:33 -05004275 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
4276 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
Alan Stern2caf7fc2008-12-31 11:31:33 -05004277 usb_enable_endpoint(udev, &udev->ep0, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004278}
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07004279EXPORT_SYMBOL_GPL(usb_ep0_reinit);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004280
4281#define usb_sndaddr0pipe() (PIPE_CONTROL << 30)
4282#define usb_rcvaddr0pipe() ((PIPE_CONTROL << 30) | USB_DIR_IN)
4283
Alan Stern4326ed02007-07-30 17:08:43 -04004284static int hub_set_address(struct usb_device *udev, int devnum)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004285{
4286 int retval;
Sarah Sharpc6515272009-04-27 19:57:26 -07004287 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004288
Sarah Sharpc6515272009-04-27 19:57:26 -07004289 /*
4290 * The host controller will choose the device address,
4291 * instead of the core having chosen it earlier
4292 */
4293 if (!hcd->driver->address_device && devnum <= 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004294 return -EINVAL;
4295 if (udev->state == USB_STATE_ADDRESS)
4296 return 0;
4297 if (udev->state != USB_STATE_DEFAULT)
4298 return -EINVAL;
Andiry Xuc8d4af82010-10-14 07:22:51 -07004299 if (hcd->driver->address_device)
Sarah Sharpc6515272009-04-27 19:57:26 -07004300 retval = hcd->driver->address_device(hcd, udev);
Andiry Xuc8d4af82010-10-14 07:22:51 -07004301 else
Sarah Sharpc6515272009-04-27 19:57:26 -07004302 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
4303 USB_REQ_SET_ADDRESS, 0, devnum, 0,
4304 NULL, 0, USB_CTRL_SET_TIMEOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004305 if (retval == 0) {
Alan Stern3b29b682011-02-22 09:53:41 -05004306 update_devnum(udev, devnum);
David Vrabel4953d142008-04-08 13:24:46 -07004307 /* Device now using proper address. */
Linus Torvalds1da177e2005-04-16 15:20:36 -07004308 usb_set_device_state(udev, USB_STATE_ADDRESS);
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07004309 usb_ep0_reinit(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004310 }
4311 return retval;
4312}
4313
Mathias Nyman890dae82013-09-30 17:26:31 +03004314/*
4315 * There are reports of USB 3.0 devices that say they support USB 2.0 Link PM
4316 * when they're plugged into a USB 2.0 port, but they don't work when LPM is
4317 * enabled.
4318 *
4319 * Only enable USB 2.0 Link PM if the port is internal (hardwired), or the
4320 * device says it supports the new USB 2.0 Link PM errata by setting the BESL
4321 * support bit in the BOS descriptor.
4322 */
4323static void hub_set_initial_usb2_lpm_policy(struct usb_device *udev)
4324{
Dan Williamsd99f6b42014-05-20 18:08:17 -07004325 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
4326 int connect_type = USB_PORT_CONNECT_TYPE_UNKNOWN;
Mathias Nyman890dae82013-09-30 17:26:31 +03004327
Guenter Roeck4e615882017-03-08 10:19:36 -08004328 if (!udev->usb2_hw_lpm_capable || !udev->bos)
Mathias Nyman890dae82013-09-30 17:26:31 +03004329 return;
4330
Dan Williamsd99f6b42014-05-20 18:08:17 -07004331 if (hub)
4332 connect_type = hub->ports[udev->portnum - 1]->connect_type;
Mathias Nyman890dae82013-09-30 17:26:31 +03004333
Bjørn Mork23c05822014-02-27 14:23:55 +01004334 if ((udev->bos->ext_cap->bmAttributes & cpu_to_le32(USB_BESL_SUPPORT)) ||
Mathias Nyman890dae82013-09-30 17:26:31 +03004335 connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
4336 udev->usb2_hw_lpm_allowed = 1;
Kai-Heng Fengc73982b2019-01-12 03:54:24 +08004337 usb_enable_usb2_hardware_lpm(udev);
Mathias Nyman890dae82013-09-30 17:26:31 +03004338 }
4339}
4340
Dan Williams48fc7db2013-12-05 17:07:27 -08004341static int hub_enable_device(struct usb_device *udev)
4342{
4343 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4344
4345 if (!hcd->driver->enable_device)
4346 return 0;
4347 if (udev->state == USB_STATE_ADDRESS)
4348 return 0;
4349 if (udev->state != USB_STATE_DEFAULT)
4350 return -EINVAL;
4351
4352 return hcd->driver->enable_device(hcd, udev);
4353}
4354
Linus Torvalds1da177e2005-04-16 15:20:36 -07004355/* Reset device, (re)assign address, get device descriptor.
4356 * Device connection must be stable, no more debouncing needed.
4357 * Returns device in USB_STATE_ADDRESS, except on error.
4358 *
4359 * If this is called for an already-existing device (as part of
Dan Williams5c79a1e2014-05-20 18:09:26 -07004360 * usb_reset_and_verify_device), the caller must own the device lock and
4361 * the port lock. For a newly detected device that is not accessible
4362 * through any global pointers, it's not necessary to lock the device,
4363 * but it is still necessary to lock the port.
Linus Torvalds1da177e2005-04-16 15:20:36 -07004364 */
4365static int
Chase Metzger039b3302015-08-18 20:36:58 -07004366hub_port_init(struct usb_hub *hub, struct usb_device *udev, int port1,
Linus Torvalds1da177e2005-04-16 15:20:36 -07004367 int retry_counter)
4368{
Linus Torvalds1da177e2005-04-16 15:20:36 -07004369 struct usb_device *hdev = hub->hdev;
Sarah Sharpe7b77172009-04-27 19:54:26 -07004370 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
Oliver Neukum0d5ce772016-02-17 11:52:43 +01004371 int retries, operations, retval, i;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004372 unsigned delay = HUB_SHORT_RESET_TIME;
4373 enum usb_device_speed oldspeed = udev->speed;
Michal Nazarewicze538dfd2011-08-30 17:11:19 +02004374 const char *speed;
Alan Stern4326ed02007-07-30 17:08:43 -04004375 int devnum = udev->devnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004376
4377 /* root hub ports have a slightly longer reset period
4378 * (from USB 2.0 spec, section 7.1.7.5)
4379 */
4380 if (!hdev->parent) {
4381 delay = HUB_ROOT_RESET_TIME;
4382 if (port1 == hdev->bus->otg_port)
4383 hdev->bus->b_hnp_enable = 0;
4384 }
4385
4386 /* Some low speed devices have problems with the quick delay, so */
4387 /* be a bit pessimistic with those devices. RHbug #23670 */
4388 if (oldspeed == USB_SPEED_LOW)
4389 delay = HUB_LONG_RESET_TIME;
4390
Chris Bainbridgefeb26ac2016-04-25 13:48:38 +01004391 mutex_lock(hcd->address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004392
Luben Tuikov07194ab2011-02-11 11:33:10 -08004393 /* Reset the device; full speed may morph to high speed */
4394 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
Andiry Xu75d7cf72011-09-13 16:41:11 -07004395 retval = hub_port_reset(hub, port1, udev, delay, false);
Luben Tuikov07194ab2011-02-11 11:33:10 -08004396 if (retval < 0) /* error or disconnect */
4397 goto fail;
4398 /* success, speed is known */
4399
Linus Torvalds1da177e2005-04-16 15:20:36 -07004400 retval = -ENODEV;
4401
Mathias Nyman8a1b2722015-12-10 09:59:25 +02004402 /* Don't allow speed changes at reset, except usb 3.0 to faster */
4403 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed &&
4404 !(oldspeed == USB_SPEED_SUPER && udev->speed > oldspeed)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004405 dev_dbg(&udev->dev, "device reset changed speed!\n");
4406 goto fail;
4407 }
4408 oldspeed = udev->speed;
Alan Stern4326ed02007-07-30 17:08:43 -04004409
Linus Torvalds1da177e2005-04-16 15:20:36 -07004410 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4411 * it's fixed size except for full speed devices.
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07004412 * For Wireless USB devices, ep0 max packet is always 512 (tho
4413 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
Linus Torvalds1da177e2005-04-16 15:20:36 -07004414 */
4415 switch (udev->speed) {
Mathias Nyman8a1b2722015-12-10 09:59:25 +02004416 case USB_SPEED_SUPER_PLUS:
Sarah Sharp6b403b02009-04-27 19:54:10 -07004417 case USB_SPEED_SUPER:
Greg Kroah-Hartman551cdbb2010-01-14 11:08:04 -08004418 case USB_SPEED_WIRELESS: /* fixed at 512 */
Harvey Harrison551509d2009-02-11 14:11:36 -08004419 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07004420 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004421 case USB_SPEED_HIGH: /* fixed at 64 */
Harvey Harrison551509d2009-02-11 14:11:36 -08004422 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004423 break;
4424 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4425 /* to determine the ep0 maxpacket size, try to read
4426 * the device descriptor to get bMaxPacketSize0 and
4427 * then correct our initial guess.
4428 */
Harvey Harrison551509d2009-02-11 14:11:36 -08004429 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004430 break;
4431 case USB_SPEED_LOW: /* fixed at 8 */
Harvey Harrison551509d2009-02-11 14:11:36 -08004432 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004433 break;
4434 default:
4435 goto fail;
4436 }
Michal Nazarewicze538dfd2011-08-30 17:11:19 +02004437
4438 if (udev->speed == USB_SPEED_WIRELESS)
4439 speed = "variable speed Wireless";
4440 else
4441 speed = usb_speed_string(udev->speed);
4442
Mathias Nyman8a1b2722015-12-10 09:59:25 +02004443 if (udev->speed < USB_SPEED_SUPER)
Sarah Sharpc6515272009-04-27 19:57:26 -07004444 dev_info(&udev->dev,
Michal Nazarewicze538dfd2011-08-30 17:11:19 +02004445 "%s %s USB device number %d using %s\n",
4446 (udev->config) ? "reset" : "new", speed,
Alan Stern3b29b682011-02-22 09:53:41 -05004447 devnum, udev->bus->controller->driver->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004448
4449 /* Set up TT records, if needed */
4450 if (hdev->tt) {
4451 udev->tt = hdev->tt;
4452 udev->ttport = hdev->ttport;
4453 } else if (udev->speed != USB_SPEED_HIGH
4454 && hdev->speed == USB_SPEED_HIGH) {
Alan Sternd199c962011-01-31 10:56:37 -05004455 if (!hub->tt.hub) {
4456 dev_err(&udev->dev, "parent hub has no TT\n");
4457 retval = -EINVAL;
4458 goto fail;
4459 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07004460 udev->tt = &hub->tt;
4461 udev->ttport = port1;
4462 }
Matthias Beyer469271f2013-10-10 23:41:27 +02004463
Linus Torvalds1da177e2005-04-16 15:20:36 -07004464 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4465 * Because device hardware and firmware is sometimes buggy in
4466 * this area, and this is how Linux has done it for ages.
4467 * Change it cautiously.
4468 *
Dan Williams48fc7db2013-12-05 17:07:27 -08004469 * NOTE: If use_new_scheme() is true we will start by issuing
Linus Torvalds1da177e2005-04-16 15:20:36 -07004470 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4471 * so it may help with some non-standards-compliant devices.
4472 * Otherwise we start with SET_ADDRESS and then try to read the
4473 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4474 * value.
4475 */
Oliver Neukum0d5ce772016-02-17 11:52:43 +01004476 for (retries = 0; retries < GET_DESCRIPTOR_TRIES; (++retries, msleep(100))) {
Dan Williams48fc7db2013-12-05 17:07:27 -08004477 bool did_new_scheme = false;
4478
4479 if (use_new_scheme(udev, retry_counter)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004480 struct usb_device_descriptor *buf;
4481 int r = 0;
4482
Dan Williams48fc7db2013-12-05 17:07:27 -08004483 did_new_scheme = true;
4484 retval = hub_enable_device(udev);
Oliver Neukum938569e2014-02-27 10:57:10 +01004485 if (retval < 0) {
4486 dev_err(&udev->dev,
4487 "hub failed to enable device, error %d\n",
4488 retval);
Dan Williams48fc7db2013-12-05 17:07:27 -08004489 goto fail;
Oliver Neukum938569e2014-02-27 10:57:10 +01004490 }
Dan Williams48fc7db2013-12-05 17:07:27 -08004491
Linus Torvalds1da177e2005-04-16 15:20:36 -07004492#define GET_DESCRIPTOR_BUFSIZE 64
4493 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4494 if (!buf) {
4495 retval = -ENOMEM;
4496 continue;
4497 }
4498
Alan Sternb89ee192007-05-11 10:19:04 -04004499 /* Retry on all errors; some devices are flakey.
4500 * 255 is for WUSB devices, we actually need to use
4501 * 512 (WUSB1.0[4.8.1]).
Linus Torvalds1da177e2005-04-16 15:20:36 -07004502 */
Oliver Neukum0d5ce772016-02-17 11:52:43 +01004503 for (operations = 0; operations < 3; ++operations) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004504 buf->bMaxPacketSize0 = 0;
4505 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4506 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4507 USB_DT_DEVICE << 8, 0,
4508 buf, GET_DESCRIPTOR_BUFSIZE,
Jaroslav Kyselafd7c5192008-10-10 16:24:45 +02004509 initial_descriptor_timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004510 switch (buf->bMaxPacketSize0) {
Inaky Perez-Gonzalez5bb6e0a2006-08-25 19:35:30 -07004511 case 8: case 16: case 32: case 64: case 255:
Linus Torvalds1da177e2005-04-16 15:20:36 -07004512 if (buf->bDescriptorType ==
4513 USB_DT_DEVICE) {
4514 r = 0;
4515 break;
4516 }
4517 /* FALL THROUGH */
4518 default:
4519 if (r == 0)
4520 r = -EPROTO;
4521 break;
4522 }
Oliver Neukum264904c2016-02-10 11:33:18 +01004523 /*
4524 * Some devices time out if they are powered on
4525 * when already connected. They need a second
4526 * reset. But only on the first attempt,
4527 * lest we get into a time out/reset loop
4528 */
Maxim Moseychuk55365ad2018-01-04 21:43:03 +03004529 if (r == 0 || (r == -ETIMEDOUT &&
4530 retries == 0 &&
4531 udev->speed > USB_SPEED_FULL))
Linus Torvalds1da177e2005-04-16 15:20:36 -07004532 break;
4533 }
4534 udev->descriptor.bMaxPacketSize0 =
4535 buf->bMaxPacketSize0;
4536 kfree(buf);
4537
Andiry Xu75d7cf72011-09-13 16:41:11 -07004538 retval = hub_port_reset(hub, port1, udev, delay, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004539 if (retval < 0) /* error or disconnect */
4540 goto fail;
4541 if (oldspeed != udev->speed) {
4542 dev_dbg(&udev->dev,
4543 "device reset changed speed!\n");
4544 retval = -ENODEV;
4545 goto fail;
4546 }
4547 if (r) {
Alan Sterne9e88fb2013-03-27 16:14:01 -04004548 if (r != -ENODEV)
4549 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4550 r);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004551 retval = -EMSGSIZE;
4552 continue;
4553 }
4554#undef GET_DESCRIPTOR_BUFSIZE
4555 }
4556
Matthias Beyer469271f2013-10-10 23:41:27 +02004557 /*
4558 * If device is WUSB, we already assigned an
4559 * unauthorized address in the Connect Ack sequence;
4560 * authorization will assign the final address.
4561 */
Sarah Sharpc6515272009-04-27 19:57:26 -07004562 if (udev->wusb == 0) {
Oliver Neukum0d5ce772016-02-17 11:52:43 +01004563 for (operations = 0; operations < SET_ADDRESS_TRIES; ++operations) {
Inaky Perez-Gonzalez6c529cd2008-04-08 13:24:46 -07004564 retval = hub_set_address(udev, devnum);
4565 if (retval >= 0)
4566 break;
4567 msleep(200);
4568 }
4569 if (retval < 0) {
Alan Sterne9e88fb2013-03-27 16:14:01 -04004570 if (retval != -ENODEV)
4571 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4572 devnum, retval);
Inaky Perez-Gonzalez6c529cd2008-04-08 13:24:46 -07004573 goto fail;
4574 }
Mathias Nyman8a1b2722015-12-10 09:59:25 +02004575 if (udev->speed >= USB_SPEED_SUPER) {
Sarah Sharpc6515272009-04-27 19:57:26 -07004576 devnum = udev->devnum;
4577 dev_info(&udev->dev,
Mathias Nyman8a1b2722015-12-10 09:59:25 +02004578 "%s SuperSpeed%s USB device number %d using %s\n",
Sarah Sharpc6515272009-04-27 19:57:26 -07004579 (udev->config) ? "reset" : "new",
Mathias Nyman8a1b2722015-12-10 09:59:25 +02004580 (udev->speed == USB_SPEED_SUPER_PLUS) ? "Plus" : "",
Alan Stern3b29b682011-02-22 09:53:41 -05004581 devnum, udev->bus->controller->driver->name);
Sarah Sharpc6515272009-04-27 19:57:26 -07004582 }
Inaky Perez-Gonzalez6c529cd2008-04-08 13:24:46 -07004583
4584 /* cope with hardware quirkiness:
4585 * - let SET_ADDRESS settle, some device hardware wants it
4586 * - read ep0 maxpacket even for high and low speed,
4587 */
4588 msleep(10);
Dan Williams48fc7db2013-12-05 17:07:27 -08004589 /* use_new_scheme() checks the speed which may have
4590 * changed since the initial look so we cache the result
4591 * in did_new_scheme
4592 */
4593 if (did_new_scheme)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004594 break;
Matthias Beyer469271f2013-10-10 23:41:27 +02004595 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07004596
4597 retval = usb_get_device_descriptor(udev, 8);
4598 if (retval < 8) {
Alan Sterne9e88fb2013-03-27 16:14:01 -04004599 if (retval != -ENODEV)
4600 dev_err(&udev->dev,
Wu Fengguangb9cef6c2008-12-15 15:32:01 +08004601 "device descriptor read/8, error %d\n",
4602 retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004603 if (retval >= 0)
4604 retval = -EMSGSIZE;
4605 } else {
4606 retval = 0;
4607 break;
4608 }
4609 }
4610 if (retval)
4611 goto fail;
4612
Elric Fud8aec3d2012-03-26 21:16:02 +08004613 /*
4614 * Some superspeed devices have finished the link training process
4615 * and attached to a superspeed hub port, but the device descriptor
4616 * got from those devices show they aren't superspeed devices. Warm
4617 * reset the port attached by the devices can fix them.
4618 */
Mathias Nyman8a1b2722015-12-10 09:59:25 +02004619 if ((udev->speed >= USB_SPEED_SUPER) &&
Elric Fud8aec3d2012-03-26 21:16:02 +08004620 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4621 dev_err(&udev->dev, "got a wrong device descriptor, "
4622 "warm reset device\n");
4623 hub_port_reset(hub, port1, udev,
4624 HUB_BH_RESET_TIME, true);
4625 retval = -EINVAL;
4626 goto fail;
4627 }
4628
Sarah Sharp6b403b02009-04-27 19:54:10 -07004629 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
Mathias Nyman8a1b2722015-12-10 09:59:25 +02004630 udev->speed >= USB_SPEED_SUPER)
Sarah Sharp6b403b02009-04-27 19:54:10 -07004631 i = 512;
4632 else
4633 i = udev->descriptor.bMaxPacketSize0;
Kuninori Morimoto29cc8892011-08-23 03:12:03 -07004634 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
Alan Stern56626a72010-10-14 15:25:21 -04004635 if (udev->speed == USB_SPEED_LOW ||
Linus Torvalds1da177e2005-04-16 15:20:36 -07004636 !(i == 8 || i == 16 || i == 32 || i == 64)) {
Alan Stern56626a72010-10-14 15:25:21 -04004637 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004638 retval = -EMSGSIZE;
4639 goto fail;
4640 }
Alan Stern56626a72010-10-14 15:25:21 -04004641 if (udev->speed == USB_SPEED_FULL)
4642 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4643 else
4644 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004645 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07004646 usb_ep0_reinit(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004647 }
Matthias Beyer469271f2013-10-10 23:41:27 +02004648
Linus Torvalds1da177e2005-04-16 15:20:36 -07004649 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4650 if (retval < (signed)sizeof(udev->descriptor)) {
Alan Sterne9e88fb2013-03-27 16:14:01 -04004651 if (retval != -ENODEV)
4652 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4653 retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004654 if (retval >= 0)
4655 retval = -ENOMSG;
4656 goto fail;
4657 }
4658
Alan Sternad87e032015-12-10 15:27:21 -05004659 usb_detect_quirks(udev);
4660
Andiry Xu1ff4df52011-09-23 14:19:48 -07004661 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4662 retval = usb_get_bos_descriptor(udev);
Sarah Sharp51e0a012012-02-20 12:02:19 -08004663 if (!retval) {
Sarah Sharpd9b20992012-02-20 08:31:26 -08004664 udev->lpm_capable = usb_device_supports_lpm(udev);
Sarah Sharp51e0a012012-02-20 12:02:19 -08004665 usb_set_lpm_parameters(udev);
4666 }
Andiry Xu1ff4df52011-09-23 14:19:48 -07004667 }
Andiry Xu3148bf02011-09-23 14:19:47 -07004668
Linus Torvalds1da177e2005-04-16 15:20:36 -07004669 retval = 0;
Alek Du48f24972010-06-04 15:47:55 +08004670 /* notify HCD that we have a device connected and addressed */
4671 if (hcd->driver->update_device)
4672 hcd->driver->update_device(hcd, udev);
Mathias Nyman890dae82013-09-30 17:26:31 +03004673 hub_set_initial_usb2_lpm_policy(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004674fail:
Alan Stern4326ed02007-07-30 17:08:43 -04004675 if (retval) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004676 hub_port_disable(hub, port1, 0);
Alan Stern3b29b682011-02-22 09:53:41 -05004677 update_devnum(udev, devnum); /* for disconnect processing */
Alan Stern4326ed02007-07-30 17:08:43 -04004678 }
Chris Bainbridgefeb26ac2016-04-25 13:48:38 +01004679 mutex_unlock(hcd->address0_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004680 return retval;
4681}
4682
4683static void
Chase Metzger039b3302015-08-18 20:36:58 -07004684check_highspeed(struct usb_hub *hub, struct usb_device *udev, int port1)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004685{
4686 struct usb_qualifier_descriptor *qual;
4687 int status;
4688
Johan Hovold2a159382014-08-25 17:51:26 +02004689 if (udev->quirks & USB_QUIRK_DEVICE_QUALIFIER)
4690 return;
4691
Chase Metzger039b3302015-08-18 20:36:58 -07004692 qual = kmalloc(sizeof *qual, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004693 if (qual == NULL)
4694 return;
4695
Chase Metzger039b3302015-08-18 20:36:58 -07004696 status = usb_get_descriptor(udev, USB_DT_DEVICE_QUALIFIER, 0,
Linus Torvalds1da177e2005-04-16 15:20:36 -07004697 qual, sizeof *qual);
4698 if (status == sizeof *qual) {
4699 dev_info(&udev->dev, "not running at top speed; "
4700 "connect to a high speed hub\n");
4701 /* hub LEDs are probably harder to miss than syslog */
4702 if (hub->has_indicators) {
4703 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
Shaibal Dutta22f6a0f2014-02-01 19:16:46 -08004704 queue_delayed_work(system_power_efficient_wq,
4705 &hub->leds, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004706 }
4707 }
Jesper Juhl1bc3c9e2005-04-18 17:39:34 -07004708 kfree(qual);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004709}
4710
4711static unsigned
Chase Metzger039b3302015-08-18 20:36:58 -07004712hub_power_remaining(struct usb_hub *hub)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004713{
4714 struct usb_device *hdev = hub->hdev;
4715 int remaining;
Alan Stern55c52712005-11-23 12:03:12 -05004716 int port1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004717
Alan Stern55c52712005-11-23 12:03:12 -05004718 if (!hub->limited_power)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004719 return 0;
4720
Alan Stern55c52712005-11-23 12:03:12 -05004721 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4722 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
Dan Williamsd99f6b42014-05-20 18:08:17 -07004723 struct usb_port *port_dev = hub->ports[port1 - 1];
4724 struct usb_device *udev = port_dev->child;
4725 unsigned unit_load;
4726 int delta;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004727
4728 if (!udev)
4729 continue;
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01004730 if (hub_is_superspeed(udev))
4731 unit_load = 150;
4732 else
4733 unit_load = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004734
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01004735 /*
4736 * Unconfigured devices may not use more than one unit load,
4737 * or 8mA for OTG ports
4738 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07004739 if (udev->actconfig)
Sebastian Andrzej Siewior8d8479d2012-12-18 15:25:46 +01004740 delta = usb_get_max_power(udev, udev->actconfig);
Alan Stern55c52712005-11-23 12:03:12 -05004741 else if (port1 != udev->bus->otg_port || hdev->parent)
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01004742 delta = unit_load;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004743 else
Alan Stern55c52712005-11-23 12:03:12 -05004744 delta = 8;
4745 if (delta > hub->mA_per_port)
Dan Williamsd99f6b42014-05-20 18:08:17 -07004746 dev_warn(&port_dev->dev, "%dmA is over %umA budget!\n",
4747 delta, hub->mA_per_port);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004748 remaining -= delta;
4749 }
4750 if (remaining < 0) {
Alan Stern55c52712005-11-23 12:03:12 -05004751 dev_warn(hub->intfdev, "%dmA over power budget!\n",
Matthias Beyer469271f2013-10-10 23:41:27 +02004752 -remaining);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004753 remaining = 0;
4754 }
4755 return remaining;
4756}
4757
Dan Williamsaf376a42014-05-20 18:09:15 -07004758static void hub_port_connect(struct usb_hub *hub, int port1, u16 portstatus,
4759 u16 portchange)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004760{
Alan Stern7c2beb12017-08-01 10:41:56 -04004761 int status = -ENODEV;
4762 int i;
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01004763 unsigned unit_load;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004764 struct usb_device *hdev = hub->hdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004765 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
Dan Williamsd99f6b42014-05-20 18:08:17 -07004766 struct usb_port *port_dev = hub->ports[port1 - 1];
Dan Williamsaf376a42014-05-20 18:09:15 -07004767 struct usb_device *udev = port_dev->child;
Oliver Neukum5ee0f802014-07-14 15:39:49 +02004768 static int unreliable_port = -1;
Alan Stern8808f002008-04-28 11:06:55 -04004769
Alan Stern24618b02008-04-28 11:06:28 -04004770 /* Disconnect any existing devices under this port */
Peter Chenb76baa82012-11-09 09:44:43 +08004771 if (udev) {
Peter Chenb2108f12014-11-04 11:14:31 +08004772 if (hcd->usb_phy && !hdev->parent)
Antoine Tenart3d46e732014-09-24 23:05:50 +04004773 usb_phy_notify_disconnect(hcd->usb_phy, udev->speed);
Dan Williamsd99f6b42014-05-20 18:08:17 -07004774 usb_disconnect(&port_dev->child);
Peter Chenb76baa82012-11-09 09:44:43 +08004775 }
Alan Stern24618b02008-04-28 11:06:28 -04004776
Alan Stern253e0572009-10-27 15:20:13 -04004777 /* We can forget about a "removed" device when there's a physical
4778 * disconnect or the connect status changes.
4779 */
4780 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4781 (portchange & USB_PORT_STAT_C_CONNECTION))
4782 clear_bit(port1, hub->removed_bits);
4783
Alan Stern5257d972008-09-22 14:43:08 -04004784 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4785 USB_PORT_STAT_C_ENABLE)) {
Lan Tianyuad493e52013-01-23 04:26:30 +08004786 status = hub_port_debounce_be_stable(hub, port1);
Alan Stern5257d972008-09-22 14:43:08 -04004787 if (status < 0) {
Oliver Neukum5ee0f802014-07-14 15:39:49 +02004788 if (status != -ENODEV &&
4789 port1 != unreliable_port &&
4790 printk_ratelimit())
Takashi Iwaidd5f5002014-08-19 17:37:55 +02004791 dev_err(&port_dev->dev, "connect-debounce failed\n");
Alan Stern5257d972008-09-22 14:43:08 -04004792 portstatus &= ~USB_PORT_STAT_CONNECTION;
Oliver Neukum5ee0f802014-07-14 15:39:49 +02004793 unreliable_port = port1;
Alan Stern5257d972008-09-22 14:43:08 -04004794 } else {
4795 portstatus = status;
4796 }
4797 }
4798
Alan Stern253e0572009-10-27 15:20:13 -04004799 /* Return now if debouncing failed or nothing is connected or
4800 * the device was "removed".
4801 */
4802 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4803 test_bit(port1, hub->removed_bits)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004804
Deepak Dasfbaecff2015-01-21 23:39:58 +05304805 /*
4806 * maybe switch power back on (e.g. root hub was reset)
4807 * but only if the port isn't owned by someone else.
4808 */
Dan Williams9262c192014-05-20 18:08:12 -07004809 if (hub_is_port_power_switchable(hub)
Deepak Dasfbaecff2015-01-21 23:39:58 +05304810 && !port_is_power_on(hub, portstatus)
4811 && !port_dev->port_owner)
Linus Torvalds1da177e2005-04-16 15:20:36 -07004812 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
Alan Stern5257d972008-09-22 14:43:08 -04004813
Linus Torvalds1da177e2005-04-16 15:20:36 -07004814 if (portstatus & USB_PORT_STAT_ENABLE)
Matthias Beyer469271f2013-10-10 23:41:27 +02004815 goto done;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004816 return;
4817 }
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01004818 if (hub_is_superspeed(hub->hdev))
4819 unit_load = 150;
4820 else
4821 unit_load = 100;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004822
Alan Sterne9e88fb2013-03-27 16:14:01 -04004823 status = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004824 for (i = 0; i < SET_CONFIG_TRIES; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004825
4826 /* reallocate for each attempt, since references
4827 * to the previous one can escape in various ways
4828 */
4829 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4830 if (!udev) {
Dan Williamsd99f6b42014-05-20 18:08:17 -07004831 dev_err(&port_dev->dev,
4832 "couldn't allocate usb_device\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07004833 goto done;
4834 }
4835
4836 usb_set_device_state(udev, USB_STATE_POWERED);
Matthias Beyer469271f2013-10-10 23:41:27 +02004837 udev->bus_mA = hub->mA_per_port;
Alan Sternb6956ff2006-08-30 15:46:48 -04004838 udev->level = hdev->level + 1;
Inaky Perez-Gonzalez8af548d2008-04-08 13:24:46 -07004839 udev->wusb = hub_is_wusb(hub);
Alan Stern55c52712005-11-23 12:03:12 -05004840
Mathias Nyman8a1b2722015-12-10 09:59:25 +02004841 /* Devices connected to SuperSpeed hubs are USB 3.0 or later */
Sarah Sharp131dec32010-12-06 21:00:19 -08004842 if (hub_is_superspeed(hub->hdev))
Sarah Sharpe7b77172009-04-27 19:54:26 -07004843 udev->speed = USB_SPEED_SUPER;
4844 else
4845 udev->speed = USB_SPEED_UNKNOWN;
4846
Alan Stern3b29b682011-02-22 09:53:41 -05004847 choose_devnum(udev);
Andiry Xuc8d4af82010-10-14 07:22:51 -07004848 if (udev->devnum <= 0) {
4849 status = -ENOTCONN; /* Don't retry */
4850 goto loop;
Sarah Sharpc6515272009-04-27 19:57:26 -07004851 }
4852
Sarah Sharpe7b77172009-04-27 19:54:26 -07004853 /* reset (non-USB 3.0 devices) and get descriptor */
Dan Williams5c79a1e2014-05-20 18:09:26 -07004854 usb_lock_port(port_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004855 status = hub_port_init(hub, udev, port1, i);
Dan Williams5c79a1e2014-05-20 18:09:26 -07004856 usb_unlock_port(port_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004857 if (status < 0)
4858 goto loop;
4859
Phil Dibowitz93362a82010-07-22 00:05:01 +02004860 if (udev->quirks & USB_QUIRK_DELAY_INIT)
Dmitry Fleytman43feb292017-09-05 11:40:56 +03004861 msleep(2000);
Phil Dibowitz93362a82010-07-22 00:05:01 +02004862
Linus Torvalds1da177e2005-04-16 15:20:36 -07004863 /* consecutive bus-powered hubs aren't reliable; they can
4864 * violate the voltage drop budget. if the new child has
4865 * a "powered" LED, users should notice we didn't enable it
4866 * (without reading syslog), even without per-port LEDs
4867 * on the parent.
4868 */
4869 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
Sebastian Andrzej Siewior430ee582012-12-18 15:25:47 +01004870 && udev->bus_mA <= unit_load) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004871 u16 devstat;
4872
4873 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
4874 &devstat);
Alan Stern15b73362013-07-30 15:35:40 -04004875 if (status) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07004876 dev_dbg(&udev->dev, "get status %d ?\n", status);
4877 goto loop_disable;
4878 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07004879 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
4880 dev_err(&udev->dev,
4881 "can't connect bus-powered hub "
4882 "to this port\n");
4883 if (hub->has_indicators) {
4884 hub->indicator[port1-1] =
4885 INDICATOR_AMBER_BLINK;
Shaibal Dutta22f6a0f2014-02-01 19:16:46 -08004886 queue_delayed_work(
4887 system_power_efficient_wq,
4888 &hub->leds, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004889 }
4890 status = -ENOTCONN; /* Don't retry */
4891 goto loop_disable;
4892 }
4893 }
Matthias Beyer469271f2013-10-10 23:41:27 +02004894
Linus Torvalds1da177e2005-04-16 15:20:36 -07004895 /* check for devices running slower than they could */
4896 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
4897 && udev->speed == USB_SPEED_FULL
4898 && highspeed_hubs != 0)
Chase Metzger039b3302015-08-18 20:36:58 -07004899 check_highspeed(hub, udev, port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004900
Greg Kroah-Hartmanfa286182012-05-14 09:20:37 -07004901 /* Store the parent's children[] pointer. At this point
Linus Torvalds1da177e2005-04-16 15:20:36 -07004902 * udev becomes globally accessible, although presumably
4903 * no one will look at it until hdev is unlocked.
4904 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07004905 status = 0;
4906
Dan Williamsd8521af2014-05-20 18:08:28 -07004907 mutex_lock(&usb_port_peer_mutex);
4908
Linus Torvalds1da177e2005-04-16 15:20:36 -07004909 /* We mustn't add new devices if the parent hub has
4910 * been disconnected; we would race with the
4911 * recursively_mark_NOTATTACHED() routine.
4912 */
4913 spin_lock_irq(&device_state_lock);
4914 if (hdev->state == USB_STATE_NOTATTACHED)
4915 status = -ENOTCONN;
4916 else
Dan Williamsd99f6b42014-05-20 18:08:17 -07004917 port_dev->child = udev;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004918 spin_unlock_irq(&device_state_lock);
Dan Williamsd8521af2014-05-20 18:08:28 -07004919 mutex_unlock(&usb_port_peer_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004920
4921 /* Run it through the hoops (find a driver, etc) */
4922 if (!status) {
4923 status = usb_new_device(udev);
4924 if (status) {
Dan Williamsd8521af2014-05-20 18:08:28 -07004925 mutex_lock(&usb_port_peer_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004926 spin_lock_irq(&device_state_lock);
Dan Williamsd99f6b42014-05-20 18:08:17 -07004927 port_dev->child = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07004928 spin_unlock_irq(&device_state_lock);
Dan Williamsd8521af2014-05-20 18:08:28 -07004929 mutex_unlock(&usb_port_peer_mutex);
Tony Zheng01ed67d2014-10-17 19:43:02 +08004930 } else {
4931 if (hcd->usb_phy && !hdev->parent)
4932 usb_phy_notify_connect(hcd->usb_phy,
4933 udev->speed);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004934 }
4935 }
4936
Linus Torvalds1da177e2005-04-16 15:20:36 -07004937 if (status)
4938 goto loop_disable;
4939
4940 status = hub_power_remaining(hub);
4941 if (status)
Dan Williamsd99f6b42014-05-20 18:08:17 -07004942 dev_dbg(hub->intfdev, "%dmA power budget left\n", status);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004943
4944 return;
4945
4946loop_disable:
4947 hub_port_disable(hub, port1, 1);
4948loop:
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07004949 usb_ep0_reinit(udev);
Alan Stern3b29b682011-02-22 09:53:41 -05004950 release_devnum(udev);
Herbert Xuf7410ce2010-01-10 20:15:03 +11004951 hub_free_dev(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07004952 usb_put_dev(udev);
Vikram Panditaffcdc182007-05-25 21:31:07 -07004953 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
Linus Torvalds1da177e2005-04-16 15:20:36 -07004954 break;
Mike Looijmanse328dff2017-11-09 13:16:46 +01004955
4956 /* When halfway through our retry count, power-cycle the port */
4957 if (i == (SET_CONFIG_TRIES / 2) - 1) {
4958 dev_info(&port_dev->dev, "attempt power cycle\n");
4959 usb_hub_set_port_power(hdev, hub, port1, false);
4960 msleep(2 * hub_power_on_good_delay(hub));
4961 usb_hub_set_port_power(hdev, hub, port1, true);
4962 msleep(hub_power_on_good_delay(hub));
4963 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07004964 }
Alan Stern3a311552008-05-20 16:58:29 -04004965 if (hub->hdev->parent ||
4966 !hcd->driver->port_handed_over ||
Alan Sterne9e88fb2013-03-27 16:14:01 -04004967 !(hcd->driver->port_handed_over)(hcd, port1)) {
4968 if (status != -ENOTCONN && status != -ENODEV)
Dan Williamsd99f6b42014-05-20 18:08:17 -07004969 dev_err(&port_dev->dev,
4970 "unable to enumerate USB device\n");
Alan Sterne9e88fb2013-03-27 16:14:01 -04004971 }
Matthias Beyer469271f2013-10-10 23:41:27 +02004972
Linus Torvalds1da177e2005-04-16 15:20:36 -07004973done:
4974 hub_port_disable(hub, port1, 1);
Alan Stern7c2beb12017-08-01 10:41:56 -04004975 if (hcd->driver->relinquish_port && !hub->hdev->parent) {
4976 if (status != -ENOTCONN && status != -ENODEV)
4977 hcd->driver->relinquish_port(hcd, port1);
4978 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07004979}
4980
Dan Williamsaf376a42014-05-20 18:09:15 -07004981/* Handle physical or logical connection change events.
4982 * This routine is called when:
4983 * a port connection-change occurs;
4984 * a port enable-change occurs (often caused by EMI);
4985 * usb_reset_and_verify_device() encounters changed descriptors (as from
4986 * a firmware download)
4987 * caller already locked the hub
4988 */
4989static void hub_port_connect_change(struct usb_hub *hub, int port1,
4990 u16 portstatus, u16 portchange)
Dan Williams5c79a1e2014-05-20 18:09:26 -07004991 __must_hold(&port_dev->status_lock)
Sarah Sharp714b07b2012-01-24 13:53:18 -08004992{
Dan Williamsaf376a42014-05-20 18:09:15 -07004993 struct usb_port *port_dev = hub->ports[port1 - 1];
4994 struct usb_device *udev = port_dev->child;
4995 int status = -ENODEV;
Sarah Sharp714b07b2012-01-24 13:53:18 -08004996
Dan Williamsaf376a42014-05-20 18:09:15 -07004997 dev_dbg(&port_dev->dev, "status %04x, change %04x, %s\n", portstatus,
4998 portchange, portspeed(hub, portstatus));
4999
5000 if (hub->has_indicators) {
5001 set_port_led(hub, port1, HUB_LED_AUTO);
5002 hub->indicator[port1-1] = INDICATOR_AUTO;
Sarah Sharp4ee823b2011-11-14 18:00:01 -08005003 }
5004
Dan Williamsaf376a42014-05-20 18:09:15 -07005005#ifdef CONFIG_USB_OTG
5006 /* during HNP, don't repeat the debounce */
5007 if (hub->hdev->bus->is_b_host)
5008 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
5009 USB_PORT_STAT_C_ENABLE);
5010#endif
Sarah Sharp714b07b2012-01-24 13:53:18 -08005011
Dan Williamsaf376a42014-05-20 18:09:15 -07005012 /* Try to resuscitate an existing device */
5013 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
5014 udev->state != USB_STATE_NOTATTACHED) {
5015 if (portstatus & USB_PORT_STAT_ENABLE) {
5016 status = 0; /* Nothing to do */
Rafael J. Wysockiceb6c9c2014-11-29 23:47:05 +01005017#ifdef CONFIG_PM
Dan Williamsaf376a42014-05-20 18:09:15 -07005018 } else if (udev->state == USB_STATE_SUSPENDED &&
5019 udev->persist_enabled) {
5020 /* For a suspended device, treat this as a
5021 * remote wakeup event.
5022 */
Dan Williams5c79a1e2014-05-20 18:09:26 -07005023 usb_unlock_port(port_dev);
Dan Williamsaf376a42014-05-20 18:09:15 -07005024 status = usb_remote_wakeup(udev);
Dan Williams5c79a1e2014-05-20 18:09:26 -07005025 usb_lock_port(port_dev);
Dan Williamsaf376a42014-05-20 18:09:15 -07005026#endif
5027 } else {
5028 /* Don't resuscitate */;
5029 }
Sarah Sharp714b07b2012-01-24 13:53:18 -08005030 }
Dan Williamsaf376a42014-05-20 18:09:15 -07005031 clear_bit(port1, hub->change_bits);
5032
Dan Williams5c79a1e2014-05-20 18:09:26 -07005033 /* successfully revalidated the connection */
Dan Williamsaf376a42014-05-20 18:09:15 -07005034 if (status == 0)
5035 return;
5036
Dan Williams5c79a1e2014-05-20 18:09:26 -07005037 usb_unlock_port(port_dev);
Dan Williamsaf376a42014-05-20 18:09:15 -07005038 hub_port_connect(hub, port1, portstatus, portchange);
Dan Williams5c79a1e2014-05-20 18:09:26 -07005039 usb_lock_port(port_dev);
Sarah Sharp714b07b2012-01-24 13:53:18 -08005040}
5041
Dan Williamsaf376a42014-05-20 18:09:15 -07005042static void port_event(struct usb_hub *hub, int port1)
Dan Williams5c79a1e2014-05-20 18:09:26 -07005043 __must_hold(&port_dev->status_lock)
Dan Williamsaf376a42014-05-20 18:09:15 -07005044{
Zhuang Jin Can7671bd12015-01-26 23:30:39 +08005045 int connect_change;
Dan Williamsaf376a42014-05-20 18:09:15 -07005046 struct usb_port *port_dev = hub->ports[port1 - 1];
5047 struct usb_device *udev = port_dev->child;
5048 struct usb_device *hdev = hub->hdev;
5049 u16 portstatus, portchange;
5050
5051 connect_change = test_bit(port1, hub->change_bits);
5052 clear_bit(port1, hub->event_bits);
5053 clear_bit(port1, hub->wakeup_bits);
5054
5055 if (hub_port_status(hub, port1, &portstatus, &portchange) < 0)
5056 return;
5057
5058 if (portchange & USB_PORT_STAT_C_CONNECTION) {
5059 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_CONNECTION);
5060 connect_change = 1;
5061 }
5062
5063 if (portchange & USB_PORT_STAT_C_ENABLE) {
5064 if (!connect_change)
5065 dev_dbg(&port_dev->dev, "enable change, status %08x\n",
5066 portstatus);
5067 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_ENABLE);
5068
5069 /*
5070 * EM interference sometimes causes badly shielded USB devices
5071 * to be shutdown by the hub, this hack enables them again.
5072 * Works at least with mouse driver.
5073 */
5074 if (!(portstatus & USB_PORT_STAT_ENABLE)
5075 && !connect_change && udev) {
5076 dev_err(&port_dev->dev, "disabled by hub (EMI?), re-enabling...\n");
5077 connect_change = 1;
5078 }
5079 }
5080
5081 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
5082 u16 status = 0, unused;
5083
5084 dev_dbg(&port_dev->dev, "over-current change\n");
5085 usb_clear_port_feature(hdev, port1,
5086 USB_PORT_FEAT_C_OVER_CURRENT);
5087 msleep(100); /* Cool down */
5088 hub_power_on(hub, true);
5089 hub_port_status(hub, port1, &status, &unused);
5090 if (status & USB_PORT_STAT_OVERCURRENT)
5091 dev_err(&port_dev->dev, "over-current condition\n");
5092 }
5093
5094 if (portchange & USB_PORT_STAT_C_RESET) {
5095 dev_dbg(&port_dev->dev, "reset change\n");
5096 usb_clear_port_feature(hdev, port1, USB_PORT_FEAT_C_RESET);
5097 }
5098 if ((portchange & USB_PORT_STAT_C_BH_RESET)
5099 && hub_is_superspeed(hdev)) {
5100 dev_dbg(&port_dev->dev, "warm reset change\n");
5101 usb_clear_port_feature(hdev, port1,
5102 USB_PORT_FEAT_C_BH_PORT_RESET);
5103 }
5104 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
5105 dev_dbg(&port_dev->dev, "link state change\n");
5106 usb_clear_port_feature(hdev, port1,
5107 USB_PORT_FEAT_C_PORT_LINK_STATE);
5108 }
5109 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
5110 dev_warn(&port_dev->dev, "config error\n");
5111 usb_clear_port_feature(hdev, port1,
5112 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
5113 }
5114
Dan Williams097a1552014-05-20 18:09:20 -07005115 /* skip port actions that require the port to be powered on */
5116 if (!pm_runtime_active(&port_dev->dev))
5117 return;
5118
Dan Williamsaf376a42014-05-20 18:09:15 -07005119 if (hub_handle_remote_wakeup(hub, port1, portstatus, portchange))
5120 connect_change = 1;
5121
5122 /*
5123 * Warm reset a USB3 protocol port if it's in
5124 * SS.Inactive state.
5125 */
Dan Williams3cd12f92014-05-29 12:58:46 -07005126 if (hub_port_warm_reset_required(hub, port1, portstatus)) {
Dan Williamsaf376a42014-05-20 18:09:15 -07005127 dev_dbg(&port_dev->dev, "do warm reset\n");
5128 if (!udev || !(portstatus & USB_PORT_STAT_CONNECTION)
5129 || udev->state == USB_STATE_NOTATTACHED) {
5130 if (hub_port_reset(hub, port1, NULL,
5131 HUB_BH_RESET_TIME, true) < 0)
5132 hub_port_disable(hub, port1, 1);
Zhuang Jin Can7671bd12015-01-26 23:30:39 +08005133 } else {
5134 usb_unlock_port(port_dev);
5135 usb_lock_device(udev);
5136 usb_reset_device(udev);
5137 usb_unlock_device(udev);
5138 usb_lock_port(port_dev);
5139 connect_change = 0;
5140 }
Dan Williamsaf376a42014-05-20 18:09:15 -07005141 }
5142
5143 if (connect_change)
5144 hub_port_connect_change(hub, port1, portstatus, portchange);
5145}
5146
Petr Mladek32a695892014-09-19 17:32:21 +02005147static void hub_event(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005148{
Linus Torvalds1da177e2005-04-16 15:20:36 -07005149 struct usb_device *hdev;
5150 struct usb_interface *intf;
5151 struct usb_hub *hub;
5152 struct device *hub_dev;
5153 u16 hubstatus;
5154 u16 hubchange;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005155 int i, ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005156
Petr Mladek32a695892014-09-19 17:32:21 +02005157 hub = container_of(work, struct usb_hub, events);
Petr Mladekeb6e2922014-09-19 17:32:20 +02005158 hdev = hub->hdev;
5159 hub_dev = hub->intfdev;
5160 intf = to_usb_interface(hub_dev);
Petr Mladek32a695892014-09-19 17:32:21 +02005161
Petr Mladekeb6e2922014-09-19 17:32:20 +02005162 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
5163 hdev->state, hdev->maxchild,
5164 /* NOTE: expects max 15 ports... */
5165 (u16) hub->change_bits[0],
5166 (u16) hub->event_bits[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005167
Petr Mladekeb6e2922014-09-19 17:32:20 +02005168 /* Lock the device, then check to see if we were
5169 * disconnected while waiting for the lock to succeed. */
5170 usb_lock_device(hdev);
5171 if (unlikely(hub->disconnected))
Petr Mladek32a695892014-09-19 17:32:21 +02005172 goto out_hdev_lock;
Petr Mladekeb6e2922014-09-19 17:32:20 +02005173
5174 /* If the hub has died, clean up after it */
5175 if (hdev->state == USB_STATE_NOTATTACHED) {
5176 hub->error = -ENODEV;
5177 hub_quiesce(hub, HUB_DISCONNECT);
Petr Mladek32a695892014-09-19 17:32:21 +02005178 goto out_hdev_lock;
Petr Mladekeb6e2922014-09-19 17:32:20 +02005179 }
5180
5181 /* Autoresume */
5182 ret = usb_autopm_get_interface(intf);
5183 if (ret) {
5184 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
Petr Mladek32a695892014-09-19 17:32:21 +02005185 goto out_hdev_lock;
Petr Mladekeb6e2922014-09-19 17:32:20 +02005186 }
5187
5188 /* If this is an inactive hub, do nothing */
5189 if (hub->quiescing)
5190 goto out_autopm;
5191
5192 if (hub->error) {
5193 dev_dbg(hub_dev, "resetting for error %d\n", hub->error);
5194
5195 ret = usb_reset_device(hdev);
Alan Stern40f122f2006-11-09 14:44:33 -05005196 if (ret) {
Petr Mladekeb6e2922014-09-19 17:32:20 +02005197 dev_dbg(hub_dev, "error resetting hub: %d\n", ret);
5198 goto out_autopm;
Alan Stern40f122f2006-11-09 14:44:33 -05005199 }
5200
Petr Mladekeb6e2922014-09-19 17:32:20 +02005201 hub->nerrors = 0;
5202 hub->error = 0;
5203 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07005204
Petr Mladekeb6e2922014-09-19 17:32:20 +02005205 /* deal with port status changes */
5206 for (i = 1; i <= hdev->maxchild; i++) {
5207 struct usb_port *port_dev = hub->ports[i - 1];
Linus Torvalds1da177e2005-04-16 15:20:36 -07005208
Petr Mladekeb6e2922014-09-19 17:32:20 +02005209 if (test_bit(i, hub->event_bits)
5210 || test_bit(i, hub->change_bits)
5211 || test_bit(i, hub->wakeup_bits)) {
5212 /*
5213 * The get_noresume and barrier ensure that if
5214 * the port was in the process of resuming, we
5215 * flush that work and keep the port active for
5216 * the duration of the port_event(). However,
5217 * if the port is runtime pm suspended
5218 * (powered-off), we leave it in that state, run
5219 * an abbreviated port_event(), and move on.
5220 */
5221 pm_runtime_get_noresume(&port_dev->dev);
5222 pm_runtime_barrier(&port_dev->dev);
5223 usb_lock_port(port_dev);
5224 port_event(hub, i);
5225 usb_unlock_port(port_dev);
5226 pm_runtime_put_sync(&port_dev->dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005227 }
Petr Mladekeb6e2922014-09-19 17:32:20 +02005228 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07005229
Petr Mladekeb6e2922014-09-19 17:32:20 +02005230 /* deal with hub status changes */
5231 if (test_and_clear_bit(0, hub->event_bits) == 0)
5232 ; /* do nothing */
5233 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
5234 dev_err(hub_dev, "get_hub_status failed\n");
5235 else {
5236 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
5237 dev_dbg(hub_dev, "power change\n");
5238 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
5239 if (hubstatus & HUB_STATUS_LOCAL_POWER)
5240 /* FIXME: Is this always true? */
5241 hub->limited_power = 1;
5242 else
5243 hub->limited_power = 0;
Dan Williamsaf376a42014-05-20 18:09:15 -07005244 }
Petr Mladekeb6e2922014-09-19 17:32:20 +02005245 if (hubchange & HUB_CHANGE_OVERCURRENT) {
5246 u16 status = 0;
5247 u16 unused;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005248
Petr Mladekeb6e2922014-09-19 17:32:20 +02005249 dev_dbg(hub_dev, "over-current change\n");
5250 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
5251 msleep(500); /* Cool down */
5252 hub_power_on(hub, true);
5253 hub_hub_status(hub, &status, &unused);
5254 if (status & HUB_STATUS_OVERCURRENT)
5255 dev_err(hub_dev, "over-current condition\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07005256 }
Petr Mladekeb6e2922014-09-19 17:32:20 +02005257 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07005258
Petr Mladekeb6e2922014-09-19 17:32:20 +02005259out_autopm:
5260 /* Balance the usb_autopm_get_interface() above */
5261 usb_autopm_put_interface_no_suspend(intf);
Petr Mladek32a695892014-09-19 17:32:21 +02005262out_hdev_lock:
Petr Mladekeb6e2922014-09-19 17:32:20 +02005263 usb_unlock_device(hdev);
Petr Mladek32a695892014-09-19 17:32:21 +02005264
5265 /* Balance the stuff in kick_hub_wq() and allow autosuspend */
5266 usb_autopm_put_interface(intf);
Petr Mladekeb6e2922014-09-19 17:32:20 +02005267 kref_put(&hub->kref, hub_release);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005268}
5269
Németh Márton1e927d92010-01-10 15:34:53 +01005270static const struct usb_device_id hub_id_table[] = {
Ming Leie6f30de2012-10-24 11:59:24 +08005271 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
Matthias Beyer469271f2013-10-10 23:41:27 +02005272 | USB_DEVICE_ID_MATCH_INT_CLASS,
Ming Leie6f30de2012-10-24 11:59:24 +08005273 .idVendor = USB_VENDOR_GENESYS_LOGIC,
5274 .bInterfaceClass = USB_CLASS_HUB,
5275 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
Linus Torvalds1da177e2005-04-16 15:20:36 -07005276 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
5277 .bDeviceClass = USB_CLASS_HUB},
5278 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
5279 .bInterfaceClass = USB_CLASS_HUB},
5280 { } /* Terminating entry */
5281};
5282
Chase Metzger039b3302015-08-18 20:36:58 -07005283MODULE_DEVICE_TABLE(usb, hub_id_table);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005284
5285static struct usb_driver hub_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07005286 .name = "hub",
5287 .probe = hub_probe,
5288 .disconnect = hub_disconnect,
5289 .suspend = hub_suspend,
5290 .resume = hub_resume,
Alan Sternf07600c2007-05-30 15:38:16 -04005291 .reset_resume = hub_reset_resume,
Alan Stern7de18d82006-06-01 13:37:24 -04005292 .pre_reset = hub_pre_reset,
5293 .post_reset = hub_post_reset,
Andi Kleenc532b292010-06-01 23:04:41 +02005294 .unlocked_ioctl = hub_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07005295 .id_table = hub_id_table,
Alan Stern40f122f2006-11-09 14:44:33 -05005296 .supports_autosuspend = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -07005297};
5298
5299int usb_hub_init(void)
5300{
Linus Torvalds1da177e2005-04-16 15:20:36 -07005301 if (usb_register(&hub_driver) < 0) {
5302 printk(KERN_ERR "%s: can't register hub driver\n",
5303 usbcore_name);
5304 return -1;
5305 }
5306
Petr Mladek32a695892014-09-19 17:32:21 +02005307 /*
5308 * The workqueue needs to be freezable to avoid interfering with
5309 * USB-PERSIST port handover. Otherwise it might see that a full-speed
5310 * device was gone before the EHCI controller had handed its port
5311 * over to the companion full-speed controller.
Petr Mladek32a695892014-09-19 17:32:21 +02005312 */
Petr Mladek638139e2014-09-19 17:32:24 +02005313 hub_wq = alloc_workqueue("usb_hub_wq", WQ_FREEZABLE, 0);
Petr Mladek32a695892014-09-19 17:32:21 +02005314 if (hub_wq)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005315 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005316
5317 /* Fall through if kernel_thread failed */
5318 usb_deregister(&hub_driver);
Petr Mladek32a695892014-09-19 17:32:21 +02005319 pr_err("%s: can't allocate workqueue for usb hub\n", usbcore_name);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005320
5321 return -1;
5322}
5323
5324void usb_hub_cleanup(void)
5325{
Petr Mladek32a695892014-09-19 17:32:21 +02005326 destroy_workqueue(hub_wq);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005327
5328 /*
5329 * Hub resources are freed for us by usb_deregister. It calls
5330 * usb_driver_purge on every device which in turn calls that
5331 * devices disconnect function if it is using this driver.
5332 * The hub_disconnect function takes care of releasing the
5333 * individual hub resources. -greg
5334 */
5335 usb_deregister(&hub_driver);
5336} /* usb_hub_cleanup() */
5337
Alan Sterneb764c42008-03-03 15:16:04 -05005338static int descriptors_changed(struct usb_device *udev,
Xenia Ragiadakoue3376d62013-08-29 21:45:48 +03005339 struct usb_device_descriptor *old_device_descriptor,
5340 struct usb_host_bos *old_bos)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005341{
Alan Sterneb764c42008-03-03 15:16:04 -05005342 int changed = 0;
5343 unsigned index;
5344 unsigned serial_len = 0;
5345 unsigned len;
5346 unsigned old_length;
5347 int length;
5348 char *buf;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005349
Alan Sterneb764c42008-03-03 15:16:04 -05005350 if (memcmp(&udev->descriptor, old_device_descriptor,
5351 sizeof(*old_device_descriptor)) != 0)
5352 return 1;
5353
Xenia Ragiadakoue3376d62013-08-29 21:45:48 +03005354 if ((old_bos && !udev->bos) || (!old_bos && udev->bos))
5355 return 1;
5356 if (udev->bos) {
Xenia Ragiadakoub9a10482013-08-31 04:40:49 +03005357 len = le16_to_cpu(udev->bos->desc->wTotalLength);
5358 if (len != le16_to_cpu(old_bos->desc->wTotalLength))
Xenia Ragiadakoue3376d62013-08-29 21:45:48 +03005359 return 1;
Xenia Ragiadakoub9a10482013-08-31 04:40:49 +03005360 if (memcmp(udev->bos->desc, old_bos->desc, len))
Xenia Ragiadakoue3376d62013-08-29 21:45:48 +03005361 return 1;
5362 }
5363
Alan Sterneb764c42008-03-03 15:16:04 -05005364 /* Since the idVendor, idProduct, and bcdDevice values in the
5365 * device descriptor haven't changed, we will assume the
5366 * Manufacturer and Product strings haven't changed either.
5367 * But the SerialNumber string could be different (e.g., a
5368 * different flash card of the same brand).
5369 */
5370 if (udev->serial)
5371 serial_len = strlen(udev->serial) + 1;
5372
5373 len = serial_len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005374 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
Alan Sterneb764c42008-03-03 15:16:04 -05005375 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5376 len = max(len, old_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005377 }
Alan Sterneb764c42008-03-03 15:16:04 -05005378
Oliver Neukum0cc1a512008-01-10 10:31:48 +01005379 buf = kmalloc(len, GFP_NOIO);
Wolfram Sangb74e7062016-08-25 19:38:59 +02005380 if (!buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005381 /* assume the worst */
5382 return 1;
Wolfram Sangb74e7062016-08-25 19:38:59 +02005383
Linus Torvalds1da177e2005-04-16 15:20:36 -07005384 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
Alan Sterneb764c42008-03-03 15:16:04 -05005385 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005386 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5387 old_length);
Alan Sterneb764c42008-03-03 15:16:04 -05005388 if (length != old_length) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07005389 dev_dbg(&udev->dev, "config index %d, error %d\n",
5390 index, length);
Alan Sterneb764c42008-03-03 15:16:04 -05005391 changed = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005392 break;
5393 }
Chase Metzger039b3302015-08-18 20:36:58 -07005394 if (memcmp(buf, udev->rawdescriptors[index], old_length)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005395 != 0) {
5396 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
Alan Sterneb764c42008-03-03 15:16:04 -05005397 index,
5398 ((struct usb_config_descriptor *) buf)->
5399 bConfigurationValue);
5400 changed = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005401 break;
5402 }
5403 }
Alan Sterneb764c42008-03-03 15:16:04 -05005404
5405 if (!changed && serial_len) {
5406 length = usb_string(udev, udev->descriptor.iSerialNumber,
5407 buf, serial_len);
5408 if (length + 1 != serial_len) {
5409 dev_dbg(&udev->dev, "serial string error %d\n",
5410 length);
5411 changed = 1;
5412 } else if (memcmp(buf, udev->serial, length) != 0) {
5413 dev_dbg(&udev->dev, "serial string changed\n");
5414 changed = 1;
5415 }
5416 }
5417
Linus Torvalds1da177e2005-04-16 15:20:36 -07005418 kfree(buf);
Alan Sterneb764c42008-03-03 15:16:04 -05005419 return changed;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005420}
5421
5422/**
Ming Lei742120c2008-06-18 22:00:29 +08005423 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
Linus Torvalds1da177e2005-04-16 15:20:36 -07005424 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5425 *
Alan Stern79efa092006-06-01 13:33:42 -04005426 * WARNING - don't use this routine to reset a composite device
5427 * (one with multiple interfaces owned by separate drivers)!
Ming Lei742120c2008-06-18 22:00:29 +08005428 * Use usb_reset_device() instead.
Linus Torvalds1da177e2005-04-16 15:20:36 -07005429 *
5430 * Do a port reset, reassign the device's address, and establish its
5431 * former operating configuration. If the reset fails, or the device's
5432 * descriptors change from their values before the reset, or the original
5433 * configuration and altsettings cannot be restored, a flag will be set
Petr Mladek37ebb542014-09-19 17:32:23 +02005434 * telling hub_wq to pretend the device has been disconnected and then
Linus Torvalds1da177e2005-04-16 15:20:36 -07005435 * re-connected. All drivers will be unbound, and the device will be
5436 * re-enumerated and probed all over again.
5437 *
Yacine Belkadi626f0902013-08-02 20:10:04 +02005438 * Return: 0 if the reset succeeded, -ENODEV if the device has been
Linus Torvalds1da177e2005-04-16 15:20:36 -07005439 * flagged for logical disconnection, or some other negative error code
5440 * if the reset wasn't even attempted.
5441 *
Yacine Belkadi626f0902013-08-02 20:10:04 +02005442 * Note:
Dan Williams5c79a1e2014-05-20 18:09:26 -07005443 * The caller must own the device lock and the port lock, the latter is
5444 * taken by usb_reset_device(). For example, it's safe to use
5445 * usb_reset_device() from a driver probe() routine after downloading
5446 * new firmware. For calls that might not occur during probe(), drivers
5447 * should lock the device using usb_lock_device_for_reset().
Alan Stern6bc6cff2007-05-04 11:53:03 -04005448 *
5449 * Locking exception: This routine may also be called from within an
5450 * autoresume handler. Such usage won't conflict with other tasks
5451 * holding the device lock because these tasks should always call
Dan Williams5c79a1e2014-05-20 18:09:26 -07005452 * usb_autopm_resume_device(), thereby preventing any unwanted
5453 * autoresume. The autoresume handler is expected to have already
5454 * acquired the port lock before calling this routine.
Linus Torvalds1da177e2005-04-16 15:20:36 -07005455 */
Ming Lei742120c2008-06-18 22:00:29 +08005456static int usb_reset_and_verify_device(struct usb_device *udev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005457{
5458 struct usb_device *parent_hdev = udev->parent;
5459 struct usb_hub *parent_hub;
Sarah Sharp3f0479e2009-12-03 09:44:36 -08005460 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005461 struct usb_device_descriptor descriptor = udev->descriptor;
Xenia Ragiadakoue3376d62013-08-29 21:45:48 +03005462 struct usb_host_bos *bos;
Hans de Goede7a7b5622013-11-08 16:37:26 +01005463 int i, j, ret = 0;
Alan Stern12c3da32005-11-23 12:09:52 -05005464 int port1 = udev->portnum;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005465
5466 if (udev->state == USB_STATE_NOTATTACHED ||
5467 udev->state == USB_STATE_SUSPENDED) {
5468 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5469 udev->state);
5470 return -EINVAL;
5471 }
5472
Dan Williams5c79a1e2014-05-20 18:09:26 -07005473 if (!parent_hdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005474 return -EISDIR;
Dan Williams5c79a1e2014-05-20 18:09:26 -07005475
Lan Tianyuad493e52013-01-23 04:26:30 +08005476 parent_hub = usb_hub_to_struct_hub(parent_hdev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005477
Sarah Sharpdcc01c02013-09-30 17:26:29 +03005478 /* Disable USB2 hardware LPM.
5479 * It will be re-enabled by the enumeration process.
5480 */
Kai-Heng Feng9b916af2019-01-12 03:54:25 +08005481 usb_disable_usb2_hardware_lpm(udev);
Sarah Sharpdcc01c02013-09-30 17:26:29 +03005482
Sarah Sharpf74631e2012-06-25 12:08:08 -07005483 /* Disable LPM and LTM while we reset the device and reinstall the alt
5484 * settings. Device-initiated LPM settings, and system exit latency
5485 * settings are cleared when the device is reset, so we have to set
5486 * them up again.
Sarah Sharp6d1d0512012-07-03 22:49:04 -07005487 */
5488 ret = usb_unlocked_disable_lpm(udev);
5489 if (ret) {
5490 dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
Hans Yang464ad8c2015-12-01 16:54:59 +08005491 goto re_enumerate_no_bos;
Sarah Sharp6d1d0512012-07-03 22:49:04 -07005492 }
Sarah Sharpf74631e2012-06-25 12:08:08 -07005493 ret = usb_disable_ltm(udev);
5494 if (ret) {
5495 dev_err(&udev->dev, "%s Failed to disable LTM\n.",
5496 __func__);
Hans Yang464ad8c2015-12-01 16:54:59 +08005497 goto re_enumerate_no_bos;
Sarah Sharpf74631e2012-06-25 12:08:08 -07005498 }
Sarah Sharp6d1d0512012-07-03 22:49:04 -07005499
Hans Yang464ad8c2015-12-01 16:54:59 +08005500 bos = udev->bos;
Greg Kroah-Hartmane5bdfd52016-02-20 14:19:34 -08005501 udev->bos = NULL;
Hans Yang464ad8c2015-12-01 16:54:59 +08005502
Linus Torvalds1da177e2005-04-16 15:20:36 -07005503 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
5504
5505 /* ep0 maxpacket size may change; let the HCD know about it.
5506 * Other endpoints will be handled by re-enumeration. */
Inaky Perez-Gonzalezfc721f52008-04-08 13:24:46 -07005507 usb_ep0_reinit(udev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005508 ret = hub_port_init(parent_hub, udev, port1, i);
Alan Sterndd4dd192007-05-04 11:55:54 -04005509 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
Linus Torvalds1da177e2005-04-16 15:20:36 -07005510 break;
5511 }
Alan Sternd5cbad42006-08-11 16:52:39 -04005512
Linus Torvalds1da177e2005-04-16 15:20:36 -07005513 if (ret < 0)
5514 goto re_enumerate;
Matthias Beyer469271f2013-10-10 23:41:27 +02005515
Linus Torvalds1da177e2005-04-16 15:20:36 -07005516 /* Device might have changed firmware (DFU or similar) */
Xenia Ragiadakoue3376d62013-08-29 21:45:48 +03005517 if (descriptors_changed(udev, &descriptor, bos)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07005518 dev_info(&udev->dev, "device firmware changed\n");
5519 udev->descriptor = descriptor; /* for disconnect() calls */
5520 goto re_enumerate;
Matthias Beyer469271f2013-10-10 23:41:27 +02005521 }
Alan Stern4fe03872009-02-26 10:21:02 -05005522
5523 /* Restore the device's previous configuration */
Linus Torvalds1da177e2005-04-16 15:20:36 -07005524 if (!udev->actconfig)
5525 goto done;
Sarah Sharp3f0479e2009-12-03 09:44:36 -08005526
Sarah Sharpd673bfc2010-10-15 08:55:24 -07005527 mutex_lock(hcd->bandwidth_mutex);
Sarah Sharp3f0479e2009-12-03 09:44:36 -08005528 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5529 if (ret < 0) {
5530 dev_warn(&udev->dev,
5531 "Busted HC? Not enough HCD resources for "
5532 "old configuration.\n");
Sarah Sharpd673bfc2010-10-15 08:55:24 -07005533 mutex_unlock(hcd->bandwidth_mutex);
Sarah Sharp3f0479e2009-12-03 09:44:36 -08005534 goto re_enumerate;
5535 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07005536 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5537 USB_REQ_SET_CONFIGURATION, 0,
5538 udev->actconfig->desc.bConfigurationValue, 0,
5539 NULL, 0, USB_CTRL_SET_TIMEOUT);
5540 if (ret < 0) {
5541 dev_err(&udev->dev,
5542 "can't restore configuration #%d (error=%d)\n",
5543 udev->actconfig->desc.bConfigurationValue, ret);
Sarah Sharpd673bfc2010-10-15 08:55:24 -07005544 mutex_unlock(hcd->bandwidth_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005545 goto re_enumerate;
Matthias Beyer469271f2013-10-10 23:41:27 +02005546 }
Sarah Sharpd673bfc2010-10-15 08:55:24 -07005547 mutex_unlock(hcd->bandwidth_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005548 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5549
Alan Stern4fe03872009-02-26 10:21:02 -05005550 /* Put interfaces back into the same altsettings as before.
5551 * Don't bother to send the Set-Interface request for interfaces
5552 * that were already in altsetting 0; besides being unnecessary,
5553 * many devices can't handle it. Instead just reset the host-side
5554 * endpoint state.
5555 */
Linus Torvalds1da177e2005-04-16 15:20:36 -07005556 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
Sarah Sharp3f0479e2009-12-03 09:44:36 -08005557 struct usb_host_config *config = udev->actconfig;
5558 struct usb_interface *intf = config->interface[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -07005559 struct usb_interface_descriptor *desc;
5560
Linus Torvalds1da177e2005-04-16 15:20:36 -07005561 desc = &intf->cur_altsetting->desc;
Alan Stern4fe03872009-02-26 10:21:02 -05005562 if (desc->bAlternateSetting == 0) {
5563 usb_disable_interface(udev, intf, true);
5564 usb_enable_interface(udev, intf, true);
5565 ret = 0;
5566 } else {
Sarah Sharp04a723e2010-01-06 10:16:51 -08005567 /* Let the bandwidth allocation function know that this
5568 * device has been reset, and it will have to use
5569 * alternate setting 0 as the current alternate setting.
Sarah Sharp3f0479e2009-12-03 09:44:36 -08005570 */
Sarah Sharp04a723e2010-01-06 10:16:51 -08005571 intf->resetting_device = 1;
Alan Stern4fe03872009-02-26 10:21:02 -05005572 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5573 desc->bAlternateSetting);
Sarah Sharp04a723e2010-01-06 10:16:51 -08005574 intf->resetting_device = 0;
Alan Stern4fe03872009-02-26 10:21:02 -05005575 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07005576 if (ret < 0) {
5577 dev_err(&udev->dev, "failed to restore interface %d "
5578 "altsetting %d (error=%d)\n",
5579 desc->bInterfaceNumber,
5580 desc->bAlternateSetting,
5581 ret);
5582 goto re_enumerate;
5583 }
Hans de Goede7a7b5622013-11-08 16:37:26 +01005584 /* Resetting also frees any allocated streams */
5585 for (j = 0; j < intf->cur_altsetting->desc.bNumEndpoints; j++)
5586 intf->cur_altsetting->endpoint[j].streams = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005587 }
5588
5589done:
Sarah Sharpf74631e2012-06-25 12:08:08 -07005590 /* Now that the alt settings are re-installed, enable LTM and LPM. */
Kai-Heng Fengc73982b2019-01-12 03:54:24 +08005591 usb_enable_usb2_hardware_lpm(udev);
Alan Stern78d9a482008-06-23 16:00:40 -04005592 usb_unlocked_enable_lpm(udev);
Sarah Sharpf74631e2012-06-25 12:08:08 -07005593 usb_enable_ltm(udev);
Greg Kroah-Hartmane5bdfd52016-02-20 14:19:34 -08005594 usb_release_bos_descriptor(udev);
5595 udev->bos = bos;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005596 return 0;
Matthias Beyer469271f2013-10-10 23:41:27 +02005597
Linus Torvalds1da177e2005-04-16 15:20:36 -07005598re_enumerate:
Xenia Ragiadakoue3376d62013-08-29 21:45:48 +03005599 usb_release_bos_descriptor(udev);
5600 udev->bos = bos;
Hans Yang464ad8c2015-12-01 16:54:59 +08005601re_enumerate_no_bos:
5602 /* LPM state doesn't matter when we're about to destroy the device. */
5603 hub_port_logical_disconnect(parent_hub, port1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07005604 return -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07005605}
5606
5607/**
5608 * usb_reset_device - warn interface drivers and perform a USB port reset
5609 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5610 *
Alan Stern79efa092006-06-01 13:33:42 -04005611 * Warns all drivers bound to registered interfaces (using their pre_reset
5612 * method), performs the port reset, and then lets the drivers know that
Ming Lei742120c2008-06-18 22:00:29 +08005613 * the reset is over (using their post_reset method).
Alan Stern79efa092006-06-01 13:33:42 -04005614 *
Yacine Belkadi626f0902013-08-02 20:10:04 +02005615 * Return: The same as for usb_reset_and_verify_device().
Alan Stern79efa092006-06-01 13:33:42 -04005616 *
Yacine Belkadi626f0902013-08-02 20:10:04 +02005617 * Note:
Alan Stern79efa092006-06-01 13:33:42 -04005618 * The caller must own the device lock. For example, it's safe to use
5619 * this from a driver probe() routine after downloading new firmware.
5620 * For calls that might not occur during probe(), drivers should lock
Ming Lei742120c2008-06-18 22:00:29 +08005621 * the device using usb_lock_device_for_reset().
Alan Stern79efa092006-06-01 13:33:42 -04005622 *
5623 * If an interface is currently being probed or disconnected, we assume
5624 * its driver knows how to handle resets. For all other interfaces,
5625 * if the driver doesn't have pre_reset and post_reset methods then
5626 * we attempt to unbind it and rebind afterward.
Alan Stern79efa092006-06-01 13:33:42 -04005627 */
Ming Lei742120c2008-06-18 22:00:29 +08005628int usb_reset_device(struct usb_device *udev)
Alan Stern79efa092006-06-01 13:33:42 -04005629{
5630 int ret;
Alan Stern852c4b42007-12-03 15:44:29 -05005631 int i;
Ming Lei4d769de2013-02-22 16:34:22 -08005632 unsigned int noio_flag;
Dan Williams5c79a1e2014-05-20 18:09:26 -07005633 struct usb_port *port_dev;
Alan Stern79efa092006-06-01 13:33:42 -04005634 struct usb_host_config *config = udev->actconfig;
Dan Williams5c79a1e2014-05-20 18:09:26 -07005635 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
Alan Stern79efa092006-06-01 13:33:42 -04005636
5637 if (udev->state == USB_STATE_NOTATTACHED ||
5638 udev->state == USB_STATE_SUSPENDED) {
5639 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5640 udev->state);
5641 return -EINVAL;
5642 }
5643
Dan Williams5c79a1e2014-05-20 18:09:26 -07005644 if (!udev->parent) {
5645 /* this requires hcd-specific logic; see ohci_restart() */
5646 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
5647 return -EISDIR;
5648 }
5649
5650 port_dev = hub->ports[udev->portnum - 1];
5651
Ming Lei4d769de2013-02-22 16:34:22 -08005652 /*
5653 * Don't allocate memory with GFP_KERNEL in current
5654 * context to avoid possible deadlock if usb mass
5655 * storage interface or usbnet interface(iSCSI case)
5656 * is included in current configuration. The easist
5657 * approach is to do it for every device reset,
5658 * because the device 'memalloc_noio' flag may have
5659 * not been set before reseting the usb device.
5660 */
5661 noio_flag = memalloc_noio_save();
5662
Alan Stern645daaa2006-08-30 15:47:02 -04005663 /* Prevent autosuspend during the reset */
Alan Stern94fcda12006-11-20 11:38:46 -05005664 usb_autoresume_device(udev);
Alan Stern645daaa2006-08-30 15:47:02 -04005665
Alan Stern79efa092006-06-01 13:33:42 -04005666 if (config) {
Alan Stern79efa092006-06-01 13:33:42 -04005667 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
Alan Stern852c4b42007-12-03 15:44:29 -05005668 struct usb_interface *cintf = config->interface[i];
5669 struct usb_driver *drv;
Alan Stern78d9a482008-06-23 16:00:40 -04005670 int unbind = 0;
Alan Stern852c4b42007-12-03 15:44:29 -05005671
5672 if (cintf->dev.driver) {
Alan Stern79efa092006-06-01 13:33:42 -04005673 drv = to_usb_driver(cintf->dev.driver);
Alan Stern78d9a482008-06-23 16:00:40 -04005674 if (drv->pre_reset && drv->post_reset)
5675 unbind = (drv->pre_reset)(cintf);
5676 else if (cintf->condition ==
5677 USB_INTERFACE_BOUND)
5678 unbind = 1;
5679 if (unbind)
5680 usb_forced_unbind_intf(cintf);
Alan Stern79efa092006-06-01 13:33:42 -04005681 }
5682 }
5683 }
5684
Dan Williams5c79a1e2014-05-20 18:09:26 -07005685 usb_lock_port(port_dev);
Ming Lei742120c2008-06-18 22:00:29 +08005686 ret = usb_reset_and_verify_device(udev);
Dan Williams5c79a1e2014-05-20 18:09:26 -07005687 usb_unlock_port(port_dev);
Alan Stern79efa092006-06-01 13:33:42 -04005688
5689 if (config) {
Alan Stern79efa092006-06-01 13:33:42 -04005690 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
Alan Stern852c4b42007-12-03 15:44:29 -05005691 struct usb_interface *cintf = config->interface[i];
5692 struct usb_driver *drv;
Alan Stern78d9a482008-06-23 16:00:40 -04005693 int rebind = cintf->needs_binding;
Alan Stern852c4b42007-12-03 15:44:29 -05005694
Alan Stern78d9a482008-06-23 16:00:40 -04005695 if (!rebind && cintf->dev.driver) {
Alan Stern79efa092006-06-01 13:33:42 -04005696 drv = to_usb_driver(cintf->dev.driver);
5697 if (drv->post_reset)
Alan Stern78d9a482008-06-23 16:00:40 -04005698 rebind = (drv->post_reset)(cintf);
5699 else if (cintf->condition ==
5700 USB_INTERFACE_BOUND)
5701 rebind = 1;
Alan Stern6aec0442014-03-12 11:30:38 -04005702 if (rebind)
5703 cintf->needs_binding = 1;
Alan Stern79efa092006-06-01 13:33:42 -04005704 }
Alan Stern79efa092006-06-01 13:33:42 -04005705 }
Alan Stern9105d112019-04-16 10:50:01 -04005706
5707 /* If the reset failed, hub_wq will unbind drivers later */
5708 if (ret == 0)
5709 usb_unbind_and_rebind_marked_interfaces(udev);
Alan Stern79efa092006-06-01 13:33:42 -04005710 }
5711
Alan Stern94fcda12006-11-20 11:38:46 -05005712 usb_autosuspend_device(udev);
Ming Lei4d769de2013-02-22 16:34:22 -08005713 memalloc_noio_restore(noio_flag);
Alan Stern79efa092006-06-01 13:33:42 -04005714 return ret;
5715}
Ming Lei742120c2008-06-18 22:00:29 +08005716EXPORT_SYMBOL_GPL(usb_reset_device);
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -08005717
5718
5719/**
5720 * usb_queue_reset_device - Reset a USB device from an atomic context
5721 * @iface: USB interface belonging to the device to reset
5722 *
5723 * This function can be used to reset a USB device from an atomic
5724 * context, where usb_reset_device() won't work (as it blocks).
5725 *
5726 * Doing a reset via this method is functionally equivalent to calling
5727 * usb_reset_device(), except for the fact that it is delayed to a
5728 * workqueue. This means that any drivers bound to other interfaces
5729 * might be unbound, as well as users from usbfs in user space.
5730 *
5731 * Corner cases:
5732 *
5733 * - Scheduling two resets at the same time from two different drivers
5734 * attached to two different interfaces of the same device is
5735 * possible; depending on how the driver attached to each interface
5736 * handles ->pre_reset(), the second reset might happen or not.
5737 *
Alan Stern524134d2015-01-21 14:02:43 -05005738 * - If the reset is delayed so long that the interface is unbound from
5739 * its driver, the reset will be skipped.
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -08005740 *
Alan Stern524134d2015-01-21 14:02:43 -05005741 * - This function can be called during .probe(). It can also be called
5742 * during .disconnect(), but doing so is pointless because the reset
5743 * will not occur. If you really want to reset the device during
5744 * .disconnect(), call usb_reset_device() directly -- but watch out
5745 * for nested unbinding issues!
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -08005746 */
5747void usb_queue_reset_device(struct usb_interface *iface)
5748{
Alan Stern524134d2015-01-21 14:02:43 -05005749 if (schedule_work(&iface->reset_ws))
5750 usb_get_intf(iface);
Inaky Perez-Gonzalezdc023dc2008-11-13 10:31:35 -08005751}
5752EXPORT_SYMBOL_GPL(usb_queue_reset_device);
Lan Tianyuff823c72012-09-05 13:44:32 +08005753
5754/**
5755 * usb_hub_find_child - Get the pointer of child device
5756 * attached to the port which is specified by @port1.
5757 * @hdev: USB device belonging to the usb hub
5758 * @port1: port num to indicate which port the child device
5759 * is attached to.
5760 *
5761 * USB drivers call this function to get hub's child device
5762 * pointer.
5763 *
Yacine Belkadi626f0902013-08-02 20:10:04 +02005764 * Return: %NULL if input param is invalid and
Lan Tianyuff823c72012-09-05 13:44:32 +08005765 * child's usb_device pointer if non-NULL.
5766 */
5767struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5768 int port1)
5769{
Lan Tianyuad493e52013-01-23 04:26:30 +08005770 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
Lan Tianyuff823c72012-09-05 13:44:32 +08005771
5772 if (port1 < 1 || port1 > hdev->maxchild)
5773 return NULL;
5774 return hub->ports[port1 - 1]->child;
5775}
5776EXPORT_SYMBOL_GPL(usb_hub_find_child);
Lan Tianyud5575422012-09-05 13:44:33 +08005777
Lan Tianyud2123fd2013-01-21 22:18:00 +08005778void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
5779 struct usb_hub_descriptor *desc)
5780{
Dan Williamsd99f6b42014-05-20 18:08:17 -07005781 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
Lan Tianyud2123fd2013-01-21 22:18:00 +08005782 enum usb_port_connect_type connect_type;
5783 int i;
5784
Dan Williamsd99f6b42014-05-20 18:08:17 -07005785 if (!hub)
5786 return;
5787
Lan Tianyud2123fd2013-01-21 22:18:00 +08005788 if (!hub_is_superspeed(hdev)) {
5789 for (i = 1; i <= hdev->maxchild; i++) {
Dan Williamsd99f6b42014-05-20 18:08:17 -07005790 struct usb_port *port_dev = hub->ports[i - 1];
Lan Tianyud2123fd2013-01-21 22:18:00 +08005791
Dan Williamsd99f6b42014-05-20 18:08:17 -07005792 connect_type = port_dev->connect_type;
Lan Tianyud2123fd2013-01-21 22:18:00 +08005793 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5794 u8 mask = 1 << (i%8);
5795
5796 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
Dan Williamsd99f6b42014-05-20 18:08:17 -07005797 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
Lan Tianyud2123fd2013-01-21 22:18:00 +08005798 desc->u.hs.DeviceRemovable[i/8] |= mask;
5799 }
5800 }
5801 }
5802 } else {
5803 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
5804
5805 for (i = 1; i <= hdev->maxchild; i++) {
Dan Williamsd99f6b42014-05-20 18:08:17 -07005806 struct usb_port *port_dev = hub->ports[i - 1];
Lan Tianyud2123fd2013-01-21 22:18:00 +08005807
Dan Williamsd99f6b42014-05-20 18:08:17 -07005808 connect_type = port_dev->connect_type;
Lan Tianyud2123fd2013-01-21 22:18:00 +08005809 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5810 u16 mask = 1 << i;
5811
5812 if (!(port_removable & mask)) {
Dan Williamsd99f6b42014-05-20 18:08:17 -07005813 dev_dbg(&port_dev->dev, "DeviceRemovable is changed to 1 according to platform information.\n");
Lan Tianyud2123fd2013-01-21 22:18:00 +08005814 port_removable |= mask;
5815 }
5816 }
5817 }
5818
5819 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
5820 }
5821}
5822
Lan Tianyud5575422012-09-05 13:44:33 +08005823#ifdef CONFIG_ACPI
5824/**
5825 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5826 * @hdev: USB device belonging to the usb hub
5827 * @port1: port num of the port
5828 *
Yacine Belkadi626f0902013-08-02 20:10:04 +02005829 * Return: Port's acpi handle if successful, %NULL if params are
5830 * invalid.
Lan Tianyud5575422012-09-05 13:44:33 +08005831 */
5832acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
5833 int port1)
5834{
Lan Tianyuad493e52013-01-23 04:26:30 +08005835 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
Lan Tianyud5575422012-09-05 13:44:33 +08005836
Mathias Nyman41341262013-06-18 17:28:48 +03005837 if (!hub)
5838 return NULL;
5839
Rafael J. Wysocki3a83f992013-11-14 23:17:21 +01005840 return ACPI_HANDLE(&hub->ports[port1 - 1]->dev);
Lan Tianyud5575422012-09-05 13:44:33 +08005841}
5842#endif