common/usb.c

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