Converting ByteStreamDriverModel into an interface

Drv/ByteStreamDriverModel/ByteStreamDriverPorts.fpp

@@ -0,0 +1,39 @@
+module Drv {
+
+    @ Status returned by the send call
+    enum SendStatus {
+        SEND_OK = 0 @< Send worked as expected
+        SEND_RETRY = 1 @< Data send should be retried
+        SEND_ERROR = 2 @< Send error occurred retrying may succeed
+    }
+
+    @ Send data out through the byte stream
+    port ByteStreamSend(
+        ref sendBuffer: Fw.Buffer @< Data to send
+    ) -> SendStatus
+
+    @ Status associated with the received data
+    enum RecvStatus {
+        RECV_OK = 0 @< Receive worked as expected
+        RECV_ERROR = 1 @< Receive error occurred retrying may succeed
+    }
+
+    @ Carries the received bytes stream driver
+    port ByteStreamRecv(
+        ref recvBuffer: Fw.Buffer
+        recvStatus: RecvStatus
+    )
+
+    enum PollStatus {
+        POLL_OK = 0 @< Poll successfully received data
+        POLL_RETRY = 1 @< No data available, retry later
+        POLL_ERROR = 2 @< Error received when polling
+    }
+
+    port ByteStreamPoll(
+        ref pollBuffer: Fw.Buffer
+    ) -> PollStatus
+
+    @ Signal indicating the driver is ready to send and received data
+    port ByteStreamReady()
+}

Drv/ByteStreamDriverModel/CMakeLists.txt

@@ -6,7 +6,7 @@
 #
 ####
 set(SOURCE_FILES
-    "${CMAKE_CURRENT_LIST_DIR}/ByteStreamDriverModel.fpp"
+    "${CMAKE_CURRENT_LIST_DIR}/ByteStreamDriverPorts.fpp"
 )
 
 register_fprime_module()

Drv/Interfaces/ByteStreamDriverInterface.fppi

@@ -0,0 +1,8 @@
+    @ Port invoked when the driver is ready to send/receive data
+    output port ready: Drv.ByteStreamReady
+
+    @ Port invoked when driver has received data
+    output port $recv: Drv.ByteStreamRecv
+
+    @ Port invoked to send data out the driver
+    guarded input port send: Drv.ByteStreamSend

Drv/LinuxUartDriver/LinuxUartDriver.fpp

