Index: firmware/App/Modes/ModeDrain.h =================================================================== diff -u -rb64c49fdcf2b6d95e61e63f8e258c4e600935bbd -r4efb2d1786c717ca6cf4b1bc992cec8e16820bff --- firmware/App/Modes/ModeDrain.h (.../ModeDrain.h) (revision b64c49fdcf2b6d95e61e63f8e258c4e600935bbd) +++ firmware/App/Modes/ModeDrain.h (.../ModeDrain.h) (revision 4efb2d1786c717ca6cf4b1bc992cec8e16820bff) @@ -1,4 +1,4 @@ -/************************************************************************** +/**********************************************************************//** * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * @@ -8,7 +8,7 @@ * @file ModeDrain.h * * @date 19-Sep-2019 - * @author L. Baloa + * @author S. Nash * * @brief Header file for Drain Mode. * @@ -18,11 +18,27 @@ #define __MODE_DRAIN_H__ #include "DGCommon.h" +#include "DGDefs.h" +/** + * @defgroup DGDrainMode DGDrainMode + * @brief Drain mode module. + * Manages drain mode functions via a state machine. + * + * @addtogroup DGDrainMode + * @{ + */ + +// ********** public definitions ********** + // ********** private function prototypes ********** void initDrainMode( void ); // initialize this module -void transitionToDrainMode( void ); // prepares for transition to operating parameters mode -void execDrainMode( void ); // execute the drain mode state machine +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