Skip to content

Commit 3860201

Browse files
thnkslprptthnkslprpt
committed
Fix #95, Standardize command responses
1 parent f958cc0 commit 3860201

18 files changed

+104
-104
lines changed

‎.github/pull_request_template.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ A clear and concise description of what the contribution is.
1010
**Testing performed**
1111
Steps taken to test the contribution:
1212
1. Build steps '...'
13-
1. Execution steps '...'
13+
2. Execution steps '...'
1414

1515
**Expected behavior changes**
1616
A clear and concise description of how this contribution will change behavior and level of impact.

‎fsw/inc/cs_events.h‎

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -189,15 +189,15 @@
189189
/**
190190
* \brief CS cFE Core Checksum Recompute Started Event ID
191191
*
192-
* \par Type: DEBUG
192+
* \par Type: INFORMATION
193193
*
194194
* \par Cause:
195195
*
196196
* This event message is issued when a recompute baseline
197197
* for the cFE core command has been received and the
198198
* recompute task has been started.
199199
*/
200-
#define CS_RECOMPUTE_CFECORE_STARTED_DBG_EID 14
200+
#define CS_RECOMPUTE_CFECORE_STARTED_INF_EID 14
201201

202202
/**
203203
* \brief CS cFE Core Checksum Failed Child Task Create Event ID
@@ -230,15 +230,15 @@
230230
/**
231231
* \brief CS OS Code Checksum Recompute Started Event ID
232232
*
233-
* \par Type: DEBUG
233+
* \par Type: INFORMATION
234234
*
235235
* \par Cause:
236236
*
237237
* This event message is issued when a recompute baseline
238238
* for the OS code segment command has been received and the
239239
* recompute task has been started.
240240
*/
241-
#define CS_RECOMPUTE_OS_STARTED_DBG_EID 17
241+
#define CS_RECOMPUTE_OS_STARTED_INF_EID 17
242242

243243
/**
244244
* \brief CS OS Code Checksum Recompute Failed Child Task Create Event ID
@@ -271,14 +271,14 @@
271271
/**
272272
* \brief CS Oneshot Checksum Started Event ID
273273
*
274-
* \par Type: DEBUG
274+
* \par Type: INFORMATION
275275
*
276276
* \par Cause:
277277
*
278278
* This event message is issued when a OneShot calculation
279279
* command has been received and the OneShot task has been started.
280280
*/
281-
#define CS_ONESHOT_STARTED_DBG_EID 20
281+
#define CS_ONESHOT_STARTED_INF_EID 20
282282

283283
/**
284284
* \brief CS Oneshot Checksum Failed Child Task Create Event ID
@@ -547,15 +547,15 @@
547547
/**
548548
* \brief CS EEPROM Checksum Recompute Started Event ID
549549
*
550-
* \par Type: DEBUG
550+
* \par Type: INFORMATION
551551
*
552552
* \par Cause:
553553
*
554554
* This event message is issued when a recompute baseline
555555
* for the specified EEPROM Entry ID command has been received and the
556556
* recompute task has been started.
557557
*/
558-
#define CS_RECOMPUTE_EEPROM_STARTED_DBG_EID 42
558+
#define CS_RECOMPUTE_EEPROM_STARTED_INF_EID 42
559559

560560
/**
561561
* \brief CS EEPROM Checksum Recompute Failed Child Task Create Event ID
@@ -746,15 +746,15 @@
746746
/**
747747
* \brief CS Memory Checksum Recompute Started Event ID
748748
*
749-
* \par Type: DEBUG
749+
* \par Type: INFORMATION
750750
*
751751
* \par Cause:
752752
*
753753
* This event message is issued when a recompute baseline
754754
* for the specified Memory Entry ID command has been received and the
755755
* recompute task has been started.
756756
*/
757-
#define CS_RECOMPUTE_MEMORY_STARTED_DBG_EID 57
757+
#define CS_RECOMPUTE_MEMORY_STARTED_INF_EID 57
758758

