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