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