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