Issue 4156 generic hub

.github/actions/spelling/expect.txt

@@ -18,7 +18,6 @@ arduino
 ARef
 argcomplete
 ARGN
-binaryfile
 ARINC
 arpa
 ASize
@@ -36,13 +35,15 @@ bfree
 BHn
 bibtex
 Bies
+binaryfile
 BINDIR
 bitmaps
 bitshifts
 bitwidth
 bocchino
 boolt
 bsd
+BSDI
 bst
 BUFFERALLOCATE
 BUFFERALLOCATIONFAILED

Drv/AsyncByteStreamBufferAdapter/AsyncByteStreamBufferAdapter.cpp

@@ -0,0 +1,52 @@
+// ======================================================================
+// \title  AsyncByteStreamBufferAdapter.cpp
+// \author bocchino
+// \brief  cpp file for AsyncByteStreamBufferAdapter component implementation class
+// ======================================================================
+
+#include "Drv/AsyncByteStreamBufferAdapter/AsyncByteStreamBufferAdapter.hpp"
+
+namespace Drv {
+
+// ----------------------------------------------------------------------
+// Component construction and destruction
+// ----------------------------------------------------------------------
+
+AsyncByteStreamBufferAdapter::AsyncByteStreamBufferAdapter(const char* const compName)
+    : AsyncByteStreamBufferAdapterComponentBase(compName) {}
+
+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::bufferOutReturn_handler(FwIndexType portNum, Fw::Buffer& fwBuffer) {
+    // TODO: Send fwBuffer on fromByteStreamDriverReturn_out
+}
+
+void AsyncByteStreamBufferAdapter::byteStreamDriverReady_handler(FwIndexType portNum) {
+    this->m_driverIsReady = true;
+}
+
+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::toByteStreamDriverReturn_handler(FwIndexType portNum,
+                                                                    Fw::Buffer& buffer,
+                                                                    const Drv::ByteStreamStatus& status) {
+    // TODO: Send fwBuffer on bufferInReturn_out
+}
+
+}  // namespace Drv

Drv/AsyncByteStreamBufferAdapter/AsyncByteStreamBufferAdapter.fpp

@@ -0,0 +1,33 @@
+module Drv {
+
+  @ A passive component for mediating between the AsyncByteStreamDriver
+  @ interface and the PassiveBufferDriver interface
+  @
+  @ Sample topology:
+  @
+  @ -----------------------------------------------------------
+  @ |                                                         |
+  @ | AsyncByteStreamDriver <--> AsyncByteStreamBufferAdapter | <--> PassiveBufferDriverClient
+  @ |                                                         |
+  @ -----------------------------------------------------------
+  @
+  @ The two components in the box function together as a PassiveBufferDriver:
+  @
+  @ -------------------------------------------------
+  @ |                                               |
+  @ |             PassiveBufferDriver               | <--> PassiveBufferDriverClient
+  @ |                                               |
+  @ -------------------------------------------------
+  @
+  passive component AsyncByteStreamBufferAdapter {
+
+    @ AsyncByteStreamBufferAdapter is a passive client of the
+    @ AsyncByteStreamDriver interface
+    import PassiveAsyncByteStreamDriverClient
+
+    @ AsyncByteStreamBufferAdapter is a PassiveBufferDriver
+    import PassiveBufferDriver
+
+  }
+
+}

Drv/AsyncByteStreamBufferAdapter/AsyncByteStreamBufferAdapter.hpp

@@ -0,0 +1,80 @@
+// ======================================================================
+// \title  AsyncByteStreamBufferAdapter.hpp
+// \author bocchino
+// \brief  hpp file for AsyncByteStreamBufferAdapter component implementation class
+// ======================================================================
+
+#ifndef Drv_AsyncByteStreamBufferAdapter_HPP
+#define Drv_AsyncByteStreamBufferAdapter_HPP
+
+#include "Drv/AsyncByteStreamBufferAdapter/AsyncByteStreamBufferAdapterComponentAc.hpp"
+
+namespace Drv {
+
+class AsyncByteStreamBufferAdapter final : public AsyncByteStreamBufferAdapterComponentBase {
+  public:
+    // ----------------------------------------------------------------------
+    // Component construction and destruction
+    // ----------------------------------------------------------------------
+
+    //! Construct AsyncByteStreamBufferAdapter object
+    AsyncByteStreamBufferAdapter(const char* const compName  //!< The component name
+    );
+
+    //! Destroy AsyncByteStreamBufferAdapter object
+    ~AsyncByteStreamBufferAdapter();
+
+  private:
+    // ----------------------------------------------------------------------
+    // Handler implementations for typed input ports
+    // ----------------------------------------------------------------------
+
+    //! Handler implementation for bufferIn
+    //!
+    //! Port for receiving buffers
+    void bufferIn_handler(FwIndexType portNum,  //!< The port number
+                          Fw::Buffer& fwBuffer  //!< The buffer
+                          ) override;
+
+    //! Handler implementation for bufferOutReturn
+    //!
+    //! Port for receiving buffers sent on bufferOut and then returned
+    void bufferOutReturn_handler(FwIndexType portNum,  //!< The port number
+                                 Fw::Buffer& fwBuffer  //!< The buffer
+                                 ) override;
+
+    //! Handler implementation for byteStreamDriver
+    //!
+    //! Port for receiving ready signals from the driver
+    //! Sample connection: byteStreamDriver.ready -> byteStreamDriverClient.byteStreamReady
+    void byteStreamDriverReady_handler(FwIndexType portNum  //!< The port number
+                                       ) override;
+
+    //! Handler implementation for fromByteStreamDriver
+    //!
+    //! Port for receiving data from the driver
+    //! Sample connection: byteStreamDriver.$recv -> byteStreamDriverClient.fromDriver
+    void fromByteStreamDriver_handler(FwIndexType portNum,  //!< The port number
+                                      Fw::Buffer& buffer,
+                                      const Drv::ByteStreamStatus& status) override;
+
+    //! Handler implementation for toByteStreamDriverReturn
+    //!
+    //! Port for receiving buffers sent on toByteStreamDriver and then returned
+    //! Sample connection: driver.sendReturnOut -> client.toByteStreamDriverReturn
+    void toByteStreamDriverReturn_handler(FwIndexType portNum,  //!< The port number
+                                          Fw::Buffer& buffer,
+                                          const Drv::ByteStreamStatus& status) override;
+
+  private:
+    // ----------------------------------------------------------------------
+    // Private member variables
+    // ----------------------------------------------------------------------
+
+    //! Whether the driver is ready
+    bool m_driverIsReady = false;
+};
+
+}  // namespace Drv
+
+#endif

