CCAux  2.17.0.0
CCAux API reference
AuxVersion.h
Go to the documentation of this file.
1 /************************************************
2 *
3 * CROSSCONTROL AUX API
4 *
5 * AuxVersion.h
6 *
7 * Version 2.17.0.0", 2019-10-22
8 *
9 * (c) CrossControl 2010-2019
10 *
11 
12  * File description:
13  * Get software versions for firmware and software
14  *
15  * Use the function GetAuxVersion() to get a handle to pass on to the other functions.
16  * Use the method AuxVersion_release(AUXVERSIONHANDLE) to return the handle.
17  *
18  * Example Usage:
19  * @include auxversion_example.cpp
20  *
21  ************************************************/
22 
23 #ifndef CC_VERSION_H_
24 #define CC_VERSION_H_
25 
26 #include "CCAuxErrors.h"
27 #include "CCPlatform.h"
28 
29 #ifdef __cplusplus
30 namespace CrossControl {
31 #endif
32 
33  typedef void* AUXVERSIONHANDLE;
34 
54  EXTERN_C
55  CCAUXDLL_API
56  AUXVERSIONHANDLE
57  CCAUXDLL_CALLING_CONV
58  GetAuxVersion(void);
59 
70  EXTERN_C
71  CCAUXDLL_API
72  void
73  CCAUXDLL_CALLING_CONV
74  AuxVersion_release(AUXVERSIONHANDLE);
75 
91  EXTERN_C
92  CCAUXDLL_API
93  eErr
94  CCAUXDLL_CALLING_CONV
95  AuxVersion_getFPGAVersion(
96  AUXVERSIONHANDLE,
97  uint8_t* major,
98  uint8_t* minor,
99  uint8_t* release,
100  uint8_t* build);
101 
117  EXTERN_C
118  CCAUXDLL_API
119  eErr
120  CCAUXDLL_CALLING_CONV
121  AuxVersion_getSSVersion(
122  AUXVERSIONHANDLE,
123  uint8_t* major,
124  uint8_t* minor,
125  uint8_t* release,
126  uint8_t* build);
127 
143  EXTERN_C
144  CCAUXDLL_API
145  eErr
146  CCAUXDLL_CALLING_CONV
147  AuxVersion_getFrontVersion(
148  AUXVERSIONHANDLE,
149  uint8_t* major,
150  uint8_t* minor,
151  uint8_t* release,
152  uint8_t* build);
153 
171  EXTERN_C
172  CCAUXDLL_API
173  eErr
174  CCAUXDLL_CALLING_CONV
175  AuxVersion_getCCAuxVersion(
176  AUXVERSIONHANDLE,
177  uint8_t* major,
178  uint8_t* minor,
179  uint8_t* release,
180  uint8_t* build);
181 
197  EXTERN_C
198  CCAUXDLL_API
199  eErr
200  CCAUXDLL_CALLING_CONV
201  AuxVersion_getOSVersion(
202  AUXVERSIONHANDLE,
203  uint8_t* major,
204  uint8_t* minor,
205  uint8_t* release,
206  uint8_t* build);
207 
224  EXTERN_C
225  CCAUXDLL_API
226  eErr
227  CCAUXDLL_CALLING_CONV
228  AuxVersion_getCCAuxDrvVersion(
229  AUXVERSIONHANDLE,
230  uint8_t* major,
231  uint8_t* minor,
232  uint8_t* release,
233  uint8_t* build);
234 
250  EXTERN_C
251  CCAUXDLL_API
252  eErr
253  CCAUXDLL_CALLING_CONV
254  AuxVersion_getCanFdMcuVersion(
255  AUXVERSIONHANDLE,
256  uint8_t* major,
257  uint8_t* minor,
258  uint8_t* release,
259  uint8_t* build);
260 
276  EXTERN_C
277  CCAUXDLL_API
278  eErr
279  CCAUXDLL_CALLING_CONV
280  AuxVersion_getCanFdApiVersion(
281  AUXVERSIONHANDLE,
282  uint8_t* major,
283  uint8_t* minor,
284  uint8_t* release,
285  uint8_t* build);
286 
304  EXTERN_C
305  CCAUXDLL_API
306  eErr
307  CCAUXDLL_CALLING_CONV
308  AuxVersion_getFullOSVersion(
309  AUXVERSIONHANDLE,
310  uint8_t* major,
311  uint8_t* minor,
312  uint8_t* release,
313  uint8_t* build,
314  char_t* tag,
315  uint32_t len);
316 
337  EXTERN_C
338  CCAUXDLL_API
339  eErr
340  CCAUXDLL_CALLING_CONV
341  AuxVersion_getFullCCAuxVersion(
342  AUXVERSIONHANDLE,
343  uint8_t* major,
344  uint8_t* minor,
345  uint8_t* release,
346  uint8_t* build,
347  char_t* tag,
348  uint32_t len);
349 
350 #ifdef __cplusplus
351 } /* namespace CrossControl */
352 #endif
353 
354 #endif /* CC_VERSION_H_ */
355 
CrossControl::AuxVersion_getFPGAVersion
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getFPGAVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
CrossControl::eErr
eErr
Definition: CCAuxTypes.h:159
CCPlatform.h
CrossControl::AuxVersion_getCanFdMcuVersion
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getCanFdMcuVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
CrossControl::AuxVersion_getCCAuxVersion
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getCCAuxVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
CrossControl
Definition: About.h:30
CrossControl::AuxVersion_getFullCCAuxVersion
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getFullCCAuxVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build, char_t *tag, uint32_t len)
uint32_t
unsigned int uint32_t
Definition: CCAuxTypes.h:49
CrossControl::AuxVersion_getCCAuxDrvVersion
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getCCAuxDrvVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
CrossControl::AuxVersion_getSSVersion
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getSSVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
uint8_t
unsigned char uint8_t
Definition: CCAuxTypes.h:47
CCAuxErrors.h
CrossControl::AuxVersion_release
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV AuxVersion_release(AUXVERSIONHANDLE)
CrossControl::AuxVersion_getCanFdApiVersion
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getCanFdApiVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
CrossControl::AUXVERSIONHANDLE
void * AUXVERSIONHANDLE
Definition: AuxVersion.h:33
CrossControl::AuxVersion_getFullOSVersion
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getFullOSVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build, char_t *tag, uint32_t len)
CrossControl::GetAuxVersion
EXTERN_C CCAUXDLL_API AUXVERSIONHANDLE CCAUXDLL_CALLING_CONV GetAuxVersion(void)
CrossControl::AuxVersion_getFrontVersion
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getFrontVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
char_t
char char_t
Definition: CCAuxTypes.h:27
CrossControl::AuxVersion_getOSVersion
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV AuxVersion_getOSVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release, uint8_t *build)
Generated on Tue Oct 22 2019 17:00:44 for CCAux by   doxygen 1.8.14