Index: firmware/App/Services/AlarmMgmt.c =================================================================== diff -u -rdc0d9b087c609e71cacdb7f0395cccf29d749c00 -r5e0cd9b5be11ff4b2acaadbdcafc4ffe05172aa1 --- firmware/App/Services/AlarmMgmt.c (.../AlarmMgmt.c) (revision dc0d9b087c609e71cacdb7f0395cccf29d749c00) +++ firmware/App/Services/AlarmMgmt.c (.../AlarmMgmt.c) (revision 5e0cd9b5be11ff4b2acaadbdcafc4ffe05172aa1) @@ -28,20 +28,18 @@ // ********** private definitions ********** -/// A blank alarm data record for alarms that do not include alarm data when triggered. -const ALARM_DATA_T blankAlarmData = { ALARM_DATA_TYPE_NONE, 0 }; +const ALARM_DATA_T blankAlarmData = { ALARM_DATA_TYPE_NONE, 0 }; ///< A blank alarm data record for alarms that do not include alarm data when triggered. // ********** private data ********** -/// table - current state of each alarm -DATA_ARRAY_DECL( BOOL, AlarmStates, NUM_OF_ALARM_IDS, alarmIsActive ); +DATA_ARRAY_DECL( BOOL, AlarmStates, NUM_OF_ALARM_IDS, alarmIsActive ); ///< Array of current state of each alarm // ********** private function prototypes ********** static void activateAlarm( ALARM_ID_T alarm ); static DATA_ARRAY_GET_PROTOTYPE( BOOL, getAlarmActive, alarmID ); -/************************************************************************* +/*********************************************************************//** * @brief initAlarmMgmt * The initAlarmMgmt function initializes the AlarmMgmt module. * @details @@ -62,22 +60,21 @@ alarmIsActive[ a ].override = OVERRIDE_RESET; } } - -/************************************************************************* + +/*********************************************************************//** * @brief execAlarmMgmt - * The execAlarmMgmt function executes the alarm management functions to be \n - * done periodically. + * The execAlarmMgmt function executes the alarm management module. * @details - * Inputs : - * Outputs : + * Inputs : none + * Outputs : none * @return none *************************************************************************/ void execAlarmMgmt( void ) { // TODO - any alarm audio or LED/lamp management for DG? } - -/************************************************************************* + +/*********************************************************************//** * @brief activateAlarm * The activateAlarm function activates a given alarm. * @details @@ -103,17 +100,15 @@ SET_ALARM_WITH_2_U32_DATA( ALARM_ID_DG_SOFTWARE_FAULT, SW_FAULT_ID_ALARM_MGMT_INVALID_ALARM_TO_ACTIVATE, alarm ) } } - -/************************************************************************* + +/*********************************************************************//** * @brief activateAlarmNoData - * The activateAlarmNoData function activates a given alarm. Also, an alarm \n - * message is broadcast to the rest of the system. This function will \n - * include given data in the broadcast message for logging. + * The activateAlarmNoData function activates a given alarm. An alarm message + * is broadcast to the rest of the system. * @details * Inputs : none * Outputs : alarm triggered message sent, alarm activated * @param alarm ID of alarm to activate - * @param alarmData supporting data to include in alarm msg * @return none *************************************************************************/ void activateAlarmNoData( ALARM_ID_T alarm ) @@ -137,17 +132,17 @@ activateAlarm( alarm ); } - -/************************************************************************* + +/*********************************************************************//** * @brief activateAlarm1Data - * The activateAlarm1Data function activates a given alarm. Also, an alarm \n - * message is broadcast to the rest of the system. This function will \n - * include given data in the broadcast message for logging. + * 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 * Inputs : none * Outputs : alarm triggered message sent, alarm activated * @param alarm ID of alarm to activate - * @param alarmData supporting data to include in alarm msg + * @param alarmData supporting data to include in alarm message * @return none *************************************************************************/ void activateAlarm1Data( ALARM_ID_T alarm, ALARM_DATA_T alarmData ) @@ -171,18 +166,18 @@ activateAlarm( alarm ); } - -/************************************************************************* + +/*********************************************************************//** * @brief activateAlarm2Data - * The activateAlarm2Data function activates a given alarm. Also, an alarm \n - * message is broadcast to the rest of the system. This function will \n - * include two given data in the broadcast message for logging. + * 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 * Inputs : none * 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 alarmData1 supporting data to include in alarm message + * @param alarmData2 supporting data to include in alarm message * @return none *************************************************************************/ void activateAlarm2Data( ALARM_ID_T alarm, ALARM_DATA_T alarmData1, ALARM_DATA_T alarmData2 ) @@ -206,11 +201,11 @@ activateAlarm( alarm ); } - -/************************************************************************* + +/*********************************************************************//** * @brief clearAlarm - * The clearAlarm function clears a given alarm if it is recoverable. Also \n - * an alarm message is broadcast to the rest of the system. + * The clearAlarm function clears a given alarm if it is recoverable. + * An alarm message is broadcast to the rest of the system. * @details * Inputs : none * Outputs : AlarmStatusTable[] @@ -245,11 +240,10 @@ SET_ALARM_WITH_2_U32_DATA( ALARM_ID_DG_SOFTWARE_FAULT, SW_FAULT_ID_ALARM_MGMT_INVALID_ALARM_TO_CLEAR, alarm ) } } - -/************************************************************************* + +/*********************************************************************//** * @brief isAlarmActive - * The isAlarmActive function determines whether a given alarm is currently \n - * active. + * The isAlarmActive function determines whether a given alarm is currently active. * @details * Inputs : alarmIsActive[] * Outputs : none @@ -262,8 +256,8 @@ return result; } - -/************************************************************************* + +/*********************************************************************//** * @brief getAlarmActive * The getAlarmActive function gets the active state of a given alarm. * @details @@ -278,13 +272,11 @@ /************************************************************************* * TEST SUPPORT FUNCTIONS *************************************************************************/ - - -/************************************************************************* + +/*********************************************************************//** * @brief - * The testSetAlarmStateOverride function overrides the state of the \n - * alarm active state for a given alarm with the alarm management with \n - * a given active state. + * The testSetAlarmStateOverride function overrides the state of the alarm active + * state for a given alarm with the alarm management with a given active state. * @details * Inputs : none * Outputs : alarm activated or cleared @@ -314,10 +306,10 @@ return result; } - -/************************************************************************* + +/*********************************************************************//** * @brief - * The testResetAlarmStateOverride function resets the override of the \n + * The testResetAlarmStateOverride function resets the override of the * state of the active state for a given alarm with the alarm management. * @details * Inputs : none