/**********************************************************************//**
 *
 *  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 ModeFlush.c
 *
 *  @date 20-Dec-2019
 *  @author S. Nash
 *
 *  @brief Top-level state machine for flush mode.
 *
 *************************************************************************/

#include "ModeFlush.h"
#include "OperationModes.h"

/**
 *  @addtogroup FlushMode
 *  @{
 */

// ********** private definitions **********

/// Enumeration of flush mode states.
typedef enum Flush_States
{
    FLUSH_STATE_START = 0,                               ///< Start flush mode state.
    NUM_OF_FLUSH_STATES                                  ///< Number of flush mode states.
} FLUSH_STATE_T;

// ********** private data **********

static FLUSH_STATE_T flushState = FLUSH_STATE_START;     ///< Currently active flush state.

// ********** private function prototypes **********

/*********************************************************************//**
 * @brief
 * The initFlushMode function initializes flush Mode module.
 * @details
 * Inputs : none
 * Outputs : none
 * @return none
*************************************************************************/
void initFlushMode( void )
{
    flushState = FLUSH_STATE_START;
}

/*********************************************************************//**
 * @brief
 * The transitionToFlushMode function prepares for transition to \n
 * flush mode.
 * @details
 * Inputs : none
 * Outputs :
 * @return none
*************************************************************************/
void transitionToFlushMode( void )
{
    initFlushMode();
}

/*********************************************************************//**
 * @brief
 * The execFlushMode function executes the flush Mode state machine.
 * @details
 * Inputs : none
 * Outputs :
 * @return none
*************************************************************************/
void execFlushMode( void )
{
    // execute current flush state
    switch ( flushState )
    {
        case FLUSH_STATE_START:
            break;

        default:
            flushState = FLUSH_STATE_START;
            // TODO - s/w fault
            break;
    }
}

/**@}*/