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

Jump to bottom

Fix #1391, EVS/FS documentation cleanup #1576

Merged
merged 1 commit into from
May 27, 2021
Merged

Fix #1391, EVS/FS documentation cleanup #1576

Show file tree
Hide file tree
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
5 changes: 2 additions & 3 deletions modules/core_api/fsw/inc/cfe_fs.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,11 @@
** -# The File has already been successfully opened using #OS_OpenCreate and
** the caller has a legitimate File Descriptor.
**
** \param[in] FileDes File Descriptor obtained from a previous call to #OS_OpenCreate
** that is associated with the file whose header is to be read.
**
** \param[in, out] Hdr Pointer to a variable of type #CFE_FS_Header_t that will be
** filled with the contents of the Standard cFE File Header. *Hdr is the contents of the
** Standard cFE File Header for the specified file.
** \param[in] FileDes File Descriptor obtained from a previous call to #OS_OpenCreate
** that is associated with the file whose header is to be read.
**
** \return Execution status, see \ref CFEReturnCodes
**
Expand Down
2 changes: 1 addition & 1 deletion modules/core_api/fsw/inc/cfe_fs_extern_typedefs.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ typedef struct CFE_FS_Header
uint32 SubType; /**< \brief Type of \c ContentType, if necessary */
/**< Standard SubType definitions can be found
\link #CFE_FS_SubType_ES_ERLOG here \endlink */
uint32 Length; /**< \brief Length of primary header */
uint32 Length; /**< \brief Length of this header to support external processing */
uint32 SpacecraftID; /**< \brief Spacecraft that generated the file */
uint32 ProcessorID; /**< \brief Processor that generated the file */
uint32 ApplicationID; /**< \brief Application that generated the file */
Expand Down
2 changes: 1 addition & 1 deletion modules/core_private/fsw/inc/cfe_evs_log_typedef.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
typedef struct
{
uint16 Next; /**< \brief Index of the next entry in the local event log */
uint16 LogCount; /**< \brief Local Event Kog counter */
uint16 LogCount; /**< \brief Local Event Log counter */
uint8 LogFullFlag; /**< \brief Local Event Log full flag */
uint8 LogMode; /**< \brief Local Event Logging mode (overwrite/discard) */
uint16 LogOverflowCounter; /**< \brief Local Event Log overflow counter */
Expand Down
50 changes: 10 additions & 40 deletions modules/evs/fsw/src/cfe_evs_task.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -718,10 +718,7 @@ int32 CFE_EVS_SetFilterCmd(const CFE_EVS_SetFilterCmd_t *data)
EVS_AppData_t * AppDataPtr;
char LocalName[OS_MAX_API_NAME];

/*
* Althgouh EVS_GetApplicationInfo() does not require a null terminated argument,
* the value is passed to EVS_SendEvent which does require termination (normal C string)
*/
/* Copy appname from command, ensures NULL termination */
CFE_SB_MessageStringGet(LocalName, (char *)CmdPtr->AppName, NULL, sizeof(LocalName), sizeof(CmdPtr->AppName));

/* Retreive application data */
Expand Down Expand Up @@ -1011,10 +1008,7 @@ int32 CFE_EVS_EnableAppEventTypeCmd(const CFE_EVS_EnableAppEventTypeCmd_t *data)
int32 Status;
char LocalName[OS_MAX_API_NAME];

/*
* Althgouh EVS_GetApplicationInfo() does not require a null terminated argument,
* the value is passed to EVS_SendEvent which does require termination (normal C string)
*/
/* Copy appname from command, ensures NULL termination */
CFE_SB_MessageStringGet(LocalName, (char *)CmdPtr->AppName, NULL, sizeof(LocalName), sizeof(CmdPtr->AppName));

/* Retrieve application data */
Expand Down Expand Up @@ -1079,10 +1073,7 @@ int32 CFE_EVS_DisableAppEventTypeCmd(const CFE_EVS_DisableAppEventTypeCmd_t *dat
int32 Status;
char LocalName[OS_MAX_API_NAME];

/*
* Althgouh EVS_GetApplicationInfo() does not require a null terminated argument,
* the value is passed to EVS_SendEvent which does require termination (normal C string)
*/
/* Copy appname from command, ensures NULL termination */
CFE_SB_MessageStringGet(LocalName, (char *)CmdPtr->AppName, NULL, sizeof(LocalName), sizeof(CmdPtr->AppName));

/* Retreive application data */
Expand Down Expand Up @@ -1147,10 +1138,7 @@ int32 CFE_EVS_EnableAppEventsCmd(const CFE_EVS_EnableAppEventsCmd_t *data)
int32 Status;
char LocalName[OS_MAX_API_NAME];

/*
* Althgouh EVS_GetApplicationInfo() does not require a null terminated argument,
* the value is passed to EVS_SendEvent which does require termination (normal C string)
*/
/* Copy appname from command, ensures NULL termination */
CFE_SB_MessageStringGet(LocalName, (char *)CmdPtr->AppName, NULL, sizeof(LocalName), sizeof(CmdPtr->AppName));

/* Retrieve application data */
Expand Down Expand Up @@ -1199,10 +1187,7 @@ int32 CFE_EVS_DisableAppEventsCmd(const CFE_EVS_DisableAppEventsCmd_t *data)
int32 Status;
char LocalName[OS_MAX_API_NAME];

/*
* Althgouh EVS_GetApplicationInfo() does not require a null terminated argument,
* the value is passed to EVS_SendEvent which does require termination (normal C string)
*/
/* Copy appname from command, ensures NULL termination */
CFE_SB_MessageStringGet(LocalName, (char *)CmdPtr->AppName, NULL, sizeof(LocalName), sizeof(CmdPtr->AppName));

/* Retreive application data */
Expand Down Expand Up @@ -1251,10 +1236,7 @@ int32 CFE_EVS_ResetAppCounterCmd(const CFE_EVS_ResetAppCounterCmd_t *data)
int32 Status;
char LocalName[OS_MAX_API_NAME];

/*
* Althgouh EVS_GetApplicationInfo() does not require a null terminated argument,
* the value is passed to EVS_SendEvent which does require termination (normal C string)
*/
/* Copy appname from command, ensures NULL termination */
CFE_SB_MessageStringGet(LocalName, (char *)CmdPtr->AppName, NULL, sizeof(LocalName), sizeof(CmdPtr->AppName));

/* Retreive application data */
Expand Down Expand Up @@ -1304,10 +1286,7 @@ int32 CFE_EVS_ResetFilterCmd(const CFE_EVS_ResetFilterCmd_t *data)
EVS_AppData_t * AppDataPtr;
char LocalName[OS_MAX_API_NAME];

/*
* Althgouh EVS_GetApplicationInfo() does not require a null terminated argument,
* the value is passed to EVS_SendEvent which does require termination (normal C string)
*/
/* Copy appname from command, ensures NULL termination */
CFE_SB_MessageStringGet(LocalName, (char *)CmdPtr->AppName, NULL, sizeof(LocalName), sizeof(CmdPtr->AppName));

/* Retreive application data */
Expand Down Expand Up @@ -1371,10 +1350,7 @@ int32 CFE_EVS_ResetAllFiltersCmd(const CFE_EVS_ResetAllFiltersCmd_t *data)
uint32 i;
char LocalName[OS_MAX_API_NAME];

/*
* Althgouh EVS_GetApplicationInfo() does not require a null terminated argument,
* the value is passed to EVS_SendEvent which does require termination (normal C string)
*/
/* Copy appname from command, ensures NULL termination */
CFE_SB_MessageStringGet(LocalName, (char *)CmdPtr->AppName, NULL, sizeof(LocalName), sizeof(CmdPtr->AppName));

/* Retreive application data */
Expand Down Expand Up @@ -1427,10 +1403,7 @@ int32 CFE_EVS_AddEventFilterCmd(const CFE_EVS_AddEventFilterCmd_t *data)
EVS_AppData_t * AppDataPtr;
char LocalName[OS_MAX_API_NAME];

/*
* Althgouh EVS_GetApplicationInfo() does not require a null terminated argument,
* the value is passed to EVS_SendEvent which does require termination (normal C string)
*/
/* Copy appname from command, ensures NULL termination */
CFE_SB_MessageStringGet(LocalName, (char *)CmdPtr->AppName, NULL, sizeof(LocalName), sizeof(CmdPtr->AppName));

/* Retreive application data */
Expand Down Expand Up @@ -1514,10 +1487,7 @@ int32 CFE_EVS_DeleteEventFilterCmd(const CFE_EVS_DeleteEventFilterCmd_t *data)
EVS_AppData_t * AppDataPtr;
char LocalName[OS_MAX_API_NAME];

/*
* Althgouh EVS_GetApplicationInfo() does not require a null terminated argument,
* the value is passed to EVS_SendEvent which does require termination (normal C string)
*/
/* Copy appname from command, ensures NULL termination */
CFE_SB_MessageStringGet(LocalName, (char *)CmdPtr->AppName, NULL, sizeof(LocalName), sizeof(CmdPtr->AppName));

/* Retreive application data */
Expand Down