Index: firmware/App/Drivers/SafetyShutdown.h =================================================================== diff -u -ra303cd4258157a8fbcbd8af4dd2bbaadec1a736c -r7d4711edd7b40cd3e29f43e766f79a8a09586fe9 --- firmware/App/Drivers/SafetyShutdown.h (.../SafetyShutdown.h) (revision a303cd4258157a8fbcbd8af4dd2bbaadec1a736c) +++ firmware/App/Drivers/SafetyShutdown.h (.../SafetyShutdown.h) (revision 7d4711edd7b40cd3e29f43e766f79a8a09586fe9) @@ -1,25 +1,51 @@ -/************************************************************************** - * - * 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-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 SafetyShutdown.h +* +* @author (last) Dara Navaei +* @date (last) 17-Jan-2023 +* +* @author (original) Dara Navaei +* @date (original) 05-Nov-2019 +* +***************************************************************************/ #ifndef __SAFETY_SHUTDOWN_H__ #define __SAFETY_SHUTDOWN_H__ +#include "DGCommon.h" + +/** + * @defgroup SafetyShutdown SafetyShutdown + * @brief Safety Shutdown module. Allows any module to activate the safety shutdown signal. + * + * @addtogroup SafetyShutdown + * @{ + */ + +// ********** public definitions ********** +/// Safety shutdown broadcast data +typedef struct +{ + U32 isSafetyShutdownActivated; ///< Is safety shutdown active boolean flag +} DG_SAFETY_SHUTDOWN_DATA_T; + // ********** public function prototypes ********** void initSafetyShutdown( void ); void activateSafetyShutdown( void ); +BOOL isSafetyShutdownActivated( void ); +SELF_TEST_STATUS_T execSafetyShutdownTest( void ); +void resetSafetyShutdownPOSTState( void ); +BOOL testSetSafetyShutdownOverride( U32 value ); +BOOL testResetSafetyShutdownOverride( void ); + +/**@}*/ + #endif