mirror of
https://gitee.com/mirrors_PX4/PX4-Autopilot.git
synced 2026-11-02 01:01:36 +08:00
Resync new repository with old repo r5166
git-svn-id: http://svn.code.sf.net/p/nuttx/code/trunk@5153 42af7a65-404d-4744-a932-0658087f49c3
This commit is contained in:
@@ -0,0 +1,518 @@
|
||||
/*******************************************************************************
|
||||
* drivers/usbhost/usbhost_enumerate.c
|
||||
*
|
||||
* Copyright (C) 2011-2012 Gregory Nutt. All rights reserved.
|
||||
* Authors: Gregory Nutt <gnutt@nuttx.org>
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions
|
||||
* are met:
|
||||
*
|
||||
* 1. Redistributions of source code must retain the above copyright
|
||||
* notice, this list of conditions and the following disclaimer.
|
||||
* 2. Redistributions in binary form must reproduce the above copyright
|
||||
* notice, this list of conditions and the following disclaimer in
|
||||
* the documentation and/or other materials provided with the
|
||||
* distribution.
|
||||
* 3. Neither the name NuttX nor the names of its contributors may be
|
||||
* used to endorse or promote products derived from this software
|
||||
* without specific prior written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
||||
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
|
||||
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
||||
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
||||
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
|
||||
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
||||
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
||||
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
|
||||
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
|
||||
* POSSIBILITY OF SUCH DAMAGE.
|
||||
*
|
||||
*******************************************************************************/
|
||||
|
||||
/*******************************************************************************
|
||||
* Included Files
|
||||
*******************************************************************************/
|
||||
|
||||
#include <nuttx/config.h>
|
||||
|
||||
#include <sys/types.h>
|
||||
#include <stdint.h>
|
||||
#include <string.h>
|
||||
#include <unistd.h>
|
||||
#include <errno.h>
|
||||
#include <assert.h>
|
||||
#include <debug.h>
|
||||
|
||||
#include <nuttx/arch.h>
|
||||
#include <nuttx/usb/usb.h>
|
||||
#include <nuttx/usb/usbhost.h>
|
||||
|
||||
/*******************************************************************************
|
||||
* Definitions
|
||||
*******************************************************************************/
|
||||
|
||||
/*******************************************************************************
|
||||
* Private Types
|
||||
*******************************************************************************/
|
||||
|
||||
/*******************************************************************************
|
||||
* Private Function Prototypes
|
||||
*******************************************************************************/
|
||||
|
||||
static inline uint16_t usbhost_getle16(const uint8_t *val);
|
||||
static void usbhost_putle16(uint8_t *dest, uint16_t val);
|
||||
|
||||
static inline int usbhost_devdesc(const struct usb_devdesc_s *devdesc,
|
||||
struct usbhost_id_s *id);
|
||||
static inline int usbhost_configdesc(const uint8_t *configdesc, int desclen,
|
||||
struct usbhost_id_s *id);
|
||||
static inline int usbhost_classbind(FAR struct usbhost_driver_s *drvr,
|
||||
const uint8_t *configdesc, int desclen,
|
||||
struct usbhost_id_s *id, uint8_t funcaddr,
|
||||
FAR struct usbhost_class_s **class);
|
||||
|
||||
/*******************************************************************************
|
||||
* Private Data
|
||||
*******************************************************************************/
|
||||
|
||||
/*******************************************************************************
|
||||
* Public Data
|
||||
*******************************************************************************/
|
||||
|
||||
/*******************************************************************************
|
||||
* Private Functions
|
||||
*******************************************************************************/
|
||||
|
||||
/****************************************************************************
|
||||
* Name: usbhost_getle16
|
||||
*
|
||||
* Description:
|
||||
* Get a (possibly unaligned) 16-bit little endian value.
|
||||
*
|
||||
*******************************************************************************/
|
||||
|
||||
static inline uint16_t usbhost_getle16(const uint8_t *val)
|
||||
{
|
||||
return (uint16_t)val[1] << 8 | (uint16_t)val[0];
|
||||
}
|
||||
|
||||
/****************************************************************************
|
||||
* Name: usbhost_putle16
|
||||
*
|
||||
* Description:
|
||||
* Put a (possibly unaligned) 16-bit little endian value.
|
||||
*
|
||||
*******************************************************************************/
|
||||
|
||||
static void usbhost_putle16(uint8_t *dest, uint16_t val)
|
||||
{
|
||||
dest[0] = val & 0xff; /* Little endian means LS byte first in byte stream */
|
||||
dest[1] = val >> 8;
|
||||
}
|
||||
|
||||
/*******************************************************************************
|
||||
* Name: usbhost_devdesc
|
||||
*
|
||||
* Description:
|
||||
* A configuration descriptor has been obtained from the device. Find the
|
||||
* ID information for the class that supports this device.
|
||||
*
|
||||
*******************************************************************************/
|
||||
|
||||
static inline int usbhost_devdesc(FAR const struct usb_devdesc_s *devdesc,
|
||||
FAR struct usbhost_id_s *id)
|
||||
{
|
||||
/* Clear the ID info */
|
||||
|
||||
memset(id, 0, sizeof(struct usbhost_id_s));
|
||||
|
||||
/* Pick off the class ID info */
|
||||
|
||||
id->base = devdesc->classid;
|
||||
id->subclass = devdesc->subclass;
|
||||
id->proto = devdesc->protocol;
|
||||
|
||||
/* Pick off the VID and PID as well (for vendor specfic devices) */
|
||||
|
||||
id->vid = usbhost_getle16(devdesc->vendor);
|
||||
id->pid = usbhost_getle16(devdesc->product);
|
||||
|
||||
uvdbg("class:%d subclass:%04x protocol:%04x vid:%d pid:%d\n",
|
||||
id->base, id->subclass, id->proto, id->vid, id->pid);
|
||||
return OK;
|
||||
}
|
||||
|
||||
/*******************************************************************************
|
||||
* Name: usbhost_configdesc
|
||||
*
|
||||
* Description:
|
||||
* A configuration descriptor has been obtained from the device. Find the
|
||||
* ID information for the class that supports this device.
|
||||
*
|
||||
*******************************************************************************/
|
||||
|
||||
static inline int usbhost_configdesc(const uint8_t *configdesc, int cfglen,
|
||||
struct usbhost_id_s *id)
|
||||
{
|
||||
struct usb_cfgdesc_s *cfgdesc;
|
||||
struct usb_ifdesc_s *ifdesc;
|
||||
int remaining;
|
||||
|
||||
DEBUGASSERT(configdesc != NULL && cfglen >= USB_SIZEOF_CFGDESC);
|
||||
|
||||
/* Verify that we were passed a configuration descriptor */
|
||||
|
||||
cfgdesc = (struct usb_cfgdesc_s *)configdesc;
|
||||
uvdbg("cfg len:%d total len:%d\n", cfgdesc->len, cfglen);
|
||||
|
||||
if (cfgdesc->type != USB_DESC_TYPE_CONFIG)
|
||||
{
|
||||
return -EINVAL;
|
||||
}
|
||||
|
||||
/* Skip to the next entry descriptor */
|
||||
|
||||
configdesc += cfgdesc->len;
|
||||
remaining = cfglen - cfgdesc->len;
|
||||
|
||||
/* Loop where there are more dscriptors to examine */
|
||||
|
||||
memset(id, 0, sizeof(FAR struct usb_desc_s));
|
||||
while (remaining >= sizeof(struct usb_desc_s))
|
||||
{
|
||||
/* What is the next descriptor? Is it an interface descriptor? */
|
||||
|
||||
ifdesc = (struct usb_ifdesc_s *)configdesc;
|
||||
if (ifdesc->type == USB_DESC_TYPE_INTERFACE)
|
||||
{
|
||||
/* Yes, extract the class information from the interface descriptor.
|
||||
* Typically these values are zero meaning that the "real" ID
|
||||
* information resides in the device descriptor.
|
||||
*/
|
||||
|
||||
DEBUGASSERT(remaining >= sizeof(struct usb_ifdesc_s));
|
||||
id->base = ifdesc->classid;
|
||||
id->subclass = ifdesc->subclass;
|
||||
id->proto = ifdesc->protocol;
|
||||
uvdbg("class:%d subclass:%d protocol:%d\n",
|
||||
id->base, id->subclass, id->proto);
|
||||
return OK;
|
||||
}
|
||||
|
||||
/* Increment the address of the next descriptor */
|
||||
|
||||
configdesc += ifdesc->len;
|
||||
remaining -= ifdesc->len;
|
||||
}
|
||||
|
||||
return -ENOENT;
|
||||
}
|
||||
|
||||
/*******************************************************************************
|
||||
* Name: usbhost_classbind
|
||||
*
|
||||
* Description:
|
||||
* A configuration descriptor has been obtained from the device. Try to
|
||||
* bind this configuration descriptor with a supported class.
|
||||
*
|
||||
*******************************************************************************/
|
||||
|
||||
static inline int usbhost_classbind(FAR struct usbhost_driver_s *drvr,
|
||||
const uint8_t *configdesc, int desclen,
|
||||
struct usbhost_id_s *id, uint8_t funcaddr,
|
||||
FAR struct usbhost_class_s **class)
|
||||
{
|
||||
FAR struct usbhost_class_s *devclass;
|
||||
const struct usbhost_registry_s *reg;
|
||||
int ret = -EINVAL;
|
||||
|
||||
/* Is there is a class implementation registered to support this device. */
|
||||
|
||||
reg = usbhost_findclass(id);
|
||||
uvdbg("usbhost_findclass: %p\n", reg);
|
||||
if (reg)
|
||||
{
|
||||
/* Yes.. there is a class for this device. Get an instance of
|
||||
* its interface.
|
||||
*/
|
||||
|
||||
ret = -ENOMEM;
|
||||
devclass = CLASS_CREATE(reg, drvr, id);
|
||||
uvdbg("CLASS_CREATE: %p\n", devclass);
|
||||
if (devclass)
|
||||
{
|
||||
/* Then bind the newly instantiated class instance */
|
||||
|
||||
ret = CLASS_CONNECT(devclass, configdesc, desclen, funcaddr);
|
||||
if (ret != OK)
|
||||
{
|
||||
/* On failures, call the class disconnect method which
|
||||
* should then free the allocated devclass instance.
|
||||
*/
|
||||
|
||||
udbg("CLASS_CONNECT failed: %d\n", ret);
|
||||
CLASS_DISCONNECTED(devclass);
|
||||
}
|
||||
else
|
||||
{
|
||||
*class = devclass;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
uvdbg("Returning: %d\n", ret);
|
||||
return ret;
|
||||
}
|
||||
|
||||
/*******************************************************************************
|
||||
* Public Functions
|
||||
*******************************************************************************/
|
||||
|
||||
/*******************************************************************************
|
||||
* Name: usbhost_enumerate
|
||||
*
|
||||
* Description:
|
||||
* Enumerate the connected device. As part of this enumeration process,
|
||||
* the driver will (1) get the device's configuration descriptor, (2)
|
||||
* extract the class ID info from the configuration descriptor, (3) call
|
||||
* usbhost_findclass() to find the class that supports this device, (4)
|
||||
* call the create() method on the struct usbhost_registry_s interface
|
||||
* to get a class instance, and finally (5) call the configdesc() method
|
||||
* of the struct usbhost_class_s interface. After that, the class is in
|
||||
* charge of the sequence of operations.
|
||||
*
|
||||
* Input Parameters:
|
||||
* drvr - The USB host driver instance obtained as a parameter from the call to
|
||||
* the class create() method.
|
||||
* funcaddr - The USB address of the function containing the endpoint that EP0
|
||||
* controls
|
||||
* class - If the class driver for the device is successful located
|
||||
* and bound to the driver, the allocated class instance is returned into
|
||||
* this caller-provided memory location.
|
||||
*
|
||||
* Returned Values:
|
||||
* On success, zero (OK) is returned. On a failure, a negated errno value is
|
||||
* returned indicating the nature of the failure
|
||||
*
|
||||
* Assumptions:
|
||||
* - Only a single class bound to a single device is supported.
|
||||
* - Called from a single thread so no mutual exclusion is required.
|
||||
* - Never called from an interrupt handler.
|
||||
*
|
||||
*******************************************************************************/
|
||||
|
||||
int usbhost_enumerate(FAR struct usbhost_driver_s *drvr, uint8_t funcaddr,
|
||||
FAR struct usbhost_class_s **class)
|
||||
{
|
||||
struct usb_ctrlreq_s *ctrlreq;
|
||||
struct usbhost_id_s id;
|
||||
size_t maxlen;
|
||||
unsigned int cfglen;
|
||||
uint8_t maxpacketsize;
|
||||
uint8_t *buffer;
|
||||
int ret;
|
||||
|
||||
DEBUGASSERT(drvr && class);
|
||||
|
||||
/* Allocate descriptor buffers for use in this function. We will need two:
|
||||
* One for the request and one for the data buffer.
|
||||
*/
|
||||
|
||||
ret = DRVR_ALLOC(drvr, (FAR uint8_t **)&ctrlreq, &maxlen);
|
||||
if (ret != OK)
|
||||
{
|
||||
udbg("DRVR_ALLOC failed: %d\n", ret);
|
||||
return ret;
|
||||
}
|
||||
|
||||
ret = DRVR_ALLOC(drvr, &buffer, &maxlen);
|
||||
if (ret != OK)
|
||||
{
|
||||
udbg("DRVR_ALLOC failed: %d\n", ret);
|
||||
goto errout;
|
||||
}
|
||||
|
||||
/* Set max pkt size = 8 */
|
||||
|
||||
DRVR_EP0CONFIGURE(drvr, 0, 8);
|
||||
|
||||
/* Read first 8 bytes of the device descriptor */
|
||||
|
||||
ctrlreq->type = USB_REQ_DIR_IN|USB_REQ_RECIPIENT_DEVICE;
|
||||
ctrlreq->req = USB_REQ_GETDESCRIPTOR;
|
||||
usbhost_putle16(ctrlreq->value, (USB_DESC_TYPE_DEVICE << 8));
|
||||
usbhost_putle16(ctrlreq->index, 0);
|
||||
usbhost_putle16(ctrlreq->len, 8);
|
||||
|
||||
ret = DRVR_CTRLIN(drvr, ctrlreq, buffer);
|
||||
if (ret != OK)
|
||||
{
|
||||
udbg("ERROR: GETDESCRIPTOR/DEVICE, DRVR_CTRLIN returned %d\n", ret);
|
||||
goto errout;
|
||||
}
|
||||
|
||||
/* Extract the correct max packetsize from the device descriptor */
|
||||
|
||||
maxpacketsize = ((struct usb_devdesc_s *)buffer)->mxpacketsize;
|
||||
uvdbg("maxpacksetsize: %d\n", maxpacketsize);
|
||||
|
||||
/* And reconfigure EP0 */
|
||||
|
||||
DRVR_EP0CONFIGURE(drvr, 0, maxpacketsize);
|
||||
|
||||
/* Now read the full device descriptor */
|
||||
|
||||
ctrlreq->type = USB_REQ_DIR_IN|USB_REQ_RECIPIENT_DEVICE;
|
||||
ctrlreq->req = USB_REQ_GETDESCRIPTOR;
|
||||
usbhost_putle16(ctrlreq->value, (USB_DESC_TYPE_DEVICE << 8));
|
||||
usbhost_putle16(ctrlreq->index, 0);
|
||||
usbhost_putle16(ctrlreq->len, USB_SIZEOF_DEVDESC);
|
||||
|
||||
ret = DRVR_CTRLIN(drvr, ctrlreq, buffer);
|
||||
if (ret != OK)
|
||||
{
|
||||
udbg("ERROR: GETDESCRIPTOR/DEVICE, DRVR_CTRLIN returned %d\n", ret);
|
||||
goto errout;
|
||||
}
|
||||
|
||||
/* Get class identification information from the device descriptor. Most
|
||||
* devices set this to USB_CLASS_PER_INTERFACE (zero) and provide the
|
||||
* identification informatino in the interface descriptor(s). That allows
|
||||
* a device to support multiple, different classes.
|
||||
*/
|
||||
|
||||
(void)usbhost_devdesc((struct usb_devdesc_s *)buffer, &id);
|
||||
|
||||
/* Set the USB device address to the value in the 'funcaddr' input */
|
||||
|
||||
ctrlreq->type = USB_REQ_DIR_OUT|USB_REQ_RECIPIENT_DEVICE;
|
||||
ctrlreq->req = USB_REQ_SETADDRESS;
|
||||
usbhost_putle16(ctrlreq->value, (uint16_t)funcaddr);
|
||||
usbhost_putle16(ctrlreq->index, 0);
|
||||
usbhost_putle16(ctrlreq->len, 0);
|
||||
|
||||
ret = DRVR_CTRLOUT(drvr, ctrlreq, NULL);
|
||||
if (ret != OK)
|
||||
{
|
||||
udbg("ERROR: SETADDRESS DRVR_CTRLOUT returned %d\n", ret);
|
||||
goto errout;
|
||||
}
|
||||
usleep(2*1000);
|
||||
|
||||
/* Modify control pipe with the provided USB device address */
|
||||
|
||||
DRVR_EP0CONFIGURE(drvr, funcaddr, maxpacketsize);
|
||||
|
||||
/* Get the configuration descriptor (only), index == 0. Should not be
|
||||
* hard-coded! More logic is needed in order to handle devices with
|
||||
* multiple configurations.
|
||||
*/
|
||||
|
||||
ctrlreq->type = USB_REQ_DIR_IN|USB_REQ_RECIPIENT_DEVICE;
|
||||
ctrlreq->req = USB_REQ_GETDESCRIPTOR;
|
||||
usbhost_putle16(ctrlreq->value, (USB_DESC_TYPE_CONFIG << 8));
|
||||
usbhost_putle16(ctrlreq->index, 0);
|
||||
usbhost_putle16(ctrlreq->len, USB_SIZEOF_CFGDESC);
|
||||
|
||||
ret = DRVR_CTRLIN(drvr, ctrlreq, buffer);
|
||||
if (ret != OK)
|
||||
{
|
||||
udbg("ERROR: GETDESCRIPTOR/CONFIG, DRVR_CTRLIN returned %d\n", ret);
|
||||
goto errout;
|
||||
}
|
||||
|
||||
/* Extract the full size of the configuration data */
|
||||
|
||||
cfglen = (unsigned int)usbhost_getle16(((struct usb_cfgdesc_s *)buffer)->totallen);
|
||||
uvdbg("sizeof config data: %d\n", cfglen);
|
||||
|
||||
/* Get all of the configuration descriptor data, index == 0 (Should not be
|
||||
* hard-coded!)
|
||||
*/
|
||||
|
||||
ctrlreq->type = USB_REQ_DIR_IN|USB_REQ_RECIPIENT_DEVICE;
|
||||
ctrlreq->req = USB_REQ_GETDESCRIPTOR;
|
||||
usbhost_putle16(ctrlreq->value, (USB_DESC_TYPE_CONFIG << 8));
|
||||
usbhost_putle16(ctrlreq->index, 0);
|
||||
usbhost_putle16(ctrlreq->len, cfglen);
|
||||
|
||||
ret = DRVR_CTRLIN(drvr, ctrlreq, buffer);
|
||||
if (ret != OK)
|
||||
{
|
||||
udbg("ERROR: GETDESCRIPTOR/CONFIG, DRVR_CTRLIN returned %d\n", ret);
|
||||
goto errout;
|
||||
}
|
||||
|
||||
/* Select device configuration 1 (Should not be hard-coded!) */
|
||||
|
||||
ctrlreq->type = USB_REQ_DIR_OUT|USB_REQ_RECIPIENT_DEVICE;
|
||||
ctrlreq->req = USB_REQ_SETCONFIGURATION;
|
||||
usbhost_putle16(ctrlreq->value, 1);
|
||||
usbhost_putle16(ctrlreq->index, 0);
|
||||
usbhost_putle16(ctrlreq->len, 0);
|
||||
|
||||
ret = DRVR_CTRLOUT(drvr, ctrlreq, NULL);
|
||||
if (ret != OK)
|
||||
{
|
||||
udbg("ERROR: SETCONFIGURATION, DRVR_CTRLOUT returned %d\n", ret);
|
||||
goto errout;
|
||||
}
|
||||
|
||||
/* Free the descriptor buffer that we were using for the request buffer.
|
||||
* It is not needed further here but it may be needed by the class driver
|
||||
* during its connection operations.
|
||||
*/
|
||||
|
||||
DRVR_FREE(drvr, (uint8_t*)ctrlreq);
|
||||
ctrlreq = NULL;
|
||||
|
||||
/* Was the class identification information provided in the device descriptor?
|
||||
* Or do we need to find it in the interface descriptor(s)?
|
||||
*/
|
||||
|
||||
if (id.base == USB_CLASS_PER_INTERFACE)
|
||||
{
|
||||
/* Get the class identification information for this device from the
|
||||
* interface descriptor(s). Hmmm.. More logic is need to handle the
|
||||
* case of multiple interface descriptors.
|
||||
*/
|
||||
|
||||
ret = usbhost_configdesc(buffer, cfglen, &id);
|
||||
if (ret != OK)
|
||||
{
|
||||
udbg("ERROR: usbhost_configdesc returned %d\n", ret);
|
||||
goto errout;
|
||||
}
|
||||
}
|
||||
|
||||
/* Some devices may require some delay before initialization */
|
||||
|
||||
usleep(100*1000);
|
||||
|
||||
/* Parse the configuration descriptor and bind to the class instance for the
|
||||
* device. This needs to be the last thing done because the class driver
|
||||
* will begin configuring the device.
|
||||
*/
|
||||
|
||||
ret = usbhost_classbind(drvr, buffer, cfglen, &id, funcaddr, class);
|
||||
if (ret != OK)
|
||||
{
|
||||
udbg("ERROR: usbhost_classbind returned %d\n", ret);
|
||||
}
|
||||
|
||||
errout:
|
||||
if (buffer)
|
||||
{
|
||||
DRVR_FREE(drvr, buffer);
|
||||
}
|
||||
|
||||
if (ctrlreq)
|
||||
{
|
||||
DRVR_FREE(drvr, (uint8_t*)ctrlreq);
|
||||
}
|
||||
return ret;
|
||||
}
|
||||
Reference in New Issue
Block a user