Index: firmware/App/Modes/ModeDrain.h =================================================================== diff -u -rb64c49fdcf2b6d95e61e63f8e258c4e600935bbd -r94a190522ce398399c7b93c59f788d7666ec0060 --- firmware/App/Modes/ModeDrain.h (.../ModeDrain.h) (revision b64c49fdcf2b6d95e61e63f8e258c4e600935bbd) +++ firmware/App/Modes/ModeDrain.h (.../ModeDrain.h) (revision 94a190522ce398399c7b93c59f788d7666ec0060) @@ -1,28 +1,44 @@ /************************************************************************** - * - * 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 L. Baloa - * - * @brief Header file for Drain Mode. - * - **************************************************************************/ +* +* Copyright (c) 2019-2021 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 +* +* @author (last) Dara Navaei +* @date (last) 24-Oct-2021 +* +* @author (original) Leonardo Baloa +* @date (original) 20-Dec-2019 +* +***************************************************************************/ #ifndef __MODE_DRAIN_H__ #define __MODE_DRAIN_H__ #include "DGCommon.h" +#include "DGDefs.h" -// ********** private function prototypes ********** +/** + * @defgroup DGDrainMode DGDrainMode + * @brief Drain mode module. Manages drain mode functions via a state machine. + * + * @addtogroup DGDrainMode + * @{ + */ +// ********** public definitions ********** + +// ********** public 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 +U32 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