]> git.kernelconcepts.de Git - karo-tx-uboot.git/blobdiff - common/usb.c
mmc: add function to get the number of available mmc interfaces
[karo-tx-uboot.git] / common / usb.c
index 6fc0fc1c0ec75fe34f100cbfb03b207628b32885..32e15cd8ddb93320c5758635268daac68e7196f7 100644 (file)
@@ -1,5 +1,4 @@
 /*
- *
  * Most of this source has been derived from the Linux USB
  * project:
  * (C) Copyright Linus Torvalds 1999
  * Adapted for U-Boot:
  * (C) Copyright 2001 Denis Peter, MPL AG Switzerland
  *
- * See file CREDITS for list of people who contributed to this
- * project.
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License as
- * published by the Free Software Foundation; either version 2 of
- * the License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
- * MA 02111-1307 USA
- *
+ * SPDX-License-Identifier:    GPL-2.0+
  */
 
 /*
 #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>
 #endif
 
-#ifdef DEBUG
-#define USB_DEBUG      1
-#define USB_HUB_DEBUG  1
-#else
-#define USB_DEBUG      0
-#define USB_HUB_DEBUG  0
-#endif
-
-#define USB_PRINTF(fmt, args...)       debug_cond(USB_DEBUG, fmt, ##args)
-#define USB_HUB_PRINTF(fmt, args...)   debug_cond(USB_HUB_DEBUG, fmt, ##args)
-
 #define USB_BUFSIZ     512
 
 static struct usb_device usb_dev[USB_MAX_DEVICE];
@@ -88,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;
@@ -103,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;
                }
@@ -111,6 +91,7 @@ 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);
@@ -130,14 +111,12 @@ int usb_init(void)
                usb_started = 1;
        }
 
-       USB_PRINTF("scan end\n");
+       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 : -1;
 }
 
 /******************************************************************************
@@ -216,9 +195,9 @@ int usb_control_msg(struct usb_device *dev, unsigned int pipe,
        setup_packet->value = cpu_to_le16(value);
        setup_packet->index = cpu_to_le16(index);
        setup_packet->length = cpu_to_le16(size);
-       USB_PRINTF("usb_control_msg: request: 0x%X, requesttype: 0x%X, " \
-                  "value 0x%X index 0x%X length 0x%X\n",
-                  request, requesttype, value, index, size);
+       debug("usb_control_msg: request: 0x%X, requesttype: 0x%X, " \
+             "value 0x%X index 0x%X length 0x%X\n",
+             request, requesttype, value, index, size);
        dev->status = USB_ST_NOT_PROC; /*not yet processed */
 
        if (submit_control_msg(dev, pipe, data, size, setup_packet) < 0)
@@ -314,22 +293,22 @@ usb_set_maxpacket_ep(struct usb_device *dev, int if_idx, int ep_idx)
                /* Control => bidirectional */
                dev->epmaxpacketout[b] = ep_wMaxPacketSize;
                dev->epmaxpacketin[b] = ep_wMaxPacketSize;
-               USB_PRINTF("##Control EP epmaxpacketout/in[%d] = %d\n",
-                          b, dev->epmaxpacketin[b]);
+               debug("##Control EP epmaxpacketout/in[%d] = %d\n",
+                     b, dev->epmaxpacketin[b]);
        } else {
                if ((ep->bEndpointAddress & 0x80) == 0) {
                        /* OUT Endpoint */
                        if (ep_wMaxPacketSize > dev->epmaxpacketout[b]) {
                                dev->epmaxpacketout[b] = ep_wMaxPacketSize;
-                               USB_PRINTF("##EP epmaxpacketout[%d] = %d\n",
-                                          b, dev->epmaxpacketout[b]);
+                               debug("##EP epmaxpacketout[%d] = %d\n",
+                                     b, dev->epmaxpacketout[b]);
                        }
                } else {
                        /* IN Endpoint */
                        if (ep_wMaxPacketSize > dev->epmaxpacketin[b]) {
                                dev->epmaxpacketin[b] = ep_wMaxPacketSize;
-                               USB_PRINTF("##EP epmaxpacketin[%d] = %d\n",
-                                          b, dev->epmaxpacketin[b]);
+                               debug("##EP epmaxpacketin[%d] = %d\n",
+                                     b, dev->epmaxpacketin[b]);
                        }
                } /* if out */
        } /* if control */
