Merge branch 'nasa:devel' into cfdp_manager

Author: Brian-Campuzano

.github/actions/spelling/expect.txt

@@ -42,6 +42,7 @@ bitshifts
 bitwidth
 bocchino
 boolt
+BSB
 bsd
 BSDI
 bst
@@ -58,6 +59,7 @@ bugprone
 buildstep
 BYTEDRV
 calcu
+CALCULATECRC
 callergraph
 callgraph
 Campuzano
@@ -606,6 +608,7 @@ sfregoso
 sge
 SGN
 sgt
+shahab
 SHAREDSTATEDIR
 SHELLCOMMAND
 showinitializer
@@ -649,7 +652,7 @@ strnlen
 subgrouping
 subhist
 subhistory
-subseconds
+subsecond
 subtopology
 suppr
 suseconds
@@ -716,6 +719,7 @@ uge
 uitofp
 UML
 umod
+unconfigured
 UNEXP
 unistd
 UNITTESTASSERT

.gitignore

@@ -4,6 +4,8 @@ build-artifacts/
 gtest/
 docs-cache/
 CMakePresets.json
+/DpTest*/
+/Testing/
 
 AutoXML/
 test_harness/src/test_harness-C/application.out
@@ -30,6 +32,7 @@ Dict
 
 **/coverage/
 *.gcov
