CP210xRuntimeDLL.h

#ifndef HOST_LIB_RUNTIME_INCLUDE_CP210XRUNTIMEDLL_H_INCLUDED_QU4N7WC20W
#define HOST_LIB_RUNTIME_INCLUDE_CP210XRUNTIMEDLL_H_INCLUDED_QU4N7WC20W


#include    <stdint.h>  // For C99 fixed sized types
#include    <stdbool.h> // For C99 _Bool

#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 CP210xRUNTIMEDLL_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
// CP210xRUNTIMEDLL_API functions as being imported from a DLL, wheras this DLL sees symbols
// defined with this macro as being exported.
#ifdef CP210xRUNTIMEDLL_EXPORTS
#define CP210xRUNTIMEDLL_API
#else
#if defined(SILABS_STATIC_LINK)
#define CP210xRUNTIMEDLL_API extern
#pragma comment (lib, "CP210xRuntime.static.lib")
#else // defined(SILABS_STATIC_LINK)
#define CP210xRUNTIMEDLL_API __declspec(dllimport)
#pragma comment (lib, "CP210xRuntime.lib")
#endif // defined(SILABS_STATIC_LINK)
#endif
#else // !_WIN32
#define CP210xDLL_API 
#define WINAPI 
#define CP210xRUNTIMEDLL_API 
#endif // !_WIN32


#define     CP210x_CP2101_VERSION               CP210x_PARTNUM_CP2101   
#define     CP210x_CP2102_VERSION               CP210x_PARTNUM_CP2102   
#define     CP210x_CP2103_VERSION               CP210x_PARTNUM_CP2103   
#define     CP210x_CP2104_VERSION               CP210x_PARTNUM_CP2104   
#define     CP210x_CP2105_VERSION               CP210x_PARTNUM_CP2105   
#define     CP210x_CP2108_VERSION               CP210x_PARTNUM_CP2108   
#define     CP210x_CP2109_VERSION               CP210x_PARTNUM_CP2109   
#define     CP210x_CP2102N_QFN28_VERSION        CP210x_PARTNUM_CP2102N_QFN28    
#define     CP210x_CP2102N_QFN24_VERSION        CP210x_PARTNUM_CP2102N_QFN24    
#define     CP210x_CP2102N_QFN20_VERSION        CP210x_PARTNUM_CP2102N_QFN20    


#if defined(NOT_YET)
typedef enum _CP210x_STATUS {
    CP210x_SUCCESS = SILABS_STATUS_SUCCESS  
    , CP210x_INVALID_HANDLE = 0x01          
    , CP210x_INVALID_PARAMETER = 0x02           
    , CP210x_DEVICE_IO_FAILED = 0x03    
    , CP210x_FUNCTION_NOT_SUPPORTED = 0x04          
    , CP210x_GLOBAL_DATA_ERROR = 0x05   
    , CP210x_FILE_ERROR = 0x06  
    , CP210x_COMMAND_FAILED = 0x08  
    , CP210x_INVALID_ACCESS_TYPE = 0x09 

    , CP210x_DEVICE_NOT_FOUND = 0xFF            
} CP210x_STATUS, *PCP210x_STATUS;
#else // defined(NOT_YET)
#define CP210x_SUCCESS SILABS_STATUS_SUCCESS    
#define CP210x_INVALID_HANDLE 0x01              
#define CP210x_INVALID_PARAMETER 0x02           
#define CP210x_DEVICE_IO_FAILED 0x03            
#define CP210x_FUNCTION_NOT_SUPPORTED 0x04      
#define CP210x_GLOBAL_DATA_ERROR 0x05           
#define CP210x_FILE_ERROR 0x06                  
#define CP210x_COMMAND_FAILED 0x08              
#define CP210x_INVALID_ACCESS_TYPE 0x09         
#define CP210x_DEVICE_NOT_FOUND 0xFF            
typedef     int     CP210x_STATUS;  
#endif // defined(NOT_YET)

// Buffer size limits TODO: Enstone: cut'n'paste dups of CP210xManufacturingDLL.h's defines of same name
#define     CP210x_MAX_PRODUCT_STRLEN           126 
#define     CP210x_MAX_SERIAL_STRLEN_S          126 
#define     CP210x_MAX_SETUP_STRING_SIZE      246   
// Type definitions
typedef     char    CP210x_PRODUCT_STRING[CP210x_MAX_PRODUCT_STRLEN]; 
typedef     char    CP210x_SERIAL_STRING_S[CP210x_MAX_SERIAL_STRLEN_S];

#define     CP210x_GPIO_0                       0x0001  
#define     CP210x_GPIO_1                       0x0002  
#define     CP210x_GPIO_2                       0x0004  
#define     CP210x_GPIO_3                       0x0008  
#define     CP210x_GPIO_4                       0x0010  
#define     CP210x_GPIO_5                       0x0020  
#define     CP210x_GPIO_6                       0x0040  
#define     CP210x_GPIO_7                       0x0080  
#define     CP210x_GPIO_8                       0x0100  
#define     CP210x_GPIO_9                       0x0200  
#define     CP210x_GPIO_10                      0x0400  
#define     CP210x_GPIO_11                      0x0800  
#define     CP210x_GPIO_12                      0x1000  
#define     CP210x_GPIO_13                      0x2000  
#define     CP210x_GPIO_14                      0x4000  
#define     CP210x_GPIO_15                      0x8000  

