From 36a0cf1da832c83ce1880e1c2675f55e1af4b08d Mon Sep 17 00:00:00 2001 From: Avi Date: Tue, 6 Dec 2022 09:01:04 +1000 Subject: [PATCH] Fix #2003, Update event type constants in Dev Guide --- docs/cFE Application Developers Guide.md | 24 +++++++++++----------- modules/cfe_testcase/src/message_id_test.c | 2 +- modules/core_api/fsw/inc/cfe_config.h | 6 +++--- modules/core_api/fsw/inc/cfe_es.h | 4 ++-- modules/core_api/fsw/inc/cfe_fs.h | 2 +- 5 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/cFE Application Developers Guide.md b/docs/cFE Application Developers Guide.md index a75cafc25..6e9710f19 100644 --- a/docs/cFE Application Developers Guide.md +++ b/docs/cFE Application Developers Guide.md @@ -1334,7 +1334,7 @@ int32 SAMPLE_TaskInit(void) else if (Status != CFE_SUCCESS) { /* Error creating my critical data store */ - CFE_EVS_SendEvent(SAMPLE_CDS_ERR_EID, CFE_EVS_ERROR, + CFE_EVS_SendEvent(SAMPLE_CDS_ERR_EID, CFE_EVS_EventType_ERROR, "Failed to create CDS (Err=0x%08x)", Status); } @@ -1370,7 +1370,7 @@ void SAMPLE_TaskMain(void) CFE_ES_CopyToCDS(SAMPLE_TaskData.MyCDSHandle, &SAMPLE_MyCDSDataType_t); } } - CFE_EVS_SendEvent(CFE_TBL_EXIT_ERR_EID, CFE_EVS_ERROR, + CFE_EVS_SendEvent(CFE_TBL_EXIT_ERR_EID, CFE_EVS_EventType_ERROR, "SAMPLE Task terminating, err = 0x%X", Status); } ``` @@ -2313,23 +2313,23 @@ configured to downlink event messages if they need to be sent as telemetry. Event Messages are classified within the cFE and on the ground by an Event Type. Event Types defined within the cFE are: -- `CFE_EVS_DEBUG`: Events of this type are primarily for the +- `CFE_EVS_EventType_DEBUG`: Events of this type are primarily for the Developer. The messages contain specific references to code and are of limited use to spacecraft operations personnel. By default, these types of event messages are disabled. -- `CFE_EVS_INFORMATION`: Events of this type are normal events that - confirm expected behavior of the flight software. Examples would be - notification of the processing of a received command, nominal mode +- `CFE_EVS_EventType_INFORMATION`: Events of this type are normal events + that confirm expected behavior of the flight software. Examples would + be notification of the processing of a received command, nominal mode changes, entering/exiting orbit day/night, etc. -- `CFE_EVS_ERROR`: Events of this type are notifications of abnormal - behavior. However, they represent error conditions that have been - identified and corrected for by the flight software. These typically - represent things like erroneous commands, illegal mode change - attempts, switching to redundant hardware, etc. +- `CFE_EVS_EventType_ERROR`: Events of this type are notifications of + abnormal behavior. However, they represent error conditions that have + been identified and corrected for by the flight software. These + typically represent things like erroneous commands, illegal mode + change attempts, switching to redundant hardware, etc. -- `CFE_EVS_CRITICAL`: Events of this type are notifications of error +- `CFE_EVS_EventType_CRITICAL`: Events of this type are notifications of error conditions that the flight software is unable to correct or compensate for. These might be uncorrectable memory errors, hardware failures etc. diff --git a/modules/cfe_testcase/src/message_id_test.c b/modules/cfe_testcase/src/message_id_test.c index 61d99794d..be316f9e7 100644 --- a/modules/cfe_testcase/src/message_id_test.c +++ b/modules/cfe_testcase/src/message_id_test.c @@ -49,7 +49,7 @@ void TestMsgId(void) * "v1" and "v2" implementations do define a specific highest MsgId value, but another * implementation might not have a highest number concept at all. * - * By passing the value of -1, when converted to a an unsigned value (either 16 or 32 bit) + * By passing the value of -1, when converted to an unsigned value (either 16 or 32 bit) * it should translate to a MsgId value with all bits being set. In theory, at least some of * those bits will be not mappable to the packet header bits, and it should therefore elicit * the CFE_MSG_BAD_ARGUMENT response. diff --git a/modules/core_api/fsw/inc/cfe_config.h b/modules/core_api/fsw/inc/cfe_config.h index 4fc3478f2..4081ead44 100644 --- a/modules/core_api/fsw/inc/cfe_config.h +++ b/modules/core_api/fsw/inc/cfe_config.h @@ -40,7 +40,7 @@ #include "cfe_config_ids.h" /** - * @brief Obtain an integer value correlating to an CFE configuration ID + * @brief Obtain an integer value correlating to a CFE configuration ID * * Retreives the integer value associated with the specified key. * @@ -54,7 +54,7 @@ uint32 CFE_Config_GetValue(CFE_ConfigId_t ConfigId); /** - * @brief Obtain a pointer value correlating to an CFE configuration ID + * @brief Obtain a pointer value correlating to a CFE configuration ID * * Retreives the pointer value associated with the specified key. * @@ -68,7 +68,7 @@ uint32 CFE_Config_GetValue(CFE_ConfigId_t ConfigId); const void *CFE_Config_GetObjPointer(CFE_ConfigId_t ConfigId); /** - * @brief Obtain a string value correlating to an CFE configuration ID + * @brief Obtain a string value correlating to a CFE configuration ID * * Retreives the string value associated with the specified key. * diff --git a/modules/core_api/fsw/inc/cfe_es.h b/modules/core_api/fsw/inc/cfe_es.h index ea87cf31b..e72a69ea1 100644 --- a/modules/core_api/fsw/inc/cfe_es.h +++ b/modules/core_api/fsw/inc/cfe_es.h @@ -103,7 +103,7 @@ CFE_Status_t CFE_ES_AppID_ToIndex(CFE_ES_AppId_t AppID, uint32 *Idx); * * Index values are only guaranteed to be unique for resources of the same * type. For instance, the indices corresponding to two [valid] Library - * IDs will never overlap, but the index of an Library and a library ID + * IDs will never overlap, but the index of a Library and a library ID * may be the same. Furthermore, indices may be reused if a resource is * deleted and re-created. * @@ -367,7 +367,7 @@ void CFE_ES_ExitApp(uint32 ExitStatus); ** For ES to report application counters correctly this API should be called ** from the main app task as part of it's main processing loop. ** -** In the event of a externally initiated app shutdown request (such as the APP_STOP, +** In the event of an externally initiated app shutdown request (such as the APP_STOP, ** APP_RELOAD, and APP_RESTART commands) or if a system error occurs requiring the app ** to be shut down administratively, this function returns "false" and optionally sets ** the "RunStatus" output to further indicate the specific application state. diff --git a/modules/core_api/fsw/inc/cfe_fs.h b/modules/core_api/fsw/inc/cfe_fs.h index 8eca284dd..94fb68461 100644 --- a/modules/core_api/fsw/inc/cfe_fs.h +++ b/modules/core_api/fsw/inc/cfe_fs.h @@ -240,7 +240,7 @@ const char *CFE_FS_GetDefaultExtension(CFE_FS_FileCategory_t FileCategory); ** at the first null char, when the input is shorter than the maximum. ** ** \param[out] OutputBuffer Buffer to store result @nonnull. -** \param[in] InputBuffer A input buffer that may contain a file name (e.g. from command) @nonnull. +** \param[in] InputBuffer An input buffer that may contain a file name (e.g. from command) @nonnull. ** \param[in] OutputBufSize Maximum Size of output buffer @nonzero. ** \param[in] InputBufSize Maximum Size of input buffer. ** \param[in] DefaultInput Default value to use for input if InputBffer is empty