Drv/AsyncByteStreamBufferAdapter/CMakeLists.txt

@@ -0,0 +1,10 @@
+set(SOURCE_FILES
+    "${CMAKE_CURRENT_LIST_DIR}/AsyncByteStreamBufferAdapter.fpp"
+    "${CMAKE_CURRENT_LIST_DIR}/AsyncByteStreamBufferAdapter.cpp"
+)
+
+set(MOD_DEPS
+    "Fw/Logger"
+)
+
+register_fprime_module()

Drv/ByteStreamBufferAdapter/ByteStreamBufferAdapter.cpp

@@ -0,0 +1,47 @@
+// ======================================================================
+// \title  ByteStreamBufferAdapter.cpp
+// \author bocchino
+// \brief  cpp file for ByteStreamBufferAdapter component implementation class
+// ======================================================================
+
+#include "Drv/ByteStreamBufferAdapter/ByteStreamBufferAdapter.hpp"
+
+namespace Drv {
+
+// ----------------------------------------------------------------------
+// Component construction and destruction
+// ----------------------------------------------------------------------
+
+ByteStreamBufferAdapter::ByteStreamBufferAdapter(const char* const compName)
+    : ByteStreamBufferAdapterComponentBase(compName) {}
+
+ByteStreamBufferAdapter::~ByteStreamBufferAdapter() {}
+
+// ----------------------------------------------------------------------
+// Handler implementations for typed input ports
+// ----------------------------------------------------------------------
+
+void ByteStreamBufferAdapter::bufferIn_handler(FwIndexType portNum, Fw::Buffer& fwBuffer) {
+    // TODO: If m_driverIsReady then
+    // TODO:   Send fwBuffer on toByteStreamDriver_out
+    // TODO:   Check the return status. If there is an error, then log it to the Logger.
+    // TODO: Otherwise log the error
+    // TODO: Send fwBuffer on bufferInReturn_out
+}
+
+void ByteStreamBufferAdapter::bufferOutReturn_handler(FwIndexType portNum, Fw::Buffer& fwBuffer) {
+    // TODO: Send fwBuffer on fromByteStreamDriverReturn_out
+}
+
+void ByteStreamBufferAdapter::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 ByteStreamBufferAdapter::byteStreamDriverReady_handler(FwIndexType portNum) {
+    this->m_driverIsReady = true;
+}
+
+}  // namespace Drv

Drv/ByteStreamBufferAdapter/ByteStreamBufferAdapter.fpp

@@ -0,0 +1,33 @@
+module Drv {
+
+  @ A passive component for mediating between the ByteStreamDriver
+  @ interface and the PassiveBufferDriver interface
+  @
+  @ Sample topology:
+  @
+  @ -------------------------------------------------
+  @ |                                               |
+  @ | ByteStreamDriver <--> ByteStreamBufferAdapter | <--> PassiveBufferDriverClient
+  @ |                                               |
+  @ -------------------------------------------------
+  @
+  @ The two components in the box function together as a PassiveBufferDriver:
+  @
+  @ -------------------------------------------------
+  @ |                                               |
+  @ |             PassiveBufferDriver               | <--> PassiveBufferDriverClient
+  @ |                                               |
+  @ -------------------------------------------------
+  @
+  passive component ByteStreamBufferAdapter {
+
+    @ ByteStreamBufferAdapter is a passive client of the ByteStreamDriver
+    @ interface
+    import PassiveByteStreamDriverClient
+
+    @ ByteStreamBufferAdapter is a PassiveBufferDriver
+    import PassiveBufferDriver
+
+  }
+
+}

