/**********************************************************************//**
 *
 *  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 ModeFill.c
 *
 *  @date 19-Nov-2019
 *  @author L. Baloa
 *
 *  @brief Top-level state machine for the fill mode.
 *
 **************************************************************************/

#include "OperationModes.h"
#include "Timers.h"
#include "ModeFill.h"

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

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

#define QUARTER_SECOND   250
#define HALF_SECOND      500

typedef enum Fill_Mode_States
{
    FILL_MODE_STATE_START = 0,
    FILL_MODE_STATE_CHECK_INLET_WATER,
    FILL_MODE_STATE_CREATE_PRODUCT_WATER,
    FILL_MODE_STATE_DIALYSATE_PRODUCTION,
    FILL_MODE_STATE_DELIVER_DIALYSATE,
    NUM_OF_FILL_MODE_STATES
} FILL_MODE_STATE_T;

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

static FILL_MODE_STATE_T fillState;

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

static FILL_MODE_STATE_T handleCheckInletWaterState( void );
static FILL_MODE_STATE_T handleCreateProductWaterState( void );
static FILL_MODE_STATE_T handleDialysateProductionState( void );
static FILL_MODE_STATE_T handleDeliverDialysateState( void );

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

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

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

        case FILL_MODE_STATE_CHECK_INLET_WATER:
            fillState = handleCheckInletWaterState();
            break;

        case FILL_MODE_STATE_CREATE_PRODUCT_WATER:
            fillState = handleCreateProductWaterState();
            break;

        case FILL_MODE_STATE_DIALYSATE_PRODUCTION:
            fillState = handleDialysateProductionState();
            break;

        case FILL_MODE_STATE_DELIVER_DIALYSATE:
            fillState = handleDeliverDialysateState();
            break;

        default:
            // TODO - s/w fault
            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 FILL_MODE_STATE_T handleCheckInletWaterState( void )
{
    FILL_MODE_STATE_T result = FILL_MODE_STATE_CHECK_INLET_WATER;

    return result;
}

/*********************************************************************//**
 * @brief
 * The handleCreateProductWaterState 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 FILL_MODE_STATE_T handleCreateProductWaterState( void )
{
    FILL_MODE_STATE_T result = FILL_MODE_STATE_CREATE_PRODUCT_WATER;

    return result;
}

/*********************************************************************//**
 * @brief
 * The handleDialysateProductionState function executes the Dialysate Production \n
 * state of the Fill Mode state machine.
 * @details
 * Inputs : none
 * Outputs :
 * @param none
 * @return the next state
 *************************************************************************/
static FILL_MODE_STATE_T handleDialysateProductionState( void )
{
    FILL_MODE_STATE_T result = FILL_MODE_STATE_DIALYSATE_PRODUCTION;

    return result;
}

/*********************************************************************//**
 * @brief
 * The handleDeliverDialysateState function executes the Deliver Dialysate \n
 * state of the Fill Mode state machine.
 * @details
 * Inputs : none
 * Outputs :
 * @param none
 * @return the next state
 *************************************************************************/
static FILL_MODE_STATE_T handleDeliverDialysateState( void )
{
    FILL_MODE_STATE_T result = FILL_MODE_STATE_DELIVER_DIALYSATE;

    return result;
}