Issue 2769

Fw/CMakeLists.txt

@@ -22,6 +22,9 @@ add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/SerializableFile/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Test/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Types/")
 
+# CCSDS subdirectories
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/Ccsds/Cfdp/")
+
 # Setup an interface target for Fw for efficiency
 add_library(Fw INTERFACE)
 add_dependencies(Fw ${FPRIME_FRAMEWORK_MODULES})

Fw/Ccsds/Cfdp/CMakeLists.txt

@@ -0,0 +1,31 @@
+####
+# CMakeLists.txt:
+#
+# Sets up the fprime module build within CMake.
+####
+set(SOURCE_FILES
+  "${CMAKE_CURRENT_LIST_DIR}/EndOfFile.cpp"
+  "${CMAKE_CURRENT_LIST_DIR}/FileData.cpp"
+  "${CMAKE_CURRENT_LIST_DIR}/FilePacket.cpp"
+  "${CMAKE_CURRENT_LIST_DIR}/Finished.cpp"
+  "${CMAKE_CURRENT_LIST_DIR}/Header.cpp"
+  "${CMAKE_CURRENT_LIST_DIR}/Metadata.cpp"
+)
+
+set(MOD_DEPS
+  Fw/Types
+  Fw/Buffer
+)
+
+register_fprime_module()
+
+set(UT_SOURCE_FILES
+  "${CMAKE_CURRENT_LIST_DIR}/test/ut/TestEndOfFile.cpp"
+  "${CMAKE_CURRENT_LIST_DIR}/test/ut/TestFileData.cpp"
+  "${CMAKE_CURRENT_LIST_DIR}/test/ut/TestFilePacketMain.cpp"
+  "${CMAKE_CURRENT_LIST_DIR}/test/ut/TestFilePacket.cpp"
+  "${CMAKE_CURRENT_LIST_DIR}/test/ut/TestFinished.cpp"
+  "${CMAKE_CURRENT_LIST_DIR}/test/ut/TestHeader.cpp"
+  "${CMAKE_CURRENT_LIST_DIR}/test/ut/TestMetadata.cpp"
+)
+register_fprime_ut()

Fw/Ccsds/Cfdp/EndOfFile.cpp

@@ -0,0 +1,111 @@
+//! ============================================================================
+//! @file   EndOfFile.cpp
+//! @brief  cpp file for a CFDP file packet End-of-file data field.
+//! @author chownw
+//! ============================================================================
+
+#include <string.h>
+
+#include <FpConfig.hpp>
+#include <Fw/Buffer/Buffer.hpp>
+#include <Fw/Ccsds/Cfdp/EndOfFile.hpp>
+#include <Fw/Ccsds/Cfdp/FilePacket.hpp>
+#include <Fw/Ccsds/Cfdp/Header.hpp>
+
+namespace Fw
+{
+
+namespace Cfdp
+{
+
+FilePacket::DirectiveType FilePacket::EndOfFile::directiveCode =
+  FilePacket::DirectiveType::END_OF_FILE;
+
+FilePacket::EndOfFile::
+  EndOfFile()
+{
+}
+
+FilePacket::EndOfFile::
+  EndOfFile(ConditionCode conditionCode, U32 fileChecksum, U64 fileSize)
+{
+  this->conditionCode = conditionCode;
+  this->spare = 0;
+  this->fileChecksum = fileChecksum;
+  this->fileSize = FileSizeSensitive(fileSize);
+}
+
+FilePacket::ConditionCode FilePacket::EndOfFile::
+  getConditionCode() const
+{
+  return this->conditionCode;
+}
+
+U32 FilePacket::EndOfFile::
+  getFileChecksum() const
+{
+  return this->fileChecksum;
+}
+
+U64 FilePacket::EndOfFile::
+  getFileSize() const
+{
+  return this->fileSize.getValue();
+}
+
+void FilePacket::EndOfFile::
+  serialize(const Fw::Buffer& buf, U32 offset, const Header& header) const
+{
+  U8* data = buf.getData() + offset;
+
+  // Serialize octet 0
+  data[0] = static_cast<U8>(this->directiveCode);
+
+  // Serialize octet 1
+  data[1] = (static_cast<U8>(this->conditionCode) & 15) << 4;
+
+  // Push file checksum in big-endian format
+  FilePacket::serializeValue(
+    &data[2],
+    this->fileChecksum,
+    FieldLength::FILE_CHECKSUM / 8
+  );
+
+  // Serialize the FSS field file size
+  U32 fileSizeOffset = offset + FixedSize::BYTES;
+  this->fileSize.serialize(buf, fileSizeOffset, header);
+}
+
+void FilePacket::EndOfFile::
+  deserialize(const Fw::Buffer& buf, U32 offset, const Header& header)
+{
+  U8* data = buf.getData() + offset;
+
+  // Deserialize octet 1
+  this->conditionCode =
+    static_cast<FilePacket::ConditionCode>((data[1] >> 4) & 15);
+  this->spare = data[1] & 15;
+
+  // Deserialize file checksum bytes
+  this->fileChecksum = FilePacket::deserializeValue(
+    &data[2],
+    FieldLength::FILE_CHECKSUM / 8
+  );
+
+  // Deserialize the FSS field file size
+  U32 fileSizeOffset = offset + FixedSize::BYTES;
+  this->fileSize.deserialize(buf, fileSizeOffset, header);
+}
+
+U32 FilePacket::EndOfFile::
+  getSerializedLength(const Header& header) const
+{
+  return (
+    FixedSize::BYTES
+    + this->fileSize.getSerializedLength(header)
+  );
+}
+
+} // Cfdp
+
+} // Fw

