SubtopologyTopologyAc.cpp

Go to the documentation of this file.

// ======================================================================
// \title  SubtopologyTopologyAc.cpp
// \author Generated by fpp-to-cpp
// \brief  cpp file for Subtopology topology
// ======================================================================

#include "Svc/Subtopologies/ComCcsds/SubtopologyTopologyAc.hpp"

// ----------------------------------------------------------------------
// Component instances
// ----------------------------------------------------------------------

namespace ComCcsds {

  Svc::Ccsds::ApidManager apidManager(FW_OPTIONAL_NAME("apidManager"));

}

namespace ComCcsds {

  Svc::CmdSequencer cmdSeq(FW_OPTIONAL_NAME("cmdSeq"));

}

namespace ComCcsds {

  Drv::TcpClient comDriver(FW_OPTIONAL_NAME("comDriver"));

}

namespace ComCcsds {

  Svc::ComQueue comQueue(FW_OPTIONAL_NAME("comQueue"));

}

namespace ComCcsds {

  Svc::ComStub comStub(FW_OPTIONAL_NAME("comStub"));

}

namespace ComCcsds {

  Svc::BufferManager commsBufferManager(FW_OPTIONAL_NAME("commsBufferManager"));

}

namespace ComCcsds {

  Svc::FprimeRouter fprimeRouter(FW_OPTIONAL_NAME("fprimeRouter"));

}

namespace ComCcsds {

  Svc::FrameAccumulator frameAccumulator(FW_OPTIONAL_NAME("frameAccumulator"));

}

namespace ComCcsds {

  Svc::Ccsds::SpacePacketDeframer spacePacketDeframer(FW_OPTIONAL_NAME("spacePacketDeframer"));

}

namespace ComCcsds {

  Svc::Ccsds::SpacePacketFramer spacePacketFramer(FW_OPTIONAL_NAME("spacePacketFramer"));

}

namespace ComCcsds {

  Svc::Ccsds::TcDeframer tcDeframer(FW_OPTIONAL_NAME("tcDeframer"));

}

namespace ComCcsds {

  Svc::Ccsds::TmFramer tmFramer(FW_OPTIONAL_NAME("tmFramer"));

}

namespace ComCcsds {

  // ----------------------------------------------------------------------
  // Component configuration objects
  // ----------------------------------------------------------------------

  namespace ConfigObjects {

    namespace ComCcsds_commsBufferManager {
      Svc::BufferManager::BufferBins bins;
    }

    namespace ComCcsds_frameAccumulator {
      Svc::FrameDetectors::CcsdsTcFrameDetector frameDetector;
    }

  }

  // ----------------------------------------------------------------------
  // Helper functions
  // ----------------------------------------------------------------------

  void initComponents(const TopologyState& state) {
    ComCcsds::apidManager.init(InstanceIds::ComCcsds_apidManager);
    ComCcsds::cmdSeq.init(QueueSizes::ComCcsds_cmdSeq, InstanceIds::ComCcsds_cmdSeq);
    ComCcsds::comDriver.init(InstanceIds::ComCcsds_comDriver);
    ComCcsds::comQueue.init(QueueSizes::ComCcsds_comQueue, InstanceIds::ComCcsds_comQueue);
    ComCcsds::comStub.init(InstanceIds::ComCcsds_comStub);
    ComCcsds::commsBufferManager.init(InstanceIds::ComCcsds_commsBufferManager);
    ComCcsds::fprimeRouter.init(InstanceIds::ComCcsds_fprimeRouter);
    ComCcsds::frameAccumulator.init(InstanceIds::ComCcsds_frameAccumulator);
    ComCcsds::spacePacketDeframer.init(InstanceIds::ComCcsds_spacePacketDeframer);
    ComCcsds::spacePacketFramer.init(InstanceIds::ComCcsds_spacePacketFramer);
    ComCcsds::tcDeframer.init(InstanceIds::ComCcsds_tcDeframer);
    ComCcsds::tmFramer.init(InstanceIds::ComCcsds_tmFramer);
  }

