cascoda_usb.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2019, Cascoda Ltd.
 *  All rights reserved.
 *
 *  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 of the copyright holder 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 HOLDER 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.
 */
#ifndef CASCODA_USB_H
#define CASCODA_USB_H
 
#include "cascoda-bm/cascoda_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/******************************************************************************/
/****** USB Descriptor Types                                             ******/
/******************************************************************************/
#define USB_DT_DEVICE (1)
#define USB_DT_CONFIGURATION (2)
#define USB_DT_STRING (3)
#define USB_DT_INTERFACE (4)
#define USB_DT_ENDPOINT (5)
 
#define USB_DT_BOS (15)
#define USB_DT_DEVICE_CAPABILITY (16)
 
#define USB_DT_HID (33)
#define USB_DT_HID_RPT (34)
 
/******************************************************************************/
/****** USB Device Capability Types                                      ******/
/******************************************************************************/
#define USB_DCT_WIRELESS (1)
#define USB_DCT_2_0_EXTENSION (2)
 
typedef struct UsbDeviceDescriptor
{
    u8_t bLength;            
    u8_t bDescriptorType;    
    u8_t bcdUSB[2];          
    u8_t bDeviceClass;       
    u8_t bDeviceSubClass;    
    u8_t bDeviceProtocol;    
    u8_t bMaxPacketSize0;    
    u8_t idVendor[2];        
    u8_t idProduct[2];       
    u8_t bcdDevice[2];       
    u8_t iManufacturer;      
    u8_t iProduct;           
    u8_t iSerialNumber;      
    u8_t bNumConfigurations; 
} UsbDeviceDescriptor_t;
 
typedef struct UsbBOSDescriptor
{
    u8_t bLength;         
    u8_t bDescriptorType; 
    u8_t wTotalLength[2]; 
    u8_t bNumDeviceCaps;  
} UsbBOSDescriptor_t;
 
typedef struct UsbDeviceCapabilityDescriptor
{
    u8_t bLength;            
    u8_t bDescriptorType;    
    u8_t bDevCapabilityType; 
} UsbDeviceCapabilityDescriptor_t;
 
typedef struct UsbConfigurationDescriptor
{
    u8_t bLength;             
    u8_t bDescriptorType;     
    u8_t wTotalLength[2];     
    u8_t bNumInterfaces;      
    u8_t bConfigurationValue; 
    u8_t iConfiguration;      
    u8_t bmAttributes;        
    u8_t bMaxPower;           
} UsbConfigurationDescriptor_t;
 
typedef struct UsbInterfaceDescriptor
{
    u8_t bLength;            
    u8_t bDescriptorType;    
    u8_t bInterfaceNumber;   
    u8_t bAlternateSetting;  
    u8_t bNumEndpoints;      
    u8_t iInterfaceClass;    
    u8_t iInterfaceSubClass; 
    u8_t bInterfaceProtocol; 
    u8_t iInterface;         
} UsbInterfaceDescriptor_t;
 
typedef struct UsbEndpointDescriptor
{
    u8_t bLength;           
    u8_t bDescriptorType;   
    u8_t bEndpointAddress;  
    u8_t bmAttributes;      
    u8_t wMaxPacketSize[2]; 
    u8_t bInterval;         
} UsbEndpointDescriptor_t;
 
typedef struct UsbStringDescriptor
{
    u8_t *pu8String;        
    u8_t *pu8UniCodeString; 
} UsbStringDescriptor_t;
 
/******************************************************************************/
/****** String indexes                                                   ******/
/******************************************************************************/
#define USB_ILANGUAGE (0)
#define USB_IMANUFACTURER (1)
#define USB_IPRODUCT (2)
#define USB_ISERIAL (3)
#define USB_ILAST (3)
#ifdef __cplusplus
}
#endif
 
#endif // CASCODA_USB_H