/**************************************************************************
*
* Copyright (c) 2024-2025 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    FilterFlush.h
*
* @author  (last)      Michael Garthwaite
* @date    (last)      03-Mar-2025
*
* @author  (original)  Michael Garthwaite
* @date    (original)  03-Mar-2025
*
***************************************************************************/

#ifndef __FILTER_FLUSH_H__
#define __FILTER_FLUSH_H__

#include "FPCommon.h"
#include "RODefs.h"

/**
 *  @defgroup FPFilterFlush FPFilterFlush
 *  @brief Filter Flush unit. Manages filter flush functions via a state machine.
 *
 *  @addtogroup FPFilterFlush
 *  @{
 */

// ********** public definitions **********

/// Filter Flush data structure
typedef struct
{
    U32 filterFlushExecState;                          ///< Filter Flush execution state
} FILTER_FLUSH_DATA_T;

// ********** public function prototypes **********

void initFilterFlushMode( void );                          // Initialize this gen water mode unit
U32  transitionToFilterFlushMode( void );                  // Transition to gen water mode
U32  execFilterFlushMode( void );                          // Execute the gen water mode state machine (call from OperationModes)

FP_FILTER_FLUSH_STATE_T getCurrentFilterFlushState( void );   // Get the current state of the gen water mode

/**@}*/


#endif