SiUSBXp.h

#ifndef HOST_LIB_SIUSBXP_INCLUDE_SIUSBXP_H_INCLUDED_9QM3BKN3FX
#define HOST_LIB_SIUSBXP_INCLUDE_SIUSBXP_H_INCLUDED_9QM3BKN3FX


#include    "silabs_defs.h"
#include    "silabs_sal.h"


#ifdef _WIN32
// The following ifdef block is the standard way of creating macros which make exporting 
// from a DLL simpler. All files within this DLL are compiled with the SI_USB_XP_EXPORTS
// symbol defined on the command line. this symbol should not be defined on any project
// that uses this DLL. This way any other project whose source files include this file see 
// SI_USB_XP_API functions as being imported from a DLL, wheras this DLL sees symbols
// defined with this macro as being exported.
#ifdef SI_USB_XP_EXPORTS
#define SI_USB_XP_API
#else
#define SI_USB_XP_API __declspec(dllimport)
#pragma comment (lib, "SiUSBXp.lib")
#endif
#else // !_WIN32
#define __declspec(n) 
#define SI_USB_XP_API 
#define WINAPI 
#endif // !_WIN32

typedef enum _SI_STATUS {
    SI_SUCCESS = SILABS_STATUS_SUCCESS  
    , SI_INVALID_HANDLE = 0x01          
    , SI_READ_ERROR = 0x02              
    , SI_RX_QUEUE_NOT_READY = 0x03      
    , SI_WRITE_ERROR = 0x04             
    , SI_RESET_ERROR = 0x05             
    , SI_INVALID_PARAMETER = 0x06       
    , SI_INVALID_REQUEST_LENGTH = 0x07  
    , SI_DEVICE_IO_FAILED = 0x08        
    , SI_INVALID_BAUDRATE = 0x09        
    , SI_FUNCTION_NOT_SUPPORTED = 0x0A  
    , SI_GLOBAL_DATA_ERROR = 0x0B       
    , SI_SYSTEM_ERROR_CODE = 0x0C       
    , SI_READ_TIMED_OUT = 0x0D          
    , SI_WRITE_TIMED_OUT = 0x0E         
    , SI_IO_PENDING = 0x0F              
    , SI_NOTHING_TO_CANCEL = 0xA0       
    , SI_DEVICE_NOT_FOUND = 0xFF        
} SI_STATUS, *PSI_STATUS;
#define     SI_RETURN_SERIAL_NUMBER     0x00    
#define     SI_RETURN_DESCRIPTION       0x01    
#define     SI_RETURN_LINK_NAME         0x02    
#define     SI_RETURN_VID               0x03    
#define     SI_RETURN_PID               0x04    

#define     SI_RX_NO_OVERRUN            0x00    
#define     SI_RX_EMPTY                 0x00    
#define     SI_RX_OVERRUN               0x01    
#define     SI_RX_READY                 0x02    

#define     SI_MAX_DEVICE_STRLEN        256         
#define     SI_MAX_READ_SIZE            4096*16     
#define     SI_MAX_WRITE_SIZE           4096        

typedef     char    SI_DEVICE_STRING[SI_MAX_DEVICE_STRLEN];

#define     SI_HELD_INACTIVE            0x00    
#define     SI_HELD_ACTIVE              0x01    
#define     SI_FIRMWARE_CONTROLLED      0x02    
#define     SI_RECEIVE_FLOW_CONTROL     0x02    
#define     SI_TRANSMIT_ACTIVE_SIGNAL   0x03    
#define     SI_STATUS_INPUT             0x00    
#define     SI_HANDSHAKE_LINE           0x01    

#define     SI_GPIO_0                   (1<<0)  
#define     SI_GPIO_1                   (1<<1)  
#define     SI_GPIO_2                   (1<<2)  
#define     SI_GPIO_3                   0x0008  
#define     SI_GPIO_4                   0x0010  
#define     SI_GPIO_5                   0x0020  
#define     SI_GPIO_6                   0x0040  
#define     SI_GPIO_7                   0x0080  
#define     SI_GPIO_8                   0x0100  
#define     SI_GPIO_9                   0x0200  
#define     SI_GPIO_10                  0x0400  
#define     SI_GPIO_11                  0x0800  
#define     SI_GPIO_12                  0x1000  
#define     SI_GPIO_13                  0x2000  
#define     SI_GPIO_14                  0x4000  
#define     SI_GPIO_15                  0x8000  

