#ifndef COMMON_RODEFS_H_
#define COMMON_RODEFS_H_

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

/**
 *  @addtogroup ROOperationModes
 *  @{
 */

/// 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_NLEG,                           ///< Not legal - an illegal mode transition occurred
    NUM_OF_RO_MODES                         ///< Number of TD operation modes
};
typedef enum RO_Op_Modes RO_OP_MODE_T;  ///< Type for RO operation modes enumeration

/**@}*/

/**
 *  @addtogroup ROInitAndPOSTMode
 *  @{
 */

/// Enumeration of init & POST mode states.
enum RO_POST_States
{
    POST_STATE_START = 0,                               ///< Start initialize & POST mode state
    POST_STATE_FW_INTEGRITY,                            ///< Run firmware integrity test state
    POST_STATE_NVDATAMGMT,                              ///< Run NV Data Mgmt. test state
    POST_STATE_WATCHDOG,                                ///< Run watchdog test state
    POST_STATE_SAFETY_SHUTDOWN,                         ///< Run safety shutdown test state
    POST_STATE_TEMPERATURES,                            ///< Run temperatures POST state
    POST_STATE_FW_COMPATIBILITY,                        ///< Run firmware compatibility test state
    POST_STATE_FPGA,                                    ///< Run FPGA test state
    POST_STATE_COMPLETED,                               ///< POST self-tests completed state
    POST_STATE_FAILED,                                  ///< POST self-tests failed state
    NUM_OF_POST_STATES                                  ///< Number of initialize & POST mode states
};
typedef enum RO_POST_States RO_POST_STATE_T;            ///< Type for RO POST 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