Index: firmware/App/Services/AlarmMgmt.c =================================================================== diff -u -rfa1a1b4206b3a917f93262bea47140a8a7d1afe3 -r72598f0fb0dc610f0dc8d624f0737f951ce6ac56 --- firmware/App/Services/AlarmMgmt.c (.../AlarmMgmt.c) (revision fa1a1b4206b3a917f93262bea47140a8a7d1afe3) +++ firmware/App/Services/AlarmMgmt.c (.../AlarmMgmt.c) (revision 72598f0fb0dc610f0dc8d624f0737f951ce6ac56) @@ -7,8 +7,8 @@ * * @file AlarmMgmt.c * -* @author (last) Sean Nash -* @date (last) 04-May-2023 +* @author (last) Vinayakam Mani +* @date (last) 11-Sep-2023 * * @author (original) Sean Nash * @date (original) 07-Nov-2019 @@ -142,6 +142,7 @@ static BOOL alarmAudioTestToneRequested; ///< Flag indicates whether alarm audio test tone should be output. static BOOL resumeBlockedByAlarmProperty; ///< Flag indicates whether treatment resumption is currently blocked by alarm property. +static BOOL alarmNoRetrigger; ///< Flag indicates whether some alarms should be prevented from re-triggering after being cleared by rinseback or end-tx options // ********** private function prototypes ********** @@ -154,7 +155,7 @@ static void updateAlarmsSilenceStatus( void ); static void updateAlarmsFlags( void ); -static void clearAllRecoverableAlarms( void ); +static BOOL clearAllRecoverableAlarms( ALARM_USER_ACTION_T action ); static void resetAlarmPriorityFIFO( ALARM_PRIORITY_T priority ); static U32 getAlarmStartTime( ALARM_ID_T alarmID ); @@ -222,6 +223,7 @@ alarmsBlockedTimer = 0; alarmAudioTestToneRequested = FALSE; resumeBlockedByAlarmProperty = FALSE; + alarmNoRetrigger = FALSE; alarmAudioSelfTestState = ALARM_AUDIO_SELF_TEST_STATE_START; } @@ -267,6 +269,13 @@ if ( ( FALSE == alarmIsActive[ alarm ] ) || ( ( FALSE == alarmIsDetected[ alarm ] ) && ( FALSE == ALARM_TABLE[ alarm ].alarmConditionClearImmed ) ) ) { + // If alarms are silenced and this new alarm is of higher or same priority, end silence due to new alarm + if ( ( ALARM_TABLE[ alarm ].alarmPriority > ALARM_TABLE[ alarmStatus.alarmTop ].alarmPriority ) || + ( ( ALARM_TABLE[ alarm ].alarmPriority == ALARM_TABLE[ alarmStatus.alarmTop ].alarmPriority ) && + ( ALARM_TABLE[ alarm ].alarmSubRank < ALARM_TABLE[ alarmStatus.alarmTop ].alarmSubRank ) ) ) + { + alarmStatus.alarmsSilenced = FALSE; + } // If alarm status was that no alarms currently active, set this alarm as top alarm until status formally updated later if ( ALARM_ID_NO_ALARM == alarmStatus.alarmTop ) { @@ -277,8 +286,6 @@ { alarmStatus.stop = TRUE; } - // If alarms silenced, end silence due to new alarm - alarmStatus.alarmsSilenced = FALSE; // If alarm is a fault (and not in service mode), request transition to fault mode if ( ( TRUE == ALARM_TABLE[ alarm ].alarmIsFault ) && ( getCurrentOperationMode() != MODE_SERV ) ) { @@ -319,7 +326,7 @@ *************************************************************************/ void activateAlarmNoData( ALARM_ID_T alarm ) { - activateAlarm2Data( alarm, BLANK_ALARM_DATA, BLANK_ALARM_DATA ); + activateAlarm2Data( alarm, BLANK_ALARM_DATA, BLANK_ALARM_DATA, FALSE ); } /*********************************************************************//** @@ -335,7 +342,7 @@ *************************************************************************/ void activateAlarm1Data( ALARM_ID_T alarm, ALARM_DATA_T alarmData ) { - activateAlarm2Data( alarm, alarmData, BLANK_ALARM_DATA ); + activateAlarm2Data( alarm, alarmData, BLANK_ALARM_DATA, FALSE ); } /*********************************************************************//** @@ -347,10 +354,11 @@ * @details Outputs: alarm triggered message sent, alarm activated * @param alarm ID of alarm to activate * @param alarmData1 supporting data to include in alarm msg - * @param alarmData2 supporting data to include in alarm msg + * @param alarmData2 supporting data to include in alarm msg + * @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 ) +void activateAlarm2Data( ALARM_ID_T alarm, ALARM_DATA_T alarmData1, ALARM_DATA_T alarmData2, BOOL outside ) { // Block if new alarms are occur during loss of AC power if ( ( TRUE == getCPLDACPowerLossDetected() ) ) @@ -364,29 +372,41 @@ if ( ( ALARM_NOT_BLOCKED == alarmsBlockedTimer ) || ( ALARM_ID_HD_AC_POWER_LOST == alarm ) || ( ALARM_ID_HD_AC_POWER_LOST_IN_TREATMENT == alarm ) ) - { - // Broadcast alarm and data if alarm not already active - if ( FALSE == alarmIsActive[ alarm ] ) + { // do not re-trigger alarm if blocked by property + if ( ( FALSE == alarmNoRetrigger ) || + ( ( ALARM_TABLE[ alarm ].alarmNoRetrigOnRB != TRUE ) && ( ALARM_TABLE[ alarm ].alarmNoRetrigOnEndTx != TRUE ) ) ) { - ALARM_TRIGGERED_PAYLOAD_T data; + HD_OP_MODE_T opMode = getCurrentOperationMode(); + TREATMENT_STATE_T ts = getTreatmentState(); - data.alarm = (U32)alarm; - data.almDataType1 = (U32)alarmData1.dataType; - data.almData1 = alarmData1.data.uInt.data; - data.almDataType2 = (U32)alarmData2.dataType; - data.almData2 = alarmData2.data.uInt.data; - data.almPriority = ALARM_TABLE[ alarm ].alarmPriority; - data.almRank = ALARM_TABLE[ alarm ].alarmSubRank; - data.almClrTopOnly = ALARM_TABLE[ alarm ].alarmClearOnly; - - broadcastData( MSG_ID_ALARM_TRIGGERED, COMM_BUFFER_OUT_CAN_HD_ALARM, (U08*)&data, sizeof( ALARM_TRIGGERED_PAYLOAD_T ) ); - // Send information for UI to log to treatment log - if ( ( TRUE == ALARM_TABLE[ alarm ].alarmTreatmentLog ) && ( MODE_TREA == getCurrentOperationMode() ) ) + // do not trigger alarm if blocked by current mode/state + if ( ( ( ALARM_TABLE[ alarm ].alarmBlockRinseback != TRUE ) || ( opMode != MODE_TREA ) || ( ts != TREATMENT_RINSEBACK_STATE ) || ( TRUE == outside ) ) && + ( ( ALARM_TABLE[ alarm ].alarmBlockEndTx != TRUE ) || ( opMode != MODE_POST ) || ( TRUE == outside )) ) { - sendTreatmentLogAlarmEventData( alarm, alarmData1, alarmData2 ); - } - } - activateAlarm( alarm ); + // Broadcast alarm and data if alarm not already active + if ( FALSE == alarmIsActive[ alarm ] ) + { + ALARM_TRIGGERED_PAYLOAD_T data; + + data.alarm = (U32)alarm; + data.almDataType1 = (U32)alarmData1.dataType; + data.almData1 = alarmData1.data.uInt.data; + data.almDataType2 = (U32)alarmData2.dataType; + data.almData2 = alarmData2.data.uInt.data; + data.almPriority = ALARM_TABLE[ alarm ].alarmPriority; + data.almRank = ALARM_TABLE[ alarm ].alarmSubRank; + data.almClrTopOnly = ALARM_TABLE[ alarm ].alarmClearOnly; + + broadcastData( MSG_ID_ALARM_TRIGGERED, COMM_BUFFER_OUT_CAN_HD_ALARM, (U08*)&data, sizeof( ALARM_TRIGGERED_PAYLOAD_T ) ); + // Send information for UI to log to treatment log + if ( ( TRUE == ALARM_TABLE[ alarm ].alarmTreatmentLog ) && ( MODE_TREA == getCurrentOperationMode() ) ) + { + sendTreatmentLogAlarmEventData( alarm, alarmData1, alarmData2 ); + } + } + activateAlarm( alarm ); + } + } } } else @@ -458,6 +478,30 @@ { SET_ALARM_WITH_2_U32_DATA( ALARM_ID_HD_SOFTWARE_FAULT, SW_FAULT_ID_ALARM_MGMT_INVALID_ALARM_TO_CLEAR, alarm ) } +} + +/*********************************************************************//** + * @brief + * The clearNoRetriggerFlag function clears the no re-trigger flag. + * @details Inputs: none + * @details Outputs: alarmNoRetrigger + * @return none + *************************************************************************/ +void clearNoRetriggerFlag( void ) +{ + alarmNoRetrigger = FALSE; +} + +/*********************************************************************//** + * @brief + * The clearNoRetriggerFlag function returns the no re-trigger flag. + * @details Inputs: alarmNoRetrigger + * @details Outputs: none + * @return alarmNoRetrigger + *************************************************************************/ +BOOL getNoRetriggerFlag( void ) +{ + return alarmNoRetrigger; } /*********************************************************************//** @@ -525,7 +569,9 @@ *************************************************************************/ void signalAlarmUserActionInitiated( ALARM_USER_ACTION_T action ) { - // Validate given action + BOOL allRecAlarmsCleared = TRUE; + + // Clear recoverable alarms on user action if ( ( action < NUMBER_OF_ALARM_USER_ACTIONS ) && ( action != ALARM_USER_ACTION_END_TREATMENT ) ) // end tx action must be confirmed first { ALARM_ID_T a = alarmStatus.alarmTop; @@ -540,20 +586,23 @@ // Otherwise we must be in mode/state where ack was only option - so clear all like other options else { - clearAllRecoverableAlarms(); + allRecAlarmsCleared = clearAllRecoverableAlarms( action ); } } else { - clearAllRecoverableAlarms(); + allRecAlarmsCleared = clearAllRecoverableAlarms( action ); } } // Initiate user selected action switch ( action ) { case ALARM_USER_ACTION_RESUME: - initiateAlarmAction( ALARM_ACTION_RESUME ); + if ( TRUE == allRecAlarmsCleared ) + { // only resume if we've cleared all recoverable alarms + initiateAlarmAction( ALARM_ACTION_RESUME ); + } break; case ALARM_USER_ACTION_RINSEBACK: @@ -671,6 +720,26 @@ /*********************************************************************//** * @brief + * The doesAlarmStatusIndicateEndTxOnly function determines whether any currently + * active alarm has ( stop && noRes && /noET ) property, that is end treatment is + * the only choice from full stop. + * @details Inputs: alarmStatus + * @details Outputs: none + * @return TRUE if any active alarm has stop property, FALSE if not + *************************************************************************/ +BOOL doesAlarmStatusIndicateEndTxOnly( void ) +{ + return ( ( ( TRUE == alarmStatus.noResume ) && + ( TRUE == alarmStatus.noRinseback ) && + ( TRUE == alarmStatus.stop ) && + ( TRUE == alarmStatus.noBloodRecirc ) && + ( FALSE == alarmStatus.noEndTreatment ) + ) ? TRUE : FALSE + ); +} + +/*********************************************************************//** + * @brief * The doesAlarmStatusIndicateStop function determines whether any currently * active alarm has stop property. * @details Inputs: alarmStatus @@ -876,7 +945,7 @@ // Check for user confirmation of end treatment alarm response if ( CONFIRMATION_REQUEST_STATUS_ACCEPTED == getConfirmationRequestStatus( GENERIC_CONFIRM_ID_TREATMENT_END ) ) { - clearAllRecoverableAlarms(); + clearAllRecoverableAlarms( ALARM_USER_ACTION_END_TREATMENT ); initiateAlarmAction( ALARM_ACTION_END_TREATMENT ); } @@ -1128,7 +1197,7 @@ BOOL stop = FALSE; BOOL noClear = FALSE; BOOL noResume = FALSE; - BOOL noResumePerAlarmPropertyOnly = FALSE; + BOOL noResumePerAlarmPropertyOnly = alarmNoRetrigger; // cannot resume if no re-trigger flag is set BOOL noRinseback = FALSE; BOOL noEndTreatment = FALSE; BOOL usrAckReq = FALSE; @@ -1227,6 +1296,7 @@ alarmStatus.noEndTreatment = noEndTreatment; alarmStatus.ok = usrAckReq; alarmStatus.noMinimize = noMinimize; + alarmStatus.noReTrigger = alarmNoRetrigger; resumeBlockedByAlarmProperty = noResumePerAlarmPropertyOnly; } @@ -1235,23 +1305,57 @@ * The clearAllRecoverableAlarms function clears all currently active * recoverable alarms. * @details Inputs: ALARM_TABLE[] - * @details Outputs: All currently active recoverable alarms are cleared - * @return none + * @details Outputs: alarmNoRetrigger, alarmIsActive[] + * @param action user action that prompted clearing of recoverable alarms + * @return TRUE if all recoverable alarms cleared, FALSE if any left active *************************************************************************/ -static void clearAllRecoverableAlarms( void ) +static BOOL clearAllRecoverableAlarms( ALARM_USER_ACTION_T action ) { + BOOL result = TRUE; ALARM_ID_T a; // assigning to 1 in order to prevent ALARM_ID_NO_ALARM being cleared // which will cause a fault - for ( a = ( ( ALARM_ID_T ) 1 ) ; a < NUM_OF_ALARM_IDS; a++ ) + for ( a = ( ( ALARM_ID_T ) 1 ); a < NUM_OF_ALARM_IDS; a++ ) { // Clear alarm if alarm allowed to be cleared and not clear only (those are cleared individually) if ( ( FALSE == ALARM_TABLE[ a ].alarmNoClear ) && ( FALSE == ALARM_TABLE[ a ].alarmClearOnly ) ) { - clearAlarm( a ); + // Clear alarm if active and condition not active + if ( ( TRUE == alarmIsActive[ a ] ) && + ( ( TRUE == ALARM_TABLE[ a ].alarmConditionClearImmed ) || ( alarmIsDetected[ a ] != TRUE ) || ( action != ALARM_USER_ACTION_RESUME ) ) ) + { + // set no re-trigger flag if appropriate + if ( ( ALARM_USER_ACTION_RINSEBACK == action ) && ( TRUE == ALARM_TABLE[ a ].alarmNoRetrigOnRB ) ) + { // alarms with no re-trigger on rinseback property should set the no re-trigger flag + alarmNoRetrigger = TRUE; + } + else if ( ( ALARM_USER_ACTION_END_TREATMENT == action ) && ( TRUE == ALARM_TABLE[ a ].alarmNoRetrigOnEndTx ) ) + { // alarms with no re-trigger on end-tx property should set the no re-trigger flag + alarmNoRetrigger = TRUE; + } + else if ( ALARM_USER_ACTION_ACK == action ) + { + if ( ( TRUE == ALARM_TABLE[ a ].alarmNoResume ) && ( TRUE == ALARM_TABLE[ a ].alarmNoRinseback ) ) + { // alarms that only allow end-tx that occur in rinseback or recirc states of treatment mode should set the no re-trigger flag + if ( ( MODE_TREA == getCurrentOperationMode() ) && + ( ( TREATMENT_RINSEBACK_STATE == getCurrentSubMode() ) || ( TREATMENT_RECIRC_STATE == getCurrentSubMode() ) ) ) + { + alarmNoRetrigger = TRUE; + } + } + } + // clear this alarm + clearAlarm( a ); + } + else if ( TRUE == alarmIsActive[ a ] ) + { + result = FALSE; // we didn't clear this alarm because condition still active + } } } + + return result; } /*********************************************************************//** @@ -1629,7 +1733,7 @@ * the correct 32-bit key. A Dialin user must also be logged into HD. * @details Inputs: none * @details Outputs: alarmIsActive[], alarmStartedAt[] - * @param key 32-bit supervior alarm key required to perform this function + * @param key 32-bit supervisor alarm key required to perform this function * @return TRUE if override reset successful, FALSE if not *************************************************************************/ BOOL testClearAllAlarms( U32 key ) @@ -1644,6 +1748,10 @@ { ALARM_ID_T a; + // clear the flags when Dialin clears alarms + alarmNoRetrigger = FALSE; + resumeBlockedByAlarmProperty = FALSE; + // Clear all active alarms for ( a = ALARM_ID_NO_ALARM; a < NUM_OF_ALARM_IDS; a++ ) {