Fix #95, Standardize command responses

nasa · Jul 6, 2024 · 4442ca6 · 4442ca6
1 parent c3fd1c2
commit 4442ca6
Show file tree

Hide file tree

Showing 18 changed files with 108 additions and 108 deletions.
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -10,7 +10,7 @@ A clear and concise description of what the contribution is.
 **Testing performed**
 Steps taken to test the contribution:
 1. Build steps '...'
-1. Execution steps '...'
+2. Execution steps '...'
 
 **Expected behavior changes**
 A clear and concise description of how this contribution will change behavior and level of impact.

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
@@ -189,15 +189,15 @@
 /**
  * \brief CS cFE Core Checksum Recompute Started Event ID
  *
- *  \par Type: DEBUG
+ *  \par Type: INFORMATION
  *
  *  \par Cause:
  *
  *  This event message is issued when a recompute baseline
  *  for the cFE core command has been received and the
  *  recompute task has been started.
  */
-#define CS_RECOMPUTE_CFECORE_STARTED_DBG_EID 14
+#define CS_RECOMPUTE_CFECORE_STARTED_INF_EID 14
 
 /**
  * \brief CS cFE Core Checksum Failed Child Task Create Event ID
@@ -230,15 +230,15 @@
 /**
  * \brief CS OS Code Checksum Recompute Started Event ID
  *
- *  \par Type: DEBUG
+ *  \par Type: INFORMATION
  *
  *  \par Cause:
  *
  *  This event message is issued when a recompute baseline
  *  for the OS code segment command has been received and the
  *  recompute task has been started.
  */
-#define CS_RECOMPUTE_OS_STARTED_DBG_EID 17
+#define CS_RECOMPUTE_OS_STARTED_INF_EID 17
 
 /**
  * \brief CS OS Code Checksum Recompute Failed Child Task Create Event ID
@@ -271,14 +271,14 @@
 /**
  * \brief CS Oneshot Checksum Started Event ID
  *
- *  \par Type: DEBUG
+ *  \par Type: INFORMATION
  *
  *  \par Cause:
  *
  *  This event message is issued when a OneShot calculation
  *  command has been received and the OneShot task has been started.
  */
-#define CS_ONESHOT_STARTED_DBG_EID 20
+#define CS_ONESHOT_STARTED_INF_EID 20
 
 /**
  * \brief CS Oneshot Checksum Failed Child Task Create Event ID
@@ -547,15 +547,15 @@
 /**
  * \brief CS EEPROM Checksum Recompute Started Event ID
  *
- *  \par Type: DEBUG
+ *  \par Type: INFORMATION
  *
  *  \par Cause:
  *
  *  This event message is issued when a recompute baseline
  *  for the specified EEPROM Entry ID command has been received and the
  *  recompute task has been started.
  */
-#define CS_RECOMPUTE_EEPROM_STARTED_DBG_EID 42
+#define CS_RECOMPUTE_EEPROM_STARTED_INF_EID 42
 
 /**
  * \brief CS EEPROM Checksum Recompute Failed Child Task Create Event ID
@@ -746,15 +746,15 @@
 /**
  * \brief CS Memory Checksum Recompute Started Event ID
  *
- *  \par Type: DEBUG
+ *  \par Type: INFORMATION
  *
  *  \par Cause:
  *
  *  This event message is issued when a recompute baseline
  *  for the specified Memory Entry ID command has been received and the
  *  recompute task has been started.
  */
-#define CS_RECOMPUTE_MEMORY_STARTED_DBG_EID 57
+#define CS_RECOMPUTE_MEMORY_STARTED_INF_EID 57
 
 /**
  * \brief CS Memory Checksum Recompute Failed Child Task Create Event ID
@@ -947,15 +947,15 @@
 /**
  * \brief CS Table Checksum Recompute Started Event ID
  *
- *  \par Type: DEBUG
+ *  \par Type: INFORMATION
  *
  *  \par Cause:
  *
  *  This event message is issued when a recompute baseline
  *  for the specified table command has been received and the
  *  recompute task has been started.
  */
-#define CS_RECOMPUTE_TABLES_STARTED_DBG_EID 72
+#define CS_RECOMPUTE_TABLES_STARTED_INF_EID 72
 
 /**
  * \brief CS Table Checksum Recompute Failed Child Task Create Event ID
@@ -1120,15 +1120,15 @@
 /**
  * \brief CS App Checksum Recompute Started Event ID
  *
- *  \par Type: DEBUG
+ *  \par Type: INFORMATION
  *
  *  \par Cause:
  *
  *  This event message is issued when a recompute baseline
  *  for the specified app command has been received and the
  *  recompute task has been started.
  */
