Index: firmware/App/Drivers/SafetyShutdown.h =================================================================== diff -u -r9b262ba08e3180f121c3cf19d8d25e565183f87d -r8e7158d8231435496fcf1d5649e51babf859ccc7 --- firmware/App/Drivers/SafetyShutdown.h (.../SafetyShutdown.h) (revision 9b262ba08e3180f121c3cf19d8d25e565183f87d) +++ firmware/App/Drivers/SafetyShutdown.h (.../SafetyShutdown.h) (revision 8e7158d8231435496fcf1d5649e51babf859ccc7) @@ -1,27 +1,43 @@ -/************************************************************************** - * - * 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 SafetyShutdown.h - * - * @date 20-Sep-2019 - * @author S. Nash - * - * @brief Header file for Safety Shutdown Controller. - * - **************************************************************************/ +/************************************************************************** +* +* 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 SafetyShutdown.h +* +* @author (last) Sean Nash +* @date (last) 01-Jun-2020 +* +* @author (original) Dara Navaei +* @date (original) 05-Nov-2019 +* +***************************************************************************/ #ifndef __SAFETY_SHUTDOWN_H__ #define __SAFETY_SHUTDOWN_H__ #include "HDCommon.h" +/** + * @defgroup SafetyShutdown SafetyShutdown + * @brief Safety Shutdown module. Allows any module to activate the safety shutdown + * signal. + * + * @addtogroup SafetyShutdown + * @{ + */ + // ********** public function prototypes ********** void initSafetyShutdown( void ); void activateSafetyShutdown( void ); +BOOL isSafetyShutdownActivated( void ); +BOOL testSetSafetyShutdownOverride( U32 value ); +BOOL testResetSafetyShutdownOverride( void ); + +/**@}*/ + #endif