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