]>
Commit | Line | Data |
---|---|---|
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(struct usb_hub_device *hub, 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 | #ifdef CONFIG_DM_USB | |
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 | ||
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 | ||
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 | ||
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 | ||
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 | ||
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 | ||
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 | #ifdef CONFIG_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 | ||
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 | #ifndef CONFIG_DM_USB | |
216 | static struct usb_hub_device hub_dev[USB_MAX_HUB]; | |
217 | static int usb_hub_index; | |
218 | ||
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 | ||
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 | ||
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 | */ | |
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 | #ifdef CONFIG_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 | ||
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 | ||
351 | /* Check status */ | |
352 | ret = usb_get_port_status(dev, port + 1, portsts); | |
353 | if (ret < 0) { | |
354 | debug("get_port_status failed\n"); | |
355 | return ret; | |
356 | } | |
357 | ||
358 | portstatus = le16_to_cpu(portsts->wPortStatus); | |
359 | debug("portstatus %x, change %x, %s\n", | |
360 | portstatus, | |
361 | le16_to_cpu(portsts->wPortChange), | |
362 | portspeed(portstatus)); | |
363 | ||
364 | /* Clear the connection change status */ | |
365 | usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_CONNECTION); | |
366 | ||
367 | /* Disconnect any existing devices under this port */ | |
368 | if (((!(portstatus & USB_PORT_STAT_CONNECTION)) && | |
369 | (!(portstatus & USB_PORT_STAT_ENABLE))) || | |
370 | usb_device_has_child_on_port(dev, port)) { | |
371 | debug("usb_disconnect(&hub->children[port]);\n"); | |
372 | /* Return now if nothing is connected */ | |
373 | if (!(portstatus & USB_PORT_STAT_CONNECTION)) | |
374 | return -ENOTCONN; | |
375 | } | |
376 | ||
377 | /* Reset the port */ | |
378 | ret = usb_hub_port_reset(dev, port, &portstatus); | |
379 | if (ret < 0) { | |
380 | if (ret != -ENXIO) | |
381 | printf("cannot reset port %i!?\n", port + 1); | |
382 | return ret; | |
383 | } | |
384 | ||
385 | switch (portstatus & USB_PORT_STAT_SPEED_MASK) { | |
386 | case USB_PORT_STAT_SUPER_SPEED: | |
387 | speed = USB_SPEED_SUPER; | |
388 | break; | |
389 | case USB_PORT_STAT_HIGH_SPEED: | |
390 | speed = USB_SPEED_HIGH; | |
391 | break; | |
392 | case USB_PORT_STAT_LOW_SPEED: | |
393 | speed = USB_SPEED_LOW; | |
394 | break; | |
395 | default: | |
396 | speed = USB_SPEED_FULL; | |
397 | break; | |
398 | } | |
399 | ||
400 | #ifdef CONFIG_DM_USB | |
401 | struct udevice *child; | |
402 | ||
403 | ret = usb_scan_device(dev->dev, port + 1, speed, &child); | |
404 | #else | |
405 | struct usb_device *usb; | |
406 | ||
407 | ret = usb_alloc_new_device(dev->controller, &usb); | |
408 | if (ret) { | |
409 | printf("cannot create new device: ret=%d", ret); | |
410 | return ret; | |
411 | } | |
412 | ||
413 | dev->children[port] = usb; | |
414 | usb->speed = speed; | |
415 | usb->parent = dev; | |
416 | usb->portnr = port + 1; | |
417 | /* Run it through the hoops (find a driver, etc) */ | |
418 | ret = usb_new_device(usb); | |
419 | if (ret < 0) { | |
420 | /* Woops, disable the port */ | |
421 | usb_free_device(dev->controller); | |
422 | dev->children[port] = NULL; | |
423 | } | |
424 | #endif | |
425 | if (ret < 0) { | |
426 | debug("hub: disabling port %d\n", port + 1); | |
427 | usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_ENABLE); | |
428 | } | |
429 | ||
430 | return ret; | |
431 | } | |
432 | ||
433 | static int usb_scan_port(struct usb_device_scan *usb_scan) | |
434 | { | |
435 | ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1); | |
436 | unsigned short portstatus; | |
437 | unsigned short portchange; | |
438 | struct usb_device *dev; | |
439 | struct usb_hub_device *hub; | |
440 | int ret = 0; | |
441 | int i; | |
442 | ||
443 | dev = usb_scan->dev; | |
444 | hub = usb_scan->hub; | |
445 | i = usb_scan->port; | |
446 | ||
447 | /* | |
448 | * Don't talk to the device before the query delay is expired. | |
449 | * This is needed for voltages to stabalize. | |
450 | */ | |
451 | if (get_timer(0) < hub->query_delay) | |
452 | return 0; | |
453 | ||
454 | ret = usb_get_port_status(dev, i + 1, portsts); | |
455 | if (ret < 0) { | |
456 | debug("get_port_status failed\n"); | |
457 | if (get_timer(0) >= hub->connect_timeout) { | |
458 | debug("devnum=%d port=%d: timeout\n", | |
459 | dev->devnum, i + 1); | |
460 | /* Remove this device from scanning list */ | |
461 | list_del(&usb_scan->list); | |
462 | free(usb_scan); | |
463 | return 0; | |
464 | } | |
465 | return 0; | |
466 | } | |
467 | ||
468 | portstatus = le16_to_cpu(portsts->wPortStatus); | |
469 | portchange = le16_to_cpu(portsts->wPortChange); | |
470 | debug("Port %d Status %X Change %X\n", i + 1, portstatus, portchange); | |
471 | ||
472 | /* | |
473 | * No connection change happened, wait a bit more. | |
474 | * | |
475 | * For some situation, the hub reports no connection change but a | |
476 | * device is connected to the port (eg: CCS bit is set but CSC is not | |
477 | * in the PORTSC register of a root hub), ignore such case. | |
478 | */ | |
479 | if (!(portchange & USB_PORT_STAT_C_CONNECTION) && | |
480 | !(portstatus & USB_PORT_STAT_CONNECTION)) { | |
481 | if (get_timer(0) >= hub->connect_timeout) { | |
482 | debug("devnum=%d port=%d: timeout\n", | |
483 | dev->devnum, i + 1); | |
484 | /* Remove this device from scanning list */ | |
485 | list_del(&usb_scan->list); | |
486 | free(usb_scan); | |
487 | return 0; | |
488 | } | |
489 | return 0; | |
490 | } | |
491 | ||
492 | if (portchange & USB_PORT_STAT_C_RESET) { | |
493 | debug("port %d reset change\n", i + 1); | |
494 | usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_C_RESET); | |
495 | } | |
496 | ||
497 | if ((portchange & USB_SS_PORT_STAT_C_BH_RESET) && | |
498 | usb_hub_is_superspeed(dev)) { | |
499 | debug("port %d BH reset change\n", i + 1); | |
500 | usb_clear_port_feature(dev, i + 1, USB_SS_PORT_FEAT_C_BH_RESET); | |
501 | } | |
502 | ||
503 | /* A new USB device is ready at this point */ | |
504 | debug("devnum=%d port=%d: USB dev found\n", dev->devnum, i + 1); | |
505 | ||
506 | usb_hub_port_connect_change(dev, i); | |
507 | ||
508 | if (portchange & USB_PORT_STAT_C_ENABLE) { | |
509 | debug("port %d enable change, status %x\n", i + 1, portstatus); | |
510 | usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_C_ENABLE); | |
511 | /* | |
512 | * The following hack causes a ghost device problem | |
513 | * to Faraday EHCI | |
514 | */ | |
515 | #ifndef CONFIG_USB_EHCI_FARADAY | |
516 | /* | |
517 | * EM interference sometimes causes bad shielded USB | |
518 | * devices to be shutdown by the hub, this hack enables | |
519 | * them again. Works at least with mouse driver | |
520 | */ | |
521 | if (!(portstatus & USB_PORT_STAT_ENABLE) && | |
522 | (portstatus & USB_PORT_STAT_CONNECTION) && | |
523 | usb_device_has_child_on_port(dev, i)) { | |
524 | debug("already running port %i disabled by hub (EMI?), re-enabling...\n", | |
525 | i + 1); | |
526 | usb_hub_port_connect_change(dev, i); | |
527 | } | |
528 | #endif | |
529 | } | |
530 | ||
531 | if (portstatus & USB_PORT_STAT_SUSPEND) { | |
532 | debug("port %d suspend change\n", i + 1); | |
533 | usb_clear_port_feature(dev, i + 1, USB_PORT_FEAT_SUSPEND); | |
534 | } | |
535 | ||
536 | if (portchange & USB_PORT_STAT_C_OVERCURRENT) { | |
537 | debug("port %d over-current change\n", i + 1); | |
538 | usb_clear_port_feature(dev, i + 1, | |
539 | USB_PORT_FEAT_C_OVER_CURRENT); | |
540 | /* Only power-on this one port */ | |
541 | usb_set_port_feature(dev, i + 1, USB_PORT_FEAT_POWER); | |
542 | hub->overcurrent_count[i]++; | |
543 | ||
544 | /* | |
545 | * If the max-scan-count is not reached, return without removing | |
546 | * the device from scan-list. This will re-issue a new scan. | |
547 | */ | |
548 | if (hub->overcurrent_count[i] <= | |
549 | PORT_OVERCURRENT_MAX_SCAN_COUNT) | |
550 | return 0; | |
551 | ||
552 | /* Otherwise the device will get removed */ | |
553 | printf("Port %d over-current occurred %d times\n", i + 1, | |
554 | hub->overcurrent_count[i]); | |
555 | } | |
556 | ||
557 | /* | |
558 | * We're done with this device, so let's remove this device from | |
559 | * scanning list | |
560 | */ | |
561 | list_del(&usb_scan->list); | |
562 | free(usb_scan); | |
563 | ||
564 | return 0; | |
565 | } | |
566 | ||
567 | static int usb_device_list_scan(void) | |
568 | { | |
569 | struct usb_device_scan *usb_scan; | |
570 | struct usb_device_scan *tmp; | |
571 | static int running; | |
572 | int ret = 0; | |
573 | ||
574 | /* Only run this loop once for each controller */ | |
575 | if (running) | |
576 | return 0; | |
577 | ||
578 | running = 1; | |
579 | ||
580 | while (1) { | |
581 | /* We're done, once the list is empty again */ | |
582 | if (list_empty(&usb_scan_list)) | |
583 | goto out; | |
584 | ||
585 | list_for_each_entry_safe(usb_scan, tmp, &usb_scan_list, list) { | |
586 | int ret; | |
587 | ||
588 | /* Scan this port */ | |
589 | ret = usb_scan_port(usb_scan); | |
590 | if (ret) | |
591 | goto out; | |
592 | } | |
593 | } | |
594 | ||
595 | out: | |
596 | /* | |
597 | * This USB controller has finished scanning all its connected | |
598 | * USB devices. Set "running" back to 0, so that other USB controllers | |
599 | * will scan their devices too. | |
600 | */ | |
601 | running = 0; | |
602 | ||
603 | return ret; | |
604 | } | |
605 | ||
606 | static struct usb_hub_device *usb_get_hub_device(struct usb_device *dev) | |
607 | { | |
608 | struct usb_hub_device *hub; | |
609 | ||
610 | #ifndef CONFIG_DM_USB | |
611 | /* "allocate" Hub device */ | |
612 | hub = usb_hub_allocate(); | |
613 | #else | |
614 | hub = dev_get_uclass_priv(dev->dev); | |
615 | #endif | |
616 | ||
617 | return hub; | |
618 | } | |
619 | ||
620 | static int usb_hub_configure(struct usb_device *dev) | |
621 | { | |
622 | int i, length; | |
623 | ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer, USB_BUFSIZ); | |
624 | unsigned char *bitmap; | |
625 | short hubCharacteristics; | |
626 | struct usb_hub_descriptor *descriptor; | |
627 | struct usb_hub_device *hub; | |
628 | struct usb_hub_status *hubsts; | |
629 | int ret; | |
630 | ||
631 | hub = usb_get_hub_device(dev); | |
632 | if (hub == NULL) | |
633 | return -ENOMEM; | |
634 | hub->pusb_dev = dev; | |
635 | ||
636 | /* Get the the hub descriptor */ | |
637 | ret = usb_get_hub_descriptor(dev, buffer, 4); | |
638 | if (ret < 0) { | |
639 | debug("usb_hub_configure: failed to get hub " \ | |
640 | "descriptor, giving up %lX\n", dev->status); | |
641 | return ret; | |
642 | } | |
643 | descriptor = (struct usb_hub_descriptor *)buffer; | |
644 | ||
645 | length = min_t(int, descriptor->bLength, | |
646 | sizeof(struct usb_hub_descriptor)); | |
647 | ||
648 | ret = usb_get_hub_descriptor(dev, buffer, length); | |
649 | if (ret < 0) { | |
650 | debug("usb_hub_configure: failed to get hub " \ | |
651 | "descriptor 2nd giving up %lX\n", dev->status); | |
652 | return ret; | |
653 | } | |
654 | memcpy((unsigned char *)&hub->desc, buffer, length); | |
655 | /* adjust 16bit values */ | |
656 | put_unaligned(le16_to_cpu(get_unaligned( | |
657 | &descriptor->wHubCharacteristics)), | |
658 | &hub->desc.wHubCharacteristics); | |
659 | /* set the bitmap */ | |
660 | bitmap = (unsigned char *)&hub->desc.u.hs.DeviceRemovable[0]; | |
661 | /* devices not removable by default */ | |
662 | memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8); | |
663 | bitmap = (unsigned char *)&hub->desc.u.hs.PortPowerCtrlMask[0]; | |
664 | memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8); /* PowerMask = 1B */ | |
665 | ||
666 | for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++) | |
667 | hub->desc.u.hs.DeviceRemovable[i] = | |
668 | descriptor->u.hs.DeviceRemovable[i]; | |
669 | ||
670 | for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++) | |
671 | hub->desc.u.hs.PortPowerCtrlMask[i] = | |
672 | descriptor->u.hs.PortPowerCtrlMask[i]; | |
673 | ||
674 | dev->maxchild = descriptor->bNbrPorts; | |
675 | debug("%d ports detected\n", dev->maxchild); | |
676 | ||
677 | hubCharacteristics = get_unaligned(&hub->desc.wHubCharacteristics); | |
678 | switch (hubCharacteristics & HUB_CHAR_LPSM) { | |
679 | case 0x00: | |
680 | debug("ganged power switching\n"); | |
681 | break; | |
682 | case 0x01: | |
683 | debug("individual port power switching\n"); | |
684 | break; | |
685 | case 0x02: | |
686 | case 0x03: | |
687 | debug("unknown reserved power switching mode\n"); | |
688 | break; | |
689 | } | |
690 | ||
691 | if (hubCharacteristics & HUB_CHAR_COMPOUND) | |
692 | debug("part of a compound device\n"); | |
693 | else | |
694 | debug("standalone hub\n"); | |
695 | ||
696 | switch (hubCharacteristics & HUB_CHAR_OCPM) { | |
697 | case 0x00: | |
698 | debug("global over-current protection\n"); | |
699 | break; | |
700 | case 0x08: | |
701 | debug("individual port over-current protection\n"); | |
702 | break; | |
703 | case 0x10: | |
704 | case 0x18: | |
705 | debug("no over-current protection\n"); | |
706 | break; | |
707 | } | |
708 | ||
709 | switch (dev->descriptor.bDeviceProtocol) { | |
710 | case USB_HUB_PR_FS: | |
711 | break; | |
712 | case USB_HUB_PR_HS_SINGLE_TT: | |
713 | debug("Single TT\n"); | |
714 | break; | |
715 | case USB_HUB_PR_HS_MULTI_TT: | |
716 | ret = usb_set_interface(dev, 0, 1); | |
717 | if (ret == 0) { | |
718 | debug("TT per port\n"); | |
719 | hub->tt.multi = true; | |
720 | } else { | |
721 | debug("Using single TT (err %d)\n", ret); | |
722 | } | |
723 | break; | |
724 | case USB_HUB_PR_SS: | |
725 | /* USB 3.0 hubs don't have a TT */ | |
726 | break; | |
727 | default: | |
728 | debug("Unrecognized hub protocol %d\n", | |
729 | dev->descriptor.bDeviceProtocol); | |
730 | break; | |
731 | } | |
732 | ||
733 | /* Note 8 FS bit times == (8 bits / 12000000 bps) ~= 666ns */ | |
734 | switch (hubCharacteristics & HUB_CHAR_TTTT) { | |
735 | case HUB_TTTT_8_BITS: | |
736 | if (dev->descriptor.bDeviceProtocol != 0) { | |
737 | hub->tt.think_time = 666; | |
738 | debug("TT requires at most %d FS bit times (%d ns)\n", | |
739 | 8, hub->tt.think_time); | |
740 | } | |
741 | break; | |
742 | case HUB_TTTT_16_BITS: | |
743 | hub->tt.think_time = 666 * 2; | |
744 | debug("TT requires at most %d FS bit times (%d ns)\n", | |
745 | 16, hub->tt.think_time); | |
746 | break; | |
747 | case HUB_TTTT_24_BITS: | |
748 | hub->tt.think_time = 666 * 3; | |
749 | debug("TT requires at most %d FS bit times (%d ns)\n", | |
750 | 24, hub->tt.think_time); | |
751 | break; | |
752 | case HUB_TTTT_32_BITS: | |
753 | hub->tt.think_time = 666 * 4; | |
754 | debug("TT requires at most %d FS bit times (%d ns)\n", | |
755 | 32, hub->tt.think_time); | |
756 | break; | |
757 | } | |
758 | ||
759 | debug("power on to power good time: %dms\n", | |
760 | descriptor->bPwrOn2PwrGood * 2); | |
761 | debug("hub controller current requirement: %dmA\n", | |
762 | descriptor->bHubContrCurrent); | |
763 | ||
764 | for (i = 0; i < dev->maxchild; i++) | |
765 | debug("port %d is%s removable\n", i + 1, | |
766 | hub->desc.u.hs.DeviceRemovable[(i + 1) / 8] & \ | |
767 | (1 << ((i + 1) % 8)) ? " not" : ""); | |
768 | ||
769 | if (sizeof(struct usb_hub_status) > USB_BUFSIZ) { | |
770 | debug("usb_hub_configure: failed to get Status - " \ | |
771 | "too long: %d\n", descriptor->bLength); | |
772 | return -EFBIG; | |
773 | } | |
774 | ||
775 | ret = usb_get_hub_status(dev, buffer); | |
776 | if (ret < 0) { | |
777 | debug("usb_hub_configure: failed to get Status %lX\n", | |
778 | dev->status); | |
779 | return ret; | |
780 | } | |
781 | ||
782 | hubsts = (struct usb_hub_status *)buffer; | |
783 | ||
784 | debug("get_hub_status returned status %X, change %X\n", | |
785 | le16_to_cpu(hubsts->wHubStatus), | |
786 | le16_to_cpu(hubsts->wHubChange)); | |
787 | debug("local power source is %s\n", | |
788 | (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_LOCAL_POWER) ? \ | |
789 | "lost (inactive)" : "good"); | |
790 | debug("%sover-current condition exists\n", | |
791 | (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_OVERCURRENT) ? \ | |
792 | "" : "no "); | |
793 | ||
794 | #ifdef CONFIG_DM_USB | |
795 | /* | |
796 | * Update USB host controller's internal representation of this hub | |
797 | * after the hub descriptor is fetched. | |
798 | */ | |
799 | ret = usb_update_hub_device(dev); | |
800 | if (ret < 0 && ret != -ENOSYS) { | |
801 | debug("%s: failed to update hub device for HCD (%x)\n", | |
802 | __func__, ret); | |
803 | return ret; | |
804 | } | |
805 | ||
806 | /* | |
807 | * A maximum of seven tiers are allowed in a USB topology, and the | |
808 | * root hub occupies the first tier. The last tier ends with a normal | |
809 | * USB device. USB 3.0 hubs use a 20-bit field called 'route string' | |
810 | * to route packets to the designated downstream port. The hub uses a | |
811 | * hub depth value multiplied by four as an offset into the 'route | |
812 | * string' to locate the bits it uses to determine the downstream | |
813 | * port number. | |
814 | */ | |
815 | if (usb_hub_is_root_hub(dev->dev)) { | |
816 | hub->hub_depth = -1; | |
817 | } else { | |
818 | struct udevice *hdev; | |
819 | int depth = 0; | |
820 | ||
821 | hdev = dev->dev->parent; | |
822 | while (!usb_hub_is_root_hub(hdev)) { | |
823 | depth++; | |
824 | hdev = hdev->parent; | |
825 | } | |
826 | ||
827 | hub->hub_depth = depth; | |
828 | ||
829 | if (usb_hub_is_superspeed(dev)) { | |
830 | debug("set hub (%p) depth to %d\n", dev, depth); | |
831 | /* | |
832 | * This request sets the value that the hub uses to | |
833 | * determine the index into the 'route string index' | |
834 | * for this hub. | |
835 | */ | |
836 | ret = usb_set_hub_depth(dev, depth); | |
837 | if (ret < 0) { | |
838 | debug("%s: failed to set hub depth (%lX)\n", | |
839 | __func__, dev->status); | |
840 | return ret; | |
841 | } | |
842 | } | |
843 | } | |
844 | #endif | |
845 | ||
846 | usb_hub_power_on(hub); | |
847 | ||
848 | /* | |
849 | * Reset any devices that may be in a bad state when applying | |
850 | * the power. This is a __weak function. Resetting of the devices | |
851 | * should occur in the board file of the device. | |
852 | */ | |
853 | for (i = 0; i < dev->maxchild; i++) | |
854 | usb_hub_reset_devices(hub, i + 1); | |
855 | ||
856 | /* | |
857 | * Only add the connected USB devices, including potential hubs, | |
858 | * to a scanning list. This list will get scanned and devices that | |
859 | * are detected (either via port connected or via port timeout) | |
860 | * will get removed from this list. Scanning of the devices on this | |
861 | * list will continue until all devices are removed. | |
862 | */ | |
863 | for (i = 0; i < dev->maxchild; i++) { | |
864 | struct usb_device_scan *usb_scan; | |
865 | ||
866 | usb_scan = calloc(1, sizeof(*usb_scan)); | |
867 | if (!usb_scan) { | |
868 | printf("Can't allocate memory for USB device!\n"); | |
869 | return -ENOMEM; | |
870 | } | |
871 | usb_scan->dev = dev; | |
872 | usb_scan->hub = hub; | |
873 | usb_scan->port = i; | |
874 | list_add_tail(&usb_scan->list, &usb_scan_list); | |
875 | } | |
876 | ||
877 | /* | |
878 | * And now call the scanning code which loops over the generated list | |
879 | */ | |
880 | ret = usb_device_list_scan(); | |
881 | ||
882 | return ret; | |
883 | } | |
884 | ||
885 | static int usb_hub_check(struct usb_device *dev, int ifnum) | |
886 | { | |
887 | struct usb_interface *iface; | |
888 | struct usb_endpoint_descriptor *ep = NULL; | |
889 | ||
890 | iface = &dev->config.if_desc[ifnum]; | |
891 | /* Is it a hub? */ | |
892 | if (iface->desc.bInterfaceClass != USB_CLASS_HUB) | |
893 | goto err; | |
894 | /* Some hubs have a subclass of 1, which AFAICT according to the */ | |
895 | /* specs is not defined, but it works */ | |
896 | if ((iface->desc.bInterfaceSubClass != 0) && | |
897 | (iface->desc.bInterfaceSubClass != 1)) | |
898 | goto err; | |
899 | /* Multiple endpoints? What kind of mutant ninja-hub is this? */ | |
900 | if (iface->desc.bNumEndpoints != 1) | |
901 | goto err; | |
902 | ep = &iface->ep_desc[0]; | |
903 | /* Output endpoint? Curiousier and curiousier.. */ | |
904 | if (!(ep->bEndpointAddress & USB_DIR_IN)) | |
905 | goto err; | |
906 | /* If it's not an interrupt endpoint, we'd better punt! */ | |
907 | if ((ep->bmAttributes & 3) != 3) | |
908 | goto err; | |
909 | /* We found a hub */ | |
910 | debug("USB hub found\n"); | |
911 | return 0; | |
912 | ||
913 | err: | |
914 | debug("USB hub not found: bInterfaceClass=%d, bInterfaceSubClass=%d, bNumEndpoints=%d\n", | |
915 | iface->desc.bInterfaceClass, iface->desc.bInterfaceSubClass, | |
916 | iface->desc.bNumEndpoints); | |
917 | if (ep) { | |
918 | debug(" bEndpointAddress=%#x, bmAttributes=%d", | |
919 | ep->bEndpointAddress, ep->bmAttributes); | |
920 | } | |
921 | ||
922 | return -ENOENT; | |
923 | } | |
924 | ||
925 | int usb_hub_probe(struct usb_device *dev, int ifnum) | |
926 | { | |
927 | int ret; | |
928 | ||
929 | ret = usb_hub_check(dev, ifnum); | |
930 | if (ret) | |
931 | return 0; | |
932 | ret = usb_hub_configure(dev); | |
933 | return ret; | |
934 | } | |
935 | ||
936 | #ifdef CONFIG_DM_USB | |
937 | int usb_hub_scan(struct udevice *hub) | |
938 | { | |
939 | struct usb_device *udev = dev_get_parent_priv(hub); | |
940 | ||
941 | return usb_hub_configure(udev); | |
942 | } | |
943 | ||
944 | static int usb_hub_post_probe(struct udevice *dev) | |
945 | { | |
946 | debug("%s\n", __func__); | |
947 | return usb_hub_scan(dev); | |
948 | } | |
949 | ||
950 | static const struct udevice_id usb_hub_ids[] = { | |
951 | { .compatible = "usb-hub" }, | |
952 | { } | |
953 | }; | |
954 | ||
955 | U_BOOT_DRIVER(usb_generic_hub) = { | |
956 | .name = "usb_hub", | |
957 | .id = UCLASS_USB_HUB, | |
958 | .of_match = usb_hub_ids, | |
959 | .flags = DM_FLAG_ALLOC_PRIV_DMA, | |
960 | }; | |
961 | ||
962 | UCLASS_DRIVER(usb_hub) = { | |
963 | .id = UCLASS_USB_HUB, | |
964 | .name = "usb_hub", | |
965 | .post_bind = dm_scan_fdt_dev, | |
966 | .post_probe = usb_hub_post_probe, | |
967 | .child_pre_probe = usb_child_pre_probe, | |
968 | .per_child_auto_alloc_size = sizeof(struct usb_device), | |
969 | .per_child_platdata_auto_alloc_size = sizeof(struct usb_dev_platdata), | |
970 | .per_device_auto_alloc_size = sizeof(struct usb_hub_device), | |
971 | }; | |
972 | ||
973 | static const struct usb_device_id hub_id_table[] = { | |
974 | { | |
975 | .match_flags = USB_DEVICE_ID_MATCH_DEV_CLASS, | |
976 | .bDeviceClass = USB_CLASS_HUB | |
977 | }, | |
978 | { } /* Terminating entry */ | |
979 | }; | |
980 | ||
981 | U_BOOT_USB_DEVICE(usb_generic_hub, hub_id_table); | |
982 | ||
983 | #endif |