Skip to content

Commit

Permalink
Fix nasa#245, Opaque CFE_SB_MsgId_t values
Browse files Browse the repository at this point in the history 
Treat the CFE_SB_MsgId_t type as an opaque/abstract value and do not
assume it is an integer.

This change offers two modes of operation, where CFE_SB_MsgId_t is
defined as a simple integer and is backward compatible, or defined
as a type safe structure.  In type safe mode, passing an integer to
an API requiring a CFE_SB_MsgId_t value will result in an error.
The macros and conversion functions can be used with either mode,
allowing a transition for applications.
  • Loading branch information
@jphickey
jphickey committed Apr 7, 2020
1 parent 62252d1 commit 7be262f
Show file tree
Hide file tree
Showing 21 changed files with 919 additions and 672 deletions.
117 changes: 85 additions & 32 deletions cmake/sample_defs/cpu1_msgids.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,54 +40,107 @@
*/

#include "cfe_mission_cfg.h"
#include "cfe_sb.h" /* for use of the CFE_SB_MSGID_LITERAL macro */

/*
* NOTE: For backward compatibility/transitioning from the integer CFE_SB_MsgId_t type,
* this defines both a "bare value" (integer) as well as the type safe
* CFE_SB_MsgId_t literal value.
*
* The previous MID symbol now resolves to the type-safe literal value,
* which for many use cases is transparent (it can be passed to CFE_SB_Subscribe, etc).
*
* However it does not work for compile-time/static assignment. In this case the
* integer value must still be used.
*
* A future version of CFE should eventually phase out the hardcoded/manually-assigned
* integer values in favor of a runtime lookup base on some implementation of a command
* and data dictionary.
*/

/*
** cFE Command Message Id's
*/
#define CFE_EVS_CMD_MID CFE_MISSION_CMD_MID_BASE1 + CFE_MISSION_EVS_CMD_MSG /* 0x1801 */
/* Message ID 0x1802 is available */
#define CFE_SB_CMD_MID CFE_MISSION_CMD_MID_BASE1 + CFE_MISSION_SB_CMD_MSG /* 0x1803 */
#define CFE_TBL_CMD_MID CFE_MISSION_CMD_MID_BASE1 + CFE_MISSION_TBL_CMD_MSG /* 0x1804 */
#define CFE_TIME_CMD_MID CFE_MISSION_CMD_MID_BASE1 + CFE_MISSION_TIME_CMD_MSG /* 0x1805 */
#define CFE_ES_CMD_MID CFE_MISSION_CMD_MID_BASE1 + CFE_MISSION_ES_CMD_MSG /* 0x1806 */
#define CFE_EVS_CMD_MID_VALUE CFE_MISSION_CMD_MID_BASE1 + CFE_MISSION_EVS_CMD_MSG /* 0x1801 */
/* Message ID 0x1802 is available */
#define CFE_SB_CMD_MID_VALUE CFE_MISSION_CMD_MID_BASE1 + CFE_MISSION_SB_CMD_MSG /* 0x1803 */
#define CFE_TBL_CMD_MID_VALUE CFE_MISSION_CMD_MID_BASE1 + CFE_MISSION_TBL_CMD_MSG /* 0x1804 */
#define CFE_TIME_CMD_MID_VALUE CFE_MISSION_CMD_MID_BASE1 + CFE_MISSION_TIME_CMD_MSG /* 0x1805 */
#define CFE_ES_CMD_MID_VALUE CFE_MISSION_CMD_MID_BASE1 + CFE_MISSION_ES_CMD_MSG /* 0x1806 */

