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