759759
/**
760760
* \brief CS Memory Checksum Recompute Failed Child Task Create Event ID
@@ -947,15 +947,15 @@
947947
/**
948948
* \brief CS Table Checksum Recompute Started Event ID
949949
*
950-
* \par Type: DEBUG
950+
* \par Type: INFORMATION
951951
*
952952
* \par Cause:
953953
*
954954
* This event message is issued when a recompute baseline
955955
* for the specified table command has been received and the
956956
* recompute task has been started.
957957
*/
958-
#define CS_RECOMPUTE_TABLES_STARTED_DBG_EID 72
958+
#define CS_RECOMPUTE_TABLES_STARTED_INF_EID 72
959959

960960
/**
961961
* \brief CS Table Checksum Recompute Failed Child Task Create Event ID
@@ -1120,15 +1120,15 @@
11201120
/**
11211121
* \brief CS App Checksum Recompute Started Event ID
11221122
*
1123-
* \par Type: DEBUG
1123+
* \par Type: INFORMATION
11241124
*
11251125
* \par Cause:
11261126
*
11271127
* This event message is issued when a recompute baseline
11281128
* for the specified app command has been received and the
11291129
* recompute task has been started.
11301130
*/
1131-
#define CS_RECOMPUTE_APP_STARTED_DBG_EID 85
1131+
#define CS_RECOMPUTE_APP_STARTED_INF_EID 85
11321132

11331133
/**
11341134
* \brief CS App Checksum Recompute Failed Create Child Task Event ID
@@ -1657,106 +1657,106 @@
16571657
/**
16581658
* \brief CS Table Enable Checksum Unable To Find Entry In Definition Table Event ID
16591659
*
1660-
* \par Type: DEBUG
1660+
* \par Type: ERROR
16611661
*
16621662
* \par Cause:
16631663
*
16641664
* This event message is issued when CS successfully enables an entry (specified
16651665
* by name) in the Tables results table but is unable to find the same entry
16661666
* in the definition table (or the entry is marked as #CS_STATE_EMPTY).
16671667
*/
1668-
#define CS_ENABLE_TABLE_DEF_NOT_FOUND_DBG_EID 129
1668+
#define CS_ENABLE_TABLE_DEF_NOT_FOUND_ERR_EID 129
16691669

16701670
/**
16711671
* \brief CS Table Disable Checksum Unable To Find Entry In Definition Table Event ID
16721672
*
1673-
* \par Type: DEBUG
1673+
* \par Type: ERROR
16741674
*
16751675
* \par Cause:
16761676
*
16771677
* This event message is issued when CS successfully disables an entry (specified
16781678
* by name) in the Tables results table but is unable to find the same entry
16791679
* in the definition table (or the entry is marked as #CS_STATE_EMPTY).
16801680
*/
1681-
#define CS_DISABLE_TABLE_DEF_NOT_FOUND_DBG_EID 130
1681+
#define CS_DISABLE_TABLE_DEF_NOT_FOUND_ERR_EID 130
16821682

16831683
/**
16841684
* \brief CS App Enable Checksum Unable To Find Entry In Definition Table Event ID
16851685
*
1686-
* \par Type: DEBUG
1686+
* \par Type: ERROR
16871687
*
16881688
* \par Cause:
16891689
*
16901690
* This event message is issued when CS successfully enables an entry (specified
16911691
* by name) in the Apps results table but is unable to find the same entry
16921692
* in the definition table (or the entry is marked as #CS_STATE_EMPTY).
16931693
*/
1694-
#define CS_ENABLE_APP_DEF_NOT_FOUND_DBG_EID 131
1694+
#define CS_ENABLE_APP_DEF_NOT_FOUND_ERR_EID 131
16951695

16961696
/**
16971697
* \brief CS App Disable Checksum Unable To Find Entry In Definition Table Event ID
16981698
*
1699-
* \par Type: DEBUG
1699+
* \par Type: ERROR
17001700
*
17011701
* \par Cause:
17021702
*
17031703
* This event message is issued when CS successfully disables an entry (specified
17041704
* by name) in the Apps results table but is unable to find the same entry
17051705
* in the definition table (or the entry is marked as #CS_STATE_EMPTY).
17061706
*/
1707-
#define CS_DISABLE_APP_DEF_NOT_FOUND_DBG_EID 132
1707+
#define CS_DISABLE_APP_DEF_NOT_FOUND_ERR_EID 132
17081708