#define CFE_ES_SEND_HK_MID_VALUE CFE_MISSION_CMD_MID_BASE1 + CFE_MISSION_ES_SEND_HK_MSG /* 0x1808 */
#define CFE_EVS_SEND_HK_MID_VALUE CFE_MISSION_CMD_MID_BASE1 + CFE_MISSION_EVS_SEND_HK_MSG /* 0x1809 */
/* Message ID 0x180A is available */
#define CFE_SB_SEND_HK_MID_VALUE CFE_MISSION_CMD_MID_BASE1 + CFE_MISSION_SB_SEND_HK_MSG /* 0x180B */
#define CFE_TBL_SEND_HK_MID_VALUE CFE_MISSION_CMD_MID_BASE1 + CFE_MISSION_TBL_SEND_HK_MSG /* 0x180C */
#define CFE_TIME_SEND_HK_MID_VALUE CFE_MISSION_CMD_MID_BASE1 + CFE_MISSION_TIME_SEND_HK_MSG /* 0x180D */

#define CFE_TIME_TONE_CMD_MID_VALUE CFE_MISSION_CMD_MID_BASE1 + CFE_MISSION_TIME_TONE_CMD_MSG /* 0x1810 */
#define CFE_TIME_1HZ_CMD_MID_VALUE CFE_MISSION_CMD_MID_BASE1 + CFE_MISSION_TIME_1HZ_CMD_MSG /* 0x1811 */

#define CFE_ES_SEND_HK_MID CFE_MISSION_CMD_MID_BASE1 + CFE_MISSION_ES_SEND_HK_MSG /* 0x1808 */
#define CFE_EVS_SEND_HK_MID CFE_MISSION_CMD_MID_BASE1 + CFE_MISSION_EVS_SEND_HK_MSG /* 0x1809 */
/* Message ID 0x180A is available */
#define CFE_SB_SEND_HK_MID CFE_MISSION_CMD_MID_BASE1 + CFE_MISSION_SB_SEND_HK_MSG /* 0x180B */
#define CFE_TBL_SEND_HK_MID CFE_MISSION_CMD_MID_BASE1 + CFE_MISSION_TBL_SEND_HK_MSG /* 0x180C */
#define CFE_TIME_SEND_HK_MID CFE_MISSION_CMD_MID_BASE1 + CFE_MISSION_TIME_SEND_HK_MSG /* 0x180D */

#define CFE_TIME_TONE_CMD_MID CFE_MISSION_CMD_MID_BASE1 + CFE_MISSION_TIME_TONE_CMD_MSG /* 0x1810 */
#define CFE_TIME_1HZ_CMD_MID CFE_MISSION_CMD_MID_BASE1 + CFE_MISSION_TIME_1HZ_CMD_MSG /* 0x1811 */

#define CFE_EVS_CMD_MID CFE_SB_MSGID_LITERAL(CFE_EVS_CMD_MID_VALUE )
#define CFE_SB_CMD_MID CFE_SB_MSGID_LITERAL(CFE_SB_CMD_MID_VALUE )
#define CFE_TBL_CMD_MID CFE_SB_MSGID_LITERAL(CFE_TBL_CMD_MID_VALUE )
#define CFE_TIME_CMD_MID CFE_SB_MSGID_LITERAL(CFE_TIME_CMD_MID_VALUE )
#define CFE_ES_CMD_MID CFE_SB_MSGID_LITERAL(CFE_ES_CMD_MID_VALUE )
#define CFE_ES_SEND_HK_MID CFE_SB_MSGID_LITERAL(CFE_ES_SEND_HK_MID_VALUE )
#define CFE_EVS_SEND_HK_MID CFE_SB_MSGID_LITERAL(CFE_EVS_SEND_HK_MID_VALUE )
#define CFE_SB_SEND_HK_MID CFE_SB_MSGID_LITERAL(CFE_SB_SEND_HK_MID_VALUE )
#define CFE_TBL_SEND_HK_MID CFE_SB_MSGID_LITERAL(CFE_TBL_SEND_HK_MID_VALUE )
#define CFE_TIME_SEND_HK_MID CFE_SB_MSGID_LITERAL(CFE_TIME_SEND_HK_MID_VALUE )
#define CFE_TIME_TONE_CMD_MID CFE_SB_MSGID_LITERAL(CFE_TIME_TONE_CMD_MID_VALUE )
#define CFE_TIME_1HZ_CMD_MID CFE_SB_MSGID_LITERAL(CFE_TIME_1HZ_CMD_MID_VALUE )



