/**************************************************************************
 *
 *  Copyright (c) 2020-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 Valves.h
 *
 *  @date 21-Apr-2020
 *  @author P. Montazemi
 *
 *  @brief Valves header file.
 *
 **************************************************************************/

#ifndef __VALVES_H__
#define __VALVES_H__

#include "DGCommon.h"

/**
 *  @defgroup Valves Valves
 *  @brief Valves driver module.
 *  Controls valves.
 *
 *  @addtogroup Valves
 *  @{
 */

// ********** public definitions **********

/// Enumeration of available valve state names per valve type (from SA and DG SRS documents)
typedef enum ValveStateNames
{
    VALVE_STATE_OPEN = 0,       ///< Open valve state, used only for VPi, VBf, and VSP
    VALVE_STATE_CLOSED,         ///< Closed valve state, used only for VPi, VBf, and VSP
    VALVE_STATE_OPEN_C_TO_NO,   ///< Open Common to Normally Open valve state, used only for VPd
    VALVE_STATE_DRAIN_C_TO_NC,  ///< Drain Common to Normally Closed valve state, used only for VPd
    VALVE_STATE_NOFILL_C_TO_NO, ///< No Fill Common to Normally Open valve state, used only for VPo
    VALVE_STATE_FILL_C_TO_NC,   ///< Fill Common to Normally Closed valve state, used only for VPo
    VALVE_STATE_DRAIN_C_TO_NO,  ///< Drain Common to Normally Open valve state, used only for VDr and VRc
    VALVE_STATE_RECIRC_C_TO_NC, ///< Recirculate Common to Normally Closed valve state, used only for VDr and VRc
    VALVE_STATE_R1_C_TO_NO,     ///< Reservoir 1 Common to Normally Open valve state, used only for VRo and VRi
    VALVE_STATE_R1_C_TO_NC,     ///< Reservoir 1 Common to Normally Closed valve state, used only for VRd and VRf
    VALVE_STATE_R2_C_TO_NO,     ///< Reservoir 2 Common to Normally Open valve state, used only for VRd and VRf
    VALVE_STATE_R2_C_TO_NC,     ///< Reservoir 2 Common to Normally Closed valve state, used only for VRo and VRi
    NUM_OF_VALVE_STATES         ///< number of valve states
} VALVE_STATE_NAMES_T;

/// Enumeration of valves
typedef enum Valves
{
    VRF = 0,          ///< Valve Reservoir Fill
    VRI,              ///< Valve Reservoir Inlet
    VRD,              ///< Valve Reservoir Drain
    VRO,              ///< Valve Reservoir Outlet
    VPO,              ///< Valve Pressure Outlet
    VBF,              ///< Valve Bypass Filter
    VRC,              ///< Valve Recirculate
    VDR,              ///< Valve Drain
    VPI,              ///< Valve Pressure Inlet
    VSP,              ///< Valve Sampling Port
    VR1,              ///< Valve Reservoir 1 (spare for now including DG FPGA, as valve is of passive air relief type)
    VR2,              ///< Valve Reservoir 2 (spare for now including DG FPGA, as valve is of passive air relief type)
    VPD,              ///< Valve Production Drain
    NUM_OF_VALVES     ///< Number of valves
} VALVES_T;

// ********** public function prototypes **********

void initValves( void );                                              // initialize the valves driver
void execValves( void );                                              // execute the valves driver

BOOL setValveState( VALVES_T valve, VALVE_STATE_NAMES_T valveState );      // set valve's state to valveState
DATA_ARRAY_GET_PROTOTYPE( U32, getValveState, valveID );              // get valve state for given valve

BOOL testSetValvesStatesPublishIntervalOverride( U32 value );
BOOL testResetValvesStatesPublishIntervalOverride( void );
BOOL testSetValveStateOverride( U32 valve, U32 state );
BOOL testResetValveStateOverride( U32 valveID );

/**@}*/

#endif /* __VALVES_H__ */