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