FirmwareUpgrade.h

Go to the documentation of this file.

/************************************************
 *
 *  CROSSCONTROL AUX API
 *
 *  FirmwareUpgrade.h
 *
 *  Version 2.15.2.0, 2020-07-08
 *
 *  (c) CrossControl 2010-2020
 *

 *  File description: 
 *  Firmware upgrade of the system's microprocessors and FPGA.
 *
 *  Use the function GetFirmwareUpgrade() to get a handle to pass on to the other functions. 
 *  Use the method FirmwareUpgrade_release(FIRMWAREUPGHANDLE) to return the handle.
 *
 *  XA platform: Note that if you do several upgrades/verifications in a row, 
 *  the FirmwareUpgrade object should be released and reinitialised between 
 *  each operation: 
 *  FirmwareUpgrade_release(pObj); pObj = ::GetFirmwareUpgrade();
 *
 *  Example Usage:
 *  @include firmwareupgrade_example.cpp
 ************************************************/

#ifndef CC_FIRMWAREUPG_H_
#define CC_FIRMWAREUPG_H_

#include "CCAuxErrors.h"
#include "CCPlatform.h"

#ifdef __cplusplus
namespace CrossControl {
#endif

  typedef void* FIRMWAREUPGHANDLE;

  EXTERN_C
    CCAUXDLL_API
    FIRMWAREUPGHANDLE
    CCAUXDLL_CALLING_CONV
    GetFirmwareUpgrade(void);

  EXTERN_C
    CCAUXDLL_API
    void
    CCAUXDLL_CALLING_CONV
    FirmwareUpgrade_release(FIRMWAREUPGHANDLE);

  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_startFpgaVerification (FIRMWAREUPGHANDLE, const char_t* filename, bool blocking);

  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    FirmwareUpgrade_startSSUpgrade(FIRMWAREUPGHANDLE, const char_t* filename, bool blocking);

  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_startFrontUpgrade(FIRMWAREUPGHANDLE, const char_t* filename, bool blocking);

  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    FirmwareUpgrade_startFrontVerification (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_shutDown(FIRMWAREUPGHANDLE);

#ifdef __cplusplus
} /* namespace CrossControl */
#endif

#endif /* CC_FIRMWAREUPG_H_ */