Index: firmware/App/Modes/ModePreTreat.h =================================================================== diff -u -r9b262ba08e3180f121c3cf19d8d25e565183f87d -r8e7158d8231435496fcf1d5649e51babf859ccc7 --- firmware/App/Modes/ModePreTreat.h (.../ModePreTreat.h) (revision 9b262ba08e3180f121c3cf19d8d25e565183f87d) +++ firmware/App/Modes/ModePreTreat.h (.../ModePreTreat.h) (revision 8e7158d8231435496fcf1d5649e51babf859ccc7) @@ -1,28 +1,41 @@ /************************************************************************** - * - * 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 ModePreTreat.h - * - * @date 19-Sep-2019 - * @author S. Nash - * - * @brief Header file for Pre-Treatment 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 ModePreTreat.h +* +* @author (last) Sean Nash +* @date (last) 22-Sep-2020 +* +* @author (original) Dara Navaei +* @date (original) 05-Nov-2019 +* +***************************************************************************/ #ifndef __MODE_PRE_TREAT_H__ #define __MODE_PRE_TREAT_H__ #include "HDCommon.h" +#include "HDDefs.h" +/** + * @defgroup HDPreTreatmentMode HDPreTreatmentMode + * @brief Pre-TreatmentMode module. + * + * @addtogroup HDPreTreatmentMode + * @{ + */ + // ********** private function prototypes ********** void initPreTreatmentMode( void ); // initialize this module void transitionToPreTreatmentMode( void ); // prepares for transition to pre-treatment mode -void execPreTreatmentMode( void ); // execute the pre-treatment mode state machine (call from OperationModes) +U32 execPreTreatmentMode( void ); // execute the pre-treatment mode state machine (call from OperationModes) +BOOL signalUserBeginningTreatment( void ); // signal that user requests treatment begin +/**@}*/ + #endif