common/usb.c

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