Add Driver for the S Band Radio

.gitmodules

@@ -7,3 +7,6 @@
 [submodule "lib/fprime-zephyr"]
 	path = lib/fprime-zephyr
 	url = https://github.com/fprime-community/fprime-zephyr.git
+[submodule "lib/RadioLib"]
+	path = lib/RadioLib
+	url = https://github.com/jgromes/RadioLib

FprimeZephyrReference/CMakeLists.txt

@@ -5,4 +5,5 @@
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/project/config")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Components")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/ComCcsdsUart/")
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/ComCcsdsSband/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/ReferenceDeployment/")

FprimeZephyrReference/ComCcsdsSband/CMakeLists.txt

@@ -0,0 +1,12 @@
+
+register_fprime_module(
+    EXCLUDE_FROM_ALL
+    AUTOCODER_INPUTS
+        "${CMAKE_CURRENT_LIST_DIR}/ComCcsdsSband.fpp"
+    HEADERS
+        "${CMAKE_CURRENT_LIST_DIR}/SubtopologyTopologyDefs.hpp"
+        "${CMAKE_CURRENT_LIST_DIR}/PingEntries.hpp"
+    DEPENDS
+        Svc_Subtopologies_ComCcsds_ComCcsdsConfig
+    INTERFACE
+)

FprimeZephyrReference/ComCcsdsSband/ComCcsdsSband.fpp

