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