Index: firmware/App/Modes/ModeChemicalDisinfect.c =================================================================== diff -u -ra7bf3ca23ea37a61000379facae628a31b3ecc59 -rcc398b14ccf518f350b57fb5cb8728e5c908bd1e --- firmware/App/Modes/ModeChemicalDisinfect.c (.../ModeChemicalDisinfect.c) (revision a7bf3ca23ea37a61000379facae628a31b3ecc59) +++ firmware/App/Modes/ModeChemicalDisinfect.c (.../ModeChemicalDisinfect.c) (revision cc398b14ccf518f350b57fb5cb8728e5c908bd1e) @@ -33,7 +33,7 @@ /*********************************************************************//** * @brief - * The initChemicalDisinfectMode function initializes the chemical disinfect Mode module. + * The initChemicalDisinfectMode function initializes the chemical disinfect mode module. * @details * Inputs : none * Outputs : Module initialized. @@ -46,7 +46,7 @@ /*********************************************************************//** * @brief - * The transitionToChemicalDisinfectMode function prepares for transition to \n + * The transitionToChemicalDisinfectMode function prepares for transition to * chemical disinfect mode. * @details * Inputs : none @@ -60,11 +60,11 @@ /*********************************************************************//** * @brief - * The execChemicalDisinfectMode function executes the chemical disinfect Mode state machine. + * The execChemicalDisinfectMode function executes the chemical disinfect mode state machine. * @details * Inputs : none - * Outputs : none - * @return current state. + * Outputs : Chemical disinfect mode state machine executed + * @return current state of chemical disinfect mode *************************************************************************/ U32 execChemicalDisinfectMode( void ) { @@ -85,12 +85,12 @@ /*********************************************************************//** * @brief - * The getCurrentChemicalDisinfectState function returns the current state of the \n + * The getCurrentChemicalDisinfectState function returns the current state of the * chemical disinfect mode. * @details * Inputs : chemState * Outputs : none - * @return the current state of chemical disinfect mode. + * @return current state of chemical disinfect mode *************************************************************************/ DG_CHEM_DISINFECT_STATE_T getCurrentChemicalDisinfectState( void ) { Index: firmware/App/Modes/ModeChemicalDisinfect.h =================================================================== diff -u -ra7bf3ca23ea37a61000379facae628a31b3ecc59 -rcc398b14ccf518f350b57fb5cb8728e5c908bd1e --- firmware/App/Modes/ModeChemicalDisinfect.h (.../ModeChemicalDisinfect.h) (revision a7bf3ca23ea37a61000379facae628a31b3ecc59) +++ firmware/App/Modes/ModeChemicalDisinfect.h (.../ModeChemicalDisinfect.h) (revision cc398b14ccf518f350b57fb5cb8728e5c908bd1e) @@ -23,16 +23,15 @@ /** * @defgroup DGChemicalDisinfectMode DGChemicalDisinfectMode - * @brief Chemical disinfect mode module. - * Manages chemical disinfect mode functions via a state machine. + * @brief Chemical disinfect mode module. Manages chemical disinfect mode functions via a state machine. * * @addtogroup DGChemicalDisinfectMode * @{ */ // ********** public definitions ********** -// ********** private function prototypes ********** +// ********** public function prototypes ********** void initChemicalDisinfectMode( void ); // initialize this module void transitionToChemicalDisinfectMode( void ); // prepares for transition to chemical disinfection mode Index: firmware/App/Modes/ModeDrain.c =================================================================== diff -u -r92ec01cb48d91fe7315baa987e1aa051dd12df75 -rcc398b14ccf518f350b57fb5cb8728e5c908bd1e --- firmware/App/Modes/ModeDrain.c (.../ModeDrain.c) (revision 92ec01cb48d91fe7315baa987e1aa051dd12df75) +++ firmware/App/Modes/ModeDrain.c (.../ModeDrain.c) (revision cc398b14ccf518f350b57fb5cb8728e5c908bd1e) @@ -57,8 +57,7 @@ /*********************************************************************//** * @brief - * The transitionToDrainMode function prepares for transition to drain \n - * mode. + * The transitionToDrainMode function prepares for transition to drain mode. * @details * Inputs : none * Outputs : Drain mode initialized @@ -79,7 +78,7 @@ * The execDrainMode function executes the drain mode state machine. * @details * Inputs : drainState - * Outputs : Check water quality, drainState + * Outputs : Check water quality, drain mode state machine executed * @return current state. *************************************************************************/ U32 execDrainMode( void ) @@ -112,8 +111,7 @@ /*********************************************************************//** * @brief - * The handleDrainState function handles the drain state of the drain mode \n - * state machine. + * The handleDrainState function handles the drain state of the drain mode state machine. * @details * Inputs : none * Outputs : Drain out from reservoir @@ -142,8 +140,7 @@ /*********************************************************************//** * @brief - * The getCurrentDrainState function returns the current state of the \n - * drain mode. + * The getCurrentDrainState function returns the current state of the drain mode. * @details * Inputs : drainState * Outputs : none Index: firmware/App/Modes/ModeDrain.h =================================================================== diff -u -ra7bf3ca23ea37a61000379facae628a31b3ecc59 -rcc398b14ccf518f350b57fb5cb8728e5c908bd1e --- firmware/App/Modes/ModeDrain.h (.../ModeDrain.h) (revision a7bf3ca23ea37a61000379facae628a31b3ecc59) +++ firmware/App/Modes/ModeDrain.h (.../ModeDrain.h) (revision cc398b14ccf518f350b57fb5cb8728e5c908bd1e) @@ -23,16 +23,15 @@ /** * @defgroup DGDrainMode DGDrainMode - * @brief Drain mode module. - * Manages drain mode functions via a state machine. + * @brief Drain mode module. Manages drain mode functions via a state machine. * * @addtogroup DGDrainMode * @{ */ // ********** public definitions ********** -// ********** private function prototypes ********** +// ********** public function prototypes ********** void initDrainMode( void ); // initialize this module void transitionToDrainMode( void ); // prepares for transition to operating parameters mode Index: firmware/App/Modes/ModeFault.c =================================================================== diff -u -ra7bf3ca23ea37a61000379facae628a31b3ecc59 -rcc398b14ccf518f350b57fb5cb8728e5c908bd1e --- firmware/App/Modes/ModeFault.c (.../ModeFault.c) (revision a7bf3ca23ea37a61000379facae628a31b3ecc59) +++ firmware/App/Modes/ModeFault.c (.../ModeFault.c) (revision cc398b14ccf518f350b57fb5cb8728e5c908bd1e) @@ -36,7 +36,7 @@ * The initFaultMode function initializes the Fault Mode module. * @details * Inputs : none - * Outputs : Fault Mode module initialized. + * Outputs : Fault mode module initialized * @return none *************************************************************************/ void initFaultMode( void ) @@ -49,7 +49,7 @@ * The transitionToFaultMode function prepares for transition to fault mode. * @details * Inputs : none - * Outputs : + * Outputs : none * @return none *************************************************************************/ void transitionToFaultMode( void ) @@ -58,11 +58,11 @@ /*********************************************************************//** * @brief - * The execFaultMode function executes the Fault Mode state machine. + * The execFaultMode function executes the fault mode state machine. * @details * Inputs : none - * Outputs : - * @return current state + * Outputs : Fault mode state machine executed + * @return current state of fault mode *************************************************************************/ U32 execFaultMode( void ) { @@ -83,12 +83,11 @@ /*********************************************************************//** * @brief - * The getCurrentFaultState function returns the current state of the \n - * fault mode. + * The getCurrentFaultState function returns the current state of the fault mode. * @details * Inputs : faultState * Outputs : none - * @return the current state of fault mode. + * @return current state of fault mode *************************************************************************/ DG_FAULT_STATE_T getCurrentFaultState( void ) { Index: firmware/App/Modes/ModeFault.h =================================================================== diff -u -ra7bf3ca23ea37a61000379facae628a31b3ecc59 -rcc398b14ccf518f350b57fb5cb8728e5c908bd1e --- firmware/App/Modes/ModeFault.h (.../ModeFault.h) (revision a7bf3ca23ea37a61000379facae628a31b3ecc59) +++ firmware/App/Modes/ModeFault.h (.../ModeFault.h) (revision cc398b14ccf518f350b57fb5cb8728e5c908bd1e) @@ -23,8 +23,7 @@ /** * @defgroup DGFaultMode DGFaultMode - * @brief Fault mode module. - * Manages fault mode functions via a state machine. + * @brief Fault mode module. Manages fault mode functions via a state machine. * * @addtogroup DGFaultMode * @{ Index: firmware/App/Modes/ModeFill.c =================================================================== diff -u -r92ec01cb48d91fe7315baa987e1aa051dd12df75 -rcc398b14ccf518f350b57fb5cb8728e5c908bd1e --- firmware/App/Modes/ModeFill.c (.../ModeFill.c) (revision 92ec01cb48d91fe7315baa987e1aa051dd12df75) +++ firmware/App/Modes/ModeFill.c (.../ModeFill.c) (revision cc398b14ccf518f350b57fb5cb8728e5c908bd1e) @@ -33,9 +33,6 @@ // ********** private definitions ********** -#define QUARTER_SECOND 250 -#define HALF_SECOND 500 - // ********** private data ********** static DG_FILL_MODE_STATE_T fillState; ///< Currently active fill state. @@ -50,7 +47,7 @@ * The initFillMode function initializes the fill mode module. * @details * Inputs : none - * Outputs : Fill mode module initialized. + * Outputs : Fill mode module initialized * @return none *************************************************************************/ void initFillMode( void ) @@ -60,8 +57,7 @@ /*********************************************************************//** * @brief transitionToFillMode - * The transitionToFillMode function prepares for transition to \n - * fill mode. + * The transitionToFillMode function prepares for transition to fill mode. * @details * Inputs : none * Outputs : Re-initialized fill mode @@ -83,7 +79,7 @@ * The execFillMode function executes the fill mode state machine. * @details * Inputs : fillState - * Outputs : Check water quality, fillState + * Outputs : Check water quality, fill mode state machine executed * @return current state. *************************************************************************/ U32 execFillMode( void ) @@ -120,7 +116,7 @@ /*********************************************************************//** * @brief - * The handleDialysateProductionState function executes the Dialysate Production \n + * The handleDialysateProductionState function executes the Dialysate production * state of the fill mode state machine. * @details * Inputs : none @@ -143,7 +139,7 @@ /*********************************************************************//** * @brief - * The handleDeliverDialysateState function executes the Deliver Dialysate \n + * The handleDeliverDialysateState function executes the deliver Dialysate * state of the fill mode state machine. * @details * Inputs : none @@ -179,12 +175,11 @@ /*********************************************************************//** * @brief - * The getCurrentFillState function returns the current state of the \n - * fill mode. + * The getCurrentFillState function returns the current state of the fill mode. * @details * Inputs : fillState * Outputs : none - * @return the current state of fill mode. + * @return current state of fill mode *************************************************************************/ DG_FILL_MODE_STATE_T getCurrentFillState( void ) { Index: firmware/App/Modes/ModeFill.h =================================================================== diff -u -ra7bf3ca23ea37a61000379facae628a31b3ecc59 -rcc398b14ccf518f350b57fb5cb8728e5c908bd1e --- firmware/App/Modes/ModeFill.h (.../ModeFill.h) (revision a7bf3ca23ea37a61000379facae628a31b3ecc59) +++ firmware/App/Modes/ModeFill.h (.../ModeFill.h) (revision cc398b14ccf518f350b57fb5cb8728e5c908bd1e) @@ -23,8 +23,7 @@ /** * @defgroup DGFillMode DGFillMode - * @brief Fill mode module. - * Manages fill mode functions via a state machine. + * @brief Fill mode module. Manages fill mode functions via a state machine. * * @addtogroup DGFillMode * @{ Index: firmware/App/Modes/ModeFlush.c =================================================================== diff -u -ra7bf3ca23ea37a61000379facae628a31b3ecc59 -rcc398b14ccf518f350b57fb5cb8728e5c908bd1e --- firmware/App/Modes/ModeFlush.c (.../ModeFlush.c) (revision a7bf3ca23ea37a61000379facae628a31b3ecc59) +++ firmware/App/Modes/ModeFlush.c (.../ModeFlush.c) (revision cc398b14ccf518f350b57fb5cb8728e5c908bd1e) @@ -33,10 +33,10 @@ /*********************************************************************//** * @brief - * The initFlushMode function initializes flush Mode module. + * The initFlushMode function initializes flush mode module. * @details * Inputs : none - * Outputs : none + * Outputs : Initialized flush mode module * @return none *************************************************************************/ void initFlushMode( void ) @@ -46,11 +46,10 @@ /*********************************************************************//** * @brief - * The transitionToFlushMode function prepares for transition to \n - * flush mode. + * The transitionToFlushMode function prepares for transition to flush mode. * @details * Inputs : none - * Outputs : + * Outputs : Prepares for transition to flush mode * @return none *************************************************************************/ void transitionToFlushMode( void ) @@ -60,11 +59,11 @@ /*********************************************************************//** * @brief - * The execFlushMode function executes the flush Mode state machine. + * The execFlushMode function executes the flush mode state machine. * @details * Inputs : none - * Outputs : - * @return current state. + * Outputs : Flush mode state machine executed + * @return current state *************************************************************************/ U32 execFlushMode( void ) { @@ -85,12 +84,11 @@ /*********************************************************************//** * @brief - * The getCurrentFlushState function returns the current state of the \n - * flush mode. + * The getCurrentFlushState function returns the current state of the flush mode. * @details * Inputs : flushState * Outputs : none - * @return the current state of flush mode. + * @return current state of flush mode. *************************************************************************/ DG_FLUSH_STATE_T getCurrentFlushState( void ) { Index: firmware/App/Modes/ModeFlush.h =================================================================== diff -u -ra7bf3ca23ea37a61000379facae628a31b3ecc59 -rcc398b14ccf518f350b57fb5cb8728e5c908bd1e --- firmware/App/Modes/ModeFlush.h (.../ModeFlush.h) (revision a7bf3ca23ea37a61000379facae628a31b3ecc59) +++ firmware/App/Modes/ModeFlush.h (.../ModeFlush.h) (revision cc398b14ccf518f350b57fb5cb8728e5c908bd1e) @@ -23,8 +23,7 @@ /** * @defgroup DGFlushMode DGFlushMode - * @brief Flush mode module. Manages the state machine for the - * flush mode. + * @brief Flush mode module. Manages the state machine for the flush mode. * * @addtogroup DGFlushMode * @{ Index: firmware/App/Modes/ModeHeatDisinfect.c =================================================================== diff -u -ra7bf3ca23ea37a61000379facae628a31b3ecc59 -rcc398b14ccf518f350b57fb5cb8728e5c908bd1e --- firmware/App/Modes/ModeHeatDisinfect.c (.../ModeHeatDisinfect.c) (revision a7bf3ca23ea37a61000379facae628a31b3ecc59) +++ firmware/App/Modes/ModeHeatDisinfect.c (.../ModeHeatDisinfect.c) (revision cc398b14ccf518f350b57fb5cb8728e5c908bd1e) @@ -33,10 +33,10 @@ /*********************************************************************//** * @brief - * The initHeatDisinfectMode function initializes the heat disinfect Mode module. + * The initHeatDisinfectMode function initializes the heat disinfect mode module. * @details * Inputs : none - * Outputs : none + * Outputs : Initialized heat disinfect mode module * @return none *************************************************************************/ void initHeatDisinfectMode( void ) @@ -49,7 +49,7 @@ * The transitionToHeatDisinfectMode function prepares for transition to heat disinfect mode. * @details * Inputs : none - * Outputs : none + * Outputs : Prepare for transition to heat disinfect mode * @return none *************************************************************************/ void transitionToHeatDisinfectMode( void ) @@ -59,11 +59,11 @@ /*********************************************************************//** * @brief - * The execHeatDisinfectMode function executes the heat disinfect Mode state machine. + * The execHeatDisinfectMode function executes the heat disinfect mode state machine. * @details * Inputs : none - * Outputs : none - * @return current state. + * Outputs : Heat disinfect mode state machine executed + * @return current state *************************************************************************/ U32 execHeatDisinfectMode( void ) { @@ -84,7 +84,7 @@ /*********************************************************************//** * @brief - * The getCurrentHeatDisinfectState function returns the current state of the \n + * The getCurrentHeatDisinfectState function returns the current state of the * heat disinfect mode. * @details * Inputs : heatState Index: firmware/App/Modes/ModeHeatDisinfect.h =================================================================== diff -u -ra7bf3ca23ea37a61000379facae628a31b3ecc59 -rcc398b14ccf518f350b57fb5cb8728e5c908bd1e --- firmware/App/Modes/ModeHeatDisinfect.h (.../ModeHeatDisinfect.h) (revision a7bf3ca23ea37a61000379facae628a31b3ecc59) +++ firmware/App/Modes/ModeHeatDisinfect.h (.../ModeHeatDisinfect.h) (revision cc398b14ccf518f350b57fb5cb8728e5c908bd1e) @@ -23,8 +23,7 @@ /** * @defgroup DGHeatDisinfectMode DGHeatDisinfectMode - * @brief Heat disinfection mode module. Manages the state machine for the - * heat disinfection mode. + * @brief Heat disinfection mode module. Manages the state machine for the heat disinfection mode. * * @addtogroup DGHeatDisinfectMode * @{ Index: firmware/App/Modes/ModeInitPOST.c =================================================================== diff -u -r9b9af8666ecd84c16912351bf828ccae062037be -rcc398b14ccf518f350b57fb5cb8728e5c908bd1e --- firmware/App/Modes/ModeInitPOST.c (.../ModeInitPOST.c) (revision 9b9af8666ecd84c16912351bf828ccae062037be) +++ firmware/App/Modes/ModeInitPOST.c (.../ModeInitPOST.c) (revision cc398b14ccf518f350b57fb5cb8728e5c908bd1e) @@ -43,10 +43,10 @@ /*********************************************************************//** * @brief - * The initInitAndPOSTMode function initializes the Initialize & POST Mode module. + * The initInitAndPOSTMode function initializes the Initialization and POST mode module. * @details * Inputs : none - * Outputs : Initialize & POST Mode module initialized. + * Outputs : Initialization and POST mode module initialized * @return none *************************************************************************/ void initInitAndPOSTMode( void ) @@ -59,11 +59,11 @@ /*********************************************************************//** * @brief - * The transitionToInitAndPOSTMode function prepares for transition to\n - * initialize & POST mode. + * The transitionToInitAndPOSTMode function prepares for transition to + * initialization and POST mode. * @details * Inputs : none - * Outputs : + * Outputs : none * @return none *************************************************************************/ void transitionToInitAndPOSTMode( void ) @@ -73,10 +73,11 @@ /*********************************************************************//** * @brief - * The execInitAndPOSTMode function executes the Initialize & POST Mode state machine. + * The execInitAndPOSTMode function executes the initialization and POST + * mode state machine. * @details * Inputs : postState - * Outputs : POST state machine executed + * Outputs : Initialization and POST mode state machine executed * @return current state. *************************************************************************/ U32 execInitAndPOSTMode( void ) @@ -162,9 +163,8 @@ /*********************************************************************//** * @brief - * The isPOSTCompleted function determines whether all HD POST have \n - * been run and completed. If true, call the isPOSTPassed() to see final \n - * result (pass/fail). + * The isPOSTCompleted function determines whether all DG POST have been run + * and completed. If true, call the isPOSTPassed() to see final result (pass/fail). * @details * Inputs : postCompleted * Outputs : none @@ -177,7 +177,7 @@ /*********************************************************************//** * @brief - * The isPOSTPassed function determines whether all HD POST have passed. \n + * The isPOSTPassed function determines whether all HD POST have passed. * Call this function after POST is complete (call isPOSTCompleted function). * @details * Inputs : postPassed @@ -191,8 +191,7 @@ /*********************************************************************//** * @brief - * The handlePOSTStatus function handles a status result returned by a - * POST function. + * The handlePOSTStatus function handles a status result returned by a POST function. * @details * Inputs : postPassed * Outputs : none @@ -217,12 +216,12 @@ /*********************************************************************//** * @brief - * The getCurrentInitAndPOSTState function returns the current state of the \n - * initialize & POST mode. + * The getCurrentInitAndPOSTState function returns the current state of the + * initialization and POST mode. * @details * Inputs : postState * Outputs : none - * @return the current state of initialize & POST mode. + * @return the current state of initialization and POST mode *************************************************************************/ DG_POST_STATE_T getCurrentInitAndPOSTState( void ) { Index: firmware/App/Modes/ModeInitPOST.h =================================================================== diff -u -ra7bf3ca23ea37a61000379facae628a31b3ecc59 -rcc398b14ccf518f350b57fb5cb8728e5c908bd1e --- firmware/App/Modes/ModeInitPOST.h (.../ModeInitPOST.h) (revision a7bf3ca23ea37a61000379facae628a31b3ecc59) +++ firmware/App/Modes/ModeInitPOST.h (.../ModeInitPOST.h) (revision cc398b14ccf518f350b57fb5cb8728e5c908bd1e) @@ -23,8 +23,7 @@ /** * @defgroup DGInitAndPOSTMode DGInitAndPOSTMode - * @brief Initialization and POST mode module. - * Manages initialization and POST mode functions via a state machine. + * @brief Initialization and POST mode module. Manages initialization and POST mode functions via a state machine. * * @addtogroup DGInitAndPOSTMode * @{ Index: firmware/App/Modes/ModeRecirculate.c =================================================================== diff -u -r92ec01cb48d91fe7315baa987e1aa051dd12df75 -rcc398b14ccf518f350b57fb5cb8728e5c908bd1e --- firmware/App/Modes/ModeRecirculate.c (.../ModeRecirculate.c) (revision 92ec01cb48d91fe7315baa987e1aa051dd12df75) +++ firmware/App/Modes/ModeRecirculate.c (.../ModeRecirculate.c) (revision cc398b14ccf518f350b57fb5cb8728e5c908bd1e) @@ -68,8 +68,7 @@ /*********************************************************************//** * @brief - * The transitionToRecirculateMode function prepares for transition to \n - * re-circulate mode. + * The transitionToRecirculateMode function prepares for transition to re-circulate mode. * @details * Inputs : none * Outputs : Re-initialized re-circulate mode @@ -105,7 +104,7 @@ * The execRecirculateMode function executes the re-circulate mode state machine. * @details * Inputs : recircState - * Outputs : Check water quality, recircState + * Outputs : Check water quality, re-circulate mode state machine executed * @return current state *************************************************************************/ U32 execRecirculateMode( void ) @@ -146,8 +145,8 @@ /*********************************************************************//** * @brief - * The handleFlushLinesState function executes the flush lines \n - * state of the re-circulate mode state machine. + * The handleFlushLinesState function executes the flush lines state of the + * re-circulate mode state machine. * @details * Inputs : none * Outputs : Integrate volume of water moved through line @@ -174,8 +173,8 @@ /*********************************************************************//** * @brief - * The handleRecircWaterState function executes the re-circulate \n - * water state of the re-circulate mode state machine. + * The handleRecircWaterState function executes the re-circulate water state + * of the re-circulate mode state machine. * @details * Inputs : none * Outputs : none @@ -190,7 +189,7 @@ /*********************************************************************//** * @brief - * The handleRecircPauseState function executes the pause state of the \n + * The handleRecircPauseState function executes the pause state of the * re-circulate mode state machine. * @details * Inputs : none @@ -206,7 +205,7 @@ /*********************************************************************//** * @brief - * The requestDGStop function handles an HD request to stop (return to Standby mode). + * The requestDGStop function handles an HD request to stop (return to standby mode). * @details * Inputs : none * Outputs : DG standby mode requested @@ -223,12 +222,12 @@ /*********************************************************************//** * @brief - * The getCurrentRecirculateState function returns the current state of the \n + * The getCurrentRecirculateState function returns the current state of the * re-circulate mode. * @details * Inputs : recircState * Outputs : none - * @return the current state of re-circulate mode. + * @return the current state of re-circulate mode *************************************************************************/ DG_RECIRCULATE_MODE_STATE_T getCurrentRecirculateState( void ) { Index: firmware/App/Modes/ModeRecirculate.h =================================================================== diff -u -ra7bf3ca23ea37a61000379facae628a31b3ecc59 -rcc398b14ccf518f350b57fb5cb8728e5c908bd1e --- firmware/App/Modes/ModeRecirculate.h (.../ModeRecirculate.h) (revision a7bf3ca23ea37a61000379facae628a31b3ecc59) +++ firmware/App/Modes/ModeRecirculate.h (.../ModeRecirculate.h) (revision cc398b14ccf518f350b57fb5cb8728e5c908bd1e) @@ -23,8 +23,7 @@ /** * @defgroup DGRecirculateMode DGRecirculateMode - * @brief Re-circulate mode module. - * Manages re-circulate mode functions via a state machine. + * @brief Re-circulate mode module. Manages re-circulate mode functions via a state machine. * * @addtogroup DGRecirculateMode * @{ @@ -35,8 +34,8 @@ // ********** private function prototypes ********** void initRecirculateMode( void ); // initialize this module -void transitionToRecirculateMode( void ); // prepares for transition to Recirculate mode -U32 execRecirculateMode( void ); // execute the Recirculate mode state machine (call from OperationModes) +void transitionToRecirculateMode( void ); // prepares for transition to recirculate mode +U32 execRecirculateMode( void ); // execute the recirculate mode state machine (call from OperationModes) DG_RECIRCULATE_MODE_STATE_T getCurrentRecirculateState( void ); // get the current state of re-circulate mode Index: firmware/App/Modes/ModeService.c =================================================================== diff -u -ra7bf3ca23ea37a61000379facae628a31b3ecc59 -rcc398b14ccf518f350b57fb5cb8728e5c908bd1e --- firmware/App/Modes/ModeService.c (.../ModeService.c) (revision a7bf3ca23ea37a61000379facae628a31b3ecc59) +++ firmware/App/Modes/ModeService.c (.../ModeService.c) (revision cc398b14ccf518f350b57fb5cb8728e5c908bd1e) @@ -33,10 +33,10 @@ /*********************************************************************//** * @brief - * The initServiceMode function initializes the Service Mode module. + * The initServiceMode function initializes the service mode module. * @details * Inputs : none - * Outputs : Service Mode module initialized. + * Outputs : Service mode module initialized * @return none *************************************************************************/ void initServiceMode( void ) @@ -49,7 +49,7 @@ * The transitionToServiceMode function prepares for transition to service mode. * @details * Inputs : none - * Outputs : + * Outputs : none * @return none *************************************************************************/ void transitionToServiceMode( void ) @@ -58,10 +58,10 @@ /*********************************************************************//** * @brief - * The execServiceMode function executes the Service Mode state machine. + * The execServiceMode function executes the service mode state machine. * @details * Inputs : none - * Outputs : + * Outputs : Service mode state machine executed * @return current state. *************************************************************************/ U32 execServiceMode( void ) @@ -83,12 +83,11 @@ /*********************************************************************//** * @brief - * The getCurrentServiceState function returns the current state of the \n - * service mode. + * The getCurrentServiceState function returns the current state of the service mode. * @details * Inputs : serviceState * Outputs : none - * @return the current state of service mode. + * @return the current state of service mode *************************************************************************/ DG_SERVICE_STATE_T getCurrentServiceState( void ) { Index: firmware/App/Modes/ModeService.h =================================================================== diff -u -ra7bf3ca23ea37a61000379facae628a31b3ecc59 -rcc398b14ccf518f350b57fb5cb8728e5c908bd1e --- firmware/App/Modes/ModeService.h (.../ModeService.h) (revision a7bf3ca23ea37a61000379facae628a31b3ecc59) +++ firmware/App/Modes/ModeService.h (.../ModeService.h) (revision cc398b14ccf518f350b57fb5cb8728e5c908bd1e) @@ -23,8 +23,7 @@ /** * @defgroup DGServiceMode DGServiceMode - * @brief Service mode module. - * Manages service mode functions via a state machine. + * @brief Service mode module. Manages service mode functions via a state machine. * * @addtogroup DGServiceMode * @{ Index: firmware/App/Modes/ModeSolo.c =================================================================== diff -u -rdc0d9b087c609e71cacdb7f0395cccf29d749c00 -rcc398b14ccf518f350b57fb5cb8728e5c908bd1e --- firmware/App/Modes/ModeSolo.c (.../ModeSolo.c) (revision dc0d9b087c609e71cacdb7f0395cccf29d749c00) +++ firmware/App/Modes/ModeSolo.c (.../ModeSolo.c) (revision cc398b14ccf518f350b57fb5cb8728e5c908bd1e) @@ -37,10 +37,10 @@ /*********************************************************************//** * @brief - * The initSoloMode function initializes the Standby-Solo Mode module. + * The initSoloMode function initializes the solo standby mode module. * @details * Inputs : none - * Outputs : Standby-Solo Mode module initialized. + * Outputs : Solo standby mode module initialized * @return none *************************************************************************/ void initSoloMode( void ) @@ -50,10 +50,10 @@ /*********************************************************************//** * @brief - * The transitionToSoloMode function prepares for transition to standby-solo mode. + * The transitionToSoloMode function prepares for transition to solo standby mode. * @details * Inputs : none - * Outputs : + * Outputs : Re-initialized solo standby mode * @return none *************************************************************************/ void transitionToSoloMode( void ) @@ -63,10 +63,10 @@ /*********************************************************************//** * @brief - * The execSoloMode function executes the Standby-Solo Mode state machine. + * The execSoloMode function executes the solo standby mode state machine. * @details * Inputs : none - * Outputs : + * Outputs : Solo standby mode state machine executed * @return current state. *************************************************************************/ U32 execSoloMode( void ) @@ -93,12 +93,11 @@ /*********************************************************************//** * @brief - * The handleIdleDGSoloStandbyState function handles the idle state of DG \n - * standby-solo mode. + * The handleIdleDGSoloStandbyState function handles the idle state of solo standby mode. * @details * Inputs : none * Outputs : none - * @return the next state of standby-solo mode. + * @return the next state of solo standby mode. *************************************************************************/ static DG_SOLO_STANDBY_STATE_T handleIdleDGSoloStandbyState( void ) { @@ -115,12 +114,11 @@ /*********************************************************************//** * @brief - * The getCurrentSoloState function returns the current state of the \n - * standby-solo mode. + * The getCurrentSoloState function returns the current state of solo standby mode. * @details * Inputs : soloState * Outputs : none - * @return the current state of standby-solo mode. + * @return the current state of solo standby mode. *************************************************************************/ DG_SOLO_STANDBY_STATE_T getCurrentSoloState( void ) { Index: firmware/App/Modes/ModeSolo.h =================================================================== diff -u -ra7bf3ca23ea37a61000379facae628a31b3ecc59 -rcc398b14ccf518f350b57fb5cb8728e5c908bd1e --- firmware/App/Modes/ModeSolo.h (.../ModeSolo.h) (revision a7bf3ca23ea37a61000379facae628a31b3ecc59) +++ firmware/App/Modes/ModeSolo.h (.../ModeSolo.h) (revision cc398b14ccf518f350b57fb5cb8728e5c908bd1e) @@ -23,8 +23,7 @@ /** * @defgroup DGSoloStandbyMode DGSoloStandbyMode - * @brief Solo Standby mode module. - * Manages Solo standby mode functions via a state machine. + * @brief Solo Standby mode module. Manages solo standby mode functions via a state machine. * * @addtogroup DGSoloStandbyMode * @{ Index: firmware/App/Modes/ModeStandby.c =================================================================== diff -u -rdc0d9b087c609e71cacdb7f0395cccf29d749c00 -rcc398b14ccf518f350b57fb5cb8728e5c908bd1e --- firmware/App/Modes/ModeStandby.c (.../ModeStandby.c) (revision dc0d9b087c609e71cacdb7f0395cccf29d749c00) +++ firmware/App/Modes/ModeStandby.c (.../ModeStandby.c) (revision cc398b14ccf518f350b57fb5cb8728e5c908bd1e) @@ -32,14 +32,14 @@ // ********** private definitions ********** -#define WATER_SAMPLE_TIME_MS ( 10 * MS_PER_SECOND ) ///< Duration of water sample state (in ms). +#define WATER_SAMPLE_TIME_MS ( 10 * MS_PER_SECOND ) ///< Duration of water sample state (in ms). // ********** private data ********** -static DG_STANDBY_MODE_STATE_T standbyState = DG_STANDBY_MODE_STATE_START; ///< Currently active standby state. -static BOOL pendingSampleWaterRequest = FALSE; ///< Flag indicating HD has requested a water sample. -static BOOL pendingStartDGRequest = FALSE; ///< Flag indicating HD has requested DG start (go to re-circulate mode). -static U32 waterSampleStartTime = 0; ///< Time stamp for start of water sample state. +static DG_STANDBY_MODE_STATE_T standbyState = DG_STANDBY_MODE_STATE_START; ///< Currently active standby state. +static BOOL pendingSampleWaterRequest = FALSE; ///< Flag indicating HD has requested a water sample. +static BOOL pendingStartDGRequest = FALSE; ///< Flag indicating HD has requested DG start (go to re-circulate mode). +static U32 waterSampleStartTime = 0; ///< Time stamp for start of water sample state. // ********** private function prototypes ********** @@ -48,10 +48,10 @@ /*********************************************************************//** * @brief - * The initStandbyMode function initializes the Standby Mode module. + * The initStandbyMode function initializes the standby mode module. * @details * Inputs : none - * Outputs : Standby Mode module initialized. + * Outputs : Standby mode module initialized * @return none *************************************************************************/ void initStandbyMode( void ) @@ -67,7 +67,7 @@ * The transitionToStandbyMode function prepares for transition to standby mode. * @details * Inputs : none - * Outputs : + * Outputs : Re-initialized standby mode * @return none *************************************************************************/ void transitionToStandbyMode( void ) @@ -91,11 +91,11 @@ /*********************************************************************//** * @brief - * The execStandbyMode function executes the Standby Mode state machine. + * The execStandbyMode function executes the standby mode state machine. * @details * Inputs : none - * Outputs : - * @return current state. + * Outputs : Standby mode state machine executed + * @return current state *************************************************************************/ U32 execStandbyMode( void ) { @@ -125,11 +125,11 @@ /*********************************************************************//** * @brief - * The handleStandbyIdleState function executes the Idle state of the \n - * Standby Mode state machine. + * The handleStandbyIdleState function executes the idle state of the + * standby mode state machine. * @details * Inputs : pendingSampleWaterRequest, pendingStartDGRequest - * Outputs : possibly op mode + * Outputs : Idle state of the standby mode executed * @return the next state *************************************************************************/ static DG_STANDBY_MODE_STATE_T handleStandbyIdleState( void ) @@ -161,11 +161,11 @@ /*********************************************************************//** * @brief - * The handleStandbySampleWaterState function executes the sample water state \n - * of the Standby Mode state machine. + * The handleStandbySampleWaterState function executes the sample water state + * of the standby mode state machine. * @details * Inputs : none - * Outputs : + * Outputs : Sample water state of the standby mode executed * @return the next state *************************************************************************/ static DG_STANDBY_MODE_STATE_T handleStandbySampleWaterState( void ) @@ -227,8 +227,7 @@ /*********************************************************************//** * @brief - * The getCurrentStandbyState function returns the current state of the \n - * standby mode. + * The getCurrentStandbyState function returns the current state of standby mode. * @details * Inputs : standbyState * Outputs : none Index: firmware/App/Modes/ModeStandby.h =================================================================== diff -u -ra7bf3ca23ea37a61000379facae628a31b3ecc59 -rcc398b14ccf518f350b57fb5cb8728e5c908bd1e --- firmware/App/Modes/ModeStandby.h (.../ModeStandby.h) (revision a7bf3ca23ea37a61000379facae628a31b3ecc59) +++ firmware/App/Modes/ModeStandby.h (.../ModeStandby.h) (revision cc398b14ccf518f350b57fb5cb8728e5c908bd1e) @@ -23,8 +23,7 @@ /** * @defgroup DGStandbyMode DGStandbyMode - * @brief Standby mode module. - * Manages standby mode functions via a state machine. + * @brief Standby mode module. Manages standby mode functions via a state machine. * * @addtogroup DGStandbyMode * @{ Index: firmware/App/Modes/OperationModes.c =================================================================== diff -u -rdc0d9b087c609e71cacdb7f0395cccf29d749c00 -rcc398b14ccf518f350b57fb5cb8728e5c908bd1e --- firmware/App/Modes/OperationModes.c (.../OperationModes.c) (revision dc0d9b087c609e71cacdb7f0395cccf29d749c00) +++ firmware/App/Modes/OperationModes.c (.../OperationModes.c) (revision cc398b14ccf518f350b57fb5cb8728e5c908bd1e) @@ -39,14 +39,15 @@ // ********** private definitions ********** -#define BROADCAST_DG_OP_MODE_INTERVAL ( MS_PER_SECOND / TASK_GENERAL_INTERVAL ) ///< interval (ms/task time) at which the op mode is published on the CAN bus. +#define BROADCAST_DG_OP_MODE_INTERVAL ( MS_PER_SECOND / TASK_GENERAL_INTERVAL ) ///< interval (ms/task time) at which the op mode is published on the CAN bus. // ********** private data ********** -static volatile BOOL modeRequest[NUM_OF_DG_MODES - 1]; ///< Array of mode request flags. -static DG_OP_MODE_T currentMode = DG_MODE_INIT; ///< The currently active mode. -static U32 currentSubMode = 0; ///< The currently active state of the active mode. -static U32 broadcastModeIntervalCtr = 11; ///< Interval counter used to determine when to broadcase operation mode. Initialize to 11 to stagger broadcast. +static volatile BOOL modeRequest[NUM_OF_DG_MODES - 1]; ///< Array of mode request flags. +static DG_OP_MODE_T currentMode = DG_MODE_INIT; ///< The currently active mode. +static U32 currentSubMode = 0; ///< The currently active state of the active mode. +static U32 broadcastModeIntervalCtr = 11; ///< Interval counter used to determine when to broadcase operation mode. Initialize to 11 to stagger broadcast. +static U32 dgOpModePublicationTimerCounter = 0; ///< Timer counter for DG operation mode publication /// This matrix determines legal transitions from one mode to another. static const DG_OP_MODE_T MODE_TRANSITION_TABLE[NUM_OF_DG_MODES - 1][NUM_OF_DG_MODES - 1] = @@ -65,7 +66,6 @@ /* CHEM */{ DG_MODE_FAUL, DG_MODE_NLEG, DG_MODE_NLEG, DG_MODE_STAN, DG_MODE_NLEG, DG_MODE_NLEG, DG_MODE_NLEG, DG_MODE_NLEG, DG_MODE_NLEG, DG_MODE_NLEG, DG_MODE_CHEM } }; -static U32 dgOpModePublicationTimerCounter = 0; // ********** private function prototypes ********** @@ -74,11 +74,11 @@ static void broadcastOperationMode( void ); /*********************************************************************//** - * @brief execOperationModes - * The execOperationModes function initializes the Operation Modes module. + * @brief + * The initOperationModes function initializes the operation modes module. * @details * Inputs : none - * Outputs : Operation Modes module initialized. + * Outputs : Operation modes module initialized * @return none *************************************************************************/ void initOperationModes( void ) @@ -114,11 +114,11 @@ } /*********************************************************************//** - * @brief execOperationModes - * The execOperationModes function executes the Operation Modes state machine. + * @brief + * The execOperationModes function executes the operation modes state machine. * @details - * Inputs : none - * Outputs : currentMode is set by state machine. + * Inputs : currentMode + * Outputs : Operation modes' state machine executed * @return none *************************************************************************/ void execOperationModes( void ) @@ -203,11 +203,11 @@ } /*********************************************************************//** - * @brief requestNewOperationMode + * @brief * The requestNewOperationMode function requests a new operation mode. * @details * Inputs : none - * Outputs : makes the requested mode "pending". + * Outputs : makes the requested mode "pending" * @param newMode requested mode * @return none *************************************************************************/ @@ -226,25 +226,26 @@ } /*********************************************************************//** - * @brief getCurrentOperationMode - * The getCurrentOperationMode function initializes the Operation Modes module. + * @brief + * The getCurrentOperationMode function returns the current operation mode. * @details * Inputs : none - * Outputs : Initializes the Operation Modes module. - * @return none + * Outputs : none + * @return current mode *************************************************************************/ DG_OP_MODE_T getCurrentOperationMode( void ) { return currentMode; } /*********************************************************************//** - * @brief arbitrateModeRequest - * The arbitrateModeRequest function initializes the Operation Modes module. + * @brief + * The arbitrateModeRequest function selects highest priority mode request + * and clear all requests. * @details * Inputs : none - * Outputs : Initializes the Operation Modes module. - * @return none + * Outputs : Arbitrated mode requests + * @return highest priority requested mode *************************************************************************/ static DG_OP_MODE_T arbitrateModeRequest( void ) { @@ -277,11 +278,12 @@ } /*********************************************************************//** - * @brief transitionToNewOperationMode - * The transitionToNewOperationMode function initializes the Operation Modes module. + * @brief + * The transitionToNewOperationMode function undergo the process of transition + * to new operation mode. * @details * Inputs : none - * Outputs : Initializes the Operation Modes module. + * Outputs : Transition to new mode * @param newMode new op mode to transition to * @return none *************************************************************************/ @@ -331,11 +333,11 @@ /*********************************************************************//** * @brief - * The broadcastOperationMode function sends the current operation mode at \n + * The broadcastOperationMode function broadcasts the current operation mode at * the prescribed interval. * @details * Inputs : broadcastModeIntervalCtr - * Outputs : DG operation mode broadcast message sent. + * Outputs : DG operation mode broadcast message sent * @return none *************************************************************************/ static void broadcastOperationMode( void ) Index: firmware/App/Modes/OperationModes.h =================================================================== diff -u -ra7bf3ca23ea37a61000379facae628a31b3ecc59 -rcc398b14ccf518f350b57fb5cb8728e5c908bd1e --- firmware/App/Modes/OperationModes.h (.../OperationModes.h) (revision a7bf3ca23ea37a61000379facae628a31b3ecc59) +++ firmware/App/Modes/OperationModes.h (.../OperationModes.h) (revision cc398b14ccf518f350b57fb5cb8728e5c908bd1e) @@ -23,8 +23,7 @@ /** * @defgroup DGOperationModes DGOperationModes - * @brief Operation Modes module. - * Manages the top level operation modes of the DG via a state machine. + * @brief Operation Modes module. Manages the top level operation modes of the DG via a state machine. * * @addtogroup DGOperationModes * @{ @@ -34,8 +33,8 @@ // ********** public function prototypes ********** -void initOperationModes( void ); // initialize this module -void execOperationModes( void ); // execute the operation modes state machine (scheduled periodic call) +void initOperationModes( void ); // initialize this module +void execOperationModes( void ); // execute the operation modes state machine (scheduled periodic call) void requestNewOperationMode( DG_OP_MODE_T newMode ); // request a transition to a new operation mode DG_OP_MODE_T getCurrentOperationMode( void ); // get the current operation mode