/**********************************************************************//**
 *
 *  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 ModeDrain.h
 *
 *  @date 19-Sep-2019
 *  @author S. Nash
 *
 *  @brief Header file for Drain Mode.
 *
 **************************************************************************/

#ifndef __MODE_DRAIN_H__
#define __MODE_DRAIN_H__

#include "DGCommon.h"
#include "DGModes.h"

/**
 *  @defgroup DrainMode DrainMode
 *  @brief Drain mode module.
 *  Manages drain mode functions via a state machine.
 *
 *  @addtogroup DrainMode
 *  @{
 */

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

// ********** private function prototypes **********

void initDrainMode( void );         // initialize this module
void transitionToDrainMode( void ); // prepares for transition to operating parameters mode
U32 execDrainMode( void );          // execute the drain mode state machine

DG_DRAIN_STATE_T getCurrentDrainState( void );  // get the current state of the drain mode.

/**@}*/

#endif