/**************************************************************************
*
* 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    FPModeFault.c
*
* @author  (last)      Michael Garthwaite
* @date    (last)      28-Feb-2025
*
* @author  (original)  Michael Garthwaite
* @date    (original)  28-Feb-2025
*
***************************************************************************/

#ifndef __MODE_FP_FAULT_H__
#define __MODE_FP_FAULT_H__

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

/**
 *  @defgroup FPFaultMode FPFaultMode
 *  @brief FaultMode unit. Manages fault mode functions via state machine.
 *
 *  @addtogroup FPFaultMode
 *  @{
 */

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

void initFPFaultMode( void );                                 // Initialize this unit
U32  transitionToFPFaultMode( void );                         // Prepares for transition to fault mode
U32  execFPFaultMode( void );                                 // Execute the fault mode state machine (call from OperationModes)

FP_FAULT_STATE_T getCurrentFPFaultState( void );  // get the current state of the fault mode.
void deEnergizeFPActuators( BOOL isDrainEnabled );

/**@}*/

#endif