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