Merge pull request #2232 from nasa/integration-candidate

cFE Integration candidate: Caelum-rc4+dev33
nasa · Dec 20, 2022 · f6432f5 · f6432f5
2 parents 9f89010 + bb60c19
commit f6432f5
Show file tree

Hide file tree

Showing 36 changed files with 847 additions and 457 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## Development Build: v7.0.0-rc4+dev242
+- EDS Updates to match the current mainline
+- Update UTs to use correct cmd types
+- Move CRC types and convert to enum
+- See <https://github.com/nasa/cFE/pull/2231>, <https://github.com/nasa/cFE/pull/2229>, and <https://github.com/nasa/cFE/pull/2192>
+
 ## Development Build: v7.0.0-rc4+dev233
 - Replace CFE_MSG_CommandHeader_t w/ CFE_TBL_NoArgsCmd_t
 - See <https://github.com/nasa/cFE/pull/2226>

diff --git a/cmake/sample_defs/sample_mission_cfg.h b/cmake/sample_defs/sample_mission_cfg.h
@@ -258,14 +258,16 @@
 */
 #define CFE_MISSION_EVS_MAX_MESSAGE_LENGTH 122
 
+#ifndef CFE_OMIT_DEPRECATED_6_8
+/* These names have been converted to an enum in cfe_es_api_typedefs.h */
+
 /** \name Checksum/CRC algorithm identifiers */
-/** \{ */
-#define CFE_MISSION_ES_CRC_8  1 /**< \brief CRC ( 8 bit additive - returns 32 bit total) (Currently not implemented) */
-#define CFE_MISSION_ES_CRC_16 2 /**< \brief CRC (16 bit additive - returns 32 bit total) */
-#define CFE_MISSION_ES_CRC_32                                                              \
-    3 /**< \brief CRC (32 bit additive - returns 32 bit total) (Currently not implemented) \
-       */
-/** \} */
+
+#define CFE_MISSION_ES_CRC_8  CFE_ES_CrcType_CRC_8  /* 1 */
+#define CFE_MISSION_ES_CRC_16 CFE_ES_CrcType_CRC_16 /* 2 */
+#define CFE_MISSION_ES_CRC_32 CFE_ES_CrcType_CRC_32 /* 3 */
+
+#endif
 
 /**
 **  \cfeescfg Mission Default CRC algorithm
@@ -276,9 +278,10 @@
 **      Table Image data integrity values.
 **
 **  \par Limits
-**      Currently only CFE_MISSION_ES_CRC_16 is supported (see #CFE_MISSION_ES_CRC_16)
+**      Currently only CFE_ES_CrcType_CRC_16 is supported (see brief in CFE_ES_CrcType_Enum
+**      definition in cfe_es_api_typedefs.h)
 */
