Fix #52, Apply consistent Event ID names to common events

nasa · Nov 1, 2023 · de94f05 · de94f05
1 parent d9c1034
commit de94f05
Show file tree

Hide file tree

Showing 11 changed files with 60 additions and 60 deletions.
diff --git a/fsw/inc/cs_events.h b/fsw/inc/cs_events.h
@@ -54,13 +54,13 @@
 /**
  * \brief CS Reset Counters Command Event ID
  *
- *  \par Type: DEBUG
+ *  \par Type: INFORMATION
  *
  *  \par Cause:
  *
  *  This event message is issued when a reset counters command has been received.
  */
-#define CS_RESET_DBG_EID 3
+#define CS_RESET_INF_EID 3
 
 /**
  * \brief CS Disable Checksumming Command Event ID
@@ -451,7 +451,7 @@
  *  This event message is issued when a software bus message is received
  *  with an invalid command code.
  */
-#define CS_CC1_ERR_EID 34
+#define CS_CC_ERR_EID 34
 
 /**
  * \brief CS App Termination Event ID
@@ -475,7 +475,7 @@
  *  This event message is issued when command message is received with a message
  *  length that doesn't match the expected value.
  */
-#define CS_LEN_ERR_EID 36
+#define CS_CMD_LEN_ERR_EID 36
 
 /**********************************************************************/
 /*EEPROM Commands                                                     */
@@ -1466,7 +1466,7 @@
  *
  *  This event message is issued when CFE_SB_CreatePipe fails for the command pipe
  */
