/**************************************************************************
*
* 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 ModeRecirculate.h
*
* @author (last) Quang Nguyen
* @date (last) 14-Sep-2020
*
* @author (original) Sean
* @date (original) 04-Apr-2020
*
***************************************************************************/

#ifndef __MODE_RECIRCULATION_H__
#define __MODE_RECIRCULATION_H__

#include "DGCommon.h"
#include "DGDefs.h"

/**
 *  @defgroup DGRecirculateMode DGRecirculateMode
 *  @brief Re-circulate mode module. Manages re-circulate mode functions via a state machine.
 *
 *  @addtogroup DGRecirculateMode
 *  @{
 */

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

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

void initRecirculateMode( void );          // initialize this module
void transitionToRecirculateMode( void );  // prepares for transition to re-circulate mode
U32  execRecirculateMode( void );          // execute the re-circulate mode state machine (call from OperationModes)

DG_RECIRCULATE_MODE_STATE_T getCurrentRecirculateState( void );    // get the current state of re-circulate mode

BOOL requestDGStop( void );                // HD requests DG stop (go back to standby mode)

/**@}*/

#endif