Index: firmware/App/Modes/ModeFault.c =================================================================== diff -u -r499e5de29e706d09f79ba22511068990c4044e84 -rc48a99d2d1c852adcc986253b6c420a90dab7bfe --- firmware/App/Modes/ModeFault.c (.../ModeFault.c) (revision 499e5de29e706d09f79ba22511068990c4044e84) +++ firmware/App/Modes/ModeFault.c (.../ModeFault.c) (revision c48a99d2d1c852adcc986253b6c420a90dab7bfe) @@ -1,4 +1,4 @@ -/************************************************************************** +/**********************************************************************//** * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * @@ -17,46 +17,72 @@ #include "OperationModes.h" #include "ModeFault.h" +/** + * @addtogroup FaultMode + * @{ + */ + +// ********** private definitions ********** + +/// Enumeration of fault mode states. +typedef enum Fault_States +{ + FAULT_STATE_START = 0, ///< Start solo fault state. + NUM_OF_FAULT_STATES ///< Number of fault mode states. +} FAULT_STATE_T; + // ********** private data ********** +static FAULT_STATE_T faultState = FAULT_STATE_START; ///< Currently active fault state. + // ********** private function prototypes ********** -/************************************************************************* - * @brief initFaultMode +/*********************************************************************//** + * @brief * The initFaultMode function initializes the Fault Mode module. * @details * Inputs : none * Outputs : Fault Mode module initialized. - * @param none * @return none *************************************************************************/ void initFaultMode( void ) { + faultState = FAULT_STATE_START; } -/************************************************************************* - * @brief transitionToFaultMode +/*********************************************************************//** + * @brief * The transitionToFaultMode function prepares for transition to fault mode. * @details * Inputs : none * Outputs : - * @param none * @return none *************************************************************************/ void transitionToFaultMode( void ) { } -/************************************************************************* - * @brief execFaultMode +/*********************************************************************//** + * @brief * The execFaultMode function executes the Fault Mode state machine. * @details * Inputs : none * Outputs : - * @param none * @return none *************************************************************************/ void execFaultMode( void ) { + // execute current fault state + switch ( faultState ) + { + case FAULT_STATE_START: + break; + + default: + faultState = FAULT_STATE_START; + // TODO - s/w fault + break; + } } +/**@}*/