Index: DGModes.h
===================================================================
diff -u
--- DGModes.h	(revision 0)
+++ DGModes.h	(revision 70e55d7492e44b138eb53253f0a4254dc4dce05e)
@@ -0,0 +1,142 @@
+/**********************************************************************//**
+ *
+ *  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 DGModes.h
+ *
+ *  @date 18-May-2020
+ *  @author S. Nash
+ *
+ *  @brief header file containing DGModes information.
+ *
+ **************************************************************************/
+
+#ifndef __DG_MODES_H__
+#define __DG_MODES_H__
+
+#include "Common.h"
+
+/**
+ *  @defgroup DGModes DGModes
+ *  @brief DGModes header.  Provides enumeration lists of all DG
+ *  operation modes and their sub-modes (states)..
+ *
+ *  @addtogroup DGModes
+ *  @{
+ */
+
+// ********** public definitions **********
+
+/// Enumeration of operation modes.  These are in order of priority (highest to lowest).
+typedef enum DG_Op_Modes
+{
+    MODE_FAUL = 0,                                      ///< Fault mode.
+    MODE_SERV,                                          ///< Service mode.
+    MODE_INIT,                                          ///< Initialization & POST mode.
+    MODE_STAN,                                          ///< Standby mode - connected to HD.
+    MODE_SOLO,                                          ///< Standby Solo mode - no HD connected.
+    MODE_CIRC,                                          ///< Re-circulate mode.
+    MODE_FILL,                                          ///< Fill mode.
+    MODE_DRAI,                                          ///< Drain mode.
+    MODE_FLUS,                                          ///< Flush mode.
+    MODE_HEAT,                                          ///< Heat Disinfect mode.
+    MODE_CHEM,                                          ///< Chemical Disinfect mode.
+    MODE_NLEG,                                          ///< Not legal - an illegal mode transition occurred.
+    NUM_OF_DG_MODES
+} DG_OP_MODE;
+
+/// Enumeration of init & POST mode states.
+typedef enum DG_POST_States
+{
+    DG_POST_STATE_START = 0,                            ///< Start initialize & POST mode state.
+    DG_POST_STATE_FPGA,                                 ///< FPGA POST test state.
+    DG_POST_STATE_WATCHDOG,                             ///< Watchdog POST test state.
+    DG_POST_STATE_COMPLETED,                            ///< POST completed successfully state.
+    DG_POST_STATE_FAILED,                               ///< POST failed state.
+    NUM_OF_DG_POST_STATES                               ///< Number of initialize & POST mode states.
+} DG_POST_STATE_T;
+
+/// Enumeration of fault mode states.
+typedef enum DG_Fault_States
+{
+    DG_FAULT_STATE_START = 0,                           ///< Start solo fault state.
+    NUM_OF_DG_FAULT_STATES                              ///< Number of fault mode states.
+} DG_FAULT_STATE_T;
+
+/// Enumeration of solo standby mode states.
+typedef enum DG_Solo_States
+{
+    DG_SOLO_STANDBY_STATE_START = 0,                    ///< Start solo standby mode state.
+    NUM_OF_DG_SOLO_STANDBY_STATES                       ///< Number of solo standby mode states.
+} DG_SOLO_STANDBY_STATE_T;
+
+/// Enumeration of standby mode states.
+typedef enum DG_Standby_Mode_States
+{
+    DG_STANDBY_MODE_STATE_START = 0,                    ///< Start standby mode state.
+    DG_STANDBY_MODE_STATE_IDLE,                         ///< Idle standby mode state.
+    DG_STANDBY_MODE_STATE_SAMPLE_WATER,                 ///< Sample water standby mode state.
+    NUM_OF_DG_STANDBY_MODE_STATES                       ///< Number of standby mode states.
+} DG_STANDBY_MODE_STATE_T;
+
+/// Enumeration of re-circulation mode states.
+typedef enum DG_Recirculate_Mode_States
+{
+    DG_RECIRCULATE_MODE_STATE_START = 0,                ///< Start re-circulation mode state.
+    DG_RECIRCULATE_MODE_STATE_FLUSH_LINES,              ///< Flush lines state.
+    DG_RECIRCULATE_MODE_STATE_RECIRC_WATER,             ///< Re-circulate water state.
+    DG_RECIRCULATE_MODE_STATE_PAUSE,                    ///< Pause state (pumps, heaters, lamps off).
+    NUM_OF_DG_RECIRCULATE_MODE_STATES                   ///< Number of fill mode states.
+} DG_RECIRCULATE_MODE_STATE_T;
+
+/// Enumeration of fill mode states.
+typedef enum DG_Fill_Mode_States
+{
+    DG_FILL_MODE_STATE_START = 0,                       ///< Start fill mode state.
+    DG_FILL_MODE_STATE_DIALYSATE_PRODUCTION,            ///< Dialysate production state.
+    DG_FILL_MODE_STATE_DELIVER_DIALYSATE,               ///< Deliver dialysate state.
+    NUM_OF_DG_FILL_MODE_STATES                          ///< Number of fill mode states.
+} DG_FILL_MODE_STATE_T;
+
+/// Enumeration of drain mode states.
+typedef enum DG_Drain_States
+{
+    DG_DRAIN_STATE_START = 0,                           ///< Start drain mode state.
+    DG_DRAIN_STATE_DRAIN,                               ///< Drain drain mode state.
+    NUM_OF_DG_DRAIN_STATES                              ///< Number of drain mode states.
+} DG_DRAIN_STATE_T;
+
+/// Enumeration of flush mode states.
+typedef enum DG_Flush_States
+{
+    DG_FLUSH_STATE_START = 0,                           ///< Start flush mode state.
+    NUM_OF_DG_FLUSH_STATES                              ///< Number of flush mode states.
+} DG_FLUSH_STATE_T;
+
+/// Enumeration of heat disinfection mode states.
+typedef enum DG_Heat_States
+{
+    DG_HEAT_DISINFECT_STATE_START = 0,                  ///< Start heat disinfect mode state.
+    NUM_OF_DG_HEAT_DISINFECT_STATES                     ///< Number of heat disinfect mode states.
+} DG_HEAT_DISINFECT_STATE_T;
+
+/// Enumeration of chem. disinfect mode states.
+typedef enum DG_Chem_States
+{
+    DG_CHEM_DISINFECT_STATE_START = 0,                  ///< Start chemical disinfect mode state.
+    NUM_OF_DG_CHEM_DISINFECT_STATES                     ///< Number of chemical disinfect mode states.
+} DG_CHEM_DISINFECT_STATE_T;
+
+/// Enumeration of service mode states.
+typedef enum DG_Service_States
+{
+    DG_SERVICE_STATE_START = 0,                         ///< Start service mode state.
+    NUM_OF_DG_SERVICE_STATES                            ///< Number of service mode states.
+} DG_SERVICE_STATE_T;
+
+/**@}*/
+
+#endif