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