Skip to content

Commit

Permalink
HotFix #2411, move perf enum definition
Browse files Browse the repository at this point in the history
The API documentation should not refer to internal headers, only
public headers.  The fact that the message payload was based on
this enum meant that the enum definition is in the wrong place.
  • Loading branch information
jphickey committed Dec 7, 2023
1 parent 1733ffe commit e56d5e0
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 15 deletions.
16 changes: 15 additions & 1 deletion modules/es/config/default_cfe_es_msgdefs.h
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,20 @@ typedef struct CFE_ES_DeleteCDSCmd_Payload
CdsName[CFE_MISSION_ES_CDS_MAX_FULL_NAME_LEN]; /**< \brief ASCII text string containing name of CDS to delete */
} CFE_ES_DeleteCDSCmd_Payload_t;

/**
* @brief Labels for values to use in #CFE_ES_StartPerfCmd_Payload.TriggerMode
* @sa CFE_ES_StartPerfCmd_Payload
*/
enum CFE_ES_PerfMode
{
CFE_ES_PERF_TRIGGER_START = 0,
CFE_ES_PERF_TRIGGER_CENTER,
CFE_ES_PERF_TRIGGER_END,
CFE_ES_PERF_MAX_MODES
};

typedef uint32 CFE_ES_PerfMode_Enum_t;

/**
** \brief Start Performance Analyzer Command Payload
**
Expand All @@ -151,7 +165,7 @@ typedef struct CFE_ES_DeleteCDSCmd_Payload
**/
typedef struct CFE_ES_StartPerfCmd_Payload
{
uint32 TriggerMode; /**< \brief Desired trigger position (Start, Center, End). Values defined by #CFE_ES_PerfMode. */
CFE_ES_PerfMode_Enum_t TriggerMode; /**< \brief Desired trigger position (Start, Center, End). Values defined by #CFE_ES_PerfMode. */
} CFE_ES_StartPerfCmd_Payload_t;

/**
Expand Down
16 changes: 2 additions & 14 deletions modules/es/fsw/src/cfe_es_perf.h
Original file line number Diff line number Diff line change
Expand Up @@ -49,25 +49,13 @@
/**
* @brief Internal states for Performance Analyzer
*/
enum CFE_ES_PerfState
typedef enum CFE_ES_PerfState
{
CFE_ES_PERF_IDLE = 0,
CFE_ES_PERF_WAITING_FOR_TRIGGER,
CFE_ES_PERF_TRIGGERED,
CFE_ES_PERF_MAX_STATES
};

/**
* @brief Labels for values to use in #CFE_ES_StartPerfCmd_Payload.TriggerMode
* @sa CFE_ES_StartPerfCmd_Payload
*/
enum CFE_ES_PerfMode
{
CFE_ES_PERF_TRIGGER_START = 0,
CFE_ES_PERF_TRIGGER_CENTER,
CFE_ES_PERF_TRIGGER_END,
CFE_ES_PERF_MAX_MODES
};
} CFE_ES_PerfState_t;

/**
* @brief Perflog Dump Background Job states
Expand Down

0 comments on commit e56d5e0

Please sign in to comment.