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