@@ -0,0 +1,203 @@
+module ComCcsdsSband {
+
+    # ComPacket Queue enum for queue types
+    enum Ports_ComPacketQueue {
+        EVENTS,
+        TELEMETRY
+    }
+
+    enum Ports_ComBufferQueue {
+        FILE
+    }
+
+    # ----------------------------------------------------------------------
+    # Active Components
+    # ----------------------------------------------------------------------
+    instance comQueue: Svc.ComQueue base id ComCcsdsConfig.BASE_ID_SBAND + 0x00000 \
+        queue size ComCcsdsConfig.QueueSizes.comQueue \
+        stack size ComCcsdsConfig.StackSizes.comQueue \
+        priority ComCcsdsConfig.Priorities.comQueue \
+    {
+        phase Fpp.ToCpp.Phases.configComponents """
+        using namespace ComCcsdsSband;
+        Svc::ComQueue::QueueConfigurationTable configurationTableSband;
+
+        // Events (highest-priority)
+        configurationTableSband.entries[Ports_ComPacketQueue::EVENTS].depth = ComCcsdsConfig::QueueDepths::events;
+        configurationTableSband.entries[Ports_ComPacketQueue::EVENTS].priority = ComCcsdsConfig::QueuePriorities::events;
+
+        // Telemetry
+        configurationTableSband.entries[Ports_ComPacketQueue::TELEMETRY].depth = ComCcsdsConfig::QueueDepths::tlm;
+        configurationTableSband.entries[Ports_ComPacketQueue::TELEMETRY].priority = ComCcsdsConfig::QueuePriorities::tlm;
+
+        // File Downlink Queue (buffer queue using NUM_CONSTANTS offset)
+        configurationTableSband.entries[Ports_ComPacketQueue::NUM_CONSTANTS + Ports_ComBufferQueue::FILE].depth = ComCcsdsConfig::QueueDepths::file;
+        configurationTableSband.entries[Ports_ComPacketQueue::NUM_CONSTANTS + Ports_ComBufferQueue::FILE].priority = ComCcsdsConfig::QueuePriorities::file;
+
+        // Allocation identifier is 0 as the MallocAllocator discards it
+        ComCcsdsSband::comQueue.configure(configurationTableSband, 0, ComCcsds::Allocation::memAllocator);
+        """
+        phase Fpp.ToCpp.Phases.tearDownComponents """
+        ComCcsdsSband::comQueue.cleanup();
+        """
+    }
+
+    instance aggregator: Svc.ComAggregator base id ComCcsdsConfig.BASE_ID_SBAND + 0x06000 \
+        queue size ComCcsdsConfig.QueueSizes.aggregator \
+        stack size ComCcsdsConfig.StackSizes.aggregator
+
+    # ----------------------------------------------------------------------
+    # Passive Components
+    # ----------------------------------------------------------------------
+    instance frameAccumulator: Svc.FrameAccumulator base id ComCcsdsConfig.BASE_ID_SBAND + 0x01000 \
+    {
+
+        phase Fpp.ToCpp.Phases.configObjects """
+        Svc::FrameDetectors::CcsdsTcFrameDetector frameDetector;
+        """
+        phase Fpp.ToCpp.Phases.configComponents """
+        ComCcsdsSband::frameAccumulator.configure(
+            ConfigObjects::ComCcsdsSband_frameAccumulator::frameDetector,
+            1,
+            ComCcsds::Allocation::memAllocator,
+            ComCcsdsConfig::BuffMgr::frameAccumulatorSize
+        );
+        """
+
+        phase Fpp.ToCpp.Phases.tearDownComponents """
+        ComCcsdsSband::frameAccumulator.cleanup();
+        """
+    }
+
+    instance commsBufferManager: Svc.BufferManager base id ComCcsdsConfig.BASE_ID_SBAND + 0x02000 \
+    {
+        phase Fpp.ToCpp.Phases.configObjects """
+        Svc::BufferManager::BufferBins bins;
+        """
+
+        phase Fpp.ToCpp.Phases.configComponents """
+        memset(&ConfigObjects::ComCcsdsSband_commsBufferManager::bins, 0, sizeof(ConfigObjects::ComCcsdsSband_commsBufferManager::bins));
+        ConfigObjects::ComCcsdsSband_commsBufferManager::bins.bins[0].bufferSize = ComCcsdsConfig::BuffMgr::commsBuffSize;
+        ConfigObjects::ComCcsdsSband_commsBufferManager::bins.bins[0].numBuffers = ComCcsdsConfig::BuffMgr::commsBuffCount;
+        ConfigObjects::ComCcsdsSband_commsBufferManager::bins.bins[1].bufferSize = ComCcsdsConfig::BuffMgr::commsFileBuffSize;
+        ConfigObjects::ComCcsdsSband_commsBufferManager::bins.bins[1].numBuffers = ComCcsdsConfig::BuffMgr::commsFileBuffCount;
+        ComCcsdsSband::commsBufferManager.setup(
+            ComCcsdsConfig::BuffMgr::commsBuffMgrId,
+            0,
+            ComCcsds::Allocation::memAllocator,
+            ConfigObjects::ComCcsdsSband_commsBufferManager::bins
+        );
+        """
+
+        phase Fpp.ToCpp.Phases.tearDownComponents """
+        ComCcsdsSband::commsBufferManager.cleanup();
+        """
+    }
+
+    instance fprimeRouter: Svc.FprimeRouter base id ComCcsdsConfig.BASE_ID_SBAND + 0x03000
+
+    instance tcDeframer: Svc.Ccsds.TcDeframer base id ComCcsdsConfig.BASE_ID_SBAND + 0x04000
+
+    instance spacePacketDeframer: Svc.Ccsds.SpacePacketDeframer base id ComCcsdsConfig.BASE_ID_SBAND + 0x05000
+
+    # NOTE: name 'framer' is used for the framer that connects to the Com Adapter Interface for better subtopology interoperability
+    instance framer: Svc.Ccsds.TmFramer base id ComCcsdsConfig.BASE_ID_SBAND + 0x07000
+
+    instance spacePacketFramer: Svc.Ccsds.SpacePacketFramer base id ComCcsdsConfig.BASE_ID_SBAND + 0x08000
+
+    instance apidManager: Svc.Ccsds.ApidManager base id ComCcsdsConfig.BASE_ID_SBAND + 0x09000
+
+    instance comStub: Svc.ComStub base id ComCcsdsConfig.BASE_ID_SBAND + 0x0A000
+
+    topology FramingSubtopology {
+        # Usage Note:
+        #
+        # When importing this subtopology, users shall establish 5 port connections with a component implementing
+        # the Svc.Com (Svc/Interfaces/Com.fpp) interface. They are as follows:
+        #
+        # 1) Outputs:
+        #     - ComCcsds.framer.dataOut                 -> [Svc.Com].dataIn
+        #     - ComCcsds.frameAccumulator.dataReturnOut -> [Svc.Com].dataReturnIn
+        # 2) Inputs:
+        #     - [Svc.Com].dataReturnOut -> ComCcsds.framer.dataReturnIn
+        #     - [Svc.Com].comStatusOut  -> ComCcsds.framer.comStatusIn
+        #     - [Svc.Com].dataOut       -> ComCcsds.frameAccumulator.dataIn
+
+
+        # Active Components
+        instance comQueue
+
+        # Passive Components
+        instance commsBufferManager
+        instance frameAccumulator
+        instance fprimeRouter
+        instance tcDeframer
+        instance spacePacketDeframer
+        instance framer
+        instance spacePacketFramer
+        instance apidManager
+        instance aggregator
+
+        connections Downlink {
+            # ComQueue <-> SpacePacketFramer
+            comQueue.dataOut                -> spacePacketFramer.dataIn
+            spacePacketFramer.dataReturnOut -> comQueue.dataReturnIn
+            # SpacePacketFramer buffer and APID management
+            spacePacketFramer.bufferAllocate   -> commsBufferManager.bufferGetCallee
+            spacePacketFramer.bufferDeallocate -> commsBufferManager.bufferSendIn
+            spacePacketFramer.getApidSeqCount  -> apidManager.getApidSeqCountIn
+            # SpacePacketFramer <-> TmFramer
+            spacePacketFramer.dataOut -> aggregator.dataIn
+            aggregator.dataOut        -> framer.dataIn
+
+            framer.dataReturnOut      -> aggregator.dataReturnIn
+            aggregator.dataReturnOut    -> spacePacketFramer.dataReturnIn
+
+            # ComStatus
+            framer.comStatusOut            -> aggregator.comStatusIn
+            aggregator.comStatusOut        -> spacePacketFramer.comStatusIn
+            spacePacketFramer.comStatusOut -> comQueue.comStatusIn
+            # (Outgoing) Framer <-> ComInterface connections shall be established by the user
+        }
+
+        connections Uplink {
+            # (Incoming) ComInterface <-> FrameAccumulator connections shall be established by the user
+            # FrameAccumulator buffer allocations
+            frameAccumulator.bufferDeallocate -> commsBufferManager.bufferSendIn
+            frameAccumulator.bufferAllocate   -> commsBufferManager.bufferGetCallee
+            # FrameAccumulator <-> TcDeframer
+            frameAccumulator.dataOut -> tcDeframer.dataIn
+            tcDeframer.dataReturnOut -> frameAccumulator.dataReturnIn
+            # TcDeframer <-> SpacePacketDeframer
+            tcDeframer.dataOut                -> spacePacketDeframer.dataIn
+            spacePacketDeframer.dataReturnOut -> tcDeframer.dataReturnIn
+            # SpacePacketDeframer APID validation
+            spacePacketDeframer.validateApidSeqCount -> apidManager.validateApidSeqCountIn
+            # SpacePacketDeframer <-> Router
+            spacePacketDeframer.dataOut -> fprimeRouter.dataIn
+            fprimeRouter.dataReturnOut  -> spacePacketDeframer.dataReturnIn
+            # Router buffer allocations
+            fprimeRouter.bufferAllocate   -> commsBufferManager.bufferGetCallee
+            fprimeRouter.bufferDeallocate -> commsBufferManager.bufferSendIn
+        }
+    } # end FramingSubtopology
+
+    # This subtopology uses FramingSubtopology with a ComStub component for Com Interface
+    topology Subtopology {
+        import FramingSubtopology
+
+        instance comStub
+
+        connections ComStub {
+            # Framer <-> ComStub (Downlink)
+            framer.dataOut -> comStub.dataIn
+            comStub.dataReturnOut   -> framer.dataReturnIn
+            comStub.comStatusOut    -> framer.comStatusIn
+
+            # ComStub <-> FrameAccumulator (Uplink)
+            comStub.dataOut -> frameAccumulator.dataIn
+            frameAccumulator.dataReturnOut -> comStub.dataReturnIn
+        }
+    } # end Subtopology
+
+} # end ComCcsdsSband

