common/usb.c

   1 /*
   2  * Most of this source has been derived from the Linux USB
   3  * project:
   4  * (C) Copyright Linus Torvalds 1999
   5  * (C) Copyright Johannes Erdfelt 1999-2001
   6  * (C) Copyright Andreas Gal 1999
   7  * (C) Copyright Gregory P. Smith 1999
   8  * (C) Copyright Deti Fliegl 1999 (new USB architecture)
   9  * (C) Copyright Randy Dunlap 2000
  10  * (C) Copyright David Brownell 2000 (kernel hotplug, usb_device_id)
  11  * (C) Copyright Yggdrasil Computing, Inc. 2000
  12  *     (usb_device_id matching changes by Adam J. Richter)
  13  *
  14  * Adapted for U-Boot:
  15  * (C) Copyright 2001 Denis Peter, MPL AG Switzerland
  16  *
  17  * SPDX-License-Identifier:     GPL-2.0+
  18  */
  19
  20 /*
  21  * How it works:
  22  *
  23  * Since this is a bootloader, the devices will not be automatic
  24  * (re)configured on hotplug, but after a restart of the USB the
  25  * device should work.
  26  *
  27  * For each transfer (except "Interrupt") we wait for completion.
  28  */
  29 #include <common.h>
  30 #include <command.h>
  31 #include <dm.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 #ifdef CONFIG_4xx
  40 #include <asm/4xx_pci.h>
  41 #endif
  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 #ifndef CONFIG_DM_USB
  49 static struct usb_device usb_dev[USB_MAX_DEVICE];
  50 static int dev_index;
  51
  52 #ifndef CONFIG_USB_MAX_CONTROLLER_COUNT
  53 #define CONFIG_USB_MAX_CONTROLLER_COUNT 1
  54 #endif
  55
  56 /***************************************************************************
  57  * Init USB Device
  58  */
  59 int usb_init(void)
  60 {
  61         void *ctrl;
  62         struct usb_device *dev;
  63         int i, start_index = 0;
  64         int controllers_initialized = 0;
  65         int ret;
  66
  67         dev_index = 0;
  68         asynch_allowed = 1;
  69         usb_hub_reset();
  70
  71         /* first make all devices unknown */
  72         for (i = 0; i < USB_MAX_DEVICE; i++) {
  73                 memset(&usb_dev[i], 0, sizeof(struct usb_device));
  74                 usb_dev[i].devnum = -1;
  75         }
  76
  77         /* init low_level USB */
  78         for (i = 0; i < CONFIG_USB_MAX_CONTROLLER_COUNT; i++) {
  79                 /* init low_level USB */
  80                 printf("USB%d:   ", i);
  81                 ret = usb_lowlevel_init(i, USB_INIT_HOST, &ctrl);
  82                 if (ret == -ENODEV) {   /* No such device. */
  83                         puts("Port not available.\n");
  84                         controllers_initialized++;
  85                         continue;
  86                 }
  87
  88                 if (ret) {              /* Other error. */
  89                         puts("lowlevel init failed\n");
  90                         continue;
  91                 }
  92                 /*
  93                  * lowlevel init is OK, now scan the bus for devices
  94                  * i.e. search HUBs and configure them
  95                  */
  96                 controllers_initialized++;
  97                 start_index = dev_index;
  98                 printf("scanning bus %d for devices... ", i);
  99                 ret = usb_alloc_new_device(ctrl, &dev);
 100                 if (ret)
 101                         break;
 102
 103                 /*
 104                  * device 0 is always present
 105                  * (root hub, so let it analyze)
 106                  */
 107                 ret = usb_new_device(dev);
 108                 if (ret)
 109                         usb_free_device(dev->controller);
 110
 111                 if (start_index == dev_index) {
 112                         puts("No USB Device found\n");
 113                         continue;
 114                 } else {
 115                         printf("%d USB Device(s) found\n",
 116                                 dev_index - start_index);
 117                 }
 118
 119                 usb_started = 1;
 120         }
 121
 122         debug("scan end\n");
 123         /* if we were not able to find at least one working bus, bail out */
 124         if (controllers_initialized == 0)
 125                 puts("USB error: all controllers failed lowlevel init\n");
 126
 127         return usb_started ? 0 : -ENODEV;
 128 }
 129
 130 /******************************************************************************
 131  * Stop USB this stops the LowLevel Part and deregisters USB devices.
 132  */
 133 int usb_stop(void)
 134 {
 135         int i;
 136
 137         if (usb_started) {
 138                 asynch_allowed = 1;
 139                 usb_started = 0;
 140                 usb_hub_reset();
 141
 142                 for (i = 0; i < CONFIG_USB_MAX_CONTROLLER_COUNT; i++) {
 143                         if (usb_lowlevel_stop(i))
 144                                 printf("failed to stop USB controller %d\n", i);
 145                 }
 146         }
 147
 148         return 0;
 149 }
 150
 151 /******************************************************************************
 152  * Detect if a USB device has been plugged or unplugged.
 153  */
 154 int usb_detect_change(void)
 155 {
 156         int i, j;
 157         int change = 0;
 158
 159         for (j = 0; j < USB_MAX_DEVICE; j++) {
 160                 for (i = 0; i < usb_dev[j].maxchild; i++) {
 161                         struct usb_port_status status;
 162
 163                         if (usb_get_port_status(&usb_dev[j], i + 1,
 164                                                 &status) < 0)
 165                                 /* USB request failed */
 166                                 continue;
 167
 168                         if (le16_to_cpu(status.wPortChange) &
 169                             USB_PORT_STAT_C_CONNECTION)
 170                                 change++;
 171                 }
 172         }
 173
 174         return change;
 175 }
 176
 177 /*
 178  * disables the asynch behaviour of the control message. This is used for data
 179  * transfers that uses the exclusiv access to the control and bulk messages.
 180  * Returns the old value so it can be restored later.
 181  */
 182 int usb_disable_asynch(int disable)
 183 {
 184         int old_value = asynch_allowed;
 185
 186         asynch_allowed = !disable;
 187         return old_value;
 188 }
 189 #endif /* !CONFIG_DM_USB */
 190
 191
 192 /*-------------------------------------------------------------------
 193  * Message wrappers.
 194  *
 195  */
 196
 197 /*
 198  * submits an Interrupt Message
 199  */
 200 int usb_submit_int_msg(struct usb_device *dev, unsigned long pipe,
 201                         void *buffer, int transfer_len, int interval)
 202 {
 203         return submit_int_msg(dev, pipe, buffer, transfer_len, interval);
 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 transfered length if OK or -1 if error. The transfered 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                                 printf("ERROR: Invalid USB EP length (%d)\n",
 444                                         head->bLength);
 445                                 break;
 446                         }
 447                         if (index + USB_DT_ENDPOINT_SIZE >
 448                             dev->config.desc.wTotalLength) {
 449                                 puts("USB EP descriptor overflowed buffer!\n");
 450                                 break;
 451                         }
 452                         if (ifno < 0) {
 453                                 puts("Endpoint descriptor out of order!\n");
 454                                 break;
 455                         }
 456                         epno = dev->config.if_desc[ifno].no_of_ep;
 457                         if_desc = &dev->config.if_desc[ifno];
 458                         if (epno > USB_MAXENDPOINTS) {
 459                                 printf("Interface %d has too many endpoints!\n",
 460                                         if_desc->desc.bInterfaceNumber);
 461                                 return -EINVAL;
 462                         }
 463                         /* found an endpoint */
 464                         if_desc->no_of_ep++;
 465                         memcpy(&if_desc->ep_desc[epno], head,
 466                                 USB_DT_ENDPOINT_SIZE);
 467                         ep_wMaxPacketSize = get_unaligned(&dev->config.\
 468                                                         if_desc[ifno].\
 469                                                         ep_desc[epno].\
 470                                                         wMaxPacketSize);
 471                         put_unaligned(le16_to_cpu(ep_wMaxPacketSize),
 472                                         &dev->config.\
 473                                         if_desc[ifno].\
 474                                         ep_desc[epno].\
 475                                         wMaxPacketSize);
 476                         debug("if %d, ep %d\n", ifno, epno);
 477                         break;
 478                 case USB_DT_SS_ENDPOINT_COMP:
 479                         if (head->bLength != USB_DT_SS_EP_COMP_SIZE) {
 480                                 printf("ERROR: Invalid USB EPC length (%d)\n",
 481                                         head->bLength);
 482                                 break;
 483                         }
 484                         if (index + USB_DT_SS_EP_COMP_SIZE >
 485                             dev->config.desc.wTotalLength) {
 486                                 puts("USB EPC descriptor overflowed buffer!\n");
 487                                 break;
 488                         }
 489                         if (ifno < 0 || epno < 0) {
 490                                 puts("EPC descriptor out of order!\n");
 491                                 break;
 492                         }
 493                         if_desc = &dev->config.if_desc[ifno];
 494                         memcpy(&if_desc->ss_ep_comp_desc[epno], head,
 495                                 USB_DT_SS_EP_COMP_SIZE);
 496                         break;
 497                 default:
 498                         if (head->bLength == 0)
 499                                 return -EINVAL;
 500
 501                         debug("unknown Description Type : %x\n",
 502                               head->bDescriptorType);
 503
 504 #ifdef DEBUG
 505                         {
 506                                 unsigned char *ch = (unsigned char *)head;
 507                                 int i;
 508
 509                                 for (i = 0; i < head->bLength; i++)
 510                                         debug("%02X ", *ch++);
 511                                 debug("\n\n\n");
 512                         }
 513 #endif
 514                         break;
 515                 }
 516                 index += head->bLength;
 517                 head = (struct usb_descriptor_header *)&buffer[index];
 518         }
 519         return 0;
 520 }
 521
 522 /***********************************************************************
 523  * Clears an endpoint
 524  * endp: endpoint number in bits 0-3;
 525  * direction flag in bit 7 (1 = IN, 0 = OUT)
 526  */
 527 int usb_clear_halt(struct usb_device *dev, int pipe)
 528 {
 529         int result;
 530         int endp = usb_pipeendpoint(pipe)|(usb_pipein(pipe)<<7);
 531
 532         result = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
 533                                  USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT, 0,
 534                                  endp, NULL, 0, USB_CNTL_TIMEOUT * 3);
 535
 536         /* don't clear if failed */
 537         if (result < 0)
 538                 return result;
 539
 540         /*
 541          * NOTE: we do not get status and verify reset was successful
 542          * as some devices are reported to lock up upon this check..
 543          */
 544
 545         usb_endpoint_running(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe));
 546
 547         /* toggle is reset on clear */
 548         usb_settoggle(dev, usb_pipeendpoint(pipe), usb_pipeout(pipe), 0);
 549         return 0;
 550 }
 551
 552
 553 /**********************************************************************
 554  * get_descriptor type
 555  */
 556 static int usb_get_descriptor(struct usb_device *dev, unsigned char type,
 557                         unsigned char index, void *buf, int size)
 558 {
 559         int res;
 560         res = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
 561                         USB_REQ_GET_DESCRIPTOR, USB_DIR_IN,
 562                         (type << 8) + index, 0,
 563                         buf, size, USB_CNTL_TIMEOUT);
 564         return res;
 565 }
 566
 567 /**********************************************************************
 568  * gets configuration cfgno and store it in the buffer
 569  */
 570 int usb_get_configuration_no(struct usb_device *dev,
 571                              unsigned char *buffer, int cfgno)
 572 {
 573         int result;
 574         unsigned int length;
 575         struct usb_config_descriptor *config;
 576
 577         config = (struct usb_config_descriptor *)&buffer[0];
 578         result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, 9);
 579         if (result < 9) {
 580                 if (result < 0)
 581                         printf("unable to get descriptor, error %lX\n",
 582                                 dev->status);
 583                 else
 584                         printf("config descriptor too short " \
 585                                 "(expected %i, got %i)\n", 9, result);
 586                 return -EIO;
 587         }
 588         length = le16_to_cpu(config->wTotalLength);
 589
 590         if (length > USB_BUFSIZ) {
 591                 printf("%s: failed to get descriptor - too long: %d\n",
 592                         __func__, length);
 593                 return -EIO;
 594         }
 595
 596         result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, length);
 597         debug("get_conf_no %d Result %d, wLength %d\n", cfgno, result, length);
 598         config->wTotalLength = length; /* validated, with CPU byte order */
 599
 600         return result;
 601 }
 602
 603 /********************************************************************
 604  * set address of a device to the value in dev->devnum.
 605  * This can only be done by addressing the device via the default address (0)
 606  */
 607 static int usb_set_address(struct usb_device *dev)
 608 {
 609         int res;
 610
 611         debug("set address %d\n", dev->devnum);
 612         res = usb_control_msg(dev, usb_snddefctrl(dev),
 613                                 USB_REQ_SET_ADDRESS, 0,
 614                                 (dev->devnum), 0,
 615                                 NULL, 0, USB_CNTL_TIMEOUT);
 616         return res;
 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 #ifndef CONFIG_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_DM_USB */
 913
 914 #ifndef CONFIG_DM_USB
 915 int usb_legacy_port_reset(struct usb_device *hub, int portnr)
 916 {
 917         if (hub) {
 918                 unsigned short portstatus;
 919                 int err;
 920
 921                 /* reset the port for the second time */
 922                 err = legacy_hub_port_reset(hub, portnr - 1, &portstatus);
 923                 if (err < 0) {
 924                         printf("\n     Couldn't reset port %i\n", portnr);
 925                         return err;
 926                 }
 927         } else {
 928                 usb_reset_root_port();
 929         }
 930
 931         return 0;
 932 }
 933 #endif
 934
 935 static int get_descriptor_len(struct usb_device *dev, int len, int expect_len)
 936 {
 937         __maybe_unused struct usb_device_descriptor *desc;
 938         ALLOC_CACHE_ALIGN_BUFFER(unsigned char, tmpbuf, USB_BUFSIZ);
 939         int err;
 940
 941         desc = (struct usb_device_descriptor *)tmpbuf;
 942
 943         err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, desc, len);
 944         if (err < expect_len) {
 945                 if (err < 0) {
 946                         printf("unable to get device descriptor (error=%d)\n",
 947                                 err);
 948                         return err;
 949                 } else {
 950                         printf("USB device descriptor short read (expected %i, got %i)\n",
 951                                 expect_len, err);
 952                         return -EIO;
 953                 }
 954         }
 955         memcpy(&dev->descriptor, tmpbuf, sizeof(dev->descriptor));
 956
 957         return 0;
 958 }
 959
 960 static int usb_setup_descriptor(struct usb_device *dev, bool do_read)
 961 {
 962         /*
 963          * This is a Windows scheme of initialization sequence, with double
 964          * reset of the device (Linux uses the same sequence)
 965          * Some equipment is said to work only with such init sequence; this
 966          * patch is based on the work by Alan Stern:
 967          * http://sourceforge.net/mailarchive/forum.php?
 968          * thread_id=5729457&forum_id=5398
 969          */
 970
 971         /*
 972          * send 64-byte GET-DEVICE-DESCRIPTOR request.  Since the descriptor is
 973          * only 18 bytes long, this will terminate with a short packet.  But if
 974          * the maxpacket size is 8 or 16 the device may be waiting to transmit
 975          * some more, or keeps on retransmitting the 8 byte header.
 976          */
 977
 978         if (dev->speed == USB_SPEED_LOW) {
 979                 dev->descriptor.bMaxPacketSize0 = 8;
 980                 dev->maxpacketsize = PACKET_SIZE_8;
 981         } else {
 982                 dev->descriptor.bMaxPacketSize0 = 64;
 983                 dev->maxpacketsize = PACKET_SIZE_64;
 984         }
 985         dev->epmaxpacketin[0] = dev->descriptor.bMaxPacketSize0;
 986         dev->epmaxpacketout[0] = dev->descriptor.bMaxPacketSize0;
 987
 988         if (do_read) {
 989                 int err;
 990
 991                 /*
 992                  * Validate we've received only at least 8 bytes, not that we've
 993                  * received the entire descriptor. The reasoning is:
 994                  * - The code only uses fields in the first 8 bytes, so that's all we
 995                  *   need to have fetched at this stage.
 996                  * - The smallest maxpacket size is 8 bytes. Before we know the actual
 997                  *   maxpacket the device uses, the USB controller may only accept a
 998                  *   single packet. Consequently we are only guaranteed to receive 1
 999                  *   packet (at least 8 bytes) even in a non-error case.
1000                  *
1001                  * At least the DWC2 controller needs to be programmed with the number
1002                  * of packets in addition to the number of bytes. A request for 64
1003                  * bytes of data with the maxpacket guessed as 64 (above) yields a
1004                  * request for 1 packet.
1005                  */
1006                 err = get_descriptor_len(dev, 64, 8);
1007                 if (err)
1008                         return err;
1009         }
1010
1011         dev->epmaxpacketin[0] = dev->descriptor.bMaxPacketSize0;
1012         dev->epmaxpacketout[0] = dev->descriptor.bMaxPacketSize0;
1013         switch (dev->descriptor.bMaxPacketSize0) {
1014         case 8:
1015                 dev->maxpacketsize  = PACKET_SIZE_8;
1016                 break;
1017         case 16:
1018                 dev->maxpacketsize = PACKET_SIZE_16;
1019                 break;
1020         case 32:
1021                 dev->maxpacketsize = PACKET_SIZE_32;
1022                 break;
1023         case 64:
1024                 dev->maxpacketsize = PACKET_SIZE_64;
1025                 break;
1026         default:
1027                 printf("usb_new_device: invalid max packet size\n");
1028                 return -EIO;
1029         }
1030
1031         return 0;
1032 }
1033
1034 static int usb_prepare_device(struct usb_device *dev, int addr, bool do_read,
1035                               struct usb_device *parent, int portnr)
1036 {
1037         int err;
1038
1039         /*
1040          * Allocate usb 3.0 device context.
1041          * USB 3.0 (xHCI) protocol tries to allocate device slot
1042          * and related data structures first. This call does that.
1043          * Refer to sec 4.3.2 in xHCI spec rev1.0
1044          */
1045         err = usb_alloc_device(dev);
1046         if (err) {
1047                 printf("Cannot allocate device context to get SLOT_ID\n");
1048                 return err;
1049         }
1050         err = usb_setup_descriptor(dev, do_read);
1051         if (err)
1052                 return err;
1053         err = usb_legacy_port_reset(parent, portnr);
1054         if (err)
1055                 return err;
1056
1057         dev->devnum = addr;
1058
1059         err = usb_set_address(dev); /* set address */
1060
1061         if (err < 0) {
1062                 printf("\n      USB device not accepting new address " \
1063                         "(error=%lX)\n", dev->status);
1064                 return err;
1065         }
1066
1067         mdelay(10);     /* Let the SET_ADDRESS settle */
1068
1069         return 0;
1070 }
1071
1072 int usb_select_config(struct usb_device *dev)
1073 {
1074         ALLOC_CACHE_ALIGN_BUFFER(unsigned char, tmpbuf, USB_BUFSIZ);
1075         int err;
1076
1077         err = get_descriptor_len(dev, USB_DT_DEVICE_SIZE, USB_DT_DEVICE_SIZE);
1078         if (err)
1079                 return err;
1080
1081         /* correct le values */
1082         le16_to_cpus(&dev->descriptor.bcdUSB);
1083         le16_to_cpus(&dev->descriptor.idVendor);
1084         le16_to_cpus(&dev->descriptor.idProduct);
1085         le16_to_cpus(&dev->descriptor.bcdDevice);
1086
1087         /* only support for one config for now */
1088         err = usb_get_configuration_no(dev, tmpbuf, 0);
1089         if (err < 0) {
1090                 printf("usb_new_device: Cannot read configuration, " \
1091                        "skipping device %04x:%04x\n",
1092                        dev->descriptor.idVendor, dev->descriptor.idProduct);
1093                 return err;
1094         }
1095         usb_parse_config(dev, tmpbuf, 0);
1096         usb_set_maxpacket(dev);
1097         /*
1098          * we set the default configuration here
1099          * This seems premature. If the driver wants a different configuration
1100          * it will need to select itself.
1101          */
1102         err = usb_set_configuration(dev, dev->config.desc.bConfigurationValue);
1103         if (err < 0) {
1104                 printf("failed to set default configuration " \
1105                         "len %d, status %lX\n", dev->act_len, dev->status);
1106                 return err;
1107         }
1108         debug("new device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
1109               dev->descriptor.iManufacturer, dev->descriptor.iProduct,
1110               dev->descriptor.iSerialNumber);
1111         memset(dev->mf, 0, sizeof(dev->mf));
1112         memset(dev->prod, 0, sizeof(dev->prod));
1113         memset(dev->serial, 0, sizeof(dev->serial));
1114         if (dev->descriptor.iManufacturer)
1115                 usb_string(dev, dev->descriptor.iManufacturer,
1116                            dev->mf, sizeof(dev->mf));
1117         if (dev->descriptor.iProduct)
1118                 usb_string(dev, dev->descriptor.iProduct,
1119                            dev->prod, sizeof(dev->prod));
1120         if (dev->descriptor.iSerialNumber)
1121                 usb_string(dev, dev->descriptor.iSerialNumber,
1122                            dev->serial, sizeof(dev->serial));
1123         debug("Manufacturer %s\n", dev->mf);
1124         debug("Product      %s\n", dev->prod);
1125         debug("SerialNumber %s\n", dev->serial);
1126
1127         return 0;
1128 }
1129
1130 int usb_setup_device(struct usb_device *dev, bool do_read,
1131                      struct usb_device *parent, int portnr)
1132 {
1133         int addr;
1134         int ret;
1135
1136         /* We still haven't set the Address yet */
1137         addr = dev->devnum;
1138         dev->devnum = 0;
1139
1140         ret = usb_prepare_device(dev, addr, do_read, parent, portnr);
1141         if (ret)
1142                 return ret;
1143         ret = usb_select_config(dev);
1144
1145         return ret;
1146 }
1147
1148 #ifndef CONFIG_DM_USB
1149 /*
1150  * By the time we get here, the device has gotten a new device ID
1151  * and is in the default state. We need to identify the thing and
1152  * get the ball rolling..
1153  *
1154  * Returns 0 for success, != 0 for error.
1155  */
1156 int usb_new_device(struct usb_device *dev)
1157 {
1158         bool do_read = true;
1159         int err;
1160
1161         /*
1162          * XHCI needs to issue a Address device command to setup
1163          * proper device context structures, before it can interact
1164          * with the device. So a get_descriptor will fail before any
1165          * of that is done for XHCI unlike EHCI.
1166          */
1167 #ifdef CONFIG_USB_XHCI
1168         do_read = false;
1169 #endif
1170         err = usb_setup_device(dev, do_read, dev->parent, dev->portnr);
1171         if (err)
1172                 return err;
1173
1174         /* Now probe if the device is a hub */
1175         err = usb_hub_probe(dev, 0);
1176         if (err < 0)
1177                 return err;
1178
1179         return 0;
1180 }
1181 #endif
1182
1183 __weak
1184 int board_usb_init(int index, enum usb_init_type init)
1185 {
1186         return 0;
1187 }
1188
1189 __weak
1190 int board_usb_cleanup(int index, enum usb_init_type init)
1191 {
1192         return 0;
1193 }
1194
1195 bool usb_device_has_child_on_port(struct usb_device *parent, int port)
1196 {
1197 #ifdef CONFIG_DM_USB
1198         return false;
1199 #else
1200         return parent->children[port] != NULL;
1201 #endif
1202 }
1203
1204 /* EOF */