-#define CFE_MISSION_ES_DEFAULT_CRC CFE_MISSION_ES_CRC_16
+#define CFE_MISSION_ES_DEFAULT_CRC CFE_ES_CrcType_CRC_16
 
 /**
 **  \cfetblcfg Maximum Table Name Length

diff --git a/docs/cFE Application Developers Guide.md b/docs/cFE Application Developers Guide.md
@@ -1293,24 +1293,28 @@ an API for a CRC calculation that can be used by all Applications on a mission.
 This function looks like the following:
 
 ```c
-uint32 CFE_ES_CalculateCRC(void *pData, uint32 DataLength, uint32 InputCRC, uint32 TypeCRC);
+uint32 CFE_ES_CalculateCRC(const void *DataPtr, size_t DataLength, uint32 InputCRC, CFE_ES_CrcType_Enum_t TypeCRC);
 ```
 
-where pData points to the first byte of an array of bytes that are to have
+where DataPtr points to the first byte of an array of bytes that are to have
 the CRC calculated on, DataLength specifies the number of sequential bytes to
 include in the calculation, InputCRC is the initial value of the CRC and
 TypeCRC identifies which of the standard CRC polynomials to be used.  Currently,
 there are the following types available:
 
 ```
-CFE_MISSION_ES_CRC_8 – an 8-bit additive checksum calculation that returns a 32-bit value
-CFE_MISSION_ES_CRC_16 – a 16-bit additive checksum calculation that returns a 32-bit value
-CFE_MISSION_ES_CRC_32 – a 32-bit additive checksum calculation that returns a 32-bit value
-CFE_MISSION_ES_DEFAULT_CRC – the mission specified default CRC calculation
+CFE_ES_CrcType_CRC_8 – an 8-bit additive checksum calculation that returns a 32-bit value
+CFE_ES_CrcType_CRC_16 – a 16-bit additive checksum calculation that returns a 32-bit value
+CFE_ES_CrcType_CRC_32 – a 32-bit additive checksum calculation that returns a 32-bit value
+CFE_MISSION_ES_DEFAULT_CRC – the mission specified default CRC calculation (currently
+                             this is set to CFE_ES_CrcType_CRC_16 in sample_mission_cfg.h)
 ```
 
-Unless there is a specific interface with a specified CRC calculation,
-Applications must use the CFE_MISSION_ES_DEFAULT_CRC type.
+Unless there is a specific interface with a specified CRC calculation, applications
+must use the CFE_MISSION_ES_DEFAULT_CRC type.
+
+Currently only CFE_ES_CrcType_CRC_16 is supported. CFE_ES_CrcType_CRC_8 and CFE_ES_CrcType_CRC_32 are yet
+to be implemented.
 
 ## 5.11 File System Functions
 

diff --git a/modules/cfe_testcase/eds/cfe_testcase.xml b/modules/cfe_testcase/eds/cfe_testcase.xml
@@ -0,0 +1,85 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+    GSC-18128-1, "Core Flight Executive Version 6.7"
+    LEW-19710-1, "CCSDS electronic data sheet implementation"
+
+    Copyright (c) 2006-2019 United States Government as represented by
+    the Administrator of the National Aeronautics and Space Administration.
+    All Rights Reserved.
+
+    Licensed under the Apache License, Version 2.0 (the "License");
+    you may not use this file except in compliance with the License.
+    You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.
+
+    This document adheres to the Electronic Data Sheet (EDS) XML schema
+    as prescribed in CCSDS book 876.0.
+
+    Purpose:
+      This describes all interface objects for the Executive Services (CFE_ES)
+      core application
+
+-->
+<PackageFile xmlns="http://www.ccsds.org/schema/sois/seds">
+  <Package name="CFE_TEST" shortDescription="CFE Functional Test (FT) Application Package">
+
+    <DataTypeSet>
+
+      <ContainerDataType name="TestTable" shortDescription="Example Table Definition">
+        <EntryList>
+          <Entry name="Int1" type="BASE_TYPES/uint16" shortDescription="Example integer 1" />
+          <Entry name="Int2" type="BASE_TYPES/uint16" shortDescription="Example integer 2" />
+        </EntryList>
+      </ContainerDataType>
+
+      <ContainerDataType name="TestCmd" baseType="CFE_HDR/CommandHeader" shortDescription="Test command message">
+        <EntryList>
+          <Entry name="CmdPayload" type="BASE_TYPES/uint64" shortDescription="Example Payload" />
+        </EntryList>
+      </ContainerDataType>
+
+      <ContainerDataType name="TestTlm" baseType="CFE_HDR/TelemetryHeader" shortDescription="Test housekeeping message">
+        <EntryList>
+          <Entry name="TlmPayload" type="BASE_TYPES/uint64" shortDescription="Example Payload" />
+        </EntryList>
+      </ContainerDataType>
+
+    </DataTypeSet>
+
+    <ComponentSet>
+      <Component name="Application">
+        <RequiredInterfaceSet>
+          <Interface name="CMD" shortDescription="Software bus telecommand interface" type="CFE_SB/Telecommand">
+            <GenericTypeMapSet>
+              <GenericTypeMap name="TelecommandDataType" type="TestCmd" />
+            </GenericTypeMapSet>
+          </Interface>
+          <Interface name="HK_TLM" shortDescription="Software bus housekeeping telemetry interface" type="CFE_SB/Telemetry">
+            <GenericTypeMapSet>
+              <GenericTypeMap name="TelemetryDataType" type="TestTlm" />
+            </GenericTypeMapSet>
+          </Interface>
+        </RequiredInterfaceSet>
+        <Implementation>
+          <VariableSet>
+            <Variable type="BASE_TYPES/uint16" readOnly="true" name="CmdTopicId" initialValue="${CFE_MISSION/TEST_CMD_TOPICID}" />
+            <Variable type="BASE_TYPES/uint16" readOnly="true" name="TlmTopicId" initialValue="${CFE_MISSION/TEST_HK_TLM_TOPICID}" />
+          </VariableSet>
+          <ParameterMapSet>
+            <ParameterMap interface="CMD" parameter="TopicId" variableRef="CmdTopicId" />
+            <ParameterMap interface="HK_TLM" parameter="TopicId" variableRef="TlmTopicId" />
+          </ParameterMapSet>
+        </Implementation>
+      </Component>
+    </ComponentSet>
+
+  </Package>
+</PackageFile>
diff --git a/modules/cfe_testcase/src/es_misc_test.c b/modules/cfe_testcase/src/es_misc_test.c
@@ -41,19 +41,19 @@ void TestCalculateCRC(void)
     UtAssert_VOIDCALL(Result = CFE_ES_CalculateCRC(Data, sizeof(Data), 0, CFE_MISSION_ES_DEFAULT_CRC));
     UtAssert_MIR("Confirm mission default CRC of \"%s\" is %lu", Data, (unsigned long)Result);
 
-    UtAssert_VOIDCALL(Result = CFE_ES_CalculateCRC(Data, sizeof(Data), inputCrc, CFE_MISSION_ES_CRC_16));
+    UtAssert_VOIDCALL(Result = CFE_ES_CalculateCRC(Data, sizeof(Data), inputCrc, CFE_ES_CrcType_CRC_16));
     UtAssert_MIR("Confirm CRC16 of \"%s\" with input CRC of %lu is %lu", Data, (unsigned long)inputCrc,
                  (unsigned long)Result);
 
-    UtAssert_VOIDCALL(Result = CFE_ES_CalculateCRC(Data, sizeof(Data), 0, CFE_MISSION_ES_CRC_8));
+    UtAssert_VOIDCALL(Result = CFE_ES_CalculateCRC(Data, sizeof(Data), 0, CFE_ES_CrcType_CRC_8));
     UtAssert_MIR("Confirm CRC8 of \"%s\" is %lu", Data, (unsigned long)Result);
 
-    UtAssert_VOIDCALL(Result = CFE_ES_CalculateCRC(Data, sizeof(Data), 0, CFE_MISSION_ES_CRC_32));
+    UtAssert_VOIDCALL(Result = CFE_ES_CalculateCRC(Data, sizeof(Data), 0, CFE_ES_CrcType_CRC_32));
     UtAssert_MIR("Confirm CRC32 of \"%s\" is %lu", Data, (unsigned long)Result);
 
     /* NULL input or 0 size returns input crc */