FprimeZephyrReference/ComCcsdsSband/PingEntries.hpp

@@ -0,0 +1,7 @@
+#ifndef COMCCSDS_SBAND_PINGENTRIES_HPP
+#define COMCCSDS_SBAND_PINGENTRIES_HPP
+namespace PingEntries {
+// No ping-enabled components in ComCcsds S-band subtopology
+}
+
+#endif

FprimeZephyrReference/ComCcsdsSband/SubtopologyTopologyDefs.hpp

@@ -0,0 +1,21 @@
+#ifndef COMCCSDSSBANDSUBDEFS_HPP
+#define COMCCSDSSBANDSUBDEFS_HPP
+
+#include <Fw/Types/MallocAllocator.hpp>
+#include <Svc/BufferManager/BufferManager.hpp>
+#include <Svc/FrameAccumulator/FrameDetector/CcsdsTcFrameDetector.hpp>
+
+#include "ComCcsdsConfig/ComCcsdsSubtopologyConfig.hpp"
+#include "Svc/Subtopologies/ComCcsds/ComCcsdsConfig/FppConstantsAc.hpp"
+
+namespace ComCcsdsSband {
+struct SubtopologyState {
+    // Empty - no external state needed for ComCcsdsSband subtopology
+};
+
+struct TopologyState {
+    SubtopologyState comCcsdsSband;
+};
+}  // namespace ComCcsdsSband
+
+#endif

FprimeZephyrReference/ComCcsdsSband/docs/sdd.md

@@ -0,0 +1,5 @@
+# ComCcsdsSband
+
+This is a clone with a renamed module of the F Prime's Svc::ComCcsds.
+
+See: [Svc::ComCcsds](../../../lib/fprime/Svc/Subtopologies/ComCcsds/docs/sdd.md)

FprimeZephyrReference/Components/CMakeLists.txt

@@ -13,5 +13,6 @@ add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/ModeManager/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/NullPrmDb/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/PowerMonitor/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/ResetManager/")
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/SBand/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/StartupManager/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Watchdog")

