From 61ea145d85dfce8c935968bbf7bf159bf6c32f56 Mon Sep 17 00:00:00 2001 From: Jacob Hageman Date: Wed, 26 May 2021 21:37:14 +0000 Subject: [PATCH] Fix #1320 #1583, Order event ids and remove max --- modules/es/fsw/inc/cfe_es_events.h | 36 +-- modules/evs/fsw/inc/cfe_evs_events.h | 27 +-- modules/sb/fsw/inc/cfe_sb_events.h | 311 ++++++++++++------------- modules/tbl/fsw/inc/cfe_tbl_events.h | 148 +++++------- modules/time/fsw/inc/cfe_time_events.h | 44 ++-- 5 files changed, 232 insertions(+), 334 deletions(-) diff --git a/modules/es/fsw/inc/cfe_es_events.h b/modules/es/fsw/inc/cfe_es_events.h index 5024fa38b..18ec276e8 100644 --- a/modules/es/fsw/inc/cfe_es_events.h +++ b/modules/es/fsw/inc/cfe_es_events.h @@ -21,33 +21,16 @@ /** * @file * - * Purpose: - * cFE Executive Services (ES) Event IDs - * - * References: - * Flight Software Branch C Coding Standard Version 1.0a - * cFE Flight Software Application Developers Guide - * - * Notes: - * + * cFE Executive Services Event IDs */ #ifndef CFE_ES_EVENTS_H #define CFE_ES_EVENTS_H -/* ************************** -** ****** Maximum EID. ****** -** ************************** -** The EID's below may not necessarily be in order, so it can be difficult to -** determine what the next EID is to use. When you add EID's, start with MAX_EID + 1 -** and when you're done adding, set this to the highest EID you used. It may -** be worthwhile to, on occasion, re-number the EID's to put them back in order. -*/ -#define CFE_ES_MAX_EID 92 - -/* -** ES task event message ID's. -*/ +/** + * \name ES event IDs + */ +/**\{*/ /** \brief 'cFE ES Initialized' ** \event 'cFE ES Initialized' @@ -59,7 +42,7 @@ ** This event message is always automatically issued when the Executive Services ** Task completes its Initialization. **/ -#define CFE_ES_INIT_INF_EID 1 /* start up message "informational" */ +#define CFE_ES_INIT_INF_EID 1 /** \brief 'cFE Version \%d.\%d.\%d chksm \%d, OSAL Version \%d.\%d' ** \event 'cFE Version \%d.\%d.\%d chksm \%d, OSAL Version \%d.\%d' @@ -87,7 +70,7 @@ ** This event message is always automatically issued in response ** to a cFE Executive Services \link #CFE_ES_NOOP_CC NO-OP command \endlink **/ -#define CFE_ES_NOOP_INF_EID 3 /* processed command "informational" */ +#define CFE_ES_NOOP_INF_EID 3 /** \brief 'Reset Counters command' ** \event 'Reset Counters command' @@ -358,7 +341,7 @@ ** The \c ID field in the event message identifies ** the message ID (in hex) that was found in the message. **/ -#define CFE_ES_MID_ERR_EID 21 /* invalid command packet "error" */ +#define CFE_ES_MID_ERR_EID 21 /** \brief 'Invalid ground command code: ID = 0x\%X, CC = \%d' ** \event 'Invalid ground command code: ID = 0x\%X, CC = \%d' @@ -414,7 +397,7 @@ ** The 'd' field identifies the numeric, in decimal, of the restart type found ** in the received cFE Restart Command Packet. **/ -#define CFE_ES_BOOT_ERR_EID 24 /* command specific "error" */ +#define CFE_ES_BOOT_ERR_EID 24 /** \brief 'Failed to start \%s from \%s, RC = \%08X' ** \event 'Failed to start \%s from \%s, RC = \%08X' @@ -1447,5 +1430,6 @@ ** **/ #define CFE_ES_ERLOG_PENDING_ERR_EID 93 +/**\}*/ #endif /* CFE_ES_EVENTS_H */ diff --git a/modules/evs/fsw/inc/cfe_evs_events.h b/modules/evs/fsw/inc/cfe_evs_events.h index 8f1f8db1e..f81c3cdfe 100644 --- a/modules/evs/fsw/inc/cfe_evs_events.h +++ b/modules/evs/fsw/inc/cfe_evs_events.h @@ -21,30 +21,16 @@ /** * @file * - * Purpose: - * cFE Event Services (EVS) Event IDs - * - * Design Notes: - * - * References: - * Flight Software Branch C Coding Standard Version 1.0a - * + * cFE Event Services Event IDs */ #ifndef CFE_EVS_EVENTS_H #define CFE_EVS_EVENTS_H -/* ************************** -** ****** Maximum EID. ****** -** ************************** -** The EID's below may not necessarily be in order, so it can be difficult to -** determine what the next EID is to use. When you add EID's, start with MAX_EID + 1 -** and when you're done adding, set this to the highest EID you used. It may -** be worthwhile to, on occasion, re-number the EID's to put them back in order. -*/ -#define CFE_EVS_MAX_EID 43 - -/* Event Service event ID's */ +/** + * \name EVS event IDs + */ +/**\{*/ /** \brief 'No-op command' ** \event 'No-op command' @@ -56,7 +42,7 @@ ** This event message is always automatically issued in response ** to a cFE Event Services \link #CFE_EVS_NOOP_CC NO-OP command \endlink **/ -#define CFE_EVS_NOOP_EID 0 /* Noop event identifier */ +#define CFE_EVS_NOOP_EID 0 /** \brief 'cFE EVS Initialized' ** \event 'cFE EVS Initialized' @@ -638,5 +624,6 @@ ** found in the message. **/ #define CFE_EVS_LEN_ERR_EID 43 +/**\}*/ #endif /* CFE_EVS_EVENTS_H */ diff --git a/modules/sb/fsw/inc/cfe_sb_events.h b/modules/sb/fsw/inc/cfe_sb_events.h index 682b3fe35..b2636a16d 100644 --- a/modules/sb/fsw/inc/cfe_sb_events.h +++ b/modules/sb/fsw/inc/cfe_sb_events.h @@ -21,34 +21,16 @@ /** * @file * - * Purpose: - * cFE Software Bus (SB) Event IDs - * - * References: - * Flight Software Branch C Coding Standard Version 1.0a - * cFE Flight Software Application Developers Guide - * + * cFE Software Bus Services Event IDs */ #ifndef CFE_SB_EVENTS_H #define CFE_SB_EVENTS_H -/* ************************** -** ****** Maximum EID. ****** -** ************************** -** The EID's below are not necessarily in order, so it can be difficult to -** determine what the next EID is to use. When you add EID's, start with MAX_EID + 1 -** and when you're done adding, set this to the highest EID you used. It may -** be worthwhile to, on occasion, re-number the EID's to put them back in order. -*/ -#define CFE_SB_MAX_EID 67 - -/* -** SB task event message ID's. -*/ -/* -** Event ID's -*/ +/** + * \name SB event IDs + */ +/**\{*/ /** \brief 'cFE SB Initialized' ** \event 'cFE SB Initialized' @@ -113,144 +95,6 @@ **/ #define CFE_SB_PIPE_ADDED_EID 5 -/** \brief 'SetPipeOptsErr:Invalid pipe id (\%d).app \%s' -** \event 'SetPipeOptsErr:Invalid pipe id (\%d).app \%s' -** -** \par Type: ERROR -** -** \par Cause: -** -** This error event message is issued when the #CFE_SB_SetPipeOpts API is called and -** the PipeID is invalid. -**/ -#define CFE_SB_SETPIPEOPTS_ID_ERR_EID 55 - -/** \brief 'SetPipeOptsErr:Caller not owner (\%d).app \%s' -** \event 'SetPipeOptsErr:Caller not owner (\%d).app \%s' -** -** \par Type: ERROR -** -** \par Cause: -** -** This error event message is issued when the #CFE_SB_SetPipeOpts API is called and -** the pipe is owned by another app ID. -**/ -#define CFE_SB_SETPIPEOPTS_OWNER_ERR_EID 56 - -/** \brief 'SetPipeOpts: Options set (\%d). app \%s' -** \event 'SetPipeOpts: Options set (\%d). app \%s' -** -** \par Type: DEBUG -** -** \par Cause: -** -** This debug event is generated when options are set. -**/ -#define CFE_SB_SETPIPEOPTS_EID 57 - -/** \brief 'GetPipeOptsErr:Invalid pipe id (\%d).app \%s' -** \event 'GetPipeOptsErr:Invalid pipe id (\%d).app \%s' -** -** \par Type: ERROR -** -** \par Cause: -** -** This error event message is issued when the #CFE_SB_GetPipeOpts API is called and -** the PipeID is invalid. -**/ -#define CFE_SB_GETPIPEOPTS_ID_ERR_EID 58 - -/** \brief 'GetPipeOptsErr:Invalid opts ptr.app \%s' -** \event 'GetPipeOptsErr:Invalid opts ptr.app \%s' -** -** \par Type: ERROR -** -** \par Cause: -** -** This error event message is issued when the #CFE_SB_GetPipeOpts API is called and -** the pointer is invalid. -**/ -#define CFE_SB_GETPIPEOPTS_PTR_ERR_EID 59 - -/** \brief 'GetPipeOpts: Options retrieved. app \%s' -** \event 'GetPipeOpts: Options retrieved. app \%s' -** -** \par Type: DEBUG -** -** \par Cause: -** -** This debug event is generated when options are retrieved. -**/ -#define CFE_SB_GETPIPEOPTS_EID 60 - -/** \brief 'GetPipeName: Name retrieved. NameOut \%s,Id \%d, app \%s' -** \event 'GetPipeName: Name retrieved. NameOut \%s,Id \%d, app \%s' -** -** \par Type: DEBUG -** -** \par Cause: -** -** This debug event is generated when name is retrieved by id. -**/ -#define CFE_SB_GETPIPENAME_EID 62 - -/** \brief 'GetPipeName: Null ptr error. Id \%d, app \%s' -** \event 'GetPipeName: Null ptr error. Id \%d, app \%s' -** -** \par Type: ERROR -** -** \par Cause: -** -** This debug event is generated when the name buffer ptr is null. -**/ -#define CFE_SB_GETPIPENAME_NULL_PTR_EID 63 - -/** \brief 'GetPipeName: Id error. NameOut \%s,Id \%d, app \%s' -** \event 'GetPipeName: Id error. NameOut \%s,Id \%d, app \%s' -** -** \par Type: ERROR -** -** \par Cause: -** -** This debug event is generated when name is retrieved by id. -**/ -#define CFE_SB_GETPIPENAME_ID_ERR_EID 64 - -/** \brief 'GetPipeIdByName: ID retrieved. Name \%s,IdOut 0x\%x, app \%s' -** \event 'GetPipeIdByName: ID retrieved. Name \%s,IdOut 0x\%x, app \%s' -** -** \par Type: DEBUG -** -** \par Cause: -** -** This debug event is generated when id is retrieved by name. -**/ -#define CFE_SB_GETPIPEIDBYNAME_EID 65 - -/** \brief 'GetPipeIdByName Err:Bad input argument,Name 0x\%x,IdOut 0x%x,App \%s' -** \event 'GetPipeIdByName Err:Bad input argument,Name 0x\%x,IdOut 0x%x,App \%s' -** -** \par Type: ERROR -** -** \par Cause: -** -** This error event message is issued when the #CFE_SB_GetPipeIdByName API receives a -** NULL ptr as an argument. -**/ -#define CFE_SB_GETPIPEIDBYNAME_NULL_ERR_EID 66 - -/** \brief 'GetPipeIdByName Err:Name not found,Name \%s,IdOut 0x%x,App \%s' -** \event 'GetPipeIdByName Err:Name not found,Name \%s,IdOut 0x%x,App \%s' -** -** \par Type: ERROR -** -** \par Cause: -** -** This error event message is issued when the #CFE_SB_GetPipeIdByName API receives an -** invalid name. -**/ -#define CFE_SB_GETPIPEIDBYNAME_NAME_ERR_EID 67 - /** \brief 'Subscribe Err:Bad Arg,MsgId 0x\%x,PipeId \%d,app \%s,scope \%d' ** \event 'Subscribe Err:Bad Arg,MsgId 0x\%x,PipeId \%d,app \%s,scope \%d' ** @@ -861,6 +705,144 @@ **/ #define CFE_SB_DEL_PIPE_ERR2_EID 54 +/** \brief 'SetPipeOptsErr:Invalid pipe id (\%d).app \%s' +** \event 'SetPipeOptsErr:Invalid pipe id (\%d).app \%s' +** +** \par Type: ERROR +** +** \par Cause: +** +** This error event message is issued when the #CFE_SB_SetPipeOpts API is called and +** the PipeID is invalid. +**/ +#define CFE_SB_SETPIPEOPTS_ID_ERR_EID 55 + +/** \brief 'SetPipeOptsErr:Caller not owner (\%d).app \%s' +** \event 'SetPipeOptsErr:Caller not owner (\%d).app \%s' +** +** \par Type: ERROR +** +** \par Cause: +** +** This error event message is issued when the #CFE_SB_SetPipeOpts API is called and +** the pipe is owned by another app ID. +**/ +#define CFE_SB_SETPIPEOPTS_OWNER_ERR_EID 56 + +/** \brief 'SetPipeOpts: Options set (\%d). app \%s' +** \event 'SetPipeOpts: Options set (\%d). app \%s' +** +** \par Type: DEBUG +** +** \par Cause: +** +** This debug event is generated when options are set. +**/ +#define CFE_SB_SETPIPEOPTS_EID 57 + +/** \brief 'GetPipeOptsErr:Invalid pipe id (\%d).app \%s' +** \event 'GetPipeOptsErr:Invalid pipe id (\%d).app \%s' +** +** \par Type: ERROR +** +** \par Cause: +** +** This error event message is issued when the #CFE_SB_GetPipeOpts API is called and +** the PipeID is invalid. +**/ +#define CFE_SB_GETPIPEOPTS_ID_ERR_EID 58 + +/** \brief 'GetPipeOptsErr:Invalid opts ptr.app \%s' +** \event 'GetPipeOptsErr:Invalid opts ptr.app \%s' +** +** \par Type: ERROR +** +** \par Cause: +** +** This error event message is issued when the #CFE_SB_GetPipeOpts API is called and +** the pointer is invalid. +**/ +#define CFE_SB_GETPIPEOPTS_PTR_ERR_EID 59 + +/** \brief 'GetPipeOpts: Options retrieved. app \%s' +** \event 'GetPipeOpts: Options retrieved. app \%s' +** +** \par Type: DEBUG +** +** \par Cause: +** +** This debug event is generated when options are retrieved. +**/ +#define CFE_SB_GETPIPEOPTS_EID 60 + +/** \brief 'GetPipeName: Name retrieved. NameOut \%s,Id \%d, app \%s' +** \event 'GetPipeName: Name retrieved. NameOut \%s,Id \%d, app \%s' +** +** \par Type: DEBUG +** +** \par Cause: +** +** This debug event is generated when name is retrieved by id. +**/ +#define CFE_SB_GETPIPENAME_EID 62 + +/** \brief 'GetPipeName: Null ptr error. Id \%d, app \%s' +** \event 'GetPipeName: Null ptr error. Id \%d, app \%s' +** +** \par Type: ERROR +** +** \par Cause: +** +** This debug event is generated when the name buffer ptr is null. +**/ +#define CFE_SB_GETPIPENAME_NULL_PTR_EID 63 + +/** \brief 'GetPipeName: Id error. NameOut \%s,Id \%d, app \%s' +** \event 'GetPipeName: Id error. NameOut \%s,Id \%d, app \%s' +** +** \par Type: ERROR +** +** \par Cause: +** +** This debug event is generated when name is retrieved by id. +**/ +#define CFE_SB_GETPIPENAME_ID_ERR_EID 64 + +/** \brief 'GetPipeIdByName: ID retrieved. Name \%s,IdOut 0x\%x, app \%s' +** \event 'GetPipeIdByName: ID retrieved. Name \%s,IdOut 0x\%x, app \%s' +** +** \par Type: DEBUG +** +** \par Cause: +** +** This debug event is generated when id is retrieved by name. +**/ +#define CFE_SB_GETPIPEIDBYNAME_EID 65 + +/** \brief 'GetPipeIdByName Err:Bad input argument,Name 0x\%x,IdOut 0x%x,App \%s' +** \event 'GetPipeIdByName Err:Bad input argument,Name 0x\%x,IdOut 0x%x,App \%s' +** +** \par Type: ERROR +** +** \par Cause: +** +** This error event message is issued when the #CFE_SB_GetPipeIdByName API receives a +** NULL ptr as an argument. +**/ +#define CFE_SB_GETPIPEIDBYNAME_NULL_ERR_EID 66 + +/** \brief 'GetPipeIdByName Err:Name not found,Name \%s,IdOut 0x%x,App \%s' +** \event 'GetPipeIdByName Err:Name not found,Name \%s,IdOut 0x%x,App \%s' +** +** \par Type: ERROR +** +** \par Cause: +** +** This error event message is issued when the #CFE_SB_GetPipeIdByName API receives an +** invalid name. +**/ +#define CFE_SB_GETPIPEIDBYNAME_NAME_ERR_EID 67 + /** \brief 'Invalid cmd length: ID = 0x\%X, CC = \%d, Exp Len = \%d, Len = \%d' ** \event 'Invalid cmd length: ID = 0x\%X, CC = \%d, Exp Len = \%d, Len = \%d' ** @@ -877,7 +859,7 @@ ** Length (in decimal ), and \c Len specifies the message Length (in decimal) ** found in the message. **/ -#define CFE_SB_LEN_ERR_EID 61 +#define CFE_SB_LEN_ERR_EID 68 /** \brief 'CreatePipeErr:Name Taken:app=\%s,ptr=0x\%x,depth=\%d,maxdepth=\%d' ** \event 'CreatePipeErr:Name Taken:app=\%s,ptr=0x\%x,depth=\%d,maxdepth=\%d' @@ -889,7 +871,7 @@ ** This error event message is issued when the #CFE_SB_CreatePipe API tries to create ** a pipe with a name that is in use. **/ -#define CFE_SB_CR_PIPE_NAME_TAKEN_EID 62 +#define CFE_SB_CR_PIPE_NAME_TAKEN_EID 69 /** \brief 'CreatePipeErr:No Free:app=\%s,ptr=0x\%x,depth=\%d,maxdepth=\%d' ** \event 'CreatePipeErr:No Free:app=\%s,ptr=0x\%x,depth=\%d,maxdepth=\%d' @@ -901,6 +883,7 @@ ** This error event message is issued when the #CFE_SB_CreatePipe API is unable to ** create a queue because there are no queues free. **/ -#define CFE_SB_CR_PIPE_NO_FREE_EID 63 +#define CFE_SB_CR_PIPE_NO_FREE_EID 70 +/**\}*/ #endif /* CFE_SB_EVENTS_H */ diff --git a/modules/tbl/fsw/inc/cfe_tbl_events.h b/modules/tbl/fsw/inc/cfe_tbl_events.h index ad100681c..216bf20c1 100644 --- a/modules/tbl/fsw/inc/cfe_tbl_events.h +++ b/modules/tbl/fsw/inc/cfe_tbl_events.h @@ -21,40 +21,17 @@ /** * @file * - * Title: Table Services API Event ID Header File - * - * Purpose: - * Identifies event codes for event messages issued by Table Services. - * - * Design Notes: - * - * References: - * Flight Software Branch C Coding Standard Version 1.0a - * - * Notes: - * + * cFE Table Services Event IDs */ #ifndef CFE_TBL_EVENTS_H #define CFE_TBL_EVENTS_H -/* ************************** -** ****** Maximum EID. ****** -** ************************** -** The EID's below may not necessarily be in order, so it can be difficult to -** determine what the next EID is to use. When you add EID's, start with MAX_EID + 1 -** and when you're done adding, set this to the highest EID you used. It may -** be worthwhile to, on occasion, re-number the EID's to put them back in order. -*/ -#define CFE_TBL_MAX_EID 103 - -/******************* Macro Definitions ***********************/ -/* -** Event message ID's -*/ +/** + * \name TBL event IDs + */ +/**\{*/ -/** \name Informational Event Message IDs */ -/** \{ */ /** \brief 'Task Initialized' ** \event 'Task Initialized' ** @@ -66,10 +43,6 @@ ** Task completes its Initialization. **/ #define CFE_TBL_INIT_INF_EID 1 -/** \} */ - -/** \name Command Response Informational Event Message IDs */ -/** \{ */ /** \brief 'No-op command' ** \event 'No-op command' @@ -238,10 +211,56 @@ ** #CFE_TBL_Register API. **/ #define CFE_TBL_ASSUMED_VALID_INF_EID 23 -/** \} */ -/** \name Command Error Event Message IDs */ -/** \{ */ +/** \brief 'Successfully loaded '\%s' from '\%s'' +** \event 'Successfully loaded '\%s' from '\%s'' +** +** \par Type: DEBUG (the first time) and INFORMATION (normally) +** +** \par Cause: +** +** This event message is generated when a Table is successfully updated by its owning Application +** with the contents of the Application specified file or memory area. This Event Message only +** appears when an Application successfully calls the #CFE_TBL_Load API. +**/ +#define CFE_TBL_LOAD_SUCCESS_INF_EID 35 + +/** \brief '\%s validation successful for Inactive '\%s'' +** \event '\%s validation successful for Inactive '\%s'' +** +** \par Type: INFORMATION +** +** \par Cause: +** +** This event message is generated when a Table Image is successfully validated by its owning +** Application via the Validation function specified by the owning Application when the table +** was first registered. +**/ +#define CFE_TBL_VALIDATION_INF_EID 36 + +/** \brief '\%s Successfully Updated '\%s'' +** \event '\%s Successfully Updated '\%s'' +** +** \par Type: INFORMATION +** +** \par Cause: +** +** This event message is generated when a Table's Active Buffer is successfully updated with the contents +** of its Inactive Buffer. +**/ +#define CFE_TBL_UPDATE_SUCCESS_INF_EID 37 + +/** \brief 'Successfully removed '\%s' from CDS' +** \event 'Successfully removed '\%s' from CDS' +** +** \par Type: INFORMATION +** +** \par Cause: +** +** This event message is generated when a Critical Table's CDS has been successfully deleted. +**/ +#define CFE_TBL_CDS_DELETED_INFO_EID 38 + /** \brief 'Invalid message ID -- ID = 0x\%X' ** \event 'Invalid message ID -- ID = 0x\%X' ** @@ -839,63 +858,7 @@ ** is the error code returned. **/ #define CFE_TBL_FAIL_NOTIFY_SEND_ERR_EID 89 -/** \} */ - -/** \name API Informational Event Message IDs */ -/** \{ */ - -/** \brief 'Successfully loaded '\%s' from '\%s'' -** \event 'Successfully loaded '\%s' from '\%s'' -** -** \par Type: DEBUG (the first time) and INFORMATION (normally) -** -** \par Cause: -** -** This event message is generated when a Table is successfully updated by its owning Application -** with the contents of the Application specified file or memory area. This Event Message only -** appears when an Application successfully calls the #CFE_TBL_Load API. -**/ -#define CFE_TBL_LOAD_SUCCESS_INF_EID 35 - -/** \brief '\%s validation successful for Inactive '\%s'' -** \event '\%s validation successful for Inactive '\%s'' -** -** \par Type: INFORMATION -** -** \par Cause: -** -** This event message is generated when a Table Image is successfully validated by its owning -** Application via the Validation function specified by the owning Application when the table -** was first registered. -**/ -#define CFE_TBL_VALIDATION_INF_EID 36 - -/** \brief '\%s Successfully Updated '\%s'' -** \event '\%s Successfully Updated '\%s'' -** -** \par Type: INFORMATION -** -** \par Cause: -** -** This event message is generated when a Table's Active Buffer is successfully updated with the contents -** of its Inactive Buffer. -**/ -#define CFE_TBL_UPDATE_SUCCESS_INF_EID 37 - -/** \brief 'Successfully removed '\%s' from CDS' -** \event 'Successfully removed '\%s' from CDS' -** -** \par Type: INFORMATION -** -** \par Cause: -** -** This event message is generated when a Critical Table's CDS has been successfully deleted. -**/ -#define CFE_TBL_CDS_DELETED_INFO_EID 38 -/** \} */ -/** \name API Error Event Message IDs */ -/** \{ */ /** \brief '\%s Failed to Register '\%s', Status=0x\%08X' ** \event '\%s Failed to Register '\%s', Status=0x\%08X' ** @@ -1094,7 +1057,6 @@ ** The application ID does not have access to the table handle. **/ #define CFE_TBL_HANDLE_ACCESS_ERR_EID 103 - -/** \} */ +/**\}*/ #endif /* CFE_TBL_EVENTS_H */ diff --git a/modules/time/fsw/inc/cfe_time_events.h b/modules/time/fsw/inc/cfe_time_events.h index ae43e9b3b..89e386351 100644 --- a/modules/time/fsw/inc/cfe_time_events.h +++ b/modules/time/fsw/inc/cfe_time_events.h @@ -21,32 +21,17 @@ /** * @file * - * Purpose: - * cFE Time Services (Time) Event IDs - * - * Design Notes: - * - * References: - * Flight Software Branch C Coding Standard Version 1.0a - * + * cFE Time Services Event IDs */ #ifndef CFE_TIME_EVENTS_H #define CFE_TIME_EVENTS_H -/* ************************** -** ****** Maximum EID. ****** -** ************************** -** The EID's below may not necessarily be in order, so it can be difficult to -** determine what the next EID is to use. When you add EID's, start with MAX_EID + 1 -** and when you're done adding, set this to the highest EID you used. It may -** be worthwhile to, on occasion, re-number the EID's to put them back in order. -*/ -#define CFE_TIME_MAX_EID 49 +/** + * \name TIME event IDs + */ +/**\{*/ -/* -** Event message ID's... -*/ /** \brief 'cFE TIME Initialized' ** \event 'cFE TIME Initialized' ** @@ -57,7 +42,7 @@ ** This event message is always automatically issued when the Time Services ** Task completes its Initialization. **/ -#define CFE_TIME_INIT_EID 1 /* start up message "informational" */ +#define CFE_TIME_INIT_EID 1 /** \brief 'No-op command' ** \event 'No-op command' @@ -69,7 +54,7 @@ ** This event message is always automatically issued in response ** to a cFE Time Services \link #CFE_TIME_NOOP_CC NO-OP command \endlink **/ -#define CFE_TIME_NOOP_EID 4 /* processed command "informational" */ +#define CFE_TIME_NOOP_EID 4 /** \brief 'Reset Counters command' ** \event 'Reset Counters command' @@ -273,7 +258,7 @@ ** ** This event message is generated whenever the Time Services enters FLYWHEEL mode. **/ -#define CFE_TIME_FLY_ON_EID 20 /* flywheel state "informational" */ +#define CFE_TIME_FLY_ON_EID 20 /** \brief 'Stop FLYWHEEL' ** \event 'Stop FLYWHEEL' @@ -286,7 +271,7 @@ **/ #define CFE_TIME_FLY_OFF_EID 21 -#define CFE_TIME_EXIT_ERR_EID 25 /* task termination "error" */ +#define CFE_TIME_EXIT_ERR_EID 25 /** \brief 'Invalid message ID -- ID = 0x\%X' ** \event 'Invalid message ID -- ID = 0x\%X' @@ -302,7 +287,7 @@ ** The \c ID field specifies, in hex, the message ID of the inappropriately ** received message. **/ -#define CFE_TIME_ID_ERR_EID 26 /* invalid command packet "error" */ +#define CFE_TIME_ID_ERR_EID 26 /** \brief 'Invalid command code -- ID = 0x\%X, CC = \%d' ** \event 'Invalid command code -- ID = 0x\%X, CC = \%d' @@ -337,7 +322,7 @@ ** The \c State field specifies, in hex, the state value received ** in the command message. **/ -#define CFE_TIME_STATE_ERR_EID 30 /* processed command "error" */ +#define CFE_TIME_STATE_ERR_EID 30 /** \brief 'Invalid Time Source = 0x\%X' ** \event 'Invalid Time Source = 0x\%X' @@ -468,10 +453,6 @@ **/ #define CFE_TIME_DELTA_ERR_EID 37 -/** (obsolete - unused) - **/ -#define CFE_TIME_1HZ_ERR_EID 38 - /** \brief 'Set Source commands invalid without CFE_PLATFORM_TIME_CFG_SOURCE set to true' ** \event 'Set Source commands invalid without CFE_PLATFORM_TIME_CFG_SOURCE set to true' ** @@ -484,7 +465,7 @@ ** and the Time Services configuration parameter #CFE_PLATFORM_TIME_CFG_SOURCE has ** not been set to true in the cfe_platform_cfg.h file. **/ -#define CFE_TIME_SOURCE_CFG_EID 40 /* cmd disabled per cfg "error" */ +#define CFE_TIME_SOURCE_CFG_EID 40 /** \brief 'Set Signal commands invalid without CFE_PLATFORM_TIME_CFG_SIGNAL set to true' ** \event 'Set Signal commands invalid without CFE_PLATFORM_TIME_CFG_SIGNAL set to true' @@ -618,5 +599,6 @@ ** found in the message. **/ #define CFE_TIME_LEN_ERR_EID 49 +/**\}*/ #endif /* CFE_TIME_EVENTS_H */