1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3 * Most of this source has been derived from the Linux USB
4 * project:
5 * (C) Copyright Linus Torvalds 1999
6 * (C) Copyright Johannes Erdfelt 1999-2001
7 * (C) Copyright Andreas Gal 1999
8 * (C) Copyright Gregory P. Smith 1999
9 * (C) Copyright Deti Fliegl 1999 (new USB architecture)
10 * (C) Copyright Randy Dunlap 2000
11 * (C) Copyright David Brownell 2000 (kernel hotplug, usb_device_id)
12 * (C) Copyright Yggdrasil Computing, Inc. 2000
13 * (usb_device_id matching changes by Adam J. Richter)
14 *
15 * Adapted for U-Boot:
16 * (C) Copyright 2001 Denis Peter, MPL AG Switzerland
17 */
18
19 /****************************************************************************
20 * HUB "Driver"
21 * Probes device for being a hub and configurate it
22 */
23
24 #include <common.h>
25 #include <command.h>
26 #include <dm.h>
27 #include <env.h>
28 #include <errno.h>
29 #include <memalign.h>
30 #include <asm/processor.h>
31 #include <asm/unaligned.h>
32 #include <linux/ctype.h>
33 #include <linux/list.h>
34 #include <asm/byteorder.h>
35 #ifdef CONFIG_SANDBOX
36 #include <asm/state.h>
37 #endif
38 #include <asm/unaligned.h>
39
40 #include <usb.h>
41
42 #define USB_BUFSIZ 512
43
44 #define HUB_SHORT_RESET_TIME 20
45 #define HUB_LONG_RESET_TIME 200
46
47 #define PORT_OVERCURRENT_MAX_SCAN_COUNT 3
48
49 struct usb_device_scan {
50 struct usb_device *dev; /* USB hub device to scan */
51 struct usb_hub_device *hub; /* USB hub struct */
52 int port; /* USB port to scan */
53 struct list_head list;
54 };
55
56 static LIST_HEAD(usb_scan_list);
57
usb_hub_reset_devices(struct usb_hub_device * hub,int port)58 __weak void usb_hub_reset_devices(struct usb_hub_device *hub, int port)
59 {
60 return;
61 }
62
usb_hub_is_superspeed(struct usb_device * hdev)63 static inline bool usb_hub_is_superspeed(struct usb_device *hdev)
64 {
65 return hdev->descriptor.bDeviceProtocol == 3;
66 }
67
68 #if CONFIG_IS_ENABLED(DM_USB)
usb_hub_is_root_hub(struct udevice * hub)69 bool usb_hub_is_root_hub(struct udevice *hub)
70 {
71 if (device_get_uclass_id(hub->parent) != UCLASS_USB_HUB)
72 return true;
73
74 return false;
75 }
76
usb_set_hub_depth(struct usb_device * dev,int depth)77 static int usb_set_hub_depth(struct usb_device *dev, int depth)
78 {
79 if (depth < 0 || depth > 4)
80 return -EINVAL;
81
82 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
83 USB_REQ_SET_HUB_DEPTH, USB_DIR_OUT | USB_RT_HUB,
84 depth, 0, NULL, 0, USB_CNTL_TIMEOUT);
85 }
86 #endif
87
usb_get_hub_descriptor(struct usb_device * dev,void * data,int size)88 static int usb_get_hub_descriptor(struct usb_device *dev, void *data, int size)
89 {
90 unsigned short dtype = USB_DT_HUB;
91
92 if (usb_hub_is_superspeed(dev))
93 dtype = USB_DT_SS_HUB;
94
95 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
96 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
97 dtype << 8, 0, data, size, USB_CNTL_TIMEOUT);
98 }
99
usb_clear_port_feature(struct usb_device * dev,int port,int feature)100 static int usb_clear_port_feature(struct usb_device *dev, int port, int feature)
101 {
102 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
103 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature,
104 port, NULL, 0, USB_CNTL_TIMEOUT);
105 }
106
usb_set_port_feature(struct usb_device * dev,int port,int feature)107 static int usb_set_port_feature(struct usb_device *dev, int port, int feature)
108 {
109 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
110 USB_REQ_SET_FEATURE, USB_RT_PORT, feature,
111 port, NULL, 0, USB_CNTL_TIMEOUT);
112 }
113
usb_get_hub_status(struct usb_device * dev,void * data)114 static int usb_get_hub_status(struct usb_device *dev, void *data)
115 {
116 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
117 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
118 data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
119 }
120
usb_get_port_status(struct usb_device * dev,int port,void * data)121 int usb_get_port_status(struct usb_device *dev, int port, void *data)
122 {
123 int ret;
124
125 ret = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
126 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port,
127 data, sizeof(struct usb_port_status), USB_CNTL_TIMEOUT);
128
129 #if CONFIG_IS_ENABLED(DM_USB)
130 if (ret < 0)
131 return ret;
132
133 /*
134 * Translate the USB 3.0 hub port status field into the old version
135 * that U-Boot understands. Do this only when the hub is not root hub.
136 * For root hub, the port status field has already been translated
137 * in the host controller driver (see xhci_submit_root() in xhci.c).
138 *
139 * Note: this only supports driver model.
140 */
141
142 if (!usb_hub_is_root_hub(dev->dev) && usb_hub_is_superspeed(dev)) {
143 struct usb_port_status *status = (struct usb_port_status *)data;
144 u16 tmp = (status->wPortStatus) & USB_SS_PORT_STAT_MASK;
145
146 if (status->wPortStatus & USB_SS_PORT_STAT_POWER)
147 tmp |= USB_PORT_STAT_POWER;
148 if ((status->wPortStatus & USB_SS_PORT_STAT_SPEED) ==
149 USB_SS_PORT_STAT_SPEED_5GBPS)
150 tmp |= USB_PORT_STAT_SUPER_SPEED;
151
152 status->wPortStatus = tmp;
153 }
154 #endif
155
156 return ret;
157 }
158
159
usb_hub_power_on(struct usb_hub_device * hub)160 static void usb_hub_power_on(struct usb_hub_device *hub)
161 {
162 int i;
163 struct usb_device *dev;
164 unsigned pgood_delay = hub->desc.bPwrOn2PwrGood * 2;
165 const char *env;
166
167 dev = hub->pusb_dev;
168
169 debug("enabling power on all ports\n");
170 for (i = 0; i < dev->maxchild; i++) {
171 usb_set_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
172 debug("port %d returns %lX\n", i + 1, dev->status);
173 }
174
175 #ifdef CONFIG_SANDBOX
176 /*
177 * Don't set timeout / delay values here. This results
178 * in these values still being reset to 0.
179 */
180 if (state_get_skip_delays())
181 return;
182 #endif
183
184 /*
185 * Wait for power to become stable,
186 * plus spec-defined max time for device to connect
187 * but allow this time to be increased via env variable as some
188 * devices break the spec and require longer warm-up times
189 */
190 env = env_get("usb_pgood_delay");
191 if (env)
192 pgood_delay = max(pgood_delay,
193 (unsigned)simple_strtol(env, NULL, 0));
194 debug("pgood_delay=%dms\n", pgood_delay);
195
196 /*
197 * Do a minimum delay of the larger value of 100ms or pgood_delay
198 * so that the power can stablize before the devices are queried
199 */
200 hub->query_delay = get_timer(0) + max(100, (int)pgood_delay);
201
202 /*
203 * Record the power-on timeout here. The max. delay (timeout)
204 * will be done based on this value in the USB port loop in
205 * usb_hub_configure() later.
206 */
207 hub->connect_timeout = hub->query_delay + 1000;
208 debug("devnum=%d poweron: query_delay=%d connect_timeout=%d\n",
209 dev->devnum, max(100, (int)pgood_delay),
210 max(100, (int)pgood_delay) + 1000);
211 }
212
213 #if !CONFIG_IS_ENABLED(DM_USB)
214 static struct usb_hub_device hub_dev[USB_MAX_HUB];
215 static int usb_hub_index;
216
usb_hub_reset(void)217 void usb_hub_reset(void)
218 {
219 usb_hub_index = 0;
220
221 /* Zero out global hub_dev in case its re-used again */
222 memset(hub_dev, 0, sizeof(hub_dev));
223 }
224
usb_hub_allocate(void)225 static struct usb_hub_device *usb_hub_allocate(void)
226 {
227 if (usb_hub_index < USB_MAX_HUB)
228 return &hub_dev[usb_hub_index++];
229
230 printf("ERROR: USB_MAX_HUB (%d) reached\n", USB_MAX_HUB);
231 return NULL;
232 }
233 #endif
234
235 #define MAX_TRIES 5
236
portspeed(int portstatus)237 static inline const char *portspeed(int portstatus)
238 {
239 switch (portstatus & USB_PORT_STAT_SPEED_MASK) {
240 case USB_PORT_STAT_SUPER_SPEED:
241 return "5 Gb/s";
242 case USB_PORT_STAT_HIGH_SPEED:
243 return "480 Mb/s";
244 case USB_PORT_STAT_LOW_SPEED:
245 return "1.5 Mb/s";
246 default:
247 return "12 Mb/s";
248 }
249 }
250
251 /**
252 * usb_hub_port_reset() - reset a port given its usb_device pointer
253 *
254 * Reset a hub port and see if a device is present on that port, providing
255 * sufficient time for it to show itself. The port status is returned.
256 *
257 * @dev: USB device to reset
258 * @port: Port number to reset (note ports are numbered from 0 here)
259 * @portstat: Returns port status
260 */
usb_hub_port_reset(struct usb_device * dev,int port,unsigned short * portstat)261 static int usb_hub_port_reset(struct usb_device *dev, int port,
262 unsigned short *portstat)
263 {
264 int err, tries;
265 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
266 unsigned short portstatus, portchange;
267 int delay = HUB_SHORT_RESET_TIME; /* start with short reset delay */
268
269 #if CONFIG_IS_ENABLED(DM_USB)
270 debug("%s: resetting '%s' port %d...\n", __func__, dev->dev->name,
271 port + 1);
272 #else
273 debug("%s: resetting port %d...\n", __func__, port + 1);
274 #endif
275 for (tries = 0; tries < MAX_TRIES; tries++) {
276 err = usb_set_port_feature(dev, port + 1, USB_PORT_FEAT_RESET);
277 if (err < 0)
278 return err;
279
280 mdelay(delay);
281
282 if (usb_get_port_status(dev, port + 1, portsts) < 0) {
283 debug("get_port_status failed status %lX\n",
284 dev->status);
285 return -1;
286 }
287 portstatus = le16_to_cpu(portsts->wPortStatus);
288 portchange = le16_to_cpu(portsts->wPortChange);
289
290 debug("portstatus %x, change %x, %s\n", portstatus, portchange,
291 portspeed(portstatus));
292
293 debug("STAT_C_CONNECTION = %d STAT_CONNECTION = %d" \
294 " USB_PORT_STAT_ENABLE %d\n",
295 (portchange & USB_PORT_STAT_C_CONNECTION) ? 1 : 0,
296 (portstatus & USB_PORT_STAT_CONNECTION) ? 1 : 0,
297 (portstatus & USB_PORT_STAT_ENABLE) ? 1 : 0);
298
299 if ((portchange & USB_PORT_STAT_C_CONNECTION) ||
300 !(portstatus & USB_PORT_STAT_CONNECTION)) {
301 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_CONNECTION);
302 usb_clear_port_feature(dev, port + 1, USB_PORT_STAT_CONNECTION);
303 continue;
304 }
305 /*
306 * Perhaps we should check for the following here:
307 * - C_CONNECTION hasn't been set.
308 * - CONNECTION is still set.
309 *
310 * Doing so would ensure that the device is still connected
311 * to the bus, and hasn't been unplugged or replaced while the
312 * USB bus reset was going on.
313 *
314 * However, if we do that, then (at least) a San Disk Ultra
315 * USB 3.0 16GB device fails to reset on (at least) an NVIDIA
316 * Tegra Jetson TK1 board. For some reason, the device appears
317 * to briefly drop off the bus when this second bus reset is
318 * executed, yet if we retry this loop, it'll eventually come
319 * back after another reset or two.
320 */
321
322 if (portstatus & USB_PORT_STAT_ENABLE)
323 break;
324
325 /* Switch to long reset delay for the next round */
326 delay = HUB_LONG_RESET_TIME;
327 mdelay(delay);
328 }
329
330 if (tries == MAX_TRIES) {
331 debug("Cannot enable port %i after %i retries, " \
332 "disabling port.\n", port + 1, MAX_TRIES);
333 debug("Maybe the USB cable is bad?\n");
334 return -1;
335 }
336
337 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_RESET);
338 *portstat = portstatus;
339 return 0;
340 }
341
usb_hub_port_connect_change(struct usb_device * dev,int port)342 int usb_hub_port_connect_change(struct usb_device *dev, int port)
343 {
344 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
345 unsigned short portstatus;
346 int ret, speed;
347 int retry_count = 0;
348
349 /* Check status */
350 re_enumerate:
351 ret = usb_get_port_status(dev, port + 1, portsts);
352 if (ret < 0) {
353 debug("get_port_status failed\n");
354 return ret;
355 }
356
357 portstatus = le16_to_cpu(portsts->wPortStatus);
358 debug("portstatus %x, change %x, %s\n",
359 portstatus,
360 le16_to_cpu(portsts->wPortChange),
361 portspeed(portstatus));
362
363 /* Clear the connection change status */
364 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_CONNECTION);
365
366 /* Disconnect any existing devices under this port */
367 if (((!(portstatus & USB_PORT_STAT_CONNECTION)) &&
368 (!(portstatus & USB_PORT_STAT_ENABLE))) ||
369 usb_device_has_child_on_port(dev, port)) {
370 debug("usb_disconnect(&hub->children[port]);\n");
371 /* Return now if nothing is connected */
372 if (!(portstatus & USB_PORT_STAT_CONNECTION))
373 return -ENOTCONN;
374 }
375
376 /* Reset the port */
377 ret = usb_hub_port_reset(dev, port, &portstatus);
378 if (ret < 0) {
379 if (ret != -ENXIO)
380 printf("cannot reset port %i!?\n", port + 1);
381 goto port_reset;
382 }
383
384 switch (portstatus & USB_PORT_STAT_SPEED_MASK) {
385 case USB_PORT_STAT_SUPER_SPEED:
386 speed = USB_SPEED_SUPER;
387 break;
388 case USB_PORT_STAT_HIGH_SPEED:
389 speed = USB_SPEED_HIGH;
390 break;
391 case USB_PORT_STAT_LOW_SPEED:
392 speed = USB_SPEED_LOW;
393 break;
394 default:
395 speed = USB_SPEED_FULL;
396 break;
397 }
398
399 #if CONFIG_IS_ENABLED(DM_USB)
400 struct udevice *child;
401
402 ret = usb_scan_device(dev->dev, port + 1, speed, &child);
403 #else
404 struct usb_device *usb;
405
406 ret = usb_alloc_new_device(dev->controller, &usb);
407 if (ret) {
408 printf("cannot create new device: ret=%d", ret);
409 return ret;
410 }
411
412 dev->children[port] = usb;
413 usb->speed = speed;
414 usb->parent = dev;
415 usb->portnr = port + 1;
416 /* Run it through the hoops (find a driver, etc) */
417 ret = usb_new_device(usb);
418 if (ret < 0) {
419 /* Woops, disable the port */
420 usb_free_device(dev->controller);
421 dev->children[port] = NULL;
422 }
423 #endif
424 if (ret < 0) {
425 debug("hub: disabling port %d\n", port + 1);
426 port_reset:
427 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_ENABLE);
428 retry_count++;
429 if (retry_count <= 5) {
430 usb_set_port_feature(dev, port + 1, USB_PORT_FEAT_RESET);
431 mdelay(1000);
432 goto re_enumerate;
433 }
434 }
435
436 return ret;
437 }
438
usb_scan_port(struct usb_device_scan * usb_scan)439 static int usb_scan_port(struct usb_device_scan *usb_scan)
440 {
441 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
442 unsigned short portstatus;
443 unsigned short portchange;
444 struct usb_device *dev;
445 struct usb_hub_device *hub;
446 int ret = 0;
447 int i;
448
449 dev = usb_scan->dev;
450 hub = usb_scan->hub;
451 i = usb_scan->port;
452
453 /*
454 * Don't talk to the device before the query delay is expired.
455 * This is needed for voltages to stabalize.
456 */
457 if (get_timer(0) < hub->query_delay)
458 return 0;
459
460 ret = usb_get_port_status(dev, i + 1, portsts);
461 if (ret < 0) {
462 debug("get_port_status failed\n");
463 if (get_timer(0) >= hub->connect_timeout) {
464 debug("devnum=%d port=%d: timeout\n",
465 dev->devnum, i + 1);
466 /* Remove this device from scanning list */
467 list_del(&usb_scan->list);
468 free(usb_scan);
469 return 0;
470 }
471 return 0;
472 }
473
474 portstatus = le16_to_cpu(portsts->wPortStatus);
475 portchange = le16_to_cpu(portsts->wPortChange);
476 debug("Port %d Status %X Change %X\n", i + 1, portstatus, portchange);
477
478 /*
479 * No connection change happened, wait a bit more.
480 *
481 * For some situation, the hub reports no connection change but a
482 * device is connected to the port (eg: CCS bit is set but CSC is not
483 * in the PORTSC register of a root hub), ignore such case.
484 */
485 if (!(portchange & USB_PORT_STAT_C_CONNECTION) &&
486 !(portstatus & USB_PORT_STAT_CONNECTION)) {
487 if (get_timer(0) >= hub->connect_timeout) {
488 debug("devnum=%d port=%d: timeout\n",
489 dev->devnum, i + 1);
490 /* Remove this device from scanning list */
491 list_del(&usb_scan->list);
492 free(usb_scan);
493 return 0;
494 }
495 return 0;
496 }
497
498 if (portchange & USB_PORT_STAT_C_RESET) {
499 debug("port %d reset change\n", i + 1);
500 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_C_RESET);
501 }
502
503 if ((portchange & USB_SS_PORT_STAT_C_BH_RESET) &&
504 usb_hub_is_superspeed(dev)) {
505 debug("port %d BH reset change\n", i + 1);
506 usb_clear_port_feature(dev, i + 1, USB_SS_PORT_FEAT_C_BH_RESET);
507 }
508
509 /* A new USB device is ready at this point */
510 debug("devnum=%d port=%d: USB dev found\n", dev->devnum, i + 1);
511
512 usb_hub_port_connect_change(dev, i);
513
514 if (portchange & USB_PORT_STAT_C_ENABLE) {
515 debug("port %d enable change, status %x\n", i + 1, portstatus);
516 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_C_ENABLE);
517 /*
518 * The following hack causes a ghost device problem
519 * to Faraday EHCI
520 */
521 #ifndef CONFIG_USB_EHCI_FARADAY
522 /*
523 * EM interference sometimes causes bad shielded USB
524 * devices to be shutdown by the hub, this hack enables
525 * them again. Works at least with mouse driver
526 */
527 if (!(portstatus & USB_PORT_STAT_ENABLE) &&
528 (portstatus & USB_PORT_STAT_CONNECTION) &&
529 usb_device_has_child_on_port(dev, i)) {
530 debug("already running port %i disabled by hub (EMI?), re-enabling...\n",
531 i + 1);
532 usb_hub_port_connect_change(dev, i);
533 }
534 #endif
535 }
536
537 if (portstatus & USB_PORT_STAT_SUSPEND) {
538 debug("port %d suspend change\n", i + 1);
539 usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_SUSPEND);
540 }
541
542 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
543 debug("port %d over-current change\n", i + 1);
544 usb_clear_port_feature(dev, i + 1,
545 USB_PORT_FEAT_C_OVER_CURRENT);
546 /* Only power-on this one port */
547 usb_set_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
548 hub->overcurrent_count[i]++;
549
550 /*
551 * If the max-scan-count is not reached, return without removing
552 * the device from scan-list. This will re-issue a new scan.
553 */
554 if (hub->overcurrent_count[i] <=
555 PORT_OVERCURRENT_MAX_SCAN_COUNT)
556 return 0;
557
558 /* Otherwise the device will get removed */
559 printf("Port %d over-current occurred %d times\n", i + 1,
560 hub->overcurrent_count[i]);
561 }
562
563 /*
564 * We're done with this device, so let's remove this device from
565 * scanning list
566 */
567 list_del(&usb_scan->list);
568 free(usb_scan);
569
570 return 0;
571 }
572
usb_device_list_scan(void)573 static int usb_device_list_scan(void)
574 {
575 struct usb_device_scan *usb_scan;
576 struct usb_device_scan *tmp;
577 static int running;
578 int ret = 0;
579
580 /* Only run this loop once for each controller */
581 if (running)
582 return 0;
583
584 running = 1;
585
586 while (1) {
587 /* We're done, once the list is empty again */
588 if (list_empty(&usb_scan_list))
589 goto out;
590
591 list_for_each_entry_safe(usb_scan, tmp, &usb_scan_list, list) {
592 int ret;
593
594 /* Scan this port */
595 ret = usb_scan_port(usb_scan);
596 if (ret)
597 goto out;
598 }
599 }
600
601 out:
602 /*
603 * This USB controller has finished scanning all its connected
604 * USB devices. Set "running" back to 0, so that other USB controllers
605 * will scan their devices too.
606 */
607 running = 0;
608
609 return ret;
610 }
611
usb_get_hub_device(struct usb_device * dev)612 static struct usb_hub_device *usb_get_hub_device(struct usb_device *dev)
613 {
614 struct usb_hub_device *hub;
615
616 #if !CONFIG_IS_ENABLED(DM_USB)
617 /* "allocate" Hub device */
618 hub = usb_hub_allocate();
619 #else
620 hub = dev_get_uclass_priv(dev->dev);
621 #endif
622
623 return hub;
624 }
625
usb_hub_configure(struct usb_device * dev)626 static int usb_hub_configure(struct usb_device *dev)
627 {
628 int i, length;
629 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer, USB_BUFSIZ);
630 unsigned char *bitmap;
631 short hubCharacteristics;
632 struct usb_hub_descriptor *descriptor;
633 struct usb_hub_device *hub;
634 struct usb_hub_status *hubsts;
635 int ret;
636
637 hub = usb_get_hub_device(dev);
638 if (hub == NULL)
639 return -ENOMEM;
640 hub->pusb_dev = dev;
641
642 /* Get the the hub descriptor */
643 ret = usb_get_hub_descriptor(dev, buffer, 4);
644 if (ret < 0) {
645 debug("usb_hub_configure: failed to get hub " \
646 "descriptor, giving up %lX\n", dev->status);
647 return ret;
648 }
649 descriptor = (struct usb_hub_descriptor *)buffer;
650
651 length = min_t(int, descriptor->bLength,
652 sizeof(struct usb_hub_descriptor));
653
654 ret = usb_get_hub_descriptor(dev, buffer, length);
655 if (ret < 0) {
656 debug("usb_hub_configure: failed to get hub " \
657 "descriptor 2nd giving up %lX\n", dev->status);
658 return ret;
659 }
660 memcpy((unsigned char *)&hub->desc, buffer, length);
661 /* adjust 16bit values */
662 put_unaligned(le16_to_cpu(get_unaligned(
663 &descriptor->wHubCharacteristics)),
664 &hub->desc.wHubCharacteristics);
665 /* set the bitmap */
666 bitmap = (unsigned char *)&hub->desc.u.hs.DeviceRemovable[0];
667 /* devices not removable by default */
668 memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8);
669 bitmap = (unsigned char *)&hub->desc.u.hs.PortPowerCtrlMask[0];
670 memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8); /* PowerMask = 1B */
671
672 for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
673 hub->desc.u.hs.DeviceRemovable[i] =
674 descriptor->u.hs.DeviceRemovable[i];
675
676 for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
677 hub->desc.u.hs.PortPowerCtrlMask[i] =
678 descriptor->u.hs.PortPowerCtrlMask[i];
679
680 dev->maxchild = descriptor->bNbrPorts;
681 debug("%d ports detected\n", dev->maxchild);
682
683 hubCharacteristics = get_unaligned(&hub->desc.wHubCharacteristics);
684 switch (hubCharacteristics & HUB_CHAR_LPSM) {
685 case 0x00:
686 debug("ganged power switching\n");
687 break;
688 case 0x01:
689 debug("individual port power switching\n");
690 break;
691 case 0x02:
692 case 0x03:
693 debug("unknown reserved power switching mode\n");
694 break;
695 }
696
697 if (hubCharacteristics & HUB_CHAR_COMPOUND)
698 debug("part of a compound device\n");
699 else
700 debug("standalone hub\n");
701
702 switch (hubCharacteristics & HUB_CHAR_OCPM) {
703 case 0x00:
704 debug("global over-current protection\n");
705 break;
706 case 0x08:
707 debug("individual port over-current protection\n");
708 break;
709 case 0x10:
710 case 0x18:
711 debug("no over-current protection\n");
712 break;
713 }
714
715 switch (dev->descriptor.bDeviceProtocol) {
716 case USB_HUB_PR_FS:
717 break;
718 case USB_HUB_PR_HS_SINGLE_TT:
719 debug("Single TT\n");
720 break;
721 case USB_HUB_PR_HS_MULTI_TT:
722 ret = usb_set_interface(dev, 0, 1);
723 if (ret == 0) {
724 debug("TT per port\n");
725 hub->tt.multi = true;
726 } else {
727 debug("Using single TT (err %d)\n", ret);
728 }
729 break;
730 case USB_HUB_PR_SS:
731 /* USB 3.0 hubs don't have a TT */
732 break;
733 default:
734 debug("Unrecognized hub protocol %d\n",
735 dev->descriptor.bDeviceProtocol);
736 break;
737 }
738
739 /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */
740 switch (hubCharacteristics & HUB_CHAR_TTTT) {
741 case HUB_TTTT_8_BITS:
742 if (dev->descriptor.bDeviceProtocol != 0) {
743 hub->tt.think_time = 666;
744 debug("TT requires at most %d FS bit times (%d ns)\n",
745 8, hub->tt.think_time);
746 }
747 break;
748 case HUB_TTTT_16_BITS:
749 hub->tt.think_time = 666 * 2;
750 debug("TT requires at most %d FS bit times (%d ns)\n",
751 16, hub->tt.think_time);
752 break;
753 case HUB_TTTT_24_BITS:
754 hub->tt.think_time = 666 * 3;
755 debug("TT requires at most %d FS bit times (%d ns)\n",
756 24, hub->tt.think_time);
757 break;
758 case HUB_TTTT_32_BITS:
759 hub->tt.think_time = 666 * 4;
760 debug("TT requires at most %d FS bit times (%d ns)\n",
761 32, hub->tt.think_time);
762 break;
763 }
764
765 debug("power on to power good time: %dms\n",
766 descriptor->bPwrOn2PwrGood * 2);
767 debug("hub controller current requirement: %dmA\n",
768 descriptor->bHubContrCurrent);
769
770 for (i = 0; i < dev->maxchild; i++)
771 debug("port %d is%s removable\n", i + 1,
772 hub->desc.u.hs.DeviceRemovable[(i + 1) / 8] & \
773 (1 << ((i + 1) % 8)) ? " not" : "");
774
775 if (sizeof(struct usb_hub_status) > USB_BUFSIZ) {
776 debug("usb_hub_configure: failed to get Status - " \
777 "too long: %d\n", descriptor->bLength);
778 return -EFBIG;
779 }
780
781 ret = usb_get_hub_status(dev, buffer);
782 if (ret < 0) {
783 debug("usb_hub_configure: failed to get Status %lX\n",
784 dev->status);
785 return ret;
786 }
787
788 hubsts = (struct usb_hub_status *)buffer;
789
790 debug("get_hub_status returned status %X, change %X\n",
791 le16_to_cpu(hubsts->wHubStatus),
792 le16_to_cpu(hubsts->wHubChange));
793 debug("local power source is %s\n",
794 (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_LOCAL_POWER) ? \
795 "lost (inactive)" : "good");
796 debug("%sover-current condition exists\n",
797 (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_OVERCURRENT) ? \
798 "" : "no ");
799
800 #if CONFIG_IS_ENABLED(DM_USB)
801 /*
802 * Update USB host controller's internal representation of this hub
803 * after the hub descriptor is fetched.
804 */
805 ret = usb_update_hub_device(dev);
806 if (ret < 0 && ret != -ENOSYS) {
807 debug("%s: failed to update hub device for HCD (%x)\n",
808 __func__, ret);
809 return ret;
810 }
811
812 /*
813 * A maximum of seven tiers are allowed in a USB topology, and the
814 * root hub occupies the first tier. The last tier ends with a normal
815 * USB device. USB 3.0 hubs use a 20-bit field called 'route string'
816 * to route packets to the designated downstream port. The hub uses a
817 * hub depth value multiplied by four as an offset into the 'route
818 * string' to locate the bits it uses to determine the downstream
819 * port number.
820 */
821 if (usb_hub_is_root_hub(dev->dev)) {
822 hub->hub_depth = -1;
823 } else {
824 struct udevice *hdev;
825 int depth = 0;
826
827 hdev = dev->dev->parent;
828 while (!usb_hub_is_root_hub(hdev)) {
829 depth++;
830 hdev = hdev->parent;
831 }
832
833 hub->hub_depth = depth;
834
835 if (usb_hub_is_superspeed(dev)) {
836 debug("set hub (%p) depth to %d\n", dev, depth);
837 /*
838 * This request sets the value that the hub uses to
839 * determine the index into the 'route string index'
840 * for this hub.
841 */
842 ret = usb_set_hub_depth(dev, depth);
843 if (ret < 0) {
844 debug("%s: failed to set hub depth (%lX)\n",
845 __func__, dev->status);
846 return ret;
847 }
848 }
849 }
850 #endif
851
852 usb_hub_power_on(hub);
853
854 /*
855 * Reset any devices that may be in a bad state when applying
856 * the power. This is a __weak function. Resetting of the devices
857 * should occur in the board file of the device.
858 */
859 for (i = 0; i < dev->maxchild; i++)
860 usb_hub_reset_devices(hub, i + 1);
861
862 /*
863 * Only add the connected USB devices, including potential hubs,
864 * to a scanning list. This list will get scanned and devices that
865 * are detected (either via port connected or via port timeout)
866 * will get removed from this list. Scanning of the devices on this
867 * list will continue until all devices are removed.
868 */
869 for (i = 0; i < dev->maxchild; i++) {
870 struct usb_device_scan *usb_scan;
871
872 usb_scan = calloc(1, sizeof(*usb_scan));
873 if (!usb_scan) {
874 printf("Can't allocate memory for USB device!\n");
875 return -ENOMEM;
876 }
877 usb_scan->dev = dev;
878 usb_scan->hub = hub;
879 usb_scan->port = i;
880 list_add_tail(&usb_scan->list, &usb_scan_list);
881 }
882
883 /*
884 * And now call the scanning code which loops over the generated list
885 */
886 ret = usb_device_list_scan();
887
888 return ret;
889 }
890
usb_hub_check(struct usb_device * dev,int ifnum)891 static int usb_hub_check(struct usb_device *dev, int ifnum)
892 {
893 struct usb_interface *iface;
894 struct usb_endpoint_descriptor *ep = NULL;
895
896 iface = &dev->config.if_desc[ifnum];
897 /* Is it a hub? */
898 if (iface->desc.bInterfaceClass != USB_CLASS_HUB)
899 goto err;
900 /* Some hubs have a subclass of 1, which AFAICT according to the */
901 /* specs is not defined, but it works */
902 if ((iface->desc.bInterfaceSubClass != 0) &&
903 (iface->desc.bInterfaceSubClass != 1))
904 goto err;
905 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
906 if (iface->desc.bNumEndpoints != 1)
907 goto err;
908 ep = &iface->ep_desc[0];
909 /* Output endpoint? Curiousier and curiousier.. */
910 if (!(ep->bEndpointAddress & USB_DIR_IN))
911 goto err;
912 /* If it's not an interrupt endpoint, we'd better punt! */
913 if ((ep->bmAttributes & 3) != 3)
914 goto err;
915 /* We found a hub */
916 debug("USB hub found\n");
917 return 0;
918
919 err:
920 debug("USB hub not found: bInterfaceClass=%d, bInterfaceSubClass=%d, bNumEndpoints=%d\n",
921 iface->desc.bInterfaceClass, iface->desc.bInterfaceSubClass,
922 iface->desc.bNumEndpoints);
923 if (ep) {
924 debug(" bEndpointAddress=%#x, bmAttributes=%d",
925 ep->bEndpointAddress, ep->bmAttributes);
926 }
927
928 return -ENOENT;
929 }
930
usb_hub_probe(struct usb_device * dev,int ifnum)931 int usb_hub_probe(struct usb_device *dev, int ifnum)
932 {
933 int ret;
934
935 ret = usb_hub_check(dev, ifnum);
936 if (ret)
937 return 0;
938 ret = usb_hub_configure(dev);
939 return ret;
940 }
941
942 #if CONFIG_IS_ENABLED(DM_USB)
usb_hub_scan(struct udevice * hub)943 int usb_hub_scan(struct udevice *hub)
944 {
945 struct usb_device *udev = dev_get_parent_priv(hub);
946
947 return usb_hub_configure(udev);
948 }
949
usb_hub_post_probe(struct udevice * dev)950 static int usb_hub_post_probe(struct udevice *dev)
951 {
952 debug("%s\n", __func__);
953 return usb_hub_scan(dev);
954 }
955
956 static const struct udevice_id usb_hub_ids[] = {
957 { .compatible = "usb-hub" },
958 { }
959 };
960
961 U_BOOT_DRIVER(usb_generic_hub) = {
962 .name = "usb_hub",
963 .id = UCLASS_USB_HUB,
964 .of_match = usb_hub_ids,
965 .flags = DM_FLAG_ALLOC_PRIV_DMA,
966 };
967
968 UCLASS_DRIVER(usb_hub) = {
969 .id = UCLASS_USB_HUB,
970 .name = "usb_hub",
971 .post_bind = dm_scan_fdt_dev,
972 .post_probe = usb_hub_post_probe,
973 .child_pre_probe = usb_child_pre_probe,
974 .per_child_auto_alloc_size = sizeof(struct usb_device),
975 .per_child_platdata_auto_alloc_size = sizeof(struct usb_dev_platdata),
976 .per_device_auto_alloc_size = sizeof(struct usb_hub_device),
977 };
978
979 static const struct usb_device_id hub_id_table[] = {
980 {
981 .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS,
982 .bDeviceClass = USB_CLASS_HUB
983 },
984 { } /* Terminating entry */
985 };
986
987 U_BOOT_USB_DEVICE(usb_generic_hub, hub_id_table);
988
989 #endif
990