C API for BALTECH SDK
sys.h
Go to the documentation of this file.
1 
15 #ifndef __BRP_BALTECH_API_CMDS_SYS_H__
16 #define __BRP_BALTECH_API_CMDS_SYS_H__
17 #include "../typedefs.h"
21 #define BRP_Sys_ErrCfgFull BRP_ERR_STATUS(0x0000, 0x01)
22 
28 #define BRP_Sys_ErrCfgAccess BRP_ERR_STATUS(0x0000, 0x02)
29 
35 #define BRP_Sys_ErrCfgNotFound BRP_ERR_STATUS(0x0000, 0x03)
36 
39 #define BRP_Sys_ErrInvalidCfgBlock BRP_ERR_STATUS(0x0000, 0x04)
40 
43 #define BRP_Sys_ErrCfgAccessDenied BRP_ERR_STATUS(0x0000, 0x05)
44 
47 #define BRP_Sys_ErrRegAccess BRP_ERR_STATUS(0x0000, 0x06)
48 
51 #define BRP_Sys_ErrInvalidProtocol BRP_ERR_STATUS(0x0000, 0x07)
52 
55 #define BRP_Sys_ErrNotSupportedByHardware BRP_ERR_STATUS(0x0000, 0x08)
56 
59 #define BRP_Sys_ErrFactsetRestore BRP_ERR_STATUS(0x0000, 0x09)
60 
67 #define BRP_Sys_ErrCfgConfigSecurityCode BRP_ERR_STATUS(0x0000, 0x0A)
68 
74 #define BRP_Sys_ErrCfgVersion BRP_ERR_STATUS(0x0000, 0x0B)
75 
78 #define BRP_Sys_ErrCfgLoadWrongState BRP_ERR_STATUS(0x0000, 0x0C)
79 
83 #define BRP_Sys_ErrInvalidFwCrc BRP_ERR_STATUS(0x0000, 0x7F)
84 
104 brp_errcode brp_Sys_GetBufferSize(brp_protocol protocol, unsigned* MaxSendSize, unsigned* MaxRecvSize, unsigned* TotalSize);
124 brp_errcode brp_Sys_HFReset(brp_protocol protocol, unsigned OffDuration);
170 brp_errcode brp_Sys_GetInfo(brp_protocol protocol, char** Info, brp_mempool *mempool);
220 brp_errcode brp_Sys_CfgGetValue(brp_protocol protocol, unsigned Key, unsigned Value, brp_buf* Content, size_t* Content_len, brp_mempool *mempool);
233 brp_errcode brp_Sys_CfgSetValue(brp_protocol protocol, unsigned Key, unsigned Value, brp_buf Content, size_t Content_len);
247 brp_errcode brp_Sys_CfgDelValues(brp_protocol protocol, unsigned Key, unsigned Value);
256 brp_errcode brp_Sys_CfgGetKeyList(brp_protocol protocol, unsigned** KeyList, size_t* KeyList_len, brp_mempool *mempool);
266 brp_errcode brp_Sys_CfgGetValueList(brp_protocol protocol, unsigned Key, unsigned** ValueList, size_t* ValueList_len, brp_mempool *mempool);
279 brp_errcode brp_Sys_CfgWriteTlvSector(brp_protocol protocol, brp_buf TlvBlock, size_t TlvBlock_len);
297 brp_errcode brp_Sys_CfgCheck(brp_protocol protocol, unsigned* TotalSize, unsigned* FreeSize);
329 brp_errcode brp_Sys_SetRegister(brp_protocol protocol, bool ResetRegister, brp_Sys_SetRegister_RegisterAssignments_Entry* RegisterAssignments, size_t RegisterAssignments_len);
340 brp_errcode brp_Sys_GetRegister(brp_protocol protocol, unsigned ID, unsigned* Value);
414 brp_errcode brp_Sys_SetCommParam(brp_protocol protocol, brp_Baudrate NewBaudrate, brp_Parity NewParity, unsigned CWT);
445 brp_errcode brp_Sys_CfgLoadBlock(brp_protocol protocol, unsigned Version, brp_buf Data, size_t Data_len);
462 brp_errcode brp_Sys_GetPlatformId(brp_protocol protocol, brp_buf* PlatformId, unsigned* BootloaderId, unsigned* BootloaderMajor, unsigned* BootloaderMinor, unsigned* BootloaderBuild, brp_mempool *mempool);
499 brp_errcode brp_Sys_CfgGetId(brp_protocol protocol, char** ConfigId, char** ConfigName, brp_mempool *mempool);
515 brp_errcode brp_Sys_CfgGetDeviceSettingsId(brp_protocol protocol, char** ConfigId, char** ConfigName, brp_mempool *mempool);
545 brp_errcode brp_Sys_GetStatistics(brp_protocol protocol, bool DeleteCounters, brp_Sys_GetStatistics_CounterTuple_Entry** CounterTuple, size_t* CounterTuple_len, brp_mempool *mempool);
558 brp_errcode brp_Sys_GetFeatures(brp_protocol protocol, brp_FeatureID** FeatureList, size_t* FeatureList_len, brp_FeatureID* MaxFeatureID, brp_mempool *mempool);
575 brp_errcode brp_Sys_GetPartNumber(brp_protocol protocol, char** PartNo, char** HwRevNo, brp_mempool *mempool);
616 brp_errcode brp_Sys_FactoryReset(brp_protocol protocol, bool PerformReboot);
632 brp_errcode brp_Sys_GetFwCrc(brp_protocol protocol, unsigned* CRC);
633 #endif
634 
brp_errcode brp_Sys_CfgLoadPrepare(brp_protocol protocol, brp_AuthReqUpload AuthReq)
This command initiates the transfer of a BEC file via brp_Sys_CfgLoadBlock().
brp_errcode brp_Sys_GetPlatformId(brp_protocol protocol, brp_buf *PlatformId, unsigned *BootloaderId, unsigned *BootloaderMajor, unsigned *BootloaderMinor, unsigned *BootloaderBuild, brp_mempool *mempool)
Maintenance command only needed for Baltech internal use to get detailed information about the actual...
brp_errcode brp_Sys_CfgGetKeyList(brp_protocol protocol, unsigned **KeyList, size_t *KeyList_len, brp_mempool *mempool)
Retrieves a list of all keys stored in the reader's configuration.
Definition: typedefs.h:2256
brp_errcode brp_Sys_CfgSetValue(brp_protocol protocol, unsigned Key, unsigned Value, brp_buf Content, size_t Content_len)
This command stores a value in the reader's configuration.
License bit mask.
Definition: typedefs.h:4735
brp_errcode brp_Sys_CfgGetValueList(brp_protocol protocol, unsigned Key, unsigned **ValueList, size_t *ValueList_len, brp_mempool *mempool)
Returns a list of all configuration values within a specified Key.
brp_errcode brp_Sys_SetCommParam(brp_protocol protocol, brp_Baudrate NewBaudrate, brp_Parity NewParity, unsigned CWT)
This command is only required when the serial host-to-reader interface is in use. ...
brp_errcode brp_Sys_FactoryReset(brp_protocol protocol, bool PerformReboot)
This command restores the reader's factory settings.
brp_errcode brp_Sys_GetPartNumber(brp_protocol protocol, char **PartNo, char **HwRevNo, brp_mempool *mempool)
This command returns the part number and the hardware revision number of the device.
brp_errcode brp_Sys_CfgGetDeviceSettingsId(brp_protocol protocol, char **ConfigId, char **ConfigName, brp_mempool *mempool)
This command retrieves the ID of the reader configuration containing the device settings.
brp_errcode brp_Sys_CfgGetId(brp_protocol protocol, char **ConfigId, char **ConfigName, brp_mempool *mempool)
This command returns the identifier of the reader configuration.
brp_ProtocolID
A list of all protocols.
Definition: typedefs.h:3043
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)
**Please use brp_Sys_CfgLoadBlock() instead of this command for new applications. ...
brp_errcode brp_Sys_GetRegister(brp_protocol protocol, unsigned ID, unsigned *Value)
Retrieves one of the reader's internal registers.
brp_errcode brp_Sys_FactoryResetLegacy(brp_protocol protocol)
**This is a legacy command! For new developments please use brp_Sys_FactoryReset() ...
brp_errcode brp_Sys_SelectProtocol(brp_protocol protocol, brp_ProtocolID Protocol)
This command starts a host 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)
This command retrieves a desired value of the reader's configuration, specified by the Key and Value ...
brp_errcode brp_Sys_SetRegister(brp_protocol protocol, bool ResetRegister, brp_Sys_SetRegister_RegisterAssignments_Entry *RegisterAssignments, size_t RegisterAssignments_len)
Sets one or multiple of the reader's internal registers.
brp_Sys_CfgLoadFinish_FinalizeAction
Defines the reader's behaviour on error/success.
Definition: typedefs.h:2282
Definition: typedefs.h:2269
brp_errcode brp_Sys_Reset(brp_protocol protocol)
This command reboots the reader.
struct brp_mempool_object_t * brp_mempool
mempool handle.
Definition: mempool.h:27
brp_errcode brp_Sys_StopProtocol(brp_protocol protocol, brp_ProtocolID Protocol)
This command stops a host protocol.
brp_errcode brp_Sys_GetFwCrc(brp_protocol protocol, unsigned *CRC)
Maintenance command only needed for Baltech internal use to get the CRC of the firmware.
brp_errcode brp_Sys_CfgLoadFinish(brp_protocol protocol, brp_Sys_CfgLoadFinish_FinalizeAction FinalizeAction)
This command has to be called after transferring a BEC file with brp_Sys_CfgLoadBlock().
brp_errcode brp_Sys_GetStatistics(brp_protocol protocol, bool DeleteCounters, brp_Sys_GetStatistics_CounterTuple_Entry **CounterTuple, size_t *CounterTuple_len, brp_mempool *mempool)
This command retrieves all available statistics counters from the reader's configuration.
brp_errcode brp_Sys_HFReset(brp_protocol protocol, unsigned OffDuration)
This command turns the HF antenna off or on.
brp_errcode brp_Sys_GetFeatures(brp_protocol protocol, brp_FeatureID **FeatureList, size_t *FeatureList_len, brp_FeatureID *MaxFeatureID, brp_mempool *mempool)
This command retrieves the list of features supported by the reader, so you can find out if the reade...
brp_errcode brp_Sys_CfgLoadBlock(brp_protocol protocol, unsigned Version, brp_buf Data, size_t Data_len)
This command transfers the configuration from a BEC file into the reader.
brp_errcode brp_Sys_GetInfo(brp_protocol protocol, char **Info, brp_mempool *mempool)
This command retrieves the firmware string of the reader, which holds information about the reader fi...
brp_Parity
Specifies the Parity-bit mode which is used for RS-232/UART protocols.
Definition: typedefs.h:3785
brp_errcode brp_Sys_GetBufferSize(brp_protocol protocol, unsigned *MaxSendSize, unsigned *MaxRecvSize, unsigned *TotalSize)
This command returns the maximum sizes of command and response frames that the reader can send and re...
brp_errcode brp_Sys_ConfigPort(brp_protocol protocol, brp_IoPortBitmask InpOutp, brp_IoPortBitmask DefaultState)
Configures generic I/O ports for input/output.
brp_FeatureID
Definition: typedefs.h:3416
brp_errcode brp_Sys_CfgReset(brp_protocol protocol)
Deletes the complete configuration.
brp_errcode brp_Sys_GetPort(brp_protocol protocol, brp_IoPortBitmask *PortMask)
This command retrieves the voltage for the custom I/O ports of the module.
brp_errcode brp_Sys_CfgDelValues(brp_protocol protocol, unsigned Key, unsigned Value)
This command deletes a key or a value from the reader's configuration.
brp_errcode brp_Sys_SetPort(brp_protocol protocol, brp_IoPortBitmask PortMask)
**Please use brp_UI_Enable() and brp_UI_Disable() instead of this command for new applications...
brp_errcode brp_Sys_PowerDown(brp_protocol protocol)
Powers off the device.
brp_errcode brp_Sys_GetLicenses(brp_protocol protocol, brp_LicenseBitMask *LicenseBitMask)
This command retrieves a bit mask of the licenses that are activated in the reader.
brp_AuthReqUpload
Specifies the authentication level the BEC/BEC2/BF3 file or ConfigCard has to fulfill to be accepted...
Definition: typedefs.h:4438
unsigned char * brp_buf
represents a pointer to a protocol data buffer.
Definition: common.h:61
brp_Baudrate
The Baudrate specifies the performance of an RS-232/UART based interface in bits per second...
Definition: typedefs.h:3808
brp_errcode brp_Sys_CfgCheck(brp_protocol protocol, unsigned *TotalSize, unsigned *FreeSize)
This command checks the consistency of the reader's internal configuration.
brp_errcode brp_Sys_GetBootStatus(brp_protocol protocol, brp_Sys_GetBootStatus_BootStatus *BootStatus)
This command retrieves the boot status of the reader, i.e.