diff --git a/modules/es/fsw/inc/cfe_es_events.h b/modules/es/fsw/inc/cfe_es_events.h index 18ec276e8..97ffa06a2 100644 --- a/modules/es/fsw/inc/cfe_es_events.h +++ b/modules/es/fsw/inc/cfe_es_events.h @@ -32,972 +32,705 @@ */ /**\{*/ -/** \brief 'cFE ES Initialized' -** \event 'cFE ES Initialized' -** -** \par Type: INFORMATION -** -** \par Cause: -** -** This event message is always automatically issued when the Executive Services -** Task completes its Initialization. -**/ +/** + * \brief ES Initialization Event ID + * + * \par Type: INFORMATION + * + * \par Cause: + * + * Executive Services Task initialization complete. + */ #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' -** -** \par Type: INFORMATION -** -** \par Cause: -** -** This event message is always automatically issued when the Executive Services -** Task completes its Initialization. -** -** The \c Version field identifies the tagged version for the cFE Build, the \c chksm field -** provides the 16-bit checksum of the cFE Build and the \c OSAL \c Version field identifies -** the version of the OS Abstraction Layer on which this particular version of the cFE was built. -**/ +/** + * \brief ES Version Information Event ID + * + * \par Type: INFORMATION + * + * \par Cause: + * + * Executive Services Task initialization complete. + */ #define CFE_ES_INITSTATS_INF_EID 2 -/** \brief 'No-op command' -** \event 'No-op command' -** -** \par Type: INFORMATION -** -** \par Cause: -** -** This event message is always automatically issued in response -** to a cFE Executive Services \link #CFE_ES_NOOP_CC NO-OP command \endlink -**/ +/** + * \brief ES No-op Command Success Event ID + * + * \par Type: INFORMATION + * + * \par Cause: + * + * \link #CFE_ES_NOOP_CC ES NO-OP command \endlink success. + */ #define CFE_ES_NOOP_INF_EID 3 -/** \brief 'Reset Counters command' -** \event 'Reset Counters command' -** -** \par Type: INFORMATION -** -** \par Cause: -** -** This event message is always automatically issued in response -** to a cFE Executive Services \link #CFE_ES_RESET_COUNTERS_CC Reset Counters command \endlink -**/ +/** + * \brief ES Reset Counters Command Success Event ID + * + * \par Type: INFORMATION + * + * \par Cause: + * + * \link #CFE_ES_RESET_COUNTERS_CC ES Reset Counters command \endlink success. + */ #define CFE_ES_RESET_INF_EID 4 -/** \brief 'Started \%s from \%s, AppID = \%d' -** \event 'Started \%s from \%s, AppID = \%d' -** -** \par Type: INFORMATION -** -** \par Cause: -** -** This event message is automatically issued upon successful completion of -** a cFE Executive Services \link #CFE_ES_START_APP_CC Start Application command \endlink -** -** The first \c 's' string identifies the name of the started Application, the -** second \c 's' string identifies the filename from which the Application was -** loaded and the \c AppId field specifies the Application ID assigned to the -** newly started Application by the cFE Executive Services. -**/ +/** + * \brief ES Start Application Command Success Event ID + * + * \par Type: INFORMATION + * + * \par Cause: + * + * \link #CFE_ES_START_APP_CC ES Start Application command \endlink success. + */ #define CFE_ES_START_INF_EID 6 -/** \brief 'Stop Application \%s Initiated.' -** \event 'Stop Application \%s Initiated.' -** -** \par Type: DEBUG -** -** \par Cause: -** -** This event message is issued upon successful processing of the -** cFE Executive Services \link #CFE_ES_STOP_APP_CC Stop Application command \endlink -** Note that when this event is displayed, the Application is not deleted. ES has -** accepted the request to delete the application, and it will be deleted after the app exits -** it's main loop, or times out. -** -** The \c 's' field identifies the name of the Application that will be stopped. -**/ +/** + * \brief ES Stop Application Command Request Success Event ID + * + * \par Type: DEBUG + * + * \par Cause: + * + * \link #CFE_ES_STOP_APP_CC ES Stop Application command \endlink success. + * Note this event signifies the request to delete the application has been sucessfully + * submitted. The successful completion will generate a #CFE_ES_STOP_INF_EID event. + */ #define CFE_ES_STOP_DBG_EID 7 -/** \brief 'Stop Application \%s Completed.' -** \event 'Stop Application \%s Completed.' -** -** \par Type: INFORMATION -** -** \par Cause: -** -** This event message is issued when the cFE finishes deleting the cFE Application -** That was started when the \link #CFE_ES_STOP_APP_CC Stop Application command \endlink -** was issued. -** -** The \c 's' field identifies the name of the Application that was stopped. -*/ +/** + * \brief ES Stop Application Completed Event ID + * + * \par Type: INFORMATION + * + * \par Cause: + * + * Request to delete an application successfully completed. + */ #define CFE_ES_STOP_INF_EID 8 -/** \brief 'Restart Application \%s Initiated.' -** \event 'Restart Application \%s Initiated.' -** -** \par Type: DEBUG -** -** \par Cause: -** -** This event message is issued upon successful processing of the -** cFE Executive Services \link #CFE_ES_RESTART_APP_CC Restart Application command \endlink -** Note that when this event is displayed, the Application is not restarted. ES has -** accepted the request to restart the application, and it will be restarted after the app exits -** it's main loop, or times out. -** -** The \c 's' field identifies the name of the Application that will be restarted. -**/ +/** + * \brief ES Restart Application Command Request Success Event ID + * + * \par Type: DEBUG + * + * \par Cause: + * + * \link #CFE_ES_RESTART_APP_CC ES Restart Application command \endlink success. + * Note this event signifies the request to restart the application has been sucessfully + * submitted. The successful completion will generate a #CFE_ES_RESTART_APP_INF_EID event. + */ #define CFE_ES_RESTART_APP_DBG_EID 9 -/** \brief 'Restart Application \%s Completed, AppID=%lu' -** \event 'Restart Application \%s Completed, AppID=%lu' -** -** \par Type: INFORMATION -** -** \par Cause: -** -** This event message is issued when the cFE finishes Restarting the cFE Application -** That was started when the \link #CFE_ES_RESTART_APP_CC Restart Application command \endlink -** was issued. -** -** The \c 's' field identifies the name of the Application that was restarted, and -** the %lu field identifies the new Application ID -*/ +/** + * \brief ES Restart Application Completed Event ID + * + * \par Type: INFORMATION + * + * \par Cause: + * + * Request to restart an application successfully completed. + */ #define CFE_ES_RESTART_APP_INF_EID 10 -/** \brief 'Reload Application \%s Initiated.' -** \event 'Reload Application \%s Initiated.' -** -** \par Type: DEBUG -** -** \par Cause: -** -** This event message is issued upon successful processing of the -** cFE Executive Services \link #CFE_ES_RELOAD_APP_CC Reload Application command \endlink -** Note that when this event is displayed, the Application is not reloaded. ES has -** accepted the request to reload the application, and it will be reloaded after the app exits -** it's main loop, or times out. -** -** The \c 's' field identifies the name of the Application that will be reloaded. -**/ +/** + * \brief ES Reload Application Command Request Success Event ID + * + * \par Type: DEBUG + * + * \par Cause: + * + * \link #CFE_ES_RELOAD_APP_CC ES Reload Application command \endlink success. + * Note this event signifies the request to reload the application has been sucessfully + * submitted. The successful completion will generate a #CFE_ES_RELOAD_APP_INF_EID event. + */ #define CFE_ES_RELOAD_APP_DBG_EID 11 -/** \brief 'Reload Application \%s Completed, AppID=%lu' -** \event 'Reload Application \%s Completed, AppID=%lu' -** -** \par Type: INFORMATION -** -** \par Cause: -** -** This event message is issued when the cFE finishes Reloading the cFE Application -** That was started when the \link #CFE_ES_RELOAD_APP_CC Restart Application command \endlink -** was issued. -** -** The \c 's' field identifies the name of the Application that was reloaded, and -** the %lu field identifies the new Application ID -*/ +/** + * \brief ES Reload Application Complete Event ID + * + * \par Type: INFORMATION + * + * \par Cause: + * + * Request to reload an application sucessfully completed. + */ #define CFE_ES_RELOAD_APP_INF_EID 12 -/** \brief 'Exit Application \%s Completed.' -** \event 'Exit Application \%s Completed.' -** -** \par Type: INFORMATION -** -** \par Cause: -** -** This event message is issued when the cFE finishes exiting/cleaning up an -** application that called the CFE_ES_ExitApp API with the CFE_ES_RunStatus_APP_EXIT parameter. -** When an App calls this API, the request is recorded and the Executive Services App will -** actually delete cFE Application before issuing this event message. -** -** The \c 's' field identifies the name of the Application that was exited. -*/ +/** + * \brief ES Nominal Exit Application Complete Event ID + * + * \par Type: INFORMATION + * + * \par Cause: + * + * Nominal request to exit an application successfully completed. + * This event indicates the Application exited due to a nominal exit condition. + */ #define CFE_ES_EXIT_APP_INF_EID 13 -/** \brief 'Exit Application \%s Completed.' -** \event 'Exit Application \%s Completed.' -** -** \par Type: INFORMATION -** -** \par Cause: -** -** This event message is issued when the cFE finishes exiting/cleaning up an -** application that called the CFE_ES_ExitApp API with an ERROR condition. -** When an App calls this API, with the CFE_ES_RunStatus_APP_ERROR parameter, it indicates -** that the Application exited due to an error condition. The details of the -** error that occurred should be given by the Application through an event message, -** System Log entry, or both. -** The request is recorded and the Executive Services App will actually delete -** cFE Application before issuing this event message. -** -** The \c 's' field identifies the name of the Application that was exited. -*/ +/** + * \brief ES Error Exit Application Complete Event ID + * + * \par Type: INFORMATION + * + * \par Cause: + * + * Error request to exit an application successfully completed. + * This event indicates the Application exited due to an error condition. The details of the + * error that occurred should be given by the Application through an event message, + * System Log entry, or both. + */ #define CFE_ES_ERREXIT_APP_INF_EID 14 -/** \brief 'Sent \%s application data' -** \event 'Sent \%s application data' -** -** \par Type: DEBUG -** -** \par Cause: -** -** This event message is issued upon successful completion of the -** cFE Executive Services \link #CFE_ES_QUERY_ONE_CC Query One Application command \endlink -** -** The \c 's' field identifies the name of the Application whose Executive Services -** Application information has been telemetered. -**/ +/** + * \brief ES Query One Application Command Success Event ID + * + * \par Type: DEBUG + * + * \par Cause: + * + * \link #CFE_ES_QUERY_ONE_CC ES Query One Application command \endlink success. + */ #define CFE_ES_ONE_APP_EID 15 -/** \brief 'App Info file written to \%s, Entries=\%d, FileSize=\%d' -** \event 'App Info file written to \%s, Entries=\%d, FileSize=\%d' -** -** \par Type: DEBUG -** -** \par Cause: -** -** This event message is issued upon successful completion of the cFE Executive -** Services \link #CFE_ES_QUERY_ALL_CC Query All Applications command \endlink -** -** The \c 's' field identifies the name of the file to which all Executive Services Application -** data has been written. The \c Entries field identifies, in decimal, the number of Applications -** whose data was written and the \c FileSize field gives the total number of bytes written to the -** file. -**/ +/** + * \brief ES Query All Applications Command Success Event ID + * + * \par Type: DEBUG + * + * \par Cause: + * + * \link #CFE_ES_QUERY_ALL_CC ES Query All Applications command \endlink success. + */ #define CFE_ES_ALL_APPS_EID 16 -/** \brief 'Cleared Executive Services log data' -** \event 'Cleared Executive Services log data' -** -** \par Type: INFORMATION -** -** \par Cause: -** -** This event message is generated upon successful completion of the cFE Executive -** Services \link #CFE_ES_CLEAR_SYSLOG_CC Clear System Log command \endlink -**/ +/** + * \brief ES Clear System Log Command Success Event ID + * + * \par Type: INFORMATION + * + * \par Cause: + * + * \link #CFE_ES_CLEAR_SYSLOG_CC Clear System Log command \endlink success. + */ #define CFE_ES_SYSLOG1_INF_EID 17 -/** \brief '\%s written:Size=\%d,Entries=\%d' -** \event '\%s written:Size=\%d,Entries=\%d' -** -** \par Type: DEBUG -** -** \par Cause: -** -** This event message is generated when the System Log has been successfully written -** to a file after receiving the cFE Executive Services \link #CFE_ES_CLEAR_SYSLOG_CC Write Executive -** Services System Log command \endlink -** -** The \c 's' field identifies the name of the file written to, the \c Size field specifies, in decimal, -** the number of bytes written to the file and the \c Entries field identifies the number of System Log -** messages that were written. -**/ +/** + * \brief ES Write System Log Command Success Event ID + * + * \par Type: DEBUG + * + * \par Cause: + * + * \link #CFE_ES_CLEAR_SYSLOG_CC ES Write System Log command \endlink success. + */ #define CFE_ES_SYSLOG2_EID 18 -/** \brief 'Cleared mode log data' -** \event 'Cleared mode log data' -** -** \par Type: INFORMATION -** -** \par Cause: -** -** This event message is generated upon successful completion of the cFE Executive -** Services \link #CFE_ES_CLEAR_ER_LOG_CC Clear Exception Reset Log command \endlink -**/ +/** + * \brief ES Clear Exception Reset Log Command Success Event ID + * + * \par Type: INFORMATION + * + * \par Cause: + * + * \link #CFE_ES_CLEAR_ER_LOG_CC ES Clear Exception Reset Log command \endlink success. + */ #define CFE_ES_ERLOG1_INF_EID 19 -/** \brief '\%s written:Size=\%d' -** \event '\%s written:Size=\%d' -** -** \par Type: DEBUG -** -** \par Cause: -** -** This event message is generated when the Exception Reset Log has been successfully written -** to a file after receiving the cFE Executive Services \link #CFE_ES_WRITE_ER_LOG_CC Write Executive -** Services Exception Reset Log command \endlink -** -** The \c 's' field identifies the name of the file written to and the \c Size field specifies, in decimal, -** the number of bytes written to the file. -**/ +/** + * \brief ES Write Exception Reset Log Complete Event ID + * + * \par Type: DEBUG + * + * \par Cause: + * + * Request to write the Exception Reset log successfully completed. + */ #define CFE_ES_ERLOG2_EID 20 -/** \brief 'Invalid command pipe message ID: 0x\%X' -** \event 'Invalid command pipe message ID: 0x\%X' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated when a message has arrived on -** the cFE Executive Services Application's Message Pipe that has a -** Message ID that is neither #CFE_ES_SEND_HK_MID or #CFE_ES_CMD_MID. -** Most likely, the cFE Software Bus routing table has become corrupt -** and is sending messages targeted for other Applications to the cFE -** Executive Services Application. -** -** The \c ID field in the event message identifies -** the message ID (in hex) that was found in the message. -**/ +/** + * \brief ES Invalid Message ID Received Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * Invalid message ID received on the ES message pipe. + */ #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' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated when a message with the #CFE_ES_CMD_MID -** message ID has arrived but whose Command Code is not one of the command -** codes specified in \link #CFE_ES_NOOP_CC cfe_es.h \endlink. This -** problem is most likely to occur when: -** -# A Message ID meant for another Application became corrupted and was -** set equal to #CFE_ES_CMD_MID. -** -# The Command Code field in the Message became corrupted. -** -# The command database at the ground station has been corrupted. -** -** The \c ID field in the event message specifies the Message ID (in hex) and the -** \c CC field specifies the Command Code (in decimal) found in the message. -**/ +/** + * \brief ES Invalid Command Code Received Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * Invalid command code for message ID #CFE_ES_CMD_MID received on the ES message pipe. + */ #define CFE_ES_CC1_ERR_EID 22 -/** \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' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated when a message with the #CFE_ES_CMD_MID -** message ID has arrived but whose packet length does not match the expected -** length for the specified command code. -** -** The \c ID field in the event message specifies the Message ID (in hex), the \c CC field -** specifies the Command Code (in decimal), the \c Exp Len field specified the Expected -** Length (in decimal ), and \c Len specifies the message Length (in decimal) -** found in the message. -**/ +/** + * \brief ES Invalid Command Length Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * Invalid length for the command code in message ID #CFE_ES_CMD_MID received on the ES message pipe. + */ #define CFE_ES_LEN_ERR_EID 23 -/** \brief 'Invalid cFE restart type \%d' -** \event 'Invalid cFE restart type \%d' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is issued when the cFE Executive Services receives a -** \link #CFE_ES_RESTART_CC cFE Restart Command \endlink whose parameter -** identifying the restart type is not equal to either #CFE_PSP_RST_TYPE_PROCESSOR -** or #CFE_PSP_RST_TYPE_POWERON. -** -** The 'd' field identifies the numeric, in decimal, of the restart type found -** in the received cFE Restart Command Packet. -**/ +/** + * \brief ES Restart Command Invalid Restart Type Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * \link #CFE_ES_RESTART_CC ES cFE Restart Command \endlink failure due to invalid restart type. + */ #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' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated for an error encountered in response -** to an Executive Services \link #CFE_ES_START_APP_CC Start Application Command \endlink. -** -** This message is a general failure when the command passes the parameter validation, but -** fails when a call to CFE_ES_AppCreate is called. -** -** The \c 's' term identifies the name of the Application that was attempted to start. -** The second \c 's' field specifies the file from which the Application was loaded. -** The \c 'X' field is the return code returned by the CFE_ES_AppCreate. -**/ +/** + * \brief ES Start Application Command Application Creation Failed Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * \link #CFE_ES_START_APP_CC ES Start Application Command \endlink failure during + * application creation after successful parameter validation. + */ #define CFE_ES_START_ERR_EID 26 -/** \brief 'CFE_ES_StartAppCmd: invalid filename: \%s' -** \event 'CFE_ES_StartAppCmd: invalid filename: \%s' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated for an error encountered in response -** to an Executive Services \link #CFE_ES_START_APP_CC Start Application Command \endlink. -** -** This message reports a command failure when the Start Appplication Command is given -** an invalid filename. ( Either NULL or too short to be a valid cFE file name ). -** -** The \c 's' term identifies the invalid filename that was sent with the command. -**/ +/** + * \brief ES Start Application Command Invalid Filename Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * \link #CFE_ES_START_APP_CC ES Start Application Command \endlink falure due to + * invalid filename. + */ #define CFE_ES_START_INVALID_FILENAME_ERR_EID 27 -/** \brief 'CFE_ES_StartAppCmd: App Entry Point is NULL.' -** \event 'CFE_ES_StartAppCmd: App Entry Point is NULL.' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated for an error encountered in response -** to an Executive Services \link #CFE_ES_START_APP_CC Start Application Command \endlink. -** -** This message reports a command failure when the Start Appplication Command is given -** a NULL Application Entry Point parameter. The command must contain an application entry -** point string. ( Example: "SC_AppMain" ). -** -**/ +/** + * \brief ES Start Application Command Entry Point NULL Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * \link #CFE_ES_START_APP_CC ES Start Application Command \endlink failure due to + * a NULL Application Entry Point. + */ #define CFE_ES_START_INVALID_ENTRY_POINT_ERR_EID 28 -/** \brief 'CFE_ES_StartAppCmd: App Name is NULL.' -** \event 'CFE_ES_StartAppCmd: App Name is NULL.' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated for an error encountered in response -** to an Executive Services \link #CFE_ES_START_APP_CC Start Application Command \endlink. -** -** This message reports a command failure when the Start Appplication Command is given -** a NULL Application Name parameter. The command must contain an application name string. -**/ +/** + * \brief ES Start Application Command App Name NULL Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * \link #CFE_ES_START_APP_CC ES Start Application Command \endlink failure due to + * NULL Application Name. + */ #define CFE_ES_START_NULL_APP_NAME_ERR_EID 29 -/** \brief 'CFE_ES_StartAppCmd: Priority is too large: \%d.' -** \event 'CFE_ES_StartAppCmd: Priority is too large: \%d.' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated for an error encountered in response -** to an Executive Services \link #CFE_ES_START_APP_CC Start Application Command \endlink. -** -** This message reports a command failure when the Application priority greater than the -** maximum priority for a Task defined by the OS Abstraction Layer ( 256 ). -** -** The \c 'd' term identifies the priority that was given in the command. -**/ +/** + * \brief ES Start Application Command Priority Too Large Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * \link #CFE_ES_START_APP_CC ES Start Application Command \endlink failure due to + * a requested application priority greater than the maximum priority allowed for tasks as + * defined by the OS Abstraction Layer (OS_MAX_PRIORITY). + */ #define CFE_ES_START_PRIORITY_ERR_EID 31 -/** \brief 'CFE_ES_StartAppCmd: Invalid Exception Action: \%d.' -** \event 'CFE_ES_StartAppCmd: Invalid Exception Action: \%d.' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated for an error encountered in response -** to an Executive Services \link #CFE_ES_START_APP_CC Start Application Command \endlink. -** -** This message reports a command failure when the Application Exception Action parameter is -** invalid. The valid options for this parameter are: 0 = Application will restart on an exception -** 1 = Application cause a processor restart on -** exception. -** -** The \c 'd' term identifies the Exception Action parameter that was given in the command. -**/ +/** + * \brief ES Start Application Command Exception Action Invalid Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * \link #CFE_ES_START_APP_CC ES Start Application Command \endlink failure due to + * invalid application exception action. + */ #define CFE_ES_START_EXC_ACTION_ERR_EID 32 -/** \brief 'Exit Application \%s on Error Failed: CleanUpApp Error 0x\%08X.' -** \event 'Exit Application \%s on Error Failed: CleanUpApp Error 0x\%08X.' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated when ES is completing the processing of the -** CFE_ES_ExitApp API call with the CFE_ES_RunStatus_APP_ERROR parameter and the call to CFE_ES_CleanUpApp fails. -** At this point the Application will likely be stopped or deleted, but it may be in an unknown state. -** -** The \c 's' field identifies the name of the Application which was attempted to be -** reloaded and the \c RC field identifies the error code, in hex, that will identify -** the precise reason for the failure. -**/ +/** + * \brief ES Error Exit Application Cleanup Failed Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * Error request to exit an application failed during application cleanup. + * Application and related resources will be in undefined state. + */ #define CFE_ES_ERREXIT_APP_ERR_EID 33 -/** \brief 'Stop Application \%s Failed, RC = 0x\%08X' -** \event 'Stop Application \%s Failed, RC = 0x\%08X' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated upon receipt of an Executive Services -** \link #CFE_ES_STOP_APP_CC Stop Application Command \endlink which fails. -** -** The \c 's' field identifies the name of the Application which was attempted to be -** stopped and the \c rc field identifies the error code, in hex, that may identify -** the precise reason for the failure. -**/ +/** + * \brief ES Stop Application Commmand Request Failed Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * \link #CFE_ES_STOP_APP_CC ES Stop Application Command \endlink request failed. + */ #define CFE_ES_STOP_ERR1_EID 35 -/** \brief 'Stop Application \%s, GetAppIDByName failed. RC = 0x\%08X.' -** \event 'Stop Application \%s, GetAppIDByName failed. RC = 0x\%08X.' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated upon receipt of an Executive Services -** \link #CFE_ES_STOP_APP_CC Stop Application Command \endlink which fails. This message -** is for a specific failure when the call to CFE_ES_GetAppIDByName fails. The application -** will not be deleted at this point. -** -** The \c 's' field identifies the name of the Application which was attempted to be -** stopped and the \c RC field identifies the error code, in hex, that will identify -** the precise reason for the failure. -**/ +/** + * \brief ES Stop Application Command Get AppID By Name Failed Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * \link #CFE_ES_STOP_APP_CC ES Stop Application Command \endlink failed to get application + * ID from application name. The application will not be deleted. + */ #define CFE_ES_STOP_ERR2_EID 36 -/* -** "Stop Application \%s Failed: CleanUpApp Error 0x\%08X." -*/ - -/** \brief 'Stop Application \%s Failed: CleanUpApp Error 0x\%08X.' -** \event 'Stop Application \%s Failed: CleanUpApp Error 0x\%08X.' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated upon receipt of an Executive Services -** \link #CFE_ES_STOP_APP_CC Stop Application Command \endlink which fails. This message -** is for a specific failure when the call to CFE_ES_GetAppIDByName fails. The application -** will not be deleted at this point. -** -** The \c 's' field identifies the name of the Application which was attempted to be -** stopped and the \c RC field identifies the error code, in hex, that will identify -** the precise reason for the failure. -**/ +/** + * \brief ES Stop Application Cleanup Failed Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * Request to delete an application failed during application cleanup. + * Application and related resources will be in undefined state. + */ #define CFE_ES_STOP_ERR3_EID 37 -/** \brief 'Restart Application \%s Failed, RC = 0x\%08X' -** \event 'Restart Application \%s Failed, RC = 0x\%08X' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated when an Executive Services \link #CFE_ES_RESTART_APP_CC Restart Application -** Command \endlink fails. -** -** The \c 's' field identifies the name of the Application which was attempted to be -** reset and the \c rc field identifies the error code, in hex, that may identify -** the precise reason for the failure. -**/ +/** + * \brief ES Restart Application Command Request Failed Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * \link #CFE_ES_RESTART_APP_CC ES Restart Application Command \endlink request failed. + */ #define CFE_ES_RESTART_APP_ERR1_EID 38 -/** \brief 'Restart Application \%s, GetAppIDByName failed. RC = 0x\%08X.' -** \event 'Restart Application \%s, GetAppIDByName failed. RC = 0x\%08X.' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated upon receipt of an Executive Services -** \link #CFE_ES_RESTART_APP_CC Restart Application Command \endlink which fails. This message -** is for a specific failure when the call to CFE_ES_GetAppIDByName fails. The application -** will not be restarted at this point. -** -** The \c 's' field identifies the name of the Application which was attempted to be -** restarted and the \c RC field identifies the error code, in hex, that will identify -** the precise reason for the failure. -**/ +/** + * \brief ES Restart Application Command Get AppID By Name Failed Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * \link #CFE_ES_RESTART_APP_CC ES Restart Application Command \endlink failed to get application + * ID from application name. The application will not be restarted. + */ #define CFE_ES_RESTART_APP_ERR2_EID 39 -/* -** "Restart Application \%s Failed: AppCreate Error 0x\%08X." -*/ - -/** \brief 'Restart Application \%s Failed: AppCreate Error 0x\%08X.' -** \event 'Restart Application \%s Failed: AppCreate Error 0x\%08X.' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated upon receipt of an Executive Services -** \link #CFE_ES_RESTART_APP_CC Restart Application Command \endlink which fails. This message -** is for a specific failure when the call to CFE_ES_AppCreate fails. The application -** will not be restarted at this point. -** -** The \c 's' field identifies the name of the Application which was attempted to be -** restarted and the \c RC field identifies the error code, in hex, that will identify -** the precise reason for the failure. -**/ +/** + * \brief ES Restart Application Startup Failed Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * Request to restart an application failed during application startup. The application + * will not be restarted. + */ #define CFE_ES_RESTART_APP_ERR3_EID 40 -/** \brief 'Restart Application \%s Failed: CleanUpApp Error 0x\%08X.' -** \event 'Restart Application \%s Failed: CleanUpApp Error 0x\%08X.' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated upon receipt of an Executive Services -** \link #CFE_ES_RESTART_APP_CC Restart Application Command \endlink which fails. This message -** is for a specific failure when the call to CFE_ES_CleanUpApp fails. The application -** will not be restarted at this point, but will likely be deleted or in an unknown state. -** -** The \c 's' field identifies the name of the Application which was attempted to be -** restarted and the \c RC field identifies the error code, in hex, that will identify -** the precise reason for the failure. -**/ +/** + * \brief ES Restart Application Cleanup Failed Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * Request to restart an application failed during application cleanup. The application + * will not be restarted and will be in an undefined state along with it's associated + * resources. + */ #define CFE_ES_RESTART_APP_ERR4_EID 41 -/** \brief 'Failed to reload Application \%s, rc = \%08X' -** \event 'Failed to reload Application \%s, rc = \%08X' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated when an Executive Services \link #CFE_ES_RELOAD_APP_CC Reload Application -** Command \endlink fails. -** -** The \c 's' field identifies the name of the Application which was attempted to be -** reloaded and the \c rc field identifies the error code, in hex, that may identify -** the precise reason for the failure. -**/ +/** + * \brief ES Reload Application Command Request Failed Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * \link #CFE_ES_RELOAD_APP_CC ES Reload Application Command \endlink request failed.. + */ #define CFE_ES_RELOAD_APP_ERR1_EID 42 -/** \brief 'Reload Application \%s, GetAppIDByName failed. RC = 0x\%08X.' -** \event 'Reload Application \%s, GetAppIDByName failed. RC = 0x\%08X.' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated upon receipt of an Executive Services -** \link #CFE_ES_RELOAD_APP_CC Reload Application Command \endlink which fails. This message -** is for a specific failure when the call to CFE_ES_GetAppIDByName fails. The application -** will not be reloaded at this point. -** -** The \c 's' field identifies the name of the Application which was attempted to be -** reloaded and the \c RC field identifies the error code, in hex, that will identify -** the precise reason for the failure. -**/ +/** + * \brief ES Reload Application Command Get AppID By Name Failed Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * \link #CFE_ES_RELOAD_APP_CC ES Reload Application Command \endlink failed to get application + * ID from application name. The application will not be reloaded. + */ #define CFE_ES_RELOAD_APP_ERR2_EID 43 -/** \brief 'Reload Application \%s Failed: AppCreate Error 0x\%08X.' -** \event 'Reload Application \%s Failed: AppCreate Error 0x\%08X.' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated upon receipt of an Executive Services -** \link #CFE_ES_RELOAD_APP_CC Reload Application Command \endlink which fails. This message -** is for a specific failure when the call to CFE_ES_AppCreate fails. The application -** will not be reloaded at this point. -** -** The \c 's' field identifies the name of the Application which was attempted to be -** reloaded and the \c RC field identifies the error code, in hex, that will identify -** the precise reason for the failure. -**/ +/** + * \brief ES Reload Application Startup Failed Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * Request to reload an application failed during application startup. The application + * will not be reloaded. + */ #define CFE_ES_RELOAD_APP_ERR3_EID 44 -/** \brief 'Reload Application \%s Failed: CleanUpApp Error 0x\%08X.' -** \event 'Reload Application \%s Failed: CleanUpApp Error 0x\%08X.' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated upon receipt of an Executive Services -** \link #CFE_ES_RELOAD_APP_CC Reload Application Command \endlink which fails. This message -** is for a specific failure when the call to CFE_ES_CleanUpApp fails. The application -** will not be reloaded at this point, and will likely be deleted or in an unknown state. -** -** The \c 's' field identifies the name of the Application which was attempted to be -** reloaded and the \c RC field identifies the error code, in hex, that will identify -** the precise reason for the failure. -**/ +/** + * \brief ES Reload Application Cleanup Failed Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * Request to reload an application failed during application cleanup. The application + * will not be reloaded and will be in an undefined state along with it's associated + * resources. + */ #define CFE_ES_RELOAD_APP_ERR4_EID 45 -/** \brief 'Exit Application \%s Failed: CleanUpApp Error 0x\%08X.' -** \event 'Exit Application \%s Failed: CleanUpApp Error 0x\%08X.' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated when ES is completing the processing of the -** CFE_ES_ExitApp API call and the call to CFE_ES_CleanUpApp fails. At this point the Application will -** likely be stopped or deleted, but it may be in an unknown state. -** -** The \c 's' field identifies the name of the Application which was attempted to be -** reloaded and the \c RC field identifies the error code, in hex, that will identify -** the precise reason for the failure. -**/ +/** + * \brief ES Exit Application Cleanup Failed Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * Nominal request to exit an application failed during application cleanup. + * Application and related resources will be in undefined state. + */ #define CFE_ES_EXIT_APP_ERR_EID 46 -/** \brief 'ES_ProcControlReq: Invalid State (EXCEPTION) Application \%s.' -** \event 'ES_ProcControlReq: Invalid State (EXCEPTION) Application \%s.' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated when ES is processing it's internal Application table and encounters -** an App with the EXCEPTION state. Because exceptions are supposed to be processed immediately, this is -** an invalid state and should not happen. It may indicate some sort of memory corruption or other problem. -**/ +/** + * \brief ES Process Control Invalid Exception State Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * Invalid Exception state encountered when processing requests for application state changes. + * Exceptions are processed immediately, so this state should never occur during routine processing. + */ #define CFE_ES_PCR_ERR1_EID 47 -/* -** "CFE_ES_CleanUpApp: Unknown State ( \%d ) Application \%s." -*/ -/** \brief 'ES_ProcControlReq: Unknown State ( \%d ) Application \%s.' -** \event 'ES_ProcControlReq: Unknown State ( \%d ) Application \%s.' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated when ES is processing it's internal Application table and encounters -** an App with an unknown state. If this message occurs, it might be an indication of a memory corruption -** or other problem. -**/ +/** + * \brief ES Process Control Unknown State Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * Unknown state encountered when processing requests for application state changes. + */ #define CFE_ES_PCR_ERR2_EID 48 -/** \brief 'Failed to send \%s application data, RC = \%08X' -** \event 'Failed to send \%s application data, RC = \%08X' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated when an Executive Services \link #CFE_ES_QUERY_ONE_CC Request Application -** Data Command \endlink failed. -** -** The \c 's' field identifies the name of the Application whose data was attempted -** to be telemetered and the \c rc field identifies the error code, in hex, that may identify -** the precise reason for the failure. -**/ +/** + * \brief ES Query One Application Data Command Transmit Message Failed Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * \link #CFE_ES_QUERY_ONE_CC ES Query One Application Data Command \endlink failed during + * message transmission. + */ #define CFE_ES_ONE_ERR_EID 49 -/** \brief 'Failed to send \%s application data: GetAppIDByName Failed, RC = 0x\%08X' -** \event 'Failed to send \%s application data: GetAppIDByName Failed, RC = 0x\%08X' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated when an Executive Services \link #CFE_ES_QUERY_ONE_CC Request Application -** Data Command \endlink failed. -** -** The \c 's' field identifies the name of the Application whose data was attempted -** to be telemetered and the \c rc field identifies the error code, in hex, that may identify -** the precise reason for the failure. -**/ +/** + * \brief ES Query One Application Data Command Get AppID By Name Failed Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * \link #CFE_ES_QUERY_ONE_CC ES Query One Application Data Command \endlink failed to get application + * ID from application name. Message will not be sent. + */ #define CFE_ES_ONE_APPID_ERR_EID 50 -/** \brief 'Failed to write App Info file, OS_OpenCreate returned \%d' -** \event 'Failed to write App Info file, OS_OpenCreate returned \%d' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated when an Executive Services \link #CFE_ES_QUERY_ALL_CC Dump Application -** Data Command \endlink fails to create the dump file. -** -** The \c 'd' parameter identifies, in decimal, the error code returned by #OS_OpenCreate when the attempt was made -** to create the file. -**/ +/** + * \brief ES Query All Application Data Command File Creation Failed Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * \link #CFE_ES_QUERY_ALL_CC Query All Application Data Command \endlink failed to create file. + */ #define CFE_ES_OSCREATE_ERR_EID 51 -/** \brief 'Failed to write App Info file, WriteHdr rtnd \%08X, exp \%d' -** \event 'Failed to write App Info file, WriteHdr rtnd \%08X, exp \%d' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated when an Executive Services \link #CFE_ES_QUERY_ALL_CC Dump Application -** Data Command \endlink fails while writing the cFE Standard File Header. -** -** The \c rtnd field contains the error code returned by the #CFE_FS_WriteHeader API. Nominally, the -** returned result should have been equal to the \c exp field (i.e. - sizeof(#CFE_FS_Header_t)). -**/ +/** + * \brief ES Query All Application Data Command File Write Header Failed Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * \link #CFE_ES_QUERY_ALL_CC Query All Application Data Command \endlink failed to write file header. + */ #define CFE_ES_WRHDR_ERR_EID 52 -/** \brief 'Failed to write App Info file, Task write RC = 0x\%08X, exp \%d' -** \event 'Failed to write App Info file, Task write RC = 0x\%08X, exp \%d' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated whenever an Executive Services \link #CFE_ES_QUERY_ALL_CC Dump Application -** Data Command \endlink fails while writing Application data to the specified file. -** -** The \c rtnd field contains, in hex, the error code returned from the #OS_write API. The expected return -** value is identified, in decimal, in the \c exp field. -**/ +/** + * \brief ES Query All Application Data Command File Write App Data Failed Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * \link #CFE_ES_QUERY_ALL_CC Query All Application Data Command \endlink failed to write file application data. + */ #define CFE_ES_TASKWR_ERR_EID 53 -/** \brief 'Error creating file \%s, stat=0x\%x' -** \event 'Error creating file \%s, stat=0x\%x' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated when an Executive Services \link #CFE_ES_WRITE_SYSLOG_CC Dump System Log -** Command \endlink fails while attempting to create the specified file. -** -** The \c 's' field identifies the name of the file that was attempted to be created and the \c stat field -** specifies, in hex, the error code returned by the #OS_OpenCreate API. -**/ +/** + * \brief ES Write System Log Command Filename Parse or File Creation Failed Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * \link #CFE_ES_WRITE_SYSLOG_CC Write System Log Command \endlink failed parsing file + * name or creating the file. OVERLOADED + */ #define CFE_ES_SYSLOG2_ERR_EID 55 -/** \brief 'Error creating file \%s, stat=0x\%x' -** \event 'Error creating file \%s, stat=0x\%x' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated when an Executive Services \link #CFE_ES_WRITE_ER_LOG_CC Dump Exception Reset Log -** Command \endlink fails while attempting to create the specified file. -** -** The \c 's' field identifies the name of the file that was attempted to be created and the \c stat field -** specifies, in hex, the error code returned by the #OS_OpenCreate API. -**/ +/** + * \brief ES Write Exception Reset Log Command Request or File Creation Failed Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * \link #CFE_ES_WRITE_ER_LOG_CC Write Exception Reset Log Command \endlink request failed or + * file creation failed. OVERLOADED + */ #define CFE_ES_ERLOG2_ERR_EID 56 -/** \brief 'Start collecting performance data command, trigger mode = %d' -** \event 'Start collecting performance data command, trigger mode = %d' -** -** \par Type: DEBUG -** -** \par Cause: -** -** This event message is generated in response to receiving an Executive Services -** \link #CFE_ES_START_PERF_DATA_CC Start Performance Analyzer Data Collection Command \endlink -** -** The \c 'd' field identifies the requested trigger mode as defined by CFE_ES_PerfMode_t. -**/ +/** + * \brief ES Start Performance Analyzer Data Collection Command Success Event ID + * + * \par Type: DEBUG + * + * \par Cause: + * + * \link #CFE_ES_START_PERF_DATA_CC ES Start Performance Analyzer Data Collection Command \endlink success. + */ #define CFE_ES_PERF_STARTCMD_EID 57 -/** \brief 'Cannot start collecting performance data,perf data write in progress' -** \event 'Cannot start collecting performance data,perf data write in progress' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated in response to receiving an Executive Services -** \link #CFE_ES_START_PERF_DATA_CC Start Performance Analyzer Data Collection Command \endlink -**/ +/** + * \brief ES Start Performance Analyzer Data Collection Command Idle Check Failed Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * \link #CFE_ES_START_PERF_DATA_CC ER Start Performance Analyzer Data Collection Command \endlink failed + * due to already being started. + */ #define CFE_ES_PERF_STARTCMD_ERR_EID 58 -/** \brief 'Cannot start collecting performance data, trigger mode (%d) out of range (%d to %d)' -** \event 'Cannot start collecting performance data, trigger mode (%d) out of range (%d to %d)' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated when an Executive Services \link #CFE_ES_START_PERF_DATA_CC -** Start Performance Analyzer Data Collection Command \endlink command is received with a bad -** value for the requested trigger mode. -** -** The first \c 'd' field identifies the received trigger mode value as defined by CFE_ES_PerfMode_t. -** The second and third \c 'd' fields specify the valid range of values for the trigger mode. -**/ +/** + * \brief ES Start Performance Analyzer Data Collection Command Trigger Range Failed Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * \link #CFE_ES_START_PERF_DATA_CC ES Start Performance Analyzer Data Collection Command \endlink failed + * due to invalid trigger mode. + */ #define CFE_ES_PERF_STARTCMD_TRIG_ERR_EID 59 -/** \brief 'Perf Stop Cmd Rcvd,\%s will write \%d entries.\%dmS dly every \%d entries' -** \event 'Perf Stop Cmd Rcvd,\%s will write \%d entries.\%dmS dly every \%d entries' -** -** \par Type: DEBUG -** -** \par Cause: -** -** This event message is generated upon receipt of a successful Performance Data Stop -** Command after receiving the cFE Executive Services \link #CFE_ES_STOP_PERF_DATA_CC Stop -** Performance Analyzer Data Collection Command \endlink -** -** The \c 's' field identifies the name of the file write task that has begun execution. -** The first \c 'd' identifies the total number of performance entries(in decimal) that will be written to the file. -** A performance data entry is defined by an unsigned 32 bit data point and an unsigned 64 bit time stamp. -** The second \c 'd' identifies the millisecond delay between writes and the -** third \c 'd' identifies the number of entries written (in decimal) between delays. -**/ +/** + * \brief ES Stop Performance Analyzer Data Collection Command Request Success Event ID + * + * \par Type: DEBUG + * + * \par Cause: + * + * \link #CFE_ES_STOP_PERF_DATA_CC ES Stop Performance Analyzer Data Collection Command \endlink success. + * Note this event signifies the request to stop and write the performance data has been sucessfully + * submitted. The successful completion will generate a #CFE_ES_PERF_DATAWRITTEN_EID event. + */ #define CFE_ES_PERF_STOPCMD_EID 60 -/** \brief 'Stop performance data cmd ignored,perf data write in progress' -** \event 'Stop performance data cmd ignored,perf data write in progress' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated upon receipt of an unsuccessful Performance Data Stop -** Command after receiving the cFE Executive Services \link #CFE_ES_STOP_PERF_DATA_CC Stop -** Performance Analyzer Data Collection Command \endlink -** -**/ +/** + * \brief ES Stop Performance Analyzer Data Collection Command Request Idle Check Failed Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * \link #CFE_ES_STOP_PERF_DATA_CC ES Stop Performance Analyzer Data Collection Command \endlink failed + * due to a write already in progress. + */ #define CFE_ES_PERF_STOPCMD_ERR2_EID 62 -/** \brief 'Set Performance Filter Mask command' -** \event 'Set Performance Filter Mask command' -** -** \par Type: DEBUG -** -** \par Cause: -** -** This event message is generated in response to receiving an Executive Services -** \link #CFE_ES_SET_PERF_FILTER_MASK_CC Set Performance Analyzer Filter Mask Command \endlink. -** -**/ +/** + * \brief ES Set Performance Analyzer Filter Mask Command Success Event ID + * + * \par Type: DEBUG + * + * \par Cause: + * + * \link #CFE_ES_SET_PERF_FILTER_MASK_CC ES Set Performance Analyzer Filter Mask Command \endlink success. + */ #define CFE_ES_PERF_FILTMSKCMD_EID 63 -/** \brief 'Performance Filter Mask Cmd Error,Index(%u)out of range(%u)' -** \event 'Performance Filter Mask Cmd Error,Index(%u)out of range(%u)' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated in response to receiving an Executive Services -** \link #CFE_ES_SET_PERF_FILTER_MASK_CC Set Performance Analyzer Filter Mask Command \endlink. -** -**/ +/** + * \brief ES Set Performance Analyzer Filter Mask Command Index Range Check Failed Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * \link #CFE_ES_SET_PERF_FILTER_MASK_CC ES Set Performance Analyzer Filter Mask Command \endlink failed + * filter index range check. + */ #define CFE_ES_PERF_FILTMSKERR_EID 64 -/** \brief 'Set Performance Trigger Mask command' -** \event 'Set Performance Trigger Mask command' -** -** \par Type: DEBUG -** -** \par Cause: -** -** This event message is generated in response to receiving an Executive Services -** \link #CFE_ES_SET_PERF_TRIGGER_MASK_CC Set Performance Analyzer Trigger Mask Command \endlink. -** -**/ +/** + * \brief ES Set Performance Analyzer Trigger Mask Command Success Event ID + * + * \par Type: DEBUG + * + * \par Cause: + * + * \link #CFE_ES_SET_PERF_TRIGGER_MASK_CC ES Set Performance Analyzer Trigger Mask Command \endlink success. + */ #define CFE_ES_PERF_TRIGMSKCMD_EID 65 -/** \brief 'Performance Trigger Mask Cmd Error,Index(%u)out of range(%u)' -** \event 'Performance Trigger Mask Cmd Error,Index(%u)out of range(%u)' -** -** \par Type: ERROR -** -** \par Cause: -** -** This event message is generated in response to receiving an Executive Services -** \link #CFE_ES_SET_PERF_TRIGGER_MASK_CC Set Performance Analyzer Trigger Mask Command \endlink. -** -**/ +/** + * \brief ES Set Performance Analyzer Trigger Mask Command Mask Range Check Failed Event ID + * + * \par Type: ERROR + * + * \par Cause: + * + * \link #CFE_ES_SET_PERF_TRIGGER_MASK_CC ES Set Performance Analyzer Trigger Mask Command \endlink failed + * the mask range check. + */ #define CFE_ES_PERF_TRIGMSKERR_EID 66 /** \brief 'Error creating file \%s, stat=\%d' @@ -1425,7 +1158,7 @@ ** ** \par Cause: ** -** This event message is generated when an Executive Services \link #CFE_ES_WRITE_ER_LOG_CC Dump Exception Reset Log +** This event message is generated when an Executive Services \link #CFE_ES_WRITE_ER_LOG_CC Write Exception Reset Log ** Command \endlink is received before a previously-issued command has finished executing ** **/