Fw/Ccsds/Cfdp/EndOfFile.hpp

@@ -0,0 +1,141 @@
+//! ============================================================================
+//! @file   EndOfFile.hpp
+//! @brief  hpp file for a CFDP file packet End-of-file data field.
+//! @author chownw
+//! ============================================================================
+
+#ifndef FW_CFDP_ENDOFFILE_HPP
+#define FW_CFDP_ENDOFFILE_HPP
+
+#include <FpConfig.hpp>
+#include <Fw/Buffer/Buffer.hpp>
+#include <Fw/Ccsds/Cfdp/FilePacket.hpp>
+
+namespace Fw
+{
+
+namespace Cfdp
+{
+
+//! @brief A CFDP file packet End-of-file data field.
+//!
+class FilePacket::EndOfFile : public DataField
+{
+  friend FilePacket;
+
+  public:
+    //! @brief Construct an empty CFDP End-of-file PDU.
+    //!
+    //! This can be used to construct an End-of-file PDU to hold deserialized
+    //! data.
+    //!
+    EndOfFile();
+
+    //! @brief Construct a filled CFDP End-of-file PDU.
+    //!
+    //! This can be used to construct an End-of-file PDU for serialization.
+    //!
+    //! @param conditionCode The condition code.
+    //! @param fileChecksum The file checksum.
+    //! @param fileSize The number of file data octets transmitted by sender.
+    //!
+    EndOfFile(
+      ConditionCode conditionCode,
+      U32 fileChecksum,
+      U64 fileSize
+    );
+
+    //! @brief Get the condition code.
+    //!
+    ConditionCode getConditionCode() const;
+
+    //! @brief Get the file checksum.
+    //!
+    U32 getFileChecksum() const;
+
+    //! @brief Get the file size.
+    //!
+    U64 getFileSize() const;
+
+  PRIVATE:
+    //! @brief Serialize this End-of-file PDU into a buffer.
+    //!
+    //! @param buf The buffer to hold the serialized data.
+    //! @param offset The byte offset to start serialization from.
+    //! @param header The header attached to this PDU.
+    //!
+    void serialize(
+      const Fw::Buffer& buf,
+      U32 offset,
+      const Header& header
+    ) const;
+
+    //! @brief Deserialize a buffer containing serialized End-of-file PDU data.
+    //!
+    //! @param buf The buffer containing serialized data.
+    //! @param offset The byte offset to start deserialization from.
+    //! @param header The header attached to this PDU.
+    //!
+    void deserialize(
+      const Fw::Buffer& buf,
+      U32 offset,
+      const Header& header
+    );
+
+    //! @brief Get the length in octets of this End-of-file PDU when serialized.
+    //!
+    //! @param header The header attached to this PDU.
+    //!
+    U32 getSerializedLength(const Header& header) const;
+
+  PRIVATE:
+    //! @brief Length in bits of fixed-size End-of-file PDU fields.
+    //!
+    enum FieldLength : U32
+    {
+      DIRECTIVE_CODE = 8,
+      CONDITION_CODE = 4,
+      SPARE = 4,
+      FILE_CHECKSUM = 32,
+    };
+
+    //! @brief Total length of fixed-size End-of-file PDU fields.
+    //!
+    enum FixedSize : U32
+    {
+      BITS =
+        FieldLength::DIRECTIVE_CODE
+        + FieldLength::CONDITION_CODE
+        + FieldLength::SPARE
+        + FieldLength::FILE_CHECKSUM,
+      BYTES = BITS / 8,
+    };
+
+    //! @brief Indicates that the data field contains an End-of-file PDU.
+    //!
+    static DirectiveType directiveCode;
+
+    //! @brief Condition code.
+    //!
+    ConditionCode conditionCode;
+
+    //! @brief Spare bits, set to all zeroes.
+    //!
+    U8 spare;
+
+    //! @brief File checksum.
+    //!
+    U32 fileChecksum;
+
+    //! @brief Number of file data octets transmitted by sender.
+    //!
+    FileSizeSensitive fileSize;
+
+    // NOTE: Fault location field not supported.
+};
+
+} // Cfdp
+
+} // Fw
+
+#endif // FW_CFDP_ENDOFFILE_HPP