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