You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
366 lines
12 KiB
366 lines
12 KiB
/**************************************************************************** |
|
* drivers/usbdev/composite_descriptors.c |
|
* |
|
* Copyright (C) 2011-2012 Gregory Nutt. All rights reserved. |
|
* Author: 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 <errno.h> |
|
#include <debug.h> |
|
|
|
#include <nuttx/usb/usbdev_trace.h> |
|
|
|
#include "composite.h" |
|
|
|
#ifdef CONFIG_CDCSER_COMPOSITE |
|
# include "cdcacm.h" |
|
#endif |
|
|
|
#ifdef CONFIG_USBSTRG_COMPOSITE |
|
# include "msc.h" |
|
#endif |
|
|
|
#ifdef CONFIG_USBDEV_COMPOSITE |
|
|
|
/**************************************************************************** |
|
* Pre-processor Definitions |
|
****************************************************************************/ |
|
|
|
#undef DEV1_IS_CDCSERIAL |
|
#undef DEV1_IS_USBSTRG |
|
|
|
#undef DEV2_IS_CDCSERIAL |
|
#undef DEV2_IS_USBSTRG |
|
|
|
/* Pick the first device in the composite. At present, this may only be |
|
* the CDC serial device or the mass storage device. |
|
*/ |
|
|
|
#if defined(CONFIG_CDCSER_COMPOSITE) |
|
# define DEV1_IS_CDCSERIAL 1 |
|
# define DEV1_MKCFGDESC cdcser_mkcfgdesc |
|
# define DEV1_NCONFIGS CDCSER_NCONFIGS |
|
# define DEV1_CONFIGID CDCSER_CONFIGID |
|
# define DEV1_NINTERFACES CDCSER_NINTERFACES |
|
# define DEV1_FIRSTSTRID CONFIG_CDCSER_STRBASE |
|
# define DEV1_NSTRIDS (CDCSER_LASTSTRID-CONFIG_CDCSER_STRBASE) |
|
# define DEV1_CFGDESCSIZE SIZEOF_CDCSER_CFGDESC |
|
#elif defined(CONFIG_CDCSER_COMPOSITE) |
|
# define DEV1_IS_USBSTRG 1 |
|
# define DEV1_MKCFGDESC composite_mkcfgdesc |
|
# define DEV1_NCONFIGS USBSTRG_NCONFIGS |
|
# define DEV1_CONFIGID USBSTRG_CONFIGID |
|
# define DEV1_NINTERFACES USBSTRG_NINTERFACES |
|
# define DEV1_FIRSTSTRID CONFIG_CDCSER_STRBASE |
|
# define DEV1_NSTRIDS (USBSTRG_LASTSTRID-CONFIG_USBSTRG_STRBASE) |
|
# define DEV1_CFGDESCSIZE SIZEOF_USBSTRG_CFGDESC |
|
#else |
|
# error "No members of the composite defined" |
|
#endif |
|
|
|
/* Pick the second device in the composite. At present, this may only be |
|
* the CDC serial device or the mass storage device. |
|
*/ |
|
|
|
#if defined(CONFIG_CDCSER_COMPOSITE) && !defined(DEV1_IS_CDCSERIAL) |
|
# define DEV2_IS_CDCSERIAL 1 |
|
# define DEV2_MKCFGDESC cdcser_mkcfgdesc |
|
# define DEV2_NCONFIGS CDCSER_NCONFIGS |
|
# define DEV2_CONFIGID CDCSER_CONFIGID |
|
# define DEV2_NINTERFACES CDCSER_NINTERFACES |
|
# define DEV2_FIRSTSTRID CONFIG_CDCSER_STRBASE |
|
# define DEV2_NSTRIDS (CDCSER_LASTSTRID-CONFIG_CDCSER_STRBASE) |
|
# define DEV2_CFGDESCSIZE SIZEOF_CDCSER_CFGDESC |
|
#elif defined(CONFIG_CDCSER_COMPOSITE) && !defined(DEV1_IS_USBSTRG) |
|
# define DEV2_IS_USBSTRG 1 |
|
# define DEV2_MKCFGDESC composite_mkcfgdesc |
|
# define DEV2_NCONFIGS USBSTRG_NCONFIGS |
|
# define DEV2_CONFIGID USBSTRG_CONFIGID |
|
# define DEV2_NINTERFACES USBSTRG_NINTERFACES |
|
# define DEV2_FIRSTSTRID CONFIG_CDCSER_STRBASE |
|
# define DEV2_NSTRIDS (USBSTRG_LASTSTRID-CONFIG_USBSTRG_STRBASE) |
|
# define DEV2_CFGDESCSIZE SIZEOF_USBSTRG_CFGDESC |
|
#else |
|
# error "Insufficient members of the composite defined" |
|
#endif |
|
|
|
/* Total size of the configuration descriptor: */ |
|
|
|
#define COMPOSITE_CFGDESCSIZE (USB_SIZEOF_CFGDESC + DEV1_CFGDESCSIZE + DEV2_CFGDESCSIZE) |
|
|
|
/* The total number of interfaces */ |
|
|
|
#define COMPOSITE_NINTERFACES (DEV1_NINTERFACES + DEV2_NINTERFACES) |
|
|
|
/* Composite configuration ID value */ |
|
|
|
#if DEV1_NCONFIGS != 1 || DEV1_CONFIGID != 1 |
|
# error "DEV1: Only a single configuration is supported" |
|
#endif |
|
|
|
#if DEV2_NCONFIGS != 1 || DEV2_CONFIGID != 1 |
|
# error "DEV2: Only a single configuration is supported" |
|
#endif |
|
|
|
#define COMPOSITE_NCONFIGS 1 |
|
#define COMPOSITE_CONFIGID 1 |
|
|
|
/**************************************************************************** |
|
* Private Types |
|
****************************************************************************/ |
|
|
|
#ifdef CONFIG_USBDEV_DUALSPEED |
|
typedef int16_t (*mkcfgdesc)(FAR uint8_t *buf, uint8_t speed, uint8_t type); |
|
#else |
|
typedef int16_t (*mkcfgdesc)(FAR uint8_t *buf); |
|
#endif |
|
|
|
/**************************************************************************** |
|
* Private Function Prototypes |
|
****************************************************************************/ |
|
|
|
/**************************************************************************** |
|
* Private Data |
|
****************************************************************************/ |
|
/* Device Descriptor */ |
|
|
|
static const struct usb_devdesc_s g_devdesc = |
|
{ |
|
USB_SIZEOF_DEVDESC, /* len */ |
|
USB_DESC_TYPE_DEVICE, /* type */ |
|
{ /* usb */ |
|
LSBYTE(0x0200), |
|
MSBYTE(0x0200) |
|
}, |
|
USB_CLASS_PER_INTERFACE, /* class */ |
|
0, /* subclass */ |
|
0, /* protocol */ |
|
CONFIG_COMPOSITE_EP0MAXPACKET, /* maxpacketsize */ |
|
{ |
|
LSBYTE(CONFIG_COMPOSITE_VENDORID), /* vendor */ |
|
MSBYTE(CONFIG_COMPOSITE_VENDORID) |
|
}, |
|
{ |
|
LSBYTE(CONFIG_COMPOSITE_PRODUCTID), /* product */ |
|
MSBYTE(CONFIG_COMPOSITE_PRODUCTID) |
|
}, |
|
{ |
|
LSBYTE(CONFIG_COMPOSITE_VERSIONNO), /* device */ |
|
MSBYTE(CONFIG_COMPOSITE_VERSIONNO) |
|
}, |
|
COMPOSITE_MANUFACTURERSTRID, /* imfgr */ |
|
COMPOSITE_PRODUCTSTRID, /* iproduct */ |
|
COMPOSITE_SERIALSTRID, /* serno */ |
|
COMPOSITE_NCONFIGS /* nconfigs */ |
|
}; |
|
|
|
/* Configuration descriptor for the composite device */ |
|
|
|
static const struct usb_cfgdesc_s g_cfgdesc = |
|
{ |
|
USB_SIZEOF_CFGDESC, /* len */ |
|
USB_DESC_TYPE_CONFIG, /* type */ |
|
{ |
|
LSBYTE(COMPOSITE_CFGDESCSIZE), /* LS totallen */ |
|
MSBYTE(COMPOSITE_CFGDESCSIZE) /* MS totallen */ |
|
}, |
|
COMPOSITE_NINTERFACES, /* ninterfaces */ |
|
COMPOSITE_CONFIGID, /* cfgvalue */ |
|
COMPOSITE_CONFIGSTRID, /* icfg */ |
|
USB_CONFIG_ATTR_ONE|SELFPOWERED|REMOTEWAKEUP, /* attr */ |
|
(CONFIG_USBDEV_MAXPOWER + 1) / 2 /* mxpower */ |
|
}; |
|
|
|
#ifdef CONFIG_USBDEV_DUALSPEED |
|
static const struct usb_qualdesc_s g_qualdesc = |
|
{ |
|
USB_SIZEOF_QUALDESC, /* len */ |
|
USB_DESC_TYPE_DEVICEQUALIFIER, /* type */ |
|
{ /* usb */ |
|
LSBYTE(0x0200), |
|
MSBYTE(0x0200) |
|
}, |
|
USB_CLASS_VENDOR_SPEC, /* class */ |
|
0, /* subclass */ |
|
0, /* protocol */ |
|
CONFIG_COMPOSITE_EP0MAXPACKET, /* mxpacketsize */ |
|
COMPOSITE_NCONFIGS, /* nconfigs */ |
|
0, /* reserved */ |
|
}; |
|
#endif |
|
|
|
/**************************************************************************** |
|
* Private Functions |
|
****************************************************************************/ |
|
|
|
/**************************************************************************** |
|
* Public Functions |
|
****************************************************************************/ |
|
|
|
/**************************************************************************** |
|
* Name: usbstrg_mkstrdesc |
|
* |
|
* Description: |
|
* Construct a string descriptor |
|
* |
|
****************************************************************************/ |
|
|
|
int composite_mkstrdesc(uint8_t id, struct usb_strdesc_s *strdesc) |
|
{ |
|
const char *str; |
|
int len; |
|
int ndata; |
|
int i; |
|
|
|
switch (id) |
|
{ |
|
case 0: |
|
{ |
|
/* Descriptor 0 is the language id */ |
|
|
|
strdesc->len = 4; |
|
strdesc->type = USB_DESC_TYPE_STRING; |
|
strdesc->data[0] = LSBYTE(USBSTRG_STR_LANGUAGE); |
|
strdesc->data[1] = MSBYTE(USBSTRG_STR_LANGUAGE); |
|
return 4; |
|
} |
|
|
|
case COMPOSITE_MANUFACTURERSTRID: |
|
str = g_vendorstr; |
|
break; |
|
|
|
case COMPOSITE_PRODUCTSTRID: |
|
str = g_productstr; |
|
break; |
|
|
|
case COMPOSITE_SERIALSTRID: |
|
str = g_serialstr; |
|
break; |
|
|
|
case COMPOSITE_CONFIGSTRID: |
|
str = CONFIG_USBSTRG_CONFIGSTR; |
|
break; |
|
|
|
default: |
|
return -EINVAL; |
|
} |
|
|
|
/* The string is utf16-le. The poor man's utf-8 to utf16-le |
|
* conversion below will only handle 7-bit en-us ascii |
|
*/ |
|
|
|
len = strlen(str); |
|
for (i = 0, ndata = 0; i < len; i++, ndata += 2) |
|
{ |
|
strdesc->data[ndata] = str[i]; |
|
strdesc->data[ndata+1] = 0; |
|
} |
|
|
|
strdesc->len = ndata+2; |
|
strdesc->type = USB_DESC_TYPE_STRING; |
|
return strdesc->len; |
|
} |
|
|
|
/**************************************************************************** |
|
* Name: composite_getepdesc |
|
* |
|
* Description: |
|
* Return a pointer to the raw device descriptor |
|
* |
|
****************************************************************************/ |
|
|
|
#ifndef CONFIG_USBSTRG_COMPOSITE |
|
FAR const struct usb_devdesc_s *composite_getdevdesc(void) |
|
{ |
|
return &g_devdesc; |
|
} |
|
#endif |
|
|
|
/**************************************************************************** |
|
* Name: composite_mkcfgdesc |
|
* |
|
* Description: |
|
* Construct the configuration descriptor |
|
* |
|
****************************************************************************/ |
|
|
|
#ifdef CONFIG_USBDEV_DUALSPEED |
|
int16_t composite_mkcfgdesc(uint8_t *buf, uint8_t speed, uint8_t type) |
|
#else |
|
int16_t composite_mkcfgdesc(uint8_t *buf) |
|
#endif |
|
{ |
|
FAR struct usb_cfgdesc_s *cfgdesc = (struct usb_cfgdesc_s*)buf; |
|
|
|
/* Configuration descriptor -- Copy the canned configuration descriptor. */ |
|
|
|
memcpy(cfgdesc, &g_cfgdesc, USB_SIZEOF_CFGDESC); |
|
buf += USB_SIZEOF_CFGDESC; |
|
|
|
/* Copy DEV1/DEV2 configuration descriptors */ |
|
|
|
#ifdef CONFIG_USBDEV_DUALSPEED |
|
buf += DEV1_MKCFGDESC(buf, speed, type); |
|
buf += DEV2_MKCFGDESC(buf, speed, type); |
|
#else |
|
buf += DEV1_MKCFGDESC(buf); |
|
buf += DEV2_MKCFGDESC(buf); |
|
#endif |
|
|
|
return COMPOSITE_CFGDESCSIZE; |
|
} |
|
|
|
/**************************************************************************** |
|
* Name: composite_getqualdesc |
|
* |
|
* Description: |
|
* Return a pointer to the raw qual descriptor |
|
* |
|
****************************************************************************/ |
|
|
|
#ifdef CONFIG_USBDEV_DUALSPEED |
|
FAR const struct usb_qualdesc_s *composite_getqualdesc(void) |
|
{ |
|
return &g_qualdesc; |
|
} |
|
#endif |
|
|
|
#endif /* CONFIG_USBDEV_COMPOSITE */
|
|
|