17091709
/**
17101710
* \brief CS Memory Disable Checksum Unable To Find Entry In Definition Table Event ID
17111711
*
1712-
* \par Type: DEBUG
1712+
* \par Type: ERROR
17131713
*
17141714
* \par Cause:
17151715
*
17161716
* This event message is issued when CS successfully disables an entry (specified
17171717
* by name) in the Memory results table but identifies the corresponding entry in
17181718
* the definitions table to be set to #CS_STATE_EMPTY.
17191719
*/
1720-
#define CS_DISABLE_MEMORY_DEF_EMPTY_DBG_EID 133
1720+
#define CS_DISABLE_MEMORY_DEF_EMPTY_ERR_EID 133
17211721

17221722
/**
17231723
* \brief CS Memory Enable Checksum Unable To Find Entry In Definition Table Event ID
17241724
*
1725-
* \par Type: DEBUG
1725+
* \par Type: ERROR
17261726
*
17271727
* \par Cause:
17281728
*
17291729
* This event message is issued when CS successfully enables an entry (specified
17301730
* by name) in the Memory results table but identifies the corresponding entry in
17311731
* the definitions table to be set to #CS_STATE_EMPTY.
17321732
*/
1733-
#define CS_ENABLE_MEMORY_DEF_EMPTY_DBG_EID 134
1733+
#define CS_ENABLE_MEMORY_DEF_EMPTY_ERR_EID 134
17341734

17351735
/**
17361736
* \brief CS EEPROM Disable Checksum Unable To Find Entry In Definition Table Event ID
17371737
*
1738-
* \par Type: DEBUG
1738+
* \par Type: ERROR
17391739
*
17401740
* \par Cause:
17411741
*
17421742
* This event message is issued when CS successfully disables an entry (specified
17431743
* by name) in the EEPROM results table but identifies the corresponding entry in
17441744
* the definitions table to be set to #CS_STATE_EMPTY.
17451745
*/
1746-
#define CS_DISABLE_EEPROM_DEF_EMPTY_DBG_EID 135
1746+
#define CS_DISABLE_EEPROM_DEF_EMPTY_ERR_EID 135
17471747

17481748
/**
17491749
* \brief CS EEPROM Enable Checksum Unable To Find Entry In Definition Table Event ID
17501750
*
1751-
* \par Type: DEBUG
1751+
* \par Type: ERROR
17521752
*
17531753
* \par Cause:
17541754
*
17551755
* This event message is issued when CS successfully enables an entry (specified
17561756
* by name) in the EEPROM results table but identifies the corresponding entry in
17571757
* the definitions table to be set to #CS_STATE_EMPTY.
17581758
*/
1759-
#define CS_ENABLE_EEPROM_DEF_EMPTY_DBG_EID 136
1759+
#define CS_ENABLE_EEPROM_DEF_EMPTY_ERR_EID 136
17601760