#define     SI_USBXPRESS_EFM8           CP210x_PARTNUM_USBXPRESS_EFM8   
#define     SI_USBXPRESS_EFM32          CP210x_PARTNUM_USBXPRESS_EFM32  
#define     SI_CP2101_VERSION           CP210x_PARTNUM_CP2101   
#define     SI_CP2102_VERSION           CP210x_PARTNUM_CP2102   
#define     SI_CP2103_VERSION           CP210x_PARTNUM_CP2103   
#define     SI_CP2104_VERSION           CP210x_PARTNUM_CP2104   
#define     SI_CP2105_VERSION           CP210x_PARTNUM_CP2105   
#define     SI_CP2108_VERSION           CP210x_PARTNUM_CP2108   
#define     SI_CP2109_VERSION           CP210x_PARTNUM_CP2109   
#define     SI_CP2102N_QFN28_VERSION        CP210x_PARTNUM_CP2102N_QFN28    
#define     SI_CP2102N_QFN24_VERSION        CP210x_PARTNUM_CP2102N_QFN24    
#define     SI_CP2102N_QFN20_VERSION        CP210x_PARTNUM_CP2102N_QFN20    

//
#pragma pack(push, 1)
typedef _Struct_size_bytes_(19) struct _COMM_STATUS {
    ULONG   ulErrors;
    ULONG   ulHoldReasons;
    ULONG   ulAmountInInQueue;
    ULONG   ulAmountInOutQueue;
    UCHAR   bEofReceived;
    UCHAR   bWaitForImmediate;
    UCHAR   bReserved;
} COMM_STATUS, *PCOMM_STATUS;
#pragma pack(pop)
#ifdef __cplusplus
extern "C" {
#endif

_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_GetNumDevices(
    _Out_writes_bytes_(sizeof(DWORD)) _Pre_defensive_ LPDWORD lpdwNumDevices
    );

//__declspec(deprecated)
_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_GetProductString(
    _In_ _Pre_defensive_ const DWORD dwDeviceIndex,
    _Out_writes_bytes_(CP210x_MAX_DEVICE_STRLEN) _Pre_defensive_ LPVOID lpvDeviceString,
    _In_ _Pre_defensive_ const DWORD dwFlags
    );

_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_GetProductStringSafe(
    _In_ _Pre_defensive_ const DWORD dwDeviceIndex,
    _Out_writes_bytes_(DeviceStringLenInBytes) LPVOID lpvDeviceString,
    _In_ _Pre_defensive_ const size_t DeviceStringLenInBytes,
    _In_ _Pre_defensive_ const DWORD dwFlags
    );


_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_Open(
    _In_ _Pre_defensive_ const DWORD DeviceIndex,
    _Out_writes_bytes_(sizeof(HANDLE)) _Pre_defensive_ PHANDLE pcyHandle
    ); 

_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_Close(
    _In_ _Pre_defensive_ const HANDLE cyHandle
    );

_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_Read(
    _In_ _Pre_defensive_ const HANDLE cyHandle,
    _Out_writes_bytes_(dwBytesToRead) LPVOID lpBuffer,
    _In_range_(0, SI_MAX_READ_SIZE) const DWORD dwBytesToRead, 
    _Out_range_(0,dwBytesToRead) LPDWORD lpdwBytesReturned,
    _In_opt_ LPOVERLAPPED lpOverlapped = NULL
    );

_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_Write(
    _In_ _Pre_defensive_ const HANDLE cyHandle,
    _In_reads_bytes_(dwBytesToWrite) _Pre_defensive_ LPVOID lpBuffer,
    _In_range_(0, SI_MAX_WRITE_SIZE) _Pre_defensive_ const DWORD dwBytesToWrite,
    _Out_range_(0, dwBytesToWrite) _Pre_defensive_ LPDWORD lpdwBytesWritten,
    _In_opt_ LPOVERLAPPED lpOverlapped = NULL
    );

_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(return == SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_DeviceIOControl(
    _In_ _Pre_defensive_ const HANDLE cyHandle,
    _In_ _Pre_defensive_ const DWORD dwIoControlCode,
    LPVOID lpInBuffer,
    _In_ _Pre_defensive_ const DWORD dwBytesToRead,
    LPVOID lpOutBuffer,
    _In_ _Pre_defensive_ const DWORD dwBytesToWrite,
    LPDWORD lpdwBytesSucceeded
    );

_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_FlushBuffers(
    _In_ _Pre_defensive_ const HANDLE cyHandle,
    _In_ _Pre_defensive_ const BYTE FlushTransmit,
    _In_ _Pre_defensive_ const BYTE FlushReceive
    );

_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_SetTimeouts(
    _In_ _Pre_defensive_ const DWORD dwReadTimeoutInMilliseconds,
    _In_ _Pre_defensive_ const DWORD dwWriteTimeoutInMilliseconds
    );

_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_GetTimeouts(
    _Out_writes_bytes_(sizeof(DWORD)) _Pre_defensive_ LPDWORD lpdwReadTimeout,
    _Out_writes_bytes_(sizeof(DWORD)) _Pre_defensive_ LPDWORD lpdwWriteTimeout
    );

_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_CheckRXQueue(
    _In_ _Pre_defensive_ const HANDLE cyHandle,
    _Out_writes_bytes_(sizeof(DWORD)) _Pre_defensive_ LPDWORD lpdwNumBytesInQueue,
    _Out_writes_bytes_(sizeof(DWORD)) _Pre_defensive_ LPDWORD lpdwQueueStatus
    );

_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_SetBaudRate(
    _In_ _Pre_defensive_ const HANDLE cyHandle,
    _In_ _Pre_defensive_ const DWORD dwBaudRate
    );

_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(return == SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_SetBaudDivisor(
    _In_ _Pre_defensive_ const HANDLE cyHandle,
    _In_ _Pre_defensive_ const WORD wBaudDivisor
    );

_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(return == SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_SetLineControl(
    _In_ _Pre_defensive_ const HANDLE cyHandle,
    _In_ _Pre_defensive_ const WORD wLineControl
    );

_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(return == SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_SetFlowControl(
    _In_ _Pre_defensive_ const HANDLE cyHandle,
    _In_ _Pre_defensive_ const BYTE bCTS_MaskCode,
    _In_ _Pre_defensive_ const BYTE bRTS_MaskCode,
    _In_ _Pre_defensive_ const BYTE bDTR_MaskCode,
    _In_ _Pre_defensive_ const BYTE bDSR_MaskCode,
    _In_ _Pre_defensive_ const BYTE bDCD_MaskCode,
    _In_ _Pre_defensive_ const BOOL bFlowXonXoff
    );

_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(return == SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_GetModemStatus(
    _In_ _Pre_defensive_ const HANDLE cyHandle,
    _Out_writes_bytes_(sizeof(BYTE)) _Pre_defensive_ PBYTE pModemStatus
    );

_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(return == SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_GetCommStatus(
    _In_ _Pre_defensive_ const HANDLE cyHandle,
    _Out_writes_bytes_(sizeof(COMM_STATUS)) _Pre_defensive_ PCOMM_STATUS pCommStatus
);

_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(return == SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_SetBreak(
    _In_ _Pre_defensive_ const HANDLE cyHandle,
    _In_ _Pre_defensive_ const WORD wBreakState
    );

_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(return == SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_ReadLatch(
    _In_ _Pre_defensive_ const HANDLE cyHandle,
    _Out_writes_bytes_(sizeof(WORD)) _Pre_defensive_ LPWORD lpwLatch
    );

_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(return == SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_WriteLatch(
    _In_ _Pre_defensive_ const HANDLE cyHandle,
    _In_ _Pre_defensive_ const WORD mask,
    _In_ _Pre_defensive_ const WORD latch
    );


_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(return == SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_GetPartNumber(
    _In_ _Pre_defensive_ const HANDLE cyHandle,
    _Out_writes_bytes_(sizeof(BYTE)) _Pre_defensive_  LPBYTE lpbPartNum
    );

_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(return == SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_GetPartLibraryVersion(
    _In_ _Pre_defensive_ const HANDLE cyHandle,
    _Out_writes_bytes_(2 * sizeof(BYTE)) _Pre_defensive_ BYTE pLibraryVersion[2]
    );

_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(return == SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_GetInterfaceNumber(
    _In_ _Pre_defensive_ const HANDLE cyHandle,
    _Out_writes_bytes_(sizeof(BYTE)) _Pre_defensive_ LPBYTE lpbInterfaceNum
    );

_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(return == SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_GetDeviceProductString(
    _In_ _Pre_defensive_ const HANDLE cyHandle,
    _Out_writes_bytes_(*lpbProductStringLengthInBytes) _Pre_defensive_ LPVOID lpProductString,
    _Out_writes_bytes_(1) _Pre_defensive_ LPBYTE lpbProductStringLengthInBytes,
    _In_ _Pre_defensive_ const BOOL bConvertToASCII = TRUE
    );

_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(return == SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_GetDLLVersion(
    _Out_writes_bytes_(sizeof(DWORD)) _Pre_defensive_ DWORD* HighVersion,
    _Out_writes_bytes_(sizeof(DWORD)) _Pre_defensive_ DWORD* LowVersion
    );

_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(return == SI_SUCCESS)
__declspec(deprecated)
SI_USB_XP_API SI_STATUS WINAPI
SI_GetDriverVersion(
    _Out_writes_bytes_(sizeof(DWORD)) _Pre_defensive_ DWORD* HighVersion,
    _Out_writes_bytes_(sizeof(DWORD)) _Pre_defensive_ DWORD* LowVersion
    );

_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(return == SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_CancelIo(
    _In_ _Pre_defensive_ const HANDLE cyHandle
    );

_Check_return_
_Ret_range_(SI_SUCCESS, SI_DEVICE_NOT_FOUND)
_Success_(return == SI_SUCCESS)
SI_USB_XP_API SI_STATUS WINAPI
SI_CancelIoEx(
    _In_ _Pre_defensive_ const HANDLE cyHandle,
    LPOVERLAPPED lpOverlapped
    );

#ifdef __cplusplus
}
#endif


#endif //HOST_LIB_SIUSBXP_INCLUDE_SIUSBXP_H_INCLUDED_9QM3BKN3FX