C API for BALTECH SDK
sys.h
Go to the documentation of this file.
1 
16 #ifndef __BRP_BALTECH_API_CMDS_SYS_H__
17 #define __BRP_BALTECH_API_CMDS_SYS_H__
18 #include "../typedefs.h"
23 #define BRP_Sys_ErrCfgFull BRP_ERR_STATUS(0x0000, 0x01)
24 
31 #define BRP_Sys_ErrCfgAccess BRP_ERR_STATUS(0x0000, 0x02)
32 
39 #define BRP_Sys_ErrCfgNotFound BRP_ERR_STATUS(0x0000, 0x03)
40 
44 #define BRP_Sys_ErrInvalidCfgBlock BRP_ERR_STATUS(0x0000, 0x04)
45 
49 #define BRP_Sys_ErrCfgAccessDenied BRP_ERR_STATUS(0x0000, 0x05)
50 
54 #define BRP_Sys_ErrRegAccess BRP_ERR_STATUS(0x0000, 0x06)
55 
59 #define BRP_Sys_ErrInvalidProtocol BRP_ERR_STATUS(0x0000, 0x07)
60 
64 #define BRP_Sys_ErrNotSupportedByHardware BRP_ERR_STATUS(0x0000, 0x08)
65 
69 #define BRP_Sys_ErrFactsetRestore BRP_ERR_STATUS(0x0000, 0x09)
70 
78 #define BRP_Sys_ErrCfgConfigSecurityCode BRP_ERR_STATUS(0x0000, 0x0A)
79 
86 #define BRP_Sys_ErrCfgVersion BRP_ERR_STATUS(0x0000, 0x0B)
87 
93 #define BRP_Sys_ErrCfgLoadWrongState BRP_ERR_STATUS(0x0000, 0x0C)
94 
99 #define BRP_Sys_ErrInvalidFwCrc BRP_ERR_STATUS(0x0000, 0x7F)
100 
121 brp_errcode brp_Sys_GetBufferSize(brp_protocol protocol, unsigned* MaxSendSize, unsigned* MaxRecvSize, unsigned* TotalSize);
142 brp_errcode brp_Sys_HFReset(brp_protocol protocol, unsigned OffDuration);
190 brp_errcode brp_Sys_GetInfo(brp_protocol protocol, char** Info, brp_mempool *mempool);
245 brp_errcode brp_Sys_CfgGetValue(brp_protocol protocol, unsigned Key, unsigned Value, brp_buf* Content, size_t* Content_len, brp_mempool *mempool);
259 brp_errcode brp_Sys_CfgSetValue(brp_protocol protocol, unsigned Key, unsigned Value, brp_buf Content, size_t Content_len);
274 brp_errcode brp_Sys_CfgDelValues(brp_protocol protocol, unsigned Key, unsigned Value);
284 brp_errcode brp_Sys_CfgGetKeyList(brp_protocol protocol, unsigned** KeyList, size_t* KeyList_len, brp_mempool *mempool);
295 brp_errcode brp_Sys_CfgGetValueList(brp_protocol protocol, unsigned Key, unsigned** ValueList, size_t* ValueList_len, brp_mempool *mempool);
309 brp_errcode brp_Sys_CfgWriteTlvSector(brp_protocol protocol, brp_buf TlvBlock, size_t TlvBlock_len);
328 brp_errcode brp_Sys_CfgCheck(brp_protocol protocol, unsigned* TotalSize, unsigned* FreeSize);
362 brp_errcode brp_Sys_SetRegister(brp_protocol protocol, bool ResetRegister, brp_Sys_SetRegister_RegisterAssignments_Entry* RegisterAssignments, size_t RegisterAssignments_len);
374 brp_errcode brp_Sys_GetRegister(brp_protocol protocol, unsigned ID, unsigned* Value);
451 brp_errcode brp_Sys_SetCommParam(brp_protocol protocol, brp_Baudrate NewBaudrate, brp_Parity NewParity, unsigned CWT);
485 brp_errcode brp_Sys_CfgLoadBlock(brp_protocol protocol, unsigned Version, brp_buf Data, size_t Data_len);
504 brp_errcode brp_Sys_GetPlatformId(brp_protocol protocol, brp_buf* PlatformId, unsigned* BootloaderId, unsigned* BootloaderMajor, unsigned* BootloaderMinor, unsigned* BootloaderBuild, brp_mempool *mempool);
546 brp_errcode brp_Sys_CfgGetId(brp_protocol protocol, char** ConfigId, char** ConfigName, brp_mempool *mempool);
563 brp_errcode brp_Sys_CfgGetDeviceSettingsId(brp_protocol protocol, char** ConfigId, char** ConfigName, brp_mempool *mempool);
596 brp_errcode brp_Sys_GetStatistics(brp_protocol protocol, bool DeleteCounters, brp_Sys_GetStatistics_CounterTuple_Entry** CounterTuple, size_t* CounterTuple_len, brp_mempool *mempool);
610 brp_errcode brp_Sys_GetFeatures(brp_protocol protocol, brp_FeatureID** FeatureList, size_t* FeatureList_len, brp_FeatureID* MaxFeatureID, brp_mempool *mempool);
628 brp_errcode brp_Sys_GetPartNumber(brp_protocol protocol, char** PartNo, char** HwRevNo, brp_mempool *mempool);
676 brp_errcode brp_Sys_FactoryReset(brp_protocol protocol, bool PerformReboot);
694 brp_errcode brp_Sys_GetFwCrc(brp_protocol protocol, unsigned* CRC);
695 #endif
696 
brp_errcode brp_Sys_CfgLoadPrepare(brp_protocol protocol, brp_AuthReqUpload AuthReq)
brp_errcode brp_Sys_GetPlatformId(brp_protocol protocol, brp_buf *PlatformId, unsigned *BootloaderId, unsigned *BootloaderMajor, unsigned *BootloaderMinor, unsigned *BootloaderBuild, brp_mempool *mempool)
brp_errcode brp_Sys_CfgGetKeyList(brp_protocol protocol, unsigned **KeyList, size_t *KeyList_len, brp_mempool *mempool)
Definition: typedefs.h:2319
brp_errcode brp_Sys_CfgSetValue(brp_protocol protocol, unsigned Key, unsigned Value, brp_buf Content, size_t Content_len)
brp_errcode brp_Sys_CfgGetValueList(brp_protocol protocol, unsigned Key, unsigned **ValueList, size_t *ValueList_len, brp_mempool *mempool)
brp_errcode brp_Sys_SetCommParam(brp_protocol protocol, brp_Baudrate NewBaudrate, brp_Parity NewParity, unsigned CWT)
brp_errcode brp_Sys_FactoryReset(brp_protocol protocol, bool PerformReboot)
brp_errcode brp_Sys_GetPartNumber(brp_protocol protocol, char **PartNo, char **HwRevNo, brp_mempool *mempool)
brp_errcode brp_Sys_CfgGetDeviceSettingsId(brp_protocol protocol, char **ConfigId, char **ConfigName, brp_mempool *mempool)
brp_errcode brp_Sys_CfgGetId(brp_protocol protocol, char **ConfigId, char **ConfigName, brp_mempool *mempool)
brp_ProtocolID
Definition: typedefs.h:3124
unsigned int brp_errcode
This type is used library-wide for passing error codes in the return value of functions.
Definition: errorcodes.h:23
brp_errcode brp_Sys_CfgWriteTlvSector(brp_protocol protocol, brp_buf TlvBlock, size_t TlvBlock_len)
brp_errcode brp_Sys_GetRegister(brp_protocol protocol, unsigned ID, unsigned *Value)
brp_errcode brp_Sys_FactoryResetLegacy(brp_protocol protocol)
brp_errcode brp_Sys_SelectProtocol(brp_protocol protocol, brp_ProtocolID Protocol)
struct brp_protocol_t * brp_protocol
This is a generic handle of a protocol.
Definition: protocol.h:34
brp_errcode brp_Sys_CfgGetValue(brp_protocol protocol, unsigned Key, unsigned Value, brp_buf *Content, size_t *Content_len, brp_mempool *mempool)
brp_errcode brp_Sys_SetRegister(brp_protocol protocol, bool ResetRegister, brp_Sys_SetRegister_RegisterAssignments_Entry *RegisterAssignments, size_t RegisterAssignments_len)
brp_Sys_CfgLoadFinish_FinalizeAction
Definition: typedefs.h:2347
Definition: typedefs.h:2333
brp_errcode brp_Sys_Reset(brp_protocol protocol)
struct brp_mempool_object_t * brp_mempool
mempool handle.
Definition: mempool.h:27
brp_errcode brp_Sys_StopProtocol(brp_protocol protocol, brp_ProtocolID Protocol)
brp_errcode brp_Sys_GetFwCrc(brp_protocol protocol, unsigned *CRC)
brp_errcode brp_Sys_CfgLoadFinish(brp_protocol protocol, brp_Sys_CfgLoadFinish_FinalizeAction FinalizeAction)
brp_errcode brp_Sys_GetStatistics(brp_protocol protocol, bool DeleteCounters, brp_Sys_GetStatistics_CounterTuple_Entry **CounterTuple, size_t *CounterTuple_len, brp_mempool *mempool)
brp_errcode brp_Sys_HFReset(brp_protocol protocol, unsigned OffDuration)
brp_errcode brp_Sys_GetFeatures(brp_protocol protocol, brp_FeatureID **FeatureList, size_t *FeatureList_len, brp_FeatureID *MaxFeatureID, brp_mempool *mempool)
brp_errcode brp_Sys_CfgLoadBlock(brp_protocol protocol, unsigned Version, brp_buf Data, size_t Data_len)
brp_errcode brp_Sys_GetInfo(brp_protocol protocol, char **Info, brp_mempool *mempool)
brp_Parity
Definition: typedefs.h:3847
brp_errcode brp_Sys_GetBufferSize(brp_protocol protocol, unsigned *MaxSendSize, unsigned *MaxRecvSize, unsigned *TotalSize)
brp_errcode brp_Sys_ConfigPort(brp_protocol protocol, brp_IoPortBitmask InpOutp, brp_IoPortBitmask DefaultState)
brp_FeatureID
Definition: typedefs.h:3500
brp_errcode brp_Sys_CfgReset(brp_protocol protocol)
brp_errcode brp_Sys_GetPort(brp_protocol protocol, brp_IoPortBitmask *PortMask)
brp_errcode brp_Sys_CfgDelValues(brp_protocol protocol, unsigned Key, unsigned Value)
brp_errcode brp_Sys_SetPort(brp_protocol protocol, brp_IoPortBitmask PortMask)
brp_errcode brp_Sys_PowerDown(brp_protocol protocol)
brp_errcode brp_Sys_GetLicenses(brp_protocol protocol, brp_LicenseBitMask *LicenseBitMask)
brp_AuthReqUpload
Definition: typedefs.h:4508
unsigned char * brp_buf
represents a pointer to a protocol data buffer.
Definition: common.h:61
brp_Baudrate
Definition: typedefs.h:3871
brp_errcode brp_Sys_CfgCheck(brp_protocol protocol, unsigned *TotalSize, unsigned *FreeSize)
brp_errcode brp_Sys_GetBootStatus(brp_protocol protocol, brp_Sys_GetBootStatus_BootStatus *BootStatus)