17611761
/**
17621762
* \brief CS Tables Table Validate Failed Duplicate Name Event ID

‎fsw/inc/cs_msgdefs.h‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -111,10 +111,10 @@
111111
* Successful execution of this command may be verified with
112112
* the following telemetry:
113113
* - #CS_HkPacket_Payload_t.CmdCounter will increment
114-
* - The #CS_ONESHOT_STARTED_DBG_EID debug event message will be
114+
* - The #CS_ONESHOT_STARTED_INF_EID informational event message will be
115115
* generated when the command is received
116116
* - The CS_ONESHOT_FINISHED_INF_EID informational message will
117-
* be generated when the compuation finishes.
117+
* be generated when the computation finishes.
118118
* - #CS_HkPacket_Payload_t.LastOneShotChecksum will be updated to the new value
119119
*
120120
* \par Error Conditions
@@ -356,8 +356,8 @@
356356
* Successful execution of this command may be verified with
357357
* the following telemetry:
358358
* - #CS_HkPacket_Payload_t.CmdCounter will increment
359-
* - The #CS_RECOMPUTE_CFECORE_STARTED_DBG_EID debug event message will be
360-
* generated when the command is received
359+
* - The #CS_RECOMPUTE_CFECORE_STARTED_INF_EID informational event message
360+
* will be generated when the command is received
361361
*
362362
* \par Error Conditions
363363
* This command may fail for the following reason(s):
@@ -495,8 +495,8 @@
495495
* Successful execution of this command may be verified with
496496
* the following telemetry:
497497
* - #CS_HkPacket_Payload_t.CmdCounter will increment
498-
* - The #CS_RECOMPUTE_OS_STARTED_DBG_EID debug event message will be
499-
* generated when the command is received
498+
* - The #CS_RECOMPUTE_OS_STARTED_INF_EID informational event message
499+
* will be generated when the command is received
500500
*
501501
* \par Error Conditions
502502
* This command may fail for the following reason(s):
@@ -637,7 +637,7 @@
637637
* Successful execution of this command may be verified with
638638
* the following telemetry:
639639
* - #CS_HkPacket_Payload_t.CmdCounter will increment
640-
* - The #CS_RECOMPUTE_EEPROM_STARTED_DBG_EID debug event
640+
* - The #CS_RECOMPUTE_EEPROM_STARTED_INF_EID informational event
641641
* message will be generated when the command is received
642642
* - The #CS_RECOMPUTE_FINISH_EEPROM_MEMORY_INF_EID informational event
643643
* message will be generated when the recompute is finished
@@ -881,7 +881,7 @@
881881
* Successful execution of this command may be verified with
882882
* the following telemetry:
883883
* - #CS_HkPacket_Payload_t.CmdCounter will increment
884-
* - The #CS_RECOMPUTE_MEMORY_STARTED_DBG_EID debug event
884+
* - The #CS_RECOMPUTE_MEMORY_STARTED_INF_EID informational event
885885
* message will be generated when the command is received
886886
* - The #CS_RECOMPUTE_FINISH_EEPROM_MEMORY_INF_EID informational event
887887
* message will be generated when the recompute is finished
@@ -1126,7 +1126,7 @@
11261126
* Successful execution of this command may be verified with
11271127
* the following telemetry:
11281128
* - #CS_HkPacket_Payload_t.CmdCounter will increment
1129-
* - The #CS_RECOMPUTE_TABLES_STARTED_DBG_EID debug event
1129+
* - The #CS_RECOMPUTE_TABLES_STARTED_INF_EID informational event
11301130
* message will be generated when the command is received
11311131
* - The #CS_RECOMPUTE_FINISH_TABLES_INF_EID informational event
11321132
* message will be generated when the recompute is finished.
@@ -1344,7 +1344,7 @@
13441344
* Successful execution of this command may be verified with
13451345
* the following telemetry:
13461346
* - #CS_HkPacket_Payload_t.CmdCounter will increment
1347-
* - The #CS_RECOMPUTE_APP_STARTED_DBG_EID debug event
1347+
* - The #CS_RECOMPUTE_APP_STARTED_INF_EID informational event
13481348
* message will be generated when the command is received
13491349
* - The #CS_RECOMPUTE_FINISH_APP_INF_EID informational event
13501350
* message will be generated when the recompute is finished

‎fsw/inc/cs_tbldefs.h‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ typedef struct
119119
uint32 ComparisonValue; /**< \brief The Memory Integrity Value */
120120
uint32 ByteOffset; /**< \brief Where a previous unfinished calc left off */
121121
uint32 TempChecksumValue; /**< \brief The unfinished caluculation */
122-
CFE_TBL_Handle_t TblHandle; /**< \brief handle recieved from CFE_TBL */
122+
CFE_TBL_Handle_t TblHandle; /**< \brief handle received from CFE_TBL */
123123
bool IsCSOwner; /**< \brief Is CS the original owner of this table */
124124
bool Filler8; /**< \brief Padding */
125125
char Name[CFE_TBL_MAX_FULL_NAME_LEN]; /**< \brief name of the table */

