CCAux  2.15.2.0
CCAux API reference
FirmwareUpgrade.h
Go to the documentation of this file.
1 /************************************************
2  *
3  * CROSSCONTROL AUX API
4  *
5  * FirmwareUpgrade.h
6  *
7  * Version 2.15.2.0, 2020-07-08
8  *
9  * (c) CrossControl 2010-2020
10  *
11 
12  * File description:
13  * Firmware upgrade of the system's microprocessors and FPGA.
14  *
15  * Use the function GetFirmwareUpgrade() to get a handle to pass on to the other functions.
16  * Use the method FirmwareUpgrade_release(FIRMWAREUPGHANDLE) to return the handle.
17  *
18  * XA platform: Note that if you do several upgrades/verifications in a row,
19  * the FirmwareUpgrade object should be released and reinitialised between
20  * each operation:
21  * FirmwareUpgrade_release(pObj); pObj = ::GetFirmwareUpgrade();
22  *
23  * Example Usage:
24  * @include firmwareupgrade_example.cpp
25  ************************************************/
26 
27 #ifndef CC_FIRMWAREUPG_H_
28 #define CC_FIRMWAREUPG_H_
29 
30 #include "CCAuxErrors.h"
31 #include "CCPlatform.h"
32 
33 #ifdef __cplusplus
34 namespace CrossControl {
35 #endif
36 
37  typedef void* FIRMWAREUPGHANDLE;
38 
52  EXTERN_C
53  CCAUXDLL_API
55  CCAUXDLL_CALLING_CONV
56  GetFirmwareUpgrade(void);
57 
68  EXTERN_C
69  CCAUXDLL_API
70  void
71  CCAUXDLL_CALLING_CONV
73 
95  EXTERN_C
96  CCAUXDLL_API
97  eErr
98  CCAUXDLL_CALLING_CONV
99  FirmwareUpgrade_startFpgaUpgrade(FIRMWAREUPGHANDLE, const char_t* filename, bool blocking);
100 
121  EXTERN_C
122  CCAUXDLL_API
123  eErr
124  CCAUXDLL_CALLING_CONV
125  FirmwareUpgrade_startFpgaVerification (FIRMWAREUPGHANDLE, const char_t* filename, bool blocking);
126 
149  EXTERN_C
150  CCAUXDLL_API
151  eErr
152  CCAUXDLL_CALLING_CONV
153  FirmwareUpgrade_startSSUpgrade(FIRMWAREUPGHANDLE, const char_t* filename, bool blocking);
154 
175  EXTERN_C
176  CCAUXDLL_API
177  eErr
178  CCAUXDLL_CALLING_CONV
179  FirmwareUpgrade_startSSVerification (FIRMWAREUPGHANDLE, const char_t* filename, bool blocking);
180 
201  EXTERN_C
202  CCAUXDLL_API
203  eErr
204  CCAUXDLL_CALLING_CONV
205  FirmwareUpgrade_startFrontUpgrade(FIRMWAREUPGHANDLE, const char_t* filename, bool blocking);
206 
227  EXTERN_C
228  CCAUXDLL_API
229  eErr
230  CCAUXDLL_CALLING_CONV
231  FirmwareUpgrade_startFrontVerification (FIRMWAREUPGHANDLE, const char_t* filename, bool blocking);
232 
246  EXTERN_C
247  CCAUXDLL_API
248  eErr
249  CCAUXDLL_CALLING_CONV
251 
259  EXTERN_C
260  CCAUXDLL_API
261  eErr
262  CCAUXDLL_CALLING_CONV
264 
265 #ifdef __cplusplus
266 } /* namespace CrossControl */
267 #endif
268 
269 #endif /* CC_FIRMWAREUPG_H_ */
270 
271 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV FirmwareUpgrade_shutDown(FIRMWAREUPGHANDLE)
void * FIRMWAREUPGHANDLE
Definition: FirmwareUpgrade.h:37
eErr
Definition: CCAuxTypes.h:159
EXTERN_C CCAUXDLL_API FIRMWAREUPGHANDLE CCAUXDLL_CALLING_CONV GetFirmwareUpgrade(void)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV FirmwareUpgrade_startFpgaVerification(FIRMWAREUPGHANDLE, const char_t *filename, bool blocking)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV FirmwareUpgrade_startFrontUpgrade(FIRMWAREUPGHANDLE, const char_t *filename, bool blocking)
Definition: CCAuxTypes.h:428
Definition: About.h:30
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV FirmwareUpgrade_startSSVerification(FIRMWAREUPGHANDLE, const char_t *filename, bool blocking)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV FirmwareUpgrade_startFpgaUpgrade(FIRMWAREUPGHANDLE, const char_t *filename, bool blocking)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV FirmwareUpgrade_getUpgradeStatus(FIRMWAREUPGHANDLE, UpgradeStatus *status, bool blocking)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV FirmwareUpgrade_startFrontVerification(FIRMWAREUPGHANDLE, const char_t *filename, bool blocking)
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV FirmwareUpgrade_release(FIRMWAREUPGHANDLE)
char char_t
Definition: CCAuxTypes.h:27
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV FirmwareUpgrade_startSSUpgrade(FIRMWAREUPGHANDLE, const char_t *filename, bool blocking)