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