sys.h

Go to the documentation of this file.

#ifndef __BRP_BALTECH_SDK_CMDS_SYS_H__
#define __BRP_BALTECH_SDK_CMDS_SYS_H__
#include "../typedefs.h"
#define BRP_Sys_ErrCfgFull BRP_ERR_STATUS(0x0000, 0x01)

#define BRP_Sys_ErrCfgAccess BRP_ERR_STATUS(0x0000, 0x02)

#define BRP_Sys_ErrCfgNotFound BRP_ERR_STATUS(0x0000, 0x03)

#define BRP_Sys_ErrInvalidCfgBlock BRP_ERR_STATUS(0x0000, 0x04)

#define BRP_Sys_ErrCfgAccessDenied BRP_ERR_STATUS(0x0000, 0x05)
#ifdef BALTECH_SDK_INTERNAL

#define BRP_Sys_ErrRegAccess BRP_ERR_STATUS(0x0000, 0x06)
#endif  // BALTECH_SDK_INTERNAL

#define BRP_Sys_ErrInvalidProtocol BRP_ERR_STATUS(0x0000, 0x07)

#define BRP_Sys_ErrNotSupportedByHardware BRP_ERR_STATUS(0x0000, 0x08)

#define BRP_Sys_ErrFactsetRestore BRP_ERR_STATUS(0x0000, 0x09)
#ifdef BALTECH_SDK_INTERNAL

#define BRP_Sys_ErrCfgConfigSecurityCode BRP_ERR_STATUS(0x0000, 0x0A)
#endif  // BALTECH_SDK_INTERNAL
#ifdef BALTECH_SDK_INTERNAL

#define BRP_Sys_ErrCfgVersion BRP_ERR_STATUS(0x0000, 0x0B)
#endif  // BALTECH_SDK_INTERNAL
#ifdef BALTECH_SDK_INTERNAL

#define BRP_Sys_ErrCfgLoadWrongState BRP_ERR_STATUS(0x0000, 0x0C)
#endif  // BALTECH_SDK_INTERNAL
#ifdef BALTECH_SDK_INTERNAL

