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