@@ -352,14 +331,15 @@ 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)
 {
        struct usb_descriptor_header *head;
        int index, ifno, epno, curr_if_num;
-       int i;
        u16 ep_wMaxPacketSize;
+       struct usb_interface *if_desc = NULL;
 
        ifno = -1;
        epno = -1;
@@ -372,39 +352,81 @@ static int usb_parse_config(struct usb_device *dev,
                        head->bDescriptorType);
                return -1;
        }
-       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 -1;
+       }
+       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 1;
+                               }
+                               if_desc = &dev->config.if_desc[ifno];
                                dev->config.no_of_if++;
-                               memcpy(&dev->config.if_desc[ifno],
-                                       &buffer[index], buffer[index]);
-                               dev->config.if_desc[ifno].no_of_ep = 0;
-                               dev->config.if_desc[ifno].num_altsetting = 1;
+                               memcpy(if_desc, head,
+                                       USB_DT_INTERFACE_SIZE);
+                               if_desc->no_of_ep = 0;
+                               if_desc->num_altsetting = 1;
                                curr_if_num =
-                                    dev->config.if_desc[ifno].desc.bInterfaceNumber;
+                                    if_desc->desc.bInterfaceNumber;
                        } else {
                                /* found alternate setting for the interface */
-                               dev->config.if_desc[ifno].num_altsetting++;
+                               if (ifno >= 0) {
+                                       if_desc = &dev->config.if_desc[ifno];
+                                       if_desc->num_altsetting++;
+                               }
                        }
                        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 1;
+                       }
                        /* found an endpoint */
-                       dev->config.if_desc[ifno].no_of_ep++;
-                       memcpy(&dev->config.if_desc[ifno].ep_desc[epno],
-                               &buffer[index], buffer[index]);
+                       if_desc->no_of_ep++;
+                       memcpy(&if_desc->ep_desc[epno], head,
+                               USB_DT_ENDPOINT_SIZE);
                        ep_wMaxPacketSize = get_unaligned(&dev->config.\
                                                        if_desc[ifno].\
                                                        ep_desc[epno].\
@@ -414,23 +436,44 @@ static int usb_parse_config(struct usb_device *dev,
                                        if_desc[ifno].\
                                        ep_desc[epno].\
                                        wMaxPacketSize);
-                       USB_PRINTF("if %d, ep %d\n", ifno, epno);
+                       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], head,
+                               USB_DT_SS_EP_COMP_SIZE);
                        break;
                default:
                        if (head->bLength == 0)
                                return 1;
 
-                       USB_PRINTF("unknown Description Type : %x\n",
-                                  head->bDescriptorType);
+                       debug("unknown Description Type : %x\n",
+                             head->bDescriptorType);
 
+#ifdef DEBUG
                        {
-#ifdef USB_DEBUG
                                unsigned char *ch = (unsigned char *)head;
-#endif
+                               int i;
+
                                for (i = 0; i < head->bLength; i++)
-                                       USB_PRINTF("%02X ", *ch++);
-                               USB_PRINTF("\n\n\n");
+                                       debug("%02X ", *ch++);
+                               debug("\n\n\n");
                        }
+#endif
                        break;
                }
                index += head->bLength;
@@ -491,7 +534,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];
@@ -505,17 +548,18 @@ int usb_get_configuration_no(struct usb_device *dev,
                                "(expected %i, got %i)\n", 9, result);
                return -1;
        }
-       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);
+       if (length > USB_BUFSIZ) {
+               printf("%s: failed to get descriptor - too long: %d\n",
+                       __func__, length);
                return -1;
        }
 
-       result = usb_get_descriptor(dev, USB_DT_CONFIG, cfgno, buffer, tmp);
-       USB_PRINTF("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;
 }
 
