Merge pull request #124 from nasa/integration-candidate

ci_lab Integration candidate: Caelum-rc4+dev25
nasa · Oct 11, 2022 · a5e8b4b · a5e8b4b
2 parents 0ea953f + dbfd67e
commit a5e8b4b
Show file tree

Hide file tree

Showing 4 changed files with 128 additions and 144 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,111 @@
+# Changelog
+
+## Development Build: v2.5.0-rc4+dev39
+- Remove redundant comments
+- Create CHANGELOG.md
+- See <https://github.com/nasa/ci_lab/pull/123> and <https://github.com/nasa/ci_lab/pull/120>
+
+## Development Build: v2.5.0-rc4+dev30
+- Remove unnecessary parentheses around return values.
+- Remove 'return;' from last line of void functions.
+- See <https://github.com/nasa/ci_lab/pull/116> and <https://github.com/nasa/ci_lab/pull/118>
+
+## Development Build: v2.5.0-rc4+dev24
+- Update cmake mimimum required to something more recent
+- See <https://github.com/nasa/ci_lab/pull/113>
+
+## Development Build: v2.5.0-rc4+dev22
+- Remove registration of empty EVS filters
+- Update codeql workflow for reusable updates
+- See <https://github.com/nasa/cFS/pull/505> 
+
+## Development Build: v2.5.0-rc4+dev17
+- Update Copyright Headers
+- Standardize version.h 
+- See <https://github.com/nasa/ci_lab/pull/107> and <https://github.com/nasa/cFS/445>
+
+## Development Build: v2.5.0-rc4+dev10
+- Apply header guard standard
+- See <https://github.com/nasa/cFS/pull/432>
+
+## 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 <https://github.com/nasa/ci_lab/pull/101> and <https://github.com/nasa/cFS/pull/390>
+
+## Development Build: v2.4.0-rc1+dev46
+- Apply CFE_SB_ValueToMsgId where required
+- See <https://github.com/nasa/ci_lab/pull/93> and <https://github.com/nasa/cFS/pull/359>
+
+## Development Build: v2.4.0-rc1+dev42
+- Implement Coding Standard in CodeQL workflow
+- See <https://github.com/nasa/ci_lab/pull/88> and <https://github.com/nasa/cFS/pull/270>
+
+## 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 <https://github.com/nasa/ci_lab/pull/85>
+
+## Development Build: v2.4.0-rc1+dev30
+- Use `cfe.h` instead of individual headers
+- See <https://github.com/nasa/ci_lab/pull/78>
+
+## Development Build: v2.4.0-rc1+dev25
+- Add Testing Tools to the Security Policy
+- See <https://github.com/nasa/ci_lab/pull/76>
+
+## Development Build: v2.4.0-rc1+dev14
+- Aligns messages according to changes in cFE <https://github.com/nasa/cFE/issues/1009>. Uses the "raw" message cmd/tlm types in definition
+- See <https://github.com/nasa/ci_lab/pull/65>
+
+## 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 <https://github.com/nasa/ci_lab/pull/60>
+
+## 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 <https://github.com/nasa/ci_lab/pull/56>
+
+## Development Build: v2.3.0+dev36
+- Add build name and build number to version reporting
+- See <https://github.com/nasa/ci_lab/pull/53>
+
+## Development Build: v2.3.5
+- Replace references to `ccsds.h` types with the `cfe_sb.h`-provided type.
+- See <https://github.com/nasa/ci_lab/pull/50>
+
+## 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 <https://github.com/nasa/ci_lab/pull/47>
+
+## Development Build: v2.3.3
+- Offset UDP base port in multi-cpu configurations
+- Minor changes, see <https://github.com/nasa/ci_lab/pull/44>
+
+## 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 <https://github.com/nasa/ci_lab/pull/38>
+
+## Development Build: v2.3.1
+- Code style and enforcement (see <https://github.com/nasa/ci_lab/pull/31>)
+
+## _**OFFICIAL RELEASE: v2.3.0 - Aquila**_
+- Minor updates (see <https://github.com/nasa/ci_lab/pull/12>)
+- 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 <https://github.com/nasa/cFS>.
+
+Official cFS page: <http://cfs.gsfc.nasa.gov>
diff --git a/README.md b/README.md
@@ -9,126 +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+dev30
-- Remove unnecessary parentheses around return values.
-- Remove 'return;' from last line of void functions.
-- See <https://github.com/nasa/ci_lab/pull/116> and <https://github.com/nasa/ci_lab/pull/118>
-
-### Development Build: v2.5.0-rc4+dev24
-- Update cmake mimimum required to something more recent
-- See <https://github.com/nasa/ci_lab/pull/113>
-
-### Development Build: v2.5.0-rc4+dev22
-
-- Remove registration of empty EVS filters
-- Update codeql workflow for reusable updates
-- See <https://github.com/nasa/cFS/pull/505> 
-
-### Development Build: v2.5.0-rc4+dev17
-
-- Update Copyright Headers
-- Standardize version.h 
-- See <https://github.com/nasa/ci_lab/pull/107> and <https://github.com/nasa/cFS/445>
-
-### Development Build: v2.5.0-rc4+dev10
-
-- Apply header guard standard
-- See <https://github.com/nasa/cFS/pull/432>
-
-### 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 <https://github.com/nasa/ci_lab/pull/101> and <https://github.com/nasa/cFS/pull/390>
-
-### Development Build: v2.4.0-rc1+dev46
-
-- Apply CFE_SB_ValueToMsgId where required
-- See <https://github.com/nasa/ci_lab/pull/93> and <https://github.com/nasa/cFS/pull/359>
-
-### Development Build: v2.4.0-rc1+dev42
-
-- Implement Coding Standard in CodeQL workflow
-- See <https://github.com/nasa/ci_lab/pull/88> and <https://github.com/nasa/cFS/pull/270>
-
-### 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 <https://github.com/nasa/ci_lab/pull/85>
-
-### Development Build: v2.4.0-rc1+dev30
-
-- Use `cfe.h` instead of individual headers
-- See <https://github.com/nasa/ci_lab/pull/78>
-
-### Development Build: v2.4.0-rc1+dev25
-
-- Add Testing Tools to the Security Policy
-- See <https://github.com/nasa/ci_lab/pull/76>
-
-### Development Build: v2.4.0-rc1+dev14
-
-- Aligns messages according to changes in cFE <https://github.com/nasa/cFE/issues/1009>. Uses the "raw" message cmd/tlm types in definition
-- See <https://github.com/nasa/ci_lab/pull/65>
-
-### 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 <https://github.com/nasa/ci_lab/pull/60>
-
-### 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 <https://github.com/nasa/ci_lab/pull/56>
-
-
-### Development Build: v2.3.0+dev36
-
-- Add build name and build number to version reporting
-- See <https://github.com/nasa/ci_lab/pull/53>
-
-### Development Build: v2.3.5
-
-- Replace references to `ccsds.h` types with the `cfe_sb.h`-provided type.
-- See <https://github.com/nasa/ci_lab/pull/50>
-
-### 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 <https://github.com/nasa/ci_lab/pull/47>
-
-### Development Build: v2.3.3
-
-- Offset UDP base port in multi-cpu configurations
-- Minor changes, see <https://github.com/nasa/ci_lab/pull/44>
-
-### 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 <https://github.com/nasa/ci_lab/pull/38>
-
-### Development Build: v2.3.1
-
-- Code style and enforcement (see <https://github.com/nasa/ci_lab/pull/31>)
-
-### _**OFFICIAL RELEASE: v2.3.0 - Aquila**_
-
-- Minor updates (see <https://github.com/nasa/ci_lab/pull/12>)
-- 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.

diff --git 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*/
@@ -216,11 +214,11 @@ void CI_LAB_ProcessCommandPacket(CFE_SB_Buffer_t *SBBufPtr)
                               (unsigned int)CFE_SB_MsgIdToValue(MsgId));
             break;
     }
-} /* End CI_LAB_ProcessCommandPacket */
+}
 
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * **/
 /*                                                                            */
