/**************************************************************************
*
* Copyright (c) 2019-2021 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    ModeFault.h
*
* @author  (last)      Sean Nash
* @date    (last)      06-Feb-2021
*
* @author  (original)  Dara Navaei
* @date    (original)  05-Nov-2019
*
***************************************************************************/

#ifndef __MODE_FAULT_H__
#define __MODE_FAULT_H__

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

/**
 *  @defgroup HDFaultMode HDFaultMode
 *  @brief FaultMode module.
 *
 *  @addtogroup HDFaultMode
 *  @{
 */

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

void initFaultMode( void );                                 // Initialize this module
U32  transitionToFaultMode( void );                         // Prepares for transition to fault mode
U32  execFaultMode( void );                                 // Execute the fault mode state machine (call from OperationModes)
void signalAlarmActionToFaultMode( ALARM_ACTION_T action ); // Execute alarm action as appropriate for fault mode

/**@}*/

#endif