Merge tag 'v3.10.56' 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->actconfig->desc.bmAttributes
2109 & USB_CONFIG_ATT_WAKEUP;
2110 else
2111 wakeup = 0;
2112 }
2113 if (udev->state == USB_STATE_SUSPENDED &&
2114 new_state != USB_STATE_SUSPENDED)
2115 udev->active_duration -= jiffies;
2116 else if (new_state == USB_STATE_SUSPENDED &&
2117 udev->state != USB_STATE_SUSPENDED)
2118 udev->active_duration += jiffies;
2119 udev->state = new_state;
2120 } else
2121 recursively_mark_NOTATTACHED(udev);
2122 spin_unlock_irqrestore(&device_state_lock, flags);
2123 if (wakeup >= 0)
2124 device_set_wakeup_capable(&udev->dev, wakeup);
2125 }
2126 EXPORT_SYMBOL_GPL(usb_set_device_state);
2127
2128 /*
2129 * Choose a device number.
2130 *
2131 * Device numbers are used as filenames in usbfs. On USB-1.1 and
2132 * USB-2.0 buses they are also used as device addresses, however on
2133 * USB-3.0 buses the address is assigned by the controller hardware
2134 * and it usually is not the same as the device number.
2135 *
2136 * WUSB devices are simple: they have no hubs behind, so the mapping
2137 * device <-> virtual port number becomes 1:1. Why? to simplify the
2138 * life of the device connection logic in
2139 * drivers/usb/wusbcore/devconnect.c. When we do the initial secret
2140 * handshake we need to assign a temporary address in the unauthorized
2141 * space. For simplicity we use the first virtual port number found to
2142 * be free [drivers/usb/wusbcore/devconnect.c:wusbhc_devconnect_ack()]
2143 * and that becomes it's address [X < 128] or its unauthorized address
2144 * [X | 0x80].
2145 *
2146 * We add 1 as an offset to the one-based USB-stack port number
2147 * (zero-based wusb virtual port index) for two reasons: (a) dev addr
2148 * 0 is reserved by USB for default address; (b) Linux's USB stack
2149 * uses always #1 for the root hub of the controller. So USB stack's
2150 * port #1, which is wusb virtual-port #0 has address #2.
2151 *
2152 * Devices connected under xHCI are not as simple. The host controller
2153 * supports virtualization, so the hardware assigns device addresses and
2154 * the HCD must setup data structures before issuing a set address
2155 * command to the hardware.
2156 */
2157 static void choose_devnum(struct usb_device *udev)
2158 {
2159 int devnum;
2160 struct usb_bus *bus = udev->bus;
2161
2162 /* If khubd ever becomes multithreaded, this will need a lock */
2163 if (udev->wusb) {
2164 devnum = udev->portnum + 1;
2165 BUG_ON(test_bit(devnum, bus->devmap.devicemap));
2166 } else {
2167 /* Try to allocate the next devnum beginning at
2168 * bus->devnum_next. */
2169 devnum = find_next_zero_bit(bus->devmap.devicemap, 128,
2170 bus->devnum_next);
2171 if (devnum >= 128)
2172 devnum = find_next_zero_bit(bus->devmap.devicemap,
2173 128, 1);
2174 bus->devnum_next = ( devnum >= 127 ? 1 : devnum + 1);
2175 }
2176 if (devnum < 128) {
2177 set_bit(devnum, bus->devmap.devicemap);
2178 udev->devnum = devnum;
2179 }
2180 }
2181
2182 static void release_devnum(struct usb_device *udev)
2183 {
2184 if (udev->devnum > 0) {
2185 clear_bit(udev->devnum, udev->bus->devmap.devicemap);
2186 udev->devnum = -1;
2187 }
2188 }
2189
2190 static void update_devnum(struct usb_device *udev, int devnum)
2191 {
2192 /* The address for a WUSB device is managed by wusbcore. */
2193 if (!udev->wusb)
2194 udev->devnum = devnum;
2195 }
2196
2197 static void hub_free_dev(struct usb_device *udev)
2198 {
2199 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2200
2201 /* Root hubs aren't real devices, so don't free HCD resources */
2202 if (hcd->driver->free_dev && udev->parent)
2203 hcd->driver->free_dev(hcd, udev);
2204 }
2205
2206 /**
2207 * usb_disconnect - disconnect a device (usbcore-internal)
2208 * @pdev: pointer to device being disconnected
2209 * Context: !in_interrupt ()
2210 *
2211 * Something got disconnected. Get rid of it and all of its children.
2212 *
2213 * If *pdev is a normal device then the parent hub must already be locked.
2214 * If *pdev is a root hub then this routine will acquire the
2215 * usb_bus_list_lock on behalf of the caller.
2216 *
2217 * Only hub drivers (including virtual root hub drivers for host
2218 * controllers) should ever call this.
2219 *
2220 * This call is synchronous, and may not be used in an interrupt context.
2221 */
2222 void usb_disconnect(struct usb_device **pdev)
2223 {
2224 struct usb_device *udev = *pdev;
2225 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
2226 int i;
2227 struct timeval tv_begin, tv_end;
2228 struct timeval tv_before, tv_after;
2229 do_gettimeofday(&tv_begin);
2230
2231 #ifdef CONFIG_MTK_ICUSB_SUPPORT
2232 int is_icusb_rh;
2233 #endif
2234
2235 #ifdef CONFIG_MTK_ICUSB_SUPPORT
2236 is_icusb_rh = is_musbfsh_rh(udev->parent);
2237 #endif
2238
2239
2240 /* mark the device as inactive, so any further urb submissions for
2241 * this device (and any of its children) will fail immediately.
2242 * this quiesces everything except pending urbs.
2243 */
2244 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2245 dev_info(&udev->dev, "USB disconnect, device number %d\n",
2246 udev->devnum);
2247
2248 usb_lock_device(udev);
2249
2250 /* Free up all the children before we remove this device */
2251 for (i = 0; i < udev->maxchild; i++) {
2252 if (hub->ports[i]->child)
2253 usb_disconnect(&hub->ports[i]->child);
2254 }
2255
2256 /* deallocate hcd/hardware state ... nuking all pending urbs and
2257 * cleaning up all state associated with the current configuration
2258 * so that the hardware is now fully quiesced.
2259 */
2260 dev_dbg (&udev->dev, "unregistering device\n");
2261
2262 do_gettimeofday(&tv_before);
2263 usb_disable_device(udev, 0);
2264 do_gettimeofday(&tv_after);
2265 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));
2266
2267 usb_hcd_synchronize_unlinks(udev);
2268
2269 if (udev->parent) {
2270 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2271 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2272
2273 sysfs_remove_link(&udev->dev.kobj, "port");
2274 sysfs_remove_link(&port_dev->dev.kobj, "device");
2275
2276 if (!port_dev->did_runtime_put)
2277 pm_runtime_put(&port_dev->dev);
2278 else
2279 port_dev->did_runtime_put = false;
2280 }
2281
2282 do_gettimeofday(&tv_before);
2283 usb_remove_ep_devs(&udev->ep0);
2284 do_gettimeofday(&tv_after);
2285 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));
2286
2287 usb_unlock_device(udev);
2288
2289 /* Unregister the device. The device driver is responsible
2290 * for de-configuring the device and invoking the remove-device
2291 * notifier chain (used by usbfs and possibly others).
2292 */
2293 do_gettimeofday(&tv_before);
2294 device_del(&udev->dev);
2295 do_gettimeofday(&tv_after);
2296 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));
2297
2298 /* Free the device number and delete the parent's children[]
2299 * (or root_hub) pointer.
2300 */
2301 release_devnum(udev);
2302
2303 /* Avoid races with recursively_mark_NOTATTACHED() */
2304 spin_lock_irq(&device_state_lock);
2305 *pdev = NULL;
2306 spin_unlock_irq(&device_state_lock);
2307
2308 hub_free_dev(udev);
2309
2310 put_device(&udev->dev);
2311
2312 #ifdef CONFIG_MTK_ICUSB_SUPPORT
2313 if (is_icusb_rh)
2314 {
2315 set_icusb_sts_disconnect_done();
2316 MYDBG("ICUSB Disconnect\n");
2317 }
2318 #endif
2319 do_gettimeofday(&tv_end);
2320 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));
2321 }
2322
2323 #ifdef CONFIG_USB_ANNOUNCE_NEW_DEVICES
2324 static void show_string(struct usb_device *udev, char *id, char *string)
2325 {
2326 if (!string)
2327 return;
2328 dev_info(&udev->dev, "%s: %s\n", id, string);
2329 }
2330
2331 static void announce_device(struct usb_device *udev)
2332 {
2333 dev_info(&udev->dev, "New USB device found, idVendor=%04x, idProduct=%04x\n",
2334 le16_to_cpu(udev->descriptor.idVendor),
2335 le16_to_cpu(udev->descriptor.idProduct));
2336 dev_info(&udev->dev,
2337 "New USB device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
2338 udev->descriptor.iManufacturer,
2339 udev->descriptor.iProduct,
2340 udev->descriptor.iSerialNumber);
2341 show_string(udev, "Product", udev->product);
2342 show_string(udev, "Manufacturer", udev->manufacturer);
2343 show_string(udev, "SerialNumber", udev->serial);
2344 }
2345 #else
2346 static inline void announce_device(struct usb_device *udev) { }
2347 #endif
2348
2349 #ifdef CONFIG_USB_OTG
2350 #include "otg_whitelist.h"
2351 #endif
2352
2353 /**
2354 * usb_enumerate_device_otg - FIXME (usbcore-internal)
2355 * @udev: newly addressed device (in ADDRESS state)
2356 *
2357 * Finish enumeration for On-The-Go devices
2358 */
2359 static int usb_enumerate_device_otg(struct usb_device *udev)
2360 {
2361 int err = 0;
2362
2363 #ifdef CONFIG_USB_OTG
2364 /*
2365 * OTG-aware devices on OTG-capable root hubs may be able to use SRP,
2366 * to wake us after we've powered off VBUS; and HNP, switching roles
2367 * "host" to "peripheral". The OTG descriptor helps figure this out.
2368 */
2369 if (!udev->bus->is_b_host
2370 && udev->config
2371 && udev->parent == udev->bus->root_hub) {
2372 struct usb_otg_descriptor *desc = NULL;
2373 struct usb_bus *bus = udev->bus;
2374
2375 /* descriptor may appear anywhere in config */
2376 if (__usb_get_extra_descriptor (udev->rawdescriptors[0],
2377 le16_to_cpu(udev->config[0].desc.wTotalLength),
2378 USB_DT_OTG, (void **) &desc) == 0) {
2379 if (desc->bmAttributes & USB_OTG_HNP) {
2380 unsigned port1 = udev->portnum;
2381
2382 dev_info(&udev->dev,
2383 "Dual-Role OTG device on %sHNP port\n",
2384 (port1 == bus->otg_port)
2385 ? "" : "non-");
2386
2387 /* enable HNP before suspend, it's simpler */
2388 if (port1 == bus->otg_port)
2389 bus->b_hnp_enable = 1;
2390 err = usb_control_msg(udev,
2391 usb_sndctrlpipe(udev, 0),
2392 USB_REQ_SET_FEATURE, 0,
2393 bus->b_hnp_enable
2394 ? USB_DEVICE_B_HNP_ENABLE
2395 : USB_DEVICE_A_ALT_HNP_SUPPORT,
2396 0, NULL, 0, USB_CTRL_SET_TIMEOUT);
2397 if (err < 0) {
2398 /* OTG MESSAGE: report errors here,
2399 * customize to match your product.
2400 */
2401 dev_info(&udev->dev,
2402 "can't set HNP mode: %d\n",
2403 err);
2404 bus->b_hnp_enable = 0;
2405 }
2406 }
2407 }
2408 }
2409
2410 if (!is_targeted(udev)) {
2411
2412 /* Maybe it can talk to us, though we can't talk to it.
2413 * (Includes HNP test device.)
2414 */
2415 if (udev->bus->b_hnp_enable || udev->bus->is_b_host) {
2416 err = usb_port_suspend(udev, PMSG_SUSPEND);
2417 if (err < 0)
2418 dev_dbg(&udev->dev, "HNP fail, %d\n", err);
2419 }
2420 err = -ENOTSUPP;
2421 goto fail;
2422 }
2423 fail:
2424 #endif
2425 return err;
2426 }
2427
2428
2429 /**
2430 * usb_enumerate_device - Read device configs/intfs/otg (usbcore-internal)
2431 * @udev: newly addressed device (in ADDRESS state)
2432 *
2433 * This is only called by usb_new_device() and usb_authorize_device()
2434 * and FIXME -- all comments that apply to them apply here wrt to
2435 * environment.
2436 *
2437 * If the device is WUSB and not authorized, we don't attempt to read
2438 * the string descriptors, as they will be errored out by the device
2439 * until it has been authorized.
2440 */
2441 static int usb_enumerate_device(struct usb_device *udev)
2442 {
2443 int err;
2444
2445 if (udev->config == NULL) {
2446 err = usb_get_configuration(udev);
2447 if (err < 0) {
2448 if (err != -ENODEV)
2449 dev_err(&udev->dev, "can't read configurations, error %d\n",
2450 err);
2451 return err;
2452 }
2453 }
2454
2455 /* read the standard strings and cache them if present */
2456 udev->product = usb_cache_string(udev, udev->descriptor.iProduct);
2457 udev->manufacturer = usb_cache_string(udev,
2458 udev->descriptor.iManufacturer);
2459 udev->serial = usb_cache_string(udev, udev->descriptor.iSerialNumber);
2460
2461 err = usb_enumerate_device_otg(udev);
2462
2463 #if defined(CONFIG_USBIF_COMPLIANCE) && defined(CONFIG_USB_XHCI_HCD)
2464 if (udev->parent){ // we don't have to check ourself (roothub)
2465 if (!is_targeted(udev)) {
2466 usbif_u3h_send_event("DEV_NOT_SUPPORTED");
2467 err = -ENOTSUPP;
2468 }
2469 }
2470 #endif
2471
2472 if (err < 0)
2473 return err;
2474
2475 usb_detect_interface_quirks(udev);
2476
2477 return 0;
2478 }
2479
2480 static void set_usb_port_removable(struct usb_device *udev)
2481 {
2482 struct usb_device *hdev = udev->parent;
2483 struct usb_hub *hub;
2484 u8 port = udev->portnum;
2485 u16 wHubCharacteristics;
2486 bool removable = true;
2487
2488 if (!hdev)
2489 return;
2490
2491 hub = usb_hub_to_struct_hub(udev->parent);
2492
2493 wHubCharacteristics = le16_to_cpu(hub->descriptor->wHubCharacteristics);
2494
2495 if (!(wHubCharacteristics & HUB_CHAR_COMPOUND))
2496 return;
2497
2498 if (hub_is_superspeed(hdev)) {
2499 if (le16_to_cpu(hub->descriptor->u.ss.DeviceRemovable)
2500 & (1 << port))
2501 removable = false;
2502 } else {
2503 if (hub->descriptor->u.hs.DeviceRemovable[port / 8] & (1 << (port % 8)))
2504 removable = false;
2505 }
2506
2507 if (removable)
2508 udev->removable = USB_DEVICE_REMOVABLE;
2509 else
2510 udev->removable = USB_DEVICE_FIXED;
2511 }
2512
2513 /**
2514 * usb_new_device - perform initial device setup (usbcore-internal)
2515 * @udev: newly addressed device (in ADDRESS state)
2516 *
2517 * This is called with devices which have been detected but not fully
2518 * enumerated. The device descriptor is available, but not descriptors
2519 * for any device configuration. The caller must have locked either
2520 * the parent hub (if udev is a normal device) or else the
2521 * usb_bus_list_lock (if udev is a root hub). The parent's pointer to
2522 * udev has already been installed, but udev is not yet visible through
2523 * sysfs or other filesystem code.
2524 *
2525 * It will return if the device is configured properly or not. Zero if
2526 * the interface was registered with the driver core; else a negative
2527 * errno value.
2528 *
2529 * This call is synchronous, and may not be used in an interrupt context.
2530 *
2531 * Only the hub driver or root-hub registrar should ever call this.
2532 */
2533 int usb_new_device(struct usb_device *udev)
2534 {
2535 int err;
2536
2537 if (udev->parent) {
2538 /* Initialize non-root-hub device wakeup to disabled;
2539 * device (un)configuration controls wakeup capable
2540 * sysfs power/wakeup controls wakeup enabled/disabled
2541 */
2542 device_init_wakeup(&udev->dev, 0);
2543 MYDBG("udev :%p\n", udev);
2544 #ifdef CONFIG_MTK_DT_USB_SUPPORT
2545 #ifdef CONFIG_PM_RUNTIME
2546 if(is_musbfsh_rh(udev->parent)){
2547 MYDBG("\n");
2548 /*find out struct *usb_hub and hook it */
2549 usb11_hub = usb_hub_to_struct_hub(udev->parent);
2550 }
2551 #endif
2552 #endif
2553 }
2554
2555 /* Tell the runtime-PM framework the device is active */
2556 pm_runtime_set_active(&udev->dev);
2557 pm_runtime_get_noresume(&udev->dev);
2558 pm_runtime_use_autosuspend(&udev->dev);
2559 pm_runtime_enable(&udev->dev);
2560
2561 /* By default, forbid autosuspend for all devices. It will be
2562 * allowed for hubs during binding.
2563 */
2564 usb_disable_autosuspend(udev);
2565
2566 err = usb_enumerate_device(udev); /* Read descriptors */
2567 if (err < 0)
2568 goto fail;
2569 dev_dbg(&udev->dev, "udev %d, busnum %d, minor = %d\n",
2570 udev->devnum, udev->bus->busnum,
2571 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2572 /* export the usbdev device-node for libusb */
2573 udev->dev.devt = MKDEV(USB_DEVICE_MAJOR,
2574 (((udev->bus->busnum-1) * 128) + (udev->devnum-1)));
2575
2576 /* Tell the world! */
2577 announce_device(udev);
2578
2579 if (udev->serial)
2580 add_device_randomness(udev->serial, strlen(udev->serial));
2581 if (udev->product)
2582 add_device_randomness(udev->product, strlen(udev->product));
2583 if (udev->manufacturer)
2584 add_device_randomness(udev->manufacturer,
2585 strlen(udev->manufacturer));
2586
2587 device_enable_async_suspend(&udev->dev);
2588
2589 /*
2590 * check whether the hub marks this port as non-removable. Do it
2591 * now so that platform-specific data can override it in
2592 * device_add()
2593 */
2594 if (udev->parent)
2595 set_usb_port_removable(udev);
2596
2597 /* Register the device. The device driver is responsible
2598 * for configuring the device and invoking the add-device
2599 * notifier chain (used by usbfs and possibly others).
2600 */
2601 err = device_add(&udev->dev);
2602 if (err) {
2603 dev_err(&udev->dev, "can't device_add, error %d\n", err);
2604 goto fail;
2605 }
2606
2607 /* Create link files between child device and usb port device. */
2608 if (udev->parent) {
2609 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
2610 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
2611
2612 err = sysfs_create_link(&udev->dev.kobj,
2613 &port_dev->dev.kobj, "port");
2614 if (err)
2615 goto fail;
2616
2617 err = sysfs_create_link(&port_dev->dev.kobj,
2618 &udev->dev.kobj, "device");
2619 if (err) {
2620 sysfs_remove_link(&udev->dev.kobj, "port");
2621 goto fail;
2622 }
2623
2624 pm_runtime_get_sync(&port_dev->dev);
2625 }
2626
2627 (void) usb_create_ep_devs(&udev->dev, &udev->ep0, udev);
2628 usb_mark_last_busy(udev);
2629 pm_runtime_put_sync_autosuspend(&udev->dev);
2630 return err;
2631
2632 fail:
2633 usb_set_device_state(udev, USB_STATE_NOTATTACHED);
2634 pm_runtime_disable(&udev->dev);
2635 pm_runtime_set_suspended(&udev->dev);
2636 return err;
2637 }
2638
2639
2640 /**
2641 * usb_deauthorize_device - deauthorize a device (usbcore-internal)
2642 * @usb_dev: USB device
2643 *
2644 * Move the USB device to a very basic state where interfaces are disabled
2645 * and the device is in fact unconfigured and unusable.
2646 *
2647 * We share a lock (that we have) with device_del(), so we need to
2648 * defer its call.
2649 */
2650 int usb_deauthorize_device(struct usb_device *usb_dev)
2651 {
2652 usb_lock_device(usb_dev);
2653 if (usb_dev->authorized == 0)
2654 goto out_unauthorized;
2655
2656 usb_dev->authorized = 0;
2657 usb_set_configuration(usb_dev, -1);
2658
2659 out_unauthorized:
2660 usb_unlock_device(usb_dev);
2661 return 0;
2662 }
2663
2664
2665 int usb_authorize_device(struct usb_device *usb_dev)
2666 {
2667 int result = 0, c;
2668
2669 usb_lock_device(usb_dev);
2670 if (usb_dev->authorized == 1)
2671 goto out_authorized;
2672
2673 result = usb_autoresume_device(usb_dev);
2674 if (result < 0) {
2675 dev_err(&usb_dev->dev,
2676 "can't autoresume for authorization: %d\n", result);
2677 goto error_autoresume;
2678 }
2679 result = usb_get_device_descriptor(usb_dev, sizeof(usb_dev->descriptor));
2680 if (result < 0) {
2681 dev_err(&usb_dev->dev, "can't re-read device descriptor for "
2682 "authorization: %d\n", result);
2683 goto error_device_descriptor;
2684 }
2685
2686 usb_dev->authorized = 1;
2687 /* Choose and set the configuration. This registers the interfaces
2688 * with the driver core and lets interface drivers bind to them.
2689 */
2690 c = usb_choose_configuration(usb_dev);
2691 if (c >= 0) {
2692 result = usb_set_configuration(usb_dev, c);
2693 if (result) {
2694 dev_err(&usb_dev->dev,
2695 "can't set config #%d, error %d\n", c, result);
2696 /* This need not be fatal. The user can try to
2697 * set other configurations. */
2698 }
2699 }
2700 dev_info(&usb_dev->dev, "authorized to connect\n");
2701
2702 error_device_descriptor:
2703 usb_autosuspend_device(usb_dev);
2704 error_autoresume:
2705 out_authorized:
2706 usb_unlock_device(usb_dev); // complements locktree
2707 return result;
2708 }
2709
2710
2711 /* Returns 1 if @hub is a WUSB root hub, 0 otherwise */
2712 static unsigned hub_is_wusb(struct usb_hub *hub)
2713 {
2714 struct usb_hcd *hcd;
2715 if (hub->hdev->parent != NULL) /* not a root hub? */
2716 return 0;
2717 hcd = container_of(hub->hdev->bus, struct usb_hcd, self);
2718 return hcd->wireless;
2719 }
2720
2721
2722 #define PORT_RESET_TRIES 5
2723 #define SET_ADDRESS_TRIES 2
2724 #define GET_DESCRIPTOR_TRIES 2
2725 #define SET_CONFIG_TRIES (2 * (use_both_schemes + 1))
2726 #define USE_NEW_SCHEME(i) ((i) / 2 == (int)old_scheme_first)
2727
2728 #define HUB_ROOT_RESET_TIME 50 /* times are in msec */
2729 #define HUB_SHORT_RESET_TIME 10
2730 #define HUB_BH_RESET_TIME 50
2731 #define HUB_LONG_RESET_TIME 200
2732 #define HUB_RESET_TIMEOUT 800
2733
2734 static int hub_port_reset(struct usb_hub *hub, int port1,
2735 struct usb_device *udev, unsigned int delay, bool warm);
2736
2737 /* Is a USB 3.0 port in the Inactive or Complinance Mode state?
2738 * Port worm reset is required to recover
2739 */
2740 static bool hub_port_warm_reset_required(struct usb_hub *hub, u16 portstatus)
2741 {
2742 return hub_is_superspeed(hub->hdev) &&
2743 (((portstatus & USB_PORT_STAT_LINK_STATE) ==
2744 USB_SS_PORT_LS_SS_INACTIVE) ||
2745 ((portstatus & USB_PORT_STAT_LINK_STATE) ==
2746 USB_SS_PORT_LS_COMP_MOD)) ;
2747 }
2748
2749 static int hub_port_wait_reset(struct usb_hub *hub, int port1,
2750 struct usb_device *udev, unsigned int delay, bool warm)
2751 {
2752 int delay_time, ret;
2753 u16 portstatus;
2754 u16 portchange;
2755
2756 for (delay_time = 0;
2757 delay_time < HUB_RESET_TIMEOUT;
2758 delay_time += delay) {
2759 /* wait to give the device a chance to reset */
2760 msleep(delay);
2761
2762 /* read and decode port status */
2763 MYDBG("");
2764 ret = hub_port_status(hub, port1, &portstatus, &portchange);
2765 MYDBG("");
2766 if (ret < 0)
2767 return ret;
2768
2769 /* The port state is unknown until the reset completes. */
2770 if (!(portstatus & USB_PORT_STAT_RESET))
2771 break;
2772
2773 /* switch to the long delay after two short delay failures */
2774 if (delay_time >= 2 * HUB_SHORT_RESET_TIME)
2775 delay = HUB_LONG_RESET_TIME;
2776
2777 dev_dbg (hub->intfdev,
2778 "port %d not %sreset yet, waiting %dms\n",
2779 port1, warm ? "warm " : "", delay);
2780 }
2781
2782 if ((portstatus & USB_PORT_STAT_RESET))
2783 return -EBUSY;
2784
2785 if (hub_port_warm_reset_required(hub, portstatus))
2786 return -ENOTCONN;
2787
2788 /* Device went away? */
2789 if (!(portstatus & USB_PORT_STAT_CONNECTION))
2790 return -ENOTCONN;
2791
2792 /* bomb out completely if the connection bounced. A USB 3.0
2793 * connection may bounce if multiple warm resets were issued,
2794 * but the device may have successfully re-connected. Ignore it.
2795 */
2796 if (!hub_is_superspeed(hub->hdev) &&
2797 (portchange & USB_PORT_STAT_C_CONNECTION))
2798 return -ENOTCONN;
2799
2800 if (!(portstatus & USB_PORT_STAT_ENABLE))
2801 return -EBUSY;
2802
2803 if (!udev)
2804 return 0;
2805
2806 if (hub_is_wusb(hub))
2807 udev->speed = USB_SPEED_WIRELESS;
2808 else if (hub_is_superspeed(hub->hdev))
2809 udev->speed = USB_SPEED_SUPER;
2810 else if (portstatus & USB_PORT_STAT_HIGH_SPEED)
2811 udev->speed = USB_SPEED_HIGH;
2812 else if (portstatus & USB_PORT_STAT_LOW_SPEED)
2813 udev->speed = USB_SPEED_LOW;
2814 else
2815 udev->speed = USB_SPEED_FULL;
2816 return 0;
2817 }
2818
2819 static void hub_port_finish_reset(struct usb_hub *hub, int port1,
2820 struct usb_device *udev, int *status)
2821 {
2822 switch (*status) {
2823 case 0:
2824 /* TRSTRCY = 10 ms; plus some extra */
2825 msleep(10 + 40);
2826 if (udev) {
2827 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
2828
2829 update_devnum(udev, 0);
2830 /* The xHC may think the device is already reset,
2831 * so ignore the status.
2832 */
2833 if (hcd->driver->reset_device)
2834 hcd->driver->reset_device(hcd, udev);
2835 }
2836 /* FALL THROUGH */
2837 case -ENOTCONN:
2838 case -ENODEV:
2839 usb_clear_port_feature(hub->hdev,
2840 port1, USB_PORT_FEAT_C_RESET);
2841 if (hub_is_superspeed(hub->hdev)) {
2842 usb_clear_port_feature(hub->hdev, port1,
2843 USB_PORT_FEAT_C_BH_PORT_RESET);
2844 usb_clear_port_feature(hub->hdev, port1,
2845 USB_PORT_FEAT_C_PORT_LINK_STATE);
2846 usb_clear_port_feature(hub->hdev, port1,
2847 USB_PORT_FEAT_C_CONNECTION);
2848 }
2849 if (udev)
2850 usb_set_device_state(udev, *status
2851 ? USB_STATE_NOTATTACHED
2852 : USB_STATE_DEFAULT);
2853 break;
2854 }
2855 }
2856
2857 /* Handle port reset and port warm(BH) reset (for USB3 protocol ports) */
2858 static int hub_port_reset(struct usb_hub *hub, int port1,
2859 struct usb_device *udev, unsigned int delay, bool warm)
2860 {
2861 int i, status;
2862 u16 portchange, portstatus;
2863
2864 if (!hub_is_superspeed(hub->hdev)) {
2865 if (warm) {
2866 dev_err(hub->intfdev, "only USB3 hub support "
2867 "warm reset\n");
2868 return -EINVAL;
2869 }
2870 /* Block EHCI CF initialization during the port reset.
2871 * Some companion controllers don't like it when they mix.
2872 */
2873 down_read(&ehci_cf_port_reset_rwsem);
2874 } else if (!warm) {
2875 /*
2876 * If the caller hasn't explicitly requested a warm reset,
2877 * double check and see if one is needed.
2878 */
2879 status = hub_port_status(hub, port1,
2880 &portstatus, &portchange);
2881 if (status < 0)
2882 goto done;
2883
2884 if (hub_port_warm_reset_required(hub, portstatus))
2885 warm = true;
2886 }
2887
2888 /* Reset the port */
2889 for (i = 0; i < PORT_RESET_TRIES; i++) {
2890 MYDBG("");
2891 status = set_port_feature(hub->hdev, port1, (warm ?
2892 USB_PORT_FEAT_BH_PORT_RESET :
2893 USB_PORT_FEAT_RESET));
2894 MYDBG("");
2895 if (status == -ENODEV) {
2896 MYDBG("");
2897 ; /* The hub is gone */
2898 } else if (status) {
2899 MYDBG("");
2900 dev_err(hub->intfdev,
2901 "cannot %sreset port %d (err = %d)\n",
2902 warm ? "warm " : "", port1, status);
2903 } else {
2904 MYDBG("");
2905 status = hub_port_wait_reset(hub, port1, udev, delay,
2906 warm);
2907 if (status && status != -ENOTCONN)
2908 {
2909 MYDBG("");
2910 dev_dbg(hub->intfdev,
2911 "port_wait_reset: err = %d\n",
2912 status);
2913 }
2914 }
2915
2916 MYDBG("");
2917 /* Check for disconnect or reset */
2918 if (status == 0 || status == -ENOTCONN || status == -ENODEV) {
2919 MYDBG("");
2920 hub_port_finish_reset(hub, port1, udev, &status);
2921 MYDBG("");
2922
2923 if (!hub_is_superspeed(hub->hdev))
2924 goto done;
2925
2926 /*
2927 * If a USB 3.0 device migrates from reset to an error
2928 * state, re-issue the warm reset.
2929 */
2930 if (hub_port_status(hub, port1,
2931 &portstatus, &portchange) < 0)
2932 goto done;
2933
2934 if (!hub_port_warm_reset_required(hub, portstatus))
2935 goto done;
2936
2937 /*
2938 * If the port is in SS.Inactive or Compliance Mode, the
2939 * hot or warm reset failed. Try another warm reset.
2940 */
2941 if (!warm) {
2942 dev_dbg(hub->intfdev, "hot reset failed, warm reset port %d\n",
2943 port1);
2944 warm = true;
2945 }
2946 }
2947 MYDBG("");
2948
2949 dev_dbg (hub->intfdev,
2950 "port %d not enabled, trying %sreset again...\n",
2951 port1, warm ? "warm " : "");
2952 delay = HUB_LONG_RESET_TIME;
2953 }
2954 MYDBG("");
2955
2956
2957 dev_err (hub->intfdev,
2958 "Cannot enable port %i. Maybe the USB cable is bad?\n",
2959 port1);
2960
2961 done:
2962 if (!hub_is_superspeed(hub->hdev))
2963 {
2964 MYDBG("");
2965 up_read(&ehci_cf_port_reset_rwsem);
2966 }
2967
2968 MYDBG("");
2969
2970 return status;
2971 }
2972
2973 /* Check if a port is power on */
2974 static int port_is_power_on(struct usb_hub *hub, unsigned portstatus)
2975 {
2976 int ret = 0;
2977
2978 if (hub_is_superspeed(hub->hdev)) {
2979 if (portstatus & USB_SS_PORT_STAT_POWER)
2980 ret = 1;
2981 } else {
2982 if (portstatus & USB_PORT_STAT_POWER)
2983 ret = 1;
2984 }
2985
2986 return ret;
2987 }
2988
2989 #ifdef CONFIG_PM
2990
2991 /* Check if a port is suspended(USB2.0 port) or in U3 state(USB3.0 port) */
2992 static int port_is_suspended(struct usb_hub *hub, unsigned portstatus)
2993 {
2994 int ret = 0;
2995
2996 if (hub_is_superspeed(hub->hdev)) {
2997 if ((portstatus & USB_PORT_STAT_LINK_STATE)
2998 == USB_SS_PORT_LS_U3)
2999 ret = 1;
3000 } else {
3001 if (portstatus & USB_PORT_STAT_SUSPEND)
3002 ret = 1;
3003 }
3004
3005 return ret;
3006 }
3007
3008 /* Determine whether the device on a port is ready for a normal resume,
3009 * is ready for a reset-resume, or should be disconnected.
3010 */
3011 static int check_port_resume_type(struct usb_device *udev,
3012 struct usb_hub *hub, int port1,
3013 int status, unsigned portchange, unsigned portstatus)
3014 {
3015 /* Is the device still present? */
3016 if (status || port_is_suspended(hub, portstatus) ||
3017 !port_is_power_on(hub, portstatus) ||
3018 !(portstatus & USB_PORT_STAT_CONNECTION)) {
3019 if (status >= 0)
3020 status = -ENODEV;
3021 }
3022
3023 /* Can't do a normal resume if the port isn't enabled,
3024 * so try a reset-resume instead.
3025 */
3026 else if (!(portstatus & USB_PORT_STAT_ENABLE) && !udev->reset_resume) {
3027 if (udev->persist_enabled)
3028 udev->reset_resume = 1;
3029 else
3030 status = -ENODEV;
3031 }
3032
3033 if (status) {
3034 dev_dbg(hub->intfdev,
3035 "port %d status %04x.%04x after resume, %d\n",
3036 port1, portchange, portstatus, status);
3037 } else if (udev->reset_resume) {
3038
3039 /* Late port handoff can set status-change bits */
3040 if (portchange & USB_PORT_STAT_C_CONNECTION)
3041 usb_clear_port_feature(hub->hdev, port1,
3042 USB_PORT_FEAT_C_CONNECTION);
3043 if (portchange & USB_PORT_STAT_C_ENABLE)
3044 usb_clear_port_feature(hub->hdev, port1,
3045 USB_PORT_FEAT_C_ENABLE);
3046 }
3047
3048 return status;
3049 }
3050
3051 int usb_disable_ltm(struct usb_device *udev)
3052 {
3053 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3054
3055 /* Check if the roothub and device supports LTM. */
3056 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3057 !usb_device_supports_ltm(udev))
3058 return 0;
3059
3060 /* Clear Feature LTM Enable can only be sent if the device is
3061 * configured.
3062 */
3063 if (!udev->actconfig)
3064 return 0;
3065
3066 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3067 USB_REQ_CLEAR_FEATURE, USB_RECIP_DEVICE,
3068 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3069 USB_CTRL_SET_TIMEOUT);
3070 }
3071 EXPORT_SYMBOL_GPL(usb_disable_ltm);
3072
3073 void usb_enable_ltm(struct usb_device *udev)
3074 {
3075 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
3076
3077 /* Check if the roothub and device supports LTM. */
3078 if (!usb_device_supports_ltm(hcd->self.root_hub) ||
3079 !usb_device_supports_ltm(udev))
3080 return;
3081
3082 /* Set Feature LTM Enable can only be sent if the device is
3083 * configured.
3084 */
3085 if (!udev->actconfig)
3086 return;
3087
3088 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3089 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3090 USB_DEVICE_LTM_ENABLE, 0, NULL, 0,
3091 USB_CTRL_SET_TIMEOUT);
3092 }
3093 EXPORT_SYMBOL_GPL(usb_enable_ltm);
3094
3095 #ifdef CONFIG_PM
3096 /*
3097 * usb_disable_function_remotewakeup - disable usb3.0
3098 * device's function remote wakeup
3099 * @udev: target device
3100 *
3101 * Assume there's only one function on the USB 3.0
3102 * device and disable remote wake for the first
3103 * interface. FIXME if the interface association
3104 * descriptor shows there's more than one function.
3105 */
3106 static int usb_disable_function_remotewakeup(struct usb_device *udev)
3107 {
3108 return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3109 USB_REQ_CLEAR_FEATURE, USB_RECIP_INTERFACE,
3110 USB_INTRF_FUNC_SUSPEND, 0, NULL, 0,
3111 USB_CTRL_SET_TIMEOUT);
3112 }
3113
3114 /* Count of wakeup-enabled devices at or below udev */
3115 static unsigned wakeup_enabled_descendants(struct usb_device *udev)
3116 {
3117 struct usb_hub *hub = usb_hub_to_struct_hub(udev);
3118
3119 return udev->do_remote_wakeup +
3120 (hub ? hub->wakeup_enabled_descendants : 0);
3121 }
3122
3123 /*
3124 * usb_port_suspend - suspend a usb device's upstream port
3125 * @udev: device that's no longer in active use, not a root hub
3126 * Context: must be able to sleep; device not locked; pm locks held
3127 *
3128 * Suspends a USB device that isn't in active use, conserving power.
3129 * Devices may wake out of a suspend, if anything important happens,
3130 * using the remote wakeup mechanism. They may also be taken out of
3131 * suspend by the host, using usb_port_resume(). It's also routine
3132 * to disconnect devices while they are suspended.
3133 *
3134 * This only affects the USB hardware for a device; its interfaces
3135 * (and, for hubs, child devices) must already have been suspended.
3136 *
3137 * Selective port suspend reduces power; most suspended devices draw
3138 * less than 500 uA. It's also used in OTG, along with remote wakeup.
3139 * All devices below the suspended port are also suspended.
3140 *
3141 * Devices leave suspend state when the host wakes them up. Some devices
3142 * also support "remote wakeup", where the device can activate the USB
3143 * tree above them to deliver data, such as a keypress or packet. In
3144 * some cases, this wakes the USB host.
3145 *
3146 * Suspending OTG devices may trigger HNP, if that's been enabled
3147 * between a pair of dual-role devices. That will change roles, such
3148 * as from A-Host to A-Peripheral or from B-Host back to B-Peripheral.
3149 *
3150 * Devices on USB hub ports have only one "suspend" state, corresponding
3151 * to ACPI D2, "may cause the device to lose some context".
3152 * State transitions include:
3153 *
3154 * - suspend, resume ... when the VBUS power link stays live
3155 * - suspend, disconnect ... VBUS lost
3156 *
3157 * Once VBUS drop breaks the circuit, the port it's using has to go through
3158 * normal re-enumeration procedures, starting with enabling VBUS power.
3159 * Other than re-initializing the hub (plug/unplug, except for root hubs),
3160 * Linux (2.6) currently has NO mechanisms to initiate that: no khubd
3161 * timer, no SRP, no requests through sysfs.
3162 *
3163 * If Runtime PM isn't enabled or used, non-SuperSpeed devices may not get
3164 * suspended until their bus goes into global suspend (i.e., the root
3165 * hub is suspended). Nevertheless, we change @udev->state to
3166 * USB_STATE_SUSPENDED as this is the device's "logical" state. The actual
3167 * upstream port setting is stored in @udev->port_is_suspended.
3168 *
3169 * Returns 0 on success, else negative errno.
3170 */
3171 int usb_port_suspend(struct usb_device *udev, pm_message_t msg)
3172 {
3173 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3174 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3175 int port1 = udev->portnum;
3176 int status;
3177 bool really_suspend = true;
3178
3179 /* enable remote wakeup when appropriate; this lets the device
3180 * wake up the upstream hub (including maybe the root hub).
3181 *
3182 * NOTE: OTG devices may issue remote wakeup (or SRP) even when
3183 * we don't explicitly enable it here.
3184 */
3185 if (udev->do_remote_wakeup) {
3186 if (!hub_is_superspeed(hub->hdev)) {
3187 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3188 USB_REQ_SET_FEATURE, USB_RECIP_DEVICE,
3189 USB_DEVICE_REMOTE_WAKEUP, 0,
3190 NULL, 0,
3191 USB_CTRL_SET_TIMEOUT);
3192 } else {
3193 /* Assume there's only one function on the USB 3.0
3194 * device and enable remote wake for the first
3195 * interface. FIXME if the interface association
3196 * descriptor shows there's more than one function.
3197 */
3198 status = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3199 USB_REQ_SET_FEATURE,
3200 USB_RECIP_INTERFACE,
3201 USB_INTRF_FUNC_SUSPEND,
3202 USB_INTRF_FUNC_SUSPEND_RW |
3203 USB_INTRF_FUNC_SUSPEND_LP,
3204 NULL, 0,
3205 USB_CTRL_SET_TIMEOUT);
3206 }
3207 if (status) {
3208 dev_dbg(&udev->dev, "won't remote wakeup, status %d\n",
3209 status);
3210 /* bail if autosuspend is requested */
3211 if (PMSG_IS_AUTO(msg))
3212 {
3213 MYDBG("");
3214 goto err_wakeup;
3215 }
3216 }
3217 }
3218
3219 /* disable USB2 hardware LPM */
3220 if (udev->usb2_hw_lpm_enabled == 1)
3221 usb_set_usb2_hardware_lpm(udev, 0);
3222
3223 if (usb_disable_ltm(udev)) {
3224 dev_err(&udev->dev, "Failed to disable LTM before suspend\n.");
3225 status = -ENOMEM;
3226 MYDBG("");
3227 if (PMSG_IS_AUTO(msg))
3228 goto err_ltm;
3229 }
3230 if (usb_unlocked_disable_lpm(udev)) {
3231 dev_err(&udev->dev, "Failed to disable LPM before suspend\n.");
3232 status = -ENOMEM;
3233 MYDBG("");
3234 if (PMSG_IS_AUTO(msg))
3235 goto err_lpm3;
3236 }
3237
3238 /* see 7.1.7.6 */
3239 if (hub_is_superspeed(hub->hdev))
3240 {
3241 MYDBG("");
3242 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U3);
3243
3244 #if 0 /* behavior for kernel 3.10 */
3245 /*
3246 * For system suspend, we do not need to enable the suspend feature
3247 * on individual USB-2 ports. The devices will automatically go
3248 * into suspend a few ms after the root hub stops sending packets.
3249 * The USB 2.0 spec calls this "global suspend".
3250 *
3251 * However, many USB hubs have a bug: They don't relay wakeup requests
3252 * from a downstream port if the port's suspend feature isn't on.
3253 * Therefore we will turn on the suspend feature if udev or any of its
3254 * descendants is enabled for remote wakeup.
3255 */
3256 } else if (PMSG_IS_AUTO(msg) || wakeup_enabled_descendants(udev) > 0) {
3257 MYDBG("");
3258 status = set_port_feature(hub->hdev, port1,
3259 USB_PORT_FEAT_SUSPEND);
3260 } else {
3261 really_suspend = false;
3262 status = 0;
3263 }
3264 #else /*roll back behavior to kernel 3.4 */
3265 }else{
3266 MYDBG("");
3267 status = set_port_feature(hub->hdev, port1,
3268 USB_PORT_FEAT_SUSPEND);
3269 }
3270 #endif
3271
3272 if (status) {
3273 dev_dbg(hub->intfdev, "can't suspend port %d, status %d\n",
3274 port1, status);
3275 MYDBG("");
3276
3277 /* Try to enable USB3 LPM and LTM again */
3278 usb_unlocked_enable_lpm(udev);
3279 err_lpm3:
3280 usb_enable_ltm(udev);
3281 err_ltm:
3282 /* Try to enable USB2 hardware LPM again */
3283 if (udev->usb2_hw_lpm_capable == 1)
3284 usb_set_usb2_hardware_lpm(udev, 1);
3285
3286 if (udev->do_remote_wakeup) {
3287 if (udev->speed < USB_SPEED_SUPER)
3288 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3289 USB_REQ_CLEAR_FEATURE,
3290 USB_RECIP_DEVICE,
3291 USB_DEVICE_REMOTE_WAKEUP, 0,
3292 NULL, 0, USB_CTRL_SET_TIMEOUT);
3293 else
3294 usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3295 USB_REQ_CLEAR_FEATURE,
3296 USB_RECIP_INTERFACE,
3297 USB_INTRF_FUNC_SUSPEND, 0,
3298 NULL, 0, USB_CTRL_SET_TIMEOUT);
3299 }
3300 err_wakeup:
3301
3302 /* System sleep transitions should never fail */
3303 if (!PMSG_IS_AUTO(msg))
3304 status = 0;
3305 } else {
3306 dev_dbg(&udev->dev, "usb %ssuspend, wakeup %d\n",
3307 (PMSG_IS_AUTO(msg) ? "auto-" : ""),
3308 udev->do_remote_wakeup);
3309 if (really_suspend) {
3310 udev->port_is_suspended = 1;
3311
3312 /* device has up to 10 msec to fully suspend */
3313 msleep(10);
3314 }
3315 usb_set_device_state(udev, USB_STATE_SUSPENDED);
3316 }
3317
3318 if (status == 0 && !udev->do_remote_wakeup && udev->persist_enabled) {
3319 pm_runtime_put_sync(&port_dev->dev);
3320 port_dev->did_runtime_put = true;
3321 }
3322
3323 usb_mark_last_busy(hub->hdev);
3324 return status;
3325 }
3326
3327 /*
3328 * If the USB "suspend" state is in use (rather than "global suspend"),
3329 * many devices will be individually taken out of suspend state using
3330 * special "resume" signaling. This routine kicks in shortly after
3331 * hardware resume signaling is finished, either because of selective
3332 * resume (by host) or remote wakeup (by device) ... now see what changed
3333 * in the tree that's rooted at this device.
3334 *
3335 * If @udev->reset_resume is set then the device is reset before the
3336 * status check is done.
3337 */
3338 static int finish_port_resume(struct usb_device *udev)
3339 {
3340 int status = 0;
3341 u16 devstatus = 0;
3342
3343 /* caller owns the udev device lock */
3344 dev_dbg(&udev->dev, "%s\n",
3345 udev->reset_resume ? "finish reset-resume" : "finish resume");
3346
3347 /* usb ch9 identifies four variants of SUSPENDED, based on what
3348 * state the device resumes to. Linux currently won't see the
3349 * first two on the host side; they'd be inside hub_port_init()
3350 * during many timeouts, but khubd can't suspend until later.
3351 */
3352 usb_set_device_state(udev, udev->actconfig
3353 ? USB_STATE_CONFIGURED
3354 : USB_STATE_ADDRESS);
3355
3356 /* 10.5.4.5 says not to reset a suspended port if the attached
3357 * device is enabled for remote wakeup. Hence the reset
3358 * operation is carried out here, after the port has been
3359 * resumed.
3360 */
3361 if (udev->reset_resume)
3362 retry_reset_resume:
3363 status = usb_reset_and_verify_device(udev);
3364
3365 /* 10.5.4.5 says be sure devices in the tree are still there.
3366 * For now let's assume the device didn't go crazy on resume,
3367 * and device drivers will know about any resume quirks.
3368 */
3369 if (status == 0) {
3370 devstatus = 0;
3371 MYDBG("\n");
3372 status = usb_get_status(udev, USB_RECIP_DEVICE, 0, &devstatus);
3373 MYDBG("%d\n", status);
3374 if (status >= 0)
3375 status = (status > 0 ? 0 : -ENODEV);
3376
3377 /* If a normal resume failed, try doing a reset-resume */
3378 if (status && !udev->reset_resume && udev->persist_enabled) {
3379 dev_dbg(&udev->dev, "retry with reset-resume\n");
3380 udev->reset_resume = 1;
3381 goto retry_reset_resume;
3382 }
3383 }
3384
3385 if (status) {
3386 dev_dbg(&udev->dev, "gone after usb resume? status %d\n",
3387 status);
3388 /*
3389 * There are a few quirky devices which violate the standard
3390 * by claiming to have remote wakeup enabled after a reset,
3391 * which crash if the feature is cleared, hence check for
3392 * udev->reset_resume
3393 */
3394 } else if (udev->actconfig && !udev->reset_resume) {
3395 if (!hub_is_superspeed(udev->parent)) {
3396 le16_to_cpus(&devstatus);
3397 if (devstatus & (1 << USB_DEVICE_REMOTE_WAKEUP))
3398 status = usb_control_msg(udev,
3399 usb_sndctrlpipe(udev, 0),
3400 USB_REQ_CLEAR_FEATURE,
3401 USB_RECIP_DEVICE,
3402 USB_DEVICE_REMOTE_WAKEUP, 0,
3403 NULL, 0,
3404 USB_CTRL_SET_TIMEOUT);
3405 } else {
3406 status = usb_get_status(udev, USB_RECIP_INTERFACE, 0,
3407 &devstatus);
3408 le16_to_cpus(&devstatus);
3409 if (!status && devstatus & (USB_INTRF_STAT_FUNC_RW_CAP
3410 | USB_INTRF_STAT_FUNC_RW))
3411 status =
3412 usb_disable_function_remotewakeup(udev);
3413 }
3414
3415 if (status)
3416 dev_dbg(&udev->dev,
3417 "disable remote wakeup, status %d\n",
3418 status);
3419 status = 0;
3420 }
3421 return status;
3422 }
3423
3424 /*
3425 * There are some SS USB devices which take longer time for link training.
3426 * XHCI specs 4.19.4 says that when Link training is successful, port
3427 * sets CSC bit to 1. So if SW reads port status before successful link
3428 * training, then it will not find device to be present.
3429 * USB Analyzer log with such buggy devices show that in some cases
3430 * device switch on the RX termination after long delay of host enabling
3431 * the VBUS. In few other cases it has been seen that device fails to
3432 * negotiate link training in first attempt. It has been
3433 * reported till now that few devices take as long as 2000 ms to train
3434 * the link after host enabling its VBUS and termination. Following
3435 * routine implements a 2000 ms timeout for link training. If in a case
3436 * link trains before timeout, loop will exit earlier.
3437 *
3438 * FIXME: If a device was connected before suspend, but was removed
3439 * while system was asleep, then the loop in the following routine will
3440 * only exit at timeout.
3441 *
3442 * This routine should only be called when persist is enabled for a SS
3443 * device.
3444 */
3445 static int wait_for_ss_port_enable(struct usb_device *udev,
3446 struct usb_hub *hub, int *port1,
3447 u16 *portchange, u16 *portstatus)
3448 {
3449 int status = 0, delay_ms = 0;
3450
3451 while (delay_ms < 2000) {
3452 if (status || *portstatus & USB_PORT_STAT_CONNECTION)
3453 break;
3454 msleep(20);
3455 delay_ms += 20;
3456 status = hub_port_status(hub, *port1, portstatus, portchange);
3457 }
3458 return status;
3459 }
3460
3461 /*
3462 * usb_port_resume - re-activate a suspended usb device's upstream port
3463 * @udev: device to re-activate, not a root hub
3464 * Context: must be able to sleep; device not locked; pm locks held
3465 *
3466 * This will re-activate the suspended device, increasing power usage
3467 * while letting drivers communicate again with its endpoints.
3468 * USB resume explicitly guarantees that the power session between
3469 * the host and the device is the same as it was when the device
3470 * suspended.
3471 *
3472 * If @udev->reset_resume is set then this routine won't check that the
3473 * port is still enabled. Furthermore, finish_port_resume() above will
3474 * reset @udev. The end result is that a broken power session can be
3475 * recovered and @udev will appear to persist across a loss of VBUS power.
3476 *
3477 * For example, if a host controller doesn't maintain VBUS suspend current
3478 * during a system sleep or is reset when the system wakes up, all the USB
3479 * power sessions below it will be broken. This is especially troublesome
3480 * for mass-storage devices containing mounted filesystems, since the
3481 * device will appear to have disconnected and all the memory mappings
3482 * to it will be lost. Using the USB_PERSIST facility, the device can be
3483 * made to appear as if it had not disconnected.
3484 *
3485 * This facility can be dangerous. Although usb_reset_and_verify_device() makes
3486 * every effort to insure that the same device is present after the
3487 * reset as before, it cannot provide a 100% guarantee. Furthermore it's
3488 * quite possible for a device to remain unaltered but its media to be
3489 * changed. If the user replaces a flash memory card while the system is
3490 * asleep, he will have only himself to blame when the filesystem on the
3491 * new card is corrupted and the system crashes.
3492 *
3493 * Returns 0 on success, else negative errno.
3494 */
3495 int usb_port_resume(struct usb_device *udev, pm_message_t msg)
3496 {
3497 struct usb_hub *hub = usb_hub_to_struct_hub(udev->parent);
3498 struct usb_port *port_dev = hub->ports[udev->portnum - 1];
3499 int port1 = udev->portnum;
3500 int status;
3501 u16 portchange, portstatus;
3502
3503 if (port_dev->did_runtime_put) {
3504 status = pm_runtime_get_sync(&port_dev->dev);
3505 port_dev->did_runtime_put = false;
3506 if (status < 0) {
3507 dev_dbg(&udev->dev, "can't resume usb port, status %d\n",
3508 status);
3509 return status;
3510 }
3511 }
3512
3513 /* Skip the initial Clear-Suspend step for a remote wakeup */
3514 status = hub_port_status(hub, port1, &portstatus, &portchange);
3515 if (status == 0 && !port_is_suspended(hub, portstatus))
3516 goto SuspendCleared;
3517
3518 // dev_dbg(hub->intfdev, "resume port %d\n", port1);
3519
3520 set_bit(port1, hub->busy_bits);
3521
3522 /* see 7.1.7.7; affects power usage, but not budgeting */
3523 if (hub_is_superspeed(hub->hdev))
3524 status = hub_set_port_link_state(hub, port1, USB_SS_PORT_LS_U0);
3525 else
3526 status = usb_clear_port_feature(hub->hdev,
3527 port1, USB_PORT_FEAT_SUSPEND);
3528 if (status) {
3529 dev_dbg(hub->intfdev, "can't resume port %d, status %d\n",
3530 port1, status);
3531 } else {
3532 /* drive resume for at least 20 msec */
3533 dev_dbg(&udev->dev, "usb %sresume\n",
3534 (PMSG_IS_AUTO(msg) ? "auto-" : ""));
3535 msleep(25);
3536
3537 /* Virtual root hubs can trigger on GET_PORT_STATUS to
3538 * stop resume signaling. Then finish the resume
3539 * sequence.
3540 */
3541 status = hub_port_status(hub, port1, &portstatus, &portchange);
3542
3543 /* TRSMRCY = 10 msec */
3544 msleep(10);
3545 }
3546
3547 SuspendCleared:
3548 if (status == 0) {
3549 udev->port_is_suspended = 0;
3550 if (hub_is_superspeed(hub->hdev)) {
3551 if (portchange & USB_PORT_STAT_C_LINK_STATE)
3552 usb_clear_port_feature(hub->hdev, port1,
3553 USB_PORT_FEAT_C_PORT_LINK_STATE);
3554 } else {
3555 if (portchange & USB_PORT_STAT_C_SUSPEND)
3556 usb_clear_port_feature(hub->hdev, port1,
3557 USB_PORT_FEAT_C_SUSPEND);
3558 }
3559 }
3560
3561 clear_bit(port1, hub->busy_bits);
3562
3563 if (udev->persist_enabled && hub_is_superspeed(hub->hdev))
3564 status = wait_for_ss_port_enable(udev, hub, &port1, &portchange,
3565 &portstatus);
3566
3567 status = check_port_resume_type(udev,
3568 hub, port1, status, portchange, portstatus);
3569 if (status == 0)
3570 status = finish_port_resume(udev);
3571 if (status < 0) {
3572 dev_dbg(&udev->dev, "can't resume, status %d\n", status);
3573 hub_port_logical_disconnect(hub, port1);
3574 } else {
3575 /* Try to enable USB2 hardware LPM */
3576 if (udev->usb2_hw_lpm_capable == 1)
3577 usb_set_usb2_hardware_lpm(udev, 1);
3578
3579 /* Try to enable USB3 LTM and LPM */
3580 usb_enable_ltm(udev);
3581 usb_unlocked_enable_lpm(udev);
3582 }
3583
3584 return status;
3585 }
3586
3587 #endif /* CONFIG_PM */
3588
3589 #ifdef CONFIG_PM_RUNTIME
3590
3591 /* caller has locked udev */
3592 int usb_remote_wakeup(struct usb_device *udev)
3593 {
3594 int status = 0;
3595
3596 if (udev->state == USB_STATE_SUSPENDED) {
3597 dev_dbg(&udev->dev, "usb %sresume\n", "wakeup-");
3598 status = usb_autoresume_device(udev);
3599 if (status == 0) {
3600 /* Let the drivers do their thing, then... */
3601 usb_autosuspend_device(udev);
3602 }
3603 }
3604 return status;
3605 }
3606
3607 #endif
3608
3609 static int check_ports_changed(struct usb_hub *hub)
3610 {
3611 int port1;
3612
3613 for (port1 = 1; port1 <= hub->hdev->maxchild; ++port1) {
3614 u16 portstatus, portchange;
3615 int status;
3616
3617 status = hub_port_status(hub, port1, &portstatus, &portchange);
3618 if (!status && portchange)
3619 return 1;
3620 }
3621 return 0;
3622 }
3623
3624 static int hub_suspend(struct usb_interface *intf, pm_message_t msg)
3625 {
3626 struct usb_hub *hub = usb_get_intfdata (intf);
3627 struct usb_device *hdev = hub->hdev;
3628 unsigned port1;
3629 int status;
3630
3631 /*
3632 * Warn if children aren't already suspended.
3633 * Also, add up the number of wakeup-enabled descendants.
3634 */
3635 hub->wakeup_enabled_descendants = 0;
3636 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3637 struct usb_device *udev;
3638
3639 udev = hub->ports[port1 - 1]->child;
3640 if (udev && udev->can_submit) {
3641 dev_warn(&intf->dev, "port %d nyet suspended\n", port1);
3642 if (PMSG_IS_AUTO(msg))
3643 return -EBUSY;
3644 }
3645 if (udev)
3646 hub->wakeup_enabled_descendants +=
3647 wakeup_enabled_descendants(udev);
3648 }
3649
3650 if (hdev->do_remote_wakeup && hub->quirk_check_port_auto_suspend) {
3651 /* check if there are changes pending on hub ports */
3652 if (check_ports_changed(hub)) {
3653 if (PMSG_IS_AUTO(msg))
3654 return -EBUSY;
3655 pm_wakeup_event(&hdev->dev, 2000);
3656 }
3657 }
3658
3659 if (hub_is_superspeed(hdev) && hdev->do_remote_wakeup) {
3660 /* Enable hub to send remote wakeup for all ports. */
3661 for (port1 = 1; port1 <= hdev->maxchild; port1++) {
3662 status = set_port_feature(hdev,
3663 port1 |
3664 USB_PORT_FEAT_REMOTE_WAKE_CONNECT |
3665 USB_PORT_FEAT_REMOTE_WAKE_DISCONNECT |
3666 USB_PORT_FEAT_REMOTE_WAKE_OVER_CURRENT,
3667 USB_PORT_FEAT_REMOTE_WAKE_MASK);
3668 }
3669 }
3670
3671 dev_dbg(&intf->dev, "%s\n", __func__);
3672
3673 /* stop khubd and related activity */
3674 hub_quiesce(hub, HUB_SUSPEND);
3675 return 0;
3676 }
3677
3678 static int hub_resume(struct usb_interface *intf)
3679 {
3680 struct usb_hub *hub = usb_get_intfdata(intf);
3681
3682 dev_dbg(&intf->dev, "%s\n", __func__);
3683 hub_activate(hub, HUB_RESUME);
3684 return 0;
3685 }
3686
3687 static int hub_reset_resume(struct usb_interface *intf)
3688 {
3689 struct usb_hub *hub = usb_get_intfdata(intf);
3690
3691 dev_dbg(&intf->dev, "%s\n", __func__);
3692 hub_activate(hub, HUB_RESET_RESUME);
3693 return 0;
3694 }
3695
3696 /**
3697 * usb_root_hub_lost_power - called by HCD if the root hub lost Vbus power
3698 * @rhdev: struct usb_device for the root hub
3699 *
3700 * The USB host controller driver calls this function when its root hub
3701 * is resumed and Vbus power has been interrupted or the controller
3702 * has been reset. The routine marks @rhdev as having lost power.
3703 * When the hub driver is resumed it will take notice and carry out
3704 * power-session recovery for all the "USB-PERSIST"-enabled child devices;
3705 * the others will be disconnected.
3706 */
3707 void usb_root_hub_lost_power(struct usb_device *rhdev)
3708 {
3709 dev_warn(&rhdev->dev, "root hub lost power or was reset\n");
3710 rhdev->reset_resume = 1;
3711 }
3712 EXPORT_SYMBOL_GPL(usb_root_hub_lost_power);
3713
3714 static const char * const usb3_lpm_names[] = {
3715 "U0",
3716 "U1",
3717 "U2",
3718 "U3",
3719 };
3720
3721 /*
3722 * Send a Set SEL control transfer to the device, prior to enabling
3723 * device-initiated U1 or U2. This lets the device know the exit latencies from
3724 * the time the device initiates a U1 or U2 exit, to the time it will receive a
3725 * packet from the host.
3726 *
3727 * This function will fail if the SEL or PEL values for udev are greater than
3728 * the maximum allowed values for the link state to be enabled.
3729 */
3730 static int usb_req_set_sel(struct usb_device *udev, enum usb3_link_state state)
3731 {
3732 struct usb_set_sel_req *sel_values;
3733 unsigned long long u1_sel;
3734 unsigned long long u1_pel;
3735 unsigned long long u2_sel;
3736 unsigned long long u2_pel;
3737 int ret;
3738
3739 /* Convert SEL and PEL stored in ns to us */
3740 u1_sel = DIV_ROUND_UP(udev->u1_params.sel, 1000);
3741 u1_pel = DIV_ROUND_UP(udev->u1_params.pel, 1000);
3742 u2_sel = DIV_ROUND_UP(udev->u2_params.sel, 1000);
3743 u2_pel = DIV_ROUND_UP(udev->u2_params.pel, 1000);
3744
3745 /*
3746 * Make sure that the calculated SEL and PEL values for the link
3747 * state we're enabling aren't bigger than the max SEL/PEL
3748 * value that will fit in the SET SEL control transfer.
3749 * Otherwise the device would get an incorrect idea of the exit
3750 * latency for the link state, and could start a device-initiated
3751 * U1/U2 when the exit latencies are too high.
3752 */
3753 if ((state == USB3_LPM_U1 &&
3754 (u1_sel > USB3_LPM_MAX_U1_SEL_PEL ||
3755 u1_pel > USB3_LPM_MAX_U1_SEL_PEL)) ||
3756 (state == USB3_LPM_U2 &&
3757 (u2_sel > USB3_LPM_MAX_U2_SEL_PEL ||
3758 u2_pel > USB3_LPM_MAX_U2_SEL_PEL))) {
3759 dev_dbg(&udev->dev, "Device-initiated %s disabled due to long SEL %llu us or PEL %llu us\n",
3760 usb3_lpm_names[state], u1_sel, u1_pel);
3761 return -EINVAL;
3762 }
3763
3764 /*
3765 * If we're enabling device-initiated LPM for one link state,
3766 * but the other link state has a too high SEL or PEL value,
3767 * just set those values to the max in the Set SEL request.
3768 */
3769 if (u1_sel > USB3_LPM_MAX_U1_SEL_PEL)
3770 u1_sel = USB3_LPM_MAX_U1_SEL_PEL;
3771
3772 if (u1_pel > USB3_LPM_MAX_U1_SEL_PEL)
3773 u1_pel = USB3_LPM_MAX_U1_SEL_PEL;
3774
3775 if (u2_sel > USB3_LPM_MAX_U2_SEL_PEL)
3776 u2_sel = USB3_LPM_MAX_U2_SEL_PEL;
3777
3778 if (u2_pel > USB3_LPM_MAX_U2_SEL_PEL)
3779 u2_pel = USB3_LPM_MAX_U2_SEL_PEL;
3780
3781 /*
3782 * usb_enable_lpm() can be called as part of a failed device reset,
3783 * which may be initiated by an error path of a mass storage driver.
3784 * Therefore, use GFP_NOIO.
3785 */
3786 sel_values = kmalloc(sizeof *(sel_values), GFP_NOIO);
3787 if (!sel_values)
3788 return -ENOMEM;
3789
3790 sel_values->u1_sel = u1_sel;
3791 sel_values->u1_pel = u1_pel;
3792 sel_values->u2_sel = cpu_to_le16(u2_sel);
3793 sel_values->u2_pel = cpu_to_le16(u2_pel);
3794
3795 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3796 USB_REQ_SET_SEL,
3797 USB_RECIP_DEVICE,
3798 0, 0,
3799 sel_values, sizeof *(sel_values),
3800 USB_CTRL_SET_TIMEOUT);
3801 kfree(sel_values);
3802 return ret;
3803 }
3804
3805 /*
3806 * Enable or disable device-initiated U1 or U2 transitions.
3807 */
3808 static int usb_set_device_initiated_lpm(struct usb_device *udev,
3809 enum usb3_link_state state, bool enable)
3810 {
3811 int ret;
3812 int feature;
3813
3814 switch (state) {
3815 case USB3_LPM_U1:
3816 feature = USB_DEVICE_U1_ENABLE;
3817 break;
3818 case USB3_LPM_U2:
3819 feature = USB_DEVICE_U2_ENABLE;
3820 break;
3821 default:
3822 dev_warn(&udev->dev, "%s: Can't %s non-U1 or U2 state.\n",
3823 __func__, enable ? "enable" : "disable");
3824 return -EINVAL;
3825 }
3826
3827 if (udev->state != USB_STATE_CONFIGURED) {
3828 dev_dbg(&udev->dev, "%s: Can't %s %s state "
3829 "for unconfigured device.\n",
3830 __func__, enable ? "enable" : "disable",
3831 usb3_lpm_names[state]);
3832 return 0;
3833 }
3834
3835 if (enable) {
3836 /*
3837 * Now send the control transfer to enable device-initiated LPM
3838 * for either U1 or U2.
3839 */
3840 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3841 USB_REQ_SET_FEATURE,
3842 USB_RECIP_DEVICE,
3843 feature,
3844 0, NULL, 0,
3845 USB_CTRL_SET_TIMEOUT);
3846 } else {
3847 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
3848 USB_REQ_CLEAR_FEATURE,
3849 USB_RECIP_DEVICE,
3850 feature,
3851 0, NULL, 0,
3852 USB_CTRL_SET_TIMEOUT);
3853 }
3854 if (ret < 0) {
3855 dev_warn(&udev->dev, "%s of device-initiated %s failed.\n",
3856 enable ? "Enable" : "Disable",
3857 usb3_lpm_names[state]);
3858 return -EBUSY;
3859 }
3860 return 0;
3861 }
3862
3863 static int usb_set_lpm_timeout(struct usb_device *udev,
3864 enum usb3_link_state state, int timeout)
3865 {
3866 int ret;
3867 int feature;
3868
3869 switch (state) {
3870 case USB3_LPM_U1:
3871 feature = USB_PORT_FEAT_U1_TIMEOUT;
3872 break;
3873 case USB3_LPM_U2:
3874 feature = USB_PORT_FEAT_U2_TIMEOUT;
3875 break;
3876 default:
3877 dev_warn(&udev->dev, "%s: Can't set timeout for non-U1 or U2 state.\n",
3878 __func__);
3879 return -EINVAL;
3880 }
3881
3882 if (state == USB3_LPM_U1 && timeout > USB3_LPM_U1_MAX_TIMEOUT &&
3883 timeout != USB3_LPM_DEVICE_INITIATED) {
3884 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x, "
3885 "which is a reserved value.\n",
3886 usb3_lpm_names[state], timeout);
3887 return -EINVAL;
3888 }
3889
3890 ret = set_port_feature(udev->parent,
3891 USB_PORT_LPM_TIMEOUT(timeout) | udev->portnum,
3892 feature);
3893 if (ret < 0) {
3894 dev_warn(&udev->dev, "Failed to set %s timeout to 0x%x,"
3895 "error code %i\n", usb3_lpm_names[state],
3896 timeout, ret);
3897 return -EBUSY;
3898 }
3899 if (state == USB3_LPM_U1)
3900 udev->u1_params.timeout = timeout;
3901 else
3902 udev->u2_params.timeout = timeout;
3903 return 0;
3904 }
3905
3906 /*
3907 * Enable the hub-initiated U1/U2 idle timeouts, and enable device-initiated
3908 * U1/U2 entry.
3909 *
3910 * We will attempt to enable U1 or U2, but there are no guarantees that the
3911 * control transfers to set the hub timeout or enable device-initiated U1/U2
3912 * will be successful.
3913 *
3914 * If we cannot set the parent hub U1/U2 timeout, we attempt to let the xHCI
3915 * driver know about it. If that call fails, it should be harmless, and just
3916 * take up more slightly more bus bandwidth for unnecessary U1/U2 exit latency.
3917 */
3918 static void usb_enable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3919 enum usb3_link_state state)
3920 {
3921 int timeout, ret;
3922 __u8 u1_mel = udev->bos->ss_cap->bU1devExitLat;
3923 __le16 u2_mel = udev->bos->ss_cap->bU2DevExitLat;
3924
3925 /* If the device says it doesn't have *any* exit latency to come out of
3926 * U1 or U2, it's probably lying. Assume it doesn't implement that link
3927 * state.
3928 */
3929 if ((state == USB3_LPM_U1 && u1_mel == 0) ||
3930 (state == USB3_LPM_U2 && u2_mel == 0))
3931 return;
3932
3933 /*
3934 * First, let the device know about the exit latencies
3935 * associated with the link state we're about to enable.
3936 */
3937 ret = usb_req_set_sel(udev, state);
3938 if (ret < 0) {
3939 dev_warn(&udev->dev, "Set SEL for device-initiated %s failed.\n",
3940 usb3_lpm_names[state]);
3941 return;
3942 }
3943
3944 /* We allow the host controller to set the U1/U2 timeout internally
3945 * first, so that it can change its schedule to account for the
3946 * additional latency to send data to a device in a lower power
3947 * link state.
3948 */
3949 timeout = hcd->driver->enable_usb3_lpm_timeout(hcd, udev, state);
3950
3951 /* xHCI host controller doesn't want to enable this LPM state. */
3952 if (timeout == 0)
3953 return;
3954
3955 if (timeout < 0) {
3956 dev_warn(&udev->dev, "Could not enable %s link state, "
3957 "xHCI error %i.\n", usb3_lpm_names[state],
3958 timeout);
3959 return;
3960 }
3961
3962 if (usb_set_lpm_timeout(udev, state, timeout))
3963 /* If we can't set the parent hub U1/U2 timeout,
3964 * device-initiated LPM won't be allowed either, so let the xHCI
3965 * host know that this link state won't be enabled.
3966 */
3967 hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state);
3968
3969 /* Only a configured device will accept the Set Feature U1/U2_ENABLE */
3970 else if (udev->actconfig)
3971 usb_set_device_initiated_lpm(udev, state, true);
3972
3973 }
3974
3975 /*
3976 * Disable the hub-initiated U1/U2 idle timeouts, and disable device-initiated
3977 * U1/U2 entry.
3978 *
3979 * If this function returns -EBUSY, the parent hub will still allow U1/U2 entry.
3980 * If zero is returned, the parent will not allow the link to go into U1/U2.
3981 *
3982 * If zero is returned, device-initiated U1/U2 entry may still be enabled, but
3983 * it won't have an effect on the bus link state because the parent hub will
3984 * still disallow device-initiated U1/U2 entry.
3985 *
3986 * If zero is returned, the xHCI host controller may still think U1/U2 entry is
3987 * possible. The result will be slightly more bus bandwidth will be taken up
3988 * (to account for U1/U2 exit latency), but it should be harmless.
3989 */
3990 static int usb_disable_link_state(struct usb_hcd *hcd, struct usb_device *udev,
3991 enum usb3_link_state state)
3992 {
3993 int feature;
3994
3995 switch (state) {
3996 case USB3_LPM_U1:
3997 feature = USB_PORT_FEAT_U1_TIMEOUT;
3998 break;
3999 case USB3_LPM_U2:
4000 feature = USB_PORT_FEAT_U2_TIMEOUT;
4001 break;
4002 default:
4003 dev_warn(&udev->dev, "%s: Can't disable non-U1 or U2 state.\n",
4004 __func__);
4005 return -EINVAL;
4006 }
4007
4008 if (usb_set_lpm_timeout(udev, state, 0))
4009 return -EBUSY;
4010
4011 usb_set_device_initiated_lpm(udev, state, false);
4012
4013 if (hcd->driver->disable_usb3_lpm_timeout(hcd, udev, state))
4014 dev_warn(&udev->dev, "Could not disable xHCI %s timeout, "
4015 "bus schedule bandwidth may be impacted.\n",
4016 usb3_lpm_names[state]);
4017 return 0;
4018 }
4019
4020 /*
4021 * Disable hub-initiated and device-initiated U1 and U2 entry.
4022 * Caller must own the bandwidth_mutex.
4023 *
4024 * This will call usb_enable_lpm() on failure, which will decrement
4025 * lpm_disable_count, and will re-enable LPM if lpm_disable_count reaches zero.
4026 */
4027 int usb_disable_lpm(struct usb_device *udev)
4028 {
4029 struct usb_hcd *hcd;
4030
4031 if (!udev || !udev->parent ||
4032 udev->speed != USB_SPEED_SUPER ||
4033 !udev->lpm_capable)
4034 return 0;
4035
4036 hcd = bus_to_hcd(udev->bus);
4037 if (!hcd || !hcd->driver->disable_usb3_lpm_timeout)
4038 return 0;
4039
4040 udev->lpm_disable_count++;
4041 if ((udev->u1_params.timeout == 0 && udev->u2_params.timeout == 0))
4042 return 0;
4043
4044 /* If LPM is enabled, attempt to disable it. */
4045 if (usb_disable_link_state(hcd, udev, USB3_LPM_U1))
4046 goto enable_lpm;
4047 if (usb_disable_link_state(hcd, udev, USB3_LPM_U2))
4048 goto enable_lpm;
4049
4050 return 0;
4051
4052 enable_lpm:
4053 usb_enable_lpm(udev);
4054 return -EBUSY;
4055 }
4056 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4057
4058 /* Grab the bandwidth_mutex before calling usb_disable_lpm() */
4059 int usb_unlocked_disable_lpm(struct usb_device *udev)
4060 {
4061 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4062 int ret;
4063
4064 if (!hcd)
4065 return -EINVAL;
4066
4067 mutex_lock(hcd->bandwidth_mutex);
4068 ret = usb_disable_lpm(udev);
4069 mutex_unlock(hcd->bandwidth_mutex);
4070
4071 return ret;
4072 }
4073 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4074
4075 /*
4076 * Attempt to enable device-initiated and hub-initiated U1 and U2 entry. The
4077 * xHCI host policy may prevent U1 or U2 from being enabled.
4078 *
4079 * Other callers may have disabled link PM, so U1 and U2 entry will be disabled
4080 * until the lpm_disable_count drops to zero. Caller must own the
4081 * bandwidth_mutex.
4082 */
4083 void usb_enable_lpm(struct usb_device *udev)
4084 {
4085 struct usb_hcd *hcd;
4086
4087 if (!udev || !udev->parent ||
4088 udev->speed != USB_SPEED_SUPER ||
4089 !udev->lpm_capable)
4090 return;
4091
4092 udev->lpm_disable_count--;
4093 hcd = bus_to_hcd(udev->bus);
4094 /* Double check that we can both enable and disable LPM.
4095 * Device must be configured to accept set feature U1/U2 timeout.
4096 */
4097 if (!hcd || !hcd->driver->enable_usb3_lpm_timeout ||
4098 !hcd->driver->disable_usb3_lpm_timeout)
4099 return;
4100
4101 if (udev->lpm_disable_count > 0)
4102 return;
4103
4104 usb_enable_link_state(hcd, udev, USB3_LPM_U1);
4105 usb_enable_link_state(hcd, udev, USB3_LPM_U2);
4106 }
4107 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4108
4109 /* Grab the bandwidth_mutex before calling usb_enable_lpm() */
4110 void usb_unlocked_enable_lpm(struct usb_device *udev)
4111 {
4112 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4113
4114 if (!hcd)
4115 return;
4116
4117 mutex_lock(hcd->bandwidth_mutex);
4118 usb_enable_lpm(udev);
4119 mutex_unlock(hcd->bandwidth_mutex);
4120 }
4121 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4122
4123
4124 #else /* CONFIG_PM */
4125
4126 #define hub_suspend NULL
4127 #define hub_resume NULL
4128 #define hub_reset_resume NULL
4129
4130 int usb_disable_lpm(struct usb_device *udev)
4131 {
4132 return 0;
4133 }
4134 EXPORT_SYMBOL_GPL(usb_disable_lpm);
4135
4136 void usb_enable_lpm(struct usb_device *udev) { }
4137 EXPORT_SYMBOL_GPL(usb_enable_lpm);
4138
4139 int usb_unlocked_disable_lpm(struct usb_device *udev)
4140 {
4141 return 0;
4142 }
4143 EXPORT_SYMBOL_GPL(usb_unlocked_disable_lpm);
4144
4145 void usb_unlocked_enable_lpm(struct usb_device *udev) { }
4146 EXPORT_SYMBOL_GPL(usb_unlocked_enable_lpm);
4147
4148 int usb_disable_ltm(struct usb_device *udev)
4149 {
4150 return 0;
4151 }
4152 EXPORT_SYMBOL_GPL(usb_disable_ltm);
4153
4154 void usb_enable_ltm(struct usb_device *udev) { }
4155 EXPORT_SYMBOL_GPL(usb_enable_ltm);
4156 #endif
4157
4158
4159 /* USB 2.0 spec, 7.1.7.3 / fig 7-29:
4160 *
4161 * Between connect detection and reset signaling there must be a delay
4162 * of 100ms at least for debounce and power-settling. The corresponding
4163 * timer shall restart whenever the downstream port detects a disconnect.
4164 *
4165 * Apparently there are some bluetooth and irda-dongles and a number of
4166 * low-speed devices for which this debounce period may last over a second.
4167 * Not covered by the spec - but easy to deal with.
4168 *
4169 * This implementation uses a 1500ms total debounce timeout; if the
4170 * connection isn't stable by then it returns -ETIMEDOUT. It checks
4171 * every 25ms for transient disconnects. When the port status has been
4172 * unchanged for 100ms it returns the port status.
4173 */
4174 int hub_port_debounce(struct usb_hub *hub, int port1, bool must_be_connected)
4175 {
4176 int ret;
4177 int total_time, stable_time = 0;
4178 u16 portchange, portstatus;
4179 unsigned connection = 0xffff;
4180
4181 for (total_time = 0; ; total_time += HUB_DEBOUNCE_STEP) {
4182 ret = hub_port_status(hub, port1, &portstatus, &portchange);
4183 if (ret < 0)
4184 return ret;
4185
4186 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
4187 (portstatus & USB_PORT_STAT_CONNECTION) == connection) {
4188 if (!must_be_connected ||
4189 (connection == USB_PORT_STAT_CONNECTION))
4190 stable_time += HUB_DEBOUNCE_STEP;
4191 if (stable_time >= HUB_DEBOUNCE_STABLE)
4192 break;
4193 } else {
4194 stable_time = 0;
4195 connection = portstatus & USB_PORT_STAT_CONNECTION;
4196 }
4197
4198 if (portchange & USB_PORT_STAT_C_CONNECTION) {
4199 usb_clear_port_feature(hub->hdev, port1,
4200 USB_PORT_FEAT_C_CONNECTION);
4201 }
4202
4203 if (total_time >= HUB_DEBOUNCE_TIMEOUT)
4204 break;
4205 msleep(HUB_DEBOUNCE_STEP);
4206 }
4207
4208 dev_dbg (hub->intfdev,
4209 "debounce: port %d: total %dms stable %dms status 0x%x\n",
4210 port1, total_time, stable_time, portstatus);
4211
4212 if (stable_time < HUB_DEBOUNCE_STABLE)
4213 return -ETIMEDOUT;
4214 return portstatus;
4215 }
4216
4217 void usb_ep0_reinit(struct usb_device *udev)
4218 {
4219 usb_disable_endpoint(udev, 0 + USB_DIR_IN, true);
4220 usb_disable_endpoint(udev, 0 + USB_DIR_OUT, true);
4221 usb_enable_endpoint(udev, &udev->ep0, true);
4222 }
4223 EXPORT_SYMBOL_GPL(usb_ep0_reinit);
4224
4225
4226 static int hub_set_address(struct usb_device *udev, int devnum)
4227 {
4228 int retval;
4229 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
4230
4231 /*
4232 * The host controller will choose the device address,
4233 * instead of the core having chosen it earlier
4234 */
4235 if (!hcd->driver->address_device && devnum <= 1)
4236 return -EINVAL;
4237 if (udev->state == USB_STATE_ADDRESS)
4238 return 0;
4239 if (udev->state != USB_STATE_DEFAULT)
4240 return -EINVAL;
4241 if (hcd->driver->address_device)
4242 retval = hcd->driver->address_device(hcd, udev);
4243 else
4244 retval = usb_control_msg(udev, usb_sndaddr0pipe(),
4245 USB_REQ_SET_ADDRESS, 0, devnum, 0,
4246 NULL, 0, USB_CTRL_SET_TIMEOUT);
4247 if (retval == 0) {
4248 update_devnum(udev, devnum);
4249 /* Device now using proper address. */
4250 usb_set_device_state(udev, USB_STATE_ADDRESS);
4251 usb_ep0_reinit(udev);
4252 }
4253 return retval;
4254 }
4255
4256 /* Reset device, (re)assign address, get device descriptor.
4257 * Device connection must be stable, no more debouncing needed.
4258 * Returns device in USB_STATE_ADDRESS, except on error.
4259 *
4260 * If this is called for an already-existing device (as part of
4261 * usb_reset_and_verify_device), the caller must own the device lock. For a
4262 * newly detected device that is not accessible through any global
4263 * pointers, it's not necessary to lock the device.
4264 */
4265 static int
4266 hub_port_init (struct usb_hub *hub, struct usb_device *udev, int port1,
4267 int retry_counter)
4268 {
4269 static DEFINE_MUTEX(usb_address0_mutex);
4270
4271 struct usb_device *hdev = hub->hdev;
4272 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4273 int i, j, retval;
4274 unsigned delay = HUB_SHORT_RESET_TIME;
4275 enum usb_device_speed oldspeed = udev->speed;
4276 const char *speed;
4277 int devnum = udev->devnum;
4278
4279 dump_stack();
4280 /* root hub ports have a slightly longer reset period
4281 * (from USB 2.0 spec, section 7.1.7.5)
4282 */
4283 if (!hdev->parent) {
4284 delay = HUB_ROOT_RESET_TIME;
4285 if (port1 == hdev->bus->otg_port)
4286 hdev->bus->b_hnp_enable = 0;
4287 }
4288
4289 /* Some low speed devices have problems with the quick delay, so */
4290 /* be a bit pessimistic with those devices. RHbug #23670 */
4291 if (oldspeed == USB_SPEED_LOW)
4292 delay = HUB_LONG_RESET_TIME;
4293
4294 mutex_lock(&usb_address0_mutex);
4295
4296 /* Reset the device; full speed may morph to high speed */
4297 /* FIXME a USB 2.0 device may morph into SuperSpeed on reset. */
4298 MYDBG("");
4299 retval = hub_port_reset(hub, port1, udev, delay, false);
4300 MYDBG("");
4301 if (retval < 0) /* error or disconnect */
4302 goto fail;
4303 /* success, speed is known */
4304
4305 retval = -ENODEV;
4306
4307 if (oldspeed != USB_SPEED_UNKNOWN && oldspeed != udev->speed) {
4308 dev_dbg(&udev->dev, "device reset changed speed!\n");
4309 goto fail;
4310 }
4311 oldspeed = udev->speed;
4312
4313 /* USB 2.0 section 5.5.3 talks about ep0 maxpacket ...
4314 * it's fixed size except for full speed devices.
4315 * For Wireless USB devices, ep0 max packet is always 512 (tho
4316 * reported as 0xff in the device descriptor). WUSB1.0[4.8.1].
4317 */
4318 switch (udev->speed) {
4319 case USB_SPEED_SUPER:
4320 case USB_SPEED_WIRELESS: /* fixed at 512 */
4321 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(512);
4322 break;
4323 case USB_SPEED_HIGH: /* fixed at 64 */
4324 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4325 break;
4326 case USB_SPEED_FULL: /* 8, 16, 32, or 64 */
4327 /* to determine the ep0 maxpacket size, try to read
4328 * the device descriptor to get bMaxPacketSize0 and
4329 * then correct our initial guess.
4330 */
4331 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(64);
4332 break;
4333 case USB_SPEED_LOW: /* fixed at 8 */
4334 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(8);
4335 break;
4336 default:
4337 goto fail;
4338 }
4339 MYDBG("");
4340
4341 if (udev->speed == USB_SPEED_WIRELESS)
4342 speed = "variable speed Wireless";
4343 else
4344 speed = usb_speed_string(udev->speed);
4345
4346 if (udev->speed != USB_SPEED_SUPER)
4347 dev_info(&udev->dev,
4348 "%s %s USB device number %d using %s\n",
4349 (udev->config) ? "reset" : "new", speed,
4350 devnum, udev->bus->controller->driver->name);
4351
4352 /* Set up TT records, if needed */
4353 if (hdev->tt) {
4354 udev->tt = hdev->tt;
4355 udev->ttport = hdev->ttport;
4356 } else if (udev->speed != USB_SPEED_HIGH
4357 && hdev->speed == USB_SPEED_HIGH) {
4358 if (!hub->tt.hub) {
4359 dev_err(&udev->dev, "parent hub has no TT\n");
4360 retval = -EINVAL;
4361 goto fail;
4362 }
4363 udev->tt = &hub->tt;
4364 udev->ttport = port1;
4365 }
4366
4367 /* Why interleave GET_DESCRIPTOR and SET_ADDRESS this way?
4368 * Because device hardware and firmware is sometimes buggy in
4369 * this area, and this is how Linux has done it for ages.
4370 * Change it cautiously.
4371 *
4372 * NOTE: If USE_NEW_SCHEME() is true we will start by issuing
4373 * a 64-byte GET_DESCRIPTOR request. This is what Windows does,
4374 * so it may help with some non-standards-compliant devices.
4375 * Otherwise we start with SET_ADDRESS and then try to read the
4376 * first 8 bytes of the device descriptor to get the ep0 maxpacket
4377 * value.
4378 */
4379 for (i = 0; i < GET_DESCRIPTOR_TRIES; (++i, msleep(100))) {
4380 MYDBG("");
4381 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3)) {
4382 struct usb_device_descriptor *buf;
4383 int r = 0;
4384
4385 #define GET_DESCRIPTOR_BUFSIZE 64
4386 buf = kmalloc(GET_DESCRIPTOR_BUFSIZE, GFP_NOIO);
4387 if (!buf) {
4388 retval = -ENOMEM;
4389 continue;
4390 }
4391
4392 /* Retry on all errors; some devices are flakey.
4393 * 255 is for WUSB devices, we actually need to use
4394 * 512 (WUSB1.0[4.8.1]).
4395 */
4396 for (j = 0; j < 3; ++j) {
4397 buf->bMaxPacketSize0 = 0;
4398 r = usb_control_msg(udev, usb_rcvaddr0pipe(),
4399 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
4400 USB_DT_DEVICE << 8, 0,
4401 buf, GET_DESCRIPTOR_BUFSIZE,
4402 initial_descriptor_timeout);
4403 switch (buf->bMaxPacketSize0) {
4404 case 8: case 16: case 32: case 64: case 255:
4405 if (buf->bDescriptorType ==
4406 USB_DT_DEVICE) {
4407 r = 0;
4408 break;
4409 }
4410 /* FALL THROUGH */
4411 default:
4412 if (r == 0)
4413 r = -EPROTO;
4414 break;
4415 }
4416 if (r == 0)
4417 break;
4418
4419 #if defined(CONFIG_USBIF_COMPLIANCE) && defined(CONFIG_USB_XHCI_HCD)
4420 if (buf->bMaxPacketSize0 == 0) {
4421 usbif_u3h_send_event("DEV_CONN_TMOUT");
4422 }
4423 #endif
4424
4425 }
4426 udev->descriptor.bMaxPacketSize0 =
4427 buf->bMaxPacketSize0;
4428 kfree(buf);
4429
4430 retval = hub_port_reset(hub, port1, udev, delay, false);
4431 if (retval < 0) /* error or disconnect */
4432 goto fail;
4433 if (oldspeed != udev->speed) {
4434 dev_dbg(&udev->dev,
4435 "device reset changed speed!\n");
4436 retval = -ENODEV;
4437 goto fail;
4438 }
4439 if (r) {
4440 if (r != -ENODEV)
4441 dev_err(&udev->dev, "device descriptor read/64, error %d\n",
4442 r);
4443 retval = -EMSGSIZE;
4444 continue;
4445 }
4446 #undef GET_DESCRIPTOR_BUFSIZE
4447 }
4448
4449 /*
4450 * If device is WUSB, we already assigned an
4451 * unauthorized address in the Connect Ack sequence;
4452 * authorization will assign the final address.
4453 */
4454 if (udev->wusb == 0) {
4455 for (j = 0; j < SET_ADDRESS_TRIES; ++j) {
4456 retval = hub_set_address(udev, devnum);
4457 if (retval >= 0)
4458 break;
4459 msleep(200);
4460 }
4461 if (retval < 0) {
4462 if (retval != -ENODEV)
4463 dev_err(&udev->dev, "device not accepting address %d, error %d\n",
4464 devnum, retval);
4465 goto fail;
4466 }
4467 if (udev->speed == USB_SPEED_SUPER) {
4468 devnum = udev->devnum;
4469 dev_info(&udev->dev,
4470 "%s SuperSpeed USB device number %d using %s\n",
4471 (udev->config) ? "reset" : "new",
4472 devnum, udev->bus->controller->driver->name);
4473 }
4474
4475 /* cope with hardware quirkiness:
4476 * - let SET_ADDRESS settle, some device hardware wants it
4477 * - read ep0 maxpacket even for high and low speed,
4478 */
4479 msleep(10);
4480 if (USE_NEW_SCHEME(retry_counter) && !(hcd->driver->flags & HCD_USB3))
4481 break;
4482 }
4483
4484 retval = usb_get_device_descriptor(udev, 8);
4485 if (retval < 8) {
4486 if (retval != -ENODEV)
4487 dev_err(&udev->dev,
4488 "device descriptor read/8, error %d\n",
4489 retval);
4490 if (retval >= 0)
4491 retval = -EMSGSIZE;
4492 } else {
4493 retval = 0;
4494 break;
4495 }
4496 }
4497 if (retval)
4498 goto fail;
4499
4500 if (hcd->phy && !hdev->parent)
4501 usb_phy_notify_connect(hcd->phy, udev->speed);
4502
4503 /*
4504 * Some superspeed devices have finished the link training process
4505 * and attached to a superspeed hub port, but the device descriptor
4506 * got from those devices show they aren't superspeed devices. Warm
4507 * reset the port attached by the devices can fix them.
4508 */
4509 if ((udev->speed == USB_SPEED_SUPER) &&
4510 (le16_to_cpu(udev->descriptor.bcdUSB) < 0x0300)) {
4511 dev_err(&udev->dev, "got a wrong device descriptor, "
4512 "warm reset device\n");
4513 hub_port_reset(hub, port1, udev,
4514 HUB_BH_RESET_TIME, true);
4515 retval = -EINVAL;
4516 goto fail;
4517 }
4518
4519 if (udev->descriptor.bMaxPacketSize0 == 0xff ||
4520 udev->speed == USB_SPEED_SUPER)
4521 i = 512;
4522 else
4523 i = udev->descriptor.bMaxPacketSize0;
4524 if (usb_endpoint_maxp(&udev->ep0.desc) != i) {
4525 if (udev->speed == USB_SPEED_LOW ||
4526 !(i == 8 || i == 16 || i == 32 || i == 64)) {
4527 dev_err(&udev->dev, "Invalid ep0 maxpacket: %d\n", i);
4528 retval = -EMSGSIZE;
4529 goto fail;
4530 }
4531 if (udev->speed == USB_SPEED_FULL)
4532 dev_dbg(&udev->dev, "ep0 maxpacket = %d\n", i);
4533 else
4534 dev_warn(&udev->dev, "Using ep0 maxpacket: %d\n", i);
4535 udev->ep0.desc.wMaxPacketSize = cpu_to_le16(i);
4536 usb_ep0_reinit(udev);
4537 }
4538
4539 retval = usb_get_device_descriptor(udev, USB_DT_DEVICE_SIZE);
4540 if (retval < (signed)sizeof(udev->descriptor)) {
4541 if (retval != -ENODEV)
4542 dev_err(&udev->dev, "device descriptor read/all, error %d\n",
4543 retval);
4544 if (retval >= 0)
4545 retval = -ENOMSG;
4546 goto fail;
4547 }
4548
4549 if (udev->wusb == 0 && le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0201) {
4550 retval = usb_get_bos_descriptor(udev);
4551 if (!retval) {
4552 udev->lpm_capable = usb_device_supports_lpm(udev);
4553 usb_set_lpm_parameters(udev);
4554 }
4555 }
4556
4557 retval = 0;
4558 /* notify HCD that we have a device connected and addressed */
4559 if (hcd->driver->update_device)
4560 hcd->driver->update_device(hcd, udev);
4561 fail:
4562 if (retval) {
4563 hub_port_disable(hub, port1, 0);
4564 update_devnum(udev, devnum); /* for disconnect processing */
4565 }
4566 mutex_unlock(&usb_address0_mutex);
4567 return retval;
4568 }
4569
4570 static void
4571 check_highspeed (struct usb_hub *hub, struct usb_device *udev, int port1)
4572 {
4573 struct usb_qualifier_descriptor *qual;
4574 int status;
4575
4576 qual = kmalloc (sizeof *qual, GFP_KERNEL);
4577 if (qual == NULL)
4578 return;
4579
4580 status = usb_get_descriptor (udev, USB_DT_DEVICE_QUALIFIER, 0,
4581 qual, sizeof *qual);
4582 if (status == sizeof *qual) {
4583 dev_info(&udev->dev, "not running at top speed; "
4584 "connect to a high speed hub\n");
4585 /* hub LEDs are probably harder to miss than syslog */
4586 if (hub->has_indicators) {
4587 hub->indicator[port1-1] = INDICATOR_GREEN_BLINK;
4588 schedule_delayed_work (&hub->leds, 0);
4589 }
4590 }
4591 kfree(qual);
4592 }
4593
4594 static unsigned
4595 hub_power_remaining (struct usb_hub *hub)
4596 {
4597 struct usb_device *hdev = hub->hdev;
4598 int remaining;
4599 int port1;
4600
4601 if (!hub->limited_power)
4602 return 0;
4603
4604 remaining = hdev->bus_mA - hub->descriptor->bHubContrCurrent;
4605 for (port1 = 1; port1 <= hdev->maxchild; ++port1) {
4606 struct usb_device *udev = hub->ports[port1 - 1]->child;
4607 int delta;
4608 unsigned unit_load;
4609
4610 if (!udev)
4611 continue;
4612 if (hub_is_superspeed(udev))
4613 unit_load = 150;
4614 else
4615 unit_load = 100;
4616
4617 /*
4618 * Unconfigured devices may not use more than one unit load,
4619 * or 8mA for OTG ports
4620 */
4621 if (udev->actconfig)
4622 delta = usb_get_max_power(udev, udev->actconfig);
4623 else if (port1 != udev->bus->otg_port || hdev->parent)
4624 delta = unit_load;
4625 else
4626 delta = 8;
4627 if (delta > hub->mA_per_port)
4628 dev_warn(&udev->dev,
4629 "%dmA is over %umA budget for port %d!\n",
4630 delta, hub->mA_per_port, port1);
4631 remaining -= delta;
4632 }
4633 if (remaining < 0) {
4634 #if defined(CONFIG_USBIF_COMPLIANCE) && defined(CONFIG_USB_XHCI_HCD)
4635 usbif_u3h_send_event("DEV_OVER_CURRENT");
4636 #endif
4637 dev_warn(hub->intfdev, "%dmA over power budget!\n",
4638 - remaining);
4639 remaining = 0;
4640 }
4641 return remaining;
4642 }
4643
4644 /* Handle physical or logical connection change events.
4645 * This routine is called when:
4646 * a port connection-change occurs;
4647 * a port enable-change occurs (often caused by EMI);
4648 * usb_reset_and_verify_device() encounters changed descriptors (as from
4649 * a firmware download)
4650 * caller already locked the hub
4651 */
4652 static void hub_port_connect_change(struct usb_hub *hub, int port1,
4653 u16 portstatus, u16 portchange)
4654 {
4655 struct usb_device *hdev = hub->hdev;
4656 struct device *hub_dev = hub->intfdev;
4657 struct usb_hcd *hcd = bus_to_hcd(hdev->bus);
4658 unsigned wHubCharacteristics =
4659 le16_to_cpu(hub->descriptor->wHubCharacteristics);
4660 struct usb_device *udev;
4661 int status, i;
4662 unsigned unit_load;
4663
4664 MYDBG("");
4665 dev_dbg (hub_dev,
4666 "port %d, status %04x, change %04x, %s\n",
4667 port1, portstatus, portchange, portspeed(hub, portstatus));
4668
4669 if (hub->has_indicators) {
4670 set_port_led(hub, port1, HUB_LED_AUTO);
4671 hub->indicator[port1-1] = INDICATOR_AUTO;
4672 }
4673
4674 #ifdef CONFIG_USB_OTG
4675 /* during HNP, don't repeat the debounce */
4676 if (hdev->bus->is_b_host)
4677 portchange &= ~(USB_PORT_STAT_C_CONNECTION |
4678 USB_PORT_STAT_C_ENABLE);
4679 #endif
4680
4681 /* Try to resuscitate an existing device */
4682 udev = hub->ports[port1 - 1]->child;
4683 if ((portstatus & USB_PORT_STAT_CONNECTION) && udev &&
4684 udev->state != USB_STATE_NOTATTACHED) {
4685 usb_lock_device(udev);
4686 if (portstatus & USB_PORT_STAT_ENABLE) {
4687 status = 0; /* Nothing to do */
4688
4689 #ifdef CONFIG_PM_RUNTIME
4690 } else if (udev->state == USB_STATE_SUSPENDED &&
4691 udev->persist_enabled) {
4692 /* For a suspended device, treat this as a
4693 * remote wakeup event.
4694 */
4695 status = usb_remote_wakeup(udev);
4696 #endif
4697
4698 } else {
4699 status = -ENODEV; /* Don't resuscitate */
4700 }
4701 usb_unlock_device(udev);
4702
4703 if (status == 0) {
4704 clear_bit(port1, hub->change_bits);
4705 return;
4706 }
4707 }
4708
4709 /* Disconnect any existing devices under this port */
4710 if (udev) {
4711 if (hcd->phy && !hdev->parent &&
4712 !(portstatus & USB_PORT_STAT_CONNECTION))
4713 usb_phy_notify_disconnect(hcd->phy, udev->speed);
4714 usb_disconnect(&hub->ports[port1 - 1]->child);
4715 }
4716 clear_bit(port1, hub->change_bits);
4717
4718 /* We can forget about a "removed" device when there's a physical
4719 * disconnect or the connect status changes.
4720 */
4721 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4722 (portchange & USB_PORT_STAT_C_CONNECTION))
4723 clear_bit(port1, hub->removed_bits);
4724
4725 if (portchange & (USB_PORT_STAT_C_CONNECTION |
4726 USB_PORT_STAT_C_ENABLE)) {
4727 status = hub_port_debounce_be_stable(hub, port1);
4728 if (status < 0) {
4729 if (status != -ENODEV && printk_ratelimit())
4730 dev_err(hub_dev, "connect-debounce failed, "
4731 "port %d disabled\n", port1);
4732 portstatus &= ~USB_PORT_STAT_CONNECTION;
4733 } else {
4734 portstatus = status;
4735 }
4736 }
4737
4738 /* Return now if debouncing failed or nothing is connected or
4739 * the device was "removed".
4740 */
4741 if (!(portstatus & USB_PORT_STAT_CONNECTION) ||
4742 test_bit(port1, hub->removed_bits)) {
4743
4744 /* maybe switch power back on (e.g. root hub was reset) */
4745 if ((wHubCharacteristics & HUB_CHAR_LPSM) < 2
4746 && !port_is_power_on(hub, portstatus))
4747 set_port_feature(hdev, port1, USB_PORT_FEAT_POWER);
4748
4749 if (portstatus & USB_PORT_STAT_ENABLE)
4750 goto done;
4751 return;
4752 }
4753 if (hub_is_superspeed(hub->hdev))
4754 unit_load = 150;
4755 else
4756 unit_load = 100;
4757
4758 status = 0;
4759 for (i = 0; i < SET_CONFIG_TRIES; i++) {
4760
4761 /* reallocate for each attempt, since references
4762 * to the previous one can escape in various ways
4763 */
4764 udev = usb_alloc_dev(hdev, hdev->bus, port1);
4765 if (!udev) {
4766 dev_err (hub_dev,
4767 "couldn't allocate port %d usb_device\n",
4768 port1);
4769 goto done;
4770 }
4771
4772 usb_set_device_state(udev, USB_STATE_POWERED);
4773 udev->bus_mA = hub->mA_per_port;
4774 udev->level = hdev->level + 1;
4775 udev->wusb = hub_is_wusb(hub);
4776
4777 /* Only USB 3.0 devices are connected to SuperSpeed hubs. */
4778 if (hub_is_superspeed(hub->hdev))
4779 udev->speed = USB_SPEED_SUPER;
4780 else
4781 udev->speed = USB_SPEED_UNKNOWN;
4782
4783 choose_devnum(udev);
4784 if (udev->devnum <= 0) {
4785 status = -ENOTCONN; /* Don't retry */
4786 goto loop;
4787 }
4788
4789 /* reset (non-USB 3.0 devices) and get descriptor */
4790 MYDBG("");
4791 status = hub_port_init(hub, udev, port1, i);
4792 if (status < 0)
4793 {
4794 MYDBG("");
4795 goto loop;
4796 }
4797 MYDBG("");
4798
4799 usb_detect_quirks(udev);
4800 if (udev->quirks & USB_QUIRK_DELAY_INIT)
4801 msleep(1000);
4802
4803 /* consecutive bus-powered hubs aren't reliable; they can
4804 * violate the voltage drop budget. if the new child has
4805 * a "powered" LED, users should notice we didn't enable it
4806 * (without reading syslog), even without per-port LEDs
4807 * on the parent.
4808 */
4809 if (udev->descriptor.bDeviceClass == USB_CLASS_HUB
4810 && udev->bus_mA <= unit_load) {
4811 u16 devstat;
4812
4813 status = usb_get_status(udev, USB_RECIP_DEVICE, 0,
4814 &devstat);
4815 if (status < 2) {
4816 dev_dbg(&udev->dev, "get status %d ?\n", status);
4817 goto loop_disable;
4818 }
4819 le16_to_cpus(&devstat);
4820 if ((devstat & (1 << USB_DEVICE_SELF_POWERED)) == 0) {
4821 dev_err(&udev->dev,
4822 "can't connect bus-powered hub "
4823 "to this port\n");
4824 if (hub->has_indicators) {
4825 hub->indicator[port1-1] =
4826 INDICATOR_AMBER_BLINK;
4827 schedule_delayed_work (&hub->leds, 0);
4828 }
4829 status = -ENOTCONN; /* Don't retry */
4830 goto loop_disable;
4831 }
4832 }
4833
4834 /* check for devices running slower than they could */
4835 if (le16_to_cpu(udev->descriptor.bcdUSB) >= 0x0200
4836 && udev->speed == USB_SPEED_FULL
4837 && highspeed_hubs != 0)
4838 check_highspeed (hub, udev, port1);
4839
4840 /* Store the parent's children[] pointer. At this point
4841 * udev becomes globally accessible, although presumably
4842 * no one will look at it until hdev is unlocked.
4843 */
4844 status = 0;
4845
4846 /* We mustn't add new devices if the parent hub has
4847 * been disconnected; we would race with the
4848 * recursively_mark_NOTATTACHED() routine.
4849 */
4850 spin_lock_irq(&device_state_lock);
4851 if (hdev->state == USB_STATE_NOTATTACHED)
4852 status = -ENOTCONN;
4853 else
4854 hub->ports[port1 - 1]->child = udev;
4855 spin_unlock_irq(&device_state_lock);
4856
4857 /* Run it through the hoops (find a driver, etc) */
4858 if (!status) {
4859 status = usb_new_device(udev);
4860 if (status) {
4861 spin_lock_irq(&device_state_lock);
4862 hub->ports[port1 - 1]->child = NULL;
4863 spin_unlock_irq(&device_state_lock);
4864 }
4865 #ifdef CONFIG_MTK_DT_USB_SUPPORT
4866 g_dsda_dev = udev;
4867 MYDBG("get new device !!!, BUILD TIME : %s, g_dsda_dev : %p\n", __TIME__, g_dsda_dev);
4868 #endif
4869 }
4870
4871 if (status)
4872 goto loop_disable;
4873
4874 status = hub_power_remaining(hub);
4875 if (status)
4876 dev_dbg(hub_dev, "%dmA power budget left\n", status);
4877
4878 return;
4879
4880 loop_disable:
4881 hub_port_disable(hub, port1, 1);
4882 loop:
4883 usb_ep0_reinit(udev);
4884 release_devnum(udev);
4885 hub_free_dev(udev);
4886 usb_put_dev(udev);
4887 if ((status == -ENOTCONN) || (status == -ENOTSUPP))
4888 break;
4889 }
4890 if (hub->hdev->parent ||
4891 !hcd->driver->port_handed_over ||
4892 !(hcd->driver->port_handed_over)(hcd, port1)) {
4893 if (status != -ENOTCONN && status != -ENODEV)
4894 dev_err(hub_dev, "unable to enumerate USB device on port %d\n",
4895 port1);
4896 }
4897
4898 done:
4899 hub_port_disable(hub, port1, 1);
4900 if (hcd->driver->relinquish_port && !hub->hdev->parent)
4901 hcd->driver->relinquish_port(hcd, port1);
4902 }
4903
4904 /* Returns 1 if there was a remote wakeup and a connect status change. */
4905 static int hub_handle_remote_wakeup(struct usb_hub *hub, unsigned int port,
4906 u16 portstatus, u16 portchange)
4907 {
4908 struct usb_device *hdev;
4909 struct usb_device *udev;
4910 int connect_change = 0;
4911 int ret;
4912
4913 hdev = hub->hdev;
4914 udev = hub->ports[port - 1]->child;
4915 if (!hub_is_superspeed(hdev)) {
4916 if (!(portchange & USB_PORT_STAT_C_SUSPEND))
4917 return 0;
4918 usb_clear_port_feature(hdev, port, USB_PORT_FEAT_C_SUSPEND);
4919 } else {
4920 if (!udev || udev->state != USB_STATE_SUSPENDED ||
4921 (portstatus & USB_PORT_STAT_LINK_STATE) !=
4922 USB_SS_PORT_LS_U0)
4923 return 0;
4924 }
4925
4926 if (udev) {
4927 /* TRSMRCY = 10 msec */
4928 msleep(10);
4929
4930 usb_lock_device(udev);
4931 ret = usb_remote_wakeup(udev);
4932 usb_unlock_device(udev);
4933 if (ret < 0)
4934 connect_change = 1;
4935 } else {
4936 ret = -ENODEV;
4937 hub_port_disable(hub, port, 1);
4938 }
4939 dev_dbg(hub->intfdev, "resume on port %d, status %d\n",
4940 port, ret);
4941 return connect_change;
4942 }
4943
4944 static void hub_events(void)
4945 {
4946 struct list_head *tmp;
4947 struct usb_device *hdev;
4948 struct usb_interface *intf;
4949 struct usb_hub *hub;
4950 struct device *hub_dev;
4951 u16 hubstatus;
4952 u16 hubchange;
4953 u16 portstatus;
4954 u16 portchange;
4955 int i, ret;
4956 int connect_change, wakeup_change;
4957
4958 /*
4959 * We restart the list every time to avoid a deadlock with
4960 * deleting hubs downstream from this one. This should be
4961 * safe since we delete the hub from the event list.
4962 * Not the most efficient, but avoids deadlocks.
4963 */
4964 while (1) {
4965
4966 /* Grab the first entry at the beginning of the list */
4967 spin_lock_irq(&hub_event_lock);
4968 if (list_empty(&hub_event_list)) {
4969 spin_unlock_irq(&hub_event_lock);
4970 break;
4971 }
4972
4973 tmp = hub_event_list.next;
4974 list_del_init(tmp);
4975
4976 hub = list_entry(tmp, struct usb_hub, event_list);
4977 kref_get(&hub->kref);
4978 hdev = hub->hdev;
4979 usb_get_dev(hdev);
4980 spin_unlock_irq(&hub_event_lock);
4981
4982 hub_dev = hub->intfdev;
4983 intf = to_usb_interface(hub_dev);
4984 dev_dbg(hub_dev, "state %d ports %d chg %04x evt %04x\n",
4985 hdev->state, hub->descriptor
4986 ? hub->descriptor->bNbrPorts
4987 : 0,
4988 /* NOTE: expects max 15 ports... */
4989 (u16) hub->change_bits[0],
4990 (u16) hub->event_bits[0]);
4991
4992 /* Lock the device, then check to see if we were
4993 * disconnected while waiting for the lock to succeed. */
4994 usb_lock_device(hdev);
4995 if (unlikely(hub->disconnected))
4996 goto loop_disconnected;
4997
4998 /* If the hub has died, clean up after it */
4999 if (hdev->state == USB_STATE_NOTATTACHED) {
5000 hub->error = -ENODEV;
5001 hub_quiesce(hub, HUB_DISCONNECT);
5002 goto loop;
5003 }
5004
5005 /* Autoresume */
5006 ret = usb_autopm_get_interface(intf);
5007 if (ret) {
5008 dev_dbg(hub_dev, "Can't autoresume: %d\n", ret);
5009 goto loop;
5010 }
5011
5012 /* If this is an inactive hub, do nothing */
5013 if (hub->quiescing)
5014 goto loop_autopm;
5015
5016 if (hub->error) {
5017 dev_dbg (hub_dev, "resetting for error %d\n",
5018 hub->error);
5019
5020 MYDBG("");
5021 ret = usb_reset_device(hdev);
5022 if (ret) {
5023 dev_dbg (hub_dev,
5024 "error resetting hub: %d\n", ret);
5025 goto loop_autopm;
5026 }
5027
5028 hub->nerrors = 0;
5029 hub->error = 0;
5030 }
5031
5032 /* deal with port status changes */
5033 for (i = 1; i <= hub->descriptor->bNbrPorts; i++) {
5034 if (test_bit(i, hub->busy_bits))
5035 continue;
5036 connect_change = test_bit(i, hub->change_bits);
5037 wakeup_change = test_and_clear_bit(i, hub->wakeup_bits);
5038 if (!test_and_clear_bit(i, hub->event_bits) &&
5039 !connect_change && !wakeup_change)
5040 continue;
5041
5042 ret = hub_port_status(hub, i,
5043 &portstatus, &portchange);
5044 if (ret < 0)
5045 continue;
5046
5047 if (portchange & USB_PORT_STAT_C_CONNECTION) {
5048 usb_clear_port_feature(hdev, i,
5049 USB_PORT_FEAT_C_CONNECTION);
5050 connect_change = 1;
5051 }
5052
5053 if (portchange & USB_PORT_STAT_C_ENABLE) {
5054 if (!connect_change)
5055 dev_dbg (hub_dev,
5056 "port %d enable change, "
5057 "status %08x\n",
5058 i, portstatus);
5059 usb_clear_port_feature(hdev, i,
5060 USB_PORT_FEAT_C_ENABLE);
5061
5062 /*
5063 * EM interference sometimes causes badly
5064 * shielded USB devices to be shutdown by
5065 * the hub, this hack enables them again.
5066 * Works at least with mouse driver.
5067 */
5068 if (!(portstatus & USB_PORT_STAT_ENABLE)
5069 && !connect_change
5070 && hub->ports[i - 1]->child) {
5071 dev_err (hub_dev,
5072 "port %i "
5073 "disabled by hub (EMI?), "
5074 "re-enabling...\n",
5075 i);
5076 connect_change = 1;
5077 }
5078 }
5079
5080 if (hub_handle_remote_wakeup(hub, i,
5081 portstatus, portchange))
5082 connect_change = 1;
5083
5084 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
5085 u16 status = 0;
5086 u16 unused;
5087
5088 dev_dbg(hub_dev, "over-current change on port "
5089 "%d\n", i);
5090 usb_clear_port_feature(hdev, i,
5091 USB_PORT_FEAT_C_OVER_CURRENT);
5092 msleep(100); /* Cool down */
5093 hub_power_on(hub, true);
5094 hub_port_status(hub, i, &status, &unused);
5095 if (status & USB_PORT_STAT_OVERCURRENT)
5096 dev_err(hub_dev, "over-current "
5097 "condition on port %d\n", i);
5098 }
5099
5100 if (portchange & USB_PORT_STAT_C_RESET) {
5101 dev_dbg (hub_dev,
5102 "reset change on port %d\n",
5103 i);
5104 usb_clear_port_feature(hdev, i,
5105 USB_PORT_FEAT_C_RESET);
5106 }
5107 if ((portchange & USB_PORT_STAT_C_BH_RESET) &&
5108 hub_is_superspeed(hub->hdev)) {
5109 dev_dbg(hub_dev,
5110 "warm reset change on port %d\n",
5111 i);
5112 usb_clear_port_feature(hdev, i,
5113 USB_PORT_FEAT_C_BH_PORT_RESET);
5114 }
5115 if (portchange & USB_PORT_STAT_C_LINK_STATE) {
5116 usb_clear_port_feature(hub->hdev, i,
5117 USB_PORT_FEAT_C_PORT_LINK_STATE);
5118 }
5119 if (portchange & USB_PORT_STAT_C_CONFIG_ERROR) {
5120 dev_warn(hub_dev,
5121 "config error on port %d\n",
5122 i);
5123 usb_clear_port_feature(hub->hdev, i,
5124 USB_PORT_FEAT_C_PORT_CONFIG_ERROR);
5125 }
5126
5127 /* Warm reset a USB3 protocol port if it's in
5128 * SS.Inactive state.
5129 */
5130 if (hub_port_warm_reset_required(hub, portstatus)) {
5131 int status;
5132 struct usb_device *udev =
5133 hub->ports[i - 1]->child;
5134
5135 dev_dbg(hub_dev, "warm reset port %d\n", i);
5136 if (!udev ||
5137 !(portstatus & USB_PORT_STAT_CONNECTION) ||
5138 udev->state == USB_STATE_NOTATTACHED) {
5139 status = hub_port_reset(hub, i,
5140 NULL, HUB_BH_RESET_TIME,
5141 true);
5142 if (status < 0)
5143 hub_port_disable(hub, i, 1);
5144 } else {
5145 usb_lock_device(udev);
5146 status = usb_reset_device(udev);
5147 usb_unlock_device(udev);
5148 connect_change = 0;
5149 }
5150 }
5151
5152 if (connect_change)
5153 hub_port_connect_change(hub, i,
5154 portstatus, portchange);
5155 } /* end for i */
5156
5157 /* deal with hub status changes */
5158 if (test_and_clear_bit(0, hub->event_bits) == 0)
5159 ; /* do nothing */
5160 else if (hub_hub_status(hub, &hubstatus, &hubchange) < 0)
5161 dev_err (hub_dev, "get_hub_status failed\n");
5162 else {
5163 if (hubchange & HUB_CHANGE_LOCAL_POWER) {
5164 dev_dbg (hub_dev, "power change\n");
5165 clear_hub_feature(hdev, C_HUB_LOCAL_POWER);
5166 if (hubstatus & HUB_STATUS_LOCAL_POWER)
5167 /* FIXME: Is this always true? */
5168 hub->limited_power = 1;
5169 else
5170 hub->limited_power = 0;
5171 }
5172 if (hubchange & HUB_CHANGE_OVERCURRENT) {
5173 u16 status = 0;
5174 u16 unused;
5175
5176 dev_dbg(hub_dev, "over-current change\n");
5177 clear_hub_feature(hdev, C_HUB_OVER_CURRENT);
5178 msleep(500); /* Cool down */
5179 hub_power_on(hub, true);
5180 hub_hub_status(hub, &status, &unused);
5181 if (status & HUB_STATUS_OVERCURRENT)
5182 dev_err(hub_dev, "over-current "
5183 "condition\n");
5184 }
5185 }
5186
5187 loop_autopm:
5188 /* Balance the usb_autopm_get_interface() above */
5189 usb_autopm_put_interface_no_suspend(intf);
5190 loop:
5191 /* Balance the usb_autopm_get_interface_no_resume() in
5192 * kick_khubd() and allow autosuspend.
5193 */
5194 usb_autopm_put_interface(intf);
5195 loop_disconnected:
5196 usb_unlock_device(hdev);
5197 usb_put_dev(hdev);
5198 kref_put(&hub->kref, hub_release);
5199
5200 } /* end while (1) */
5201 }
5202
5203 static int hub_thread(void *__unused)
5204 {
5205 /* khubd needs to be freezable to avoid intefering with USB-PERSIST
5206 * port handover. Otherwise it might see that a full-speed device
5207 * was gone before the EHCI controller had handed its port over to
5208 * the companion full-speed controller.
5209 */
5210 set_freezable();
5211
5212 do {
5213 hub_events();
5214 wait_event_freezable(khubd_wait,
5215 !list_empty(&hub_event_list) ||
5216 kthread_should_stop());
5217 } while (!kthread_should_stop() || !list_empty(&hub_event_list));
5218
5219 pr_debug("%s: khubd exiting\n", usbcore_name);
5220 return 0;
5221 }
5222
5223 static const struct usb_device_id hub_id_table[] = {
5224 { .match_flags = USB_DEVICE_ID_MATCH_VENDOR
5225 | USB_DEVICE_ID_MATCH_INT_CLASS,
5226 .idVendor = USB_VENDOR_GENESYS_LOGIC,
5227 .bInterfaceClass = USB_CLASS_HUB,
5228 .driver_info = HUB_QUIRK_CHECK_PORT_AUTOSUSPEND},
5229 { .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
5230 .bDeviceClass = USB_CLASS_HUB},
5231 { .match_flags = USB_DEVICE_ID_MATCH_INT_CLASS,
5232 .bInterfaceClass = USB_CLASS_HUB},
5233 { } /* Terminating entry */
5234 };
5235
5236 MODULE_DEVICE_TABLE (usb, hub_id_table);
5237
5238 static struct usb_driver hub_driver = {
5239 .name = "hub",
5240 .probe = hub_probe,
5241 .disconnect = hub_disconnect,
5242 .suspend = hub_suspend,
5243 .resume = hub_resume,
5244 .reset_resume = hub_reset_resume,
5245 .pre_reset = hub_pre_reset,
5246 .post_reset = hub_post_reset,
5247 .unlocked_ioctl = hub_ioctl,
5248 .id_table = hub_id_table,
5249 .supports_autosuspend = 1,
5250 };
5251
5252 #if defined(CONFIG_MTK_XHCI) && defined(CONFIG_USB_MTK_DUALMODE)
5253 extern void mtk_hub_event_steal(spinlock_t *lock, struct list_head* list);
5254 #endif
5255 int usb_hub_init(void)
5256 {
5257 if (usb_register(&hub_driver) < 0) {
5258 printk(KERN_ERR "%s: can't register hub driver\n",
5259 usbcore_name);
5260 return -1;
5261 }
5262
5263 #if defined(CONFIG_MTK_XHCI) && defined(CONFIG_USB_MTK_DUALMODE)
5264 mtk_hub_event_steal(&hub_event_lock, &hub_event_list);
5265 #endif
5266
5267 khubd_task = kthread_run(hub_thread, NULL, "khubd");
5268 if (!IS_ERR(khubd_task))
5269 return 0;
5270
5271 /* Fall through if kernel_thread failed */
5272 usb_deregister(&hub_driver);
5273 printk(KERN_ERR "%s: can't start khubd\n", usbcore_name);
5274
5275 return -1;
5276 }
5277
5278 void usb_hub_cleanup(void)
5279 {
5280 kthread_stop(khubd_task);
5281
5282 /*
5283 * Hub resources are freed for us by usb_deregister. It calls
5284 * usb_driver_purge on every device which in turn calls that
5285 * devices disconnect function if it is using this driver.
5286 * The hub_disconnect function takes care of releasing the
5287 * individual hub resources. -greg
5288 */
5289 usb_deregister(&hub_driver);
5290 } /* usb_hub_cleanup() */
5291
5292 static int descriptors_changed(struct usb_device *udev,
5293 struct usb_device_descriptor *old_device_descriptor)
5294 {
5295 int changed = 0;
5296 unsigned index;
5297 unsigned serial_len = 0;
5298 unsigned len;
5299 unsigned old_length;
5300 int length;
5301 char *buf;
5302
5303 if (memcmp(&udev->descriptor, old_device_descriptor,
5304 sizeof(*old_device_descriptor)) != 0)
5305 return 1;
5306
5307 /* Since the idVendor, idProduct, and bcdDevice values in the
5308 * device descriptor haven't changed, we will assume the
5309 * Manufacturer and Product strings haven't changed either.
5310 * But the SerialNumber string could be different (e.g., a
5311 * different flash card of the same brand).
5312 */
5313 if (udev->serial)
5314 serial_len = strlen(udev->serial) + 1;
5315
5316 len = serial_len;
5317 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5318 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5319 len = max(len, old_length);
5320 }
5321
5322 buf = kmalloc(len, GFP_NOIO);
5323 if (buf == NULL) {
5324 dev_err(&udev->dev, "no mem to re-read configs after reset\n");
5325 /* assume the worst */
5326 return 1;
5327 }
5328 for (index = 0; index < udev->descriptor.bNumConfigurations; index++) {
5329 old_length = le16_to_cpu(udev->config[index].desc.wTotalLength);
5330 length = usb_get_descriptor(udev, USB_DT_CONFIG, index, buf,
5331 old_length);
5332 if (length != old_length) {
5333 dev_dbg(&udev->dev, "config index %d, error %d\n",
5334 index, length);
5335 changed = 1;
5336 break;
5337 }
5338 if (memcmp (buf, udev->rawdescriptors[index], old_length)
5339 != 0) {
5340 dev_dbg(&udev->dev, "config index %d changed (#%d)\n",
5341 index,
5342 ((struct usb_config_descriptor *) buf)->
5343 bConfigurationValue);
5344 changed = 1;
5345 break;
5346 }
5347 }
5348
5349 if (!changed && serial_len) {
5350 length = usb_string(udev, udev->descriptor.iSerialNumber,
5351 buf, serial_len);
5352 if (length + 1 != serial_len) {
5353 dev_dbg(&udev->dev, "serial string error %d\n",
5354 length);
5355 changed = 1;
5356 } else if (memcmp(buf, udev->serial, length) != 0) {
5357 dev_dbg(&udev->dev, "serial string changed\n");
5358 changed = 1;
5359 }
5360 }
5361
5362 kfree(buf);
5363 return changed;
5364 }
5365
5366 /**
5367 * usb_reset_and_verify_device - perform a USB port reset to reinitialize a device
5368 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5369 *
5370 * WARNING - don't use this routine to reset a composite device
5371 * (one with multiple interfaces owned by separate drivers)!
5372 * Use usb_reset_device() instead.
5373 *
5374 * Do a port reset, reassign the device's address, and establish its
5375 * former operating configuration. If the reset fails, or the device's
5376 * descriptors change from their values before the reset, or the original
5377 * configuration and altsettings cannot be restored, a flag will be set
5378 * telling khubd to pretend the device has been disconnected and then
5379 * re-connected. All drivers will be unbound, and the device will be
5380 * re-enumerated and probed all over again.
5381 *
5382 * Returns 0 if the reset succeeded, -ENODEV if the device has been
5383 * flagged for logical disconnection, or some other negative error code
5384 * if the reset wasn't even attempted.
5385 *
5386 * The caller must own the device lock. For example, it's safe to use
5387 * this from a driver probe() routine after downloading new firmware.
5388 * For calls that might not occur during probe(), drivers should lock
5389 * the device using usb_lock_device_for_reset().
5390 *
5391 * Locking exception: This routine may also be called from within an
5392 * autoresume handler. Such usage won't conflict with other tasks
5393 * holding the device lock because these tasks should always call
5394 * usb_autopm_resume_device(), thereby preventing any unwanted autoresume.
5395 */
5396 static int usb_reset_and_verify_device(struct usb_device *udev)
5397 {
5398 struct usb_device *parent_hdev = udev->parent;
5399 struct usb_hub *parent_hub;
5400 struct usb_hcd *hcd = bus_to_hcd(udev->bus);
5401 struct usb_device_descriptor descriptor = udev->descriptor;
5402 int i, ret = 0;
5403 int port1 = udev->portnum;
5404
5405 MYDBG("");
5406 if (udev->state == USB_STATE_NOTATTACHED ||
5407 udev->state == USB_STATE_SUSPENDED) {
5408 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5409 udev->state);
5410 return -EINVAL;
5411 }
5412
5413 if (!parent_hdev) {
5414 /* this requires hcd-specific logic; see ohci_restart() */
5415 dev_dbg(&udev->dev, "%s for root hub!\n", __func__);
5416 return -EISDIR;
5417 }
5418 parent_hub = usb_hub_to_struct_hub(parent_hdev);
5419
5420 /* Disable LPM and LTM while we reset the device and reinstall the alt
5421 * settings. Device-initiated LPM settings, and system exit latency
5422 * settings are cleared when the device is reset, so we have to set
5423 * them up again.
5424 */
5425 ret = usb_unlocked_disable_lpm(udev);
5426 if (ret) {
5427 dev_err(&udev->dev, "%s Failed to disable LPM\n.", __func__);
5428 goto re_enumerate;
5429 }
5430 ret = usb_disable_ltm(udev);
5431 if (ret) {
5432 dev_err(&udev->dev, "%s Failed to disable LTM\n.",
5433 __func__);
5434 goto re_enumerate;
5435 }
5436
5437 set_bit(port1, parent_hub->busy_bits);
5438 for (i = 0; i < SET_CONFIG_TRIES; ++i) {
5439
5440 /* ep0 maxpacket size may change; let the HCD know about it.
5441 * Other endpoints will be handled by re-enumeration. */
5442 usb_ep0_reinit(udev);
5443 ret = hub_port_init(parent_hub, udev, port1, i);
5444 if (ret >= 0 || ret == -ENOTCONN || ret == -ENODEV)
5445 break;
5446 }
5447 clear_bit(port1, parent_hub->busy_bits);
5448
5449 if (ret < 0)
5450 goto re_enumerate;
5451
5452 /* Device might have changed firmware (DFU or similar) */
5453 if (descriptors_changed(udev, &descriptor)) {
5454 dev_info(&udev->dev, "device firmware changed\n");
5455 udev->descriptor = descriptor; /* for disconnect() calls */
5456 goto re_enumerate;
5457 }
5458
5459 /* Restore the device's previous configuration */
5460 if (!udev->actconfig)
5461 goto done;
5462
5463 mutex_lock(hcd->bandwidth_mutex);
5464 ret = usb_hcd_alloc_bandwidth(udev, udev->actconfig, NULL, NULL);
5465 if (ret < 0) {
5466 dev_warn(&udev->dev,
5467 "Busted HC? Not enough HCD resources for "
5468 "old configuration.\n");
5469 mutex_unlock(hcd->bandwidth_mutex);
5470 goto re_enumerate;
5471 }
5472 ret = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
5473 USB_REQ_SET_CONFIGURATION, 0,
5474 udev->actconfig->desc.bConfigurationValue, 0,
5475 NULL, 0, USB_CTRL_SET_TIMEOUT);
5476 if (ret < 0) {
5477 dev_err(&udev->dev,
5478 "can't restore configuration #%d (error=%d)\n",
5479 udev->actconfig->desc.bConfigurationValue, ret);
5480 mutex_unlock(hcd->bandwidth_mutex);
5481 goto re_enumerate;
5482 }
5483 mutex_unlock(hcd->bandwidth_mutex);
5484 usb_set_device_state(udev, USB_STATE_CONFIGURED);
5485
5486 /* Put interfaces back into the same altsettings as before.
5487 * Don't bother to send the Set-Interface request for interfaces
5488 * that were already in altsetting 0; besides being unnecessary,
5489 * many devices can't handle it. Instead just reset the host-side
5490 * endpoint state.
5491 */
5492 for (i = 0; i < udev->actconfig->desc.bNumInterfaces; i++) {
5493 struct usb_host_config *config = udev->actconfig;
5494 struct usb_interface *intf = config->interface[i];
5495 struct usb_interface_descriptor *desc;
5496
5497 desc = &intf->cur_altsetting->desc;
5498 if (desc->bAlternateSetting == 0) {
5499 usb_disable_interface(udev, intf, true);
5500 usb_enable_interface(udev, intf, true);
5501 ret = 0;
5502 } else {
5503 /* Let the bandwidth allocation function know that this
5504 * device has been reset, and it will have to use
5505 * alternate setting 0 as the current alternate setting.
5506 */
5507 intf->resetting_device = 1;
5508 ret = usb_set_interface(udev, desc->bInterfaceNumber,
5509 desc->bAlternateSetting);
5510 intf->resetting_device = 0;
5511 }
5512 if (ret < 0) {
5513 dev_err(&udev->dev, "failed to restore interface %d "
5514 "altsetting %d (error=%d)\n",
5515 desc->bInterfaceNumber,
5516 desc->bAlternateSetting,
5517 ret);
5518 goto re_enumerate;
5519 }
5520 }
5521
5522 done:
5523 /* Now that the alt settings are re-installed, enable LTM and LPM. */
5524 usb_unlocked_enable_lpm(udev);
5525 usb_enable_ltm(udev);
5526 return 0;
5527
5528 re_enumerate:
5529 /* LPM state doesn't matter when we're about to destroy the device. */
5530 hub_port_logical_disconnect(parent_hub, port1);
5531 return -ENODEV;
5532 }
5533
5534 /**
5535 * usb_reset_device - warn interface drivers and perform a USB port reset
5536 * @udev: device to reset (not in SUSPENDED or NOTATTACHED state)
5537 *
5538 * Warns all drivers bound to registered interfaces (using their pre_reset
5539 * method), performs the port reset, and then lets the drivers know that
5540 * the reset is over (using their post_reset method).
5541 *
5542 * Return value is the same as for usb_reset_and_verify_device().
5543 *
5544 * The caller must own the device lock. For example, it's safe to use
5545 * this from a driver probe() routine after downloading new firmware.
5546 * For calls that might not occur during probe(), drivers should lock
5547 * the device using usb_lock_device_for_reset().
5548 *
5549 * If an interface is currently being probed or disconnected, we assume
5550 * its driver knows how to handle resets. For all other interfaces,
5551 * if the driver doesn't have pre_reset and post_reset methods then
5552 * we attempt to unbind it and rebind afterward.
5553 */
5554 int usb_reset_device(struct usb_device *udev)
5555 {
5556 int ret;
5557 int i;
5558 unsigned int noio_flag;
5559 struct usb_host_config *config = udev->actconfig;
5560
5561 MYDBG("");
5562 if (udev->state == USB_STATE_NOTATTACHED ||
5563 udev->state == USB_STATE_SUSPENDED) {
5564 dev_dbg(&udev->dev, "device reset not allowed in state %d\n",
5565 udev->state);
5566 return -EINVAL;
5567 }
5568
5569 /*
5570 * Don't allocate memory with GFP_KERNEL in current
5571 * context to avoid possible deadlock if usb mass
5572 * storage interface or usbnet interface(iSCSI case)
5573 * is included in current configuration. The easist
5574 * approach is to do it for every device reset,
5575 * because the device 'memalloc_noio' flag may have
5576 * not been set before reseting the usb device.
5577 */
5578 noio_flag = memalloc_noio_save();
5579
5580 /* Prevent autosuspend during the reset */
5581 usb_autoresume_device(udev);
5582
5583 if (config) {
5584 for (i = 0; i < config->desc.bNumInterfaces; ++i) {
5585 struct usb_interface *cintf = config->interface[i];
5586 struct usb_driver *drv;
5587 int unbind = 0;
5588
5589 if (cintf->dev.driver) {
5590 drv = to_usb_driver(cintf->dev.driver);
5591 if (drv->pre_reset && drv->post_reset)
5592 unbind = (drv->pre_reset)(cintf);
5593 else if (cintf->condition ==
5594 USB_INTERFACE_BOUND)
5595 unbind = 1;
5596 if (unbind)
5597 usb_forced_unbind_intf(cintf);
5598 }
5599 }
5600 }
5601
5602 ret = usb_reset_and_verify_device(udev);
5603
5604 if (config) {
5605 for (i = config->desc.bNumInterfaces - 1; i >= 0; --i) {
5606 struct usb_interface *cintf = config->interface[i];
5607 struct usb_driver *drv;
5608 int rebind = cintf->needs_binding;
5609
5610 if (!rebind && cintf->dev.driver) {
5611 drv = to_usb_driver(cintf->dev.driver);
5612 if (drv->post_reset)
5613 rebind = (drv->post_reset)(cintf);
5614 else if (cintf->condition ==
5615 USB_INTERFACE_BOUND)
5616 rebind = 1;
5617 if (rebind)
5618 cintf->needs_binding = 1;
5619 }
5620 }
5621 usb_unbind_and_rebind_marked_interfaces(udev);
5622 }
5623
5624 usb_autosuspend_device(udev);
5625 memalloc_noio_restore(noio_flag);
5626 return ret;
5627 }
5628 EXPORT_SYMBOL_GPL(usb_reset_device);
5629
5630
5631 /**
5632 * usb_queue_reset_device - Reset a USB device from an atomic context
5633 * @iface: USB interface belonging to the device to reset
5634 *
5635 * This function can be used to reset a USB device from an atomic
5636 * context, where usb_reset_device() won't work (as it blocks).
5637 *
5638 * Doing a reset via this method is functionally equivalent to calling
5639 * usb_reset_device(), except for the fact that it is delayed to a
5640 * workqueue. This means that any drivers bound to other interfaces
5641 * might be unbound, as well as users from usbfs in user space.
5642 *
5643 * Corner cases:
5644 *
5645 * - Scheduling two resets at the same time from two different drivers
5646 * attached to two different interfaces of the same device is
5647 * possible; depending on how the driver attached to each interface
5648 * handles ->pre_reset(), the second reset might happen or not.
5649 *
5650 * - If a driver is unbound and it had a pending reset, the reset will
5651 * be cancelled.
5652 *
5653 * - This function can be called during .probe() or .disconnect()
5654 * times. On return from .disconnect(), any pending resets will be
5655 * cancelled.
5656 *
5657 * There is no no need to lock/unlock the @reset_ws as schedule_work()
5658 * does its own.
5659 *
5660 * NOTE: We don't do any reference count tracking because it is not
5661 * needed. The lifecycle of the work_struct is tied to the
5662 * usb_interface. Before destroying the interface we cancel the
5663 * work_struct, so the fact that work_struct is queued and or
5664 * running means the interface (and thus, the device) exist and
5665 * are referenced.
5666 */
5667 void usb_queue_reset_device(struct usb_interface *iface)
5668 {
5669 schedule_work(&iface->reset_ws);
5670 }
5671 EXPORT_SYMBOL_GPL(usb_queue_reset_device);
5672
5673 /**
5674 * usb_hub_find_child - Get the pointer of child device
5675 * attached to the port which is specified by @port1.
5676 * @hdev: USB device belonging to the usb hub
5677 * @port1: port num to indicate which port the child device
5678 * is attached to.
5679 *
5680 * USB drivers call this function to get hub's child device
5681 * pointer.
5682 *
5683 * Return NULL if input param is invalid and
5684 * child's usb_device pointer if non-NULL.
5685 */
5686 struct usb_device *usb_hub_find_child(struct usb_device *hdev,
5687 int port1)
5688 {
5689 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5690
5691 if (port1 < 1 || port1 > hdev->maxchild)
5692 return NULL;
5693 return hub->ports[port1 - 1]->child;
5694 }
5695 EXPORT_SYMBOL_GPL(usb_hub_find_child);
5696
5697 /**
5698 * usb_set_hub_port_connect_type - set hub port connect type.
5699 * @hdev: USB device belonging to the usb hub
5700 * @port1: port num of the port
5701 * @type: connect type of the port
5702 */
5703 void usb_set_hub_port_connect_type(struct usb_device *hdev, int port1,
5704 enum usb_port_connect_type type)
5705 {
5706 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5707
5708 hub->ports[port1 - 1]->connect_type = type;
5709 }
5710
5711 /**
5712 * usb_get_hub_port_connect_type - Get the port's connect type
5713 * @hdev: USB device belonging to the usb hub
5714 * @port1: port num of the port
5715 *
5716 * Return connect type of the port and if input params are
5717 * invalid, return USB_PORT_CONNECT_TYPE_UNKNOWN.
5718 */
5719 enum usb_port_connect_type
5720 usb_get_hub_port_connect_type(struct usb_device *hdev, int port1)
5721 {
5722 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5723
5724 return hub->ports[port1 - 1]->connect_type;
5725 }
5726
5727 void usb_hub_adjust_deviceremovable(struct usb_device *hdev,
5728 struct usb_hub_descriptor *desc)
5729 {
5730 enum usb_port_connect_type connect_type;
5731 int i;
5732
5733 if (!hub_is_superspeed(hdev)) {
5734 for (i = 1; i <= hdev->maxchild; i++) {
5735 connect_type = usb_get_hub_port_connect_type(hdev, i);
5736
5737 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5738 u8 mask = 1 << (i%8);
5739
5740 if (!(desc->u.hs.DeviceRemovable[i/8] & mask)) {
5741 dev_dbg(&hdev->dev, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5742 i);
5743 desc->u.hs.DeviceRemovable[i/8] |= mask;
5744 }
5745 }
5746 }
5747 } else {
5748 u16 port_removable = le16_to_cpu(desc->u.ss.DeviceRemovable);
5749
5750 for (i = 1; i <= hdev->maxchild; i++) {
5751 connect_type = usb_get_hub_port_connect_type(hdev, i);
5752
5753 if (connect_type == USB_PORT_CONNECT_TYPE_HARD_WIRED) {
5754 u16 mask = 1 << i;
5755
5756 if (!(port_removable & mask)) {
5757 dev_dbg(&hdev->dev, "usb port%d's DeviceRemovable is changed to 1 according to platform information.\n",
5758 i);
5759 port_removable |= mask;
5760 }
5761 }
5762 }
5763
5764 desc->u.ss.DeviceRemovable = cpu_to_le16(port_removable);
5765 }
5766 }
5767
5768 #ifdef CONFIG_ACPI
5769 /**
5770 * usb_get_hub_port_acpi_handle - Get the usb port's acpi handle
5771 * @hdev: USB device belonging to the usb hub
5772 * @port1: port num of the port
5773 *
5774 * Return port's acpi handle if successful, NULL if params are
5775 * invaild.
5776 */
5777 acpi_handle usb_get_hub_port_acpi_handle(struct usb_device *hdev,
5778 int port1)
5779 {
5780 struct usb_hub *hub = usb_hub_to_struct_hub(hdev);
5781
5782 return DEVICE_ACPI_HANDLE(&hub->ports[port1 - 1]->dev);
5783 }
5784 #endif