/**************************************************************************
*
* Copyright (c) 2019-2023 Diality Inc. - All Rights Reserved.
*
* THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN
* WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER.
*
* @file    ModeInitPOST.h
*
* @author  (last)      Sean Nash
* @date    (last)      13-Apr-2023
*
* @author  (original)  Dara Navaei
* @date    (original)  05-Nov-2019
*
***************************************************************************/

#ifndef __MODE_INIT_POST_H__
#define __MODE_INIT_POST_H__

#include "HDCommon.h"
#include "HDDefs.h"

/**
 *  @defgroup HDInitAndPOSTMode HDInitAndPOSTMode
 *  @brief Initialization and POST mode module. Manages initialization and POST
 *  mode functions via a state machine.
 *
 *  @addtogroup HDInitAndPOSTMode
 *  @{
 */

// ********** public function prototypes **********

void initInitAndPOSTMode( void );                                   // Initialize this module
U32  transitionToInitAndPOSTMode( void );                           // Prepares for transition to init. & POST mode
U32  execInitAndPOSTMode( void );                                   // Execute the init. & POST mode state machine (call from OperationModes)
BOOL isPOSTCompleted( void );                                       // Determine whether POST has completed yet
BOOL isPOSTPassed( void );                                          // Determine whether POST has passed
BOOL isDGPOSTPassed( void );                                        // Determine whether DG POST has passed
void signalAlarmActionToInitAndPOSTMode( ALARM_ACTION_T action );   // Execute alarm action as appropriate for fault mode
void signalUIPOSTFinalResult( BOOL passed );                        // Record UI POST result
void signalDGPOSTFinalResult( BOOL passed );                        // Record DG POST result
void signalUIVersion( UI_VERSIONS_T version );                      // Record UI version info
void signalDGVersion( DG_VERSIONS_T version );                      // Record DG version info
DG_VERSIONS_T getDGVersion( void );                                 // Get DG version info
BOOL getDGPOSTPassed( void );                                       // Get DG POST pass/fail status

/**@}*/

#endif