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