Drv/ByteStreamBufferAdapter/ByteStreamBufferAdapter.hpp

@@ -0,0 +1,72 @@
+// ======================================================================
+// \title  ByteStreamBufferAdapter.hpp
+// \author bocchino
+// \brief  hpp file for ByteStreamBufferAdapter component implementation class
+// ======================================================================
+
+#ifndef Drv_ByteStreamBufferAdapter_HPP
+#define Drv_ByteStreamBufferAdapter_HPP
+
+#include "Drv/ByteStreamBufferAdapter/ByteStreamBufferAdapterComponentAc.hpp"
+
+namespace Drv {
+
+class ByteStreamBufferAdapter final : public ByteStreamBufferAdapterComponentBase {
+  public:
+    // ----------------------------------------------------------------------
+    // Component construction and destruction
+    // ----------------------------------------------------------------------
+
+    //! Construct ByteStreamBufferAdapter object
+    ByteStreamBufferAdapter(const char* const compName  //!< The component name
+    );
+
+    //! Destroy ByteStreamBufferAdapter object
+    ~ByteStreamBufferAdapter();
+
+  private:
+    // ----------------------------------------------------------------------
+    // Handler implementations for typed input ports
+    // ----------------------------------------------------------------------
+
+    //! Handler implementation for bufferIn
+    //!
+    //! Port for receiving buffers
+    void bufferIn_handler(FwIndexType portNum,  //!< The port number
+                          Fw::Buffer& fwBuffer  //!< The buffer
+                          ) override;
+
+    //! Handler implementation for bufferOutReturn
+    //!
+    //! Port for receiving buffers sent on bufferOut and then returned
+    void bufferOutReturn_handler(FwIndexType portNum,  //!< The port number
+                                 Fw::Buffer& fwBuffer  //!< The buffer
+                                 ) override;
+
+    //! Handler implementation for byteStreamIn
+    //!
+    //! Port for receiving data from the driver
+    //! Sample connection: byteStreamDriver.$recv -> byteStreamDriverClient.byteStreamIn
+    void fromByteStreamDriver_handler(FwIndexType portNum,  //!< The port number
+                                      Fw::Buffer& buffer,
+                                      const Drv::ByteStreamStatus& status) override;
+
+    //! Handler implementation for byteStreamReady
+    //!
+    //! Port for receiving ready signals from the driver
+    //! Sample connection: byteStreamDriver.ready -> byteStreamDriverClient.byteStreamDriverReady
+    void byteStreamDriverReady_handler(FwIndexType portNum  //!< The port number
+                                       ) override;
+
+  private:
+    // ----------------------------------------------------------------------
+    // Private member variables
+    // ----------------------------------------------------------------------
+
+    //! Whether the driver is ready
+    bool m_driverIsReady = false;
+};
+
+}  // namespace Drv
+
+#endif

Drv/ByteStreamBufferAdapter/CMakeLists.txt

@@ -0,0 +1,10 @@
+set(SOURCE_FILES
+    "${CMAKE_CURRENT_LIST_DIR}/ByteStreamBufferAdapter.fpp"
+    "${CMAKE_CURRENT_LIST_DIR}/ByteStreamBufferAdapter.cpp"
+)
+
+set(MOD_DEPS
+    "Fw/Logger"
+)
+
+register_fprime_module()

Drv/CMakeLists.txt

@@ -5,11 +5,13 @@ add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Interfaces/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Ports/")
 
 # Components
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/AsyncByteStreamBufferAdapter/")
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/ByteStreamBufferAdapter/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/ByteStreamDriverModel/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/LinuxGpioDriver/")
-add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/LinuxUartDriver/")
-add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/LinuxSpiDriver/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/LinuxI2cDriver/")
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/LinuxSpiDriver/")
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/LinuxUartDriver/")
 
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Ip/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/TcpClient/")

Drv/Interfaces/CMakeLists.txt

@@ -12,6 +12,11 @@ register_fprime_module(
     "${CMAKE_CURRENT_LIST_DIR}/ByteStreamDriver.fpp"
     "${CMAKE_CURRENT_LIST_DIR}/Gpio.fpp"
     "${CMAKE_CURRENT_LIST_DIR}/I2c.fpp"
+    "${CMAKE_CURRENT_LIST_DIR}/PassiveAsyncByteStreamDriverClient.fpp"
+    "${CMAKE_CURRENT_LIST_DIR}/PassiveBufferDriver.fpp"
+    "${CMAKE_CURRENT_LIST_DIR}/PassiveBufferDriverClient.fpp"
+    "${CMAKE_CURRENT_LIST_DIR}/PassiveByteStreamDriverClient.fpp"
+    "${CMAKE_CURRENT_LIST_DIR}/PassiveByteStreamDriverClientReadyRecv.fpp"
     "${CMAKE_CURRENT_LIST_DIR}/Spi.fpp"
     "${CMAKE_CURRENT_LIST_DIR}/Tick.fpp"
   INTERFACE