Index: firmware/App/Modes/ModeFlush.h =================================================================== diff -u -rb64c49fdcf2b6d95e61e63f8e258c4e600935bbd -r4efb2d1786c717ca6cf4b1bc992cec8e16820bff --- firmware/App/Modes/ModeFlush.h (.../ModeFlush.h) (revision b64c49fdcf2b6d95e61e63f8e258c4e600935bbd) +++ firmware/App/Modes/ModeFlush.h (.../ModeFlush.h) (revision 4efb2d1786c717ca6cf4b1bc992cec8e16820bff) @@ -1,4 +1,4 @@ -/************************************************************************** +/**********************************************************************//** * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * @@ -8,7 +8,7 @@ * @file ModeFlush.h * * @date 20-Dec-2019 - * @author L. Baloa + * @author S. Nash * * @brief Header file for Flush Mode. * @@ -18,11 +18,27 @@ #define __MODE_FLUSH_H__ #include "DGCommon.h" +#include "DGDefs.h" +/** + * @defgroup DGFlushMode DGFlushMode + * @brief Flush mode module. Manages the state machine for the + * flush mode. + * + * @addtogroup DGFlushMode + * @{ + */ + +// ********** public definitions ********** + // ********** private function prototypes ********** void initFlushMode( void ); // initialize this module void transitionToFlushMode( void ); // prepares for transition to pre-treatment mode -void execFlushMode( void ); // execute the pre-treatment mode state machine (call from OperationModes) +U32 execFlushMode( void ); // execute the pre-treatment mode state machine (call from OperationModes) +DG_FLUSH_STATE_T getCurrentFlushState( void ); // get the current state of the flush mode. + +/**@}*/ + #endif