#ifndef COMMON_RODEFS_H_
#define COMMON_RODEFS_H_

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

/**
 *  @addtogroup FPOperationModes
 *  @{
 */

/// Enumeration of operation modes.  These are in order of priority (highest to lowest).
enum RO_Op_Modes
{
    RO_MODE_FAUL = 0,                                       ///< Fault mode
    RO_MODE_SERV,                                           ///< Service mode
    RO_MODE_INIT,                                           ///< Initialization & POST mode
    RO_MODE_STAN,                                           ///< Standby mode
    RO_MODE_PGEN,                                           ///< Pre Generate permeate water mode
    RO_MODE_GENW,                                           ///< Generate permeate water mode
    RO_MODE_NLEG,                                           ///< Not legal - an illegal mode transition occurred
    NUM_OF_RO_MODES                                         ///< Number of RO operation modes
};
typedef enum RO_Op_Modes RO_OP_MODE_T;  ///< Type for RO operation modes enumeration

/**@}*/

/**
 *  @addtogroup FPInitAndPOSTMode
 *  @{
 */

/// Enumeration of init & POST mode states.
enum RO_POST_States
{
   RO_POST_STATE_START = 0,                                ///< Start initialize & POST mode state
   RO_POST_STATE_FW_INTEGRITY,                             ///< Run firmware integrity test state
   RO_POST_STATE_NVDATAMGMT,                               ///< Run NV Data Mgmt. test state
   RO_POST_STATE_WATCHDOG,                                 ///< Run watchdog test state
   RO_POST_STATE_SAFETY_SHUTDOWN,                          ///< Run safety shutdown test state
   RO_POST_STATE_TEMPERATURES,                             ///< Run temperatures POST state
   RO_POST_STATE_FW_COMPATIBILITY,                         ///< Run firmware compatibility test state
   RO_POST_STATE_FPGA,                                     ///< Run FPGA test state
   RO_POST_STATE_COMPLETED,                                ///< POST self-tests completed state
   RO_POST_STATE_FAILED,                                   ///< POST self-tests failed state
   NUM_OF_RO_POST_STATES                                   ///< Number of initialize & POST mode states
};
typedef enum RO_POST_States RO_POST_STATE_T;                ///< Type for RO POST states enumeration

/**@}*/

/**
 *  @addtogroup FPStandbyMode
 *  @{
 */

/// Enumeration of standby mode states.
enum RO_Standby_Mode_States
{
    RO_STANDBY_MODE_STATE_IDLE = 0,                             ///< Idle standby mode state
    NUM_OF_RO_STANDBY_MODE_STATES                               ///< Number of standby mode states
};
typedef enum RO_Standby_Mode_States RO_STANDBY_MODE_STATE_T;    ///< Type for RO standby mode states enumeration

/**@}*/

/**
 *  @addtogroup FPPreGenWaterMode
 *  @{
 */

/// Enumeration of Pre Gen Water mode states.
enum RO_Pre_GenW_Mode_States
{
    RO_PRE_GENW_STATE_START = 0,                                 ///< Pre Gen Water start state
    RO_PRE_GENW_FILTER_FLUSH,                                    ///< Pre Gen Water Filter Flush state
    RO_PRE_GENW_CONCENTRATE_FLUSH,                               ///< Pre Gen Water Concentrate Flush state
    RO_PRE_GENW_PERMEATE_FLUSH,                                  ///< Pre Gen Water Permeate Flush state
    RO_PRE_GENW_VERIFY_WATER,                                    ///< Pre Gen Water Verify Water state
    RO_PRE_GENW_WATER_SUPPLY,                                    ///< Pre Gen Water Defeatured Water Supply state
    NUM_OF_RO_PRE_GENP_MODE_STATES                               ///< Number of Pre Gen Water states
};
typedef enum RO_Pre_GenW_Mode_States RO_PRE_GENW_MODE_STATE_T;   ///< Type for RO Gen Water mode states enumeration

/**@}*/

/**
 *  @addtogroup FPGenWaterMode
 *  @{
 */

/// Enumeration of Gen Water mode states.
enum RO_GenW_Mode_States
{
    RO_GENW_STATE_START = 0,                                    ///< Gen Water start state
    RO_GENW_TANK_FILL_STATE,                                    ///< Gen Water Tank Fill low state
    RO_GENW_TANK_FULL_STATE,                                    ///< Gen Water Tank Full state
    RO_GENW_SUPPLY_WATER,                                       ///< Gen Water Defeatured Supply Water state
    NUM_OF_RO_GENP_MODE_STATES                                  ///< Number of gen water states
};
typedef enum RO_GenW_Mode_States RO_GENW_MODE_STATE_T;          ///< Type for RO Gen Water mode states enumeration

/**@}*/

/**
 *  @addtogroup FPFilterFlush
 *  @{
 */

/// Enumeration of Filter Flush states.
enum FP_Filter_Flush_States
{
    FILTER_FLUSH_IN_PROGRESS = 0,                               ///< Filter Flush in progress state
    FILTER_FLUSH_PAUSED,                                        ///< Filter Flush paused state
    NUM_OF_FILTER_FLUSH_STATES                                  ///< Number of filter flush states
};
typedef enum FP_Filter_Flush_States FP_FILTER_FLUSH_STATE_T;    ///< Type for FP Filter Flush states enumeration

/**@}*/

/**
 *  @addtogroup CommonHeader
 *  @{
 */

/// Enumeration of RO event IDs.
enum RO_Event_List
{
    RO_EVENT_STARTUP = 0,                                               ///< RO startup event
    RO_EVENT_OP_MODE_CHANGE,                                            ///< RO Op mode change event
    RO_EVENT_SUB_MODE_CHANGE,                                           ///< RO Op sub-mode change event
    NUM_OF_RO_EVENT_IDS                                                 ///< Total number of RO events
};
typedef enum RO_Event_List RO_EVENT_ID_T;                               ///< Type for RO event list enumeration

/**@}*/

#endif