BALTECH SDK wrapper functions reference
main.h
Go to the documentation of this file.
1 
10 #ifndef __BRP_BALTECH_SDK_CMDS_MAIN_H__
11 #define __BRP_BALTECH_SDK_CMDS_MAIN_H__
12 #include "../typedefs.h"
13 #ifdef BALTECH_SDK_INTERNAL
14 
17 #define BRP_Main_ErrOutdatedFirmware BRP_ERR_STATUS(0xF000, 0x01)
18 #endif // BALTECH_SDK_INTERNAL
19 #ifdef BALTECH_SDK_INTERNAL
20 
23 #define BRP_Main_ErrUnknownVersion BRP_ERR_STATUS(0xF000, 0x02)
24 #endif // BALTECH_SDK_INTERNAL
25 
28 #define BRP_Main_ErrInvalidState BRP_ERR_STATUS(0xF000, 0x10)
29 
32 #define BRP_Main_ErrReadFile BRP_ERR_STATUS(0xF000, 0x11)
33 
36 #define BRP_Main_ErrInvalidFormat BRP_ERR_STATUS(0xF000, 0x12)
37 
40 #define BRP_Main_ErrInvalidCustomerKey BRP_ERR_STATUS(0xF000, 0x13)
41 
44 #define BRP_Main_ErrInvalidConfigSecurityCode BRP_ERR_STATUS(0xF000, 0x14)
45 
48 #define BRP_Main_ErrInvalidConfigVersion BRP_ERR_STATUS(0xF000, 0x15)
49 
52 #define BRP_Main_ErrInvalidCmac BRP_ERR_STATUS(0xF000, 0x16)
53 
56 #define BRP_Main_ErrUpload BRP_ERR_STATUS(0xF000, 0x17)
57 
60 #define BRP_Main_ErrUnsupportedFirmware BRP_ERR_STATUS(0xF000, 0x18)
61 
64 #define BRP_Main_ErrAlreadyUpToDate BRP_ERR_STATUS(0xF000, 0x19)
65 
68 #define BRP_Main_ErrMissingConfigSecurityCode BRP_ERR_STATUS(0xF000, 0x1A)
69 
72 #define BRP_Main_ErrInvalidEccKey BRP_ERR_STATUS(0xF000, 0x1B)
73 
76 #define BRP_Main_ErrVerify BRP_ERR_STATUS(0xF000, 0x1C)
77 #ifdef BALTECH_SDK_INTERNAL
78 typedef struct {
79  brp_protocol protocol;
80  brp_buf Bf2Line;
81  size_t Bf2Line_len;
82  brp_Main_Bf2Upload_ResultCode* ResultCode;
83  unsigned* InvertedResultCode;
84 } brp_Main_Bf2Upload_t;
95 #ifdef BRP_SUPPORT_LEGACY_METHODS
96 brp_errcode brp_Main_Bf2Upload(brp_protocol protocol, brp_buf Bf2Line, size_t Bf2Line_len, brp_Main_Bf2Upload_ResultCode* ResultCode, unsigned* InvertedResultCode);
97 #else
98 brp_errcode brp_Main_Bf2Upload(brp_Main_Bf2Upload_t params);
99 #endif
100 #endif // BALTECH_SDK_INTERNAL
101 #ifdef BALTECH_SDK_INTERNAL
102 typedef struct {
103  brp_protocol protocol;
104 } brp_Main_SwitchFW_t;
111 #ifdef BRP_SUPPORT_LEGACY_METHODS
112 brp_errcode brp_Main_SwitchFW(brp_protocol protocol);
113 #else
114 brp_errcode brp_Main_SwitchFW(brp_Main_SwitchFW_t params);
115 #endif
116 #endif // BALTECH_SDK_INTERNAL
117 #ifdef BALTECH_SDK_INTERNAL
118 typedef struct {
119  brp_protocol protocol;
120  brp_buf Filter;
121  size_t Filter_len;
122  bool* Matches;
123 } brp_Main_MatchPlatformId2_t;
135 #ifdef BRP_SUPPORT_LEGACY_METHODS
136 brp_errcode brp_Main_MatchPlatformId2(brp_protocol protocol, brp_buf Filter, size_t Filter_len, bool* Matches);
137 #else
138 brp_errcode brp_Main_MatchPlatformId2(brp_Main_MatchPlatformId2_t params);
139 #endif
140 #endif // BALTECH_SDK_INTERNAL
141 #ifdef BALTECH_SDK_INTERNAL
142 typedef struct {
143  brp_protocol protocol;
144  brp_buf VersionDesc;
145  size_t VersionDesc_len;
146 } brp_Main_IsFirmwareUpToDate_t;
155 #ifdef BRP_SUPPORT_LEGACY_METHODS
156 brp_errcode brp_Main_IsFirmwareUpToDate(brp_protocol protocol, brp_buf VersionDesc, size_t VersionDesc_len);
157 #else
158 brp_errcode brp_Main_IsFirmwareUpToDate(brp_Main_IsFirmwareUpToDate_t params);
159 #endif
160 #endif // BALTECH_SDK_INTERNAL
161 typedef struct {
163  unsigned* ReqDataAdr;
164  unsigned* ReqDataLen;
177 #ifdef BRP_SUPPORT_LEGACY_METHODS
178 brp_errcode brp_Main_Bf3UploadStart(brp_protocol protocol, unsigned* ReqDataAdr, unsigned* ReqDataLen);
179 #else
181 #endif
182 typedef struct {
184  unsigned DataAdr;
186  size_t Data_len;
187  bool* Reconnect;
188  bool* Continue;
189  unsigned* ReqDataAdr;
190  unsigned* ReqDataLen;
224 #ifdef BRP_SUPPORT_LEGACY_METHODS
225 brp_errcode brp_Main_Bf3UploadContinue(brp_protocol protocol, unsigned DataAdr, brp_buf Data, size_t Data_len, bool* Reconnect, bool* Continue, unsigned* ReqDataAdr, unsigned* ReqDataLen, bool* ContainsEstimation, bool* ContainsReconnectRetryTimeout, unsigned* ReconnectRetryTimeout, unsigned* EstimatedNumberOfBytes, unsigned* EstimatedTimeOverhead);
226 #else
228 #endif
229 #endif
230 
brp_errcode brp_Main_Bf3UploadStart(brp_Main_Bf3UploadStart_t params)
This command starts the upload of a BEC2/BF3 file to update the reader's configuration and/or firmwar...
unsigned * EstimatedTimeOverhead
Definition: main.h:195
unsigned int brp_errcode
This type is used library-wide for passing error codes in the return value of functions.
Definition: errorcodes.h:23
unsigned * EstimatedNumberOfBytes
Definition: main.h:194
brp_protocol protocol
Definition: main.h:183
unsigned * ReqDataLen
Definition: main.h:164
struct brp_protocol_t * brp_protocol
This is a generic handle of a protocol.
Definition: protocol.h:34
unsigned * ReconnectRetryTimeout
Definition: main.h:193
brp_protocol protocol
Definition: main.h:162
brp_errcode brp_Main_Bf3UploadContinue(brp_Main_Bf3UploadContinue_t params)
This command is used to transfer the data of a BEC2/BF3 file block by block to the reader...
unsigned * ReqDataAdr
Definition: main.h:163
unsigned char * brp_buf
represents a pointer to a protocol data buffer.
Definition: common.h:61
bool * ContainsReconnectRetryTimeout
Definition: main.h:192