-#define CS_RECOMPUTE_APP_STARTED_DBG_EID 85
+#define CS_RECOMPUTE_APP_STARTED_INF_EID 85
 
 /**
  * \brief CS App Checksum Recompute Failed Create Child Task Event ID
@@ -1657,106 +1657,106 @@
 /**
  * \brief CS Table Enable Checksum Unable To Find Entry In Definition Table Event ID
  *
- *  \par Type: DEBUG
+ *  \par Type: ERROR
  *
  *  \par Cause:
  *
  *  This event message is issued when CS successfully enables an entry (specified
  *  by name) in the Tables results table but is unable to find the same entry
  *  in the definition table (or the entry is marked as #CS_STATE_EMPTY).
  */
-#define CS_ENABLE_TABLE_DEF_NOT_FOUND_DBG_EID 129
+#define CS_ENABLE_TABLE_DEF_NOT_FOUND_ERR_EID 129
 
 /**
  * \brief CS Table Disable Checksum Unable To Find Entry In Definition Table Event ID
  *
- *  \par Type: DEBUG
+ *  \par Type: ERROR
  *
  *  \par Cause:
  *
  *  This event message is issued when CS successfully disables an entry (specified
  *  by name) in the Tables results table but is unable to find the same entry
  *  in the definition table (or the entry is marked as #CS_STATE_EMPTY).
  */
-#define CS_DISABLE_TABLE_DEF_NOT_FOUND_DBG_EID 130
+#define CS_DISABLE_TABLE_DEF_NOT_FOUND_ERR_EID 130
 
 /**
  * \brief CS App Enable Checksum Unable To Find Entry In Definition Table Event ID
  *
- *  \par Type: DEBUG
+ *  \par Type: ERROR
  *
  *  \par Cause:
  *
  *  This event message is issued when CS successfully enables an entry (specified
  *  by name) in the Apps results table but is unable to find the same entry
  *  in the definition table (or the entry is marked as #CS_STATE_EMPTY).
  */
-#define CS_ENABLE_APP_DEF_NOT_FOUND_DBG_EID 131
+#define CS_ENABLE_APP_DEF_NOT_FOUND_ERR_EID 131
 
 /**
  * \brief CS App Disable Checksum Unable To Find Entry In Definition Table Event ID
  *
- *  \par Type: DEBUG
+ *  \par Type: ERROR
  *
  *  \par Cause:
  *
  *  This event message is issued when CS successfully disables an entry (specified
  *  by name) in the Apps results table but is unable to find the same entry
  *  in the definition table (or the entry is marked as #CS_STATE_EMPTY).
  */
-#define CS_DISABLE_APP_DEF_NOT_FOUND_DBG_EID 132
+#define CS_DISABLE_APP_DEF_NOT_FOUND_ERR_EID 132
 
 /**
  * \brief CS Memory Disable Checksum Unable To Find Entry In Definition Table Event ID
  *
- *  \par Type: DEBUG
+ *  \par Type: ERROR
  *
  *  \par Cause:
  *
  *  This event message is issued when CS successfully disables an entry (specified
  *  by name) in the Memory results table but identifies the corresponding entry in
  *  the definitions table to be set to #CS_STATE_EMPTY.
  */
-#define CS_DISABLE_MEMORY_DEF_EMPTY_DBG_EID 133
+#define CS_DISABLE_MEMORY_DEF_EMPTY_ERR_EID 133
 
 /**
  * \brief CS Memory Enable Checksum Unable To Find Entry In Definition Table Event ID
  *
- *  \par Type: DEBUG
+ *  \par Type: ERROR
  *
  *  \par Cause:
  *
  *  This event message is issued when CS successfully enables an entry (specified
  *  by name) in the Memory results table but identifies the corresponding entry in
  *  the definitions table to be set to #CS_STATE_EMPTY.
  */