  void configComponents(const TopologyState& state) {
    ComCcsds::cmdSeq.allocateBuffer(0, ComCcsds::Allocation::memAllocator, ComCcsdsConfig::BuffMgr::cmdSeqBuffSize);
    if (state.comCcsds.hostname != nullptr && state.comCcsds.port != 0) {
        ComCcsds::comDriver.configure(state.comCcsds.hostname, state.comCcsds.port);
    }
    Svc::ComQueue::QueueConfigurationTable configurationTable;

    // Events (highest-priority)
    configurationTable.entries[ConfigConstants::ComCcsds_comQueue::EVENTS].depth = ComCcsdsConfig::QueueDepths::events;
    configurationTable.entries[ConfigConstants::ComCcsds_comQueue::EVENTS].priority = ComCcsdsConfig::QueuePriorities::events;

    // Telemetry
    configurationTable.entries[ConfigConstants::ComCcsds_comQueue::TELEMETRY].depth = ComCcsdsConfig::QueueDepths::tlm;
    configurationTable.entries[ConfigConstants::ComCcsds_comQueue::TELEMETRY].priority = ComCcsdsConfig::QueuePriorities::tlm;

    // File Downlink Queue
    configurationTable.entries[ConfigConstants::ComCcsds_comQueue::FILE_QUEUE].depth = ComCcsdsConfig::QueueDepths::file;
    configurationTable.entries[ConfigConstants::ComCcsds_comQueue::FILE_QUEUE].priority = ComCcsdsConfig::QueuePriorities::file;

    // Allocation identifier is 0 as the MallocAllocator discards it
    ComCcsds::comQueue.configure(configurationTable, 0, ComCcsds::Allocation::memAllocator);
    memset(&ConfigObjects::ComCcsds_commsBufferManager::bins, 0, sizeof(ConfigObjects::ComCcsds_commsBufferManager::bins));
    ConfigObjects::ComCcsds_commsBufferManager::bins.bins[0].bufferSize = ComCcsdsConfig::BuffMgr::commsBuffSize;
    ConfigObjects::ComCcsds_commsBufferManager::bins.bins[0].numBuffers = ComCcsdsConfig::BuffMgr::commsBuffCount;
    ConfigObjects::ComCcsds_commsBufferManager::bins.bins[1].bufferSize = ComCcsdsConfig::BuffMgr::commsFileBuffSize;
    ConfigObjects::ComCcsds_commsBufferManager::bins.bins[1].numBuffers = ComCcsdsConfig::BuffMgr::commsFileBuffCount;
    ComCcsds::commsBufferManager.setup(
        ComCcsdsConfig::BuffMgr::commsBuffMgrId,
        0,
        ComCcsds::Allocation::memAllocator,
        ConfigObjects::ComCcsds_commsBufferManager::bins
    );
    ComCcsds::frameAccumulator.configure(
        ConfigObjects::ComCcsds_frameAccumulator::frameDetector,
        1,
        ComCcsds::Allocation::memAllocator,
        ComCcsdsConfig::BuffMgr::frameAccumulatorSize
    );
  }

  void setBaseIds() {
    ComCcsds::comQueue.setIdBase(BaseIds::ComCcsds_comQueue);
    ComCcsds::cmdSeq.setIdBase(BaseIds::ComCcsds_cmdSeq);
    ComCcsds::frameAccumulator.setIdBase(BaseIds::ComCcsds_frameAccumulator);
    ComCcsds::commsBufferManager.setIdBase(BaseIds::ComCcsds_commsBufferManager);
    ComCcsds::fprimeRouter.setIdBase(BaseIds::ComCcsds_fprimeRouter);
    ComCcsds::comStub.setIdBase(BaseIds::ComCcsds_comStub);
    ComCcsds::tcDeframer.setIdBase(BaseIds::ComCcsds_tcDeframer);
    ComCcsds::spacePacketDeframer.setIdBase(BaseIds::ComCcsds_spacePacketDeframer);
    ComCcsds::comDriver.setIdBase(BaseIds::ComCcsds_comDriver);
    ComCcsds::tmFramer.setIdBase(BaseIds::ComCcsds_tmFramer);
    ComCcsds::spacePacketFramer.setIdBase(BaseIds::ComCcsds_spacePacketFramer);
    ComCcsds::apidManager.setIdBase(BaseIds::ComCcsds_apidManager);
  }

