CCSDS File Delivery Protocol - CfdpManager

.github/actions/spelling/expect.txt

@@ -1,5 +1,6 @@
 Aadil
 AArray
+acknak
 AClass
 ACTIVERATEGROUP
 ACTIVERATEGROUPCFG
@@ -44,7 +45,6 @@ Bies
 binaryfile
 BINDIR
 bitfield
-Bitfield
 bitmaps
 bitshifts
 bitwidth
@@ -77,13 +77,16 @@ CBLOCK
 CCACHE
 CCB
 CComponent
+CCs
 ccsds
 ccsparc
 cdh
 CDHCORE
 CDHCORESUBTOPOLOGY
 cerrno
-CFDP
+cfdp
+CFDPMANAGER
+CFDPTIMER
 cff
 cflag
 cfsetispeed
@@ -93,7 +96,9 @@ Chieu
 CHIPINFO
 CHK
 CHNG
+chunklist
 CIRCULARSTATE
+clist
 CLOSEFILE
 cloudbees
 CMDDISP
@@ -169,12 +174,14 @@ deployables
 DEPRECATEDLIST
 deser
 Deserial
+destq
 DEVICESM
 DHTML
 diafile
 diffs
 diles
 dinkel
+diropen
 dnf
 dnp
 docbook
@@ -212,6 +219,7 @@ eay
 ECLIPSEHELP
 EEnum
 EHAs
+eid
 eip
 Elts
 emptydir
@@ -220,7 +228,7 @@ endfunction
 endmacro
 endraw
 enduml
-EPP
+eod
 epp
 ERRORCHECK
 errornum
@@ -237,6 +245,8 @@ exploitability
 externalproject
 FAKELOGGER
 fbuild
+fdir
+fdirective
 FDISP
 fdp
 featherm
@@ -254,18 +264,24 @@ FILEDISPATCHERCFG
 FILEDOWNLINK
 FILEDOWNLINKCFG
 FILEHANDLING
+FILEHANDLINGCFDP
+FILEHANDLINGCFDPSUBTOPOLOGY
 FILEHANDLINGSUBTOPOLOGY
 FILEID
 FILEMANAGERCONFIG
 FILEOPENERROR
+filestore
 FILETESTER
 FILEWORKER
 FILEWORKERTYPES
 FILEWRITEERROR
+finack
 fio
 fle
+fnames
 FNDELAY
 fne
+foffs
 fontcolor
 FONTPATH
 foodoodie
@@ -289,6 +305,7 @@ freeram
 Fregoso
 frsize
 fsblkcnt
+fsize
 fsw
 FWCASSERT
 gcda
@@ -315,6 +332,7 @@ Graphviz
 grayscales
 GROUNDINTERFACERULES
 GSE
+GSW
 gtags
 gtest
 gtimeout
@@ -392,9 +410,9 @@ jobrestrictions
 jpl
 jplffs
 jre
+kermit
 kessler
 kevin
-kermit
 kubiak
 Lammert
 lammertbies
@@ -427,6 +445,7 @@ lseek
 LTK
 lvar
 LVL
+LVs
 lxml
 MACROFILE
 MACROSTART
@@ -470,6 +489,7 @@ Mutexed
 muxed
 mycompany
 myos
+NAKs
 nasafprime
 nbits
 ncsl
@@ -549,6 +569,7 @@ PKTS
 plainnat
 plantuml
 PNGs
+polldir
 pollfd
 POLLIN
 POLYDB
@@ -580,8 +601,10 @@ projectnumber
 propget
 propput
 protothreading
+psn
 ptbool
 ptf
+PTFO
 pthread
 ptrt
 pvn
@@ -590,6 +613,7 @@ qhelpgenerator
 QHG
 qhp
 qsf
+queueidx
 racheljt
 RAII
 randtbl
@@ -625,11 +649,14 @@ ROOTDIR
 rowspan
 rpi
 rptr
+rsp
+RSubstate
 SAlias
 sanitizers
 sats
 SBF
 SBINDIR
+sbintf
 sbom
 scid
 scm
@@ -682,7 +709,9 @@ sqa
 srandom
 SRCS
 sreddy
+sret
 sss
+SSubstate
 STAMEM
 startuml
 stdbool
@@ -715,6 +744,8 @@ tabdnp
 tabkermit
 tagfile
 tbase
+tbd
+tbl
 tcanham
 tcflush
 tcgetattr
@@ -735,11 +766,11 @@ tfvn
 thisdirdoesnotexist
 thisfiledoesnotexist
 Thu
+timcanham
 timebase
 timerfd
 timetag
 timeval
-timcanham
 Tinternal
 tions
 tjh
@@ -753,16 +784,20 @@ TLMPACKET
 TLMPACKETIZER
 TLMPACKETIZERCOMPONENTIMPLCFG
 TLMPACKETIZERTYPES
