Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix #2473, 2475, document and use topicid numbers for cfe #2474

Merged
merged 2 commits into from
Dec 12, 2023
Merged

Fix #2473, 2475, document and use topicid numbers for cfe #2474

merged 2 commits into from
Dec 12, 2023

Conversation

jphickey
Copy link
Contributor

@jphickey jphickey commented Dec 6, 2023

Checklist (Please check before submitting)

Describe the contribution
A topic ID is the same concept as was previously referred to as a portable message number. This just formalizes it, gives it a name, and adds some macros for easier customization of the behavior.

Fixes #2473

Testing performed
Build CFE and run tests with and without an override file

Expected behavior changes
More configuration flexibility for users and different use cases

System(s) tested on
Debian

Additional context
Both mission and arch/platform builds should now support an all-inclusive topicid/msgid header file, respectively. Most users prefer to put all the IDs in the same header so it can be more easily identified if there is a conflict.

Contributor Info - All information REQUIRED for consideration of pull request
Joseph Hickey, Vantage Systems, Inc.

@jphickey jphickey requested a review from skliper December 6, 2023 18:55
@jphickey jphickey marked this pull request as draft December 6, 2023 18:55
@jphickey jphickey linked an issue Dec 7, 2023 that may be closed by this pull request
Rename time 1HZ signal to ONEHZ #2475
Closed
@jphickey jphickey changed the title Fix #2473, document and use topicid numbers for cfe Fix #2473, 2475, document and use topicid numbers for cfe Dec 7, 2023
@jphickey
Fix nasa#2473, document and use topicid numbers for cfe
f3cdfbe 
A topic ID is the same concept as was previously referred to as a
portable message number.  This just formalizes it, gives it a name,
and adds some macros for easier customization of the behavior.
@jphickey
Fix nasa#2475, rename 1HZ to ONEHZ in symbols
1d6a761 
This avoids having an identifier that starts with a digit
in the case that the CFE_TIME_ prefix is not needed/used.
@jphickey jphickey marked this pull request as ready for review December 7, 2023 13:56
@jphickey jphickey added the CCB:Ready Ready for discussion at the Configuration Control Board (CCB) label Dec 7, 2023
github-advanced-security[bot]
github-advanced-security bot found potential problems Dec 7, 2023
View reviewed changes
modules/time/ut-coverage/time_UT.c
@@ -49,14 +49,14 @@
"%s: Application Init Failed,RC=0x%08X\n",
"%s: Failed invalid arguments\n"};

