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