Restructure core subtopologies and add Svc_Subtopologies target (#3904)

* Modify Com/Ccsds/Fprime ComDriverConfig & TopologyDefs for easier ComDriver config

* Fix BaseID collision

* Removed restrict platform, UART/TCP driver configs different files, CMake switch depending on FPRIME_HAS_SOCKETS

* Add Exclude_FROM_ALL to all subtopology cmake modules

* remove exclude from ComCcsds (needed for Ref)

* Remove exclude from all for testing

* Exclude_from_all only on comLoggerTee, comFprime (not used in Ref)

* Added Svc_Subtopologies target

* Use add_custom_target, spelling fix

* Add Configs to Svc_Subtopologies target

* Removed comDriver as instance within subtopologies, now within project topology

* Take out cmdSeq from ComSubtopologies, put in FileHandling

* Added Subtopology States for all, common pattern users can follow

* Fix Extra newline

* Moved Phased comDriver code into RefTopology.cpp

* Update metadata

check-spelling run (pull_request_target) for subtopology-config-phasing-updates

Signed-off-by: check-spelling-bot <[email protected]>
on-behalf-of: @check-spelling <[email protected]>

* Fixed call to default stack size

* Moved cmdSeq from FileHandling subtopology to Ref Root Topology

* Fix integration test

* Remove unneeded Os includes in RefTopology.cpp

* Fix BaseIds

* Add comment for BaseIDs, comDriver configuration order fix

* Restructure of enums within Com Subtopologies

* Correct include for ComCcsds enum headers

* Using namespace syntax change

* Fix BaseIds

* Update metadata

check-spelling run (pull_request_target) for subtopology-config-phasing-updates

Signed-off-by: check-spelling-bot <[email protected]>
on-behalf-of: @check-spelling <[email protected]>

* Remove unneeded Dependency

* Add enum at the top

* Fix RefTopology.cpp

* Update Comment

---------

Signed-off-by: check-spelling-bot <[email protected]>
Co-authored-by: Moises Mata <[email protected]>

Author: moisesmata

.github/actions/spelling/expect.txt

@@ -14,7 +14,6 @@ ANamespace
 apid
 APIDOCS
 APPENDFILE
-aps
 arduino
 ARef
 argcomplete
@@ -65,6 +64,7 @@ ccsds
 ccsparc
 cdh
 CDHCORE
+CDHCORESUBTOPOLOGY
 cerrno
 CFDP
 cff
@@ -122,7 +122,6 @@ crckermit
 CRCs
 crcstat
 CREATEDIRECTORY
-Crosscompiling
 crsmith
 crt
 CRTSCTS
@@ -132,6 +131,7 @@ ctest
 ctu
 culates
 cuz
+Cxxx
 CYCLEOUT
 DATAPRODUCTS
 DATAPRODUCTSSUBTOPOLOGY
@@ -178,6 +178,7 @@ DRAINBUFFERS
 drv
 drvtcpserversocket
 dspal
+DSSC
 Dstate
 DVI
 DWN
@@ -256,8 +257,6 @@ gcgandhi
 gcov
 gdiplus
 GENHUB
-getfooter
-getstatements
 gettime
 getty
 ghprb
@@ -400,7 +399,6 @@ mman
 MMAPALLOCATOR
 MML
 modbus
-MOSI
 MOVEFILE
 msc
 mscfile
@@ -496,7 +494,6 @@ PRMDBIMPL
 PRMDBIMPLTESTERCFG
 PRMDBLIMPLCFG
 PRMDBTESTER
-PRMLEDINITSTATE
 PROCBUFFERSENDOUT
 PRODUCTGETIN
 PRODUCTREQUESTIN
@@ -551,10 +548,7 @@ RHH
 Rizvi
 ROOTDIR
 rpi
-RPIDEMO
-RPIDEMOCOMPONENTIMPLCFG
 rptr
-RXD
 SAlias
 sanitizers
 sats
@@ -586,7 +580,6 @@ SHAREDSTATEDIR
 SHELLCOMMAND
 showinitializer
 sideeffect
-sighandler
 Signedness
 Silveira
 sitofp
@@ -682,7 +675,6 @@ tparam
 TPP
 trinomials
 tts
-TXD
 typedef'ed
 typedef
 uart

.github/workflows/cppcheck-scan.yml

@@ -47,6 +47,9 @@ jobs:
         run: |
           fprime-util generate -DCMAKE_EXPORT_COMPILE_COMMANDS=ON
           fprime-util build --all --jobs "$(nproc || printf '%s\n' 1)"
+
+          # Since our subtopologies have EXCLUDE_FROM_ALL, we need to explicitly build them
+          fprime-util build --target Svc_Subtopologies --jobs "$(nproc || printf '%s\n' 1)"
           echo CPPCHECK_OPTS=--project="$GITHUB_WORKSPACE/build-fprime-automatic-native/compile_commands.json" >> $GITHUB_ENV
 
       - name: Run cppcheck

Ref/Main.cpp

@@ -82,8 +82,8 @@ int main(int argc, char* argv[]) {
     }
     // Object for communicating state to the reference topology
     Ref::TopologyState inputs;
-    inputs.comCcsds.hostname = hostname;
-    inputs.comCcsds.port = port_number;
+    inputs.hostname = hostname;
+    inputs.port = port_number;
 
     // Setup program shutdown via Ctrl-C
     signal(SIGINT, signalHandler);

Ref/Top/RefPackets.fppi

@@ -9,10 +9,10 @@ telemetry packets RefPackets {
     FileHandling.fileDownlink.PacketsSent
     FileHandling.fileManager.CommandsExecuted
 
-    ComCcsds.cmdSeq.CS_LoadCommands
-    ComCcsds.cmdSeq.CS_CancelCommands
-    ComCcsds.cmdSeq.CS_CommandsExecuted
-    ComCcsds.cmdSeq.CS_SequencesCompleted
+    Ref.cmdSeq.CS_LoadCommands
+    Ref.cmdSeq.CS_CancelCommands
+    Ref.cmdSeq.CS_CommandsExecuted
+    Ref.cmdSeq.CS_SequencesCompleted
     ComCcsds.comQueue.comQueueDepth
     ComCcsds.comQueue.buffQueueDepth
     ComCcsds.commsBufferManager.TotalBuffs
@@ -32,7 +32,7 @@ telemetry packets RefPackets {
     FileHandling.fileDownlink.Warnings
     FileHandling.fileManager.Errors
 
-    ComCcsds.cmdSeq.CS_Errors
+    Ref.cmdSeq.CS_Errors
     ComCcsds.commsBufferManager.NoBuffs
     ComCcsds.commsBufferManager.EmptyBuffs
 

Ref/Top/RefTopology.cpp

@@ -8,20 +8,19 @@
 // ALL RIGHTS RESERVED.  United States Government Sponsorship
 // acknowledged.
 // ======================================================================
+
 // Provides access to autocoded functions
 #include <Ref/Top/RefTopologyAc.hpp>
 
 // Necessary project-specified types
-#include <Os/Console.hpp>
+#include <Fw/Types/MallocAllocator.hpp>
 
-// Used for 1Hz synthetic cycling
-#include <Os/Mutex.hpp>
 
 // Allows easy reference to objects in FPP/autocoder required namespaces
 using namespace Ref;
 
-// Instantiate a system logger that will handle Fw::Logger::log calls
-Os::Console logger;
+// Instantiate a malloc allocator for cmdSeq buffer allocation
+Fw::MallocAllocator mallocator;
 
 // The reference topology divides the incoming clock signal (1Hz) into sub-signals: 1Hz, 1/2Hz, and 1/4Hz and
 // zero offset for all the dividers
@@ -33,6 +32,10 @@ U32 rateGroup1Context[Svc::ActiveRateGroup::CONNECTION_COUNT_MAX] = {};
 U32 rateGroup2Context[Svc::ActiveRateGroup::CONNECTION_COUNT_MAX] = {};
 U32 rateGroup3Context[Svc::ActiveRateGroup::CONNECTION_COUNT_MAX] = {};
 
+enum TopologyConstants {
+    COMM_PRIORITY = 100,
+};
+
 /**
  * \brief configure/setup components in project-specific way
  *
@@ -48,6 +51,9 @@ void configureTopology() {
     rateGroup1Comp.configure(rateGroup1Context, FW_NUM_ARRAY_ELEMENTS(rateGroup1Context));
     rateGroup2Comp.configure(rateGroup2Context, FW_NUM_ARRAY_ELEMENTS(rateGroup2Context));
     rateGroup3Comp.configure(rateGroup3Context, FW_NUM_ARRAY_ELEMENTS(rateGroup3Context));
+
+    // Command sequencer needs to allocate memory to hold contents of command sequences
+    cmdSeq.allocateBuffer(0, mallocator, 5 * 1024);
 }
 
 // Public functions for use in main program are namespaced with deployment name Ref
@@ -63,12 +69,20 @@ void setupTopology(const TopologyState& state) {
     regCommands();
     // Autocoded configuration. Function provided by autocoder.
     configComponents(state);
+    if (state.hostname != nullptr && state.port != 0) {
+        comDriver.configure(state.hostname, state.port);
+    }
     // Project-specific component configuration. Function provided above. May be inlined, if desired.
     configureTopology();
     // Autocoded parameter loading. Function provided by autocoder.
     loadParameters();
     // Autocoded task kick-off (active components). Function provided by autocoder.
     startTasks(state);
+    //Initialize socket client communication if and only if there is a valid specification
+    if (state.hostname != nullptr && state.port != 0) {
+        Os::TaskString name("ReceiveTask");
+        comDriver.start(name, COMM_PRIORITY, Default::STACK_SIZE);
+    }
 }
 
 void startRateGroups(Fw::TimeInterval interval) {
@@ -88,5 +102,12 @@ void teardownTopology(const TopologyState& state) {
     stopTasks(state);
     freeThreads(state);
     tearDownComponents(state);
+
+    //Stop the comDriver component, free thread
+    comDriver.stop();
+    (void)comDriver.join();
+
+    // Resource deallocation
+    cmdSeq.deallocateBuffer(mallocator);
 }
 }  // namespace Ref

Ref/Top/RefTopologyDefs.hpp

@@ -21,10 +21,15 @@
 #include "Svc/Subtopologies/FileHandling/PingEntries.hpp"
 
 // SubtopologyTopologyDefs includes
+#include "Svc/Subtopologies/CdhCore/SubtopologyTopologyDefs.hpp"
 #include "Svc/Subtopologies/ComCcsds/SubtopologyTopologyDefs.hpp"
 #include "Svc/Subtopologies/DataProducts/SubtopologyTopologyDefs.hpp"
 #include "Svc/Subtopologies/FileHandling/SubtopologyTopologyDefs.hpp"
 
+//ComCcsds Enum Includes
+#include "Svc/Subtopologies/ComCcsds/Ports_ComPacketQueueEnumAc.hpp"
+#include "Svc/Subtopologies/ComCcsds/Ports_ComBufferQueueEnumAc.hpp"
+
 /**
  * \brief required ping constants
  *
@@ -50,6 +55,7 @@ namespace PingEntries {
     namespace Ref_rateGroup1Comp {enum { WARN = 3, FATAL = 5 };}
     namespace Ref_rateGroup2Comp {enum { WARN = 3, FATAL = 5 };}
     namespace Ref_rateGroup3Comp {enum { WARN = 3, FATAL = 5 };}
+    namespace Ref_cmdSeq         {enum { WARN = 3, FATAL = 5 };}
 }  // namespace PingEntries
 
 // Definitions are placed within a namespace named after the deployment
@@ -64,7 +70,12 @@ namespace Ref {
      * fields, which are derived by command line inputs.
      */
     struct TopologyState {
-        ComCcsds::SubtopologyState comCcsds;  //!< Subtopology state for ComCcsds 
+        const char* hostname;   //!< Hostname for TCP communication
+        U16 port;              //!< Port for TCP communication
+        CdhCore::SubtopologyState cdhCore;           //!< Subtopology state for CdhCore
+        ComCcsds::SubtopologyState comCcsds;         //!< Subtopology state for ComCcsds 
+        DataProducts::SubtopologyState dataProducts; //!< Subtopology state for DataProducts
+        FileHandling::SubtopologyState fileHandling; //!< Subtopology state for FileHandling
     };
 
     namespace PingEntries = ::PingEntries;

Ref/Top/instances.fpp

@@ -1,5 +1,18 @@
 module Ref {
 
+  # ----------------------------------------------------------------------
+  # Base ID Convention
+  # ----------------------------------------------------------------------
+  # 
+  # All Base IDs follow the 8-digit hex format: 0xDSSCCxxx
+  #
+  # Where:
+  #   D   = Deployment digit (1-F)
+  #   SS  = Subtopology digits (00 for main topology, 01-FF)
+  #   CC  = Component digits (00-FF)
+  #   xxx = Reserved for internal component items (events, commands, telemetry)
+  #
+
   # ----------------------------------------------------------------------
   # Defaults
   # ----------------------------------------------------------------------
@@ -13,67 +26,74 @@ module Ref {
   # Active component instances
   # ----------------------------------------------------------------------
 
-  instance blockDrv: Ref.BlockDriver base id 0x01000000 \
+  instance blockDrv: Ref.BlockDriver base id 0x10000000 \
     queue size Default.QUEUE_SIZE \
     stack size Default.STACK_SIZE \
     priority 140
 
-  instance rateGroup1Comp: Svc.ActiveRateGroup base id 0x01010000 \
+  instance rateGroup1Comp: Svc.ActiveRateGroup base id 0x10001000 \
     queue size Default.QUEUE_SIZE \
     stack size Default.STACK_SIZE \
     priority 120
 
-  instance rateGroup2Comp: Svc.ActiveRateGroup base id 0x01020000 \
+  instance rateGroup2Comp: Svc.ActiveRateGroup base id 0x10002000 \
     queue size Default.QUEUE_SIZE \
     stack size Default.STACK_SIZE \
     priority 119
 
-  instance rateGroup3Comp: Svc.ActiveRateGroup base id 0x01030000 \
+  instance rateGroup3Comp: Svc.ActiveRateGroup base id 0x10003000 \
     queue size Default.QUEUE_SIZE \
     stack size Default.STACK_SIZE \
     priority 118
 
-  instance pingRcvr: Ref.PingReceiver base id 0x01040000 \
+  instance pingRcvr: Ref.PingReceiver base id 0x10004000 \
     queue size Default.QUEUE_SIZE \
     stack size Default.STACK_SIZE \
     priority 100
 
-  instance typeDemo: Ref.TypeDemo base id 0x01050000
+  instance typeDemo: Ref.TypeDemo base id 0x10005000
+
+  instance cmdSeq: Svc.CmdSequencer base id 0x10006000 \
+    queue size Default.QUEUE_SIZE \
+    stack size Default.STACK_SIZE \
+    priority 97
 
   # ----------------------------------------------------------------------
   # Queued component instances
   # ----------------------------------------------------------------------
 
-  instance sendBuffComp: Ref.SendBuff base id 0x01060000 \
+  instance sendBuffComp: Ref.SendBuff base id 0x10010000 \
     queue size Default.QUEUE_SIZE
 
-  instance SG1: Ref.SignalGen base id 0x01070000 \
+  instance SG1: Ref.SignalGen base id 0x10011000 \
     queue size Default.QUEUE_SIZE
 
-  instance SG2: Ref.SignalGen base id 0x01080000 \
+  instance SG2: Ref.SignalGen base id 0x10012000 \
     queue size Default.QUEUE_SIZE
 
-  instance SG3: Ref.SignalGen base id 0x01090000 \
+  instance SG3: Ref.SignalGen base id 0x10013000 \
     queue size Default.QUEUE_SIZE
 
-  instance SG4: Ref.SignalGen base id 0x010A0000 \
+  instance SG4: Ref.SignalGen base id 0x10014000 \
     queue size Default.QUEUE_SIZE
 
-  instance SG5: Ref.SignalGen base id 0x010B0000 \
+  instance SG5: Ref.SignalGen base id 0x10015000 \
     queue size Default.QUEUE_SIZE
 
   # ----------------------------------------------------------------------
   # Passive component instances
   # ----------------------------------------------------------------------
 
-  instance posixTime: Svc.PosixTime base id 0x010C0000
+  instance posixTime: Svc.PosixTime base id 0x10020000
+
+  instance rateGroupDriverComp: Svc.RateGroupDriver base id 0x10021000
 
-  instance rateGroupDriverComp: Svc.RateGroupDriver base id 0x010D0000
+  instance recvBuffComp: Ref.RecvBuff base id 0x10022000
 
-  instance recvBuffComp: Ref.RecvBuff base id 0x010E0000
+  instance systemResources: Svc.SystemResources base id 0x10023000
 
-  instance systemResources: Svc.SystemResources base id 0x010F0000
+  instance linuxTimer: Svc.LinuxTimer base id 0x10024000
 
-  instance linuxTimer: Svc.LinuxTimer base id 0x01100000
+  instance comDriver: Drv.TcpClient base id 0x10025000 
 
 }