common/usb.c

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