Index: firmware/App/Controllers/Buttons.c =================================================================== diff -u -r9a20996b770f446b8c669cba7a49668c1fdadd67 -r8e7158d8231435496fcf1d5649e51babf859ccc7 --- firmware/App/Controllers/Buttons.c (.../Buttons.c) (revision 9a20996b770f446b8c669cba7a49668c1fdadd67) +++ firmware/App/Controllers/Buttons.c (.../Buttons.c) (revision 8e7158d8231435496fcf1d5649e51babf859ccc7) @@ -1,14 +1,14 @@ /************************************************************************** * -* Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. +* 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 Buttons.c * * @author (last) Sean Nash -* @date (last) 29-May-2020 +* @date (last) 24-Sep-2020 * * @author (original) Dara Navaei * @date (original) 05-Nov-2019 @@ -105,9 +105,8 @@ /*********************************************************************//** * @brief * The initButtons function initializes the Buttons module. - * @details - * Inputs : none - * Outputs : Buttons module initialized. + * @details Inputs: none + * @details Outputs: Buttons module initialized. * @return none *************************************************************************/ void initButtons( void ) @@ -130,9 +129,8 @@ /*********************************************************************//** * @brief * The execButtons function executes the Buttons monitor. - * @details - * Inputs : none - * Outputs : offButtonState, stopButtonState, prevOffButtonState, prevStopButtonState + * @details Inputs: none + * @details Outputs: offButtonState, stopButtonState, prevOffButtonState, prevStopButtonState * @return none *************************************************************************/ void execButtons( void ) @@ -156,9 +154,8 @@ * The isStopButtonPressed function determines whether the stop button has been * pressed. Once the stop button has transitioned from released to pressed, a * press for the stop button will be pending until this function is called. - * @details - * Inputs : stopButtonPressPending - * Outputs : stopButtonPressPending + * @details Inputs: stopButtonPressPending + * @details Outputs: stopButtonPressPending * @return true if the stop button is pressed, false if not *************************************************************************/ BOOL isStopButtonPressed( void ) @@ -174,9 +171,8 @@ * @brief * The getOffButtonState function determines whether the off button is * currently pressed. - * @details - * Inputs : dataOffButtonState, prevOffButtonState - * Outputs : none + * @details Inputs: dataOffButtonState, prevOffButtonState + * @details Outputs: none * @return BUTTON_STATE_PRESSED if off button pressed, BUTTON_STATE_RELEASED if not *************************************************************************/ BUTTON_STATE_T getOffButtonState( void ) @@ -195,9 +191,8 @@ * @brief * The getStopButtonState function determines whether the stop button is * currently pressed. - * @details - * Inputs : dataStopButtonState, prevStopButtonState - * Outputs : none + * @details Inputs: dataStopButtonState, prevStopButtonState + * @details Outputs: none * @return BUTTON_STATE_PRESSED if stop button pressed, BUTTON_STATE_RELEASED if not *************************************************************************/ BUTTON_STATE_T getStopButtonState( void ) @@ -217,9 +212,8 @@ * The execStuckButtonTest function executes the stuck button test. * This function should be called periodically until a pass or fail * result is returned. - * @details - * Inputs : dataOffButtonState - * Outputs : buttonSelfTestState, buttonSelfTestTimerCount + * @details Inputs: dataOffButtonState + * @details Outputs: buttonSelfTestState, buttonSelfTestTimerCount * @return in progress, passed, or failed *************************************************************************/ SELF_TEST_STATUS_T execStuckButtonTest( void ) @@ -269,9 +263,8 @@ * The userConfirmOffButton function handles user confirmation of the off * button. The off request will be initiated here if confirmed or cancelled * if rejected by user. - * @details - * Inputs : current operation mode - * Outputs : stopButtonPressPending + * @details Inputs: current operation mode + * @details Outputs: stopButtonPressPending * @param response 1 = confirmed, 0 = rejected * @return none *************************************************************************/ @@ -340,9 +333,8 @@ * @brief * The isCurrentOpModeOkToTurnOff function determines whether the system can * be turned off in current operation mode. - * @details - * Inputs : Current operation mode. - * Outputs : none + * @details Inputs: Current operation mode. + * @details Outputs: none * @return TRUE if can turn system off in current mode, FALSE if not *************************************************************************/ static BOOL isCurrentOpModeOkToTurnOff( void ) @@ -362,9 +354,8 @@ * @brief * The handleOffButtonProcessing function checks for and processes off button * activity. - * @details - * Inputs : offButtonState, prevOffButtonState - * Outputs : offButtonPressPending, offRequestPulseCount, offRequestPulseTimer + * @details Inputs: offButtonState, prevOffButtonState + * @details Outputs: offButtonPressPending, offRequestPulseCount, offRequestPulseTimer * @return none *************************************************************************/ static void handleOffButtonProcessing( void ) @@ -421,9 +412,8 @@ * @brief * The handleStopButtonProcessing function checks for and processes stop button * activity. - * @details - * Inputs : stopButtonState, prevStopButtonState - * Outputs : stopButtonPressPending + * @details Inputs: stopButtonState, prevStopButtonState + * @details Outputs: stopButtonPressPending * @return none *************************************************************************/ static void handleStopButtonProcessing( void ) @@ -461,9 +451,8 @@ * @brief * The testSetOffButtonStateOverride function overrides the state of then * off button with a given state.n - * @details - * Inputs : none - * Outputs : dataOffButtonState + * @details Inputs: none + * @details Outputs: dataOffButtonState * @param value override state for the off button * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -485,9 +474,8 @@ * @brief * The testResetOffButtonStateOverride function resets the override of then * state of the off button. - * @details - * Inputs : none - * Outputs : dataOffButtonState + * @details Inputs: none + * @details Outputs: dataOffButtonState * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetOffButtonStateOverride( void ) @@ -508,9 +496,8 @@ * @brief * The testSetStopButtonStateOverride function overrides the state of then * stop button with a given state. - * @details - * Inputs : none - * Outputs : dataStopButtonState + * @details Inputs: none + * @details Outputs: dataStopButtonState * @param value override state for the stop button * @return TRUE if override successful, FALSE if not *************************************************************************/ @@ -532,9 +519,8 @@ * @brief * The testResetStopButtonStateOverride function resets the override of then * state of the stop button. - * @details - * Inputs : none - * Outputs : dataStopButtonState + * @details Inputs: none + * @details Outputs: dataStopButtonState * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testResetStopButtonStateOverride( void )