+tlv
 TODOLIST
 TOKENBUCKETTESTER
 topologydefs
 totalram
 tparam
 TPP
 trinomials
+tsn
 tts
-Tumbar
 tumbar
+txa
+txm
+txw
 typedef
 typedef'ed
 uart
@@ -772,6 +807,7 @@ uge
 uitofp
 UML
 umod
+unack
 unconfigured
 UNEXP
 unistd
@@ -804,6 +840,7 @@ WORKDIR
 wrs
 wxgui
 wxy
+XACT
 Xapian
 XBee
 xdf

.github/actions/spelling/patterns.txt

@@ -146,3 +146,6 @@ TeX/AMS
 # .get...() .set...() autocoded functions
 \.get\w+\(
 \.set\w+\(
+
+# CCSDS specification version numbers (e.g., CCSDS 727.0-B-5)
+\bCCSDS\s+\d+\.\d+-[A-Z]-\d+(?:\s+section\s+\d+(?:\.\d+)?)?(?:,\s+section\s+\d+(?:\.\d+)?(?:,\s+table\s+[-\d]+)?)?

CFDP/README.md

@@ -0,0 +1,25 @@
+# CFDP Utilities
+
+## Overview
+
+This directory contains CFDP utility classes used by the F' Framework.
+
+## Contents
+
+- **Checksum/**: CCSDS CFDP-compliant 32-bit checksum implementation
+
+## Where is CfdpManager?
+
+The main CFDP protocol implementation is located at:
+
+**`Svc/Ccsds/CfdpManager/`**
+
+If you're looking for the CFDP file transfer component, you'll find it there.
+
+## Why is Checksum here?
+
+The Checksum utility is used by the F' Framework's FilePacket class (`Fw/FilePacket/FilePacket.hpp`), which predates the CfdpManager component and supports legacy file transfer components (FileUplink, FileDownlink). To maintain framework independence, Checksum cannot be moved into CfdpManager.
+
+## Future
+
+A long-term solution would be to relocate Checksum to a framework utilities directory (e.g., `Fw/Utils/`), further clarifying the architectural separation.

Os/File.hpp

@@ -28,28 +28,28 @@ struct FileHandle {};
 class FileInterface {
   public:
     enum Mode {
-        OPEN_NO_MODE,     //!<  File mode not yet selected
-        OPEN_READ,        //!<  Open file for reading
+        OPEN_NO_MODE,     //!< File mode not yet selected
+        OPEN_READ,        //!< Open file for reading
         OPEN_CREATE,      //!< Open file for writing and truncates file if it exists, ie same flags as creat()
-        OPEN_WRITE,       //!<  Open file for writing
-        OPEN_SYNC_WRITE,  //!<  Open file for writing; writes don't return until data is on disk
+        OPEN_WRITE,       //!< Open file for writing
+        OPEN_SYNC_WRITE,  //!< Open file for writing; writes don't return until data is on disk
         OPEN_APPEND,      //!< Open file for appending
         MAX_OPEN_MODE     //!< Maximum value of mode
     };
 
     enum Status {
-        OP_OK,              //!<  Operation was successful
-        DOESNT_EXIST,       //!<  File doesn't exist (for read)
-        NO_SPACE,           //!<  No space left
-        NO_PERMISSION,      //!<  No permission to read/write file
-        BAD_SIZE,           //!<  Invalid size parameter
-        NOT_OPENED,         //!<  file hasn't been opened yet
+        OP_OK,              //!< Operation was successful
+        DOESNT_EXIST,       //!< File doesn't exist (for read)
+        NO_SPACE,           //!< No space left
+        NO_PERMISSION,      //!< No permission to read/write file
+        BAD_SIZE,           //!< Invalid size parameter
+        NOT_OPENED,         //!< file hasn't been opened yet
         FILE_EXISTS,        //!< file already exist (for CREATE with O_EXCL enabled)
         NOT_SUPPORTED,      //!< Kernel or file system does not support operation
         INVALID_MODE,       //!< Mode for file access is invalid for current operation
         INVALID_ARGUMENT,   //!< Invalid argument passed in
         NO_MORE_RESOURCES,  //!< No more available resources
-        OTHER_ERROR,        //!<  A catch-all for other errors. Have to look in implementation-specific code
+        OTHER_ERROR,        //!< A catch-all for other errors. Have to look in implementation-specific code
         MAX_STATUS          //!< Maximum value of status
     };
 

Svc/Ccsds/CMakeLists.txt

@@ -7,3 +7,4 @@ add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/TmFramer/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/AosFramer/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/AosDeframer/")
 add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/ApidManager/")
+add_fprime_subdirectory("${CMAKE_CURRENT_LIST_DIR}/CfdpManager/")