‎fsw/src/cs_app_cmds.c‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ void CS_RecomputeBaselineAppCmd(const CS_AppNameCmd_t *CmdPtr)
151151
CFE_PLATFORM_ES_DEFAULT_STACK_SIZE, CS_CHILD_TASK_PRIORITY, 0);
152152
if (Status == CFE_SUCCESS)
153153
{
154-
CFE_EVS_SendEvent(CS_RECOMPUTE_APP_STARTED_DBG_EID, CFE_EVS_EventType_DEBUG,
154+
CFE_EVS_SendEvent(CS_RECOMPUTE_APP_STARTED_INF_EID, CFE_EVS_EventType_INFORMATION,
155155
"Recompute baseline of app %s started", Name);
156156
CS_AppData.HkPacket.Payload.CmdCounter++;
157157
}
@@ -214,7 +214,7 @@ void CS_DisableNameAppCmd(const CS_AppNameCmd_t *CmdPtr)
214214
}
215215
else
216216
{
217-
CFE_EVS_SendEvent(CS_DISABLE_APP_DEF_NOT_FOUND_DBG_EID, CFE_EVS_EventType_DEBUG,
217+
CFE_EVS_SendEvent(CS_DISABLE_APP_DEF_NOT_FOUND_ERR_EID, CFE_EVS_EventType_ERROR,
218218
"CS unable to update apps definition table for entry %s", Name);
219219
}
220220

@@ -262,7 +262,7 @@ void CS_EnableNameAppCmd(const CS_AppNameCmd_t *CmdPtr)
262262
}
263263
else
264264
{
265-
CFE_EVS_SendEvent(CS_ENABLE_APP_DEF_NOT_FOUND_DBG_EID, CFE_EVS_EventType_DEBUG,
265+
CFE_EVS_SendEvent(CS_ENABLE_APP_DEF_NOT_FOUND_ERR_EID, CFE_EVS_EventType_ERROR,
266266
"CS unable to update apps definition table for entry %s", Name);
267267
}
268268

‎fsw/src/cs_cmds.c‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ void CS_ResetCmd(const CS_NoArgsCmd_t *CmdPtr)
7272
CS_AppData.HkPacket.Payload.OSCSErrCounter = 0;
7373
CS_AppData.HkPacket.Payload.PassCounter = 0;
7474

75-
CFE_EVS_SendEvent(CS_RESET_INF_EID, CFE_EVS_EventType_DEBUG, "Reset Counters command recieved");
75+
CFE_EVS_SendEvent(CS_RESET_INF_EID, CFE_EVS_EventType_INFORMATION, "Reset Counters command received");
7676
}
7777

7878
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
@@ -366,7 +366,7 @@ void CS_RecomputeBaselineCfeCoreCmd(const CS_NoArgsCmd_t *CmdPtr)
366366

367367
if (Status == CFE_SUCCESS)
368368
{
369-
CFE_EVS_SendEvent(CS_RECOMPUTE_CFECORE_STARTED_DBG_EID, CFE_EVS_EventType_DEBUG,
369+
CFE_EVS_SendEvent(CS_RECOMPUTE_CFECORE_STARTED_INF_EID, CFE_EVS_EventType_INFORMATION,
370370
"Recompute of cFE core started");
371371
CS_AppData.HkPacket.Payload.CmdCounter++;
372372
}
@@ -414,7 +414,7 @@ void CS_RecomputeBaselineOSCmd(const CS_NoArgsCmd_t *CmdPtr)
414414
CFE_PLATFORM_ES_DEFAULT_STACK_SIZE, CS_CHILD_TASK_PRIORITY, 0);
415415
if (Status == CFE_SUCCESS)
416416
{
417-
CFE_EVS_SendEvent(CS_RECOMPUTE_OS_STARTED_DBG_EID, CFE_EVS_EventType_DEBUG,
417+
CFE_EVS_SendEvent(CS_RECOMPUTE_OS_STARTED_INF_EID, CFE_EVS_EventType_INFORMATION,
418418
"Recompute of OS code segment started");
419419
CS_AppData.HkPacket.Payload.CmdCounter++;
420420
}
@@ -476,7 +476,7 @@ void CS_OneShotCmd(const CS_OneShotCmd_t *CmdPtr)
476476
CFE_PLATFORM_ES_DEFAULT_STACK_SIZE, CS_CHILD_TASK_PRIORITY, 0);
477477
if (Status == CFE_SUCCESS)
478478
{
479-
CFE_EVS_SendEvent(CS_ONESHOT_STARTED_DBG_EID, CFE_EVS_EventType_DEBUG,
479+
CFE_EVS_SendEvent(CS_ONESHOT_STARTED_INF_EID, CFE_EVS_EventType_INFORMATION,
480480
"OneShot checksum started on address: 0x%08X, size: %d",
481481
(unsigned int)(CmdPtr->Payload.Address), (int)(CmdPtr->Payload.Size));
482482

0 commit comments

Comments
 (0)