]> git.ipfire.org Git - people/ms/u-boot.git/blobdiff - common/usb.c
usb: dwc3: add dwc3 folder from linux kernel to u-boot
[people/ms/u-boot.git] / common / usb.c
index f740e5ec219cbe42a8d7375ed582b277a2ebc50b..bf76c4159341042a846efda075abe365c12f9833 100644 (file)
@@ -33,7 +33,7 @@
 #include <linux/ctype.h>
 #include <asm/byteorder.h>
 #include <asm/unaligned.h>
-
+#include <errno.h>
 #include <usb.h>
 #ifdef CONFIG_4xx
 #include <asm/4xx_pci.h>
@@ -59,6 +59,8 @@ int usb_init(void)
        void *ctrl;
        struct usb_device *dev;
        int i, start_index = 0;
+       int controllers_initialized = 0;
+       int ret;
 
        dev_index = 0;
        asynch_allowed = 1;
@@ -74,7 +76,14 @@ int usb_init(void)
        for (i = 0; i < CONFIG_USB_MAX_CONTROLLER_COUNT; i++) {
                /* init low_level USB */
                printf("USB%d:   ", i);
-               if (usb_lowlevel_init(i, &ctrl)) {
+               ret = usb_lowlevel_init(i, USB_INIT_HOST, &ctrl);
+               if (ret == -ENODEV) {   /* No such device. */
+                       puts("Port not available.\n");
+                       controllers_initialized++;
+                       continue;
+               }
+
+               if (ret) {              /* Other error. */
                        puts("lowlevel init failed\n");
                        continue;
                }
@@ -82,33 +91,38 @@ int usb_init(void)
                 * lowlevel init is OK, now scan the bus for devices
                 * i.e. search HUBs and configure them
                 */
+               controllers_initialized++;
                start_index = dev_index;
                printf("scanning bus %d for devices... ", i);
                dev = usb_alloc_new_device(ctrl);
+               if (!dev)
+                       break;
+
                /*
                 * device 0 is always present
                 * (root hub, so let it analyze)
                 */
-               if (dev)
-                       usb_new_device(dev);
+               ret = usb_new_device(dev);
+               if (ret)
+                       usb_free_device();
 
-               if (start_index == dev_index)
+               if (start_index == dev_index) {
                        puts("No USB Device found\n");
-               else
+                       continue;
+               } else {
                        printf("%d USB Device(s) found\n",
                                dev_index - start_index);
+               }
 
                usb_started = 1;
        }
 
        debug("scan end\n");
        /* if we were not able to find at least one working bus, bail out */
-       if (!usb_started) {
+       if (controllers_initialized == 0)
                puts("USB error: all controllers failed lowlevel init\n");
-               return -1;
-       }
 
-       return 0;
+       return usb_started ? 0 : -ENODEV;
 }
 
 /******************************************************************************
@@ -178,7 +192,7 @@ int usb_control_msg(struct usb_device *dev, unsigned int pipe,
 
        if ((timeout == 0) && (!asynch_allowed)) {
                /* request for a asynch control pipe is not allowed */
-               return -1;
+               return -EINVAL;
        }
 
        /* set setup command */
