em_usbxpress.h

Go to the documentation of this file.

/***************************************************************************/
/**************************************************************************/
#ifndef  EM_USBXPRESS_H
#define  EM_USBXPRESS_H

#include <stdint.h>
#include <stdbool.h>

#include "em_common.h"

#ifdef __cplusplus
extern "C" {
#endif

/**************************************************************************/
typedef void (*USBX_apiCallback_t)(void);


/***************************************************************************/
// Basic USBX_getCallbackSource() return value bit masks (32 bits)
// Note: More than one bit can be set at the same time.
#define USBX_RESET               0x00000001     
#define USBX_TX_COMPLETE         0x00000002     
#define USBX_RX_COMPLETE         0x00000004     
#define USBX_FIFO_PURGE          0x00000008     
#define USBX_DEV_OPEN            0x00000010     
#define USBX_DEV_CLOSE           0x00000020     
#define USBX_DEV_CONFIGURED      0x00000040     
#define USBX_DEV_SUSPEND         0x00000080     
#define USBX_RX_OVERRUN          0x00000100     

/***************************************************************************/
#define USBX_STATUS_OK                  USB_STATUS_OK                   
#define USBX_STATUS_EP_BUSY             USB_STATUS_EP_BUSY              
#define USBX_STATUS_ILLEGAL             USB_STATUS_ILLEGAL              
#define USBX_STATUS_EP_STALLED          USB_STATUS_EP_STALLED           
#define USBX_STATUS_DEVICE_UNCONFIGURED USB_STATUS_DEVICE_UNCONFIGURED  

#ifdef char16_t
#undef char16_t
#endif
#if defined(__GNUC__)                     /* GCC compilers */
#if defined(__CHAR16_TYPE__)
typedef __CHAR16_TYPE__ char16_t;
#else
typedef unsigned short char16_t;          
#endif

#elif defined(__ICCARM__)                 /* IAR compiler */
#include <uchar.h>

#elif defined(__CC_ARM)                   /* MDK-ARM compiler */
typedef unsigned short char16_t;
#endif

/***************************************************************************/
/***************************************************************************/
#define USBX_STRING_DESC(_name, ...)                            \
SL_PACK_START(1)                                                \
typedef struct                                                  \
{                                                               \
  uint8_t  len;                                                 \
  uint8_t  type;                                                \
  char16_t name[ 1 + sizeof((char16_t[]){__VA_ARGS__}) / 2];    \
} SL_ATTRIBUTE_PACKED _##_name;                                 \
SL_PACK_END()                                                   \
SL_ALIGN(4)                                                     \
SL_PACK_START(1)                                                \
static const _##_name _name SL_ATTRIBUTE_ALIGN(4)=              \
{                                                               \
  .len  = sizeof(_##_name) - 2,                                 \
  .type = 3,                                                    \
  .name = {__VA_ARGS__},                                        \
  .name[((sizeof(_##_name) - 2) / 2) - 1] = '\0'                \
}                                                               \
SL_PACK_END()

/***************************************************************************/
#define USBX_BUF(x, y) \
  SL_ALIGN(4) uint8_t x[((y)+3)&~3] SL_ATTRIBUTE_ALIGN(4)

/***************************************************************************/
#define STATIC_USBX_BUF(x, y) SL_ALIGN(4) \
  static uint8_t x[((y)+3)&~3] SL_ATTRIBUTE_ALIGN(4)

/***************************************************************************/
SL_PACK_START(1)
typedef struct
{
   uint16_t vendorId;            
   uint16_t productId;           
   void const* manufacturerString; 
   void const* productString;    
   void const* serialString;     
   uint8_t maxPower;             
   uint8_t powerAttribute;       
   uint16_t releaseBcd;          
   uint8_t useFifo;              
} SL_ATTRIBUTE_PACKED USBX_Init_t;
SL_PACK_END()


/***************************************************************************/
void USBX_init(USBX_Init_t* p);

/**************************************************************************/
int USBX_blockWrite(uint8_t* block,
                    uint32_t numBytes,
                    uint32_t* countPtr);

/**************************************************************************/
int USBX_blockRead(uint8_t* block,
                   uint32_t numBytes,
                   uint32_t* countPtr);

/**************************************************************************/
uint32_t USBX_getCallbackSource(void);

/**************************************************************************/
void USBX_apiCallbackEnable(USBX_apiCallback_t f);

/**************************************************************************/
void USBX_apiCallbackDisable(void);

/**************************************************************************/
void USBX_disable(void);

/**************************************************************************/
uint_least16_t USBX_getLibraryVersion(void);


#ifdef __cplusplus
}
#endif

#endif  // EM_USBXPRESS_H