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