slabiop.h

//-----------------------------------------------------------------------------
// slabiop.h
//-----------------------------------------------------------------------------
// Copyright 2017 Silicon Laboratories Inc.
// http://www.silabs.com
//-----------------------------------------------------------------------------


#if (_MSC_VER > 1000)
#pragma once
#endif

#ifndef HOST_LIB_SLABIOP_INCLUDE_SLABIOP_H_INCLUDED_PV1HTEYUPA
#define HOST_LIB_SLABIOP_INCLUDE_SLABIOP_H_INCLUDED_PV1HTEYUPA


#include    <stddef.h>
#include    <stdlib.h>
#include    <string.h>
#include    <stdio.h>
#include    <stdint.h>  // For C99 fixed sized types
#include    <stdbool.h> // For C99 _Bool

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

#ifdef _WIN32
#if defined(SLABIOPLIB_EXPORTS)
#define SLABIOPLIB_API
#else
#if defined(SILABS_STATIC_LINK_ALL_LIBS)
#define SLABIOPLIB_API
#pragma comment (lib, "slabiop.static.lib")
#else // defined(SILABS_STATIC_LINK_ALL_LIBS)
#define SLABIOPLIB_API     __declspec(dllimport)
#pragma comment (lib, "slabiop.lib")
#endif // defined(SILABS_STATIC_LINK_ALL_LIBS)
#endif // defined(SLABIOPLIB_EXPORTS)
#else // !_WIN32
#define SLABIOPLIB_API 
#define WINAPI 
#endif // !_WIN32

typedef enum _SILABS_IOP_INTERFACE_ALTERNATE_SETTINGS {
    SILABS_IOP_INTERFACE_ALTERNATE_SETTINGS_IDLE = ((uint8_t)(0xFF & 0x00))         
    , SILABS_IOP_INTERFACE_ALTERNATE_SETTINGS_UART = ((uint8_t)(0xFF & 0x01))       
    , SILABS_IOP_INTERFACE_ALTERNATE_SETTINGS_IOP = ((uint8_t)(0xFF & 0x02))        
    , SILABS_IOP_INTERFACE_ALTERNATE_SETTINGS_UNKNOWN = ((uint8_t)(0xFF & 0xFF))    
} SILABS_IOP_INTERFACE_ALTERNATE_SETTINGS;
_Check_return_
_Success_(return == TRUE)
__inline static BOOL IsValidSILABS_IOP_INTERFACE_ALTERNATE_SETTINGS(_In_ const SILABS_IOP_INTERFACE_ALTERNATE_SETTINGS _a) { return (SILABS_IOP_INTERFACE_ALTERNATE_SETTINGS_IDLE <= _a) && (_a <= SILABS_IOP_INTERFACE_ALTERNATE_SETTINGS_IOP); }
typedef enum _DEVICE_I2C_STATUS {
    DEVICE_I2C_STATUS_SUCCESS = (0)                
    , DEVICE_I2C_STATUS_BUS_ERROR = (0xFF)         
    , DEVICE_I2C_STATUS_BUS_BUSY = (0xFE)          
    , DEVICE_I2C_STATUS_TIMEOUT = (0xFD)           
    , DEVICE_I2C_STATUS_INVALID_PARAMETER = (0xFC) 
    , DEVICE_I2C_STATUS_CFG_LOCKED = (0xFA)        
} DEVICE_I2C_STATUS;

// Structures

#pragma pack(1)
typedef _Struct_size_bytes_(6) struct _SILABS_IOP_ACCESSORY_INFO {
    uint16_t PartID;            
    uint16_t OptionID;          
    uint16_t ProtocolVersion;   
} SILABS_IOP_ACCESSORY_INFO;
#pragma pack()

#pragma pack(1)
typedef _Struct_size_bytes_(7) struct _SILABS_IOP_PORT_CONFIGURATION {
    uint8_t PortNumber;     
    uint16_t PinFunction;       
    uint16_t PinDirection;      
    uint16_t PinOutMode;        
} SILABS_IOP_PORT_CONFIGURATION;
#pragma pack()

#pragma pack(1)
typedef _Struct_size_bytes_(5) struct _SILABS_IOP_DIGITAL_PORT_VALUE {
    uint8_t PortNumber;     
    uint16_t PinMask;           
    uint16_t PortValue;         
} SILABS_IOP_DIGITAL_PORT_VALUE;
#pragma pack()

