/**************************************************************************
*
* Copyright (c) 2024-2024 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)      Vinayakam Mani
* @date    (last)      06-Aug-2024
*
* @author  (original)  Vinayakam Mani
* @date    (original)  06-Aug-2024
*
***************************************************************************/

#ifndef __MODE_FAULT_H__
#define __MODE_FAULT_H__

#include "DDCommon.h"
#include "DDDefs.h"

/**
 *  @defgroup DDFaultMode DDFaultMode
 *  @brief Fault mode unit. Manages fault mode functions via a state machine.
 *
 *  @addtogroup DDFaultMode
 *  @{
 */

// ********** public definitions **********

// ********** 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)

DD_FAULT_STATE_T getCurrentFaultState( void );  // get the current state of the fault mode.

void deenergizeActuators( BOOL parkPumps );

/**@}*/

#endif