  void connectComponents() {

    // Downlink
    ComCcsds::comDriver.set_ready_OutputPort(
        0,
        ComCcsds::comStub.get_drvConnected_InputPort(0)
    );
    ComCcsds::comDriver.set_sendReturnOut_OutputPort(
        0,
        ComCcsds::comStub.get_drvSendReturnIn_InputPort(0)
    );
    ComCcsds::comQueue.set_dataOut_OutputPort(
        0,
        ComCcsds::spacePacketFramer.get_dataIn_InputPort(0)
    );
    ComCcsds::comStub.set_comStatusOut_OutputPort(
        0,
        ComCcsds::tmFramer.get_comStatusIn_InputPort(0)
    );
    ComCcsds::comStub.set_dataReturnOut_OutputPort(
        0,
        ComCcsds::tmFramer.get_dataReturnIn_InputPort(0)
    );
    ComCcsds::comStub.set_drvSendOut_OutputPort(
        0,
        ComCcsds::comDriver.get_send_InputPort(0)
    );
    ComCcsds::spacePacketFramer.set_bufferAllocate_OutputPort(
        0,
        ComCcsds::commsBufferManager.get_bufferGetCallee_InputPort(0)
    );
    ComCcsds::spacePacketFramer.set_bufferDeallocate_OutputPort(
        0,
        ComCcsds::commsBufferManager.get_bufferSendIn_InputPort(0)
    );
    ComCcsds::spacePacketFramer.set_comStatusOut_OutputPort(
        0,
        ComCcsds::comQueue.get_comStatusIn_InputPort(0)
    );
    ComCcsds::spacePacketFramer.set_dataOut_OutputPort(
        0,
        ComCcsds::tmFramer.get_dataIn_InputPort(0)
    );
    ComCcsds::spacePacketFramer.set_dataReturnOut_OutputPort(
        0,
        ComCcsds::comQueue.get_dataReturnIn_InputPort(0)
    );
    ComCcsds::spacePacketFramer.set_getApidSeqCount_OutputPort(
        0,
        ComCcsds::apidManager.get_getApidSeqCountIn_InputPort(0)
    );
    ComCcsds::tmFramer.set_comStatusOut_OutputPort(
        0,
        ComCcsds::spacePacketFramer.get_comStatusIn_InputPort(0)
    );
    ComCcsds::tmFramer.set_dataOut_OutputPort(
        0,
        ComCcsds::comStub.get_dataIn_InputPort(0)
    );
    ComCcsds::tmFramer.set_dataReturnOut_OutputPort(
        0,
        ComCcsds::spacePacketFramer.get_dataReturnIn_InputPort(0)
    );

    // Uplink
    ComCcsds::comDriver.set_allocate_OutputPort(
        0,
        ComCcsds::commsBufferManager.get_bufferGetCallee_InputPort(0)
    );
    ComCcsds::comDriver.set_deallocate_OutputPort(
        0,
        ComCcsds::commsBufferManager.get_bufferSendIn_InputPort(0)
    );
    ComCcsds::comDriver.set_recv_OutputPort(
        0,
        ComCcsds::comStub.get_drvReceiveIn_InputPort(0)
    );
    ComCcsds::comStub.set_dataOut_OutputPort(
        0,
        ComCcsds::frameAccumulator.get_dataIn_InputPort(0)
    );
    ComCcsds::comStub.set_drvReceiveReturnOut_OutputPort(
        0,
        ComCcsds::comDriver.get_recvReturnIn_InputPort(0)
    );
    ComCcsds::fprimeRouter.set_bufferAllocate_OutputPort(
        0,
        ComCcsds::commsBufferManager.get_bufferGetCallee_InputPort(0)
    );
    ComCcsds::fprimeRouter.set_bufferDeallocate_OutputPort(
        0,
        ComCcsds::commsBufferManager.get_bufferSendIn_InputPort(0)
    );
    ComCcsds::fprimeRouter.set_dataReturnOut_OutputPort(
        0,
        ComCcsds::spacePacketDeframer.get_dataReturnIn_InputPort(0)
    );
    ComCcsds::frameAccumulator.set_bufferAllocate_OutputPort(
        0,
        ComCcsds::commsBufferManager.get_bufferGetCallee_InputPort(0)
    );
    ComCcsds::frameAccumulator.set_bufferDeallocate_OutputPort(
        0,
        ComCcsds::commsBufferManager.get_bufferSendIn_InputPort(0)
    );
    ComCcsds::frameAccumulator.set_dataOut_OutputPort(
        0,
        ComCcsds::tcDeframer.get_dataIn_InputPort(0)
    );
    ComCcsds::frameAccumulator.set_dataReturnOut_OutputPort(
        0,
        ComCcsds::comStub.get_dataReturnIn_InputPort(0)
    );
    ComCcsds::spacePacketDeframer.set_dataOut_OutputPort(
        0,
        ComCcsds::fprimeRouter.get_dataIn_InputPort(0)
    );
    ComCcsds::spacePacketDeframer.set_dataReturnOut_OutputPort(
        0,
        ComCcsds::tcDeframer.get_dataReturnIn_InputPort(0)
    );
    ComCcsds::spacePacketDeframer.set_validateApidSeqCount_OutputPort(
        0,
        ComCcsds::apidManager.get_validateApidSeqCountIn_InputPort(0)
    );
    ComCcsds::tcDeframer.set_dataOut_OutputPort(
        0,
        ComCcsds::spacePacketDeframer.get_dataIn_InputPort(0)
    );
    ComCcsds::tcDeframer.set_dataReturnOut_OutputPort(
        0,
        ComCcsds::frameAccumulator.get_dataReturnIn_InputPort(0)
    );
  }

