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 * How it works: 40 * 41 * Since this is a bootloader, the devices will not be automatic 42 * (re)configured on hotplug, but after a restart of the USB the 43 * device should work. 44 * 45 * For each transfer (except "Interrupt") we wait for completion. 46 */ 47 #include <common.h> 48 #include <command.h> 49 #include <asm/processor.h> 50 #include <linux/compiler.h> 51 #include <linux/ctype.h> 52 #include <asm/byteorder.h> 53 #include <asm/unaligned.h> 54 55 #include <usb.h> 56 #ifdef CONFIG_4xx 57 #include <asm/4xx_pci.h> 58 #endif 59 60 #define USB_BUFSIZ 512 61 62 static struct usb_device usb_dev[USB_MAX_DEVICE]; 63 static int dev_index; 64 static int asynch_allowed; 65 66 char usb_started; /* flag for the started/stopped USB status */ 67 68 #ifndef CONFIG_USB_MAX_CONTROLLER_COUNT 69 #define CONFIG_USB_MAX_CONTROLLER_COUNT 1 70 #endif 71 72 /*************************************************************************** 73 * Init USB Device 74 */ 75 int usb_init(void) 76 { 77 void *ctrl; 78 struct usb_device *dev; 79 int i, start_index = 0; 80 81 dev_index = 0; 82 asynch_allowed = 1; 83 usb_hub_reset(); 84 85 /* first make all devices unknown */ 86 for (i = 0; i < USB_MAX_DEVICE; i++) { 87 memset(&usb_dev[i], 0, sizeof(struct usb_device)); 88 usb_dev[i].devnum = -1; 89 } 90 91 /* init low_level USB */ 92 for (i = 0; i < CONFIG_USB_MAX_CONTROLLER_COUNT; i++) { 93 /* init low_level USB */ 94 printf("USB%d: ", i); 95 if (usb_lowlevel_init(i, &ctrl)) { 96 puts("lowlevel init failed\n"); 97 continue; 98 } 99 /* 100 * lowlevel init is OK, now scan the bus for devices 101 * i.e. search HUBs and configure them 102 */ 103 start_index = dev_index; 104 printf("scanning bus %d for devices... ", i); 105 dev = usb_alloc_new_device(ctrl); 106 /* 107 * device 0 is always present 108 * (root hub, so let it analyze) 109 */ 110 if (dev) 111 usb_new_device(dev); 112 113 if (start_index == dev_index) 114 puts("No USB Device found\n"); 115 else 116 printf("%d USB Device(s) found\n", 117 dev_index - start_index); 118 119 usb_started = 1; 120 } 121 122 debug("scan end\n"); 123 /* if we were not able to find at least one working bus, bail out */ 124 if (!usb_started) { 125 puts("USB error: all controllers failed lowlevel init\n"); 126 return -1; 127 } 128 129 return 0; 130 } 131 132 /****************************************************************************** 133 * Stop USB this stops the LowLevel Part and deregisters USB devices. 134 */ 135 int usb_stop(void) 136 { 137 int i; 138 139 if (usb_started) { 140 asynch_allowed = 1; 141 usb_started = 0; 142 usb_hub_reset(); 143 144 for (i = 0; i < CONFIG_USB_MAX_CONTROLLER_COUNT; i++) { 145 if (usb_lowlevel_stop(i)) 146 printf("failed to stop USB controller %d\n", i); 147 } 148 } 149 150 return 0; 151 } 152 153 /* 154 * disables the asynch behaviour of the control message. This is used for data 155 * transfers that uses the exclusiv access to the control and bulk messages. 156 * Returns the old value so it can be restored later. 157 */ 158 int usb_disable_asynch(int disable) 159 { 160 int old_value = asynch_allowed; 161 162 asynch_allowed = !disable; 163 return old_value; 164 } 165 166 167 /*------------------------------------------------------------------- 168 * Message wrappers. 169 * 170 */ 171 172 /* 173 * submits an Interrupt Message 174 */ 175 int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe, 176 void *buffer, int transfer_len, int interval) 177 { 178 return submit_int_msg(dev, pipe, buffer, transfer_len, interval); 179 } 180 181 /* 182 * submits a control message and waits for comletion (at least timeout * 1ms) 183 * If timeout is 0, we don't wait for completion (used as example to set and 184 * clear keyboards LEDs). For data transfers, (storage transfers) we don't 185 * allow control messages with 0 timeout, by previousely resetting the flag 186 * asynch_allowed (usb_disable_asynch(1)). 187 * returns the transfered length if OK or -1 if error. The transfered length 188 * and the current status are stored in the dev->act_len and dev->status. 189 */ 190 int usb_control_msg(struct usb_device *dev, unsigned int pipe, 191 unsigned char request, unsigned char requesttype, 192 unsigned short value, unsigned short index, 193 void *data, unsigned short size, int timeout) 194 { 195 ALLOC_CACHE_ALIGN_BUFFER(struct devrequest, setup_packet, 1); 196 197 if ((timeout == 0) && (!asynch_allowed)) { 198 /* request for a asynch control pipe is not allowed */ 199 return -1; 200 } 201 202 /* set setup command */ 203 setup_packet->requesttype = requesttype; 204 setup_packet->request = request; 205 setup_packet->value = cpu_to_le16(value); 206 setup_packet->index = cpu_to_le16(index); 207 setup_packet->length = cpu_to_le16(size); 208 debug("usb_control_msg: request: 0x%X, requesttype: 0x%X, " \ 209 "value 0x%X index 0x%X length 0x%X\n", 210 request, requesttype, value, index, size); 211 dev->status = USB_ST_NOT_PROC; /*not yet processed */ 212 213 if (submit_control_msg(dev, pipe, data, size, setup_packet) < 0) 214 return -1; 215 if (timeout == 0) 216 return (int)size; 217 218 /* 219 * Wait for status to update until timeout expires, USB driver 220 * interrupt handler may set the status when the USB operation has 221 * been completed. 222 */ 223 while (timeout--) { 224 if (!((volatile unsigned long)dev->status & USB_ST_NOT_PROC)) 225 break; 226 mdelay(1); 227 } 228 if (dev->status) 229 return -1; 230 231 return dev->act_len; 232 233 } 234 235 /*------------------------------------------------------------------- 236 * submits bulk message, and waits for completion. returns 0 if Ok or 237 * -1 if Error. 238 * synchronous behavior 239 */ 240 int usb_bulk_msg(struct usb_device *dev, unsigned int pipe, 241 void *data, int len, int *actual_length, int timeout) 242 { 243 if (len < 0) 244 return -1; 245 dev->status = USB_ST_NOT_PROC; /*not yet processed */ 246 if (submit_bulk_msg(dev, pipe, data, len) < 0) 247 return -1; 248 while (timeout--) { 249 if (!((volatile unsigned long)dev->status & USB_ST_NOT_PROC)) 250 break; 251 mdelay(1); 252 } 253 *actual_length = dev->act_len; 254 if (dev->status == 0) 255 return 0; 256 else 257 return -1; 258 } 259 260 261 /*------------------------------------------------------------------- 262 * Max Packet stuff 263 */ 264 265 /* 266 * returns the max packet size, depending on the pipe direction and 267 * the configurations values 268 */ 269 int usb_maxpacket(struct usb_device *dev, unsigned long pipe) 270 { 271 /* direction is out -> use emaxpacket out */ 272 if ((pipe & USB_DIR_IN) == 0) 273 return dev->epmaxpacketout[((pipe>>15) & 0xf)]; 274 else 275 return dev->epmaxpacketin[((pipe>>15) & 0xf)]; 276 } 277 278 /* 279 * The routine usb_set_maxpacket_ep() is extracted from the loop of routine 280 * usb_set_maxpacket(), because the optimizer of GCC 4.x chokes on this routine 281 * when it is inlined in 1 single routine. What happens is that the register r3 282 * is used as loop-count 'i', but gets overwritten later on. 283 * This is clearly a compiler bug, but it is easier to workaround it here than 284 * to update the compiler (Occurs with at least several GCC 4.{1,2},x 285 * CodeSourcery compilers like e.g. 2007q3, 2008q1, 2008q3 lite editions on ARM) 286 * 287 * NOTE: Similar behaviour was observed with GCC4.6 on ARMv5. 288 */ 289 static void noinline 290 usb_set_maxpacket_ep(struct usb_device *dev, int if_idx, int ep_idx) 291 { 292 int b; 293 struct usb_endpoint_descriptor *ep; 294 u16 ep_wMaxPacketSize; 295 296 ep = &dev->config.if_desc[if_idx].ep_desc[ep_idx]; 297 298 b = ep->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK; 299 ep_wMaxPacketSize = get_unaligned(&ep->wMaxPacketSize); 300 301 if ((ep->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == 302 USB_ENDPOINT_XFER_CONTROL) { 303 /* Control => bidirectional */ 304 dev->epmaxpacketout[b] = ep_wMaxPacketSize; 305 dev->epmaxpacketin[b] = ep_wMaxPacketSize; 306 debug("##Control EP epmaxpacketout/in[%d] = %d\n", 307 b, dev->epmaxpacketin[b]); 308 } else { 309 if ((ep->bEndpointAddress & 0x80) == 0) { 310 /* OUT Endpoint */ 311 if (ep_wMaxPacketSize > dev->epmaxpacketout[b]) { 312 dev->epmaxpacketout[b] = ep_wMaxPacketSize; 313 debug("##EP epmaxpacketout[%d] = %d\n", 314 b, dev->epmaxpacketout[b]); 315 } 316 } else { 317 /* IN Endpoint */ 318 if (ep_wMaxPacketSize > dev->epmaxpacketin[b]) { 319 dev->epmaxpacketin[b] = ep_wMaxPacketSize; 320 debug("##EP epmaxpacketin[%d] = %d\n", 321 b, dev->epmaxpacketin[b]); 322 } 323 } /* if out */ 324 } /* if control */ 325 } 326 327 /* 328 * set the max packed value of all endpoints in the given configuration 329 */ 330 static int usb_set_maxpacket(struct usb_device *dev) 331 { 332 int i, ii; 333 334 for (i = 0; i < dev->config.desc.bNumInterfaces; i++) 335 for (ii = 0; ii < dev->config.if_desc[i].desc.bNumEndpoints; ii++) 336 usb_set_maxpacket_ep(dev, i, ii); 337 338 return 0; 339 } 340 341 /******************************************************************************* 342 * Parse the config, located in buffer, and fills the dev->config structure. 343 * Note that all little/big endian swapping are done automatically. 344 */ 345 static int usb_parse_config(struct usb_device *dev, 346 unsigned char *buffer, int cfgno) 347 { 348 struct usb_descriptor_header *head; 349 int index, ifno, epno, curr_if_num; 350 u16 ep_wMaxPacketSize; 351 352 ifno = -1; 353 epno = -1; 354 curr_if_num = -1; 355 356 dev->configno = cfgno; 357 head = (struct usb_descriptor_header *) &buffer[0]; 358 if (head->bDescriptorType != USB_DT_CONFIG) { 359 printf(" ERROR: NOT USB_CONFIG_DESC %x\n", 360 head->bDescriptorType); 361 return -1; 362 } 363 memcpy(&dev->config, buffer, buffer[0]); 364 le16_to_cpus(&(dev->config.desc.wTotalLength)); 365 dev->config.no_of_if = 0; 366 367 index = dev->config.desc.bLength; 368 /* Ok the first entry must be a configuration entry, 369 * now process the others */ 370 head = (struct usb_descriptor_header *) &buffer[index]; 371 while (index + 1 < dev->config.desc.wTotalLength) { 372 switch (head->bDescriptorType) { 373 case USB_DT_INTERFACE: 374 if (((struct usb_interface_descriptor *) \ 375 &buffer[index])->bInterfaceNumber != curr_if_num) { 376 /* this is a new interface, copy new desc */ 377 ifno = dev->config.no_of_if; 378 dev->config.no_of_if++; 379 memcpy(&dev->config.if_desc[ifno], 380 &buffer[index], buffer[index]); 381 dev->config.if_desc[ifno].no_of_ep = 0; 382 dev->config.if_desc[ifno].num_altsetting = 1; 383 curr_if_num = 384 dev->config.if_desc[ifno].desc.bInterfaceNumber; 385 } else { 386 /* found alternate setting for the interface */ 387 dev->config.if_desc[ifno].num_altsetting++; 388 } 389 break; 390 case USB_DT_ENDPOINT: 391 epno = dev->config.if_desc[ifno].no_of_ep; 392 /* found an endpoint */ 393 dev->config.if_desc[ifno].no_of_ep++; 394 memcpy(&dev->config.if_desc[ifno].ep_desc[epno], 395 &buffer[index], buffer[index]); 396 ep_wMaxPacketSize = get_unaligned(&dev->config.\ 397 if_desc[ifno].\ 398 ep_desc[epno].\ 399 wMaxPacketSize); 400 put_unaligned(le16_to_cpu(ep_wMaxPacketSize), 401 &dev->config.\ 402 if_desc[ifno].\ 403 ep_desc[epno].\ 404 wMaxPacketSize); 405 debug("if %d, ep %d\n", ifno, epno); 406 break; 407 default: 408 if (head->bLength == 0) 409 return 1; 410 411 debug("unknown Description Type : %x\n", 412 head->bDescriptorType); 413 414 #ifdef DEBUG 415 { 416 unsigned char *ch = (unsigned char *)head; 417 int i; 418 419 for (i = 0; i < head->bLength; i++) 420 debug("%02X ", *ch++); 421 debug("\n\n\n"); 422 } 423 #endif 424 break; 425 } 426 index += head->bLength; 427 head = (struct usb_descriptor_header *)&buffer[index]; 428 } 429 return 1; 430 } 431 432 /*********************************************************************** 433 * Clears an endpoint 434 * endp: endpoint number in bits 0-3; 435 * direction flag in bit 7 (1 = IN, 0 = OUT) 436 */ 437 int usb_clear_halt(struct usb_device *dev, int pipe) 438 { 439 int result; 440 int endp = usb_pipeendpoint(pipe)|(usb_pipein(pipe)<<7); 441 442 result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), 443 USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT, 0, 444 endp, NULL, 0, USB_CNTL_TIMEOUT * 3); 445 446 /* don't clear if failed */ 447 if (result < 0) 448 return result; 449 450 /* 451 * NOTE: we do not get status and verify reset was successful 452 * as some devices are reported to lock up upon this check.. 453 */ 454 455 usb_endpoint_running(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe)); 456 457 /* toggle is reset on clear */ 458 usb_settoggle(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe), 0); 459 return 0; 460 } 461 462 463 /********************************************************************** 464 * get_descriptor type 465 */ 466 static int usb_get_descriptor(struct usb_device *dev, unsigned char type, 467 unsigned char index, void *buf, int size) 468 { 469 int res; 470 res = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), 471 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN, 472 (type << 8) + index, 0, 473 buf, size, USB_CNTL_TIMEOUT); 474 return res; 475 } 476 477 /********************************************************************** 478 * gets configuration cfgno and store it in the buffer 479 */ 480 int usb_get_configuration_no(struct usb_device *dev, 481 unsigned char *buffer, int cfgno) 482 { 483 int result; 484 unsigned int tmp; 485 struct usb_config_descriptor *config; 486 487 config = (struct usb_config_descriptor *)&buffer[0]; 488 result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, 9); 489 if (result < 9) { 490 if (result < 0) 491 printf("unable to get descriptor, error %lX\n", 492 dev->status); 493 else 494 printf("config descriptor too short " \ 495 "(expected %i, got %i)\n", 9, result); 496 return -1; 497 } 498 tmp = le16_to_cpu(config->wTotalLength); 499 500 if (tmp > USB_BUFSIZ) { 501 printf("usb_get_configuration_no: failed to get " \ 502 "descriptor - too long: %d\n", tmp); 503 return -1; 504 } 505 506 result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, tmp); 507 debug("get_conf_no %d Result %d, wLength %d\n", cfgno, result, tmp); 508 return result; 509 } 510 511 /******************************************************************** 512 * set address of a device to the value in dev->devnum. 513 * This can only be done by addressing the device via the default address (0) 514 */ 515 static int usb_set_address(struct usb_device *dev) 516 { 517 int res; 518 519 debug("set address %d\n", dev->devnum); 520 res = usb_control_msg(dev, usb_snddefctrl(dev), 521 USB_REQ_SET_ADDRESS, 0, 522 (dev->devnum), 0, 523 NULL, 0, USB_CNTL_TIMEOUT); 524 return res; 525 } 526 527 /******************************************************************** 528 * set interface number to interface 529 */ 530 int usb_set_interface(struct usb_device *dev, int interface, int alternate) 531 { 532 struct usb_interface *if_face = NULL; 533 int ret, i; 534 535 for (i = 0; i < dev->config.desc.bNumInterfaces; i++) { 536 if (dev->config.if_desc[i].desc.bInterfaceNumber == interface) { 537 if_face = &dev->config.if_desc[i]; 538 break; 539 } 540 } 541 if (!if_face) { 542 printf("selecting invalid interface %d", interface); 543 return -1; 544 } 545 /* 546 * We should return now for devices with only one alternate setting. 547 * According to 9.4.10 of the Universal Serial Bus Specification 548 * Revision 2.0 such devices can return with a STALL. This results in 549 * some USB sticks timeouting during initialization and then being 550 * unusable in U-Boot. 551 */ 552 if (if_face->num_altsetting == 1) 553 return 0; 554 555 ret = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), 556 USB_REQ_SET_INTERFACE, USB_RECIP_INTERFACE, 557 alternate, interface, NULL, 0, 558 USB_CNTL_TIMEOUT * 5); 559 if (ret < 0) 560 return ret; 561 562 return 0; 563 } 564 565 /******************************************************************** 566 * set configuration number to configuration 567 */ 568 static int usb_set_configuration(struct usb_device *dev, int configuration) 569 { 570 int res; 571 debug("set configuration %d\n", configuration); 572 /* set setup command */ 573 res = usb_control_msg(dev, usb_sndctrlpipe(dev, 0), 574 USB_REQ_SET_CONFIGURATION, 0, 575 configuration, 0, 576 NULL, 0, USB_CNTL_TIMEOUT); 577 if (res == 0) { 578 dev->toggle[0] = 0; 579 dev->toggle[1] = 0; 580 return 0; 581 } else 582 return -1; 583 } 584 585 /******************************************************************** 586 * set protocol to protocol 587 */ 588 int usb_set_protocol(struct usb_device *dev, int ifnum, int protocol) 589 { 590 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0), 591 USB_REQ_SET_PROTOCOL, USB_TYPE_CLASS | USB_RECIP_INTERFACE, 592 protocol, ifnum, NULL, 0, USB_CNTL_TIMEOUT); 593 } 594 595 /******************************************************************** 596 * set idle 597 */ 598 int usb_set_idle(struct usb_device *dev, int ifnum, int duration, int report_id) 599 { 600 return usb_control_msg(dev, usb_sndctrlpipe(dev, 0), 601 USB_REQ_SET_IDLE, USB_TYPE_CLASS | USB_RECIP_INTERFACE, 602 (duration << 8) | report_id, ifnum, NULL, 0, USB_CNTL_TIMEOUT); 603 } 604 605 /******************************************************************** 606 * get report 607 */ 608 int usb_get_report(struct usb_device *dev, int ifnum, unsigned char type, 609 unsigned char id, void *buf, int size) 610 { 611 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), 612 USB_REQ_GET_REPORT, 613 USB_DIR_IN | USB_TYPE_CLASS | USB_RECIP_INTERFACE, 614 (type << 8) + id, ifnum, buf, size, USB_CNTL_TIMEOUT); 615 } 616 617 /******************************************************************** 618 * get class descriptor 619 */ 620 int usb_get_class_descriptor(struct usb_device *dev, int ifnum, 621 unsigned char type, unsigned char id, void *buf, int size) 622 { 623 return usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), 624 USB_REQ_GET_DESCRIPTOR, USB_RECIP_INTERFACE | USB_DIR_IN, 625 (type << 8) + id, ifnum, buf, size, USB_CNTL_TIMEOUT); 626 } 627 628 /******************************************************************** 629 * get string index in buffer 630 */ 631 static int usb_get_string(struct usb_device *dev, unsigned short langid, 632 unsigned char index, void *buf, int size) 633 { 634 int i; 635 int result; 636 637 for (i = 0; i < 3; ++i) { 638 /* some devices are flaky */ 639 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0), 640 USB_REQ_GET_DESCRIPTOR, USB_DIR_IN, 641 (USB_DT_STRING << 8) + index, langid, buf, size, 642 USB_CNTL_TIMEOUT); 643 644 if (result > 0) 645 break; 646 } 647 648 return result; 649 } 650 651 652 static void usb_try_string_workarounds(unsigned char *buf, int *length) 653 { 654 int newlength, oldlength = *length; 655 656 for (newlength = 2; newlength + 1 < oldlength; newlength += 2) 657 if (!isprint(buf[newlength]) || buf[newlength + 1]) 658 break; 659 660 if (newlength > 2) { 661 buf[0] = newlength; 662 *length = newlength; 663 } 664 } 665 666 667 static int usb_string_sub(struct usb_device *dev, unsigned int langid, 668 unsigned int index, unsigned char *buf) 669 { 670 int rc; 671 672 /* Try to read the string descriptor by asking for the maximum 673 * possible number of bytes */ 674 rc = usb_get_string(dev, langid, index, buf, 255); 675 676 /* If that failed try to read the descriptor length, then 677 * ask for just that many bytes */ 678 if (rc < 2) { 679 rc = usb_get_string(dev, langid, index, buf, 2); 680 if (rc == 2) 681 rc = usb_get_string(dev, langid, index, buf, buf[0]); 682 } 683 684 if (rc >= 2) { 685 if (!buf[0] && !buf[1]) 686 usb_try_string_workarounds(buf, &rc); 687 688 /* There might be extra junk at the end of the descriptor */ 689 if (buf[0] < rc) 690 rc = buf[0]; 691 692 rc = rc - (rc & 1); /* force a multiple of two */ 693 } 694 695 if (rc < 2) 696 rc = -1; 697 698 return rc; 699 } 700 701 702 /******************************************************************** 703 * usb_string: 704 * Get string index and translate it to ascii. 705 * returns string length (> 0) or error (< 0) 706 */ 707 int usb_string(struct usb_device *dev, int index, char *buf, size_t size) 708 { 709 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, mybuf, USB_BUFSIZ); 710 unsigned char *tbuf; 711 int err; 712 unsigned int u, idx; 713 714 if (size <= 0 || !buf || !index) 715 return -1; 716 buf[0] = 0; 717 tbuf = &mybuf[0]; 718 719 /* get langid for strings if it's not yet known */ 720 if (!dev->have_langid) { 721 err = usb_string_sub(dev, 0, 0, tbuf); 722 if (err < 0) { 723 debug("error getting string descriptor 0 " \ 724 "(error=%lx)\n", dev->status); 725 return -1; 726 } else if (tbuf[0] < 4) { 727 debug("string descriptor 0 too short\n"); 728 return -1; 729 } else { 730 dev->have_langid = -1; 731 dev->string_langid = tbuf[2] | (tbuf[3] << 8); 732 /* always use the first langid listed */ 733 debug("USB device number %d default " \ 734 "language ID 0x%x\n", 735 dev->devnum, dev->string_langid); 736 } 737 } 738 739 err = usb_string_sub(dev, dev->string_langid, index, tbuf); 740 if (err < 0) 741 return err; 742 743 size--; /* leave room for trailing NULL char in output buffer */ 744 for (idx = 0, u = 2; u < err; u += 2) { 745 if (idx >= size) 746 break; 747 if (tbuf[u+1]) /* high byte */ 748 buf[idx++] = '?'; /* non-ASCII character */ 749 else 750 buf[idx++] = tbuf[u]; 751 } 752 buf[idx] = 0; 753 err = idx; 754 return err; 755 } 756 757 758 /******************************************************************** 759 * USB device handling: 760 * the USB device are static allocated [USB_MAX_DEVICE]. 761 */ 762 763 764 /* returns a pointer to the device with the index [index]. 765 * if the device is not assigned (dev->devnum==-1) returns NULL 766 */ 767 struct usb_device *usb_get_dev_index(int index) 768 { 769 if (usb_dev[index].devnum == -1) 770 return NULL; 771 else 772 return &usb_dev[index]; 773 } 774 775 /* returns a pointer of a new device structure or NULL, if 776 * no device struct is available 777 */ 778 struct usb_device *usb_alloc_new_device(void *controller) 779 { 780 int i; 781 debug("New Device %d\n", dev_index); 782 if (dev_index == USB_MAX_DEVICE) { 783 printf("ERROR, too many USB Devices, max=%d\n", USB_MAX_DEVICE); 784 return NULL; 785 } 786 /* default Address is 0, real addresses start with 1 */ 787 usb_dev[dev_index].devnum = dev_index + 1; 788 usb_dev[dev_index].maxchild = 0; 789 for (i = 0; i < USB_MAXCHILDREN; i++) 790 usb_dev[dev_index].children[i] = NULL; 791 usb_dev[dev_index].parent = NULL; 792 usb_dev[dev_index].controller = controller; 793 dev_index++; 794 return &usb_dev[dev_index - 1]; 795 } 796 797 /* 798 * Free the newly created device node. 799 * Called in error cases where configuring a newly attached 800 * device fails for some reason. 801 */ 802 void usb_free_device(void) 803 { 804 dev_index--; 805 debug("Freeing device node: %d\n", dev_index); 806 memset(&usb_dev[dev_index], 0, sizeof(struct usb_device)); 807 usb_dev[dev_index].devnum = -1; 808 } 809 810 /* 811 * By the time we get here, the device has gotten a new device ID 812 * and is in the default state. We need to identify the thing and 813 * get the ball rolling.. 814 * 815 * Returns 0 for success, != 0 for error. 816 */ 817 int usb_new_device(struct usb_device *dev) 818 { 819 int addr, err; 820 int tmp; 821 ALLOC_CACHE_ALIGN_BUFFER(unsigned char, tmpbuf, USB_BUFSIZ); 822 823 /* We still haven't set the Address yet */ 824 addr = dev->devnum; 825 dev->devnum = 0; 826 827 #ifdef CONFIG_LEGACY_USB_INIT_SEQ 828 /* this is the old and known way of initializing devices, it is 829 * different than what Windows and Linux are doing. Windows and Linux 830 * both retrieve 64 bytes while reading the device descriptor 831 * Several USB stick devices report ERR: CTL_TIMEOUT, caused by an 832 * invalid header while reading 8 bytes as device descriptor. */ 833 dev->descriptor.bMaxPacketSize0 = 8; /* Start off at 8 bytes */ 834 dev->maxpacketsize = PACKET_SIZE_8; 835 dev->epmaxpacketin[0] = 8; 836 dev->epmaxpacketout[0] = 8; 837 838 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, tmpbuf, 8); 839 if (err < 8) { 840 printf("\n USB device not responding, " \ 841 "giving up (status=%lX)\n", dev->status); 842 return 1; 843 } 844 memcpy(&dev->descriptor, tmpbuf, 8); 845 #else 846 /* This is a Windows scheme of initialization sequence, with double 847 * reset of the device (Linux uses the same sequence) 848 * Some equipment is said to work only with such init sequence; this 849 * patch is based on the work by Alan Stern: 850 * http://sourceforge.net/mailarchive/forum.php? 851 * thread_id=5729457&forum_id=5398 852 */ 853 struct usb_device_descriptor *desc; 854 int port = -1; 855 struct usb_device *parent = dev->parent; 856 unsigned short portstatus; 857 858 /* send 64-byte GET-DEVICE-DESCRIPTOR request. Since the descriptor is 859 * only 18 bytes long, this will terminate with a short packet. But if 860 * the maxpacket size is 8 or 16 the device may be waiting to transmit 861 * some more, or keeps on retransmitting the 8 byte header. */ 862 863 desc = (struct usb_device_descriptor *)tmpbuf; 864 dev->descriptor.bMaxPacketSize0 = 64; /* Start off at 64 bytes */ 865 /* Default to 64 byte max packet size */ 866 dev->maxpacketsize = PACKET_SIZE_64; 867 dev->epmaxpacketin[0] = 64; 868 dev->epmaxpacketout[0] = 64; 869 870 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, desc, 64); 871 if (err < 0) { 872 debug("usb_new_device: usb_get_descriptor() failed\n"); 873 return 1; 874 } 875 876 dev->descriptor.bMaxPacketSize0 = desc->bMaxPacketSize0; 877 878 /* find the port number we're at */ 879 if (parent) { 880 int j; 881 882 for (j = 0; j < parent->maxchild; j++) { 883 if (parent->children[j] == dev) { 884 port = j; 885 break; 886 } 887 } 888 if (port < 0) { 889 printf("usb_new_device:cannot locate device's port.\n"); 890 return 1; 891 } 892 893 /* reset the port for the second time */ 894 err = hub_port_reset(dev->parent, port, &portstatus); 895 if (err < 0) { 896 printf("\n Couldn't reset port %i\n", port); 897 return 1; 898 } 899 } 900 #endif 901 902 dev->epmaxpacketin[0] = dev->descriptor.bMaxPacketSize0; 903 dev->epmaxpacketout[0] = dev->descriptor.bMaxPacketSize0; 904 switch (dev->descriptor.bMaxPacketSize0) { 905 case 8: 906 dev->maxpacketsize = PACKET_SIZE_8; 907 break; 908 case 16: 909 dev->maxpacketsize = PACKET_SIZE_16; 910 break; 911 case 32: 912 dev->maxpacketsize = PACKET_SIZE_32; 913 break; 914 case 64: 915 dev->maxpacketsize = PACKET_SIZE_64; 916 break; 917 } 918 dev->devnum = addr; 919 920 err = usb_set_address(dev); /* set address */ 921 922 if (err < 0) { 923 printf("\n USB device not accepting new address " \ 924 "(error=%lX)\n", dev->status); 925 return 1; 926 } 927 928 mdelay(10); /* Let the SET_ADDRESS settle */ 929 930 tmp = sizeof(dev->descriptor); 931 932 err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, 933 tmpbuf, sizeof(dev->descriptor)); 934 if (err < tmp) { 935 if (err < 0) 936 printf("unable to get device descriptor (error=%d)\n", 937 err); 938 else 939 printf("USB device descriptor short read " \ 940 "(expected %i, got %i)\n", tmp, err); 941 return 1; 942 } 943 memcpy(&dev->descriptor, tmpbuf, sizeof(dev->descriptor)); 944 /* correct le values */ 945 le16_to_cpus(&dev->descriptor.bcdUSB); 946 le16_to_cpus(&dev->descriptor.idVendor); 947 le16_to_cpus(&dev->descriptor.idProduct); 948 le16_to_cpus(&dev->descriptor.bcdDevice); 949 /* only support for one config for now */ 950 err = usb_get_configuration_no(dev, tmpbuf, 0); 951 if (err < 0) { 952 printf("usb_new_device: Cannot read configuration, " \ 953 "skipping device %04x:%04x\n", 954 dev->descriptor.idVendor, dev->descriptor.idProduct); 955 return -1; 956 } 957 usb_parse_config(dev, tmpbuf, 0); 958 usb_set_maxpacket(dev); 959 /* we set the default configuration here */ 960 if (usb_set_configuration(dev, dev->config.desc.bConfigurationValue)) { 961 printf("failed to set default configuration " \ 962 "len %d, status %lX\n", dev->act_len, dev->status); 963 return -1; 964 } 965 debug("new device strings: Mfr=%d, Product=%d, SerialNumber=%d\n", 966 dev->descriptor.iManufacturer, dev->descriptor.iProduct, 967 dev->descriptor.iSerialNumber); 968 memset(dev->mf, 0, sizeof(dev->mf)); 969 memset(dev->prod, 0, sizeof(dev->prod)); 970 memset(dev->serial, 0, sizeof(dev->serial)); 971 if (dev->descriptor.iManufacturer) 972 usb_string(dev, dev->descriptor.iManufacturer, 973 dev->mf, sizeof(dev->mf)); 974 if (dev->descriptor.iProduct) 975 usb_string(dev, dev->descriptor.iProduct, 976 dev->prod, sizeof(dev->prod)); 977 if (dev->descriptor.iSerialNumber) 978 usb_string(dev, dev->descriptor.iSerialNumber, 979 dev->serial, sizeof(dev->serial)); 980 debug("Manufacturer %s\n", dev->mf); 981 debug("Product %s\n", dev->prod); 982 debug("SerialNumber %s\n", dev->serial); 983 /* now prode if the device is a hub */ 984 usb_hub_probe(dev, 0); 985 return 0; 986 } 987 988 /* EOF */ 989