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