Index: firmware/App/Services/AlarmMgmtDD.c =================================================================== diff -u -racce65f1450d3deb39d3ed07f2e841c11d3d4df7 -r39475b40d39d5fc87c8d15bb0805b96a7594433b --- firmware/App/Services/AlarmMgmtDD.c (.../AlarmMgmtDD.c) (revision acce65f1450d3deb39d3ed07f2e841c11d3d4df7) +++ firmware/App/Services/AlarmMgmtDD.c (.../AlarmMgmtDD.c) (revision 39475b40d39d5fc87c8d15bb0805b96a7594433b) @@ -14,168 +14,165 @@ * @date (original) 05-Aug-2024 * ***************************************************************************/ +#define __ALARM_MGMT_DD_C__ #include "AlarmMgmtDD.h" -//#include "CPLD.h" +#include "Messaging.h" #include "OperationModes.h" #include "PersistentAlarm.h" #include "SafetyShutdown.h" -#include "TaskGeneral.h" -#include "Timers.h" -#include "Messaging.h" -#include "TDDefs.h" #include "SystemCommDD.h" - -/** - * @addtogroup AlarmManagement - * @{ - */ - -// ********** private definitions ********** +#include "TaskGeneral.h" +#include "TDDefs.h" +#include "Timers.h" -/// Interval (ms/task time) at which the alarm information is published on the CAN bus. -#define ALARM_INFO_PUB_INTERVAL ( MS_PER_SECOND / TASK_GENERAL_INTERVAL ) + +/** + * @addtogroup AlarmManagement + * @{ + */ + +// ********** private definitions ********** + +#define ALARM_INFO_PUB_INTERVAL ( MS_PER_SECOND / TASK_GENERAL_INTERVAL ) /// Interval (ms/task time) at which the alarm information is published on the CAN bus. #define DATA_PUBLISH_COUNTER_START_COUNT 12 ///< Data publish counter start count. -#define ALARM_DG_FAULT_LED_ON_INTERVAL ( MS_PER_SECOND / 4 / TASK_GENERAL_INTERVAL ) ///< LED Flash ON time interval time -#define ALARM_DG_FAULT_LED_OFF_INTERVAL ( ALARM_DG_FAULT_LED_ON_INTERVAL * 2 ) ///< LED Flash OFF time interval time +#define SUPERVISOR_ALARM_KEY 0xD2C3B4A5 ///< 32-bit key required for clear all alarms request. -U32 alarmLEDTimer; ///< Alarm LED timer - -const ALARM_DATA_T BLANK_ALARM_DATA = { ALARM_DATA_TYPE_NONE, 0 }; ///< A blank alarm data record for alarms that do not include alarm data when triggered. - -#define SUPERVISOR_ALARM_KEY 0xD2C3B4A5 ///< 32-bit key required for clear all alarms request. +const ALARM_DATA_T BLANK_ALARM_DATA = { ALARM_DATA_TYPE_NONE, 0 }; ///< A blank alarm data record for alarms that do not include alarm data when triggered. -// ********** private data ********** +// ********** private data ********** static U32 alarmInfoPublicationTimerCounter; ///< Used to schedule alarm information publication to CAN bus. -static BOOL isAFaultAlarmActive; ///< Boolean flag to indicate whether a DG fault alarm is active. +static BOOL isAFaultAlarmActive; ///< Boolean flag to indicate whether a DD fault alarm is active. + /// Interval (in task intervals) at which to publish alarm information to CAN bus. static OVERRIDE_U32_T alarmInfoPublishInterval = { ALARM_INFO_PUB_INTERVAL, ALARM_INFO_PUB_INTERVAL, ALARM_INFO_PUB_INTERVAL, 0 }; - -// ********** private function prototypes ********** - -static void activateAlarmDD( ALARM_ID_T alarm ); + +// ********** private function prototypes ********** + +static void activateAlarmDD( ALARM_ID_T alarm ); static void publishAlarmInfo( void ); static BOOL isTransitionToFaultRequired( void ); - -/*********************************************************************//** - * @brief - * The initAlarmMgmtDD function initializes the AlarmMgmt module. - * @details \b Inputs: none - * @details \b Outputs: alarmInfoPublicationTimerCounter, alarmLEDTimer, - * isAFaultAlarmActive, alarmIsActive, alarmIsDetected - * @return none - *************************************************************************/ -void initAlarmMgmtDD( void ) -{ + +/*********************************************************************//** + * @brief + * The initAlarmMgmtDD function initializes the AlarmMgmt unit. + * @details \b Inputs: none + * @details \b Outputs: unit variables initialized. + * @return none + *************************************************************************/ +void initAlarmMgmtDD( void ) +{ alarmInfoPublicationTimerCounter = DATA_PUBLISH_COUNTER_START_COUNT; - alarmLEDTimer = 0; isAFaultAlarmActive = FALSE; // Initialize common alarm mgmt unit - initAlarmMgmt(); -} + initAlarmMgmt(); +} -/*********************************************************************//** - * @brief - * The execAlarmMgmt function executes the alarm management module. - * @details \b Inputs: none - * @details \b Outputs: none - * @return none - *************************************************************************/ -void execAlarmMgmt( void ) -{ +/*********************************************************************//** + * @brief + * The execAlarmMgmt function executes periodic alarm management operations. + * @details \b Inputs: none + * @details \b Outputs: none + * @return none + *************************************************************************/ +void execAlarmMgmt( void ) +{ // Publish alarm information at interval publishAlarmInfo(); -} +} -/*********************************************************************//** - * @brief +/*********************************************************************//** + * @brief * The activateAlarmDD function activates a given alarm. if the alarm is - * DD fault, transition fault operation mode immediately. - * @details \b Inputs: none + * DD fault, transition fault operation mode immediately. + * @details \b Inputs: none * @details \b Outputs: alarmIsActive[], isAFaultAlarmActive - * @details \b Alarm: ALARM_ID_DD_SOFTWARE_FAULT when invalid alarm asked to activate. - * @param alarm ID of alarm to activate - * @return none - *************************************************************************/ -static void activateAlarmDD( ALARM_ID_T alarm ) -{ - // verify given alarm - if ( ( alarm > ALARM_ID_NO_ALARM ) && ( alarm < NUM_OF_ALARM_IDS ) ) - { + * @details \b Alarm: ALARM_ID_DD_SOFTWARE_FAULT when invalid alarm asked to activate. + * @param alarm ID of alarm to activate + * @return none + *************************************************************************/ +static void activateAlarmDD( ALARM_ID_T alarm ) +{ + // verify given alarm + if ( ( alarm > ALARM_ID_NO_ALARM ) && ( alarm < NUM_OF_ALARM_IDS ) ) + { ALARM_T props = getAlarmProperties( alarm ); - // no need to do anything if alarm is already active - if ( FALSE == isAlarmActive( alarm ) ) - { - // activate alarm + // no need to do anything if alarm is already active + if ( FALSE == isAlarmActive( alarm ) ) + { + // activate alarm activateAlarm( alarm ); - if ( TRUE == props.alarmIsDGFault ) + if ( TRUE == props.alarmIsDDFault ) { - // There is a DG fault alarm. + // There is a DD fault alarm. isAFaultAlarmActive = TRUE; if ( TRUE == isTransitionToFaultRequired() ) { - // If alarm is a DG fault and the alarm manager can transition to fault immediately, go to fault mode + // If alarm is a DD fault and the alarm manager can transition to fault immediately, go to fault mode + //TODO : Testing - remove the comment later requestNewOperationMode( DD_MODE_FAUL ); } - } - } - } - else - { - SET_ALARM_WITH_2_U32_DATA( ALARM_ID_DD_SOFTWARE_FAULT, SW_FAULT_ID_ALARM_MGMT_INVALID_ALARM_TO_ACTIVATE, alarm ) - } -} + } + } + } + else + { + SET_ALARM_WITH_2_U32_DATA( ALARM_ID_DD_SOFTWARE_FAULT, SW_FAULT_ID_ALARM_MGMT_INVALID_ALARM_TO_ACTIVATE, alarm ) + } +} -/*********************************************************************//** - * @brief +/*********************************************************************//** + * @brief * The activateAlarmNoData function activates a given alarm. An alarm message * is broadcast to the rest of the system.it doesn't contain any parameters - * associated to alarm. - * @details \b Inputs: none - * @details \b Outputs: alarm triggered message sent, alarm activated - * @param alarm ID of alarm to activate - * @return none - *************************************************************************/ -void activateAlarmNoData( ALARM_ID_T alarm ) + * associated to alarm. + * @details \b Inputs: none + * @details \b Outputs: alarm triggered message sent, alarm activated + * @param alarm ID of alarm to activate + * @return none + *************************************************************************/ +void activateAlarmNoData( ALARM_ID_T alarm ) { - activateAlarm2Data( alarm, BLANK_ALARM_DATA, BLANK_ALARM_DATA, FALSE ); -} + activateAlarm2Data( alarm, BLANK_ALARM_DATA, BLANK_ALARM_DATA, FALSE ); +} -/*********************************************************************//** - * @brief +/*********************************************************************//** + * @brief * The activateAlarm1Data function activates a given alarm. An alarm message * is broadcast to the rest of the system. This function will include given - * data in the broadcast message for logging. - * @details \b Inputs: none - * @details \b Outputs: alarm triggered message sent, alarm activated - * @param alarm ID of alarm to activate - * @param alarmData supporting data to include in alarm message - * @return none - *************************************************************************/ -void activateAlarm1Data( ALARM_ID_T alarm, ALARM_DATA_T alarmData ) + * data in the broadcast message for logging. + * @details \b Inputs: none + * @details \b Outputs: alarm triggered message sent, alarm activated + * @param alarm ID of alarm to activate + * @param alarmData supporting data to include in alarm message + * @return none + *************************************************************************/ +void activateAlarm1Data( ALARM_ID_T alarm, ALARM_DATA_T alarmData ) { - activateAlarm2Data( alarm, alarmData, BLANK_ALARM_DATA, FALSE ); -} + activateAlarm2Data( alarm, alarmData, BLANK_ALARM_DATA, FALSE ); +} -/*********************************************************************//** - * @brief +/*********************************************************************//** + * @brief * The activateAlarm2Data function activates a given alarm. An alarm message * is broadcast to the rest of the system. This function will include - * two given data in the broadcast message for logging. - * @details \b Inputs: none - * @details \b Outputs: alarm triggered message sent, alarm activated - * @param alarm ID of alarm to activate - * @param alarmData1 supporting data to include in alarm message - * @param alarmData2 supporting data to include in alarm message + * two given data in the broadcast message for logging. + * @details \b Inputs: none + * @details \b Outputs: alarm triggered message sent, alarm activated + * @details \b Message \b sent: MSG_ID_ALARM_TRIGGERED to update Alarm + * trigerred details along with the supporting data. + * @param alarm ID of alarm to activate + * @param alarmData1 supporting data to include in alarm message + * @param alarmData2 supporting data to include in alarm message * @param outside flag indicates whether alarm is originating from outside HD f/w - * @return none - *************************************************************************/ -void activateAlarm2Data( ALARM_ID_T alarm, ALARM_DATA_T alarmData1, ALARM_DATA_T alarmData2, BOOL outside ) + * @return none + *************************************************************************/ +void activateAlarm2Data( ALARM_ID_T alarm, ALARM_DATA_T alarmData1, ALARM_DATA_T alarmData2, BOOL outside ) { TD_MODE_SUB_MODE_T tdModes; ALARM_T props = getAlarmProperties( alarm ); @@ -193,49 +190,53 @@ } activateAlarmDD( alarm ); } -} +} -/*********************************************************************//** - * @brief +/*********************************************************************//** + * @brief * The clearAlarmDD function clears a given alarm if it is recoverable. - * An alarm message is broadcast to the rest of the system. - * @details \b Inputs: none + * An alarm message is broadcast to the rest of the system. + * @details \b Inputs: none * @details \b Outputs: AlarmStatusTable[] + * @details \b Message \Sent: MSG_ID_ALARM_CLEARED to update clearance of + * the alarm. * @details \b Alarm: ALARM_ID_DD_SOFTWARE_FAULT when invalid alarm needs - * to be cleared. - * @param alarm ID of alarm to clear - * @return none - *************************************************************************/ -void clearAlarmDD( ALARM_ID_T alarm ) -{ + * to be cleared. + * @param alarm ID of alarm to clear + * @return none + *************************************************************************/ +void clearAlarmDD( ALARM_ID_T alarm ) +{ ALARM_T props = getAlarmProperties( alarm ); - // verify given alarm - if ( ( alarm > ALARM_ID_NO_ALARM ) && ( alarm < NUM_OF_ALARM_IDS ) ) - { - // clear alarm and broadcast alarm clear if not already cleared (and not a DG fault which should not be cleared) - if ( ( TRUE == isAlarmActive( alarm ) ) && ( props.alarmIsDGFault != TRUE ) ) + // verify given alarm + if ( ( alarm > ALARM_ID_NO_ALARM ) && ( alarm < NUM_OF_ALARM_IDS ) ) + { + // clear alarm and broadcast alarm clear if not already cleared (and not a DD fault which should not be cleared) + if ( ( TRUE == isAlarmActive( alarm ) ) && ( props.alarmIsDDFault != TRUE ) ) { if ( TRUE == isTDCommunicating() ) - { + { broadcastAlarmCleared( alarm ); } - setAlarmActive( alarm, FALSE ); - clearAlarmConditionDD( alarm ); - } - } - else - { - SET_ALARM_WITH_2_U32_DATA( ALARM_ID_DD_SOFTWARE_FAULT, SW_FAULT_ID_ALARM_MGMT_INVALID_ALARM_TO_CLEAR, alarm ) - } -} + setAlarmActive( alarm, FALSE ); + clearAlarmConditionDD( alarm ); + } + } + else + { + SET_ALARM_WITH_2_U32_DATA( ALARM_ID_DD_SOFTWARE_FAULT, SW_FAULT_ID_ALARM_MGMT_INVALID_ALARM_TO_CLEAR, alarm ) + } +} /*********************************************************************//** * @brief * The clearAlarmConditionDD function clears a given alarm's condition detected * flag. Also an alarm message is broadcast to the rest of the system. * @details \b Inputs: none * @details \b Outputs: alarmIsDetected[] + * @details \b Message \b Sent: MSG_ID_ALARM_CONDITION_CLEARED to update + * alarm condition clearance. * @details \b Alarm: ALARM_ID_DD_SOFTWARE_FAULT when invalid alarm conditioned * needs to be cleared * @param alarm ID of alarm to clear condition for @@ -281,6 +282,8 @@ * interval. * @details \b Inputs: * @details \b Outputs: alarm information are published to CAN bus. + * @details \b Message \b Sent: MSG_ID_DD_ALARM_INFO_DATA to puslish saftey + * shutdown activation details. * @return none *************************************************************************/ static void publishAlarmInfo( void ) @@ -293,7 +296,6 @@ data.safetyShutdownStatus = (U32)isSafetyShutdownActivated(); broadcastData( MSG_ID_DD_ALARM_INFO_DATA, COMM_BUFFER_OUT_CAN_DD_ALARM, (U08*)&data, sizeof( SAFETY_SHUTDOWN_ACTIVATION_DATA_T ) ); - //broadcastCPLDStatus(); alarmInfoPublicationTimerCounter = 0; } } @@ -304,6 +306,7 @@ * all active alarms. * @details \b Inputs: alarmIsActive[] * @details \b Outputs: re-send active alarms to UI +* @details \b Message \b Sent: MSG_ID_ALARM_TRIGGERED to resend all active alarms. * @return none *************************************************************************/ void handleResendActiveAlarmsRequest( void ) @@ -332,12 +335,12 @@ BOOL status = FALSE; // Check all the inlet water conditions -// status |= isAlarmActive( ALARM_ID_DG_CLEANING_MODE_INLET_WATER_TEMP_TOO_HIGH ); -// status |= isAlarmActive( ALARM_ID_DG_CLEANING_MODE_INLET_WATER_TEMP_TOO_LOW ); -// status |= isAlarmActive( ALARM_ID_DG_CLEANING_MODE_INLET_WATER_COND_TOO_HIGH ); -// status |= isAlarmActive( ALARM_ID_DG_CLEANING_MODE_INLET_WATER_COND_TOO_LOW ); -// status |= isAlarmActive( ALARM_ID_DG_CLEANING_MODE_INLET_WATER_PRESSURE_TOO_HIGH ); -// status |= isAlarmActive( ALARM_ID_DG_CLEANING_MODE_INLET_WATER_PRESSURE_TOO_LOW ); +// status |= isAlarmActive( ALARM_ID_DD_CLEANING_MODE_INLET_WATER_TEMP_TOO_HIGH ); +// status |= isAlarmActive( ALARM_ID_DD_CLEANING_MODE_INLET_WATER_TEMP_TOO_LOW ); +// status |= isAlarmActive( ALARM_ID_DD_CLEANING_MODE_INLET_WATER_COND_TOO_HIGH ); +// status |= isAlarmActive( ALARM_ID_DD_CLEANING_MODE_INLET_WATER_COND_TOO_LOW ); +// status |= isAlarmActive( ALARM_ID_DD_CLEANING_MODE_INLET_WATER_PRESSURE_TOO_HIGH ); +// status |= isAlarmActive( ALARM_ID_DD_CLEANING_MODE_INLET_WATER_PRESSURE_TOO_LOW ); return status; } @@ -357,11 +360,9 @@ switch( opMode ) { - //case DG_MODE_FLUS: + //case DD_MODE_FLUS: case DD_MODE_HEAT: - //case DG_MODE_CHEM: case DD_MODE_SERV: - //case DG_MODE_CHFL: case DD_MODE_HCOL: case DD_MODE_ROPS: status = FALSE; @@ -374,18 +375,21 @@ return status; } - -/************************************************************************* - * TEST SUPPORT FUNCTIONS - *************************************************************************/ + +/************************************************************************* + * TEST SUPPORT FUNCTIONS + *************************************************************************/ + + /*********************************************************************//** * @brief * The testClearAllAlarms function clears all active alarms, even if they * are non-recoverable or faults. The caller of this function must provide - * the correct 32-bit key. A Dialin user must also be logged into DG. + * the correct 32-bit key. A Dialin user must also be logged into DD. * @details \b Inputs: none * @details \b Outputs: alarmIsActive[], alarmStartedAt[] + * @details \b Message \b Sent: MSG_ID_ALARM_CLEARED to clear all alarms. * @param key 32-bit supervisor alarm key required to perform this function * @return TRUE if override reset successful, FALSE if not *************************************************************************/