Index: firmware/App/Modes/ModeFault.h =================================================================== diff -u -rb64c49fdcf2b6d95e61e63f8e258c4e600935bbd -r4efb2d1786c717ca6cf4b1bc992cec8e16820bff --- firmware/App/Modes/ModeFault.h (.../ModeFault.h) (revision b64c49fdcf2b6d95e61e63f8e258c4e600935bbd) +++ firmware/App/Modes/ModeFault.h (.../ModeFault.h) (revision 4efb2d1786c717ca6cf4b1bc992cec8e16820bff) @@ -1,4 +1,4 @@ -/************************************************************************** +/**********************************************************************//** * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * @@ -18,11 +18,27 @@ #define __MODE_FAULT_H__ #include "DGCommon.h" +#include "DGDefs.h" +/** + * @defgroup DGFaultMode DGFaultMode + * @brief Fault mode module. + * Manages fault mode functions via a state machine. + * + * @addtogroup DGFaultMode + * @{ + */ + +// ********** public definitions ********** + // ********** private 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 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. + +/**@}*/ + #endif