Skip to content

Commit

Permalink
Merge pull request nasa#104 from jphickey/fix-101-update-header
Browse files Browse the repository at this point in the history 
Fix nasa#101, add header update platform config
  • Loading branch information
@dzbaker
dzbaker authored Sep 21, 2023
2 parents df0a57b + bad8af3 commit 52fb737
Show file tree
Hide file tree
Showing 5 changed files with 80 additions and 54 deletions.
32 changes: 32 additions & 0 deletions fsw/inc/sc_platform_cfg.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,38 @@
* \{
*/

/**
* \brief Whether to update headers on commands when sending on software bus
*
* \par Description:
*
* This controls whether to update the command header on the outgoing messages
* produced by the SC app.
*
* - If the messages in the ATS/RTS tables are expected to be completely
* initialized, including the sequence number and any required checksum
* field, then this should be configured as "false" such that these fields
* will not be modified during message transmission. The UpdateHeader
* parameter to CFE_SB_TransmitMsg() will be passed as false, and the message
* will be broadcast on the software bus verbatim. This replicates historical
* behavior of SC.
*
* - If the messages in the ATS/RTS tables need a real-time header update as
* part of the sending process, this should be configured as "true". Any
* checksum embedded within the ATS/RTS will be ignored. The UpdateHeader
* parameter to CFE_SB_TransmitMsg() will be passed as true, such that the
* command will be sequenced and timestamped with current values. A correct
* checksum will be computed based on the updated header values, and the
* resulting message is broadcast on the software bus.
*
* \sa
* CFE_SB_TransmitMsg() - UpdateHeader parameter
*
* \par Limits:
* Must be true or false
*/
#define SC_PLATFORM_ENABLE_HEADER_UPDATE false

/**
* \brief Max number of commands per second
*
Expand Down
2 changes: 2 additions & 0 deletions fsw/src/sc_app.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,8 @@ CFE_Status_t SC_AppInit(void)
/* Continue ATS execution if ATS command checksum fails */
SC_OperData.HkPacket.Payload.ContinueAtsOnFailureFlag = SC_CONT_ON_FAILURE_START;

SC_AppData.EnableHeaderUpdate = SC_PLATFORM_ENABLE_HEADER_UPDATE;

/* Make sure nothing is running */
SC_AppData.NextProcNumber = SC_NONE;
SC_AppData.NextCmdTime[SC_ATP] = SC_MAX_TIME;
Expand Down
3 changes: 2 additions & 1 deletion fsw/src/sc_app.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -280,10 +280,11 @@ typedef struct
These offsets correspond to the addresses of ATS commands located in the ATS table.
The index used is the ATS command index with values from 0 to SC_MAX_ATS_CMDS-1 */

bool EnableHeaderUpdate; /**< \brief whether to update headers in outgoing messages */

uint8 NextProcNumber; /**< \brief the next command processor number */
SC_AbsTimeTag_t NextCmdTime[2]; /**< \brief The overall next command time 0 - ATP, 1- RTP*/
SC_AbsTimeTag_t CurrentTime; /**< \brief this is the current time for SC */
uint16 Unused; /**< \brief Unused */
uint16 AutoStartRTS; /**< \brief Start selected auto-exec RTS after init */
uint16 AppendWordCount; /**< \brief Size of cmd entries in current Append ATS table */
} SC_AppData_t;
Expand Down
35 changes: 23 additions & 12 deletions fsw/src/sc_cmds.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,9 +63,9 @@ void SC_ProcessAtpCmd(void)
CFE_Status_t Result;
bool AbortATS = false;
SC_AtsEntry_t * EntryPtr;
CFE_SB_MsgId_t MessageID = CFE_SB_INVALID_MSG_ID;
CFE_MSG_FcnCode_t CommandCode = 0;
bool ChecksumValid = 0;
CFE_SB_MsgId_t MessageID = CFE_SB_INVALID_MSG_ID;
CFE_MSG_FcnCode_t CommandCode = 0;
bool ChecksumValid;