FprimeZephyrReference/Components/SBand/CMakeLists.txt

@@ -0,0 +1,42 @@
+####
+# F Prime CMakeLists.txt:
+#
+# SOURCES: list of source files (to be compiled)
+# AUTOCODER_INPUTS: list of files to be passed to the autocoders
+# DEPENDS: list of libraries that this module depends on
+#
+# More information in the F´ CMake API documentation:
+# https://fprime.jpl.nasa.gov/latest/docs/reference/api/cmake/API/
+#
+####
+
+# Module names are derived from the path from the nearest project/library/framework
+# root when not specifically overridden by the developer. i.e. The module defined by
+# `Ref/SignalGen/CMakeLists.txt` will be named `Ref_SignalGen`.
+
+register_fprime_library(
+    AUTOCODER_INPUTS
+        "${CMAKE_CURRENT_LIST_DIR}/SBand.fpp"
+    SOURCES
+        "${CMAKE_CURRENT_LIST_DIR}/SBand.cpp"
+        "${CMAKE_CURRENT_LIST_DIR}/FprimeHal.cpp"
+    DEPENDS
+        RadioLib
+)
+
+add_subdirectory("${FPRIME_PROJECT_ROOT}/lib/RadioLib" "${CMAKE_BINARY_DIR}/RadioLib")
+
+# Disable compile warnings for RadioLib as they pollute the log and we can't do anything about them.
+target_compile_options(RadioLib PRIVATE -w)
+
+### Unit Tests ###
+# register_fprime_ut(
+#     AUTOCODER_INPUTS
+#         "${CMAKE_CURRENT_LIST_DIR}/SBand.fpp"
+#     SOURCES
+#         "${CMAKE_CURRENT_LIST_DIR}/test/ut/SBandTestMain.cpp"
+#         "${CMAKE_CURRENT_LIST_DIR}/test/ut/SBandTester.cpp"
+#     DEPENDS
+#         STest # For rules-based testing
+#     UT_AUTO_HELPERS
+# )

FprimeZephyrReference/Components/SBand/FprimeHal.cpp

@@ -0,0 +1,77 @@
+#define RADIOLIB_LOW_LEVEL 1
+
+#include "FprimeHal.hpp"
+
+#include <Fw/Buffer/Buffer.hpp>
+#include <Fw/Time/Time.hpp>
+#include <Os/Task.hpp>
+
+#include "SBand.hpp"
+#include <zephyr/kernel.h>
+
+FprimeHal::FprimeHal(Components::SBand* component) : RadioLibHal(0, 0, 0, 0, 0, 0), m_component(component) {}
+
+void FprimeHal::init() {}
+
+void FprimeHal::term() {}
+
+void FprimeHal::pinMode(uint32_t pin, uint32_t mode) {}
+
+void FprimeHal::digitalWrite(uint32_t pin, uint32_t value) {}
+
+uint32_t FprimeHal::digitalRead(uint32_t pin) {
+    if (pin == 5) {
+        Fw::Logic irqState;
+        Drv::GpioStatus state = this->m_component->getIRQLine_out(0, irqState);
+        FW_ASSERT(state == Drv::GpioStatus::OP_OK);
+        if (irqState == Fw::Logic::HIGH)
+            return 1;
+        else
+            return 0;
+    }
+    return 0;
+}
+
+void FprimeHal::attachInterrupt(uint32_t interruptNum, void (*interruptCb)(void), uint32_t mode) {}
+
+void FprimeHal::detachInterrupt(uint32_t interruptNum) {}
+
+void FprimeHal::delay(unsigned long ms) {
+    Os::Task::delay(Fw::TimeInterval(0, ms * 1000));
+}
+
+void FprimeHal::delayMicroseconds(unsigned long us) {
+    Os::Task::delay(Fw::TimeInterval(0, us));
+}
+
+unsigned long FprimeHal::millis() {
+    return k_uptime_get();
+}
+
+unsigned long FprimeHal::micros() {
+    return k_uptime_get() * 1000;
+}
+
+long FprimeHal::pulseIn(uint32_t pin, uint32_t state, unsigned long timeout) {
+    return 0;
+}
+
+void FprimeHal::tone(uint32_t pin, unsigned int frequency, unsigned long duration) {}
+
+void FprimeHal::noTone(uint32_t pin) {}
+
+void FprimeHal::spiBegin() {}
+
+void FprimeHal::spiBeginTransaction() {}
+
+void FprimeHal::spiTransfer(uint8_t* out, size_t len, uint8_t* in) {
+    Fw::Buffer writeBuffer(out, len);
+    Fw::Buffer readBuffer(in, len);
+    this->m_component->spiSend_out(0, writeBuffer, readBuffer);
+}
+
+void FprimeHal::yield() {}
+
+void FprimeHal::spiEndTransaction() {}
+
+void FprimeHal::spiEnd() {}