Index: firmware/App/Modes/ModeFault.h =================================================================== diff -u -rb64c49fdcf2b6d95e61e63f8e258c4e600935bbd -r7d4711edd7b40cd3e29f43e766f79a8a09586fe9 --- firmware/App/Modes/ModeFault.h (.../ModeFault.h) (revision b64c49fdcf2b6d95e61e63f8e258c4e600935bbd) +++ firmware/App/Modes/ModeFault.h (.../ModeFault.h) (revision 7d4711edd7b40cd3e29f43e766f79a8a09586fe9) @@ -1,28 +1,46 @@ /************************************************************************** - * - * Copyright (c) 2019-2020 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 - * - * @date 19-Sep-2019 - * @author S. Nash - * - * @brief Header file for Fault Mode. - * - **************************************************************************/ +* +* Copyright (c) 2019-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) Sean Nash +* @date (last) 20-Dec-2022 +* +* @author (original) Dara Navaei +* @date (original) 05-Nov-2019 +* +***************************************************************************/ #ifndef __MODE_FAULT_H__ #define __MODE_FAULT_H__ #include "DGCommon.h" +#include "DGDefs.h" -// ********** private function prototypes ********** +/** + * @defgroup DGFaultMode DGFaultMode + * @brief Fault mode module. Manages fault mode functions via a state machine. + * + * @addtogroup DGFaultMode + * @{ + */ +// ********** public definitions ********** + +// ********** public function prototypes ********** + void initFaultMode( void ); // initialize this module -void transitionToFaultMode( void ); // prepares for transition to fault mode -void execFaultMode( void ); // execute the fault mode state machine (call from OperationModes) +U32 transitionToFaultMode( void ); // prepares for transition to fault mode +U32 execFaultMode( void ); // execute the fault mode state machine (call from OperationModes) +DG_FAULT_STATE_T getCurrentFaultState( void ); // get the current state of the fault mode. + +void deenergizeActuators( BOOL parkPumps ); + +/**@}*/ + #endif