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