Index: AlarmDefs.h =================================================================== diff -u -r8b6d80b68a2490075a921ccc8a1a80568b4da36e -r265db01fb5db89443dcc79198cb30812b9d0977e --- AlarmDefs.h (.../AlarmDefs.h) (revision 8b6d80b68a2490075a921ccc8a1a80568b4da36e) +++ AlarmDefs.h (.../AlarmDefs.h) (revision 265db01fb5db89443dcc79198cb30812b9d0977e) @@ -19,8 +19,13 @@ #define __ALARM_DEFINITIONS_H__ // ********** public definitions ********** + +/** + * @addtogroup AlarmDefs + * @{ + */ -/// Enumeration of alarm IDs +/// Enumeration of alarm IDs. enum Alarm_List { ALARM_ID_NO_ALARM = 0, ///< Indication for when no alarms is a possible situation @@ -64,7 +69,7 @@ ALARM_ID_RTC_BATTERY_LOW = 38, ///< RTC battery low ALARM_ID_RTC_OR_TIMER_ACCURACY_FAILURE = 39, ///< RTC or MCU timer inaccurate ALARM_ID_RTC_RAM_OPS_ERROR = 40, ///< RTC (i.e read time) or RAM operations failure (read or write) - ALARM_ID_NVDATA_EEPROM_OPS_FAILURE = 41, ///< EEPRON operations (read, write, erase) failure + ALARM_ID_NVDATA_EEPROM_OPS_FAILURE = 41, ///< EEPROM operations (read, write, erase) failure ALARM_ID_NVDATA_MFG_RECORD_CRC_ERROR = 42, ///< Manufacturing record CRC failure ALARM_ID_NVDATA_SRVC_RECORD_CRC_ERROR = 43, ///< Service record CRC failure ALARM_ID_NVDATA_CAL_RECORD_CRC_ERROR = 44, ///< Calibration record CRC failure @@ -94,18 +99,24 @@ ALARM_ID_HD_ACCELEROMETER_SELF_TEST_FAILURE = 68, ///< HD accelerometer failed POST ALARM_ID_DG_ACCELEROMETER_SELF_TEST_FAILURE = 69, ///< DG accelerometer failed POST ALARM_ID_HD_EXCESSIVE_TILT = 70, ///< HD tilt exceeds maximum - ALARM_ID_DG_EXCESSIVE_TILT = 71, ///< DG tilt exceeds maximu + ALARM_ID_DG_EXCESSIVE_TILT = 71, ///< DG tilt exceeds maximum ALARM_ID_HD_SHOCK = 72, ///< HD experienced large acceleration ALARM_ID_DG_SHOCK = 73, ///< DG experienced large acceleration ALARM_ID_HD_ACCELEROMETER_FAILURE = 74, ///< HD accelerometer error (no readings or FPGA reports error) ALARM_ID_DG_ACCELEROMETER_FAILURE = 75, ///< DG accelerometer error (no readings or FPGA reports error) ALARM_ID_DG_CRITICAL_DATA_ERROR = 76, ///< DG critical data integrity check failed ALARM_ID_RO_REJECTION_RATIO_OUT_OF_RANGE = 77, ///< RO rejection ratio out of range NUM_OF_ALARM_IDS ///< Total number of alarms -}; - +}; typedef enum Alarm_List ALARM_ID_T; ///< Type for alarm list enumeration +/**@}*/ + +/** + * @addtogroup AlarmPriorities + * @{ + */ + /// Enumeration of alarm priorities. enum Alarm_Priorities { @@ -114,10 +125,16 @@ ALARM_PRIORITY_MEDIUM = 2, ///< Medium priority alarm ALARM_PRIORITY_HIGH = 3, ///< High priority alarm NUM_OF_ALARM_PRIORITIES ///< Total number of alarm priorities -}; - +}; typedef enum Alarm_Priorities ALARM_PRIORITY_T; ///< Type for alarm priorities enumeration +/**@}*/ + +/** + * @addtogroup AlarmSources + * @{ + */ + /// Enumeration of alarm sources. enum Alarm_Sources { @@ -126,7 +143,8 @@ ALARM_SOURCE_DG, ///< DG firmware alarm source NUMBER_OF_ALARM_SOURCES ///< Number of alarm sources }; - typedef enum Alarm_Sources ALARM_SOURCE_T; ///< Type for alarm sources enumeration + +/**@}*/ -#endif +#endif