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