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