+lcov.info
 !**/test/ut/output/*.gcov
 GTestBase.*
 TesterBase.*
@@ -59,6 +62,7 @@ test_harness/.autotools
 core
 
 *.swp4
+*dpState.dat
 
 *AppDictionary.xml
 *TopologyAppID.csv

Drv/AsyncByteStreamBufferAdapter/AsyncByteStreamBufferAdapter.cpp

@@ -1,6 +1,6 @@
 // ======================================================================
 // \title  AsyncByteStreamBufferAdapter.cpp
-// \author bocchino
+// \author shahab
 // \brief  cpp file for AsyncByteStreamBufferAdapter component implementation class
 // ======================================================================
 
@@ -12,41 +12,54 @@ namespace Drv {
 // Component construction and destruction
 // ----------------------------------------------------------------------
 
-AsyncByteStreamBufferAdapter::AsyncByteStreamBufferAdapter(const char* const compName)
+AsyncByteStreamBufferAdapter ::AsyncByteStreamBufferAdapter(const char* const compName)
     : AsyncByteStreamBufferAdapterComponentBase(compName) {}
 
-AsyncByteStreamBufferAdapter::~AsyncByteStreamBufferAdapter() {}
+AsyncByteStreamBufferAdapter ::~AsyncByteStreamBufferAdapter() {}
 
 // ----------------------------------------------------------------------
 // Handler implementations for typed input ports
 // ----------------------------------------------------------------------
 
-void AsyncByteStreamBufferAdapter::bufferIn_handler(FwIndexType portNum, Fw::Buffer& fwBuffer) {
-    // TODO: If m_driverIsReady then send fwBuffer on toByteStreamDriver_out
-    // TODO: Otherwise
-    // TODO:   Log the error
-    // TODO:   Send fwBuffer on bufferInReturn_out
+void AsyncByteStreamBufferAdapter ::bufferIn_handler(FwIndexType portNum, Fw::Buffer& fwBuffer) {
+    if (this->m_driverIsReady) {
+        this->toByteStreamDriver_out(portNum, fwBuffer);
+        // ByteStreamDriver is Async; don't return buffer here but wait for toByteStreamDriverReturn
+    } else {
+        // If not ready, log warning and return buffer back immediately
+        this->log_WARNING_LO_DriverNotReady();
+        this->bufferInReturn_out(portNum, fwBuffer);
+    }
 }
 
-void AsyncByteStreamBufferAdapter::bufferOutReturn_handler(FwIndexType portNum, Fw::Buffer& fwBuffer) {
-    // TODO: Send fwBuffer on fromByteStreamDriverReturn_out
+void AsyncByteStreamBufferAdapter ::bufferOutReturn_handler(FwIndexType portNum, Fw::Buffer& fwBuffer) {
+    this->fromByteStreamDriverReturn_out(portNum, fwBuffer);
 }
 
-void AsyncByteStreamBufferAdapter::byteStreamDriverReady_handler(FwIndexType portNum) {
-    this->m_driverIsReady = true;
+void AsyncByteStreamBufferAdapter ::fromByteStreamDriver_handler(FwIndexType portNum,
+                                                                 Fw::Buffer& buffer,
+                                                                 const Drv::ByteStreamStatus& status) {
+    if (status == Drv::ByteStreamStatus::OP_OK) {
+        this->bufferOut_out(portNum, buffer);
+        // buffer ownership will come back through bufferOutReturn so we do **not** return buffer here
+    } else {
+        // If error, log and return buffer back immediately
+        this->log_WARNING_LO_DataReceiveError(status);
+        this->fromByteStreamDriverReturn_out(portNum, buffer);
+    }
 }
 
-void AsyncByteStreamBufferAdapter::fromByteStreamDriver_handler(FwIndexType portNum,
-                                                                Fw::Buffer& buffer,
-                                                                const Drv::ByteStreamStatus& status) {
-    // TODO: If the status is OK, then send buffer on toByteStreamDriver_out
-    // TODO: Otherwise log the error and send buffer on fromByteStreamDriverReturn_out
+void AsyncByteStreamBufferAdapter ::byteStreamDriverReady_handler(FwIndexType portNum) {
+    this->m_driverIsReady = true;
 }
 
-void AsyncByteStreamBufferAdapter::toByteStreamDriverReturn_handler(FwIndexType portNum,
-                                                                    Fw::Buffer& buffer,
-                                                                    const Drv::ByteStreamStatus& status) {
-    // TODO: Send fwBuffer on bufferInReturn_out
+void AsyncByteStreamBufferAdapter ::toByteStreamDriverReturn_handler(FwIndexType portNum,
+                                                                     Fw::Buffer& buffer,
+                                                                     const Drv::ByteStreamStatus& status) {
+    if (status != Drv::ByteStreamStatus::OP_OK) {
+        this->log_WARNING_LO_DataSendError(status);
+    }
+    this->bufferInReturn_out(portNum, buffer);
 }
 
 }  // namespace Drv

Drv/AsyncByteStreamBufferAdapter/AsyncByteStreamBufferAdapter.fpp

@@ -28,6 +28,36 @@ module Drv {
     @ AsyncByteStreamBufferAdapter is a PassiveBufferDriver
     import PassiveBufferDriver
 
+    @ Event port
+    event port Log
+
+    @ Text event port
+    text event port LogText
+
+    @ Time get port
+    time get port Time
+
+    @ Driver Ready
+    event DriverNotReady \
+      severity warning low \
+      id 0 \
+      format "Buffer Driver not ready"
+
+    @Data Send
+    event DataSendError(
+                          stat: I32 
+                        ) \
+      severity warning low \
+      id 1 \
+      format "Data send error status: {}"
+
+    @Data Receive
+    event DataReceiveError(
+                          stat: I32 
+                        ) \
+      severity warning low \
+      id 2 \
+      format "Data reception error status: {}"
   }
 
 }

Drv/AsyncByteStreamBufferAdapter/AsyncByteStreamBufferAdapter.hpp

@@ -1,6 +1,6 @@
 // ======================================================================
 // \title  AsyncByteStreamBufferAdapter.hpp
-// \author bocchino
+// \author shahab
 // \brief  hpp file for AsyncByteStreamBufferAdapter component implementation class
 // ======================================================================
 
@@ -43,10 +43,10 @@ class AsyncByteStreamBufferAdapter final : public AsyncByteStreamBufferAdapterCo
                                  Fw::Buffer& fwBuffer  //!< The buffer
                                  ) override;
 
-    //! Handler implementation for byteStreamDriver
+    //! Handler implementation for byteStreamDriverReady
     //!
     //! Port for receiving ready signals from the driver
-    //! Sample connection: byteStreamDriver.ready -> byteStreamDriverClient.byteStreamReady
+    //! Sample connection: byteStreamDriver.ready -> byteStreamDriverClient.byteStreamDriverReady
     void byteStreamDriverReady_handler(FwIndexType portNum  //!< The port number
                                        ) override;
 
@@ -72,7 +72,7 @@ class AsyncByteStreamBufferAdapter final : public AsyncByteStreamBufferAdapterCo
     // ----------------------------------------------------------------------
 
     //! Whether the driver is ready
-    bool m_driverIsReady = false;
+    std::atomic<bool> m_driverIsReady = {false};
 };
 
 }  // namespace Drv

Drv/AsyncByteStreamBufferAdapter/CMakeLists.txt

@@ -8,3 +8,16 @@ set(MOD_DEPS
 )
 
 register_fprime_module()
+
+set(UT_SOURCE_FILES
+  "${CMAKE_CURRENT_LIST_DIR}/AsyncByteStreamBufferAdapter.fpp"
+  "${CMAKE_CURRENT_LIST_DIR}/test/ut/AsyncByteStreamBufferAdapterTestMain.cpp"
+  "${CMAKE_CURRENT_LIST_DIR}/test/ut/AsyncByteStreamBufferAdapterTester.cpp"
+)
+
+set(UT_MOD_DEPS
+  STest
+)
+
+set(UT_AUTO_HELPERS ON)
+register_fprime_ut()

Drv/AsyncByteStreamBufferAdapter/docs/sdd.md

@@ -0,0 +1,33 @@
+# Drv::AsyncByteStreamBufferAdapter
+
+## 1 Introduction
+
+`AsyncByteStreamBufferAdapter` is a passive F´ component that mediates between the `AsyncByteStreamDriver` interface and the `PassiveBufferDriver` interface. It enables asynchronous byte stream drivers to be used as passive buffer drivers by adapting the interfaces and managing buffer ownership transitions.
+
+The component allows an asynchronous byte stream driver implementation to be transparently used by components that expect a passive buffer driver interface, providing flexibility in topology design.
+
+## 2 Requirements
+
+
+| Name | Description | Validation |
+|------|-------------|------------|
+| DRV-ASYNC-BSB-ADAPTER-001 | The component shall adapt the AsyncByteStreamDriver interface to the PassiveBufferDriver interface | Unit Test |
+| DRV-ASYNC-BSB-ADAPTER-002 | The component shall handle buffer ownership transfers between the two interfaces | Unit Test |
+| DRV-ASYNC-BSB-ADAPTER-003 | The component shall monitor the AsyncByteStreamDriver readiness state | Unit Test |
+| DRV-ASYNC-BSB-ADAPTER-004 | The component shall emit events on error conditions | Unit Test |
+
+## 3 Design
+
+### 3.1 Assumptions
+
+The design of `AsyncByteStreamBufferAdapter` assumes the following:
+
+1. The async byte stream driver will properly signal ready status before accepting data.
+2. Buffer ownership follows the standard Return-To-Sender pattern: buffers are owned by the receiver until returned.
+3. The async byte stream driver operates correctly and returns buffers sent to it when it is done processing.
+
+### 3.2 State
+
+`AsyncByteStreamBufferAdapter` maintains a single state variable:
+
+* **m_driverIsReady**: An atomic boolean flag indicating whether the async byte stream driver is ready to accept data. Initialized to `false` and set to `true` when a ready signal is received from the driver.

Drv/AsyncByteStreamBufferAdapter/test/ut/AsyncByteStreamBufferAdapterTestMain.cpp

@@ -0,0 +1,26 @@
+// ======================================================================
+// \title  AsyncByteStreamBufferAdapterTestMain.cpp
+// \author shahab
+// \brief  cpp file for AsyncByteStreamBufferAdapter component test main function
+// ======================================================================
+
+#include "AsyncByteStreamBufferAdapterTester.hpp"
+
+TEST(Nominal, Test_Stream_out) {
+    Drv::AsyncByteStreamBufferAdapterTester tester;
+    tester.test_byte_stream_out();
+}
+
+TEST(Nominal, Test_Stream_in) {
+    Drv::AsyncByteStreamBufferAdapterTester tester;
+    tester.test_byte_stream_in();
+}
+TEST(Nominal, Test_Stream_Return) {
+    Drv::AsyncByteStreamBufferAdapterTester tester;
+    tester.test_byte_stream_return();
+}
+
+int main(int argc, char** argv) {
+    ::testing::InitGoogleTest(&argc, argv);
+    return RUN_ALL_TESTS();
+}