/**************************************************************************
*
* Copyright (c) 2024-2025 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)      26-Aug-2024
*
* @author  (original)  Sean Nash
* @date    (original)  01-Aug-2024
*
***************************************************************************/

#ifndef __MODE_FAULT_H__
#define __MODE_FAULT_H__

#include "TDCommon.h"
#include "TDDefs.h"

/**
 *  @defgroup TDFaultMode TDFaultMode
 *  @brief FaultMode unit.
 *
 *  @addtogroup TDFaultMode
 *  @{
 */

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

void initFaultMode( void );                                 // Initialize this unit
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