Index: firmware/App/Modes/ModeFlush.h =================================================================== diff -u -rb64c49fdcf2b6d95e61e63f8e258c4e600935bbd -r7d4711edd7b40cd3e29f43e766f79a8a09586fe9 --- firmware/App/Modes/ModeFlush.h (.../ModeFlush.h) (revision b64c49fdcf2b6d95e61e63f8e258c4e600935bbd) +++ firmware/App/Modes/ModeFlush.h (.../ModeFlush.h) (revision 7d4711edd7b40cd3e29f43e766f79a8a09586fe9) @@ -1,28 +1,44 @@ /************************************************************************** - * - * 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 ModeFlush.h - * - * @date 20-Dec-2019 - * @author L. Baloa - * - * @brief Header file for Flush Mode. - * - **************************************************************************/ +* +* Copyright (c) 2019-2024 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 ModeFlush.h +* +* @author (last) Dara Navaei +* @date (last) 24-Oct-2021 +* +* @author (original) Leonardo Baloa +* @date (original) 20-Dec-2019 +* +***************************************************************************/ #ifndef __MODE_FLUSH_H__ #define __MODE_FLUSH_H__ #include "DGCommon.h" +#include "DGDefs.h" -// ********** private function prototypes ********** +/** + * @defgroup DGFlushMode DGFlushMode + * @brief Flush mode module. Manages the state machine for the flush mode. + * + * @addtogroup DGFlushMode + * @{ + */ +// ********** public 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 transitionToFlushMode( void ); // prepares for transition to pre-treatment mode +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. + +BOOL stopDGFlush( void ); + +/**@}*/ + #endif