common/usb.c

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