#pragma pack(1)
typedef _Struct_size_bytes_(7) struct _SILABS_IOP_ANALOG_PIN_VALUE {
    uint8_t PinNumber;      
    uint16_t PinValue;          
    uint32_t TimeStamp;     
} SILABS_IOP_ANALOG_PIN_VALUE;
#pragma pack()

#pragma pack(1)
typedef _Struct_size_bytes_(1) struct _SILABS_IOP_SERIAL_STATE {
    uint8_t ReceiveError;           
} SILABS_IOP_SERIAL_STATE;
#pragma pack()


// Exported API Functions


#ifdef __cplusplus
extern "C" {
#endif // __cplusplus

_Check_return_
_Ret_range_(SILABS_STATUS_SUCCESS, SILABS_STATUS_UNKNOWN_ERROR)
_Success_(return == SILABS_STATUS_SUCCESS)
SLABIOPLIB_API SILABS_STATUS WINAPI
IOP_GetLibraryVersion(
    _Out_writes_bytes_opt_(sizeof(uint8_t)) _Pre_defensive_ uint8_t* major,
    _Out_writes_bytes_opt_(sizeof(uint8_t)) _Pre_defensive_ uint8_t* minor,
    _Out_writes_bytes_opt_(sizeof(BOOL)) _Pre_defensive_ BOOL* pbIsReleaseBuild
);


_Check_return_
_Ret_range_(SILABS_STATUS_SUCCESS, SILABS_STATUS_UNKNOWN_ERROR)
_Success_(return == SILABS_STATUS_SUCCESS)
SLABIOPLIB_API SILABS_STATUS WINAPI
IOP_GetNumDevices(
    _In_ _Pre_defensive_ const uint16_t Vid,
    _In_ _Pre_defensive_ const uint16_t Pid,
    _Out_writes_bytes_(sizeof(uint32_t)) _Pre_defensive_ uint32_t *pNumDevices
);

_Check_return_
_Ret_range_(SILABS_STATUS_SUCCESS, SILABS_STATUS_UNKNOWN_ERROR)
_Success_(return == SILABS_STATUS_SUCCESS)
SLABIOPLIB_API SILABS_STATUS WINAPI
IOP_GetDevicePathString(
    _In_ _Pre_defensive_ const uint32_t DeviceIndex,
    _Out_writes_bytes_(*pLenInBytes) char *pDevicePathString,
    _In_ _Pre_defensive_ const size_t DevicePathStringLenInBytes,
    _Out_writes_bytes_(sizeof(size_t)) _Pre_defensive_ size_t *pLenInBytes
);

_Check_return_
_Ret_range_(SILABS_STATUS_SUCCESS, SILABS_STATUS_UNKNOWN_ERROR)
_Success_(return == SILABS_STATUS_SUCCESS)
SLABIOPLIB_API SILABS_STATUS WINAPI
IOP_GetVIDPIDFromDevicePath(
    _In_ _Pre_defensive_ const uint32_t DeviceIndex,
    _Out_writes_bytes_(sizeof(uint16_t)) _Pre_defensive_ uint16_t *pVid,
    _Out_writes_bytes_(sizeof(uint16_t)) _Pre_defensive_ uint16_t *pPid
);

_Check_return_
_Ret_range_(SILABS_STATUS_SUCCESS, SILABS_STATUS_UNKNOWN_ERROR)
_Success_(return == SILABS_STATUS_SUCCESS)
SLABIOPLIB_API SILABS_STATUS WINAPI
IOP_GetSerialNumberStringFromDevicePath(
    _In_ _Pre_defensive_ const uint32_t DeviceIndex,
    _Out_writes_bytes_(*pLenInBytes) char *pSerialNumberString,
    _In_ _Pre_defensive_ const size_t SerialNumberStringLenInBytes,
    _Out_writes_bytes_(sizeof(size_t)) _Pre_defensive_ size_t *pLenInBytes
);


_Check_return_
_Ret_range_(SILABS_STATUS_SUCCESS, SILABS_STATUS_UNKNOWN_ERROR)
_Success_(SILABS_STATUS_SUCCESS)
SLABIOPLIB_API SILABS_STATUS WINAPI
IOP_Open(
    _In_ _Pre_defensive_ const uint32_t DeviceIndex,
    _Out_writes_bytes_(sizeof(HANDLE)) _Pre_defensive_ PHANDLE pHandle
);

_Check_return_
_Ret_range_(SILABS_STATUS_SUCCESS, SILABS_STATUS_UNKNOWN_ERROR)
_Success_(SILABS_STATUS_SUCCESS)
SLABIOPLIB_API SILABS_STATUS WINAPI
IOP_OpenByDevicePath(
    _In_ _Pre_defensive_ const char *pDevicePath,
    _Out_writes_bytes_(sizeof(HANDLE)) _Pre_defensive_ PHANDLE pHandle
);


_Ret_range_(SILABS_STATUS_SUCCESS, SILABS_STATUS_UNKNOWN_ERROR)
_Success_(SILABS_STATUS_SUCCESS)
SLABIOPLIB_API SILABS_STATUS WINAPI
IOP_Close(
    _In_ _Pre_defensive_ const HANDLE hHandle
);

_Check_return_
_Ret_range_(SILABS_STATUS_SUCCESS, SILABS_STATUS_UNKNOWN_ERROR)
_Success_(SILABS_STATUS_SUCCESS)
SLABIOPLIB_API SILABS_STATUS WINAPI
IOP_GetCurrentAlternateSetting(
    _In_ _Pre_defensive_ const HANDLE hHandle,
    _Out_writes_bytes_(sizeof(SILABS_IOP_INTERFACE_ALTERNATE_SETTINGS)) _Pre_defensive_ SILABS_IOP_INTERFACE_ALTERNATE_SETTINGS *pAlternateSettingNumber
);
_Check_return_
_Ret_range_(SILABS_STATUS_SUCCESS, SILABS_STATUS_UNKNOWN_ERROR)
_Success_(SILABS_STATUS_SUCCESS)
SLABIOPLIB_API SILABS_STATUS WINAPI
IOP_SetCurrentAlternateSetting(
    _In_ _Pre_defensive_ const HANDLE hHandle,
    _In_ _Pre_defensive_ const SILABS_IOP_INTERFACE_ALTERNATE_SETTINGS AlternateSettingNumber
);
_Check_return_
_Ret_range_(SILABS_STATUS_SUCCESS, SILABS_STATUS_UNKNOWN_ERROR)
_Success_(SILABS_STATUS_SUCCESS)
SLABIOPLIB_API SILABS_STATUS WINAPI
IOP_SetCurrentAlternateSettingIDLE(
    _In_ _Pre_defensive_ const HANDLE hHandle
);
_Check_return_
_Ret_range_(SILABS_STATUS_SUCCESS, SILABS_STATUS_UNKNOWN_ERROR)
_Success_(SILABS_STATUS_SUCCESS)
SLABIOPLIB_API SILABS_STATUS WINAPI
IOP_SetCurrentAlternateSettingUART(
    _In_ _Pre_defensive_ const HANDLE hHandle
);
_Check_return_
_Ret_range_(SILABS_STATUS_SUCCESS, SILABS_STATUS_UNKNOWN_ERROR)
_Success_(SILABS_STATUS_SUCCESS)
SLABIOPLIB_API SILABS_STATUS WINAPI
IOP_SetCurrentAlternateSettingIOP(
    _In_ _Pre_defensive_ const HANDLE hHandle
);


_Check_return_
_Ret_range_(SILABS_STATUS_SUCCESS, SILABS_STATUS_UNKNOWN_ERROR)
_Success_(SILABS_STATUS_SUCCESS)
SLABIOPLIB_API SILABS_STATUS WINAPI
IOP_Read(
    _In_ _Pre_defensive_ const HANDLE hHandle,
    _Out_writes_bytes_(BufferLenInBytes) uint8_t *pBuffer,
    _In_range_(0, 222) const size_t BufferLenInBytes,
    _Out_range_(0, BufferLenInBytes) size_t *pBytesRead,
    _In_opt_ LPOVERLAPPED o = NULL
);

_Check_return_
_Ret_range_(SILABS_STATUS_SUCCESS, SILABS_STATUS_UNKNOWN_ERROR)
_Success_(SILABS_STATUS_SUCCESS)
SLABIOPLIB_API SILABS_STATUS WINAPI
IOP_Write(
    _In_ _Pre_defensive_ const HANDLE hHandle,
    _In_reads_bytes_(BufferLenInBytes) _Pre_defensive_ uint8_t *pBuffer,
    _In_range_(0, 222) _Pre_defensive_ const size_t BufferLenInBytes,
    _Out_range_(0, BufferLenInBytes) _Pre_defensive_ size_t *pBytesWritten,
    _In_opt_ LPOVERLAPPED o = NULL
);



_Check_return_
_Ret_range_(SILABS_STATUS_SUCCESS, SILABS_STATUS_UNKNOWN_ERROR)
_Success_(SILABS_STATUS_SUCCESS)
SLABIOPLIB_API SILABS_STATUS WINAPI
IOP_GetAccessoryInfo(
    _In_ _Pre_defensive_ const HANDLE hHandle,
    _Out_writes_bytes_(sizeof(SILABS_IOP_ACCESSORY_INFO)) _Pre_defensive_ SILABS_IOP_ACCESSORY_INFO *pAccessoryInfo
);

_Check_return_
_Ret_range_(SILABS_STATUS_SUCCESS, SILABS_STATUS_UNKNOWN_ERROR)
_Success_(SILABS_STATUS_SUCCESS)
SLABIOPLIB_API SILABS_STATUS WINAPI
IOP_GetPortConfiguration(
    _In_ _Pre_defensive_ const HANDLE hHandle,
    _In_ _Pre_defensive_ const uint8_t PortNumber,
    _Out_writes_bytes_(sizeof(SILABS_IOP_PORT_CONFIGURATION)) _Pre_defensive_ SILABS_IOP_PORT_CONFIGURATION *pPortConfiguration
);

_Check_return_
_Ret_range_(SILABS_STATUS_SUCCESS, SILABS_STATUS_UNKNOWN_ERROR)
_Success_(SILABS_STATUS_SUCCESS)
SLABIOPLIB_API SILABS_STATUS WINAPI
IOP_GetDigitalPort(
    _In_ _Pre_defensive_ const HANDLE hHandle,
    _In_ _Pre_defensive_ const uint8_t PortNumber,
    _In_ _Pre_defensive_ const uint16_t PinMask,
    _Out_writes_bytes_(sizeof(SILABS_IOP_DIGITAL_PORT_VALUE)) _Pre_defensive_ SILABS_IOP_DIGITAL_PORT_VALUE *pDigitalPortValue
);
_Check_return_
_Ret_range_(SILABS_STATUS_SUCCESS, SILABS_STATUS_UNKNOWN_ERROR)
_Success_(SILABS_STATUS_SUCCESS)
SLABIOPLIB_API SILABS_STATUS WINAPI
IOP_SetDigitalPort(
    _In_ _Pre_defensive_ const HANDLE hHandle,
    _In_ _Pre_defensive_ const uint8_t PortNumber,
    _In_reads_bytes_(sizeof(SILABS_IOP_DIGITAL_PORT_VALUE)) _Pre_defensive_ SILABS_IOP_DIGITAL_PORT_VALUE *pDigitalPortValue
);

_Check_return_
_Ret_range_(SILABS_STATUS_SUCCESS, SILABS_STATUS_UNKNOWN_ERROR)
_Success_(SILABS_STATUS_SUCCESS)
SLABIOPLIB_API SILABS_STATUS WINAPI
IOP_GetAnalogPin(
    _In_ _Pre_defensive_ const HANDLE hHandle,
    _In_ _Pre_defensive_ const uint8_t PinNumber,
    _Out_writes_bytes_(sizeof(SILABS_IOP_ANALOG_PIN_VALUE)) _Pre_defensive_ SILABS_IOP_ANALOG_PIN_VALUE *pAnalogPinValue
);

_Check_return_
_Ret_range_(SILABS_STATUS_SUCCESS, SILABS_STATUS_UNKNOWN_ERROR)
_Success_(SILABS_STATUS_SUCCESS)
SLABIOPLIB_API SILABS_STATUS WINAPI
IOP_GetSerialState(
    _In_ _Pre_defensive_ const HANDLE hHandle,
    _Out_writes_bytes_(sizeof(SILABS_IOP_SERIAL_STATE)) _Pre_defensive_ SILABS_IOP_SERIAL_STATE *pSerialState
);

_Check_return_
_Ret_range_(SILABS_STATUS_SUCCESS, SILABS_STATUS_UNKNOWN_ERROR)
_Success_(SILABS_STATUS_SUCCESS)
SLABIOPLIB_API SILABS_STATUS WINAPI
IOP_DoI2CTransfer(
    _In_ _Pre_defensive_ const HANDLE hHandle,
    _In_ _Pre_defensive_ const uint8_t SlaveAddress,
    _In_reads_bytes_opt_(WriteMsgLength) _Pre_defensive_ const uint8_t *WriteMsg,
    _In_opt_ _Pre_defensive_ const uint8_t WriteMsgLength,
    _Out_writes_bytes_opt_(ReadMsgLength) _Pre_defensive_ uint8_t *ReadMsg,
    _In_opt_ _Pre_defensive_ const uint8_t ReadMsgLength,
    _Out_writes_bytes_opt_(sizeof(uint8_t)) _Pre_defensive_ uint8_t *pNumBytesRead,
    _Out_writes_bytes_opt_(sizeof(DEVICE_I2C_STATUS)) _Pre_defensive_ DEVICE_I2C_STATUS *pDeviceI2CStatus
);




_Check_return_
_Ret_range_(SILABS_STATUS_SUCCESS, SILABS_STATUS_UNKNOWN_ERROR)
_Success_(return == SILABS_STATUS_SUCCESS)
SLABIOPLIB_API SILABS_STATUS WINAPI
IOP_GetDeviceManufacturerString(
    _In_ _Pre_defensive_ const HANDLE hHandle,
    _Out_writes_bytes_(DeviceStringLenInBytes) char *pDeviceString,
    _In_ _Pre_defensive_ const size_t DeviceStringLenInBytes,
    _Out_writes_bytes_(sizeof(size_t)) _Pre_defensive_ size_t * pLenInBytes
);

_Check_return_
_Ret_range_(SILABS_STATUS_SUCCESS, SILABS_STATUS_UNKNOWN_ERROR)
_Success_(return == SILABS_STATUS_SUCCESS)
SLABIOPLIB_API SILABS_STATUS WINAPI
IOP_GetDeviceProductString(
    _In_ _Pre_defensive_ const HANDLE hHandle,
    _Out_writes_bytes_(DeviceStringLenInBytes) char *pDeviceString,
    _In_ _Pre_defensive_ const size_t DeviceStringLenInBytes,
    _Out_writes_bytes_(sizeof(size_t)) _Pre_defensive_ size_t *pLenInBytes
);

_Check_return_
_Ret_range_(SILABS_STATUS_SUCCESS, SILABS_STATUS_UNKNOWN_ERROR)
_Success_(return == SILABS_STATUS_SUCCESS)
SLABIOPLIB_API SILABS_STATUS WINAPI
IOP_GetDeviceSerialNumberString(
    _In_ _Pre_defensive_ const HANDLE hHandle,
    _Out_writes_bytes_(DeviceStringLenInBytes) char *pDeviceString,
    _In_ _Pre_defensive_ const size_t DeviceStringLenInBytes,
    _Out_writes_bytes_(sizeof(size_t)) _Pre_defensive_ size_t * pLenInBytes
);


_Check_return_
_Ret_range_(SILABS_STATUS_SUCCESS, SILABS_STATUS_UNKNOWN_ERROR)
_Success_(return == SILABS_STATUS_SUCCESS)
SLABIOPLIB_API SILABS_STATUS WINAPI
IOP_GetDeviceFirmwareVersionString(
    _In_ _Pre_defensive_ const HANDLE hHandle,
    _Out_writes_bytes_(DeviceStringLenInBytes) char *pDeviceString,
    _In_ _Pre_defensive_ const size_t DeviceStringLenInBytes,
    _Out_writes_bytes_(sizeof(size_t)) _Pre_defensive_ size_t *pLenInBytes
);


#ifdef __cplusplus
}
#endif // __cplusplus



#endif // HOST_LIB_SLABIOP_INCLUDE_SLABIOP_H_INCLUDED_PV1HTEYUPA

// End of file