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/ComFprime/SubtopologyTopologyAc.hpp"

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

namespace ComFprime {

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

}

namespace ComFprime {

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

}

namespace ComFprime {

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

}

namespace ComFprime {

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

}

namespace ComFprime {

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

}

namespace ComFprime {

  Svc::FprimeDeframer deframer(FW_OPTIONAL_NAME("deframer"));

}

namespace ComFprime {

  Svc::FprimeFramer fprimeFramer(FW_OPTIONAL_NAME("fprimeFramer"));

}

namespace ComFprime {

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

}

namespace ComFprime {

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

}

namespace ComFprime {

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

  void initComponents(const TopologyState& state) {
    ComFprime::cmdSeq.init(QueueSizes::ComFprime_cmdSeq, InstanceIds::ComFprime_cmdSeq);
    ComFprime::comDriver.init(InstanceIds::ComFprime_comDriver);
    ComFprime::comQueue.init(QueueSizes::ComFprime_comQueue, InstanceIds::ComFprime_comQueue);
    ComFprime::comStub.init(InstanceIds::ComFprime_comStub);
    ComFprime::commsBufferManager.init(InstanceIds::ComFprime_commsBufferManager);
    ComFprime::deframer.init(InstanceIds::ComFprime_deframer);
    ComFprime::fprimeFramer.init(InstanceIds::ComFprime_fprimeFramer);
    ComFprime::fprimeRouter.init(InstanceIds::ComFprime_fprimeRouter);
    ComFprime::frameAccumulator.init(InstanceIds::ComFprime_frameAccumulator);
  }

  void configComponents(const TopologyState& state) {
    ComFprime::cmdSeq.allocateBuffer(0, ComFprime::Allocation::memAllocator, ComFprimeConfig::BuffMgr::cmdSeqBuffSize);
    if (state.hostname != nullptr && state.port != 0) {
        ComFprime::comDriver.configure(state.hostname, state.port);
    }
    Svc::ComQueue::QueueConfigurationTable configurationTable;
    // Events (highest-priority)
    configurationTable.entries[ConfigConstants::ComFprime_comQueue::EVENTS].depth = ComFprimeConfig::QueueDepths::events;
    configurationTable.entries[ConfigConstants::ComFprime_comQueue::EVENTS].priority = ComFprimeConfig::QueuePriorities::events;
    // Telemetry
    configurationTable.entries[ConfigConstants::ComFprime_comQueue::TELEMETRY].depth = ComFprimeConfig::QueueDepths::tlm;
    configurationTable.entries[ConfigConstants::ComFprime_comQueue::TELEMETRY].priority = ComFprimeConfig::QueuePriorities::tlm;
    // File Downlink Queue
    configurationTable.entries[ConfigConstants::ComFprime_comQueue::FILE_QUEUE].depth = ComFprimeConfig::QueueDepths::file;
    configurationTable.entries[ConfigConstants::ComFprime_comQueue::FILE_QUEUE].priority = ComFprimeConfig::QueuePriorities::file;
    // Allocation identifier is 0 as the MallocAllocator discards it
    ComFprime::comQueue.configure(configurationTable, 0, ComFprime::Allocation::memAllocator);
    memset(&ComFprime::BufferManagerBins::bins, 0, sizeof(ComFprime::BufferManagerBins::bins));
    ComFprime::BufferManagerBins::bins.bins[0].bufferSize = ComFprimeConfig::BuffMgr::commsBuffSize;
    ComFprime::BufferManagerBins::bins.bins[0].numBuffers = ComFprimeConfig::BuffMgr::commsBuffCount;
    ComFprime::BufferManagerBins::bins.bins[1].bufferSize = ComFprimeConfig::BuffMgr::commsFileBuffSize;
    ComFprime::BufferManagerBins::bins.bins[1].numBuffers = ComFprimeConfig::BuffMgr::commsFileBuffCount;
    ComFprime::commsBufferManager.setup(
        ComFprimeConfig::BuffMgr::commsBuffMgrId,
        0,
        ComFprime::Allocation::memAllocator,
        ComFprime::BufferManagerBins::bins
    );
    ComFprime::frameAccumulator.configure(
        ComFprime::Detector::frameDetector,
        1,
        ComFprime::Allocation::memAllocator,
        ComFprimeConfig::BuffMgr::frameAccumulatorSize
    );
  }

  void setBaseIds() {
    ComFprime::comQueue.setIdBase(BaseIds::ComFprime_comQueue);
    ComFprime::cmdSeq.setIdBase(BaseIds::ComFprime_cmdSeq);
    ComFprime::frameAccumulator.setIdBase(BaseIds::ComFprime_frameAccumulator);
    ComFprime::commsBufferManager.setIdBase(BaseIds::ComFprime_commsBufferManager);
    ComFprime::deframer.setIdBase(BaseIds::ComFprime_deframer);
    ComFprime::fprimeFramer.setIdBase(BaseIds::ComFprime_fprimeFramer);
    ComFprime::fprimeRouter.setIdBase(BaseIds::ComFprime_fprimeRouter);
    ComFprime::comStub.setIdBase(BaseIds::ComFprime_comStub);
    ComFprime::comDriver.setIdBase(BaseIds::ComFprime_comDriver);
  }