-    UtAssert_UINT32_EQ(CFE_ES_CalculateCRC(NULL, sizeof(Data), inputCrc, CFE_MISSION_ES_CRC_16), inputCrc);
-    UtAssert_UINT32_EQ(CFE_ES_CalculateCRC(Data, 0, inputCrc, CFE_MISSION_ES_CRC_16), inputCrc);
+    UtAssert_UINT32_EQ(CFE_ES_CalculateCRC(NULL, sizeof(Data), inputCrc, CFE_ES_CrcType_CRC_16), inputCrc);
+    UtAssert_UINT32_EQ(CFE_ES_CalculateCRC(Data, 0, inputCrc, CFE_ES_CrcType_CRC_16), inputCrc);
 }
 
 void TestWriteToSysLog(void)

diff --git a/modules/core_api/eds/base_types.xml b/modules/core_api/eds/base_types.xml
@@ -102,44 +102,6 @@
       <StringDataType name="ApiName" length="${CFE_MISSION/MAX_API_LEN}" />
       <StringDataType name="PathName" length="${CFE_MISSION/MAX_PATH_LEN}" />
 
-      <!--
-        CPU memory addresses in messages can be either 32 or 64 bits.
-        This depends on specific CPUs in use, but it should be consistent
-        across all cpus.
-       -->
-      <IntegerDataType name="CpuAddress" shortDescription="CPU memory address">
-        <IntegerDataEncoding sizeInBits="${CFE_MISSION/MAX_CPU_ADDRESS_SIZE} * 8" encoding="unsigned" byteOrder="${CFE_MISSION/DATA_BYTE_ORDER}" />
-        <Range>
-          <MinMaxRange max="2 ^ (8 * ${CFE_MISSION/MAX_CPU_ADDRESS_SIZE})" min="0" rangeType="inclusiveMinExclusiveMax"/>
-        </Range>
-      </IntegerDataType>
-
-      <!--
-        The following data types are a test/example of how 20-bit microseconds
-        can be used in outgoing telemetry packets.  It defines a container with
-        a 20 bit "Micros" field followed by 12 bits of padding to create 32 bits.
-        If this is desired then two configuration parameters need to change:
-         - Set the 'TELEMETRY_SUBSECONDS_TYPE' EDS directive
-         - Set the 'CFE_SB_PACKET_TIME_SUBSECONDS_UNITS' config directive
-        And uncomment these types...
-
-
-      <IntegerDataType name="MicrosecondsValue">
-        <IntegerDataEncoding sizeInBits="20" encoding="unsigned" />
-      </IntegerDataType>
-      <IntegerDataType name="MicrosecondsPad">
-        <IntegerDataEncoding sizeInBits="12" encoding="unsigned" />
-      </IntegerDataType>
-
-      <ContainerDataType name="TlmMicrosecs">
-        <EntryList>
-            <Entry name="Micros" type="MicrosecondsValue" />
-            <Entry name="Pad" type="MicrosecondsPad" />
-        </EntryList>
-      </ContainerDataType>
-
-      -->
-
    </DataTypeSet>
 
 </Package>