-#define CS_INIT_SB_CREATE_ERR_EID 112
+#define CS_CR_PIPE_ERR_EID 112
 
 /**
  * \brief CS Software Bus Subscribe To Housekeeping Failed Event ID

diff --git a/fsw/inc/cs_msgdefs.h b/fsw/inc/cs_msgdefs.h
@@ -53,7 +53,7 @@
  *       - Command packet length not as expected
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *
  *  \par Criticality
@@ -75,8 +75,8 @@
  *  \par Command Verification
  *       Successful execution of this command may be verified with
  *       the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdCounter will be cleared
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will be cleared
+ *       - #CS_HkPacket_t.CmdCounter will be cleared
+ *       - #CS_HkPacket_t.CmdErrCounter will be cleared
  *       - The #CS_RESET_DBG_EID informational event message will be
  *         generated when the command is executed
  *
@@ -85,7 +85,7 @@
  *       - Command packet length not as expected
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *
  *  \par Criticality
@@ -127,7 +127,7 @@
  *       - The child task failed to be created
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *       - Error specific event message #CS_ONESHOT_MEMVALIDATE_ERR_EID
  *       - Error specific event message #CS_ONESHOT_CHDTASK_ERR_EID
@@ -169,7 +169,7 @@
  *       - The child task could not be deleted
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *       - Error specific event message #CS_ONESHOT_CANCEL_NO_CHDTASK_ERR_EID
  *       - Error specific event message #CS_ONESHOT_CANCEL_DELETE_CHDTASK_ERR_EID
@@ -203,7 +203,7 @@
  *       - Command packet length not as expected
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *
  *  \par Criticality
@@ -235,7 +235,7 @@
  *       - Command packet length not as expected
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *
  *  \par Criticality
@@ -267,7 +267,7 @@
  *       - Command packet length not as expected
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *
  *  \par Criticality
@@ -299,7 +299,7 @@
  *       - Command packet length not as expected
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *
  *  \par Criticality
@@ -333,7 +333,7 @@
  *       - Command packet length not as expected
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *
  *  \par Criticality
@@ -368,7 +368,7 @@
  *       - The child task failed to be created by Executive Services (ES)
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *       - Error specific event message #CS_RECOMPUTE_CFECORE_CREATE_CHDTASK_ERR_EID
  *       - Error specific event message #CS_RECOMPUTE_CFECORE_CHDTASK_ERR_EID
@@ -406,9 +406,9 @@
  *       - Command packet length not as expected
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
- *       - #CS_HkPacket_Payload_t.OSCSState set to #CS_STATE_ENABLED
+ *       - #CS_HkPacket_t.OSCSState set to #CS_STATE_ENABLED
  *
  *  \par Criticality
  *       None
@@ -439,7 +439,7 @@
  *       - Command packet length not as expected
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *
  *  \par Criticality
@@ -473,7 +473,7 @@
  *       - Command packet length not as expected
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *
  *  \par Criticality
@@ -507,7 +507,7 @@
  *       - The child task failed to be created by Executive Services (ES)
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *       - Error specific event message #CS_RECOMPUTE_OS_CREATE_CHDTASK_ERR_EID
  *       - Error specific event message #CS_RECOMPUTE_OS_CHDTASK_ERR_EID
@@ -545,7 +545,7 @@
  *       - Command packet length not as expected
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *
  *  \par Criticality
@@ -577,7 +577,7 @@
  *       - Command packet length not as expected
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *
  *  \par Criticality
@@ -612,7 +612,7 @@
  *       - The command specified Entry ID is invalid
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *       - Error specific event message #CS_BASELINE_INVALID_ENTRY_EEPROM_ERR_EID
  *
@@ -652,7 +652,7 @@
  *       - The child task failed to be created by Executive Services (ES)
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *       - Error specific event message #CS_RECOMPUTE_INVALID_ENTRY_EEPROM_ERR_EID
  *       - Error specific event message #CS_RECOMPUTE_EEPROM_CREATE_CHDTASK_ERR_EID
@@ -692,7 +692,7 @@
  *       - Command specified entry was invalid
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *       - Error specific event message #CS_ENABLE_EEPROM_INVALID_ENTRY_ERR_EID
  *
@@ -725,7 +725,7 @@
  *       - Command specified entry was invalid
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *       - Error specific event message #CS_DISABLE_EEPROM_INVALID_ENTRY_ERR_EID
  *
@@ -759,7 +759,7 @@
  *       - Command specified address was not found in the table
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *       - Error specific event message #CS_GET_ENTRY_ID_EEPROM_NOT_FOUND_INF_EID
  *
@@ -790,7 +790,7 @@
  *       - Command packet length not as expected
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *
  *  \par Criticality
@@ -822,7 +822,7 @@
  *       - Command packet length not as expected
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *
  *  \par Criticality
@@ -857,7 +857,7 @@
  *       - The command specified Entry ID is invalid
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *       - Error specific event message #CS_BASELINE_INVALID_ENTRY_MEMORY_ERR_EID
  *
@@ -896,7 +896,7 @@
  *       - The child task failed to be created by Executive Services (ES)
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *       - Error specific event message #CS_RECOMPUTE_INVALID_ENTRY_MEMORY_ERR_EID
  *       - Error specific event message #CS_RECOMPUTE_MEMORY_CREATE_CHDTASK_ERR_EID
@@ -936,7 +936,7 @@
  *       - Command specified entry was invalid
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *       - Error specific event message #CS_ENABLE_MEMORY_INVALID_ENTRY_ERR_EID
  *
@@ -969,7 +969,7 @@
  *       - Command specified entry was invalid
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *       - Error specific event message #CS_DISABLE_MEMORY_INVALID_ENTRY_ERR_EID
  *
@@ -1003,7 +1003,7 @@
  *       - Command specified address was not found in the table
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *       - Error specific event message #CS_GET_ENTRY_ID_MEMORY_NOT_FOUND_INF_EID
  *
@@ -1035,7 +1035,7 @@
  *       - Command packet length not as expected
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *
  *  \par Criticality
@@ -1067,7 +1067,7 @@
  *       - Command packet length not as expected
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *
  *  \par Criticality
@@ -1102,7 +1102,7 @@
  *       - The command specified able name is invalid
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *       - Error specific event message #CS_BASELINE_INVALID_NAME_TABLES_ERR_EID
  *
@@ -1147,7 +1147,7 @@
  *       - The child task failed to be created by Executive Services (ES)
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *       - Error specific event message #CS_RECOMPUTE_UNKNOWN_NAME_TABLES_ERR_EID
  *       - Error specific event message #CS_RECOMPUTE_TABLES_CREATE_CHDTASK_ERR_EID
@@ -1187,7 +1187,7 @@
  *       - Command specified table name was invalid
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *       - Error specific event message #CS_ENABLE_TABLES_UNKNOWN_NAME_ERR_EID
  *
@@ -1253,7 +1253,7 @@
  *       - Command packet length not as expected
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *
  *  \par Criticality
@@ -1285,7 +1285,7 @@
  *       - Command packet length not as expected
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *
  *  \par Criticality
@@ -1320,7 +1320,7 @@
  *       - The command specified able name is invalid
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *       - Error specific event message #CS_BASELINE_INVALID_NAME_APP_ERR_EID
  *
@@ -1359,7 +1359,7 @@
  *       - The child task failed to be created by Executive Services (ES)
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *       - Error specific event message #CS_RECOMPUTE_UNKNOWN_NAME_APP_ERR_EID
  *       - Error specific event message #CS_RECOMPUTE_APP_CREATE_CHDTASK_ERR_EID
@@ -1399,7 +1399,7 @@
  *       - Command specified app name was invalid
  *
  *  \par Evidence of failure may be found in the following telemetry:
- *       - #CS_HkPacket_Payload_t.CmdErrCounter will increment
+ *       - #CS_HkPacket_t.CmdErrCounter will increment
  *       - Error specific event message #CS_LEN_ERR_EID
  *       - Error specific event message #CS_ENABLE_APP_UNKNOWN_NAME_ERR_EID
  *