/**************************************************************************
*
* 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"

/**
 *  @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
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