  void connectComponents() {

    // Downlink
    ComFprime::comDriver.set_ready_OutputPort(
        0,
        ComFprime::comStub.get_drvConnected_InputPort(0)
    );
    ComFprime::comDriver.set_sendReturnOut_OutputPort(
        0,
        ComFprime::comStub.get_drvSendReturnIn_InputPort(0)
    );
    ComFprime::comQueue.set_dataOut_OutputPort(
        0,
        ComFprime::fprimeFramer.get_dataIn_InputPort(0)
    );
    ComFprime::comStub.set_comStatusOut_OutputPort(
        0,
        ComFprime::fprimeFramer.get_comStatusIn_InputPort(0)
    );
    ComFprime::comStub.set_dataReturnOut_OutputPort(
        0,
        ComFprime::fprimeFramer.get_dataReturnIn_InputPort(0)
    );
    ComFprime::comStub.set_drvSendOut_OutputPort(
        0,
        ComFprime::comDriver.get_send_InputPort(0)
    );
    ComFprime::fprimeFramer.set_bufferAllocate_OutputPort(
        0,
        ComFprime::commsBufferManager.get_bufferGetCallee_InputPort(0)
    );
    ComFprime::fprimeFramer.set_bufferDeallocate_OutputPort(
        0,
        ComFprime::commsBufferManager.get_bufferSendIn_InputPort(0)
    );
    ComFprime::fprimeFramer.set_comStatusOut_OutputPort(
        0,
        ComFprime::comQueue.get_comStatusIn_InputPort(0)
    );
    ComFprime::fprimeFramer.set_dataOut_OutputPort(
        0,
        ComFprime::comStub.get_dataIn_InputPort(0)
    );
    ComFprime::fprimeFramer.set_dataReturnOut_OutputPort(
        0,
        ComFprime::comQueue.get_dataReturnIn_InputPort(0)
    );

    // Uplink
    ComFprime::comDriver.set_allocate_OutputPort(
        0,
        ComFprime::commsBufferManager.get_bufferGetCallee_InputPort(0)
    );
    ComFprime::comDriver.set_deallocate_OutputPort(
        0,
        ComFprime::commsBufferManager.get_bufferSendIn_InputPort(0)
    );
    ComFprime::comDriver.set_recv_OutputPort(
        0,
        ComFprime::comStub.get_drvReceiveIn_InputPort(0)
    );
    ComFprime::comStub.set_dataOut_OutputPort(
        0,
        ComFprime::frameAccumulator.get_dataIn_InputPort(0)
    );
    ComFprime::comStub.set_drvReceiveReturnOut_OutputPort(
        0,
        ComFprime::comDriver.get_recvReturnIn_InputPort(0)
    );
    ComFprime::deframer.set_dataOut_OutputPort(
        0,
        ComFprime::fprimeRouter.get_dataIn_InputPort(0)
    );
    ComFprime::deframer.set_dataReturnOut_OutputPort(
        0,
        ComFprime::frameAccumulator.get_dataReturnIn_InputPort(0)
    );
    ComFprime::fprimeRouter.set_bufferAllocate_OutputPort(
        0,
        ComFprime::commsBufferManager.get_bufferGetCallee_InputPort(0)
    );
    ComFprime::fprimeRouter.set_bufferDeallocate_OutputPort(
        0,
        ComFprime::commsBufferManager.get_bufferSendIn_InputPort(0)
    );
    ComFprime::fprimeRouter.set_dataReturnOut_OutputPort(
        0,
        ComFprime::deframer.get_dataReturnIn_InputPort(0)
    );
    ComFprime::frameAccumulator.set_bufferAllocate_OutputPort(
        0,
        ComFprime::commsBufferManager.get_bufferGetCallee_InputPort(0)
    );
    ComFprime::frameAccumulator.set_bufferDeallocate_OutputPort(
        0,
        ComFprime::commsBufferManager.get_bufferSendIn_InputPort(0)
    );
    ComFprime::frameAccumulator.set_dataOut_OutputPort(
        0,
        ComFprime::deframer.get_dataIn_InputPort(0)
    );
    ComFprime::frameAccumulator.set_dataReturnOut_OutputPort(
        0,
        ComFprime::comStub.get_dataReturnIn_InputPort(0)
    );
  }

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

  void readParameters() {
    // Nothing to do
  }

  void loadParameters() {
    // Nothing to do
  }

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

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

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

  void tearDownComponents(const TopologyState& state) {
    ComFprime::cmdSeq.deallocateBuffer(ComFprime::Allocation::memAllocator);
    ComFprime::commsBufferManager.cleanup();
    ComFprime::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);
  }

}