/**********************************************************************//**
 *
 *  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.c
 *
 *  @date 19-Sep-2019
 *  @author S. Nash
 *
 *  @brief Top-level state machine for the fault mode.
 *
 **************************************************************************/

#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
 * The initFaultMode function initializes the Fault Mode module.
 * @details
 * Inputs : none
 * Outputs : Fault Mode module initialized.
 * @return none
 *************************************************************************/
void initFaultMode( void )
{
    faultState = FAULT_STATE_START;
}

/*********************************************************************//**
 * @brief
 * The transitionToFaultMode function prepares for transition to fault mode.
 * @details
 * Inputs : none
 * Outputs :
 * @return none
 *************************************************************************/
void transitionToFaultMode( void )
{
}

/*********************************************************************//**
 * @brief
 * The execFaultMode function executes the Fault Mode state machine.
 * @details
 * Inputs : none
 * Outputs :
 * @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;
    }
}

/**@}*/