/*
** The following conditions must be met before the ATS command will be
Expand Down Expand Up @@ -98,11 +98,17 @@ void SC_ProcessAtpCmd(void)
if (EntryPtr->Header.CmdNumber == (SC_ATS_CMD_INDEX_TO_NUM(CmdIndex)))
{
/*
** Check the checksum on the command
**
* Check the checksum on the command
* If this feature is disabled, just skip and assume valid
* Note that the checksum will be re-computed when the message is sent.
*/
CFE_MSG_ValidateChecksum(&EntryPtr->Msg, &ChecksumValid);
if (ChecksumValid == true)
ChecksumValid = SC_AppData.EnableHeaderUpdate;
if (!SC_AppData.EnableHeaderUpdate)
{
/* If header update is NOT enabled, confirm this table entry has a valid checksum already */
CFE_MSG_ValidateChecksum(&EntryPtr->Msg, &ChecksumValid);
}
if (ChecksumValid)
{
/*
** Count the command for the rate limiter
Expand Down Expand Up @@ -151,7 +157,7 @@ void SC_ProcessAtpCmd(void)
}
else
{
Result = CFE_SB_TransmitMsg(&EntryPtr->Msg, true);
Result = CFE_SB_TransmitMsg(&EntryPtr->Msg, SC_AppData.EnableHeaderUpdate);

if (Result == CFE_SUCCESS)
{
Expand Down Expand Up @@ -294,7 +300,7 @@ void SC_ProcessRtpCommand(void)
uint16 RtsIndex; /* the RTS index for the cmd */
uint16 CmdOffset; /* the location of the cmd */
CFE_Status_t Result;
bool ChecksumValid = false;
bool ChecksumValid;

/*
** The following conditions must be met before a RTS command is executed:
Expand Down Expand Up @@ -329,14 +335,19 @@ void SC_ProcessRtpCommand(void)
*/
EntryPtr = (SC_RtsEntry_t *)&SC_OperData.RtsTblAddr[RtsIndex][CmdOffset];

CFE_MSG_ValidateChecksum(&EntryPtr->Msg, &ChecksumValid);
if (ChecksumValid == true)
ChecksumValid = SC_AppData.EnableHeaderUpdate;
if (!SC_AppData.EnableHeaderUpdate)
{
/* If header update is NOT enabled, confirm this table entry has a valid checksum already */
CFE_MSG_ValidateChecksum(&EntryPtr->Msg, &ChecksumValid);
}
if (ChecksumValid)
{
/*
** Try Sending the command on the Software Bus
*/

Result = CFE_SB_TransmitMsg(&EntryPtr->Msg, true);
Result = CFE_SB_TransmitMsg(&EntryPtr->Msg, SC_AppData.EnableHeaderUpdate);

if (Result == CFE_SUCCESS)
{
Expand Down
62 changes: 21 additions & 41 deletions unit-test/sc_cmds_tests.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@ void SC_ProcessAtpCmd_Test_SwitchCmd(void)
SC_AtsEntryHeader_t *Entry;
CFE_SB_MsgId_t TestMsgId = CFE_SB_ValueToMsgId(SC_CMD_MID);
CFE_MSG_FcnCode_t FcnCode = SC_SWITCH_ATS_CC;
bool ChecksumValid;

Entry = (SC_AtsEntryHeader_t *)&SC_OperData.AtsTblAddr[0][0];
Entry->CmdNumber = 1;
Expand All @@ -78,14 +77,12 @@ void SC_ProcessAtpCmd_Test_SwitchCmd(void)
SC_OperData.AtsCmdStatusTblAddr[0][0] = SC_LOADED;
SC_AppData.AtsCmdIndexBuffer[0][0] = 0;

SC_AppData.EnableHeaderUpdate = true;

/* Set return value for CFE_TIME_Compare to make SC_CompareAbsTime return false, to satisfy first if-statement of
* SC_ProcessAtpCmd, and for all other calls to CFE_TIME_Compare called from subfunctions reached by this test */
UT_SetHookFunction(UT_KEY(CFE_TIME_Compare), Ut_CFE_TIME_CompareHookAlessthanB, NULL);

/* Set to return true in order to satisfy the if-statement from which the function is called */
ChecksumValid = true;
UT_SetDataBuffer(UT_KEY(CFE_MSG_ValidateChecksum), &ChecksumValid, sizeof(ChecksumValid), false);

/* Set these two functions to return these values in order to statisfy the if-statement from which they are both
* called */
UT_SetDataBuffer(UT_KEY(CFE_MSG_GetMsgId), &TestMsgId, sizeof(TestMsgId), false);
Expand All @@ -111,7 +108,6 @@ void SC_ProcessAtpCmd_Test_NonSwitchCmd(void)
SC_AtsEntryHeader_t *Entry;
CFE_SB_MsgId_t TestMsgId = CFE_SB_ValueToMsgId(SC_CMD_MID);
CFE_MSG_FcnCode_t FcnCode = SC_NOOP_CC;
bool ChecksumValid;

Entry = (SC_AtsEntryHeader_t *)&SC_OperData.AtsTblAddr[0][0];
Entry->CmdNumber = 1;
Expand All @@ -125,14 +121,12 @@ void SC_ProcessAtpCmd_Test_NonSwitchCmd(void)
SC_OperData.AtsCmdStatusTblAddr[0][0] = SC_LOADED;
SC_AppData.AtsCmdIndexBuffer[0][0] = 0;

SC_AppData.EnableHeaderUpdate = true;

/* Set return value for CFE_TIME_Compare to make SC_CompareAbsTime return false, to satisfy first if-statement of
* SC_ProcessAtpCmd, and for all other calls to CFE_TIME_Compare called from subfunctions reached by this test */
UT_SetHookFunction(UT_KEY(CFE_TIME_Compare), Ut_CFE_TIME_CompareHookAlessthanB, NULL);

/* Set to return true in order to satisfy the if-statement from which the function is called */
ChecksumValid = true;
UT_SetDataBuffer(UT_KEY(CFE_MSG_ValidateChecksum), &ChecksumValid, sizeof(ChecksumValid), false);

/* Set these two functions to return these values in order to statisfy the if-statement from which they are both
* called */
UT_SetDataBuffer(UT_KEY(CFE_MSG_GetMsgId), &TestMsgId, sizeof(TestMsgId), false);
Expand All @@ -158,7 +152,6 @@ void SC_ProcessAtpCmd_Test_InlineSwitchError(void)
SC_AtsEntryHeader_t *Entry;
CFE_SB_MsgId_t TestMsgId = CFE_SB_ValueToMsgId(SC_CMD_MID);
CFE_MSG_FcnCode_t FcnCode = SC_SWITCH_ATS_CC;
bool ChecksumValid;

Entry = (SC_AtsEntryHeader_t *)&SC_OperData.AtsTblAddr[0][0];
Entry->CmdNumber = 1;
Expand All @@ -177,8 +170,7 @@ void SC_ProcessAtpCmd_Test_InlineSwitchError(void)
UT_SetHookFunction(UT_KEY(CFE_TIME_Compare), Ut_CFE_TIME_CompareHookAlessthanB, NULL);

/* Set to return true in order to satisfy the if-statement from which the function is called */
ChecksumValid = true;
UT_SetDataBuffer(UT_KEY(CFE_MSG_ValidateChecksum), &ChecksumValid, sizeof(ChecksumValid), false);
SC_AppData.EnableHeaderUpdate = true;

/* Set these two functions to return these values in order to statisfy the if-statement from which they are both
* called */
Expand Down Expand Up @@ -207,7 +199,6 @@ void SC_ProcessAtpCmd_Test_SBErrorAtsA(void)
SC_AtsEntryHeader_t *Entry;
CFE_SB_MsgId_t TestMsgId = CFE_SB_ValueToMsgId(SC_CMD_MID);
CFE_MSG_FcnCode_t FcnCode = SC_NOOP_CC;
bool ChecksumValid;

Entry = (SC_AtsEntryHeader_t *)&SC_OperData.AtsTblAddr[0][0];
Entry->CmdNumber = 1;
Expand All @@ -223,9 +214,7 @@ void SC_ProcessAtpCmd_Test_SBErrorAtsA(void)
SC_OperData.AtsCmdStatusTblAddr[0][0] = SC_LOADED;
SC_AppData.AtsCmdIndexBuffer[0][0] = 0;

/* Set to return true in order to satisfy the if-statement from which the function is called */
ChecksumValid = true;
UT_SetDataBuffer(UT_KEY(CFE_MSG_ValidateChecksum), &ChecksumValid, sizeof(ChecksumValid), false);
SC_AppData.EnableHeaderUpdate = true;

/* Set these two functions to return these values in order to statisfy the if-statement from which they are both
* called */
Expand Down Expand Up @@ -257,7 +246,6 @@ void SC_ProcessAtpCmd_Test_SBErrorAtsB(void)
SC_AtsEntryHeader_t *Entry;
CFE_SB_MsgId_t TestMsgId = CFE_SB_ValueToMsgId(SC_CMD_MID);
CFE_MSG_FcnCode_t FcnCode = SC_NOOP_CC;
bool ChecksumValid;

Entry = (SC_AtsEntryHeader_t *)&SC_OperData.AtsTblAddr[1][0];
Entry->CmdNumber = 1;
Expand All @@ -273,9 +261,7 @@ void SC_ProcessAtpCmd_Test_SBErrorAtsB(void)
SC_OperData.AtsCmdStatusTblAddr[1][0] = SC_LOADED;
SC_AppData.AtsCmdIndexBuffer[1][0] = 0;

/* Set to return true in order to satisfy the if-statement from which the function is called */
ChecksumValid = true;
UT_SetDataBuffer(UT_KEY(CFE_MSG_ValidateChecksum), &ChecksumValid, sizeof(ChecksumValid), false);
SC_AppData.EnableHeaderUpdate = true;

/* Set these two functions to return these values in order to statisfy the if-statement from which they are both
* called */
Expand Down Expand Up @@ -325,6 +311,8 @@ void SC_ProcessAtpCmd_Test_ChecksumFailedAtsA(void)

SC_OperData.HkPacket.Payload.ContinueAtsOnFailureFlag = false;

SC_AppData.EnableHeaderUpdate = false;

/* Set to return false in order to generate error message SC_ATS_CHKSUM_ERR_EID */
ChecksumValid = false;
UT_SetDataBuffer(UT_KEY(CFE_MSG_ValidateChecksum), &ChecksumValid, sizeof(ChecksumValid), false);
Expand Down Expand Up @@ -375,6 +363,8 @@ void SC_ProcessAtpCmd_Test_ChecksumFailedAtsB(void)

SC_OperData.HkPacket.Payload.ContinueAtsOnFailureFlag = false;

SC_AppData.EnableHeaderUpdate = false;

/* Set to return false in order to generate error message SC_ATS_CHKSUM_ERR_EID */
ChecksumValid = false;
UT_SetDataBuffer(UT_KEY(CFE_MSG_ValidateChecksum), &ChecksumValid, sizeof(ChecksumValid), false);
Expand Down Expand Up @@ -425,6 +415,8 @@ void SC_ProcessAtpCmd_Test_ChecksumFailedAtsAContinue(void)

SC_OperData.HkPacket.Payload.ContinueAtsOnFailureFlag = true;

SC_AppData.EnableHeaderUpdate = false;

/* Set to return false in order to generate error message SC_ATS_CHKSUM_ERR_EID */
ChecksumValid = false;
UT_SetDataBuffer(UT_KEY(CFE_MSG_ValidateChecksum), &ChecksumValid, sizeof(ChecksumValid), false);
Expand Down Expand Up @@ -634,7 +626,6 @@ void SC_ProcessAtpCmd_Test_CmdMid(void)
SC_AtsEntryHeader_t *Entry;
CFE_SB_MsgId_t TestMsgId = CFE_SB_INVALID_MSG_ID;
CFE_MSG_FcnCode_t FcnCode = SC_SWITCH_ATS_CC;
bool ChecksumValid;

Entry = (SC_AtsEntryHeader_t *)&SC_OperData.AtsTblAddr[0][0];
Entry->CmdNumber = 1;
Expand All @@ -648,14 +639,12 @@ void SC_ProcessAtpCmd_Test_CmdMid(void)
SC_OperData.AtsCmdStatusTblAddr[0][0] = SC_LOADED;
SC_AppData.AtsCmdIndexBuffer[0][0] = 0;

SC_AppData.EnableHeaderUpdate = true;

/* Set return value for CFE_TIME_Compare to make SC_CompareAbsTime return false, to satisfy first if-statement of
* SC_ProcessAtpCmd, and for all other calls to CFE_TIME_Compare called from subfunctions reached by this test */
UT_SetHookFunction(UT_KEY(CFE_TIME_Compare), Ut_CFE_TIME_CompareHookAlessthanB, NULL);

/* Set to return true in order to satisfy the if-statement from which the function is called */
ChecksumValid = true;
UT_SetDataBuffer(UT_KEY(CFE_MSG_ValidateChecksum), &ChecksumValid, sizeof(ChecksumValid), false);

/* Set these two functions to return these values in order to statisfy the if-statement from which they are both
* called */
UT_SetDataBuffer(UT_KEY(CFE_MSG_GetMsgId), &TestMsgId, sizeof(TestMsgId), false);
Expand All @@ -677,17 +666,13 @@ void SC_ProcessAtpCmd_Test_CmdMid(void)

void SC_ProcessRtpCommand_Test_Nominal(void)
{
bool ChecksumValid;

SC_AppData.NextCmdTime[SC_RTP] = 0;
SC_AppData.CurrentTime = 1;
SC_AppData.NextProcNumber = SC_RTP;
SC_OperData.RtsCtrlBlckAddr->RtsNumber = 1;
SC_OperData.RtsInfoTblAddr[SC_OperData.RtsCtrlBlckAddr->RtsNumber - 1].RtsStatus = SC_EXECUTING;

/* Set to return true in order to satisfy the if-statement from which the function is called */
ChecksumValid = true;
UT_SetDataBuffer(UT_KEY(CFE_MSG_ValidateChecksum), &ChecksumValid, sizeof(ChecksumValid), false);
SC_AppData.EnableHeaderUpdate = true;

/* Execute the function being tested */
UtAssert_VOIDCALL(SC_ProcessRtpCommand());
Expand All @@ -704,20 +689,16 @@ void SC_ProcessRtpCommand_Test_Nominal(void)

void SC_ProcessRtpCommand_Test_BadSoftwareBusReturn(void)
{
bool ChecksumValid;

SC_AppData.NextCmdTime[SC_RTP] = 0;
SC_AppData.CurrentTime = 1;
SC_AppData.NextProcNumber = SC_RTP;
SC_OperData.RtsCtrlBlckAddr->RtsNumber = 1;
SC_OperData.RtsInfoTblAddr[SC_OperData.RtsCtrlBlckAddr->RtsNumber - 1].RtsStatus = SC_EXECUTING;

/* Set to return true in order to satisfy the if-statement from which the function is called */
ChecksumValid = true;
SC_AppData.EnableHeaderUpdate = true;

/* Set to return -1 in order to generate error message SC_RTS_DIST_ERR_EID */
UT_SetDeferredRetcode(UT_KEY(CFE_SB_TransmitMsg), 1, -1);
UT_SetDataBuffer(UT_KEY(CFE_MSG_ValidateChecksum), &ChecksumValid, sizeof(ChecksumValid), false);

/* Execute the function being tested */
UtAssert_VOIDCALL(SC_ProcessRtpCommand());
Expand Down Expand Up @@ -745,6 +726,8 @@ void SC_ProcessRtpCommand_Test_BadChecksum(void)
SC_OperData.RtsCtrlBlckAddr->RtsNumber = 1;
SC_OperData.RtsInfoTblAddr[SC_OperData.RtsCtrlBlckAddr->RtsNumber - 1].RtsStatus = SC_EXECUTING;

SC_AppData.EnableHeaderUpdate = false;

/* Set to return false in order to generate error message SC_RTS_CHKSUM_ERR_EID */
ChecksumValid = false;
UT_SetDataBuffer(UT_KEY(CFE_MSG_ValidateChecksum), &ChecksumValid, sizeof(ChecksumValid), false);
Expand Down Expand Up @@ -1170,18 +1153,15 @@ void SC_ProcessRequest_Test_1HzWakeupRtpExecutionTime(void)

void SC_ProcessRequest_Test_1HzWakeupRtpExecutionTimeTooManyCmds(void)
{
bool ChecksumValid;

/**
** Test case: SC_1HZ_WAKEUP_MID with a pending RTP command that needs to execute immediately, but too many
*commands are being sent at once
**/
CFE_SB_MsgId_t TestMsgId = CFE_SB_ValueToMsgId(SC_1HZ_WAKEUP_MID);

UT_SetDataBuffer(UT_KEY(CFE_MSG_GetMsgId), &TestMsgId, sizeof(TestMsgId), false);
SC_AppData.EnableHeaderUpdate = true;

ChecksumValid = true;
UT_SetDataBuffer(UT_KEY(CFE_MSG_ValidateChecksum), &ChecksumValid, sizeof(ChecksumValid), false);
UT_SetDataBuffer(UT_KEY(CFE_MSG_GetMsgId), &TestMsgId, sizeof(TestMsgId), false);

UT_SetDeferredRetcode(UT_KEY(SC_VerifyCmdLength), 1, true);

Expand Down

0 comments on commit 52fb737

Please sign in to comment.