-#define CS_ENABLE_MEMORY_DEF_EMPTY_DBG_EID 134
+#define CS_ENABLE_MEMORY_DEF_EMPTY_ERR_EID 134
 
 /**
  * \brief CS EEPROM Disable Checksum Unable To Find Entry In Definition Table Event ID
  *
- *  \par Type: DEBUG
+ *  \par Type: ERROR
  *
  *  \par Cause:
  *
  *  This event message is issued when CS successfully disables an entry (specified
  *  by name) in the EEPROM results table but identifies the corresponding entry in
  *  the definitions table to be set to #CS_STATE_EMPTY.
  */
-#define CS_DISABLE_EEPROM_DEF_EMPTY_DBG_EID 135
+#define CS_DISABLE_EEPROM_DEF_EMPTY_ERR_EID 135
 
 /**
  * \brief CS EEPROM Enable Checksum Unable To Find Entry In Definition Table Event ID
  *
- *  \par Type: DEBUG
+ *  \par Type: ERROR
  *
  *  \par Cause:
  *
  *  This event message is issued when CS successfully enables an entry (specified
  *  by name) in the EEPROM results table but identifies the corresponding entry in
  *  the definitions table to be set to #CS_STATE_EMPTY.
  */
-#define CS_ENABLE_EEPROM_DEF_EMPTY_DBG_EID 136
+#define CS_ENABLE_EEPROM_DEF_EMPTY_ERR_EID 136
 
 /**
  * \brief CS Tables Table Validate Failed Duplicate Name Event ID

diff --git a/fsw/inc/cs_msgdefs.h b/fsw/inc/cs_msgdefs.h
@@ -77,7 +77,7 @@
  *       the following telemetry:
  *       - #CS_HkPacket_Payload_t.CmdCounter will be cleared
  *       - #CS_HkPacket_Payload_t.CmdErrCounter will be cleared
- *       - The #CS_RESET_DBG_EID informational event message will be
+ *       - The #CS_RESET_INF_EID informational event message will be
  *         generated when the command is executed
  *
  *  \par Error Conditions
@@ -111,10 +111,10 @@
  *       Successful execution of this command may be verified with
  *       the following telemetry:
  *       - #CS_HkPacket_Payload_t.CmdCounter will increment
- *       - The #CS_ONESHOT_STARTED_DBG_EID debug event message will be
+ *       - The #CS_ONESHOT_STARTED_INF_EID informational event message will be
  *         generated when the command is received
  *       - The CS_ONESHOT_FINISHED_INF_EID informational message will
- *         be generated when the compuation finishes.
+ *         be generated when the computation finishes.
  *       - #CS_HkPacket_Payload_t.LastOneShotChecksum will be updated to the new value
  *
  *  \par Error Conditions
@@ -356,8 +356,8 @@
  *       Successful execution of this command may be verified with
  *       the following telemetry:
  *       - #CS_HkPacket_Payload_t.CmdCounter will increment
- *       - The #CS_RECOMPUTE_CFECORE_STARTED_DBG_EID debug event message will be
- *         generated when the command is received
+ *       - The #CS_RECOMPUTE_CFECORE_STARTED_INF_EID informational event message
+ *         will be generated when the command is received
  *
  *  \par Error Conditions
  *       This command may fail for the following reason(s):
@@ -495,8 +495,8 @@
  *       Successful execution of this command may be verified with
  *       the following telemetry:
  *       - #CS_HkPacket_Payload_t.CmdCounter will increment
- *       - The #CS_RECOMPUTE_OS_STARTED_DBG_EID debug event message will be
- *         generated when the command is received
+ *       - The #CS_RECOMPUTE_OS_STARTED_INF_EID informational event message
+ *         will be generated when the command is received
  *
  *  \par Error Conditions
  *       This command may fail for the following reason(s):
@@ -637,7 +637,7 @@
  *       Successful execution of this command may be verified with
  *       the following telemetry:
  *       - #CS_HkPacket_Payload_t.CmdCounter will increment
- *       - The #CS_RECOMPUTE_EEPROM_STARTED_DBG_EID debug event
+ *       - The #CS_RECOMPUTE_EEPROM_STARTED_INF_EID informational event
  *         message will be generated when the command is received
  *       - The #CS_RECOMPUTE_FINISH_EEPROM_MEMORY_INF_EID informational event
  *         message will be generated when the recompute is finished
@@ -881,7 +881,7 @@
  *       Successful execution of this command may be verified with
  *       the following telemetry:
  *       - #CS_HkPacket_Payload_t.CmdCounter will increment
- *       - The #CS_RECOMPUTE_MEMORY_STARTED_DBG_EID debug event
+ *       - The #CS_RECOMPUTE_MEMORY_STARTED_INF_EID informational event
  *         message will be generated when the command is received
  *       - The #CS_RECOMPUTE_FINISH_EEPROM_MEMORY_INF_EID informational event
  *         message will be generated when the recompute is finished
@@ -1126,7 +1126,7 @@
  *       Successful execution of this command may be verified with
  *       the following telemetry:
  *       - #CS_HkPacket_Payload_t.CmdCounter will increment
- *       - The #CS_RECOMPUTE_TABLES_STARTED_DBG_EID debug event
+ *       - The #CS_RECOMPUTE_TABLES_STARTED_INF_EID informational event
  *         message will be generated when the command is received
  *       - The #CS_RECOMPUTE_FINISH_TABLES_INF_EID informational event
  *         message will be generated when the recompute is finished.
@@ -1344,7 +1344,7 @@
  *       Successful execution of this command may be verified with
  *       the following telemetry:
  *       - #CS_HkPacket_Payload_t.CmdCounter will increment
- *       - The #CS_RECOMPUTE_APP_STARTED_DBG_EID debug event
+ *       - The #CS_RECOMPUTE_APP_STARTED_INF_EID informational event
  *         message will be generated when the command is received
  *       - The #CS_RECOMPUTE_FINISH_APP_INF_EID informational event
  *         message will be generated when the recompute is finished

diff --git a/fsw/inc/cs_tbldefs.h b/fsw/inc/cs_tbldefs.h
@@ -119,7 +119,7 @@ typedef struct
     uint32           ComparisonValue;                 /**< \brief The Memory Integrity Value */
     uint32           ByteOffset;                      /**< \brief Where a previous unfinished calc left off */
     uint32           TempChecksumValue;               /**< \brief The unfinished caluculation */
