]> git.ipfire.org Git - people/ms/u-boot.git/blame - common/usb_hub.c
projects / people / ms / u-boot.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
dm: usb: Drop the legacy USB init sequence
[people/ms/u-boot.git] / common / usb_hub.c
CommitLineData
23faf2bc 1/*
23faf2bc
MV		 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 *
1a459660 17 * SPDX-License-Identifier: GPL-2.0+
23faf2bc
MV		 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>
79b58887 27#include <errno.h>
23faf2bc 28#include <asm/processor.h>
93ad908c 29#include <asm/unaligned.h>
23faf2bc
MV		 30#include <linux/ctype.h>
31#include <asm/byteorder.h>
32#include <asm/unaligned.h>
33
34#include <usb.h>
35#ifdef CONFIG_4xx
36#include <asm/4xx_pci.h>
37#endif
38
23faf2bc
MV		 39#define USB_BUFSIZ 512
40
41static struct usb_hub_device hub_dev[USB_MAX_HUB];
42static int usb_hub_index;
43
3615a996
DM		 44__weak void usb_hub_reset_devices(int port)
45{
46 return;
47}
23faf2bc
MV		 48
49static int usb_get_hub_descriptor(struct usb_device *dev, void *data, int size)
50{
51 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
52 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN | USB_RT_HUB,
53 USB_DT_HUB << 8, 0, data, size, USB_CNTL_TIMEOUT);
54}
55
56static int usb_clear_port_feature(struct usb_device *dev, int port, int feature)
57{
58 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
59 USB_REQ_CLEAR_FEATURE, USB_RT_PORT, feature,
60 port, NULL, 0, USB_CNTL_TIMEOUT);
61}
62
63static int usb_set_port_feature(struct usb_device *dev, int port, int feature)
64{
65 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
66 USB_REQ_SET_FEATURE, USB_RT_PORT, feature,
67 port, NULL, 0, USB_CNTL_TIMEOUT);
68}
69
70static int usb_get_hub_status(struct usb_device *dev, void *data)
71{
72 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
73 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_HUB, 0, 0,
74 data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
75}
76
77static int usb_get_port_status(struct usb_device *dev, int port, void *data)
78{
79 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
80 USB_REQ_GET_STATUS, USB_DIR_IN | USB_RT_PORT, 0, port,
81 data, sizeof(struct usb_hub_status), USB_CNTL_TIMEOUT);
82}
83
84
85static void usb_hub_power_on(struct usb_hub_device *hub)
86{
87 int i;
88 struct usb_device *dev;
a1a28c6e 89 unsigned pgood_delay = hub->desc.bPwrOn2PwrGood * 2;
319418c0 90 const char *env;
23faf2bc
MV		 91
92 dev = hub->pusb_dev;
0bf796f7 93
ceb4972a 94 debug("enabling power on all ports\n");
0bf796f7 95 for (i = 0; i < dev->maxchild; i++) {
23faf2bc 96 usb_set_port_feature(dev, i + 1, USB_PORT_FEAT_POWER);
ceb4972a 97 debug("port %d returns %lX\n", i + 1, dev->status);
23faf2bc 98 }
a1a28c6e 99
0d437bca
SW		 100 /*
101 * Wait for power to become stable,
102 * plus spec-defined max time for device to connect
319418c0
TH		 103 * but allow this time to be increased via env variable as some
104 * devices break the spec and require longer warm-up times
0d437bca 105 */
319418c0
TH		 106 env = getenv("usb_pgood_delay");
107 if (env)
108 pgood_delay = max(pgood_delay,
109 (unsigned)simple_strtol(env, NULL, 0));
110 debug("pgood_delay=%dms\n", pgood_delay);
77b83e6d 111 mdelay(pgood_delay + 1000);
23faf2bc
MV		 112}
113
114void usb_hub_reset(void)
115{
116 usb_hub_index = 0;
117}
118
119static struct usb_hub_device *usb_hub_allocate(void)
120{
121 if (usb_hub_index < USB_MAX_HUB)
122 return &hub_dev[usb_hub_index++];
123
124 printf("ERROR: USB_MAX_HUB (%d) reached\n", USB_MAX_HUB);
125 return NULL;
126}
127
128#define MAX_TRIES 5
129
130static inline char *portspeed(int portstatus)
131{
55f4b575
VG		 132 char *speed_str;
133
134 switch (portstatus & USB_PORT_STAT_SPEED_MASK) {
135 case USB_PORT_STAT_SUPER_SPEED:
136 speed_str = "5 Gb/s";
137 break;
138 case USB_PORT_STAT_HIGH_SPEED:
139 speed_str = "480 Mb/s";
140 break;
141 case USB_PORT_STAT_LOW_SPEED:
142 speed_str = "1.5 Mb/s";
143 break;
144 default:
145 speed_str = "12 Mb/s";
146 break;
147 }
148
149 return speed_str;
23faf2bc
MV		 150}
151
152int hub_port_reset(struct usb_device *dev, int port,
153 unsigned short *portstat)
154{
155 int tries;
f5766139 156 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
23faf2bc
MV		 157 unsigned short portstatus, portchange;
158
ceb4972a 159 debug("hub_port_reset: resetting port %d...\n", port);
23faf2bc
MV		 160 for (tries = 0; tries < MAX_TRIES; tries++) {
161
162 usb_set_port_feature(dev, port + 1, USB_PORT_FEAT_RESET);
5b84dd67 163 mdelay(200);
23faf2bc 164
f5766139 165 if (usb_get_port_status(dev, port + 1, portsts) < 0) {
ceb4972a
VG		 166 debug("get_port_status failed status %lX\n",
167 dev->status);
23faf2bc
MV		 168 return -1;
169 }
f5766139
PS		 170 portstatus = le16_to_cpu(portsts->wPortStatus);
171 portchange = le16_to_cpu(portsts->wPortChange);
23faf2bc 172
ceb4972a
VG		 173 debug("portstatus %x, change %x, %s\n", portstatus, portchange,
174 portspeed(portstatus));
23faf2bc 175
ceb4972a
VG		 176 debug("STAT_C_CONNECTION = %d STAT_CONNECTION = %d" \
177 " USB_PORT_STAT_ENABLE %d\n",
178 (portchange & USB_PORT_STAT_C_CONNECTION) ? 1 : 0,
179 (portstatus & USB_PORT_STAT_CONNECTION) ? 1 : 0,
180 (portstatus & USB_PORT_STAT_ENABLE) ? 1 : 0);
23faf2bc 181
74c0d756
SW		 182 /*
183 * Perhaps we should check for the following here:
184 * - C_CONNECTION hasn't been set.
185 * - CONNECTION is still set.
186 *
187 * Doing so would ensure that the device is still connected
188 * to the bus, and hasn't been unplugged or replaced while the
189 * USB bus reset was going on.
190 *
191 * However, if we do that, then (at least) a San Disk Ultra
192 * USB 3.0 16GB device fails to reset on (at least) an NVIDIA
193 * Tegra Jetson TK1 board. For some reason, the device appears
194 * to briefly drop off the bus when this second bus reset is
195 * executed, yet if we retry this loop, it'll eventually come
196 * back after another reset or two.
197 */
23faf2bc
MV		 198
199 if (portstatus & USB_PORT_STAT_ENABLE)
200 break;
201
5b84dd67 202 mdelay(200);
23faf2bc
MV		 203 }
204
205 if (tries == MAX_TRIES) {
ceb4972a
VG		 206 debug("Cannot enable port %i after %i retries, " \
207 "disabling port.\n", port + 1, MAX_TRIES);
208 debug("Maybe the USB cable is bad?\n");
23faf2bc
MV		 209 return -1;
210 }
211
212 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_RESET);
213 *portstat = portstatus;
214 return 0;
215}
216
217
79b58887 218int usb_hub_port_connect_change(struct usb_device *dev, int port)
23faf2bc
MV		 219{
220 struct usb_device *usb;
f5766139 221 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
23faf2bc 222 unsigned short portstatus;
79b58887 223 int ret, speed;
23faf2bc
MV		 224
225 /* Check status */
79b58887
SG		 226 ret = usb_get_port_status(dev, port + 1, portsts);
227 if (ret < 0) {
ceb4972a 228 debug("get_port_status failed\n");
79b58887 229 return ret;
23faf2bc
MV		 230 }
231
f5766139 232 portstatus = le16_to_cpu(portsts->wPortStatus);
ceb4972a
VG		 233 debug("portstatus %x, change %x, %s\n",
234 portstatus,
235 le16_to_cpu(portsts->wPortChange),
236 portspeed(portstatus));
23faf2bc
MV		 237
238 /* Clear the connection change status */
239 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_C_CONNECTION);
240
241 /* Disconnect any existing devices under this port */
242 if (((!(portstatus & USB_PORT_STAT_CONNECTION)) &&
243 (!(portstatus & USB_PORT_STAT_ENABLE))) || (dev->children[port])) {
ceb4972a 244 debug("usb_disconnect(&hub->children[port]);\n");
23faf2bc
MV		 245 /* Return now if nothing is connected */
246 if (!(portstatus & USB_PORT_STAT_CONNECTION))
79b58887 247 return -ENOTCONN;
23faf2bc 248 }
5b84dd67 249 mdelay(200);
23faf2bc
MV		 250
251 /* Reset the port */
79b58887
SG		 252 ret = hub_port_reset(dev, port, &portstatus);
253 if (ret < 0) {
23faf2bc 254 printf("cannot reset port %i!?\n", port + 1);
79b58887 255 return ret;
23faf2bc
MV		 256 }
257
5b84dd67 258 mdelay(200);
23faf2bc 259
55f4b575
VG		 260 switch (portstatus & USB_PORT_STAT_SPEED_MASK) {
261 case USB_PORT_STAT_SUPER_SPEED:
79b58887 262 speed = USB_SPEED_SUPER;
55f4b575
VG		 263 break;
264 case USB_PORT_STAT_HIGH_SPEED:
79b58887 265 speed = USB_SPEED_HIGH;
55f4b575
VG		 266 break;
267 case USB_PORT_STAT_LOW_SPEED:
79b58887 268 speed = USB_SPEED_LOW;
55f4b575
VG		 269 break;
270 default:
79b58887 271 speed = USB_SPEED_FULL;
55f4b575
VG		 272 break;
273 }
23faf2bc 274
79b58887
SG		 275 ret = usb_alloc_new_device(dev->controller, &usb);
276 if (ret) {
277 printf("cannot create new device: ret=%d", ret);
278 return ret;
279 }
280
23faf2bc 281 dev->children[port] = usb;
79b58887 282 usb->speed = speed;
23faf2bc
MV		 283 usb->parent = dev;
284 usb->portnr = port + 1;
285 /* Run it through the hoops (find a driver, etc) */
79b58887
SG		 286 ret = usb_new_device(usb);
287 if (ret < 0) {
23faf2bc 288 /* Woops, disable the port */
79b58887 289 usb_free_device(dev->controller);
359439d2 290 dev->children[port] = NULL;
ceb4972a 291 debug("hub: disabling port %d\n", port + 1);
23faf2bc
MV		 292 usb_clear_port_feature(dev, port + 1, USB_PORT_FEAT_ENABLE);
293 }
79b58887
SG		 294
295 return ret;
23faf2bc
MV		 296}
297
298
299static int usb_hub_configure(struct usb_device *dev)
300{
eaf3e613 301 int i, length;
f5766139
PS		 302 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, buffer, USB_BUFSIZ);
303 unsigned char *bitmap;
93ad908c 304 short hubCharacteristics;
23faf2bc
MV		 305 struct usb_hub_descriptor *descriptor;
306 struct usb_hub_device *hub;
ceb4972a 307 __maybe_unused struct usb_hub_status *hubsts;
23faf2bc
MV		 308
309 /* "allocate" Hub device */
310 hub = usb_hub_allocate();
311 if (hub == NULL)
312 return -1;
313 hub->pusb_dev = dev;
314 /* Get the the hub descriptor */
315 if (usb_get_hub_descriptor(dev, buffer, 4) < 0) {
ceb4972a
VG		 316 debug("usb_hub_configure: failed to get hub " \
317 "descriptor, giving up %lX\n", dev->status);
23faf2bc
MV		 318 return -1;
319 }
320 descriptor = (struct usb_hub_descriptor *)buffer;
321
b4141195
MY		 322 length = min_t(int, descriptor->bLength,
323 sizeof(struct usb_hub_descriptor));
23faf2bc 324
eaf3e613 325 if (usb_get_hub_descriptor(dev, buffer, length) < 0) {
ceb4972a
VG		 326 debug("usb_hub_configure: failed to get hub " \
327 "descriptor 2nd giving up %lX\n", dev->status);
23faf2bc
MV		 328 return -1;
329 }
eaf3e613 330 memcpy((unsigned char *)&hub->desc, buffer, length);
23faf2bc 331 /* adjust 16bit values */
93ad908c
LS		 332 put_unaligned(le16_to_cpu(get_unaligned(
333 &descriptor->wHubCharacteristics)),
334 &hub->desc.wHubCharacteristics);
23faf2bc
MV		 335 /* set the bitmap */
336 bitmap = (unsigned char *)&hub->desc.DeviceRemovable[0];
337 /* devices not removable by default */
338 memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8);
339 bitmap = (unsigned char *)&hub->desc.PortPowerCtrlMask[0];
340 memset(bitmap, 0xff, (USB_MAXCHILDREN+1+7)/8); /* PowerMask = 1B */
341
342 for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
343 hub->desc.DeviceRemovable[i] = descriptor->DeviceRemovable[i];
344
345 for (i = 0; i < ((hub->desc.bNbrPorts + 1 + 7)/8); i++)
346 hub->desc.PortPowerCtrlMask[i] = descriptor->PortPowerCtrlMask[i];
347
348 dev->maxchild = descriptor->bNbrPorts;
ceb4972a 349 debug("%d ports detected\n", dev->maxchild);
23faf2bc 350
93ad908c
LS		 351 hubCharacteristics = get_unaligned(&hub->desc.wHubCharacteristics);
352 switch (hubCharacteristics & HUB_CHAR_LPSM) {
23faf2bc 353 case 0x00:
ceb4972a 354 debug("ganged power switching\n");
23faf2bc
MV		 355 break;
356 case 0x01:
ceb4972a 357 debug("individual port power switching\n");
23faf2bc
MV		 358 break;
359 case 0x02:
360 case 0x03:
ceb4972a 361 debug("unknown reserved power switching mode\n");
23faf2bc
MV		 362 break;
363 }
364
93ad908c 365 if (hubCharacteristics & HUB_CHAR_COMPOUND)
ceb4972a 366 debug("part of a compound device\n");
23faf2bc 367 else
ceb4972a 368 debug("standalone hub\n");
23faf2bc 369
93ad908c 370 switch (hubCharacteristics & HUB_CHAR_OCPM) {
23faf2bc 371 case 0x00:
ceb4972a 372 debug("global over-current protection\n");
23faf2bc
MV		 373 break;
374 case 0x08:
ceb4972a 375 debug("individual port over-current protection\n");
23faf2bc
MV		 376 break;
377 case 0x10:
378 case 0x18:
ceb4972a 379 debug("no over-current protection\n");
23faf2bc
MV		 380 break;
381 }
382
ceb4972a
VG		 383 debug("power on to power good time: %dms\n",
384 descriptor->bPwrOn2PwrGood * 2);
385 debug("hub controller current requirement: %dmA\n",
386 descriptor->bHubContrCurrent);
23faf2bc
MV		 387
388 for (i = 0; i < dev->maxchild; i++)
ceb4972a
VG		 389 debug("port %d is%s removable\n", i + 1,
390 hub->desc.DeviceRemovable[(i + 1) / 8] & \
391 (1 << ((i + 1) % 8)) ? " not" : "");
23faf2bc
MV		 392
393 if (sizeof(struct usb_hub_status) > USB_BUFSIZ) {
ceb4972a
VG		 394 debug("usb_hub_configure: failed to get Status - " \
395 "too long: %d\n", descriptor->bLength);
23faf2bc
MV		 396 return -1;
397 }
398
399 if (usb_get_hub_status(dev, buffer) < 0) {
ceb4972a
VG		 400 debug("usb_hub_configure: failed to get Status %lX\n",
401 dev->status);
23faf2bc
MV		 402 return -1;
403 }
404
ceb4972a 405#ifdef DEBUG
23faf2bc
MV		 406 hubsts = (struct usb_hub_status *)buffer;
407#endif
ceb4972a
VG		 408
409 debug("get_hub_status returned status %X, change %X\n",
410 le16_to_cpu(hubsts->wHubStatus),
411 le16_to_cpu(hubsts->wHubChange));
412 debug("local power source is %s\n",
413 (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_LOCAL_POWER) ? \
414 "lost (inactive)" : "good");
415 debug("%sover-current condition exists\n",
416 (le16_to_cpu(hubsts->wHubStatus) & HUB_STATUS_OVERCURRENT) ? \
417 "" : "no ");
23faf2bc
MV		 418 usb_hub_power_on(hub);
419
3615a996
DM		 420 /*
421 * Reset any devices that may be in a bad state when applying
422 * the power. This is a __weak function. Resetting of the devices
423 * should occur in the board file of the device.
424 */
425 for (i = 0; i < dev->maxchild; i++)
426 usb_hub_reset_devices(i + 1);
427
23faf2bc 428 for (i = 0; i < dev->maxchild; i++) {
f5766139 429 ALLOC_CACHE_ALIGN_BUFFER(struct usb_port_status, portsts, 1);
23faf2bc 430 unsigned short portstatus, portchange;
b6d7852c
VK		 431 int ret;
432 ulong start = get_timer(0);
433
434 /*
435 * Wait for (whichever finishes first)
436 * - A maximum of 10 seconds
437 * This is a purely observational value driven by connecting
438 * a few broken pen drives and taking the max * 1.5 approach
439 * - connection_change and connection state to report same
440 * state
441 */
442 do {
443 ret = usb_get_port_status(dev, i + 1, portsts);
444 if (ret < 0) {
ceb4972a 445 debug("get_port_status failed\n");
b6d7852c
VK		 446 break;
447 }
448
449 portstatus = le16_to_cpu(portsts->wPortStatus);
450 portchange = le16_to_cpu(portsts->wPortChange);
451
452 if ((portchange & USB_PORT_STAT_C_CONNECTION) ==
453 (portstatus & USB_PORT_STAT_CONNECTION))
454 break;
455
b6d7852c
VK		 456 } while (get_timer(start) < CONFIG_SYS_HZ * 10);
457
458 if (ret < 0)
23faf2bc 459 continue;
23faf2bc 460
ceb4972a
VG		 461 debug("Port %d Status %X Change %X\n",
462 i + 1, portstatus, portchange);
23faf2bc
MV		 463
464 if (portchange & USB_PORT_STAT_C_CONNECTION) {
ceb4972a 465 debug("port %d connection change\n", i + 1);
23faf2bc
MV		 466 usb_hub_port_connect_change(dev, i);
467 }
468 if (portchange & USB_PORT_STAT_C_ENABLE) {
ceb4972a
VG		 469 debug("port %d enable change, status %x\n",
470 i + 1, portstatus);
23faf2bc
MV		 471 usb_clear_port_feature(dev, i + 1,
472 USB_PORT_FEAT_C_ENABLE);
e82a316d
KJS		 473 /*
474 * The following hack causes a ghost device problem
475 * to Faraday EHCI
476 */
477#ifndef CONFIG_USB_EHCI_FARADAY
23faf2bc
MV		 478 /* EM interference sometimes causes bad shielded USB
479 * devices to be shutdown by the hub, this hack enables
480 * them again. Works at least with mouse driver */
481 if (!(portstatus & USB_PORT_STAT_ENABLE) &&
482 (portstatus & USB_PORT_STAT_CONNECTION) &&
483 ((dev->children[i]))) {
ceb4972a
VG		 484 debug("already running port %i " \
485 "disabled by hub (EMI?), " \
486 "re-enabling...\n", i + 1);
487 usb_hub_port_connect_change(dev, i);
23faf2bc 488 }
e82a316d 489#endif
23faf2bc
MV		 490 }
491 if (portstatus & USB_PORT_STAT_SUSPEND) {
ceb4972a 492 debug("port %d suspend change\n", i + 1);
23faf2bc
MV		 493 usb_clear_port_feature(dev, i + 1,
494 USB_PORT_FEAT_SUSPEND);
495 }
496
497 if (portchange & USB_PORT_STAT_C_OVERCURRENT) {
ceb4972a 498 debug("port %d over-current change\n", i + 1);
23faf2bc
MV		 499 usb_clear_port_feature(dev, i + 1,
500 USB_PORT_FEAT_C_OVER_CURRENT);
501 usb_hub_power_on(hub);
502 }
503
504 if (portchange & USB_PORT_STAT_C_RESET) {
ceb4972a 505 debug("port %d reset change\n", i + 1);
23faf2bc
MV		 506 usb_clear_port_feature(dev, i + 1,
507 USB_PORT_FEAT_C_RESET);
508 }
509 } /* end for i all ports */
510
511 return 0;
512}
513
514int usb_hub_probe(struct usb_device *dev, int ifnum)
515{
516 struct usb_interface *iface;
517 struct usb_endpoint_descriptor *ep;
518 int ret;
519
520 iface = &dev->config.if_desc[ifnum];
521 /* Is it a hub? */
522 if (iface->desc.bInterfaceClass != USB_CLASS_HUB)
523 return 0;
524 /* Some hubs have a subclass of 1, which AFAICT according to the */
525 /* specs is not defined, but it works */
526 if ((iface->desc.bInterfaceSubClass != 0) &&
527 (iface->desc.bInterfaceSubClass != 1))
528 return 0;
529 /* Multiple endpoints? What kind of mutant ninja-hub is this? */
530 if (iface->desc.bNumEndpoints != 1)
531 return 0;
532 ep = &iface->ep_desc[0];
533 /* Output endpoint? Curiousier and curiousier.. */
534 if (!(ep->bEndpointAddress & USB_DIR_IN))
535 return 0;
536 /* If it's not an interrupt endpoint, we'd better punt! */
537 if ((ep->bmAttributes & 3) != 3)
538 return 0;
539 /* We found a hub */
ceb4972a 540 debug("USB hub found\n");
23faf2bc
MV		 541 ret = usb_hub_configure(dev);
542 return ret;
543}
"Das U-Boot" Source Tree