/*
** cFE Global Command Message Id's
*/
#define CFE_TIME_DATA_CMD_MID CFE_MISSION_CMD_MID_BASE_GLOB + CFE_MISSION_TIME_DATA_CMD_MSG /* 0x1860 */
#define CFE_TIME_SEND_CMD_MID CFE_MISSION_CMD_MID_BASE_GLOB + CFE_MISSION_TIME_SEND_CMD_MSG /* 0x1862 */
#define CFE_TIME_DATA_CMD_MID_VALUE CFE_MISSION_CMD_MID_BASE_GLOB + CFE_MISSION_TIME_DATA_CMD_MSG /* 0x1860 */
#define CFE_TIME_SEND_CMD_MID_VALUE CFE_MISSION_CMD_MID_BASE_GLOB + CFE_MISSION_TIME_SEND_CMD_MSG /* 0x1862 */

#define CFE_TIME_DATA_CMD_MID CFE_SB_MSGID_LITERAL(CFE_TIME_DATA_CMD_MID_VALUE)
#define CFE_TIME_SEND_CMD_MID CFE_SB_MSGID_LITERAL(CFE_TIME_SEND_CMD_MID_VALUE)

/*
** CFE Telemetry Message Id's
*/
#define CFE_ES_HK_TLM_MID CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_ES_HK_TLM_MSG /* 0x0800 */
#define CFE_EVS_HK_TLM_MID CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_EVS_HK_TLM_MSG /* 0x0801 */
/* Message ID 0x0802 is available */
#define CFE_SB_HK_TLM_MID CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_SB_HK_TLM_MSG /* 0x0803 */
#define CFE_TBL_HK_TLM_MID CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_TBL_HK_TLM_MSG /* 0x0804 */
#define CFE_TIME_HK_TLM_MID CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_TIME_HK_TLM_MSG /* 0x0805 */
#define CFE_TIME_DIAG_TLM_MID CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_TIME_DIAG_TLM_MSG /* 0x0806 */
#define CFE_EVS_LONG_EVENT_MSG_MID CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_EVS_LONG_EVENT_MSG_MSG /* 0x0808 */
#define CFE_EVS_SHORT_EVENT_MSG_MID CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_EVS_SHORT_EVENT_MSG_MSG /* 0x0809 */
#define CFE_SB_STATS_TLM_MID CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_SB_STATS_TLM_MSG /* 0x080A */
#define CFE_ES_APP_TLM_MID CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_ES_APP_TLM_MSG /* 0x080B */
#define CFE_TBL_REG_TLM_MID CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_TBL_REG_TLM_MSG /* 0x080C */
#define CFE_SB_ALLSUBS_TLM_MID CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_SB_ALLSUBS_TLM_MSG /* 0x080D */
#define CFE_SB_ONESUB_TLM_MID CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_SB_ONESUB_TLM_MSG /* 0x080E */
#define CFE_ES_SHELL_TLM_MID CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_ES_SHELL_TLM_MSG /* 0x080F */
#define CFE_ES_MEMSTATS_TLM_MID CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_ES_MEMSTATS_TLM_MSG /* 0x0810 */
#define CFE_ES_HK_TLM_MID_VALUE CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_ES_HK_TLM_MSG /* 0x0800 */
#define CFE_EVS_HK_TLM_MID_VALUE CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_EVS_HK_TLM_MSG /* 0x0801 */
/* Message ID 0x0802 is available */
#define CFE_SB_HK_TLM_MID_VALUE CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_SB_HK_TLM_MSG /* 0x0803 */
#define CFE_TBL_HK_TLM_MID_VALUE CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_TBL_HK_TLM_MSG /* 0x0804 */
#define CFE_TIME_HK_TLM_MID_VALUE CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_TIME_HK_TLM_MSG /* 0x0805 */
#define CFE_TIME_DIAG_TLM_MID_VALUE CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_TIME_DIAG_TLM_MSG /* 0x0806 */
#define CFE_EVS_LONG_EVENT_MSG_MID_VALUE CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_EVS_LONG_EVENT_MSG_MSG /* 0x0808 */
#define CFE_EVS_SHORT_EVENT_MSG_MID_VALUE CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_EVS_SHORT_EVENT_MSG_MSG /* 0x0809 */
#define CFE_SB_STATS_TLM_MID_VALUE CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_SB_STATS_TLM_MSG /* 0x080A */
#define CFE_ES_APP_TLM_MID_VALUE CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_ES_APP_TLM_MSG /* 0x080B */
#define CFE_TBL_REG_TLM_MID_VALUE CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_TBL_REG_TLM_MSG /* 0x080C */
#define CFE_SB_ALLSUBS_TLM_MID_VALUE CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_SB_ALLSUBS_TLM_MSG /* 0x080D */
#define CFE_SB_ONESUB_TLM_MID_VALUE CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_SB_ONESUB_TLM_MSG /* 0x080E */
#define CFE_ES_SHELL_TLM_MID_VALUE CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_ES_SHELL_TLM_MSG /* 0x080F */
#define CFE_ES_MEMSTATS_TLM_MID_VALUE CFE_MISSION_TLM_MID_BASE1 + CFE_MISSION_ES_MEMSTATS_TLM_MSG /* 0x0810 */


