Index: firmware/App/Modes/ModeService.h =================================================================== diff -u -rb64c49fdcf2b6d95e61e63f8e258c4e600935bbd -r4efb2d1786c717ca6cf4b1bc992cec8e16820bff --- firmware/App/Modes/ModeService.h (.../ModeService.h) (revision b64c49fdcf2b6d95e61e63f8e258c4e600935bbd) +++ firmware/App/Modes/ModeService.h (.../ModeService.h) (revision 4efb2d1786c717ca6cf4b1bc992cec8e16820bff) @@ -1,4 +1,4 @@ -/************************************************************************** +/**********************************************************************//** * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * @@ -18,11 +18,27 @@ #define __MODE_SERVICE_H__ #include "DGCommon.h" +#include "DGDefs.h" +/** + * @defgroup DGServiceMode DGServiceMode + * @brief Service mode module. + * Manages service mode functions via a state machine. + * + * @addtogroup DGServiceMode + * @{ + */ + +// ********** public definitions ********** + // ********** private function prototypes ********** void initServiceMode( void ); // initialize this module void transitionToServiceMode( void ); // prepares for transition to service mode -void execServiceMode( void ); // execute the service mode state machine (call from OperationModes) +U32 execServiceMode( void ); // execute the service mode state machine (call from OperationModes) +DG_SERVICE_STATE_T getCurrentServiceState( void ); // get the current state of the service mode. + +/**@}*/ + #endif