diff --git a/modules/core_api/fsw/inc/cfe_es.h b/modules/core_api/fsw/inc/cfe_es.h
@@ -999,20 +999,20 @@ CFE_Status_t CFE_ES_WriteToSysLog(const char *SpecStringPtr, ...) OS_PRINTF(1, 2
 **                          a single value.  Nominally, the user should set this value to zero.
 **
 ** \param[in]   TypeCRC     One of the following CRC algorithm selections:
-**                          \arg \c CFE_MISSION_ES_CRC_8 -  (Not currently implemented)
-**                          \arg \c CFE_MISSION_ES_CRC_16 - CRC-16/ARC <BR>
+**                          \arg \c CFE_ES_CrcType_CRC_8 -  (Not currently implemented)
+**                          \arg \c CFE_ES_CrcType_CRC_16 - CRC-16/ARC <BR>
 **                                  Polynomial: 0x8005 <BR>
 **                                  Initialization: 0x0000 <BR>
 **                                  Reflect Input/Output: true <BR>
 **                                  XorOut: 0x0000
-**                          \arg \c CFE_MISSION_ES_CRC_32 - (not currently implemented)
+**                          \arg \c CFE_ES_CrcType_CRC_32 - (not currently implemented)
 **
 ** \return The result of the CRC calculation on the specified memory block.
 **         If the TypeCRC is unimplemented will return 0.
 **         If DataPtr is null or DataLength is 0, will return InputCRC
 **
 ******************************************************************************/
-uint32 CFE_ES_CalculateCRC(const void *DataPtr, size_t DataLength, uint32 InputCRC, uint32 TypeCRC);
+uint32 CFE_ES_CalculateCRC(const void *DataPtr, size_t DataLength, uint32 InputCRC, CFE_ES_CrcType_Enum_t TypeCRC);
 
 /*****************************************************************************/
 /**

diff --git a/modules/core_api/fsw/inc/cfe_es_api_typedefs.h b/modules/core_api/fsw/inc/cfe_es_api_typedefs.h
@@ -83,6 +83,18 @@ typedef CFE_ES_TaskEntryFuncPtr_t CFE_ES_ChildTaskMainFuncPtr_t;
  */
 typedef void *CFE_ES_StackPointer_t; /* aka osal_stackptr_t in proposed OSAL change */
 
+/**
+ * \brief Checksum/CRC algorithm identifiers
+ *
+ * Currently only CFE_ES_CrcType_CRC_16 is supported.
+ */
+typedef enum CFE_ES_CrcType_Enum
+{
+    CFE_ES_CrcType_CRC_8  = 1, /**< \brief CRC ( 8 bit additive - returns 32 bit total) (Not currently implemented) */
+    CFE_ES_CrcType_CRC_16 = 2, /**< \brief CRC (16 bit additive - returns 32 bit total) */
+    CFE_ES_CrcType_CRC_32 = 3  /**< \brief CRC (32 bit additive - returns 32 bit total) (Not currently implemented) */
+} CFE_ES_CrcType_Enum_t;
+
 /**
  * \brief Pool Alignment
  *

diff --git a/modules/core_api/fsw/inc/cfe_version.h b/modules/core_api/fsw/inc/cfe_version.h
@@ -26,7 +26,7 @@
 #define CFE_VERSION_H
 
 /* Development Build Macro Definitions */
-#define CFE_BUILD_NUMBER   233 /**< @brief Development: Number of development git commits since CFE_BUILD_BASELINE */
+#define CFE_BUILD_NUMBER   242 /**< @brief Development: Number of development git commits since CFE_BUILD_BASELINE */
 #define CFE_BUILD_BASELINE "v7.0.0-rc4" /**< @brief Development: Reference git tag for build number */
 
 /* See \ref cfsversions for definitions */

diff --git a/modules/core_api/ut-stubs/src/cfe_es_stubs.c b/modules/core_api/ut-stubs/src/cfe_es_stubs.c
@@ -77,14 +77,14 @@ void CFE_ES_BackgroundWakeup(void)
  * Generated stub function for CFE_ES_CalculateCRC()
  * ----------------------------------------------------
  */
-uint32 CFE_ES_CalculateCRC(const void *DataPtr, size_t DataLength, uint32 InputCRC, uint32 TypeCRC)
+uint32 CFE_ES_CalculateCRC(const void *DataPtr, size_t DataLength, uint32 InputCRC, CFE_ES_CrcType_Enum_t TypeCRC)
 {
     UT_GenStub_SetupReturnBuffer(CFE_ES_CalculateCRC, uint32);
 
     UT_GenStub_AddParam(CFE_ES_CalculateCRC, const void *, DataPtr);
     UT_GenStub_AddParam(CFE_ES_CalculateCRC, size_t, DataLength);
     UT_GenStub_AddParam(CFE_ES_CalculateCRC, uint32, InputCRC);
-    UT_GenStub_AddParam(CFE_ES_CalculateCRC, uint32, TypeCRC);
+    UT_GenStub_AddParam(CFE_ES_CalculateCRC, CFE_ES_CrcType_Enum_t, TypeCRC);
 
     UT_GenStub_Execute(CFE_ES_CalculateCRC, Basic, NULL);