  void regCommands() {
    ComCcsds::cmdSeq.regCommands();
  }

  void readParameters() {
    // Nothing to do
  }

  void loadParameters() {
    // Nothing to do
  }

  void startTasks(const TopologyState& state) {
    ComCcsds::cmdSeq.start(
      static_cast<FwTaskPriorityType>(Priorities::ComCcsds_cmdSeq),
      static_cast<Os::Task::ParamType>(StackSizes::ComCcsds_cmdSeq),
      Os::Task::TASK_DEFAULT, // Default CPU
      static_cast<Os::Task::ParamType>(TaskIds::ComCcsds_cmdSeq)
    );
    // Initialize socket client communication if and only if there is a valid specification
    if (state.comCcsds.hostname != nullptr && state.comCcsds.port != 0) {
        Os::TaskString name("ReceiveTask");
        ComCcsds::comDriver.start(name, ComCcsdsConfig::Priorities::comDriver, ComCcsdsConfig::StackSizes::comDriver);
    }
    ComCcsds::comQueue.start(
      static_cast<FwTaskPriorityType>(Priorities::ComCcsds_comQueue),
      static_cast<Os::Task::ParamType>(StackSizes::ComCcsds_comQueue),
      Os::Task::TASK_DEFAULT, // Default CPU
      static_cast<Os::Task::ParamType>(TaskIds::ComCcsds_comQueue)
    );
  }

  void stopTasks(const TopologyState& state) {
    ComCcsds::cmdSeq.exit();
    ComCcsds::comDriver.stop();
    ComCcsds::comQueue.exit();
  }

  void freeThreads(const TopologyState& state) {
    (void) ComCcsds::cmdSeq.ActiveComponentBase::join();
    (void)ComCcsds::comDriver.join();
    (void) ComCcsds::comQueue.ActiveComponentBase::join();
  }

  void tearDownComponents(const TopologyState& state) {
    ComCcsds::cmdSeq.deallocateBuffer(ComCcsds::Allocation::memAllocator);
    ComCcsds::comQueue.cleanup();
    ComCcsds::commsBufferManager.cleanup();
    ComCcsds::frameAccumulator.cleanup();
  }

  // ----------------------------------------------------------------------
  // Setup and teardown functions
  // ----------------------------------------------------------------------

  void setup(const TopologyState& state) {
    initComponents(state);
    configComponents(state);
    setBaseIds();
    connectComponents();
    regCommands();
    readParameters();
    loadParameters();
    startTasks(state);
  }

  void teardown(const TopologyState& state) {
    stopTasks(state);
    freeThreads(state);
    tearDownComponents(state);
  }

}