AuxVersion.h

Go to the documentation of this file.

 
/*
 * Copyright (C) 2023 CrossControl AB
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; with
 * version 2.1 of the License.
 */
/*
 *  File description:
 *  Get software versions for firmware and software
 *
 *  Use the function GetAuxVersion() to get a handle to pass on to the other functions.
 *  Use the method AuxVersion_release(AUXVERSIONHANDLE) to return the handle.
 *
 *  Example Usage:
 *  @include auxversion_example.cpp
 *
 ************************************************/
 
#ifndef CC_VERSION_H_
#define CC_VERSION_H_
 
#include "CCAuxErrors.h"
#include "CCPlatform.h"
 
#ifdef __cplusplus
namespace CrossControl
{
#endif
 
typedef void *AUXVERSIONHANDLE;
 
EXTERN_C
CCAUXDLL_API
AUXVERSIONHANDLE
CCAUXDLL_CALLING_CONV
GetAuxVersion(void);
 
EXTERN_C
CCAUXDLL_API
void CCAUXDLL_CALLING_CONV AuxVersion_release(AUXVERSIONHANDLE);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV AuxVersion_getFPGAVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release,
                                                     uint8_t *build);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV AuxVersion_getSSVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release,
                                                   uint8_t *build);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV AuxVersion_getFullSSVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor,
                                                       uint8_t *release, uint8_t *build, char_t *tag, uint32_t len);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV AuxVersion_getFrontVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor,
                                                      uint8_t *release, uint8_t *build);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV AuxVersion_getDMCUVersion(AUXVERSIONHANDLE, int index, uint8_t *major, uint8_t *minor,
                                                     uint8_t *release, uint8_t *build);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV AuxVersion_getIOMCUVersion(AUXVERSIONHANDLE, int index, uint8_t *major, uint8_t *minor,
                                                      uint8_t *release, uint8_t *build);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV AuxVersion_getCCAuxVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor,
                                                      uint8_t *release, uint8_t *build);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV AuxVersion_getOSVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor, uint8_t *release,
                                                   uint8_t *build);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV AuxVersion_getCCAuxDrvVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor,
                                                         uint8_t *release, uint8_t *build);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV AuxVersion_getCanFdMcuVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor,
                                                         uint8_t *release, uint8_t *build);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV AuxVersion_getAllCanFdMcuVersions(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor,
                                                             uint8_t *release, uint8_t *build, int index);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV AuxVersion_getCanFdApiVersion(AUXVERSIONHANDLE, uint8_t *major, uint8_t *minor,
                                                         uint8_t *release, uint8_t *build);
 
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);
 
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);
 
#ifdef __cplusplus
} /* namespace CrossControl */
#endif
 
#endif /* CC_VERSION_H_ */