#define CFE_ES_HK_TLM_MID CFE_SB_MSGID_LITERAL(CFE_ES_HK_TLM_MID_VALUE )
#define CFE_EVS_HK_TLM_MID CFE_SB_MSGID_LITERAL(CFE_EVS_HK_TLM_MID_VALUE )
#define CFE_SB_HK_TLM_MID CFE_SB_MSGID_LITERAL(CFE_SB_HK_TLM_MID_VALUE )
#define CFE_TBL_HK_TLM_MID CFE_SB_MSGID_LITERAL(CFE_TBL_HK_TLM_MID_VALUE )
#define CFE_TIME_HK_TLM_MID CFE_SB_MSGID_LITERAL(CFE_TIME_HK_TLM_MID_VALUE )
#define CFE_TIME_DIAG_TLM_MID CFE_SB_MSGID_LITERAL(CFE_TIME_DIAG_TLM_MID_VALUE )
#define CFE_EVS_LONG_EVENT_MSG_MID CFE_SB_MSGID_LITERAL(CFE_EVS_LONG_EVENT_MSG_MID_VALUE )
#define CFE_EVS_SHORT_EVENT_MSG_MID CFE_SB_MSGID_LITERAL(CFE_EVS_SHORT_EVENT_MSG_MID_VALUE )
#define CFE_SB_STATS_TLM_MID CFE_SB_MSGID_LITERAL(CFE_SB_STATS_TLM_MID_VALUE )
#define CFE_ES_APP_TLM_MID CFE_SB_MSGID_LITERAL(CFE_ES_APP_TLM_MID_VALUE )
#define CFE_TBL_REG_TLM_MID CFE_SB_MSGID_LITERAL(CFE_TBL_REG_TLM_MID_VALUE )
#define CFE_SB_ALLSUBS_TLM_MID CFE_SB_MSGID_LITERAL(CFE_SB_ALLSUBS_TLM_MID_VALUE )
#define CFE_SB_ONESUB_TLM_MID CFE_SB_MSGID_LITERAL(CFE_SB_ONESUB_TLM_MID_VALUE )
#define CFE_ES_SHELL_TLM_MID CFE_SB_MSGID_LITERAL(CFE_ES_SHELL_TLM_MID_VALUE )
#define CFE_ES_MEMSTATS_TLM_MID CFE_SB_MSGID_LITERAL(CFE_ES_MEMSTATS_TLM_MID_VALUE )


/*
* MID definitions by these older names are required to make some existing apps compile
Expand Down
Loading

0 comments on commit 7be262f

Please sign in to comment.