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