Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #2339, Refactor common logic out of CFE_TIME_SetTime/MET/STCFCmd() #2340

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix #2339, Refactor common logic out of CFE_TIME_SetTime/MET/STCFCmd() #2340

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
119 changes: 28 additions & 91 deletions modules/time/fsw/src/cfe_time_task.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -771,14 +771,16 @@ int32 CFE_TIME_SubDelayCmd(const CFE_TIME_SubDelayCmd_t *data)

/*----------------------------------------------------------------
*
* Application-scope internal function
* See description in header file for argument/return detail
* Internal helper routine - not part of API
*
* This function performs the common logic for CFE_TIME_SetTimeCmd(),
* CFE_TIME_SetMETCmd() and CFE_TIME_SetSTCFCmd().
*
*-----------------------------------------------------------------*/
int32 CFE_TIME_SetTimeCmd(const CFE_TIME_SetTimeCmd_t *data)
static void CFE_TIME_SetCommand(const CFE_TIME_TimeCmd_Payload_t *CommandPtr, void (*SetTimeFunc)(CFE_TIME_SysTime_t),

Check notice

Code scanning / CodeQL

Long function without assertion

All functions of more than 10 lines should have at least one assertion.
const char *TimeType, uint16 SuccessEventID, uint16 ConfigErrorEventID,
uint16 ErrorEventID)
{
const CFE_TIME_TimeCmd_Payload_t *CommandPtr = &data->Payload;

/*
** Verify "micro-seconds" command argument...
*/
Expand All @@ -791,11 +793,11 @@ int32 CFE_TIME_SetTimeCmd(const CFE_TIME_SetTimeCmd_t *data)
NewTime.Seconds = CommandPtr->Seconds;
NewTime.Subseconds = CFE_TIME_Micro2SubSecs(CommandPtr->MicroSeconds);

CFE_TIME_SetTime(NewTime);
SetTimeFunc(NewTime);

Check notice

Code scanning / CodeQL

Use of non-constant function pointer

This call does not go through a const function pointer.

CFE_TIME_Global.CommandCounter++;
CFE_EVS_SendEvent(CFE_TIME_TIME_EID, CFE_EVS_EventType_INFORMATION,
"Set Time -- secs = %u, usecs = %u, ssecs = 0x%X", (unsigned int)CommandPtr->Seconds,
CFE_EVS_SendEvent(SuccessEventID, CFE_EVS_EventType_INFORMATION,
"Set %s -- secs = %u, usecs = %u, ssecs = 0x%X", TimeType, (unsigned int)CommandPtr->Seconds,
(unsigned int)CommandPtr->MicroSeconds,
(unsigned int)CFE_TIME_Micro2SubSecs(CommandPtr->MicroSeconds));

Expand All @@ -805,18 +807,29 @@ int32 CFE_TIME_SetTimeCmd(const CFE_TIME_SetTimeCmd_t *data)
*/
CFE_TIME_Global.CommandErrorCounter++;

CFE_EVS_SendEvent(CFE_TIME_TIME_CFG_EID, CFE_EVS_EventType_ERROR,
"Set Time commands invalid without CFE_PLATFORM_TIME_CFG_SERVER set to TRUE");
CFE_EVS_SendEvent(ConfigErrorEventID, CFE_EVS_EventType_ERROR,
"Set %s commands invalid without CFE_PLATFORM_TIME_CFG_SERVER set to TRUE", TimeType);

#endif /* CFE_PLATFORM_TIME_CFG_SERVER */
}
else
{
CFE_TIME_Global.CommandErrorCounter++;
CFE_EVS_SendEvent(CFE_TIME_TIME_ERR_EID, CFE_EVS_EventType_ERROR, "Invalid Time -- secs = %u, usecs = %u",
CFE_EVS_SendEvent(ErrorEventID, CFE_EVS_EventType_ERROR, "Invalid %s -- secs = %u, usecs = %u", TimeType,
(unsigned int)CommandPtr->Seconds, (unsigned int)CommandPtr->MicroSeconds);
}
}

/*----------------------------------------------------------------
*
* Application-scope internal function
* See description in header file for argument/return detail
*
*-----------------------------------------------------------------*/
int32 CFE_TIME_SetTimeCmd(const CFE_TIME_SetTimeCmd_t *data)
{
CFE_TIME_SetCommand(&data->Payload, CFE_TIME_SetTime, "Time", CFE_TIME_TIME_EID, CFE_TIME_TIME_CFG_EID,
CFE_TIME_TIME_ERR_EID);
return CFE_SUCCESS;
}

Expand All @@ -828,46 +841,8 @@ int32 CFE_TIME_SetTimeCmd(const CFE_TIME_SetTimeCmd_t *data)
*-----------------------------------------------------------------*/
int32 CFE_TIME_SetMETCmd(const CFE_TIME_SetMETCmd_t *data)
{
const CFE_TIME_TimeCmd_Payload_t *CommandPtr = &data->Payload;

/*
** Verify "micro-seconds" command argument...
*/
if (CommandPtr->MicroSeconds < 1000000)
{
#if (CFE_PLATFORM_TIME_CFG_SERVER == true)

CFE_TIME_SysTime_t NewMET;

NewMET.Seconds = CommandPtr->Seconds;
NewMET.Subseconds = CFE_TIME_Micro2SubSecs(CommandPtr->MicroSeconds);

CFE_TIME_SetMET(NewMET);

CFE_TIME_Global.CommandCounter++;
CFE_EVS_SendEvent(CFE_TIME_MET_EID, CFE_EVS_EventType_INFORMATION,
"Set MET -- secs = %u, usecs = %u, ssecs = 0x%X", (unsigned int)CommandPtr->Seconds,
(unsigned int)CommandPtr->MicroSeconds,
(unsigned int)CFE_TIME_Micro2SubSecs(CommandPtr->MicroSeconds));

#else /* not CFE_PLATFORM_TIME_CFG_SERVER */
/*
** We want to know if disabled commands are being sent...
*/
CFE_TIME_Global.CommandErrorCounter++;

CFE_EVS_SendEvent(CFE_TIME_MET_CFG_EID, CFE_EVS_EventType_ERROR,
"Set MET commands invalid without CFE_PLATFORM_TIME_CFG_SERVER set to TRUE");

#endif /* CFE_PLATFORM_TIME_CFG_SERVER */
}
else
{
CFE_TIME_Global.CommandErrorCounter++;
CFE_EVS_SendEvent(CFE_TIME_MET_ERR_EID, CFE_EVS_EventType_ERROR, "Invalid MET -- secs = %u, usecs = %u",
(unsigned int)CommandPtr->Seconds, (unsigned int)CommandPtr->MicroSeconds);
}

CFE_TIME_SetCommand(&data->Payload, CFE_TIME_SetMET, "MET", CFE_TIME_MET_EID, CFE_TIME_MET_CFG_EID,
CFE_TIME_MET_ERR_EID);
return CFE_SUCCESS;
}

Expand All @@ -879,46 +854,8 @@ int32 CFE_TIME_SetMETCmd(const CFE_TIME_SetMETCmd_t *data)
*-----------------------------------------------------------------*/
int32 CFE_TIME_SetSTCFCmd(const CFE_TIME_SetSTCFCmd_t *data)
{
const CFE_TIME_TimeCmd_Payload_t *CommandPtr = &data->Payload;

/*
** Verify "micro-seconds" command argument...
*/
if (CommandPtr->MicroSeconds < 1000000)
{
#if (CFE_PLATFORM_TIME_CFG_SERVER == true)

CFE_TIME_SysTime_t NewSTCF;

NewSTCF.Seconds = CommandPtr->Seconds;
NewSTCF.Subseconds = CFE_TIME_Micro2SubSecs(CommandPtr->MicroSeconds);

CFE_TIME_SetSTCF(NewSTCF);

CFE_TIME_Global.CommandCounter++;
CFE_EVS_SendEvent(CFE_TIME_STCF_EID, CFE_EVS_EventType_INFORMATION,
"Set STCF -- secs = %u, usecs = %u, ssecs = 0x%X", (unsigned int)CommandPtr->Seconds,
(unsigned int)CommandPtr->MicroSeconds,
(unsigned int)CFE_TIME_Micro2SubSecs(CommandPtr->MicroSeconds));

#else /* not CFE_PLATFORM_TIME_CFG_SERVER */
/*
** We want to know if disabled commands are being sent...
*/
CFE_TIME_Global.CommandErrorCounter++;

CFE_EVS_SendEvent(CFE_TIME_STCF_CFG_EID, CFE_EVS_EventType_ERROR,
"Set STCF commands invalid without CFE_PLATFORM_TIME_CFG_SERVER set to TRUE");

#endif /* CFE_PLATFORM_TIME_CFG_SERVER */
}
else
{
CFE_TIME_Global.CommandErrorCounter++;
CFE_EVS_SendEvent(CFE_TIME_STCF_ERR_EID, CFE_EVS_EventType_ERROR, "Invalid STCF -- secs = %u, usecs = %u",
(unsigned int)CommandPtr->Seconds, (unsigned int)CommandPtr->MicroSeconds);
}

CFE_TIME_SetCommand(&data->Payload, CFE_TIME_SetSTCF, "STCF", CFE_TIME_STCF_EID, CFE_TIME_STCF_CFG_EID,
CFE_TIME_STCF_ERR_EID);
return CFE_SUCCESS;
}

Expand Down