static const UT_TaskPipeDispatchId_t UT_TPID_CFE_TIME_SEND_HK = {.MsgId =
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_TIME_SEND_HK = {.MsgId =

Check notice

Code scanning / CodeQL-coding-standard

Variable scope too large Note

The variable UT_TPID_CFE_TIME_SEND_HK is only accessed in
Test_PipeCmds
Loading
and should be scoped accordingly.
modules/time/ut-coverage/time_UT.c
CFE_SB_MSGID_WRAP_VALUE(CFE_TIME_SEND_HK_MID)};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_TIME_TONE_CMD = {.MsgId =
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_TIME_TONE_CMD = {.MsgId =

Check notice

Code scanning / CodeQL-coding-standard

Variable scope too large Note

The variable UT_TPID_CFE_TIME_TONE_CMD is only accessed in
Test_PipeCmds
Loading
and should be scoped accordingly.
modules/time/ut-coverage/time_UT.c
CFE_SB_MSGID_WRAP_VALUE(CFE_TIME_TONE_CMD_MID)};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_TIME_DATA_CMD = {.MsgId =
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_TIME_DATA_CMD = {.MsgId =

Check notice

Code scanning / CodeQL-coding-standard

Variable scope too large Note

The variable UT_TPID_CFE_TIME_DATA_CMD is only accessed in
Test_PipeCmds
Loading
and should be scoped accordingly.
modules/time/ut-coverage/time_UT.c
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_TIME_CMD_MID), .CommandCode = CFE_TIME_ADD_1HZ_ADJUSTMENT_CC};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_TIME_CMD_SUB_1HZ_ADJUSTMENT_CC = {
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_TIME_CMD_MID), .CommandCode = CFE_TIME_SUB_1HZ_ADJUSTMENT_CC};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_TIME_CMD_ADD_ONEHZ_ADJUSTMENT_CC = {

Check notice

Code scanning / CodeQL-coding-standard

Variable scope too large Note

The variable UT_TPID_CFE_TIME_CMD_ADD_ONEHZ_ADJUSTMENT_CC is only accessed in
Test_PipeCmds
Loading
and should be scoped accordingly.
modules/time/ut-coverage/time_UT.c
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_TIME_CMD_MID), .CommandCode = CFE_TIME_SUB_1HZ_ADJUSTMENT_CC};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_TIME_CMD_ADD_ONEHZ_ADJUSTMENT_CC = {
.MsgId = CFE_SB_MSGID_WRAP_VALUE(CFE_TIME_CMD_MID), .CommandCode = CFE_TIME_ADD_ONEHZ_ADJUSTMENT_CC};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_TIME_CMD_SUB_ONEHZ_ADJUSTMENT_CC = {

Check notice

Code scanning / CodeQL-coding-standard

Variable scope too large Note

The variable UT_TPID_CFE_TIME_CMD_SUB_ONEHZ_ADJUSTMENT_CC is only accessed in
Test_PipeCmds
Loading
and should be scoped accordingly.
modules/time/ut-coverage/time_UT.c
CFE_SB_MSGID_WRAP_VALUE(CFE_TIME_DATA_CMD_MID)};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_TIME_1HZ_CMD = {.MsgId =
CFE_SB_MSGID_WRAP_VALUE(CFE_TIME_1HZ_CMD_MID)};
static const UT_TaskPipeDispatchId_t UT_TPID_CFE_TIME_ONEHZ_CMD = {.MsgId =

Check notice

Code scanning / CodeQL-coding-standard

Variable scope too large Note

The variable UT_TPID_CFE_TIME_ONEHZ_CMD is only accessed in
Test_PipeCmds
Loading
and should be scoped accordingly.
This was referenced Dec 7, 2023
Merged
Merged
Merged
Merged
@dzbaker dzbaker added CCB:Approved Indicates code review and approval by community CCB and removed CCB:Ready Ready for discussion at the Configuration Control Board (CCB) labels Dec 7, 2023
@jphickey jphickey mentioned this pull request Dec 7, 2023
Merged
@dzbaker dzbaker mentioned this pull request Dec 12, 2023
Merged
2 tasks
dzbaker added a commit to nasa/cFS that referenced this pull request Dec 12, 2023
@dzbaker
IC: Caelum-rc4+dev66
e16440a 
*Combines:*

to_lab v2.5.0-rc4+dev75
ci_lab v2.5.0-rc4+dev81
sample_app v1.3.0-rc4+dev69
sch_lab v2.5.0-rc4+dev75
cFE v7.0.0-rc4+dev434
osal v6.0.0-rc4+dev247

**Includes:**

*to_lab*
- nasa/to_lab#176

*ci_lab*
- nasa/ci_lab#165

*sample_app*
- nasa/sample_app#220

*sch_lab*
- nasa/sch_lab#156

*cFE*
- nasa/cFE#2472
- nasa/cFE#2411
- nasa/cFE#2474

*osal*
- nasa/osal#1430

Co-authored by: Joseph Hickey <jphickey@users.noreply.github.com>
Co-authored by: Isaac Rowe <irowebbn@users.noreply.github.com>
Co-authored by: Avi Weiss <thnkslprpt@users.noreply.github.com>
@dzbaker dzbaker mentioned this pull request Dec 12, 2023
Merged
2 tasks
dzbaker added a commit to nasa/cFS that referenced this pull request Dec 12, 2023
@dzbaker
IC: Caelum-rc4+dev66
71b1cc0 
*Combines:*

to_lab v2.5.0-rc4+dev75
ci_lab v2.5.0-rc4+dev81
sample_app v1.3.0-rc4+dev69
sch_lab v2.5.0-rc4+dev75
cFE v7.0.0-rc4+dev434
osal v6.0.0-rc4+dev247

**Includes:**

*to_lab*
- nasa/to_lab#176

*ci_lab*
- nasa/ci_lab#165

*sample_app*
- nasa/sample_app#220

*sch_lab*
- nasa/sch_lab#156

*cFE*
- nasa/cFE#2472
- nasa/cFE#2411
- nasa/cFE#2474

*osal*
- nasa/osal#1430

Co-authored by: Joseph Hickey <jphickey@users.noreply.github.com>
Co-authored by: Isaac Rowe <irowebbn@users.noreply.github.com>
Co-authored by: Avi Weiss <thnkslprpt@users.noreply.github.com>
dzbaker added a commit to nasa/cFS that referenced this pull request Dec 12, 2023
@dzbaker
IC: Caelum-rc4+dev66
f46e585 
*Combines:*

to_lab v2.5.0-rc4+dev75
ci_lab v2.5.0-rc4+dev81
sample_app v1.3.0-rc4+dev69
sch_lab v2.5.0-rc4+dev75
cFE v7.0.0-rc4+dev434
osal v6.0.0-rc4+dev247

**Includes:**

*to_lab*
- nasa/to_lab#176

*ci_lab*
- nasa/ci_lab#165

*sample_app*
- nasa/sample_app#220

*sch_lab*
- nasa/sch_lab#156

*cFE*
- nasa/cFE#2472
- nasa/cFE#2411
- nasa/cFE#2474

*osal*
- nasa/osal#1430

Co-authored by: Joseph Hickey <jphickey@users.noreply.github.com>
Co-authored by: Isaac Rowe <irowebbn@users.noreply.github.com>
Co-authored by: Avi Weiss <thnkslprpt@users.noreply.github.com>
@dzbaker dzbaker merged commit 780e377 into nasa:main Dec 12, 2023
22 checks passed
dzbaker added a commit to nasa/cFS that referenced this pull request Dec 12, 2023
@dzbaker
IC: Caelum-rc4+dev66
9d3f786 
*Combines:*

to_lab v2.5.0-rc4+dev75
ci_lab v2.5.0-rc4+dev81
sample_app v1.3.0-rc4+dev69
sch_lab v2.5.0-rc4+dev75
cFE v7.0.0-rc4+dev434
osal v6.0.0-rc4+dev247

**Includes:**

*to_lab*
- nasa/to_lab#176

*ci_lab*
- nasa/ci_lab#165

*sample_app*
- nasa/sample_app#220

*sch_lab*
- nasa/sch_lab#156

*cFE*
- nasa/cFE#2472
- nasa/cFE#2411
- nasa/cFE#2474

*osal*
- nasa/osal#1430

Co-authored by: Joseph Hickey <jphickey@users.noreply.github.com>
Co-authored by: Isaac Rowe <irowebbn@users.noreply.github.com>
Co-authored by: Avi Weiss <thnkslprpt@users.noreply.github.com>
@jphickey jphickey deleted the fix-2473-topicid branch December 13, 2023 00:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@skliper skliper skliper approved these changes

Assignees
No one assigned
Labels
CCB:Approved Indicates code review and approval by community CCB
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Rename time 1HZ signal to ONEHZ Formalize and document msg number / topic id concept
3 participants
@jphickey @skliper @dzbaker