em_usbxpress_descriptors.h

Go to the documentation of this file.

/***************************************************************************/
#ifndef EM_USBXPRESS_DESCRIPTORS_H
#define EM_USBXPRESS_DESCRIPTORS_H

#ifdef __cplusplus
extern "C" {
#endif

// -----------------------------------------------------------------------------
// Constant Definitions

// -------------------------------
// USB Identification

// Initial VID/PID values.  Should never be used.  VID/PID loaded by USB_Init()
#define USB_VENDOR_ID               USB_VENDOR_ID_SILICON_LABS
#define USB_PRODUCT_ID              0x0000

// Interface number for USBXpress
#define USBXPRESS_IFC_NUMBER        0

#define USBXPRESS_SETUP_EP_ADDR     0x00
#define USBXPRESS_IN_EP_ADDR        0x81
#define USBXPRESS_OUT_EP_ADDR       0x01

// -------------------------------
// Extended Compatibility

// Microsoft OS Feature Descriptor Indexes
#define FEATURE_GENRE                       1   
#define FEATURE_EXTENDED_COMPATIBILITY_ID   4   
#define FEATURE_EXTENDED_PROPERTIES_ID      5   

#define EXT_COMP_DESC_SIZE                  sizeof(USB_ExtendedCompatIdOsFeatureDesc_t)

#define EXT_COMP_VENDOR_CODE                1   

#define NUM_IFCS_WITH_EXT_COMPAT            1

// -------------------------------
// Extended Properties

// Data Types for Microsoft Extended Properties Feature Descriptor
#define EXTENDED_PROPERTY_TYPE_REG_SZ                   1   
#define EXTENDED_PROPERTY_TYPE_REG_EXPAND_SZ            2   
#define EXTENDED_PROPERTY_TYPE_REG_BINARY               3   
#define EXTENDED_PROPERTY_TYPE_REG_DWORD_LITTLE_ENDIAN  4   
#define EXTENDED_PROPERTY_TYPE_REG_DWORD_BIG_ENDIAN     5   
#define EXTENDED_PROPERTY_TYPE_REG_LINK                 6   
#define EXTENDED_PROPERTY_TYPE_MULTI_SZ                 7   

#define GUID_PROPERTY_NAME_LEN  sizeof ("DeviceInterfaceGUIDs") * 2

#define GUID_PROPERTY_NAME \
{ \
   'D', 0, \
   'e', 0, \
   'v', 0, \
   'i', 0, \
   'c', 0, \
   'e', 0, \
   'I', 0, \
   'n', 0, \
   't', 0, \
   'e', 0, \
   'r', 0, \
   'f', 0, \
   'a', 0, \
   'c', 0, \
   'e', 0, \
   'G', 0, \
   'U', 0, \
   'I', 0, \
   'D', 0, \
   's', 0, \
   '\0',0, \
}

#define GUID_PROPERTY_LEN     (sizeof("{3C5E1462-5695-4e18-876B-F3F3D08AAF18}\0") * 2)

#define GUID_PROPERTY \
{ \
   '{', 0, \
   '3', 0, \
   'C', 0, \
   '5', 0, \
   'E', 0, \
   '1', 0, \
   '4', 0, \
   '6', 0, \
   '2', 0, \
   '-', 0, \
   '5', 0, \
   '6', 0, \
   '9', 0, \
   '5', 0, \
   '-', 0, \
   '4', 0, \
   'e', 0, \
   '1', 0, \
   '8', 0, \
   '-', 0, \
   '8', 0, \
   '7', 0, \
   '6', 0, \
   'B', 0, \
   '-', 0, \
   'F', 0, \
   '3', 0, \
   'F', 0, \
   '3', 0, \
   'D', 0, \
   '0', 0, \
   '8', 0, \
   'A', 0, \
   'A', 0, \
   'F', 0, \
   '1', 0, \
   '8', 0, \
   '}', 0, \
   '\0',0, \
   '\0',0, \
}

#define GUID_PROPERTY_DESCRIPTOR_SIZE (14 + GUID_PROPERTY_NAME_LEN + GUID_PROPERTY_LEN)

#define PROPERTIES_DESCRIPTOR_SIZE    (10 + GUID_PROPERTY_DESCRIPTOR_SIZE)

// -----------------------------------------------------------------------------
// Typedef Definitions

SL_PACK_START(1)
typedef struct
{
  uint8_t firstInterfaceNumber;     
  uint8_t reserved1;                
  char compatibleID[8];             
  char subCompatibleID[8];          
  uint8_t reserved2[6];             
} SL_ATTRIBUTE_PACKED USB_CompatFunctionDesc_t;
SL_PACK_END()

SL_PACK_START(1)
typedef struct
{
  uint32_t length;                  
  uint16_t bcdVersion;              
  uint16_t index;                   
  uint8_t count;                    
  uint8_t reserved1[7];             

  const USB_CompatFunctionDesc_t
    ecid[NUM_IFCS_WITH_EXT_COMPAT]; 

} SL_ATTRIBUTE_PACKED USB_ExtendedCompatIdOsFeatureDesc_t;
SL_PACK_END()

SL_PACK_START(1)
typedef struct
{
  uint32_t wLength;                                 
  uint16_t bcdVersion;                              
  uint16_t index;                                   
  uint16_t count;                                   

  // GUID Property
  uint32_t size2;                                   
  uint32_t propertyDataType;                        
  uint16_t propertyNameLength;                      
  uint8_t propertyName[GUID_PROPERTY_NAME_LEN];     
  uint32_t propertyDataLength;                      
  uint8_t propertyData2[GUID_PROPERTY_LEN];         
} SL_ATTRIBUTE_PACKED USB_ExtendedPropertiesDescriptor_t;
SL_PACK_END()

// -----------------------------------------------------------------------------
// Extern Variable Declarations

extern const USB_DeviceDescriptor_TypeDef USBXCORE_deviceDescInit;
extern const uint8_t USBXCORE_configDescInit[];
extern const uint8_t USBXCORE_stringLangDesc[];
extern const uint8_t USBXCORE_microsoftOsDesc[];
extern const USB_ExtendedCompatIdOsFeatureDesc_t
              USBXCORE_extendedCompatIdOsFeatureDesc;
extern const USB_ExtendedPropertiesDescriptor_t USBXCORE_extendedPropertiesDesc;
extern const uint8_t USBXCORE_buffMult[];

#ifdef __cplusplus
}
#endif

#endif // EM_USBXPRESS_DESCRIPTORS_H