#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
_Check_return_
_Ret_range_(CP210x_SUCCESS, CP210x_DEVICE_NOT_FOUND)
_Success_(return == CP210x_SUCCESS)
CP210xRUNTIMEDLL_API CP210x_STATUS WINAPI
CP210xRT_GetNumDevices(
        _Out_writes_bytes_(sizeof(uint32_t)) _Pre_defensive_ uint32_t *lpdwNumDevices
    );

_Check_return_
_Ret_range_(CP210x_SUCCESS, CP210x_DEVICE_NOT_FOUND)
_Success_(return == CP210x_SUCCESS)
CP210xRUNTIMEDLL_API CP210x_STATUS WINAPI
CP210xRT_Open(
    _In_ _Pre_defensive_ const uint32_t DeviceIndex,
    _Out_writes_bytes_(sizeof(HANDLE)) _Pre_defensive_ PHANDLE pcyHandle
);

_Ret_range_(CP210x_SUCCESS, CP210x_DEVICE_NOT_FOUND)
_Success_(return == CP210x_SUCCESS)
CP210xRUNTIMEDLL_API CP210x_STATUS WINAPI
CP210xRT_Close(
    _In_ _Pre_defensive_ const HANDLE cyHandle
);

_Check_return_
_Ret_range_(CP210x_SUCCESS, CP210x_DEVICE_NOT_FOUND)
_Success_(return == CP210x_SUCCESS)
CP210xRUNTIMEDLL_API CP210x_STATUS WINAPI
CP210xRT_ReadLatch(_In_ _Pre_defensive_ const HANDLE cyHandle,
                   _Out_writes_bytes_(sizeof(WORD)) _Pre_defensive_ LPWORD lpwLatch);

_Check_return_
_Ret_range_(CP210x_SUCCESS, CP210x_DEVICE_NOT_FOUND)
_Success_(return == CP210x_SUCCESS)
CP210xRUNTIMEDLL_API CP210x_STATUS WINAPI
CP210xRT_WriteLatch(_In_ _Pre_defensive_ const HANDLE cyHandle,
                    _In_ _Pre_defensive_ const WORD mask,
                    _In_ _Pre_defensive_ const WORD latch);

_Check_return_
_Ret_range_(CP210x_SUCCESS, CP210x_DEVICE_NOT_FOUND)
_Success_(return == CP210x_SUCCESS)
CP210xRUNTIMEDLL_API CP210x_STATUS WINAPI
CP210xRT_GetPartNumber(_In_ _Pre_defensive_ const HANDLE cyHandle,
                       _Out_writes_bytes_(1) _Pre_defensive_ LPBYTE lpbPartNum);

_Check_return_
_Ret_range_(CP210x_SUCCESS, CP210x_DEVICE_NOT_FOUND)
_Success_(return == CP210x_SUCCESS)
CP210xRUNTIMEDLL_API CP210x_STATUS WINAPI
CP210xRT_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_(CP210x_SUCCESS, CP210x_DEVICE_NOT_FOUND)
_Success_(return == CP210x_SUCCESS)
CP210xRUNTIMEDLL_API CP210x_STATUS WINAPI
CP210xRT_GetDeviceSerialNumber(_In_ _Pre_defensive_ const HANDLE cyHandle,
                               _Out_writes_bytes_(*lpbSerialNumberStringLengthInBytes) _Pre_defensive_ LPVOID lpSerialNumberString,
                               _Out_writes_bytes_(1) _Pre_defensive_ LPBYTE lpbSerialNumberStringLengthInBytes,
                               _In_ _Pre_defensive_ const BOOL bConvertToASCII = TRUE
                               );

_Check_return_
_Ret_range_(CP210x_SUCCESS, CP210x_DEVICE_NOT_FOUND)
_Success_(return == CP210x_SUCCESS)
CP210xRUNTIMEDLL_API CP210x_STATUS WINAPI
CP210xRT_GetDeviceInterfaceString(_In_ _Pre_defensive_ const HANDLE cyHandle,
                                  _Out_writes_bytes_(*lpbInterfaceStringLengthInBytes) _Pre_defensive_ LPVOID lpInterfaceString,
                                  _Out_writes_bytes_(1) _Pre_defensive_ LPBYTE lpbInterfaceStringLengthInBytes,
                                  _In_ _Pre_defensive_ const BOOL bConvertToASCII);


_Check_return_
_Ret_range_(CP210x_SUCCESS, CP210x_DEVICE_NOT_FOUND)
_Success_(return == CP210x_SUCCESS)
CP210xRUNTIMEDLL_API CP210x_STATUS WINAPI
CP210xRT_GetReceiverMaxTimeout(_In_ _Pre_defensive_ const HANDLE cyHandle,
    _Out_writes_bytes_(2) _Pre_defensive_ uint16_t *pReceiverMaxTimeoutInMicroseconds);


_Check_return_
_Ret_range_(CP210x_SUCCESS, CP210x_DEVICE_NOT_FOUND)
_Success_(return == CP210x_SUCCESS)
CP210xRUNTIMEDLL_API CP210x_STATUS WINAPI
CP210xRT_SetReceiverMaxTimeout(_In_ _Pre_defensive_ const HANDLE cyHandle,
    _In_ _Pre_defensive_ const uint16_t ReceiverMaxTimeoutInMicroseconds);

#ifdef __cplusplus
}
#endif // __cplusplus


#endif  // !HOST_LIB_RUNTIME_INCLUDE_CP210XRUNTIMEDLL_H_INCLUDED_QU4N7WC20W