Index: firmware/App/Modes/ModeSolo.h =================================================================== diff -u -rf43eb1e9e0803776ec7420b16e1db8760b020bd9 -r7d4711edd7b40cd3e29f43e766f79a8a09586fe9 --- firmware/App/Modes/ModeSolo.h (.../ModeSolo.h) (revision f43eb1e9e0803776ec7420b16e1db8760b020bd9) +++ firmware/App/Modes/ModeSolo.h (.../ModeSolo.h) (revision 7d4711edd7b40cd3e29f43e766f79a8a09586fe9) @@ -1,28 +1,44 @@ -/**********************************************************************//** - * - * Copyright (c) 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 ModeSolo.h - * - * @date 18-Mar-2020 - * @author S. Nash - * - * @brief Header file for Standby-Solo Mode. - * - **************************************************************************/ +/************************************************************************** +* +* Copyright (c) 2020-2024 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 ModeSolo.h +* +* @author (last) Dara Navaei +* @date (last) 24-Oct-2021 +* +* @author (original) Sean +* @date (original) 18-Mar-2020 +* +***************************************************************************/ #ifndef __MODE_SOLO_H__ #define __MODE_SOLO_H__ #include "DGCommon.h" +#include "DGDefs.h" -// ********** private function prototypes ********** +/** + * @defgroup DGSoloStandbyMode DGSoloStandbyMode + * @brief Solo Standby mode module. Manages solo standby mode functions via a state machine. + * + * @addtogroup DGSoloStandbyMode + * @{ + */ +// ********** public definitions ********** + +// ********** public function prototypes ********** + void initSoloMode( void ); // initialize this module -void transitionToSoloMode( void ); // prepares for transition to standby-solo mode -void execSoloMode( void ); // execute the standby-solo mode state machine (call from OperationModes) +U32 transitionToSoloMode( void ); // prepares for transition to standby-solo mode +U32 execSoloMode( void ); // execute the standby-solo mode state machine (call from OperationModes) +DG_SOLO_STANDBY_STATE_T getCurrentSoloState( void ); // get the current state of the standby-solo mode. + +/**@}*/ + #endif