@@ -527,7 +571,7 @@ static int usb_set_address(struct usb_device *dev)
 {
        int res;
 
-       USB_PRINTF("set address %d\n", dev->devnum);
+       debug("set address %d\n", dev->devnum);
        res = usb_control_msg(dev, usb_snddefctrl(dev),
                                USB_REQ_SET_ADDRESS, 0,
                                (dev->devnum), 0,
@@ -579,7 +623,7 @@ int usb_set_interface(struct usb_device *dev, int interface, int alternate)
 static int usb_set_configuration(struct usb_device *dev, int configuration)
 {
        int res;
-       USB_PRINTF("set configuration %d\n", configuration);
+       debug("set configuration %d\n", configuration);
        /* set setup command */
        res = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
                                USB_REQ_SET_CONFIGURATION, 0,
@@ -731,19 +775,19 @@ int usb_string(struct usb_device *dev, int index, char *buf, size_t size)
        if (!dev->have_langid) {
                err = usb_string_sub(dev, 0, 0, tbuf);
                if (err < 0) {
-                       USB_PRINTF("error getting string descriptor 0 " \
-                                  "(error=%lx)\n", dev->status);
+                       debug("error getting string descriptor 0 " \
+                             "(error=%lx)\n", dev->status);
                        return -1;
                } else if (tbuf[0] < 4) {
-                       USB_PRINTF("string descriptor 0 too short\n");
+                       debug("string descriptor 0 too short\n");
                        return -1;
                } else {
                        dev->have_langid = -1;
                        dev->string_langid = tbuf[2] | (tbuf[3] << 8);
                                /* always use the first langid listed */
-                       USB_PRINTF("USB device number %d default " \
-                                  "language ID 0x%x\n",
-                                  dev->devnum, dev->string_langid);
+                       debug("USB device number %d default " \
+                             "language ID 0x%x\n",
+                             dev->devnum, dev->string_langid);
                }
        }
 
@@ -789,7 +833,7 @@ struct usb_device *usb_get_dev_index(int index)
 struct usb_device *usb_alloc_new_device(void *controller)
 {
        int i;
-       USB_PRINTF("New Device %d\n", dev_index);
+       debug("New Device %d\n", dev_index);
        if (dev_index == USB_MAX_DEVICE) {
                printf("ERROR, too many USB Devices, max=%d\n", USB_MAX_DEVICE);
                return NULL;
@@ -813,11 +857,21 @@ struct usb_device *usb_alloc_new_device(void *controller)
 void usb_free_device(void)
 {
        dev_index--;
-       USB_PRINTF("Freeing device node: %d\n", dev_index);
+       debug("Freeing device node: %d\n", dev_index);
        memset(&usb_dev[dev_index], 0, sizeof(struct usb_device));
        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
@@ -831,6 +885,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 -1;
+       }
+
        /* We still haven't set the Address yet */
        addr = dev->devnum;
        dev->devnum = 0;
@@ -861,8 +926,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;
 
@@ -878,35 +942,36 @@ 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) {
-               USB_PRINTF("usb_new_device: usb_get_descriptor() failed\n");
+               debug("usb_new_device: usb_get_descriptor() failed\n");
                return 1;
        }
 
        dev->descriptor.bMaxPacketSize0 = desc->bMaxPacketSize0;
+       /*
+        * Fetch the device class, driver can use this info
+        * 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);
+                       printf("\n     Couldn't reset port %i\n", dev->portnr);
                        return 1;
                }
+       } else {
+               usb_reset_root_port();
        }
 #endif
 
@@ -973,9 +1038,9 @@ int usb_new_device(struct usb_device *dev)
                        "len %d, status %lX\n", dev->act_len, dev->status);
                return -1;
        }
-       USB_PRINTF("new device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
-                  dev->descriptor.iManufacturer, dev->descriptor.iProduct,
-                  dev->descriptor.iSerialNumber);
+       debug("new device strings: Mfr=%d, Product=%d, SerialNumber=%d\n",
+             dev->descriptor.iManufacturer, dev->descriptor.iProduct,
+             dev->descriptor.iSerialNumber);
        memset(dev->mf, 0, sizeof(dev->mf));
        memset(dev->prod, 0, sizeof(dev->prod));
        memset(dev->serial, 0, sizeof(dev->serial));
@@ -988,12 +1053,17 @@ int usb_new_device(struct usb_device *dev)
        if (dev->descriptor.iSerialNumber)
                usb_string(dev, dev->descriptor.iSerialNumber,
                           dev->serial, sizeof(dev->serial));
-       USB_PRINTF("Manufacturer %s\n", dev->mf);
-       USB_PRINTF("Product      %s\n", dev->prod);
-       USB_PRINTF("SerialNumber %s\n", dev->serial);
+       debug("Manufacturer %s\n", dev->mf);
+       debug("Product      %s\n", dev->prod);
+       debug("SerialNumber %s\n", dev->serial);
        /* now prode if the device is a hub */
        usb_hub_probe(dev, 0);
        return 0;
 }
 
+__weak
+int board_usb_init(int index, enum usb_init_type init)
+{
+       return 0;
+}
 /* EOF */