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

#ifndef __MODE_GEN_IDLE_H__
#define __MODE_GEN_IDLE_H__

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

/**
 *  @defgroup DGGenIdleMode DGgenIdleMode
 *  @brief Generation idle mode module. Manages generation idle mode functions via a state machine.
 *
 *  @addtogroup DGGenIdleMode
 *  @{
 */

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

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

void initGenIdleMode( void );               // initialize this module
void transitionToGenIdleMode( void );       // prepares for transition to generation idle mode
U32  execGenIdleMode( void );               // execute the generation idle mode state machine (call from OperationModes)

DG_GEN_IDLE_MODE_STATE_T getCurrentGenIdleState( void );    // get the current state of generation idle mode

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

/**@}*/

#endif