/**************************************************************************
 *
 *  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 ModeDrain.c
 *
 *  @date 20-Dec-2019
 *  @author L. Baloa
 *
 *  @brief Top-level state machine for the drain mode.
 *
 **************************************************************************/

#include "DrainPump.h"
#include "ModeDrain.h"
#include "OperationModes.h"

/**
 *  @addtogroup DrainMode
 *  @{
 */

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

#define TARGET_DRAIN_PUMP_RPM       2000                    ///< Target drain pump speed.

/// Enumeration of drain mode states.
typedef enum Drain_States
{
    DRAIN_STATE_START = 0,                                  ///< Start drain mode state.
    DRAIN_STATE_DRAIN,                                      ///< Drain drain mode state.
    NUM_OF_DRAIN_STATES                                     ///< Number of drain mode states.
} DRAIN_STATE_T;

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

static DRAIN_STATE_T drainState = DRAIN_STATE_START;        ///< Currently active drain state.

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

static DRAIN_STATE_T handleDrainState( void );

/*********************************************************************//**
 * @brief
 * The initOpParamsMode function initializes the Drain Mode module.
 * @details
 * Inputs : none
 * Outputs : Operating Parameters Mode module initialized.
 * @return none
 *************************************************************************/
void initDrainMode( void )
{
    drainState = DRAIN_STATE_START;
}

/*********************************************************************//**
 * @brief
 * The transitionToDrainMode function prepares for transition to drain \n
 * mode.
 * @details
 * Inputs : none
 * Outputs :
 * @return none
 *************************************************************************/
void transitionToDrainMode( void )
{
    // re-initialize each time we transition to drain mode
    initDrainMode();

    // TODO - set initial actuator states
    // VDr to drain
}

/*********************************************************************//**
 * @brief
 * The execDrainMode function executes the Drain Mode state machine.
 * @details
 * Inputs : none
 * Outputs :
 * @return none
 *************************************************************************/
void execDrainMode( void )
{
    // execute current drain state
    switch ( drainState )
    {
        case DRAIN_STATE_START:
            setDrainPumpTargetSpeed( TARGET_DRAIN_PUMP_RPM );
            drainState = DRAIN_STATE_DRAIN;
            break;

        case DRAIN_STATE_DRAIN:
            drainState = handleDrainState();
            break;

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

/*********************************************************************//**
 * @brief
 * The handleDrainState function handles the drain state  of the Drain Mode \n
 * state machine.
 * @details
 * Inputs : none
 * Outputs :
 * @return the next state
 *************************************************************************/
static DRAIN_STATE_T handleDrainState( void )
{
    DRAIN_STATE_T result = DRAIN_STATE_DRAIN;

    return result;
}

/**@}*/