Upgrade to fprime4 (#46)

ethancheez · kevin-f-ortega · Kevin F Ortega · web-flow · commit f86dfb47c66a · 2025-08-11T17:08:44.000-07:00
* using import interfaces

* added missing namespace

* more upgrades to fprime4

* More upgrades for fprime v4.0.0

---------

Co-authored-by: Kevin F. Ortega &lt;kevin.f.ortega@gmail.com&gt;
Co-authored-by: Kevin F Ortega &lt;ortega@fprime-fsw-1.jpl.nasa.gov&gt;
diff --git a/Arduino/Drv/AnalogDriver/AnalogDriver.cpp b/Arduino/Drv/AnalogDriver/AnalogDriver.cpp
@@ -5,7 +5,7 @@
 // ======================================================================
 
 #include <Arduino/Drv/AnalogDriver/AnalogDriver.hpp>
-#include <config/FprimeArduino.hpp>
+#include <Arduino/config/FprimeArduino.hpp>
 
 namespace Arduino {
 
diff --git a/Arduino/Drv/GpioDriver/GpioDriver.cpp b/Arduino/Drv/GpioDriver/GpioDriver.cpp
@@ -6,7 +6,7 @@
 
 #include <Arduino/Drv/GpioDriver/GpioDriver.hpp>
 #include <config/FpConfig.hpp>
-#include <config/FprimeArduino.hpp>
+#include <Arduino/config/FprimeArduino.hpp>
 
 namespace Arduino {
 
diff --git a/Arduino/Drv/HardwareRateDriver/HardwareRateDriver.cpp b/Arduino/Drv/HardwareRateDriver/HardwareRateDriver.cpp
@@ -1,7 +1,7 @@
 #include <Arduino/Drv/HardwareRateDriver/HardwareRateDriver.hpp>
 #include <config/FpConfig.hpp>
 #ifdef ARDUINO
-#include <config/FprimeArduino.hpp>  // Needed for call to sei()
+#include <Arduino/config/FprimeArduino.hpp>  // Needed for call to sei()
 #endif
 
 namespace Arduino {
diff --git a/Arduino/Drv/HardwareRateDriver/HardwareRateDriverBasic.cpp b/Arduino/Drv/HardwareRateDriver/HardwareRateDriverBasic.cpp
@@ -1,7 +1,7 @@
 #include <config/FpConfig.hpp>
 #include <Arduino/Drv/HardwareRateDriver/HardwareRateDriver.hpp>
 #include <Fw/Logger/Logger.hpp>
-#include <config/FprimeArduino.hpp>
+#include <Arduino/config/FprimeArduino.hpp>
 
 namespace Arduino {
 static U32 last_us;
diff --git a/Arduino/Drv/HardwareRateDriver/HardwareRateDriverTeensy.cpp b/Arduino/Drv/HardwareRateDriver/HardwareRateDriverTeensy.cpp
@@ -1,6 +1,6 @@
 #include <IntervalTimer.h>
 #include <Arduino/Drv/HardwareRateDriver/HardwareRateDriver.hpp>
-#include <config/FprimeArduino.hpp>
+#include <Arduino/config/FprimeArduino.hpp>
 #include <Fw/Logger/Logger.hpp>
 
 namespace Arduino {
diff --git a/Arduino/Drv/I2cDriver/I2cDriver.hpp b/Arduino/Drv/I2cDriver/I2cDriver.hpp
@@ -8,7 +8,7 @@
 #define I2cDriver_HPP
 
 #include "Arduino/Drv/I2cDriver/I2cDriverComponentAc.hpp"
-#include <config/FprimeArduino.hpp>
+#include <Arduino/config/FprimeArduino.hpp>
 #include <Wire.h>
 
 namespace Arduino {
@@ -36,7 +36,7 @@ namespace Arduino {
       //!
       ~I2cDriver();
 
-    PRIVATE:
+    private:
 
       //! Read the actual data
       Drv::I2cStatus read_data(U32 addr, Fw::Buffer& fwBuffer);
diff --git a/Arduino/Drv/I2cNodeDriver/I2cNodeDriver.hpp b/Arduino/Drv/I2cNodeDriver/I2cNodeDriver.hpp
@@ -8,7 +8,7 @@
 #define Arduino_I2cNodeDriver_HPP
 
 #include <Wire.h>
-#include <config/FprimeArduino.hpp>
+#include <Arduino/config/FprimeArduino.hpp>
 #include "Arduino/Drv/I2cNodeDriver/I2cNodeDriverComponentAc.hpp"
 
 namespace Arduino {
diff --git a/Arduino/Drv/PwmDriver/PwmDriver.cpp b/Arduino/Drv/PwmDriver/PwmDriver.cpp
@@ -5,7 +5,7 @@
 // ======================================================================
 
 #include <Arduino/Drv/PwmDriver/PwmDriver.hpp>
-#include <config/FprimeArduino.hpp>
+#include <Arduino/config/FprimeArduino.hpp>
 
 namespace Arduino {
 
diff --git a/Arduino/Drv/SpiDriver/SpiDriverArduino.cpp b/Arduino/Drv/SpiDriver/SpiDriverArduino.cpp
@@ -5,7 +5,7 @@
 // ======================================================================
 
 #include <Arduino/Drv/SpiDriver/SpiDriver.hpp>
-#include <config/FprimeArduino.hpp>
+#include <Arduino/config/FprimeArduino.hpp>
 #include "Fw/Types/Assert.hpp"
 
 namespace Arduino {
diff --git a/Arduino/Drv/StreamDriver/StreamDriver.cpp b/Arduino/Drv/StreamDriver/StreamDriver.cpp
@@ -26,9 +26,8 @@ void StreamDriver::recvReturnIn_handler(FwIndexType portNum, Fw::Buffer& fwBuffe
     this->deallocate_out(0, fwBuffer);
 }
 
-void StreamDriver ::send_handler(const FwIndexType portNum, Fw::Buffer& serBuffer) {
-    write_data(serBuffer);
-    sendReturnOut_out(0, serBuffer, Drv::ByteStreamStatus::OP_OK);
+Drv::ByteStreamStatus StreamDriver ::send_handler(const FwIndexType portNum, Fw::Buffer& serBuffer) {
+    return write_data(serBuffer);
 }
 
 void StreamDriver ::schedIn_handler(const FwIndexType portNum, U32 context) {
diff --git a/Arduino/Drv/StreamDriver/StreamDriver.fpp b/Arduino/Drv/StreamDriver/StreamDriver.fpp
@@ -11,7 +11,6 @@ module Arduino {
     @ Deallocation of allocated buffers
     output port deallocate: Fw.BufferSend
 
-    @ TODO: Update once interfaces are fully supported in fpp
-    include "../../../../fprime/Drv/Interfaces/ByteStreamDriverInterface.fppi"
+    import Drv.ByteStreamDriver
   }
 }
diff --git a/Arduino/Drv/StreamDriver/StreamDriver.hpp b/Arduino/Drv/StreamDriver/StreamDriver.hpp
@@ -7,7 +7,7 @@
 #ifndef StreamDriver_HPP
 #define StreamDriver_HPP
 
-#include <config/FprimeArduino.hpp>
+#include <Arduino/config/FprimeArduino.hpp>
 #include "Arduino/Drv/StreamDriver/StreamDriverComponentAc.hpp"
 #include "Os/Task.hpp"
 
@@ -41,7 +41,7 @@ class StreamDriver : public StreamDriverComponentBase {
     //! Read the actual data
     void read_data(Fw::Buffer& fwBuffer);
     //! Write the actual data
-    void write_data(Fw::Buffer& serBuffer);
+    Drv::ByteStreamStatus write_data(Fw::Buffer& serBuffer);
     // ----------------------------------------------------------------------
     // Handler implementations for user-defined typed input ports
     // ----------------------------------------------------------------------
@@ -52,8 +52,8 @@ class StreamDriver : public StreamDriverComponentBase {
 
     //! Handler implementation for send
     //!
-    void send_handler(const FwIndexType portNum, /*!< The port number*/
-                      Fw::Buffer& fwBuffer) override;
+    Drv::ByteStreamStatus send_handler(const FwIndexType portNum, /*!< The port number*/
+                                       Fw::Buffer& fwBuffer) override;
 
     //! Handler implementation for schedIn
     //!
diff --git a/Arduino/Drv/StreamDriver/StreamDriverArduino.cpp b/Arduino/Drv/StreamDriver/StreamDriverArduino.cpp
@@ -5,7 +5,7 @@
 // ======================================================================
 
 #include <Arduino/Drv/StreamDriver/StreamDriver.hpp>
-#include <config/FprimeArduino.hpp>
+#include <Arduino/config/FprimeArduino.hpp>
 #include "Fw/Types/Assert.hpp"
 #include "Fw/Types/BasicTypes.hpp"
 
@@ -23,9 +23,10 @@ void StreamDriver::configure(Stream* streamDriver) {
 // Handler implementations for user-defined typed input ports
 // ----------------------------------------------------------------------
 
-void StreamDriver ::write_data(Fw::Buffer& fwBuffer) {
+Drv::ByteStreamStatus StreamDriver ::write_data(Fw::Buffer& fwBuffer) {
     FW_ASSERT(m_port_pointer != 0);
-    reinterpret_cast<Stream*>(m_port_pointer)->write(reinterpret_cast<U8*>(fwBuffer.getData()), fwBuffer.getSize());
+    size_t bytes_written = reinterpret_cast<Stream*>(m_port_pointer)->write(reinterpret_cast<U8*>(fwBuffer.getData()), fwBuffer.getSize());
+    return (bytes_written == fwBuffer.getSize()) ? Drv::ByteStreamStatus::OP_OK : Drv::ByteStreamStatus::OTHER_ERROR;
 }
 
 void StreamDriver ::read_data(Fw::Buffer& fwBuffer) {
diff --git a/Arduino/Drv/TcpClient/TcpClient.cpp b/Arduino/Drv/TcpClient/TcpClient.cpp
@@ -24,7 +24,7 @@ void TcpClient ::schedIn_handler(const FwIndexType portNum, U32 context) {
 // Handler implementations for user-defined typed input ports
 // ----------------------------------------------------------------------
 
-void TcpClient::send_handler(const FwIndexType portNum, Fw::Buffer& fwBuffer) {
+Drv::ByteStreamStatus TcpClient::send_handler(const FwIndexType portNum, Fw::Buffer& fwBuffer) {
     SocketIpStatus status = this->send(fwBuffer.getData(), fwBuffer.getSize());
     Drv::ByteStreamStatus returnStatus;
     switch (status) {
@@ -38,8 +38,7 @@ void TcpClient::send_handler(const FwIndexType portNum, Fw::Buffer& fwBuffer) {
             returnStatus = Drv::ByteStreamStatus::OTHER_ERROR;
             break;
     }
-    // Return the buffer and status to the caller
-    this->sendReturnOut_out(0, fwBuffer, returnStatus);
+    return returnStatus;
 }
 
 void TcpClient::recvReturnIn_handler(FwIndexType portNum, Fw::Buffer& fwBuffer) {
diff --git a/Arduino/Drv/TcpClient/TcpClient.fpp b/Arduino/Drv/TcpClient/TcpClient.fpp
@@ -2,7 +2,7 @@ module Arduino {
     @ TcpClient for Arduino board with WiFi support
     passive component TcpClient {
 
-        include "../../../../fprime/Drv/Interfaces/ByteStreamDriverInterface.fppi"
+        import Drv.ByteStreamDriver
 
         @ Allocation for received data
         output port allocate: Fw.BufferGet
@@ -14,4 +14,4 @@ module Arduino {
         sync input port schedIn: Svc.Sched
 
     }
-}
+}
diff --git a/Arduino/Drv/TcpClient/TcpClient.hpp b/Arduino/Drv/TcpClient/TcpClient.hpp
@@ -76,7 +76,7 @@ class TcpClient : public TcpClientComponentBase {
      * \param portNum: fprime port number of the incoming port call
      * \param fwBuffer: buffer containing data to be sent
      */
-    void send_handler(const FwIndexType portNum, Fw::Buffer& fwBuffer) override;
+    Drv::ByteStreamStatus send_handler(const FwIndexType portNum, Fw::Buffer& fwBuffer) override;
 
     //! Handler implementation for recvReturnIn
     //!
diff --git a/Arduino/Drv/TcpServer/TcpServer.cpp b/Arduino/Drv/TcpServer/TcpServer.cpp
@@ -24,7 +24,7 @@ void TcpServer ::recvReturnIn_handler(FwIndexType portNum, Fw::Buffer& fwBuffer)
     this->deallocate_out(0, fwBuffer);
 }
 
-void TcpServer ::send_handler(FwIndexType portNum, Fw::Buffer& fwBuffer) {
+Drv::ByteStreamStatus TcpServer ::send_handler(FwIndexType portNum, Fw::Buffer& fwBuffer) {
     SocketIpStatus status = this->send(fwBuffer.getData(), fwBuffer.getSize());
     Drv::ByteStreamStatus returnStatus;
     switch (status) {
@@ -35,8 +35,7 @@ void TcpServer ::send_handler(FwIndexType portNum, Fw::Buffer& fwBuffer) {
             returnStatus = Drv::ByteStreamStatus::OTHER_ERROR;
             break;
     }
-    // Return the buffer and status to the caller
-    this->sendReturnOut_out(0, fwBuffer, returnStatus);
+    return returnStatus;
 }
 
 void TcpServer ::schedIn_handler(const FwIndexType portNum, U32 context) {
diff --git a/Arduino/Drv/TcpServer/TcpServer.fpp b/Arduino/Drv/TcpServer/TcpServer.fpp
@@ -2,7 +2,7 @@ module Arduino {
     @ TCP Server for Arduino board with WiFi support
     passive component TcpServer {
 
-        include "../../../../fprime/Drv/Interfaces/ByteStreamDriverInterface.fppi"
+        import Drv.ByteStreamDriver
 
         @ Allocation for received data
         output port allocate: Fw.BufferGet
diff --git a/Arduino/Drv/TcpServer/TcpServer.hpp b/Arduino/Drv/TcpServer/TcpServer.hpp
@@ -53,9 +53,9 @@ class TcpServer final : public TcpServerComponentBase {
     //! Handler implementation for send
     //!
     //! Invoke this port to send data out the driver
-    void send_handler(FwIndexType portNum,  //!< The port number
-                      Fw::Buffer& fwBuffer  //!< The buffer
-                      ) override;
+    Drv::ByteStreamStatus send_handler(FwIndexType portNum,  //!< The port number
+                                       Fw::Buffer& fwBuffer  //!< The buffer
+                                       ) override;
 
     //! Handler implementation for schedIn
     //!
diff --git a/Arduino/Os/Console.hpp b/Arduino/Os/Console.hpp
@@ -5,7 +5,7 @@
 #ifndef OS_Stub_Console_HPP
 #define OS_Stub_Console_HPP
 #include <Os/Console.hpp>
-#include <config/FprimeArduino.hpp>
+#include <Arduino/config/FprimeArduino.hpp>
 namespace Os {
 namespace Arduino {
 
diff --git a/Arduino/Os/RawTime.cpp b/Arduino/Os/RawTime.cpp
@@ -3,7 +3,7 @@
 // \brief stub implementation for Os::RawTime
 // ======================================================================
 #include "Arduino/Os/RawTime.hpp"
-#include "config/FprimeArduino.hpp"
+#include "Arduino/config/FprimeArduino.hpp"
 namespace Os {
 namespace Arduino {
 
@@ -47,7 +47,7 @@ RawTime::Status ArduinoRawTime::getTimeInterval(const Os::RawTime& other, Fw::Ti
     return Status::OP_OK;
 }
 
-Fw::SerializeStatus ArduinoRawTime::serialize(Fw::SerializeBufferBase& buffer) const {
+Fw::SerializeStatus ArduinoRawTime::serializeTo(Fw::SerializeBufferBase& buffer) const {
     Fw::SerializeStatus status = Fw::SerializeStatus::FW_SERIALIZE_OK;
     status = buffer.serialize(this->m_handle.m_seconds);
     if (status == Fw::FW_SERIALIZE_OK) {
@@ -56,7 +56,7 @@ Fw::SerializeStatus ArduinoRawTime::serialize(Fw::SerializeBufferBase& buffer) c
     return status;
 }
 
-Fw::SerializeStatus ArduinoRawTime::deserialize(Fw::SerializeBufferBase& buffer) {
+Fw::SerializeStatus ArduinoRawTime::deserializeFrom(Fw::SerializeBufferBase& buffer) {
     Fw::SerializeStatus status = Fw::SerializeStatus::FW_SERIALIZE_OK;
     status = buffer.deserialize(this->m_handle.m_seconds);
     if (status == Fw::FW_SERIALIZE_OK) {
diff --git a/Arduino/Os/RawTime.hpp b/Arduino/Os/RawTime.hpp
@@ -57,16 +57,16 @@ class ArduinoRawTime : public RawTimeInterface {
     //! \brief Serialize the contents of the RawTimeInterface object into a buffer.
     //!
     //! This function serializes the contents of the RawTimeInterface object into the provided
-    //! buffer. 
+    //! buffer.
     //!
     //! \note The serialization must fit within `FW_RAW_TIME_SERIALIZATION_MAX_SIZE` bytes. This value is
     //! defined in FpConfig.h. For example, Posix systems use a pair of U32 (sec, nanosec) and can therefore
-    //! serialize in 8 bytes. Should an OSAL implementation require more than this, the project must increase 
+    //! serialize in 8 bytes. Should an OSAL implementation require more than this, the project must increase
     //! that value in its config/ folder.
     //!
     //! \param buffer The buffer to serialize the contents into.
     //! \return Fw::SerializeStatus indicating the result of the serialization.
-    Fw::SerializeStatus serialize(Fw::SerializeBufferBase& buffer) const override;
+    Fw::SerializeStatus serializeTo(Fw::SerializeBufferBase& buffer) const override;
 
     //! \brief Deserialize the contents of the RawTimeInterface object from a buffer.
     //!
@@ -75,12 +75,12 @@ class ArduinoRawTime : public RawTimeInterface {
     //!
     //! \note The serialization must fit within `FW_RAW_TIME_SERIALIZATION_MAX_SIZE` bytes. This value is
     //! defined in FpConfig.h. For example, Posix systems use a pair of U32 (sec, nanosec) and can therefore
-    //! serialize in 8 bytes. Should an OSAL implementation require more than this, the project must increase 
+    //! serialize in 8 bytes. Should an OSAL implementation require more than this, the project must increase
     //! that value in its config/ folder.
     //!
     //! \param buffer The buffer to deserialize the contents from.
     //! \return Fw::SerializeStatus indicating the result of the deserialization.
-    Fw::SerializeStatus deserialize(Fw::SerializeBufferBase& buffer) override;
+    Fw::SerializeStatus deserializeFrom(Fw::SerializeBufferBase& buffer) override;
 
   private:
     //! Handle for StubRawTime
diff --git a/Arduino/Svc/ArduinoTime/ArduinoTime.cpp b/Arduino/Svc/ArduinoTime/ArduinoTime.cpp
@@ -10,7 +10,7 @@
  */
 #include <Arduino/Svc/ArduinoTime/ArduinoTime.hpp>
 #include <TimeLib.h>
-#include <config/FprimeArduino.hpp>
+#include <Arduino/config/FprimeArduino.hpp>
 
 namespace Arduino {
 
diff --git a/Arduino/Svc/ArduinoTime/ArduinoTime.hpp b/Arduino/Svc/ArduinoTime/ArduinoTime.hpp
@@ -38,7 +38,7 @@ class ArduinoTime : public ArduinoTimeComponentBase {
                          U8 second             //!< The current second (0-59)
                          ) override;
 
-  PRIVATE:
+  private:
     // ----------------------------------------------------------------------
     // Handler implementations for commands
     // ----------------------------------------------------------------------
diff --git a/Arduino/Svc/LifeLed/LifeLed.hpp b/Arduino/Svc/LifeLed/LifeLed.hpp
@@ -8,7 +8,7 @@
 #define Arduino_LifeLed_HPP
 
 #include "Arduino/Svc/LifeLed/LifeLedComponentAc.hpp"
-#include <config/FprimeArduino.hpp>
+#include <Arduino/config/FprimeArduino.hpp>
 #include "Fw/Types/OnEnumAc.hpp"
 
 namespace Arduino {

Original file line number	Diff line number	Diff line change
`@@ -26,9 +26,8 @@ void StreamDriver::recvReturnIn_handler(FwIndexType portNum, Fw::Buffer& fwBuffe`
`26`	`26`	`this->deallocate_out(0, fwBuffer);`
`27`	`27`	`}`
`28`	`28`
`29`		`-void StreamDriver ::send_handler(const FwIndexType portNum, Fw::Buffer& serBuffer) {`
`30`		`- write_data(serBuffer);`
`31`		`- sendReturnOut_out(0, serBuffer, Drv::ByteStreamStatus::OP_OK);`
	`29`	`+Drv::ByteStreamStatus StreamDriver ::send_handler(const FwIndexType portNum, Fw::Buffer& serBuffer) {`
	`30`	`+ return write_data(serBuffer);`
`32`	`31`	`}`
`33`	`32`
`34`	`33`	`void StreamDriver ::schedIn_handler(const FwIndexType portNum, U32 context) {`