From 7c7f2bced2b6175108236301e0a6f0341b2219e9 Mon Sep 17 00:00:00 2001 From: Avi Date: Fri, 30 Sep 2022 22:33:37 +1000 Subject: [PATCH 1/4] Fix #119, Create CHANGELOG.md --- CHANGELOG.md | 124 +++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 116 ----------------------------------------------- 2 files changed, 124 insertions(+), 116 deletions(-) create mode 100644 CHANGELOG.md diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..4286c9f --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,124 @@ +# Changelog + +## Development Build: v2.5.0-rc4+dev24 +- Update cmake mimimum required to something more recent +- See + +## Development Build: v2.5.0-rc4+dev22 + +- Remove registration of empty EVS filters +- Update codeql workflow for reusable updates +- See + +## Development Build: v2.5.0-rc4+dev17 + +- Update Copyright Headers +- Standardize version.h +- See and + +## Development Build: v2.5.0-rc4+dev10 + +- Apply header guard standard +- See + +## Development Build: v2.5.0-rc4+dev4 + +- Use CFE_MSG_PTR conversion macro +- Update baseline for cFS-Caelum-rc4 to v2.5.0-rc4 +- See and + +## Development Build: v2.4.0-rc1+dev46 + +- Apply CFE_SB_ValueToMsgId where required +- See and + +## Development Build: v2.4.0-rc1+dev42 + +- Implement Coding Standard in CodeQL workflow +- See and + +## Development Build: v2.4.0-rc1+dev39 + +- Removes unnecessary call to `CFE_ES_RegisterApp()` since app registration is done automatically. +- Demonstrates the use of the Zero Copy API. Adds a step that obtains a buffer prior to calling `OS_SocketRecvFrom` then transmits that same buffer directly rather than copying it. +- See + +## Development Build: v2.4.0-rc1+dev30 + +- Use `cfe.h` instead of individual headers +- See + +## Development Build: v2.4.0-rc1+dev25 + +- Add Testing Tools to the Security Policy +- See + +## Development Build: v2.4.0-rc1+dev14 + +- Aligns messages according to changes in cFE . Uses the "raw" message cmd/tlm types in definition +- See + +## Development Build: v2.4.0-rc1+dev8 + +- Replaces deprecated SB API's with MSG +- No behavior impact, removes undesirable pattern use of `OS_PACK` +- See + +## Development Build: v2.4.0-rc1+dev2 + +- Update the SocketID field to be `osal_id_t` instead of uint32 +- Set Revision number to 99 for development version identifier in telemetry +- See + + +## Development Build: v2.3.0+dev36 + +- Add build name and build number to version reporting +- See + +## Development Build: v2.3.5 + +- Replace references to `ccsds.h` types with the `cfe_sb.h`-provided type. +- See + +## Development Build: v2.3.4 + +- Apply the CFE_SB_MsgIdToValue() and CFE_SB_ValueToMsgId() routines where compatibility with an integer MsgId is necessary - syslog prints, events, compile-time MID #define values. +- Minor changes, see + +## Development Build: v2.3.3 + +- Offset UDP base port in multi-cpu configurations +- Minor changes, see + +## Development Build: v2.3.2 + +- Use OSAL socket API instead of BSD sockets +- Remove PDU introspection code +- Update command and telemetry logic +- Collect globals as a single top-level global structure +- Minor changes, see + +## Development Build: v2.3.1 + +- Code style and enforcement (see ) + +## _**OFFICIAL RELEASE: v2.3.0 - Aquila**_ + +- Minor updates (see ) +- Not backwards compatible with OSAL 4.2.1 +- Released as part of cFE 6.7.0, Apache 2.0 + +## _**OFFICIAL RELEASE: v2.2.0a**_ + +- Released as part of cFE 6.6.0a, Apache 2.0 + +## Known issues + +Dependence on cfe platform config header is undesirable, and the check is not endian safe. As a lab application, extensive testing is not performed prior to release and only minimal functionality is included. + +## Getting Help + +For best results, submit issues:questions or issues:help wanted requests at . + +Official cFS page: diff --git a/README.md b/README.md index 9900451..a48b092 100644 --- a/README.md +++ b/README.md @@ -9,122 +9,6 @@ This lab application is a non-flight utility to send commands to the cFS Bundle. ci_lab is a simple command uplink application that accepts CCSDS telecommand packets over a UDP/IP port. It does not provide a full CCSDS Telecommand stack implementation. -## Changelog - - -### Development Build: v2.5.0-rc4+dev24 -- Update cmake mimimum required to something more recent -- See - -### Development Build: v2.5.0-rc4+dev22 - -- Remove registration of empty EVS filters -- Update codeql workflow for reusable updates -- See - -### Development Build: v2.5.0-rc4+dev17 - -- Update Copyright Headers -- Standardize version.h -- See and - -### Development Build: v2.5.0-rc4+dev10 - -- Apply header guard standard -- See - -### Development Build: v2.5.0-rc4+dev4 - -- Use CFE_MSG_PTR conversion macro -- Update baseline for cFS-Caelum-rc4 to v2.5.0-rc4 -- See and - -### Development Build: v2.4.0-rc1+dev46 - -- Apply CFE_SB_ValueToMsgId where required -- See and - -### Development Build: v2.4.0-rc1+dev42 - -- Implement Coding Standard in CodeQL workflow -- See and - -### Development Build: v2.4.0-rc1+dev39 - -- Removes unnecessary call to `CFE_ES_RegisterApp()` since app registration is done automatically. -- Demonstrates the use of the Zero Copy API. Adds a step that obtains a buffer prior to calling `OS_SocketRecvFrom` then transmits that same buffer directly rather than copying it. -- See - -### Development Build: v2.4.0-rc1+dev30 - -- Use `cfe.h` instead of individual headers -- See - -### Development Build: v2.4.0-rc1+dev25 - -- Add Testing Tools to the Security Policy -- See - -### Development Build: v2.4.0-rc1+dev14 - -- Aligns messages according to changes in cFE . Uses the "raw" message cmd/tlm types in definition -- See - -### Development Build: v2.4.0-rc1+dev8 - -- Replaces deprecated SB API's with MSG -- No behavior impact, removes undesirable pattern use of `OS_PACK` -- See - -### Development Build: v2.4.0-rc1+dev2 - -- Update the SocketID field to be `osal_id_t` instead of uint32 -- Set Revision number to 99 for development version identifier in telemetry -- See - - -### Development Build: v2.3.0+dev36 - -- Add build name and build number to version reporting -- See - -### Development Build: v2.3.5 - -- Replace references to `ccsds.h` types with the `cfe_sb.h`-provided type. -- See - -### Development Build: v2.3.4 - -- Apply the CFE_SB_MsgIdToValue() and CFE_SB_ValueToMsgId() routines where compatibility with an integer MsgId is necessary - syslog prints, events, compile-time MID #define values. -- Minor changes, see - -### Development Build: v2.3.3 - -- Offset UDP base port in multi-cpu configurations -- Minor changes, see - -### Development Build: v2.3.2 - -- Use OSAL socket API instead of BSD sockets -- Remove PDU introspection code -- Update command and telemetry logic -- Collect globals as a single top-level global structure -- Minor changes, see - -### Development Build: v2.3.1 - -- Code style and enforcement (see ) - -### _**OFFICIAL RELEASE: v2.3.0 - Aquila**_ - -- Minor updates (see ) -- Not backwards compatible with OSAL 4.2.1 -- Released as part of cFE 6.7.0, Apache 2.0 - -### _**OFFICIAL RELEASE: v2.2.0a**_ - -- Released as part of cFE 6.6.0a, Apache 2.0 - ## Known issues Dependence on cfe platform config header is undesirable, and the check is not endian safe. As a lab application, extensive testing is not performed prior to release and only minimal functionality is included. From 1365c52b0c97eedd652a01265e37a3936b0e5ae2 Mon Sep 17 00:00:00 2001 From: Avi Date: Wed, 5 Oct 2022 10:37:26 +1000 Subject: [PATCH 2/4] Fix #122, Remove redundant comments --- fsw/src/ci_lab_app.c | 43 ++++++++++++++++--------------------------- 1 file changed, 16 insertions(+), 27 deletions(-) diff --git a/fsw/src/ci_lab_app.c b/fsw/src/ci_lab_app.c index 70429f5..f4307a5 100644 --- a/fsw/src/ci_lab_app.c +++ b/fsw/src/ci_lab_app.c @@ -65,11 +65,12 @@ int32 CI_LAB_ResetCounters(const CI_LAB_ResetCountersCmd_t *data); int32 CI_LAB_ReportHousekeeping(const CFE_MSG_CommandHeader_t *data); /** * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ -/* CI_Lab_AppMain() -- Application entry point and main process loop */ +/* */ +/* Application entry point and main process loop */ /* Purpose: This is the Main task event loop for the Command Ingest Task */ /* The task handles all interfaces to the data system through */ /* the software bus. There is one pipeline into this task */ -/* The task is scheduled by input into this pipeline. */ +/* The task is scheduled by input into this pipeline. */ /* It can receive Commands over this pipeline */ /* and acts accordingly to process them. */ /* */ @@ -109,8 +110,7 @@ void CI_Lab_AppMain(void) } CFE_ES_ExitApp(RunStatus); - -} /* End of CI_Lab_AppMain() */ +} /* ** CI delete callback function. @@ -125,7 +125,7 @@ void CI_LAB_delete_callback(void) /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ /* */ -/* CI_LAB_TaskInit() -- CI initialization */ +/* CI initialization */ /* */ /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * **/ void CI_LAB_TaskInit(void) @@ -179,11 +179,9 @@ void CI_LAB_TaskInit(void) CFE_EVS_SendEvent(CI_LAB_STARTUP_INF_EID, CFE_EVS_EventType_INFORMATION, "CI Lab Initialized.%s", CI_LAB_VERSION_STRING); - -} /* End of CI_LAB_TaskInit() */ +} /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * **/ -/* Name: CI_LAB_ProcessCommandPacket */ /* */ /* Purpose: */ /* This routine will process any packet that is received on the CI command*/ @@ -218,12 +216,11 @@ void CI_LAB_ProcessCommandPacket(CFE_SB_Buffer_t *SBBufPtr) } return; - -} /* End CI_LAB_ProcessCommandPacket */ +} /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * **/ /* */ -/* CI_LAB_ProcessGroundCommand() -- CI ground commands */ +/* CI ground commands */ /* */ /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * **/ @@ -256,11 +253,9 @@ void CI_LAB_ProcessGroundCommand(CFE_SB_Buffer_t *SBBufPtr) } return; - -} /* End of CI_LAB_ProcessGroundCommand() */ +} /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ -/* Name: CI_LAB_Noop */ /* */ /* Purpose: */ /* Handle NOOP command packets */ @@ -277,7 +272,6 @@ int32 CI_LAB_Noop(const CI_LAB_NoopCmd_t *data) } /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ -/* Name: CI_LAB_ResetCounters */ /* */ /* Purpose: */ /* Handle ResetCounters command packets */ @@ -291,13 +285,13 @@ int32 CI_LAB_ResetCounters(const CI_LAB_ResetCountersCmd_t *data) } /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * **/ -/* Name: CI_LAB_ReportHousekeeping */ /* */ /* Purpose: */ /* This function is triggered in response to a task telemetry request */ /* from the housekeeping task. This function will gather the CI task */ /* telemetry, packetize it and send it to the housekeeping task via */ /* the software bus */ +/* */ /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ int32 CI_LAB_ReportHousekeeping(const CFE_MSG_CommandHeader_t *data) { @@ -305,11 +299,9 @@ int32 CI_LAB_ReportHousekeeping(const CFE_MSG_CommandHeader_t *data) CFE_SB_TimeStampMsg(CFE_MSG_PTR(CI_LAB_Global.HkTlm.TelemetryHeader)); CFE_SB_TransmitMsg(CFE_MSG_PTR(CI_LAB_Global.HkTlm.TelemetryHeader), true); return CFE_SUCCESS; - -} /* End of CI_LAB_ReportHousekeeping() */ +} /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * **/ -/* Name: CI_LAB_ResetCounters_Internal */ /* */ /* Purpose: */ /* This function resets all the global counter variables that are */ @@ -327,12 +319,11 @@ void CI_LAB_ResetCounters_Internal(void) CI_LAB_Global.HkTlm.Payload.IngestErrors = 0; return; - -} /* End of CI_LAB_ResetCounters() */ +} /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * **/ /* */ -/* CI_LAB_ReadUpLink() -- */ +/* -- */ /* */ /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * **/ void CI_LAB_ReadUpLink(void) @@ -391,12 +382,11 @@ void CI_LAB_ReadUpLink(void) } return; - -} /* End of CI_LAB_ReadUpLink() */ +} /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * **/ /* */ -/* CI_LAB_VerifyCmdLength() -- Verify command packet length */ +/* Verify command packet length */ /* */ /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * **/ bool CI_LAB_VerifyCmdLength(CFE_MSG_Message_t *MsgPtr, size_t ExpectedLength) @@ -425,5 +415,4 @@ bool CI_LAB_VerifyCmdLength(CFE_MSG_Message_t *MsgPtr, size_t ExpectedLength) } return (result); - -} /* End of CI_LAB_VerifyCmdLength() */ +} From e1604deecc4493153bf5703ab005fc492e3a3002 Mon Sep 17 00:00:00 2001 From: Avi Date: Fri, 7 Oct 2022 09:25:04 +1000 Subject: [PATCH 3/4] Added most recent build in order to resolve merge conflict --- CHANGELOG.md | 28 +++++----------------------- 1 file changed, 5 insertions(+), 23 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 4286c9f..ff68ed0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,98 +1,85 @@ # Changelog +## Development Build: v2.5.0-rc4+dev30 +- Remove unnecessary parentheses around return values. +- Remove 'return;' from last line of void functions. +- See and + ## Development Build: v2.5.0-rc4+dev24 - Update cmake mimimum required to something more recent - See ## Development Build: v2.5.0-rc4+dev22 - - Remove registration of empty EVS filters - Update codeql workflow for reusable updates - See ## Development Build: v2.5.0-rc4+dev17 - - Update Copyright Headers - Standardize version.h - See and ## Development Build: v2.5.0-rc4+dev10 - - Apply header guard standard - See ## Development Build: v2.5.0-rc4+dev4 - - Use CFE_MSG_PTR conversion macro - Update baseline for cFS-Caelum-rc4 to v2.5.0-rc4 - See and ## Development Build: v2.4.0-rc1+dev46 - - Apply CFE_SB_ValueToMsgId where required - See and ## Development Build: v2.4.0-rc1+dev42 - - Implement Coding Standard in CodeQL workflow - See and ## Development Build: v2.4.0-rc1+dev39 - - Removes unnecessary call to `CFE_ES_RegisterApp()` since app registration is done automatically. - Demonstrates the use of the Zero Copy API. Adds a step that obtains a buffer prior to calling `OS_SocketRecvFrom` then transmits that same buffer directly rather than copying it. - See ## Development Build: v2.4.0-rc1+dev30 - - Use `cfe.h` instead of individual headers - See ## Development Build: v2.4.0-rc1+dev25 - - Add Testing Tools to the Security Policy - See ## Development Build: v2.4.0-rc1+dev14 - - Aligns messages according to changes in cFE . Uses the "raw" message cmd/tlm types in definition - See ## Development Build: v2.4.0-rc1+dev8 - - Replaces deprecated SB API's with MSG - No behavior impact, removes undesirable pattern use of `OS_PACK` - See ## Development Build: v2.4.0-rc1+dev2 - - Update the SocketID field to be `osal_id_t` instead of uint32 - Set Revision number to 99 for development version identifier in telemetry - See - ## Development Build: v2.3.0+dev36 - - Add build name and build number to version reporting - See ## Development Build: v2.3.5 - - Replace references to `ccsds.h` types with the `cfe_sb.h`-provided type. - See ## Development Build: v2.3.4 - - Apply the CFE_SB_MsgIdToValue() and CFE_SB_ValueToMsgId() routines where compatibility with an integer MsgId is necessary - syslog prints, events, compile-time MID #define values. - Minor changes, see ## Development Build: v2.3.3 - - Offset UDP base port in multi-cpu configurations - Minor changes, see ## Development Build: v2.3.2 - - Use OSAL socket API instead of BSD sockets - Remove PDU introspection code - Update command and telemetry logic @@ -100,25 +87,20 @@ - Minor changes, see ## Development Build: v2.3.1 - - Code style and enforcement (see ) ## _**OFFICIAL RELEASE: v2.3.0 - Aquila**_ - - Minor updates (see ) - Not backwards compatible with OSAL 4.2.1 - Released as part of cFE 6.7.0, Apache 2.0 ## _**OFFICIAL RELEASE: v2.2.0a**_ - - Released as part of cFE 6.6.0a, Apache 2.0 ## Known issues - Dependence on cfe platform config header is undesirable, and the check is not endian safe. As a lab application, extensive testing is not performed prior to release and only minimal functionality is included. ## Getting Help - For best results, submit issues:questions or issues:help wanted requests at . Official cFS page: From dbfd67e1e9d08aab7617981123eb3d682f1b3071 Mon Sep 17 00:00:00 2001 From: Dylan Date: Tue, 11 Oct 2022 15:58:51 -0400 Subject: [PATCH 4/4] Bump to v2.5.0-rc4+dev39 --- CHANGELOG.md | 5 +++++ fsw/src/ci_lab_version.h | 2 +- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index ff68ed0..c419cc2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,10 @@ # Changelog +## Development Build: v2.5.0-rc4+dev39 +- Remove redundant comments +- Create CHANGELOG.md +- See and + ## Development Build: v2.5.0-rc4+dev30 - Remove unnecessary parentheses around return values. - Remove 'return;' from last line of void functions. diff --git a/fsw/src/ci_lab_version.h b/fsw/src/ci_lab_version.h index 163a6a4..f60bea1 100644 --- a/fsw/src/ci_lab_version.h +++ b/fsw/src/ci_lab_version.h @@ -25,7 +25,7 @@ /* Development Build Macro Definitions */ -#define CI_LAB_BUILD_NUMBER 30 /*!< Development Build: Number of commits since baseline */ +#define CI_LAB_BUILD_NUMBER 39 /*!< Development Build: Number of commits since baseline */ #define CI_LAB_BUILD_BASELINE \ "v2.5.0-rc4" /*!< Development Build: git tag that is the base for the current development */