/**********************************************************************//**
 *
 *  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 ModeRecirculate.c
 *
 *  @date 03-Apr-2020
 *  @author S. Nash
 *
 *  @brief Top-level state machine for the re-circulate mode.
 *
 **************************************************************************/

#include "OperationModes.h"
#include "Timers.h"
#include "ModeRecirculate.h"

#ifdef RM46_EVAL_BOARD_TARGET
    #include "CPLD.h"
#endif

/**
 *  @addtogroup RecirculateMode
 *  @{
 */

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

/// Enumberation of re-circulation mode states.
typedef enum Recirculate_Mode_States
{
    RECIRCULATE_MODE_STATE_START = 0,                          ///< Start re-circulation mode state.
    RECIRCULATE_MODE_STATE_CHECK_INLET_WATER,                  ///< Check inlet water state.
    RECIRCULATE_MODE_STATE_RECIRC_PRODUCT_WATER,               ///< Re-circulate product water state.
    NUM_OF_RECIRCULATE_MODE_STATES                             ///< Number of fill mode states.
} RECIRCULATE_MODE_STATE_T;

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

static RECIRCULATE_MODE_STATE_T recircState;                   ///< Currently active re-circulation state.

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

static RECIRCULATE_MODE_STATE_T handleCheckInletWaterState( void );
static RECIRCULATE_MODE_STATE_T handleRecircProductWaterState( void );

/*********************************************************************//**
 * @brief initFillMode
 * The initFillMode function initializes the Fill Mode module.
 * @details
 * Inputs : none
 * Outputs : Fill Mode module initialized.
 * @return none
 *************************************************************************/
void initRecirculateMode( void )
{
    recircState = RECIRCULATE_MODE_STATE_START;
}

/*********************************************************************//**
 * @brief transitionToFillMode
 * The transitionToFillMode function prepares for transition to \n
 * fill mode.
 * @details
 * Inputs : none
 * Outputs : fillState
 * @return none
 *************************************************************************/
void transitionToRecirculateMode( void )
{
    recircState = RECIRCULATE_MODE_STATE_START;
}

/*********************************************************************//**
 * @brief execFillMode
 * The execFillMode function executes the Fill Mode state machine.
 * @details
 * Inputs : fillState
 * Outputs : fillState
 * @return none
 *************************************************************************/
void execRecirculateMode( void )
{
    // execute current Fill state
    switch ( recircState )
    {
        case RECIRCULATE_MODE_STATE_START:
            recircState = RECIRCULATE_MODE_STATE_CHECK_INLET_WATER;
            break;

        case RECIRCULATE_MODE_STATE_CHECK_INLET_WATER:
            recircState = handleCheckInletWaterState();
            break;

        case RECIRCULATE_MODE_STATE_RECIRC_PRODUCT_WATER:
            recircState = handleRecircProductWaterState();
            break;

        default:
            SET_ALARM_WITH_2_U32_DATA( ALARM_ID_SOFTWARE_FAULT, 0, recircState )     // TODO - add s/w fault enum to 1st data param
            recircState = RECIRCULATE_MODE_STATE_START;
            break;
    }
}

/*********************************************************************//**
 * @brief
 * The handleCheckInletWaterState function executes the Check Inlet Water \n
 * state of the Fill Mode state machine.
 * @details
 * Inputs : none
 * Outputs :
 * @param none
 * @return the next state
 *************************************************************************/
static RECIRCULATE_MODE_STATE_T handleCheckInletWaterState( void )
{
    RECIRCULATE_MODE_STATE_T result = RECIRCULATE_MODE_STATE_CHECK_INLET_WATER;

    return result;
}

/*********************************************************************//**
 * @brief
 * The handleRecircProductWaterState function executes the Create Product \n
 * Water state of the Fill Mode state machine.
 * @details
 * Inputs : none
 * Outputs :
 * @param none
 * @return the next state
 *************************************************************************/
static RECIRCULATE_MODE_STATE_T handleRecircProductWaterState( void )
{
    RECIRCULATE_MODE_STATE_T result = RECIRCULATE_MODE_STATE_RECIRC_PRODUCT_WATER;

    return result;
}

/**@}*/