-    CFE_TBL_Handle_t TblHandle;                       /**< \brief handle recieved from CFE_TBL */
+    CFE_TBL_Handle_t TblHandle;                       /**< \brief handle received from CFE_TBL */
     bool             IsCSOwner;                       /**< \brief Is CS the original owner of this table */
     bool             Filler8;                         /**< \brief Padding */
     char             Name[CFE_TBL_MAX_FULL_NAME_LEN]; /**< \brief name of the table */

diff --git a/fsw/src/cs_app_cmds.c b/fsw/src/cs_app_cmds.c
@@ -151,7 +151,7 @@ void CS_RecomputeBaselineAppCmd(const CS_AppNameCmd_t *CmdPtr)
                                                 CFE_PLATFORM_ES_DEFAULT_STACK_SIZE, CS_CHILD_TASK_PRIORITY, 0);
                 if (Status == CFE_SUCCESS)
                 {
-                    CFE_EVS_SendEvent(CS_RECOMPUTE_APP_STARTED_DBG_EID, CFE_EVS_EventType_DEBUG,
+                    CFE_EVS_SendEvent(CS_RECOMPUTE_APP_STARTED_INF_EID, CFE_EVS_EventType_INFORMATION,
                                       "Recompute baseline of app %s started", Name);
                     CS_AppData.HkPacket.Payload.CmdCounter++;
                 }
@@ -214,7 +214,7 @@ void CS_DisableNameAppCmd(const CS_AppNameCmd_t *CmdPtr)
                 }
                 else
                 {
-                    CFE_EVS_SendEvent(CS_DISABLE_APP_DEF_NOT_FOUND_DBG_EID, CFE_EVS_EventType_DEBUG,
+                    CFE_EVS_SendEvent(CS_DISABLE_APP_DEF_NOT_FOUND_ERR_EID, CFE_EVS_EventType_ERROR,
                                       "CS unable to update apps definition table for entry %s", Name);
                 }
 
@@ -262,7 +262,7 @@ void CS_EnableNameAppCmd(const CS_AppNameCmd_t *CmdPtr)
                 }
                 else
                 {
-                    CFE_EVS_SendEvent(CS_ENABLE_APP_DEF_NOT_FOUND_DBG_EID, CFE_EVS_EventType_DEBUG,
+                    CFE_EVS_SendEvent(CS_ENABLE_APP_DEF_NOT_FOUND_ERR_EID, CFE_EVS_EventType_ERROR,
                                       "CS unable to update apps definition table for entry %s", Name);
                 }