Index: firmware/App/Modes/ModeFault.h =================================================================== diff -u -reff7b1575f008f81b29ef906f6346fac6012d3ab -r8e7158d8231435496fcf1d5649e51babf859ccc7 --- firmware/App/Modes/ModeFault.h (.../ModeFault.h) (revision eff7b1575f008f81b29ef906f6346fac6012d3ab) +++ firmware/App/Modes/ModeFault.h (.../ModeFault.h) (revision 8e7158d8231435496fcf1d5649e51babf859ccc7) @@ -1,26 +1,40 @@ /************************************************************************** - * - * Copyright (c) 2019-2019 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-2021 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) 29-May-2020 +* +* @author (original) Dara Navaei +* @date (original) 05-Nov-2019 +* +***************************************************************************/ #ifndef __MODE_FAULT_H__ #define __MODE_FAULT_H__ +#include "HDCommon.h" +#include "HDDefs.h" + +/** + * @defgroup HDFaultMode HDFaultMode + * @brief FaultMode module. + * + * @addtogroup HDFaultMode + * @{ + */ + // ********** private function prototypes ********** -void initFaultMode( void ); // initialize this module +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) +/**@}*/ + #endif