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