#define BRP_Sys_ErrInvalidFwCrc BRP_ERR_STATUS(0x0000, 0x7F)
#endif  // BALTECH_SDK_INTERNAL
typedef struct {
    brp_protocol protocol;
    unsigned* MaxSendSize;
    unsigned* MaxRecvSize;
    unsigned* TotalSize;
} brp_Sys_GetBufferSize_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_GetBufferSize(brp_protocol protocol, unsigned* MaxSendSize, unsigned* MaxRecvSize, unsigned* TotalSize);
#else
brp_errcode brp_Sys_GetBufferSize(brp_Sys_GetBufferSize_t params);
#endif
typedef struct {
    brp_protocol protocol;
    unsigned OffDuration;
} brp_Sys_HFReset_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_HFReset(brp_protocol protocol, unsigned OffDuration);
#else
brp_errcode brp_Sys_HFReset(brp_Sys_HFReset_t params);
#endif
typedef struct {
    brp_protocol protocol;
} brp_Sys_Reset_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_Reset(brp_protocol protocol);
#else
brp_errcode brp_Sys_Reset(brp_Sys_Reset_t params);
#endif
typedef struct {
    brp_protocol protocol;
    char** Info;
    brp_mempool *mempool;
} brp_Sys_GetInfo_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_GetInfo(brp_protocol protocol, char** Info, brp_mempool *mempool);
#else
brp_errcode brp_Sys_GetInfo(brp_Sys_GetInfo_t params);
#endif
typedef struct {
    brp_protocol protocol;
    brp_Sys_GetBootStatus_BootStatus* BootStatus;
} brp_Sys_GetBootStatus_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_GetBootStatus(brp_protocol protocol, brp_Sys_GetBootStatus_BootStatus* BootStatus);
#else
brp_errcode brp_Sys_GetBootStatus(brp_Sys_GetBootStatus_t params);
#endif
#ifdef BALTECH_SDK_INTERNAL
typedef struct {
    brp_protocol protocol;
    brp_IoPortBitmask* PortMask;
} brp_Sys_GetPort_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_GetPort(brp_protocol protocol, brp_IoPortBitmask* PortMask);
#else
brp_errcode brp_Sys_GetPort(brp_Sys_GetPort_t params);
#endif
#endif  // BALTECH_SDK_INTERNAL
#ifdef BALTECH_SDK_INTERNAL
typedef struct {
    brp_protocol protocol;
    brp_IoPortBitmask PortMask;
} brp_Sys_SetPort_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_SetPort(brp_protocol protocol, brp_IoPortBitmask PortMask);
#else
brp_errcode brp_Sys_SetPort(brp_Sys_SetPort_t params);
#endif
#endif  // BALTECH_SDK_INTERNAL
typedef struct {
    brp_protocol protocol;
    unsigned Key;
    unsigned Value;
    brp_buf* Content;
    size_t* Content_len;
    brp_mempool *mempool;
} brp_Sys_CfgGetValue_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_CfgGetValue(brp_protocol protocol, unsigned Key, unsigned Value, brp_buf* Content, size_t* Content_len, brp_mempool *mempool);
#else
brp_errcode brp_Sys_CfgGetValue(brp_Sys_CfgGetValue_t params);
#endif
typedef struct {
    brp_protocol protocol;
    unsigned Key;
    unsigned Value;
    brp_buf Content;
    size_t Content_len;
} brp_Sys_CfgSetValue_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_CfgSetValue(brp_protocol protocol, unsigned Key, unsigned Value, brp_buf Content, size_t Content_len);
#else
brp_errcode brp_Sys_CfgSetValue(brp_Sys_CfgSetValue_t params);
#endif
typedef struct {
    brp_protocol protocol;
    unsigned Key;
    unsigned Value;
} brp_Sys_CfgDelValues_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_CfgDelValues(brp_protocol protocol, unsigned Key, unsigned Value);
#else
brp_errcode brp_Sys_CfgDelValues(brp_Sys_CfgDelValues_t params);
#endif
typedef struct {
    brp_protocol protocol;
    unsigned** KeyList;
    size_t* KeyList_len;
    brp_mempool *mempool;
} brp_Sys_CfgGetKeyList_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_CfgGetKeyList(brp_protocol protocol, unsigned** KeyList, size_t* KeyList_len, brp_mempool *mempool);
#else
brp_errcode brp_Sys_CfgGetKeyList(brp_Sys_CfgGetKeyList_t params);
#endif
typedef struct {
    brp_protocol protocol;
    unsigned Key;
    unsigned** ValueList;
    size_t* ValueList_len;
    brp_mempool *mempool;
} brp_Sys_CfgGetValueList_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_CfgGetValueList(brp_protocol protocol, unsigned Key, unsigned** ValueList, size_t* ValueList_len, brp_mempool *mempool);
#else
brp_errcode brp_Sys_CfgGetValueList(brp_Sys_CfgGetValueList_t params);
#endif
#ifdef BALTECH_SDK_INTERNAL
typedef struct {
    brp_protocol protocol;
    brp_buf TlvBlock;
    size_t TlvBlock_len;
} brp_Sys_CfgWriteTlvSector_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_CfgWriteTlvSector(brp_protocol protocol, brp_buf TlvBlock, size_t TlvBlock_len);
#else
brp_errcode brp_Sys_CfgWriteTlvSector(brp_Sys_CfgWriteTlvSector_t params);
#endif
#endif  // BALTECH_SDK_INTERNAL
typedef struct {
    brp_protocol protocol;
    unsigned* TotalSize;
    unsigned* FreeSize;
} brp_Sys_CfgCheck_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_CfgCheck(brp_protocol protocol, unsigned* TotalSize, unsigned* FreeSize);
#else
brp_errcode brp_Sys_CfgCheck(brp_Sys_CfgCheck_t params);
#endif
#ifdef BALTECH_SDK_INTERNAL
typedef struct {
    brp_protocol protocol;
    brp_IoPortBitmask InpOutp;
    brp_IoPortBitmask DefaultState;
} brp_Sys_ConfigPort_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_ConfigPort(brp_protocol protocol, brp_IoPortBitmask InpOutp, brp_IoPortBitmask DefaultState);
#else
brp_errcode brp_Sys_ConfigPort(brp_Sys_ConfigPort_t params);
#endif
#endif  // BALTECH_SDK_INTERNAL
#ifdef BALTECH_SDK_INTERNAL
typedef struct {
    brp_protocol protocol;
    bool ResetRegister;
    brp_Sys_SetRegister_RegisterAssignments_Entry* RegisterAssignments;
    size_t RegisterAssignments_len;
} brp_Sys_SetRegister_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_SetRegister(brp_protocol protocol, bool ResetRegister, brp_Sys_SetRegister_RegisterAssignments_Entry* RegisterAssignments, size_t RegisterAssignments_len);
#else
brp_errcode brp_Sys_SetRegister(brp_Sys_SetRegister_t params);
#endif
#endif  // BALTECH_SDK_INTERNAL
#ifdef BALTECH_SDK_INTERNAL
typedef struct {
    brp_protocol protocol;
    unsigned ID;
    unsigned* Value;
} brp_Sys_GetRegister_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_GetRegister(brp_protocol protocol, unsigned ID, unsigned* Value);
#else
brp_errcode brp_Sys_GetRegister(brp_Sys_GetRegister_t params);
#endif
#endif  // BALTECH_SDK_INTERNAL
#ifdef BALTECH_SDK_INTERNAL
typedef struct {
    brp_protocol protocol;
} brp_Sys_PowerDown_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_PowerDown(brp_protocol protocol);
#else
brp_errcode brp_Sys_PowerDown(brp_Sys_PowerDown_t params);
#endif
#endif  // BALTECH_SDK_INTERNAL
typedef struct {
    brp_protocol protocol;
    brp_ProtocolID Protocol;
} brp_Sys_SelectProtocol_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_SelectProtocol(brp_protocol protocol, brp_ProtocolID Protocol);
#else
brp_errcode brp_Sys_SelectProtocol(brp_Sys_SelectProtocol_t params);
#endif
#ifdef BALTECH_SDK_INTERNAL
typedef struct {
    brp_protocol protocol;
    brp_Baudrate NewBaudrate;
    brp_Parity NewParity;
    unsigned CWT;
} brp_Sys_SetCommParam_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_SetCommParam(brp_protocol protocol, brp_Baudrate NewBaudrate, brp_Parity NewParity, unsigned CWT);
#else
brp_errcode brp_Sys_SetCommParam(brp_Sys_SetCommParam_t params);
#endif
#endif  // BALTECH_SDK_INTERNAL
typedef struct {
    brp_protocol protocol;
    unsigned Version;
    brp_buf Data;
    size_t Data_len;
} brp_Sys_CfgLoadBlock_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_CfgLoadBlock(brp_protocol protocol, unsigned Version, brp_buf Data, size_t Data_len);
#else
brp_errcode brp_Sys_CfgLoadBlock(brp_Sys_CfgLoadBlock_t params);
#endif
#ifdef BALTECH_SDK_INTERNAL
typedef struct {
    brp_protocol protocol;
    brp_buf* PlatformId;
    unsigned* BootloaderId;
    unsigned* BootloaderMajor;
    unsigned* BootloaderMinor;
    unsigned* BootloaderBuild;
    brp_mempool *mempool;
} brp_Sys_GetPlatformId_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_GetPlatformId(brp_protocol protocol, brp_buf* PlatformId, unsigned* BootloaderId, unsigned* BootloaderMajor, unsigned* BootloaderMinor, unsigned* BootloaderBuild, brp_mempool *mempool);
#else
brp_errcode brp_Sys_GetPlatformId(brp_Sys_GetPlatformId_t params);
#endif
#endif  // BALTECH_SDK_INTERNAL
typedef struct {
    brp_protocol protocol;
} brp_Sys_CfgReset_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_CfgReset(brp_protocol protocol);
#else
brp_errcode brp_Sys_CfgReset(brp_Sys_CfgReset_t params);
#endif
typedef struct {
    brp_protocol protocol;
    brp_ProtocolID Protocol;
} brp_Sys_StopProtocol_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_StopProtocol(brp_protocol protocol, brp_ProtocolID Protocol);
#else
brp_errcode brp_Sys_StopProtocol(brp_Sys_StopProtocol_t params);
#endif
typedef struct {
    brp_protocol protocol;
    brp_ProtocolID Protocol;
    brp_MessageType MsgType;
    brp_buf Message;
    size_t Message_len;
} brp_Sys_SendMessage_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_SendMessage(brp_protocol protocol, brp_ProtocolID Protocol, brp_MessageType MsgType, brp_buf Message, size_t Message_len);
#else
brp_errcode brp_Sys_SendMessage(brp_Sys_SendMessage_t params);
#endif
typedef struct {
    brp_protocol protocol;
    char** ConfigId;
    char** ConfigName;
    brp_mempool *mempool;
} brp_Sys_CfgGetId_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_CfgGetId(brp_protocol protocol, char** ConfigId, char** ConfigName, brp_mempool *mempool);
#else
brp_errcode brp_Sys_CfgGetId(brp_Sys_CfgGetId_t params);
#endif
typedef struct {
    brp_protocol protocol;
    char** ConfigId;
    char** ConfigName;
    brp_mempool *mempool;
} brp_Sys_CfgGetDeviceSettingsId_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_CfgGetDeviceSettingsId(brp_protocol protocol, char** ConfigId, char** ConfigName, brp_mempool *mempool);
#else
brp_errcode brp_Sys_CfgGetDeviceSettingsId(brp_Sys_CfgGetDeviceSettingsId_t params);
#endif
#ifdef BALTECH_SDK_INTERNAL
typedef struct {
    brp_protocol protocol;
} brp_Sys_FactoryResetLegacy_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_FactoryResetLegacy(brp_protocol protocol);
#else
brp_errcode brp_Sys_FactoryResetLegacy(brp_Sys_FactoryResetLegacy_t params);
#endif
#endif  // BALTECH_SDK_INTERNAL
typedef struct {
    brp_protocol protocol;
    bool DeleteCounters;
    brp_Sys_GetStatistics_CounterTuple_Entry** CounterTuple;
    size_t* CounterTuple_len;
    brp_mempool *mempool;
} brp_Sys_GetStatistics_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_GetStatistics(brp_protocol protocol, bool DeleteCounters, brp_Sys_GetStatistics_CounterTuple_Entry** CounterTuple, size_t* CounterTuple_len, brp_mempool *mempool);
#else
brp_errcode brp_Sys_GetStatistics(brp_Sys_GetStatistics_t params);
#endif
typedef struct {
    brp_protocol protocol;
    brp_FeatureID** FeatureList;
    size_t* FeatureList_len;
    brp_FeatureID* MaxFeatureID;
    brp_mempool *mempool;
} brp_Sys_GetFeatures_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_GetFeatures(brp_protocol protocol, brp_FeatureID** FeatureList, size_t* FeatureList_len, brp_FeatureID* MaxFeatureID, brp_mempool *mempool);
#else
brp_errcode brp_Sys_GetFeatures(brp_Sys_GetFeatures_t params);
#endif
typedef struct {
    brp_protocol protocol;
    char** PartNo;
    char** HwRevNo;
    brp_mempool *mempool;
} brp_Sys_GetPartNumber_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_GetPartNumber(brp_protocol protocol, char** PartNo, char** HwRevNo, brp_mempool *mempool);
#else
brp_errcode brp_Sys_GetPartNumber(brp_Sys_GetPartNumber_t params);
#endif
typedef struct {
    brp_protocol protocol;
    brp_AuthReqUpload AuthReq;
} brp_Sys_CfgLoadPrepare_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_CfgLoadPrepare(brp_protocol protocol, brp_AuthReqUpload AuthReq);
#else
brp_errcode brp_Sys_CfgLoadPrepare(brp_Sys_CfgLoadPrepare_t params);
#endif
typedef struct {
    brp_protocol protocol;
    brp_Sys_CfgLoadFinish_FinalizeAction FinalizeAction;
} brp_Sys_CfgLoadFinish_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_CfgLoadFinish(brp_protocol protocol, brp_Sys_CfgLoadFinish_FinalizeAction FinalizeAction);
#else
brp_errcode brp_Sys_CfgLoadFinish(brp_Sys_CfgLoadFinish_t params);
#endif
typedef struct {
    brp_protocol protocol;
    bool PerformReboot;
} brp_Sys_FactoryReset_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_FactoryReset(brp_protocol protocol, bool PerformReboot);
#else
brp_errcode brp_Sys_FactoryReset(brp_Sys_FactoryReset_t params);
#endif
typedef struct {
    brp_protocol protocol;
    brp_LicenseBitMask* LicenseBitMask;
} brp_Sys_GetLicenses_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_GetLicenses(brp_protocol protocol, brp_LicenseBitMask* LicenseBitMask);
#else
brp_errcode brp_Sys_GetLicenses(brp_Sys_GetLicenses_t params);
#endif
#ifdef BALTECH_SDK_INTERNAL
typedef struct {
    brp_protocol protocol;
    unsigned* CRC;
} brp_Sys_GetFwCrc_t;
#ifdef BRP_SUPPORT_LEGACY_METHODS
brp_errcode brp_Sys_GetFwCrc(brp_protocol protocol, unsigned* CRC);
#else
brp_errcode brp_Sys_GetFwCrc(brp_Sys_GetFwCrc_t params);
#endif
#endif  // BALTECH_SDK_INTERNAL
#endif