@@ -193,7 +207,7 @@ int usb_control_msg(struct usb_device *dev, unsigned int pipe,
        dev->status = USB_ST_NOT_PROC; /*not yet processed */
 
        if (submit_control_msg(dev, pipe, data, size, setup_packet) < 0)
-               return -1;
+               return -EIO;
        if (timeout == 0)
                return (int)size;
 
@@ -216,17 +230,17 @@ int usb_control_msg(struct usb_device *dev, unsigned int pipe,
 
 /*-------------------------------------------------------------------
  * submits bulk message, and waits for completion. returns 0 if Ok or
- * -1 if Error.
+ * negative if Error.
  * synchronous behavior
  */
 int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
                        void *data, int len, int *actual_length, int timeout)
 {
        if (len < 0)
-               return -1;
+               return -EINVAL;
        dev->status = USB_ST_NOT_PROC; /*not yet processed */
        if (submit_bulk_msg(dev, pipe, data, len) < 0)
-               return -1;
+               return -EIO;
        while (timeout--) {
                if (!((volatile unsigned long)dev->status & USB_ST_NOT_PROC))
                        break;
@@ -236,7 +250,7 @@ int usb_bulk_msg(struct usb_device *dev, unsigned int pipe,
        if (dev->status == 0)
                return 0;
        else
-               return -1;
+               return -EIO;
 }
 
 
@@ -323,6 +337,7 @@ static int usb_set_maxpacket(struct usb_device *dev)
 /*******************************************************************************
  * Parse the config, located in buffer, and fills the dev->config structure.
  * Note that all little/big endian swapping are done automatically.
+ * (wTotalLength has already been swapped and sanitized when it was read.)
  */
 static int usb_parse_config(struct usb_device *dev,
                        unsigned char *buffer, int cfgno)
@@ -341,26 +356,45 @@ static int usb_parse_config(struct usb_device *dev,
        if (head->bDescriptorType != USB_DT_CONFIG) {
                printf(" ERROR: NOT USB_CONFIG_DESC %x\n",
                        head->bDescriptorType);
-               return -1;
+               return -EINVAL;
        }
-       memcpy(&dev->config, buffer, buffer[0]);
-       le16_to_cpus(&(dev->config.desc.wTotalLength));
+       if (head->bLength != USB_DT_CONFIG_SIZE) {
+               printf("ERROR: Invalid USB CFG length (%d)\n", head->bLength);
+               return -EINVAL;
+       }
+       memcpy(&dev->config, head, USB_DT_CONFIG_SIZE);
        dev->config.no_of_if = 0;
 
        index = dev->config.desc.bLength;
        /* Ok the first entry must be a configuration entry,
         * now process the others */
        head = (struct usb_descriptor_header *) &buffer[index];
-       while (index + 1 < dev->config.desc.wTotalLength) {
+       while (index + 1 < dev->config.desc.wTotalLength && head->bLength) {
                switch (head->bDescriptorType) {
                case USB_DT_INTERFACE:
+                       if (head->bLength != USB_DT_INTERFACE_SIZE) {
+                               printf("ERROR: Invalid USB IF length (%d)\n",
+                                       head->bLength);
+                               break;
+                       }
+                       if (index + USB_DT_INTERFACE_SIZE >
+                           dev->config.desc.wTotalLength) {
+                               puts("USB IF descriptor overflowed buffer!\n");
+                               break;
+                       }
                        if (((struct usb_interface_descriptor *) \
-                            &buffer[index])->bInterfaceNumber != curr_if_num) {
+                            head)->bInterfaceNumber != curr_if_num) {
                                /* this is a new interface, copy new desc */
                                ifno = dev->config.no_of_if;
+                               if (ifno >= USB_MAXINTERFACES) {
+                                       puts("Too many USB interfaces!\n");
+                                       /* try to go on with what we have */
+                                       return -EINVAL;
+                               }
                                if_desc = &dev->config.if_desc[ifno];
                                dev->config.no_of_if++;
-                               memcpy(if_desc, &buffer[index], buffer[index]);
+                               memcpy(if_desc, head,
+                                       USB_DT_INTERFACE_SIZE);
                                if_desc->no_of_ep = 0;
                                if_desc->num_altsetting = 1;
                                curr_if_num =
@@ -374,12 +408,31 @@ static int usb_parse_config(struct usb_device *dev,
                        }
                        break;
                case USB_DT_ENDPOINT:
+                       if (head->bLength != USB_DT_ENDPOINT_SIZE) {
+                               printf("ERROR: Invalid USB EP length (%d)\n",
+                                       head->bLength);
+                               break;
+                       }
+                       if (index + USB_DT_ENDPOINT_SIZE >
+                           dev->config.desc.wTotalLength) {
+                               puts("USB EP descriptor overflowed buffer!\n");
+                               break;
+                       }
+                       if (ifno < 0) {
+                               puts("Endpoint descriptor out of order!\n");
+                               break;
+                       }
                        epno = dev->config.if_desc[ifno].no_of_ep;
                        if_desc = &dev->config.if_desc[ifno];
+                       if (epno > USB_MAXENDPOINTS) {
+                               printf("Interface %d has too many endpoints!\n",
+                                       if_desc->desc.bInterfaceNumber);
+                               return -EINVAL;
+                       }
                        /* found an endpoint */
                        if_desc->no_of_ep++;
-                       memcpy(&if_desc->ep_desc[epno],
-                               &buffer[index], buffer[index]);
+                       memcpy(&if_desc->ep_desc[epno], head,
+                               USB_DT_ENDPOINT_SIZE);
                        ep_wMaxPacketSize = get_unaligned(&dev->config.\
                                                        if_desc[ifno].\
                                                        ep_desc[epno].\
@@ -392,13 +445,27 @@ static int usb_parse_config(struct usb_device *dev,
                        debug("if %d, ep %d\n", ifno, epno);
                        break;
                case USB_DT_SS_ENDPOINT_COMP:
+                       if (head->bLength != USB_DT_SS_EP_COMP_SIZE) {
+                               printf("ERROR: Invalid USB EPC length (%d)\n",
+                                       head->bLength);
+                               break;
+                       }
+                       if (index + USB_DT_SS_EP_COMP_SIZE >
+                           dev->config.desc.wTotalLength) {
+                               puts("USB EPC descriptor overflowed buffer!\n");
+                               break;
+                       }
+                       if (ifno < 0 || epno < 0) {
+                               puts("EPC descriptor out of order!\n");
+                               break;
+                       }
                        if_desc = &dev->config.if_desc[ifno];
-                       memcpy(&if_desc->ss_ep_comp_desc[epno],
-                               &buffer[index], buffer[index]);
+                       memcpy(&if_desc->ss_ep_comp_desc[epno], head,
+                               USB_DT_SS_EP_COMP_SIZE);
                        break;
                default:
                        if (head->bLength == 0)
-                               return 1;
+                               return -EINVAL;
 
                        debug("unknown Description Type : %x\n",
                              head->bDescriptorType);
@@ -418,7 +485,7 @@ static int usb_parse_config(struct usb_device *dev,
                index += head->bLength;
                head = (struct usb_descriptor_header *)&buffer[index];
        }
-       return 1;
+       return 0;
 }
 
 /***********************************************************************
@@ -473,7 +540,7 @@ int usb_get_configuration_no(struct usb_device *dev,
                             unsigned char *buffer, int cfgno)
 {
        int result;
-       unsigned int tmp;
+       unsigned int length;
        struct usb_config_descriptor *config;
 
        config = (struct usb_config_descriptor *)&buffer[0];
@@ -485,18 +552,20 @@ int usb_get_configuration_no(struct usb_device *dev,
                else
                        printf("config descriptor too short " \
                                "(expected %i, got %i)\n", 9, result);
-               return -1;
+               return -EIO;
        }
-       tmp = le16_to_cpu(config->wTotalLength);
+       length = le16_to_cpu(config->wTotalLength);
 
-       if (tmp > USB_BUFSIZ) {
-               printf("usb_get_configuration_no: failed to get " \
-                      "descriptor - too long: %d\n", tmp);
-               return -1;
+       if (length > USB_BUFSIZ) {
+               printf("%s: failed to get descriptor - too long: %d\n",
+                       __func__, length);
+               return -EIO;
        }
 
-       result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, tmp);
-       debug("get_conf_no %d Result %d, wLength %d\n", cfgno, result, tmp);
+       result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, length);
+       debug("get_conf_no %d Result %d, wLength %d\n", cfgno, result, length);
+       config->wTotalLength = length; /* validated, with CPU byte order */
+
        return result;
 }
 
@@ -532,7 +601,7 @@ int usb_set_interface(struct usb_device *dev, int interface, int alternate)
        }
        if (!if_face) {
                printf("selecting invalid interface %d", interface);
-               return -1;
+               return -EINVAL;
        }
        /*
         * We should return now for devices with only one alternate setting.
@@ -571,7 +640,7 @@ static int usb_set_configuration(struct usb_device *dev, int configuration)
                dev->toggle[1] = 0;
                return 0;
        } else
-               return -1;
+               return -EIO;
 }
 
 /********************************************************************
@@ -685,7 +754,7 @@ static int usb_string_sub(struct usb_device *dev, unsigned int langid,
        }
 
        if (rc < 2)
-               rc = -1;
+               rc = -EINVAL;
 
        return rc;
 }
@@ -704,7 +773,7 @@ int usb_string(struct usb_device *dev, int index, char *buf, size_t size)
        unsigned int u, idx;
 
        if (size <= 0 || !buf || !index)
-               return -1;
+               return -EINVAL;
        buf[0] = 0;
        tbuf = &mybuf[0];
 
@@ -714,10 +783,10 @@ int usb_string(struct usb_device *dev, int index, char *buf, size_t size)
                if (err < 0) {
                        debug("error getting string descriptor 0 " \
                              "(error=%lx)\n", dev->status);
-                       return -1;
+                       return -EIO;
                } else if (tbuf[0] < 4) {
                        debug("string descriptor 0 too short\n");
-                       return -1;
+                       return -EIO;
                } else {
                        dev->have_langid = -1;
                        dev->string_langid = tbuf[2] | (tbuf[3] << 8);
@@ -799,6 +868,16 @@ void usb_free_device(void)
        usb_dev[dev_index].devnum = -1;
 }
 
+/*
+ * XHCI issues Enable Slot command and thereafter
+ * allocates device contexts. Provide a weak alias
+ * function for the purpose, so that XHCI overrides it
+ * and EHCI/OHCI just work out of the box.
+ */
+__weak int usb_alloc_device(struct usb_device *udev)
+{
+       return 0;
+}
 /*
  * By the time we get here, the device has gotten a new device ID
  * and is in the default state. We need to identify the thing and
@@ -812,6 +891,17 @@ int usb_new_device(struct usb_device *dev)
        int tmp;
        ALLOC_CACHE_ALIGN_BUFFER(unsigned char, tmpbuf, USB_BUFSIZ);
 
+       /*
+        * Allocate usb 3.0 device context.
+        * USB 3.0 (xHCI) protocol tries to allocate device slot
+        * and related data structures first. This call does that.
+        * Refer to sec 4.3.2 in xHCI spec rev1.0
+        */
+       if (usb_alloc_device(dev)) {
+               printf("Cannot allocate device context to get SLOT_ID\n");
+               return -EINVAL;
+       }
+
        /* We still haven't set the Address yet */
        addr = dev->devnum;
        dev->devnum = 0;
@@ -831,7 +921,7 @@ int usb_new_device(struct usb_device *dev)
        if (err < 8) {
                printf("\n      USB device not responding, " \
                       "giving up (status=%lX)\n", dev->status);
-               return 1;
+               return -EIO;
        }
        memcpy(&dev->descriptor, tmpbuf, 8);
 #else
@@ -842,8 +932,7 @@ int usb_new_device(struct usb_device *dev)
         * http://sourceforge.net/mailarchive/forum.php?
         * thread_id=5729457&forum_id=5398
         */
-       struct usb_device_descriptor *desc;
-       int port = -1;
+       __maybe_unused struct usb_device_descriptor *desc;
        struct usb_device *parent = dev->parent;
        unsigned short portstatus;
 
@@ -859,10 +948,32 @@ int usb_new_device(struct usb_device *dev)
        dev->epmaxpacketin[0] = 64;
        dev->epmaxpacketout[0] = 64;
 
+       /*
+        * XHCI needs to issue a Address device command to setup
+        * proper device context structures, before it can interact
+        * with the device. So a get_descriptor will fail before any
+        * of that is done for XHCI unlike EHCI.
+        */
+#ifndef CONFIG_USB_XHCI
        err = usb_get_descriptor(dev, USB_DT_DEVICE, 0, desc, 64);
-       if (err < 0) {
+       /*
+        * Validate we've received only at least 8 bytes, not that we've
+        * received the entire descriptor. The reasoning is:
+        * - The code only uses fields in the first 8 bytes, so that's all we
+        *   need to have fetched at this stage.
+        * - The smallest maxpacket size is 8 bytes. Before we know the actual
+        *   maxpacket the device uses, the USB controller may only accept a
+        *   single packet. Consequently we are only guaranteed to receive 1
+        *   packet (at least 8 bytes) even in a non-error case.
+        *
+        * At least the DWC2 controller needs to be programmed with the number
+        * of packets in addition to the number of bytes. A request for 64
+        * bytes of data with the maxpacket guessed as 64 (above) yields a
+        * request for 1 packet.
+        */
+       if (err < 8) {
                debug("usb_new_device: usb_get_descriptor() failed\n");
-               return 1;
+               return -EIO;
        }
 
        dev->descriptor.bMaxPacketSize0 = desc->bMaxPacketSize0;
@@ -871,28 +982,17 @@ int usb_new_device(struct usb_device *dev)
         * to differentiate between HUB and DEVICE.
         */
        dev->descriptor.bDeviceClass = desc->bDeviceClass;
+#endif
 
-       /* find the port number we're at */
        if (parent) {
-               int j;
-
-               for (j = 0; j < parent->maxchild; j++) {
-                       if (parent->children[j] == dev) {
-                               port = j;
-                               break;
-                       }
-               }
-               if (port < 0) {
-                       printf("usb_new_device:cannot locate device's port.\n");
-                       return 1;
-               }
-
                /* reset the port for the second time */
-               err = hub_port_reset(dev->parent, port, &portstatus);
+               err = hub_port_reset(dev->parent, dev->portnr - 1, &portstatus);
                if (err < 0) {
-                       printf("\n     Couldn't reset port %i\n", port);
-                       return 1;
+                       printf("\n     Couldn't reset port %i\n", dev->portnr);
+                       return -EIO;
                }
+       } else {
+               usb_reset_root_port();
        }
 #endif
 
@@ -911,6 +1011,9 @@ int usb_new_device(struct usb_device *dev)
        case 64:
                dev->maxpacketsize = PACKET_SIZE_64;
                break;
+       default:
+               printf("usb_new_device: invalid max packet size\n");
+               return -EIO;
        }
        dev->devnum = addr;
 
@@ -919,7 +1022,7 @@ int usb_new_device(struct usb_device *dev)
        if (err < 0) {
                printf("\n      USB device not accepting new address " \
                        "(error=%lX)\n", dev->status);
-               return 1;
+               return -EIO;
        }
 
        mdelay(10);     /* Let the SET_ADDRESS settle */
@@ -935,7 +1038,7 @@ int usb_new_device(struct usb_device *dev)
                else
                        printf("USB device descriptor short read " \
                                "(expected %i, got %i)\n", tmp, err);
-               return 1;
+               return -EIO;
        }
        memcpy(&dev->descriptor, tmpbuf, sizeof(dev->descriptor));
        /* correct le values */
@@ -949,7 +1052,7 @@ int usb_new_device(struct usb_device *dev)
                printf("usb_new_device: Cannot read configuration, " \
                       "skipping device %04x:%04x\n",
                       dev->descriptor.idVendor, dev->descriptor.idProduct);
-               return -1;
+               return -EIO;
        }
        usb_parse_config(dev, tmpbuf, 0);
        usb_set_maxpacket(dev);
@@ -957,7 +1060,7 @@ int usb_new_device(struct usb_device *dev)
        if (usb_set_configuration(dev, dev->config.desc.bConfigurationValue)) {
                printf("failed to set default configuration " \
                        "len %d, status %lX\n", dev->act_len, dev->status);
-               return -1;
+               return -EIO;
        }
        debug("new device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
              dev->descriptor.iManufacturer, dev->descriptor.iProduct,
@@ -982,4 +1085,9 @@ int usb_new_device(struct usb_device *dev)
        return 0;
 }
 
+__weak
+int board_usb_init(int index, enum usb_init_type init)
+{
+       return 0;
+}
 /* EOF */