-/* CI_LAB_ProcessGroundCommand() -- CI ground commands                        */
+/* CI ground commands                                                         */
 /*                                                                            */
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * **/
 
@@ -251,10 +249,9 @@ void CI_LAB_ProcessGroundCommand(CFE_SB_Buffer_t *SBBufPtr)
         default:
             break;
     }
-} /* End of CI_LAB_ProcessGroundCommand() */
+}
 
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
-/*  Name:  CI_LAB_Noop                                                         */
 /*                                                                             */
 /*  Purpose:                                                                   */
 /*     Handle NOOP command packets                                             */
@@ -271,7 +268,6 @@ int32 CI_LAB_Noop(const CI_LAB_NoopCmd_t *data)
 }
 
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
-/*  Name:  CI_LAB_ResetCounters                                                */
 /*                                                                             */
 /*  Purpose:                                                                   */
 /*     Handle ResetCounters command packets                                    */
@@ -285,25 +281,23 @@ 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)
 {
     CI_LAB_Global.HkTlm.Payload.SocketConnected = CI_LAB_Global.SocketConnected;
     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     */
@@ -319,11 +313,11 @@ void CI_LAB_ResetCounters_Internal(void)
     /* Status of packets ingested by CI task */
     CI_LAB_Global.HkTlm.Payload.IngestPackets = 0;
     CI_LAB_Global.HkTlm.Payload.IngestErrors  = 0;
-} /* End of CI_LAB_ResetCounters() */
+}
 
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * **/
 /*                                                                            */
-/* CI_LAB_ReadUpLink() --                                                     */
+/* --                                                                         */
 /*                                                                            */
 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * **/
 void CI_LAB_ReadUpLink(void)
@@ -380,11 +374,11 @@ void CI_LAB_ReadUpLink(void)
             break; /* no (more) messages */
         }
     }
-} /* 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)
@@ -413,5 +407,4 @@ bool CI_LAB_VerifyCmdLength(CFE_MSG_Message_t *MsgPtr, size_t ExpectedLength)
     }
 
     return result;
-
-} /* End of CI_LAB_VerifyCmdLength() */
+}
diff --git 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 */