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