@@ -6,14 +6,7 @@ module Drv {
     # General ports
     # ----------------------------------------------------------------------
 
-    @ Indicates the driver has connected to the UART device
-    output port ready: Drv.ByteStreamReady
-
-    @ Produces data received via the UART device on the receive task
-    output port $recv: Drv.ByteStreamRecv
-
-    @ Takes data to transmit out the UART device
-    guarded input port send: Drv.ByteStreamSend
+    include "../Interfaces/ByteStreamDriverInterface.fppi"
 
     @ Allocation port used for allocating memory in the receive task
     output port allocate: Fw.BufferGet

Drv/TcpClient/CMakeLists.txt

@@ -6,7 +6,7 @@
 #
 ####
 set(SOURCE_FILES
-	"${CMAKE_CURRENT_LIST_DIR}/../ByteStreamDriverModel/ByteStreamDriverModel.fpp"
+	"${CMAKE_CURRENT_LIST_DIR}/TcpClient.fpp"
 	"${CMAKE_CURRENT_LIST_DIR}/TcpClientComponentImpl.cpp"
 )
 
@@ -21,7 +21,7 @@ register_fprime_module()
 
 ### UTs ###
 set(UT_SOURCE_FILES
-	"${CMAKE_CURRENT_LIST_DIR}/../ByteStreamDriverModel/ByteStreamDriverModel.fpp"
+	"${CMAKE_CURRENT_LIST_DIR}/TcpClient.fpp"
 	"${CMAKE_CURRENT_LIST_DIR}/test/ut/TestMain.cpp"
 	"${CMAKE_CURRENT_LIST_DIR}/test/ut/Tester.cpp"
 )

Drv/TcpClient/TcpClient.fpp

@@ -0,0 +1,11 @@
+module Drv {
+    passive component TcpClient {
+
+        include "../Interfaces/ByteStreamDriverInterface.fppi"
+
+        output port allocate: Fw.BufferGet
+
+        output port deallocate: Fw.BufferSend
+
+    }
+}

Drv/TcpClient/TcpClientComponentImpl.cpp

@@ -22,13 +22,9 @@ namespace Drv {
 // ----------------------------------------------------------------------
 
 TcpClientComponentImpl::TcpClientComponentImpl(const char* const compName)
-    : ByteStreamDriverModelComponentBase(compName),
+    : TcpClientComponentBase(compName),
       SocketReadTask() {}
 
-void TcpClientComponentImpl::init(const NATIVE_INT_TYPE instance) {
-    ByteStreamDriverModelComponentBase::init(instance);
-}
-
 SocketIpStatus TcpClientComponentImpl::configure(const char* hostname,
                                                  const U16 port,
                                                  const U32 send_timeout_seconds,
@@ -79,9 +75,4 @@ Drv::SendStatus TcpClientComponentImpl::send_handler(const NATIVE_INT_TYPE portN
     return SendStatus::SEND_OK;
 }
 
-Drv::PollStatus TcpClientComponentImpl::poll_handler(const NATIVE_INT_TYPE portNum, Fw::Buffer& fwBuffer) {
-    FW_ASSERT(0); // It is an error to call this handler on IP drivers
-    return PollStatus::POLL_ERROR;
-}
-
 }  // end namespace Drv

Drv/TcpClient/TcpClientComponentImpl.hpp

@@ -16,11 +16,11 @@
 #include <Drv/Ip/IpSocket.hpp>
 #include <Drv/Ip/SocketReadTask.hpp>
 #include <Drv/Ip/TcpClientSocket.hpp>
-#include "Drv/ByteStreamDriverModel/ByteStreamDriverModelComponentAc.hpp"
+#include "Drv/TcpClient/TcpClientComponentAc.hpp"
 
 namespace Drv {
 
-class TcpClientComponentImpl : public ByteStreamDriverModelComponentBase, public SocketReadTask {
+class TcpClientComponentImpl : public TcpClientComponentBase, public SocketReadTask {
   public:
     // ----------------------------------------------------------------------
     // Construction, initialization, and destruction
@@ -32,13 +32,6 @@ class TcpClientComponentImpl : public ByteStreamDriverModelComponentBase, public
      */
     TcpClientComponentImpl(const char* const compName);
 
-
-    /**
-     * \brief Initialize this component
-     * \param instance: instance number of this component
-     */
-    void init(const NATIVE_INT_TYPE instance = 0);
-
     /**
      * \brief Destroy the component
      */
@@ -132,13 +125,6 @@ class TcpClientComponentImpl : public ByteStreamDriverModelComponentBase, public
      */
     Drv::SendStatus send_handler(const NATIVE_INT_TYPE portNum, Fw::Buffer& fwBuffer);
 
-    /**
-     * \brief **not supported**
-     *
-     * IP based ByteStreamDrivers don't support polling.
-     */
-    Drv::PollStatus poll_handler(const NATIVE_INT_TYPE portNum, Fw::Buffer& fwBuffer);
-
     Drv::TcpClientSocket m_socket; //!< Socket implementation
 };
 

Drv/TcpServer/CMakeLists.txt

@@ -6,7 +6,7 @@
 #
 ####
 set(SOURCE_FILES
-	"${CMAKE_CURRENT_LIST_DIR}/../ByteStreamDriverModel/ByteStreamDriverModel.fpp"
+	"${CMAKE_CURRENT_LIST_DIR}/TcpServer.fpp"
 	"${CMAKE_CURRENT_LIST_DIR}/TcpServerComponentImpl.cpp"
 )
 
@@ -21,7 +21,7 @@ register_fprime_module()
 
 ### UTs ###
 set(UT_SOURCE_FILES
-	"${CMAKE_CURRENT_LIST_DIR}/../ByteStreamDriverModel/ByteStreamDriverModel.fpp"
+	"${CMAKE_CURRENT_LIST_DIR}/TcpServer.fpp"
 	"${CMAKE_CURRENT_LIST_DIR}/test/ut/TestMain.cpp"
 	"${CMAKE_CURRENT_LIST_DIR}/test/ut/Tester.cpp"
 )

Drv/TcpServer/TcpServer.fpp

@@ -0,0 +1,11 @@
+module Drv {
+    passive component TcpServer {
+
+        include "../Interfaces/ByteStreamDriverInterface.fppi"
+
+        output port allocate: Fw.BufferGet
+
+        output port deallocate: Fw.BufferSend
+
+    }
+}

Drv/TcpServer/TcpServerComponentImpl.cpp

@@ -21,13 +21,9 @@ namespace Drv {
 // ----------------------------------------------------------------------
 
 TcpServerComponentImpl::TcpServerComponentImpl(const char* const compName)
-    : ByteStreamDriverModelComponentBase(compName),
+    : TcpServerComponentBase(compName),
       SocketReadTask() {}
 
-void TcpServerComponentImpl::init(const NATIVE_INT_TYPE instance) {
-    ByteStreamDriverModelComponentBase::init(instance);
-}
-
 SocketIpStatus TcpServerComponentImpl::configure(const char* hostname,
                                                  const U16 port,
                                                  const U32 send_timeout_seconds,
@@ -86,9 +82,4 @@ Drv::SendStatus TcpServerComponentImpl::send_handler(const NATIVE_INT_TYPE portN
     return SendStatus::SEND_OK;
 }
 
-Drv::PollStatus TcpServerComponentImpl::poll_handler(const NATIVE_INT_TYPE portNum, Fw::Buffer& fwBuffer) {
-    FW_ASSERT(0); // It is an error to call this handler on IP drivers
-    return PollStatus::POLL_ERROR;
-}
-
 }  // end namespace Drv

Drv/TcpServer/TcpServerComponentImpl.hpp

@@ -17,11 +17,11 @@
 #include <Drv/Ip/IpSocket.hpp>
 #include <Drv/Ip/SocketReadTask.hpp>
 #include <Drv/Ip/TcpServerSocket.hpp>
-#include "Drv/ByteStreamDriverModel/ByteStreamDriverModelComponentAc.hpp"
+#include "Drv/TcpServer/TcpServerComponentAc.hpp"
 
 namespace Drv {
 
-class TcpServerComponentImpl : public ByteStreamDriverModelComponentBase, public SocketReadTask {
+class TcpServerComponentImpl : public TcpServerComponentBase, public SocketReadTask {
   public:
     // ----------------------------------------------------------------------
     // Construction, initialization, and destruction
@@ -33,13 +33,6 @@ class TcpServerComponentImpl : public ByteStreamDriverModelComponentBase, public
      */
     TcpServerComponentImpl(const char* const compName);
 
-
-    /**
-     * \brief Initialize this component
-     * \param instance: instance number of this component
-     */
-    void init(const NATIVE_INT_TYPE instance = 0);
-
     /**
      * \brief Destroy the component
      */
@@ -152,13 +145,6 @@ class TcpServerComponentImpl : public ByteStreamDriverModelComponentBase, public
      */
     Drv::SendStatus send_handler(const NATIVE_INT_TYPE portNum, Fw::Buffer& fwBuffer);
 
-    /**
-     * \brief **not supported**
-     *
-     * IP based ByteStreamDrivers don't support polling.
-     */
-    Drv::PollStatus poll_handler(const NATIVE_INT_TYPE portNum, Fw::Buffer& fwBuffer);
-
     Drv::TcpServerSocket m_socket; //!< Socket implementation
 };
 

Drv/Udp/CMakeLists.txt

@@ -6,7 +6,7 @@
 #
 ####
 set(SOURCE_FILES
-	"${CMAKE_CURRENT_LIST_DIR}/../ByteStreamDriverModel/ByteStreamDriverModel.fpp"
+	"${CMAKE_CURRENT_LIST_DIR}/Udp.fpp"
 	"${CMAKE_CURRENT_LIST_DIR}/UdpComponentImpl.cpp"
 )
 
@@ -21,7 +21,7 @@ register_fprime_module()
 
 ### UTs ###
 set(UT_SOURCE_FILES
-	"${CMAKE_CURRENT_LIST_DIR}/../ByteStreamDriverModel/ByteStreamDriverModel.fpp"
+	"${CMAKE_CURRENT_LIST_DIR}/Udp.fpp"
 	"${CMAKE_CURRENT_LIST_DIR}/test/ut/TestMain.cpp"
 	"${CMAKE_CURRENT_LIST_DIR}/test/ut/Tester.cpp"
 )

Drv/Udp/Udp.fpp

@@ -0,0 +1,11 @@
+module Drv {
+    passive component Udp {
+
+        include "../Interfaces/ByteStreamDriverInterface.fppi"
+
+        output port allocate: Fw.BufferGet
+
+        output port deallocate: Fw.BufferSend
+
+    }
+}

Drv/Udp/Udp.hpp

@@ -0,0 +1,17 @@
+// ======================================================================
+// Udp.hpp
+// Standardization header for Udp
+// ======================================================================
+
+#ifndef Drv_Udp_HPP
+#define Drv_Udp_HPP
+
+#include "Drv/Udp/UdpComponentImpl.hpp"
+
+namespace Drv {
+
+  typedef UdpComponentImpl Udp;
+
+}
+
+#endif

Drv/Udp/UdpComponentImpl.cpp

@@ -23,13 +23,9 @@ namespace Drv {
 // ----------------------------------------------------------------------
 
 UdpComponentImpl::UdpComponentImpl(const char* const compName)
-    : ByteStreamDriverModelComponentBase(compName),
+    : UdpComponentBase(compName),
       SocketReadTask() {}
 
-void UdpComponentImpl::init(const NATIVE_INT_TYPE instance) {
-    ByteStreamDriverModelComponentBase::init(instance);
-}
-
 SocketIpStatus UdpComponentImpl::configureSend(const char* hostname,
                                                  const U16 port,
                                                  const U32 send_timeout_seconds,
@@ -82,9 +78,4 @@ Drv::SendStatus UdpComponentImpl::send_handler(const NATIVE_INT_TYPE portNum, Fw
     return SendStatus::SEND_OK;
 }
 
-Drv::PollStatus UdpComponentImpl::poll_handler(const NATIVE_INT_TYPE portNum, Fw::Buffer& fwBuffer) {
-    FW_ASSERT(0); // It is an error to call this handler on IP drivers
-    return PollStatus::POLL_ERROR;
-}
-
 }  // end namespace Drv