Merge branch 'development' into meier/upstream-pus-distributor-bugfix

Reviewed-on: #653

.gitignore

@@ -1,6 +1,14 @@
+# PyCharm and CLion
+/.idea/*
+!/.idea/runConfigurations
+!/.idea/cmake.xml
+!/.idea/codeStyles
+
+# Eclipse
 .cproject
 .project
 .settings
 .metadata
 
 /build*
+/cmake-build*

.idea/codeStyles/Project.xml

@@ -0,0 +1,14 @@
+<component name="ProjectCodeStyleConfiguration">
+  <code_scheme name="Project" version="173">
+    <clangFormatSettings>
+      <option name="ENABLED" value="true" />
+    </clangFormatSettings>
+    <codeStyleSettings language="CMake">
+      <indentOptions>
+        <option name="INDENT_SIZE" value="2" />
+        <option name="CONTINUATION_INDENT_SIZE" value="0" />
+        <option name="TAB_SIZE" value="2" />
+      </indentOptions>
+    </codeStyleSettings>
+  </code_scheme>
+</component>

.idea/codeStyles/codeStyleConfig.xml

@@ -0,0 +1,5 @@
+<component name="ProjectCodeStyleConfiguration">
+  <state>
+    <option name="USE_PER_PROJECT_SETTINGS" value="true" />
+  </state>
+</component>

CHANGELOG

@@ -1,175 +0,0 @@
-# Changed from ASTP 1.1.0 to 1.2.0
-
-## API Changes
-
-### FSFW Architecture
-
-- New src folder which contains all source files except the HAL, contributed code and test code
-- External and internal API mostly stayed the same
-- Folder names are now all smaller case: internalError was renamed to internalerror and
-  FreeRTOS was renamed to freertos
-- Warning if optional headers are used but the modules was not added to the source files to compile
-
-### HAL
-
-- HAL added back into FSFW. It is tightly bound to the FSFW, and compiling it as a static library
-  made using it more complicated than necessary
-
-## Bugfixes
-
-### FreeRTOS QueueMapManager
-
-- Fixed a bug which causes the first generated Queue ID to be invalid
-
-## Enhancements
-
-### FSFW Architecture
-
-- See API changes chapter. This change will keep the internal API consistent in the future
-
-# Changes from ASTP 1.0.0 to 1.1.0
-
-## API Changes
-
-### PUS
-
-- Added PUS C support
-- SUBSYSTEM_IDs added for PUS Services
-- Added new Parameter which must be defined in config: fsfwconfig::FSFW_MAX_TM_PACKET_SIZE
-
-### ObjectManager
-
- - ObjectManager is now a singelton
-
-
-### Configuration
-
-- Additional configuration option fsfwconfig::FSFW_MAX_TM_PACKET_SIZE which 
-  need to be specified in FSFWConfig.h
-
-### CMake
-
-- Changed Cmake FSFW_ADDITIONAL_INC_PATH to FSFW_ADDITIONAL_INC_PATHS
-
-## Bugfixes 
-
-- timemanager/TimeStamperIF.h: Timestamp config was not used correctly, leading to different timestamp sizes than configured in fsfwconfig::FSFW_MISSION_TIMESTAMP_SIZE
-- TCP server fixes
-
-## Enhancements
-
-### FreeRTOS Queue Handles
-
-- Fixed an internal issue how FreeRTOS MessageQueues were handled
-
-### Linux OSAL
-
-- Better printf error messages
-
-### CMake
-
-- Check for C++11 as mininimum required Version
-
-### Debug Output
-
-- Changed Warning color to magenta, which is well readable on both dark and light mode IDEs
-
-
-# Changes from ASTP 0.0.1 to 1.0.0
-
-### Host OSAL
-
-- Bugfix in MessageQueue, which caused the sender not to be set properly
-
-### FreeRTOS OSAL
-
-- vRequestContextSwitchFromISR is declared extern "C" so it can be defined in
-a C file without issues
-
-### PUS Services
-
-- It is now possible to change the message queue depth for the telecommand verification service (PUS1)
-- The same is possible for the event reporting service (PUS5)
-- PUS Health Service added, which allows to command and retrieve health via PUS packets
-
-
-### EnhancedControllerBase
-
-- New base class for a controller which also implements HasActionsIF and HasLocalDataPoolIF
-
-### Local Pool
-
-- Interface of LocalPools has changed. LocalPool is not a template anymore. Instead the size and
-bucket number of the pools per page and the number of pages are passed to the ctor instead of
-two ctor arguments and a template parameter
-
-### Parameter Service
-
-- The API of the parameter service has been changed to prevent inconsistencies
-between documentation and actual code and to clarify usage.
-- The parameter ID now consists of:
-	1. Domain ID (1 byte)
-	2. Unique Identifier (1 byte)
-	3. Linear Index (2 bytes)
-The linear index can be used for arrays as well as matrices.
-The parameter load command now explicitely expects the ECSS PTC and PFC
-information as well as  the rows and column number. Rows and column will
-default to one, which is equivalent to one scalar parameter (the most
-important use-case)
-   
-### File System Interface
-
-- A new interfaces specifies the functions for a software object which exposes the file system of
-a given hardware to use message based file handling (e.g. PUS commanding)
-
-### Internal Error Reporter
-
-- The new internal error reporter uses the local data pools. The pool IDs for
-the exisiting three error values and the new error set will be hardcoded for
-now, the the constructor for the internal error reporter just takes an object
-ID for now.
-
-### Device Handler Base
-
-- There is an additional `PERFORM_OPERATION` step for the device handler base. It is important
-that DHB users adapt their polling sequence tables to perform this step. This steps allows for 
-a clear distinction between operation and communication steps
-- setNormalDatapoolEntriesInvalid is not an abstract method and a default implementation was provided
-- getTransitionDelayMs is now an abstract method
-
-### DeviceHandlerIF
-
-- Typo for UNKNOWN_DEVICE_REPLY 
-
-### Events
-
-- makeEvent function: Now takes three input parameters instead of two and
-allows setting a unique ID. Event.cpp source file removed, functions now
-defined in header directly. Namespaces renamed. Functions declared `constexpr`
-now
-
-### Commanding Service Base
-
-- CSB uses the new fsfwconfig::FSFW_CSB_FIFO_DEPTH variable to determine  the FIFO depth for each 
-CSB instance. This variable has to be set in the FSFWConfig.h file
-
-### Service Interface
-
-- Proper printf support contained in ServiceInterfacePrinter.h
-- CPP ostream support now optional (can reduce executable size by 150 - 250 kB)
-- Amalagated header which determines automatically which service interface to use depending on FSFWConfig.h configuration. 
-  Users can just use #include <fsfw/serviceinterface/ServiceInterface.h>
-- If CPP streams are excluded, sif:: calls won't work anymore and need to be replaced by their printf counterparts. 
-  For the fsfw, this can be done by checking the processor define FSFW_CPP_OSTREAM_ENABLED from FSFWConfig.h. 
-  For mission code, developers need to replace sif:: calls by the printf counterparts, but only if the CPP stream are excluded. 
-  If this is not the case, everything should work as usual.
-
-### ActionHelper and ActionMessage
-
-- ActionHelper finish function and ActionMessage::setCompletionReply now expects explicit 
-information whether to report a success or failure message instead of deriving it implicitely 
-from returnvalue
-
-### PUS Parameter Service 20
-
-Added PUS parameter service 20 (only custom subservices available).

CHANGELOG.md

@@ -0,0 +1,546 @@
+Change Log
+=======
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+# [unreleased]
+
+# [v5.0.0]
+
+## Changes
+
+- Renamed auto-formatting script to `auto-formatter.sh` and made it more robust.
+  If `cmake-format` is installed, it will also auto-format the `CMakeLists.txt` files now.
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/625
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/626
+- Bump C++ required version to C++17. Every project which uses the FSFW and every modern
+  compiler supports it
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/622
+- New CMake option `FSFW_HAL_LINUX_ADD_LIBGPIOD` to specifically exclude `gpiod` code.
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/572
+- HAL Devicehandlers: Periodic printout is run-time configurable now
+- `oneShotAction` flag in the `TestTask` class is not static anymore
+- Major update for version handling, using `git describe` to fetch version information with git.
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/601
+  - Add helper functions provided by [`cmake-modules`](https://github.com/bilke/cmake-modules)
+    manually now. Those should not change too often and only a small subset is needed
+  - Separate folder for easier update and for distinction
+  - LICENSE file included
+  - use `int` for version numbers to allow unset or uninitialized version
+  - Initialize Version object with numbers set to -1
+  - Instead of hardcoding the git hash, it is now retrieved from git
+  - `Version` now allows specifying additional version information like the git SHA1 hash and the
+    versions since the last tag
+  - Additional information is set to the last part of the git describe output for `FSFW_VERSION` now.
+  - Version still need to be hand-updated if the FSFW is not included as a submodule for now.
+- IPC Message Queue Handling: Allow passing an optional `MqArgs` argument into the MessageQueue
+  creation call. It allows passing context information and an arbitrary user argument into
+  the message queue. Also streamlined and simplified `MessageQueue` implementation for all OSALs
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/583
+- Internal API change: Moved the `fsfw_hal` to the `src` folder and integration and internal
+  tests part of `fsfw_tests` to `src`. Unittests are now in a dedicated folder called `unittests`
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/653
+
+### Task Module Refactoring
+
+PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/636
+
+**Refactoring general task code**
+
+- There was a lot of duplicate/boilerplate code inside the individual task IF OSAL implementations.
+  Remove it by introducing base classes `PeriodicTaskBase` and `FixedTimeslotTaskBase`.
+
+**Refactor PeriodicTaskIF**
+
+- Convert `virtual ReturnValue_t addComponent(object_id_t object)` to
+  `virtual ReturnValue_t addComponent(object_id_t object, uint8_t opCode = 0)`, allowing to pass
+  the operation code passed to `performOperation`. Updated API taking
+  an `ExecutableObjectIF` accordingly
+
+**Refactor FixedTimeslotTaskIF**
+
+- Add additional `addSlot` function which takes an `ExecutableObjectIF` pointer and its Object ID
+
+**Refactor FixedSequenceSlot**
+
+- Introduce typedef `CustomCheckFunc` for `ReturnValue_t (*customCheckFunction)(const SlotList&)`.
+- Convert `ReturnValue_t (*customCheckFunction)(const SlotList&)` to
+  `ReturnValue_t (*customCheckFunction)(const SlotList&, void*)`, allowing arbitrary user arguments
+  for the custom checker
+
+**Linux Task Module**
+
+- Use composition instead of inheritance for the `PeriodicPosixTask` and make the `PosixTask` a
+  member of the class
+
+### HAL
+
+- HAL Linux Uart: Baudrate and bits per word are enums now, avoiding misconfigurations
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/585
+- HAL Linux SPI: Set the Clock Default State when setting new SPI speed
+  and mode
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/573
+- GPIO HAL: `Direction`, `GpioOperation` and `Levels` are enum classes now, which prevents
+  name clashes with Windows defines.
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/572
+- HAL Linux Uart: Baudrate and bits per word are enums now, avoiding misconfigurations
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/585
+
+### Time
+
+PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/584 and
+https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/593
+
+- `timeval` to `TimeOfDay_t`
+- Added Mutex for gmtime calls: (compare http://www.opengate.at/blog/2020/01/timeless/)
+- Moved the statics used by Clock in ClockCommon.cpp to this file
+- Better check for leap seconds
+- Added Unittests for Clock (only getter)
+
+### Power 
+
+- `PowerSwitchIF`: Remove `const` specifier from `sendSwitchCommand` and `sendFuseOnCommand` and
+  also specify a `ReturnValue_t` return type
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/590
+- Extend `PowerSwitcher` module to optionally check current state when calling `turnOn` or
+  `turnOff`. Tis can be helpful to avoid commanding switches which do not need commanding
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/590
+
+## Removed
+
+- Removed the `HkSwitchHelper`. This module should not be needed anymore, now that the local
+  datapools have been implemented.
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/557
+
+## Additions
+
+- New constructor for PoolEntry which allows to simply specify the length of the pool entry.
+  This is also the new default constructor for scalar value with 0 as an initial value
+- Added options for CI/CD builds: `FSFW_CICD_BUILD`. This allows the source code to know
+  whether it is running in CI/CD
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/623
+- Basic `clion` support: Update `.gitignore` and add some basic run configurations
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/625
+- LTO support: Allow using LTO/IPO by setting `FSFW_ENABLE_LTO=1`. CMake is able to detect whether
+  the user compiler supports IPO/LPO. LTO is on by default now. Most modern compilers support it,
+  can make good use of it and it usually makes the code faster and/or smaller.
+  After some more research:
+  Enabling LTO will actually cause the compiler to only produce thin LTO by adding 
+  `-flto -fno-fat-lto-objects` to the compiler options. I am not sure this is an ideal choice
+  because if an application linking against the FSFW does not use LTO, there can be compile
+  issues (e.g. observed when compiling the FSFW tests without LTO). This is a known issue as
+  can be seen in the multiple CMake issues for it: 
+    - https://gitlab.kitware.com/cmake/cmake/-/issues/22913, 
+    - https://gitlab.kitware.com/cmake/cmake/-/issues/16808, 
+    - https://gitlab.kitware.com/cmake/cmake/-/issues/21696
+  Easiest solution for now: Keep this option OFF by default.
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/616
+- Linux HAL: Add wiretapping option for I2C. Enabled with `FSFW_HAL_I2C_WIRETAPPING` defined to 1
+- Dedicated Version class and constant `fsfw::FSFW_VERSION` containing version information
+  inside `fsfw/version.h`
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/559
+- Added generic PUS TC Scheduler Service 11. It depends on the new added Emebeded Template Library
+  (ETL) dependency.
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/594
+- Added ETL dependency and improved library dependency management
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/592
+- Add a `DummyPowerSwitcher` module which can be useful for test setups when no PCDU is available
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/590
+- New typedef for switcher type
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/590
+- `Subsystem`: New API to add table and sequence entries
+
+## Fixed
+
+- TCP TMTC Server: `MutexGuard` was not created properly in
+  `TcpTmTcServer::handleTmSending(socket_t connSocket, bool& tmSent)` call.
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/618
+- Fix infinite recursion in `prepareHealthSetReply` of PUS Health Service 201.
+  Is not currently used right now but might be used in the future
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/617
+- Move some CMake directives further up top so they are not ignored
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/621
+- Small bugfix in STM32 HAL for SPI
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/599
+- HAL GPIO: Improved error checking in `LinuxLibgpioIF::configureGpios(...)`. If a GPIO
+  configuration fails, the function will exit prematurely with a dedicated error code
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/602
+
+# [v4.0.0]
+
+## Additions
+
+- CFDP Packet Stack and related tests added. It also refactors the existing TMTC infastructure to
+  allow sending of CFDP packets to the CCSDS handlers.
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/528
+- added virtual function to print datasets
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/544
+- doSendRead Hook
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/545
+- Dockumentation for DHB
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/551
+  
+### HAL additions
+
+- Linux Command Executor, which can execute shell commands in blocking and non-blocking mode
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/536
+- uio Mapper
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/543
+
+## Changes
+
+- Applied the `clang-format` auto-formatter to all source code
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/534
+- Updated Catch2 to v3.0.0-preview4
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/538
+- Changed CI to use prebuilt docker image
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/549
+
+## Bugfix
+
+- CMake fixes in PR https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/533 , was problematic
+  if the uppermost user `CMakeLists.txt` did not have the include paths set up properly, which
+  could lead to compile errors that `#include "fsfw/FSFW.h"` was not found.
+- Fix for build regression in Catch2 v3.0.0-preview4
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/548
+- Fix in unittest which failed on CI
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/552
+- Fix in helper script
+  PR: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/553
+
+## API Changes
+
+- Aforementioned changes to existing TMTC stack
+
+## Known bugs
+
+- 
+
+# [v3.0.1]
+
+## API Changes
+
+* 
+
+## Bugfixes
+
+* Version number was not updated for v3.0.0 #542
+
+## Enhancement
+
+* 
+
+## Known bugs
+
+* 
+
+# [v3.0.0]
+
+## API Changes
+
+#### TCP Socket Changes
+
+* Keep Open TCP Implementation #496
+    * The socket will now kept open after disconnect. This allows reconnecting. 
+    * Only one connection is allowed
+    * No internal influence but clients need to change their Code.
+
+### GPIO IF
+
+* Add feature to open GPIO by line name #506
+
+### Bitutil
+
+* Unittests for Op Divider and Bitutility #510
+
+### Filesystem IF changed
+
+*  Filesystem Base Interface: Use IF instead of void pointer #511 
+
+### STM32
+
+* STM32 SPI Updates #518
+
+## Bugfixes
+
+* Small bugfix for LIS3 handler #504
+* Spelling fixed for function names #509
+* CMakeLists fixes #517
+* Out of bound reads and writes in unittests #519
+* Bug in TmPacketStoredPusC (#478)
+* Windows ifdef fixed #529
+
+## Enhancement
+
+* FSFW.h.in more default values #491
+* Minor updates for PUS services #498
+* HasReturnvaluesIF naming for parameter #499
+* Tests can now be built as part of FSFW and versioning moved to CMake #500
+*  Added integration test code #508 
+* More printouts for rejected TC packets #505
+* Arrayprinter format improvements #514
+* Adding code for CI with docker and jenkins #520
+* Added new function in SerializeAdapter  #513
+    *  Enables simple deSerialize if you keep track of the buffer position yourself
+    *  `` static ReturnValue_t deSerialize(T *object, const uint8_t* buffer,
+            size_t* deserSize, SerializeIF::Endianness streamEndianness) ``
+* Unittest helper scripts has a new Parameter to open the coverage html in the webrowser  #525
+    * ``'-o', '--open', Open coverage data in webbrowser`` 
+* Documentation updated. Sphinx Documentation can now be build with python script #526
+
+## Known bugs
+
+* Version number was not updated for v3.0.0 #542
+
+
+All Pull Requests:
+
+Milestone: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/milestone/19
+
+# [v2.0.0]
+
+## API Changes
+
+
+### File Structure changed to fit more common structure
+
+* See pull request (#445)
+  * HAL is now part of the main project
+    * **See Instructions below:**
+
+#### Instruction how to update existing / user code
+
+* Changes in `#include`:
+  * Rename `internalError` in includes to `internalerror`
+  * Rename `fsfw/hal` to `fsfw_hal`
+  * Rename `fsfw/tests` to `fsfw_tests`
+  * Rename `osal/FreeRTOS` to `osal/freertos`
+
+* Changes in `CMakeLists.txt`: 
+  * Rename `OS_FSFW` to `FSFW_OSAL`
+
+* Changes in `DleEncoder.cpp`
+    * Create an instance of the `DleEncoder` first before calling the `encode` and `decode` functions
+
+### Removed osal/linux/Timer (#486)
+
+* Was redundant to timemanager/Countdown
+
+#### Instruction how to update existing / user code
+
+* Use timemanager/Countdown instead
+
+## Bugfixes
+
+### TM Stack
+
+* Increased TM stack robustness by introducing `nullptr` checks and more printouts (#483)
+
+#### Host OSAL / FreeRTOS 
+
+* QueueMapManager Bugfix (NO_QUEUE was used as MessageQueueId) (#444)
+
+#### Events
+
+* Event output is now consistent (#447)
+
+#### DLE Encoder
+
+* Fixed possible out of bounds access in DLE Encoder (#492)
+
+## Enhancment
+
+* HAL as major new feature, also includes three MEMS devicehandlers as part of #481
+* Linux HAL updates (#456)
+* FreeRTOS Header cleaning update and Cmake tweaks (#442)
+* Printer updates (#453)
+* New returnvalue for for empty PST (#485)
+* TMTC Bridge: Increase limit of packets stored (#484)
+
+## Known bugs
+
+* Bug in TmPacketStoredPusC (#478)
+
+
+All Pull Requests:
+
+Milestone: https://egit.irs.uni-stuttgart.de/fsfw/fsfw/milestone/5
+
+# [v1.2.0]
+
+## API Changes
+
+### FSFW Architecture
+
+- New src folder which contains all source files except the HAL, contributed code and test code
+- External and internal API mostly stayed the same
+- Folder names are now all smaller case: internalError was renamed to internalerror and
+  FreeRTOS was renamed to freertos
+- Warning if optional headers are used but the modules was not added to the source files to compile
+
+### HAL
+
+- HAL added back into FSFW. It is tightly bound to the FSFW, and compiling it as a static library
+  made using it more complicated than necessary
+
+## Bugfixes
+
+### FreeRTOS QueueMapManager
+
+- Fixed a bug which causes the first generated Queue ID to be invalid
+
+## Enhancements
+
+### FSFW Architecture
+
+- See API changes chapter. This change will keep the internal API consistent in the future
+
+# [v1.1.0]
+
+## API Changes
+
+### PUS
+
+- Added PUS C support
+- SUBSYSTEM_IDs added for PUS Services
+- Added new Parameter which must be defined in config: fsfwconfig::FSFW_MAX_TM_PACKET_SIZE
+
+### ObjectManager
+
+ - ObjectManager is now a singelton
+
+
+### Configuration
+
+- Additional configuration option fsfwconfig::FSFW_MAX_TM_PACKET_SIZE which 
+  need to be specified in FSFWConfig.h
+
+### CMake
+
+- Changed Cmake FSFW_ADDITIONAL_INC_PATH to FSFW_ADDITIONAL_INC_PATHS
+
+## Bugfixes 
+
+- timemanager/TimeStamperIF.h: Timestamp config was not used correctly, leading to different timestamp sizes than configured in fsfwconfig::FSFW_MISSION_TIMESTAMP_SIZE
+- TCP server fixes
+
+## Enhancements
+
+### FreeRTOS Queue Handles
+
+- Fixed an internal issue how FreeRTOS MessageQueues were handled
+
+### Linux OSAL
+
+- Better printf error messages
+
+### CMake
+
+- Check for C++11 as mininimum required Version
+
+### Debug Output
+
+- Changed Warning color to magenta, which is well readable on both dark and light mode IDEs
+
+
+# Changes from ASTP 0.0.1 to 1.0.0
+
+### Host OSAL
+
+- Bugfix in MessageQueue, which caused the sender not to be set properly
+
+### FreeRTOS OSAL
+
+- vRequestContextSwitchFromISR is declared extern "C" so it can be defined in
+a C file without issues
+
+### PUS Services
+
+- It is now possible to change the message queue depth for the telecommand verification service (PUS1)
+- The same is possible for the event reporting service (PUS5)
+- PUS Health Service added, which allows to command and retrieve health via PUS packets
+
+
+### EnhancedControllerBase
+
+- New base class for a controller which also implements HasActionsIF and HasLocalDataPoolIF
+
+### Local Pool
+
+- Interface of LocalPools has changed. LocalPool is not a template anymore. Instead the size and
+bucket number of the pools per page and the number of pages are passed to the ctor instead of
+two ctor arguments and a template parameter
+
+### Parameter Service
+
+- The API of the parameter service has been changed to prevent inconsistencies
+between documentation and actual code and to clarify usage.
+- The parameter ID now consists of:
+	1. Domain ID (1 byte)
+	2. Unique Identifier (1 byte)
+	3. Linear Index (2 bytes)
+The linear index can be used for arrays as well as matrices.
+The parameter load command now explicitely expects the ECSS PTC and PFC
+information as well as  the rows and column number. Rows and column will
+default to one, which is equivalent to one scalar parameter (the most
+important use-case)
+   
+### File System Interface
+
+- A new interfaces specifies the functions for a software object which exposes the file system of
+a given hardware to use message based file handling (e.g. PUS commanding)
+
+### Internal Error Reporter
+
+- The new internal error reporter uses the local data pools. The pool IDs for
+the exisiting three error values and the new error set will be hardcoded for
+now, the the constructor for the internal error reporter just takes an object
+ID for now.
+
+### Device Handler Base
+
+- There is an additional `PERFORM_OPERATION` step for the device handler base. It is important
+that DHB users adapt their polling sequence tables to perform this step. This steps allows for 
+a clear distinction between operation and communication steps
+- setNormalDatapoolEntriesInvalid is not an abstract method and a default implementation was provided
+- getTransitionDelayMs is now an abstract method
+
+### DeviceHandlerIF
+
+- Typo for UNKNOWN_DEVICE_REPLY 
+
+### Events
+
+- makeEvent function: Now takes three input parameters instead of two and
+allows setting a unique ID. Event.cpp source file removed, functions now
+defined in header directly. Namespaces renamed. Functions declared `constexpr`
+now
+
+### Commanding Service Base
+
+- CSB uses the new fsfwconfig::FSFW_CSB_FIFO_DEPTH variable to determine  the FIFO depth for each 
+CSB instance. This variable has to be set in the FSFWConfig.h file
+
+### Service Interface
+
+- Proper printf support contained in ServiceInterfacePrinter.h
+- CPP ostream support now optional (can reduce executable size by 150 - 250 kB)
+- Amalagated header which determines automatically which service interface to use depending on FSFWConfig.h configuration. 
+  Users can just use #include <fsfw/serviceinterface/ServiceInterface.h>
+- If CPP streams are excluded, sif:: calls won't work anymore and need to be replaced by their printf counterparts. 
+  For the fsfw, this can be done by checking the processor define FSFW_CPP_OSTREAM_ENABLED from FSFWConfig.h. 
+  For mission code, developers need to replace sif:: calls by the printf counterparts, but only if the CPP stream are excluded. 
+  If this is not the case, everything should work as usual.
+
+### ActionHelper and ActionMessage
+
+- ActionHelper finish function and ActionMessage::setCompletionReply now expects explicit 
+information whether to report a success or failure message instead of deriving it implicitely 
+from returnvalue
+
+### PUS Parameter Service 20
+
+Added PUS parameter service 20 (only custom subservices available).

CMakeLists.txt

@@ -1,23 +1,115 @@
 cmake_minimum_required(VERSION 3.13)
 
-set(FSFW_VERSION 2)
-set(FSFW_SUBVERSION 0)
-set(FSFW_REVISION 0)
+set(MSG_PREFIX "fsfw |")
 
 # Add the cmake folder so the FindSphinx module is found
-set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake" ${CMAKE_MODULE_PATH})
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
+list(APPEND CMAKE_MODULE_PATH
+     "${CMAKE_CURRENT_SOURCE_DIR}/cmake/cmake-modules/bilke")
+list(APPEND CMAKE_MODULE_PATH
+     "${CMAKE_CURRENT_SOURCE_DIR}/cmake/cmake-modules/rpavlik")
 
-option(FSFW_GENERATE_SECTIONS
-    "Generate function and data sections. Required to remove unused code" ON
-)
-if(FSFW_GENERATE_SECTIONS)
-    option(FSFW_REMOVE_UNUSED_CODE "Remove unused code" ON)
+# ##############################################################################
+# Version file handling  #
+# ##############################################################################
+
+set(FSFW_VERSION_IF_GIT_FAILS 4)
+set(FSFW_SUBVERSION_IF_GIT_FAILS 0)
+set(FSFW_REVISION_IF_GIT_FAILS 0)
+
+set(FSFW_GIT_VER_HANDLING_OK FALSE)
+# Version handling
+if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/.git)
+  message(STATUS "${MSG_PREFIX} Determining version information with git")
+  include(FsfwHelpers)
+  determine_version_with_git("--exclude" "docker_*")
+  if(GIT_INFO)
+    set(FSFW_GIT_INFO
+        ${GIT_INFO}
+        CACHE STRING "Version information retrieved with git describe")
+    list(GET FSFW_GIT_INFO 1 FSFW_VERSION)
+    list(GET FSFW_GIT_INFO 2 FSFW_SUBVERSION)
+    list(GET FSFW_GIT_INFO 3 FSFW_REVISION)
+    list(GET FSFW_GIT_INFO 4 FSFW_VCS_INFO)
+    if(NOT FSFW_VERSION)
+      set(FSFW_VERSION ${FSFW_VERSION_IF_GIT_FAILS})
+    endif()
+    if(NOT FSFW_SUBVERSION)
+      set(FSFW_SUBVERSION ${FSFW_SUBVERSION_IF_GIT_FAILS})
+    endif()
+    if(NOT FSFW_REVISION)
+      set(FSFW_REVISION ${FSFW_REVISION_IF_GIT_FAILS})
+    endif()
+    set(FSFW_GIT_VER_HANDLING_OK TRUE)
+  else()
+    set(FSFW_GIT_VER_HANDLING_OK FALSE)
+  endif()
+endif()
+if(NOT FSFW_GIT_VER_HANDLING_OK)
+  set(FSFW_VERSION ${FSFW_VERSION_IF_GIT_FAILS})
+  set(FSFW_SUBVERSION ${FSFW_SUBVERSION_IF_GIT_FAILS})
+  set(FSFW_REVISION ${FSFW_REVISION_IF_GIT_FAILS})
 endif()
 
-option(FSFW_BUILD_UNITTESTS "Build unittest binary in addition to static library" OFF)
+set(LIB_FSFW_NAME fsfw)
+project(${LIB_FSFW_NAME}
+        VERSION ${FSFW_VERSION}.${FSFW_SUBVERSION}.${FSFW_REVISION})
+
+if(NOT CMAKE_CXX_STANDARD)
+  set(CMAKE_CXX_STANDARD 17)
+  set(CMAKE_CXX_STANDARD_REQUIRED True)
+elseif(${CMAKE_CXX_STANDARD} LESS 17)
+  message(
+    FATAL_ERROR
+      "${MSG_PREFIX} Compiling the FSFW requires a minimum of C++17 support")
+endif()
+
+set(FSFW_SOURCES_DIR "${CMAKE_SOURCE_DIR}/src/fsfw")
+
+set(FSFW_ETL_LIB_NAME etl)
+set(FSFW_ETL_LINK_TARGET etl::etl)
+set(FSFW_ETL_LIB_MAJOR_VERSION
+    20
+    CACHE STRING "ETL library major version requirement")
+set(FSFW_ETL_LIB_VERSION
+    ${FSFW_ETL_LIB_MAJOR_VERSION}.28.0
+    CACHE STRING "ETL library exact version requirement")
+set(FSFW_ETL_LINK_TARGET etl::etl)
+
+set(FSFW_CATCH2_LIB_MAJOR_VERSION
+    3
+    CACHE STRING "Catch2 library major version requirement")
+set(FSFW_CATCH2_LIB_VERSION
+    v${FSFW_CATCH2_LIB_MAJOR_VERSION}.0.0-preview5
+    CACHE STRING "Catch2 library exact version requirement")
+
+# Keep this off by default for now. See PR:
+# https://egit.irs.uni-stuttgart.de/fsfw/fsfw/pulls/616 for information which
+# keeping this on by default is problematic
+option(
+  FSFW_ENABLE_IPO
+  "Enable interprocedural optimization or link-time optimization if available"
+  OFF)
+if(FSFW_ENABLE_IPO)
+  include(CheckIPOSupported)
+  check_ipo_supported(RESULT IPO_SUPPORTED OUTPUT IPO_ERROR)
+  if(NOT IPO_SUPPORTED)
+    message(STATUS "FSFW | IPO/LTO not supported: ${IPO_ERROR}")
+  endif()
+endif()
+
+option(FSFW_GENERATE_SECTIONS
+       "Generate function and data sections. Required to remove unused code" ON)
+if(FSFW_GENERATE_SECTIONS)
+  option(FSFW_REMOVE_UNUSED_CODE "Remove unused code" ON)
+endif()
+
+option(FSFW_BUILD_TESTS
+       "Build unittest binary in addition to static library" OFF)
+option(FSFW_CICD_BUILD "Build for CI/CD. This can disable problematic test" OFF)
 option(FSFW_BUILD_DOCS "Build documentation with Sphinx and Doxygen" OFF)
-if(FSFW_BUILD_UNITTESTS)
-    option(FSFW_TESTS_GEN_COV "Generate coverage data for unittests" ON)
+if(FSFW_BUILD_TESTS)
+  option(FSFW_TESTS_GEN_COV "Generate coverage data for unittests" ON)
 endif()
 
 option(FSFW_WARNING_SHADOW_LOCAL_GCC "Enable -Wshadow=local warning in GCC" ON)
@@ -38,314 +130,334 @@ option(FSFW_ADD_TMSTORAGE "Compile with tm storage components" OFF)
 # Contrib sources
 option(FSFW_ADD_SGP4_PROPAGATOR "Add SGP4 propagator code" OFF)
 
-set(LIB_FSFW_NAME fsfw)
 set(FSFW_TEST_TGT fsfw-tests)
 set(FSFW_DUMMY_TGT fsfw-dummy)
 
-project(${LIB_FSFW_NAME})
 add_library(${LIB_FSFW_NAME})
 
-if(FSFW_BUILD_UNITTESTS)
-    message(STATUS "Building the FSFW unittests in addition to the static library")
-    # Check whether the user has already installed Catch2 first
-    find_package(Catch2 3)
-    # Not installed, so use FetchContent to download and provide Catch2
-    if(NOT Catch2_FOUND)
-        include(FetchContent)
+if(IPO_SUPPORTED AND FSFW_ENABLE_IPO)
+  set_property(TARGET ${LIB_FSFW_NAME} PROPERTY INTERPROCEDURAL_OPTIMIZATION
+                                                TRUE)
+endif()
 
-        FetchContent_Declare(
-            Catch2
-            GIT_REPOSITORY https://github.com/catchorg/Catch2.git
-            GIT_TAG        v3.0.0-preview3
-        )
+if(FSFW_BUILD_TESTS)
+  message(
+    STATUS
+      "${MSG_PREFIX} Building the FSFW unittests in addition to the static library"
+  )
+  # Check whether the user has already installed Catch2 first
+  find_package(Catch2 ${FSFW_CATCH2_LIB_MAJOR_VERSION})
+  # Not installed, so use FetchContent to download and provide Catch2
+  if(NOT Catch2_FOUND)
+    message(
+      STATUS
+        "${MSG_PREFIX} Catch2 installation not found. Downloading Catch2 library with FetchContent"
+    )
+    include(FetchContent)
 
-        FetchContent_MakeAvailable(Catch2)
-    endif()
+    FetchContent_Declare(
+      Catch2
+      GIT_REPOSITORY https://github.com/catchorg/Catch2.git
+      GIT_TAG ${FSFW_CATCH2_LIB_VERSION})
 
-    set(FSFW_CONFIG_PATH tests/src/fsfw_tests/unit/testcfg)
-    configure_file(tests/src/fsfw_tests/unit/testcfg/FSFWConfig.h.in FSFWConfig.h)
-    configure_file(tests/src/fsfw_tests/unit/testcfg/TestsConfig.h.in tests/TestsConfig.h)
+    list(APPEND FSFW_FETCH_CONTENT_TARGETS Catch2)
+  endif()
 
-    project(${FSFW_TEST_TGT} CXX C)
-    add_executable(${FSFW_TEST_TGT})
+  set(FSFW_CONFIG_PATH unittests/testcfg)
+  configure_file(unittests/testcfg/FSFWConfig.h.in FSFWConfig.h)
+  configure_file(unittests/testcfg/TestsConfig.h.in tests/TestsConfig.h)
 
-    if(FSFW_TESTS_GEN_COV)
-        message(STATUS "Generating coverage data for the library")
-        message(STATUS "Targets linking against ${LIB_FSFW_NAME} "
-            "will be compiled with coverage data as well"
-        )
-        include(FetchContent)
-        FetchContent_Declare(
-            cmake-modules
-            GIT_REPOSITORY https://github.com/bilke/cmake-modules.git
-        )
-        FetchContent_MakeAvailable(cmake-modules)
-        set(CMAKE_BUILD_TYPE "Debug")
-        list(APPEND CMAKE_MODULE_PATH ${cmake-modules_SOURCE_DIR})
-        include(CodeCoverage)
-    endif()
+  project(${FSFW_TEST_TGT} CXX C)
+  add_executable(${FSFW_TEST_TGT})
+  if(IPO_SUPPORTED AND FSFW_ENABLE_IPO)
+    set_property(TARGET ${FSFW_TEST_TGT} PROPERTY INTERPROCEDURAL_OPTIMIZATION
+                                                  TRUE)
+  endif()
+
+  if(FSFW_TESTS_GEN_COV)
+    message(STATUS "${MSG_PREFIX} Generating coverage data for the library")
+    message(STATUS "${MSG_PREFIX} Targets linking against ${LIB_FSFW_NAME} "
+                   "will be compiled with coverage data as well")
+    set(CMAKE_BUILD_TYPE "Debug")
+    include(CodeCoverage)
+  endif()
+endif()
+
+message(STATUS "${MSG_PREFIX} Finding and/or providing ETL library")
+
+# Check whether the user has already installed ETL first
+find_package(${FSFW_ETL_LIB_NAME} ${FSFW_ETL_LIB_MAJOR_VERSION} QUIET)
+# Not installed, so use FetchContent to download and provide etl
+if(NOT ${FSFW_ETL_LIB_NAME}_FOUND)
+  message(
+    STATUS
+      "No ETL installation was found with find_package. Installing and providing "
+      "etl with FindPackage")
+  include(FetchContent)
+
+  FetchContent_Declare(
+    ${FSFW_ETL_LIB_NAME}
+    GIT_REPOSITORY https://github.com/ETLCPP/etl
+    GIT_TAG ${FSFW_ETL_LIB_VERSION})
+
+  list(APPEND FSFW_FETCH_CONTENT_TARGETS ${FSFW_ETL_LIB_NAME})
+endif()
+
+# The documentation for FetchContent recommends declaring all the dependencies
+# before making them available. We make all declared dependency available here
+# after their declaration
+if(FSFW_FETCH_CONTENT_TARGETS)
+  FetchContent_MakeAvailable(${FSFW_FETCH_CONTENT_TARGETS})
+  if(TARGET ${FSFW_ETL_LIB_NAME})
+    add_library(${FSFW_ETL_LINK_TARGET} ALIAS ${FSFW_ETL_LIB_NAME})
+  endif()
+  if(TARGET Catch2)
+    # Fixes regression -preview4, to be confirmed in later releases Related
+    # GitHub issue: https://github.com/catchorg/Catch2/issues/2417
+    set_target_properties(Catch2 PROPERTIES DEBUG_POSTFIX "")
+  endif()
 endif()
 
 set(FSFW_CORE_INC_PATH "inc")
 
 set_property(CACHE FSFW_OSAL PROPERTY STRINGS host linux rtems freertos)
 
-# Configure Files
-target_include_directories(${LIB_FSFW_NAME} PRIVATE
-    ${CMAKE_CURRENT_BINARY_DIR}
-)
-target_include_directories(${LIB_FSFW_NAME} INTERFACE
-    ${CMAKE_CURRENT_BINARY_DIR}
-)
-
-if(NOT CMAKE_CXX_STANDARD)
-    set(CMAKE_CXX_STANDARD 11)
-    set(CMAKE_CXX_STANDARD_REQUIRED True)
-elseif(${CMAKE_CXX_STANDARD} LESS 11)
-    message(FATAL_ERROR "Compiling the FSFW requires a minimum of C++11 support")
-endif()
+# For configure files
+target_include_directories(${LIB_FSFW_NAME} PRIVATE ${CMAKE_CURRENT_BINARY_DIR})
+target_include_directories(${LIB_FSFW_NAME}
+                           INTERFACE ${CMAKE_CURRENT_BINARY_DIR})
 
 # Backwards comptability
 if(OS_FSFW AND NOT FSFW_OSAL)
-    message(WARNING "Please pass the FSFW OSAL as FSFW_OSAL instead of OS_FSFW")
-    set(FSFW_OSAL OS_FSFW)
+  message(
+    WARNING
+      "${MSG_PREFIX} Please pass the FSFW OSAL as FSFW_OSAL instead of OS_FSFW")
+  set(FSFW_OSAL OS_FSFW)
 endif()
 
 if(NOT FSFW_OSAL)
-	message(STATUS "No OS for FSFW via FSFW_OSAL set. Assuming host OS")
-	# Assume host OS and autodetermine from OS_FSFW
-	if(UNIX)
-		set(FSFW_OSAL  "linux" 
-			CACHE STRING 
-			"OS abstraction layer used in the FSFW"
-		)
-	elseif(WIN32)
-		set(FSFW_OSAL  "host" 
-			CACHE STRING "OS abstraction layer used in the FSFW"
-		)
-	endif()
-
+  message(STATUS "No OS for FSFW via FSFW_OSAL set. Assuming host OS")
+  # Assume host OS and autodetermine from OS_FSFW
+  if(UNIX)
+    set(FSFW_OSAL
+        "linux"
+        CACHE STRING "OS abstraction layer used in the FSFW")
+  elseif(WIN32)
+    set(FSFW_OSAL
+        "host"
+        CACHE STRING "OS abstraction layer used in the FSFW")
+  endif()
 endif()
 
 set(FSFW_OSAL_DEFINITION FSFW_OSAL_HOST)
 
 if(FSFW_OSAL MATCHES host)
-    set(FSFW_OS_NAME "Host")
-    set(FSFW_OSAL_HOST ON)
+  set(FSFW_OS_NAME "Host")
+  set(FSFW_OSAL_HOST ON)
 elseif(FSFW_OSAL MATCHES linux)
-    set(FSFW_OS_NAME "Linux")
-    set(FSFW_OSAL_LINUX ON)
+  set(FSFW_OS_NAME "Linux")
+  set(FSFW_OSAL_LINUX ON)
 elseif(FSFW_OSAL MATCHES freertos)
-    set(FSFW_OS_NAME "FreeRTOS")
-    set(FSFW_OSAL_FREERTOS ON)
-    target_link_libraries(${LIB_FSFW_NAME} PRIVATE
-        ${LIB_OS_NAME}
-    )
+  set(FSFW_OS_NAME "FreeRTOS")
+  set(FSFW_OSAL_FREERTOS ON)
+  target_link_libraries(${LIB_FSFW_NAME} PRIVATE ${LIB_OS_NAME})
 elseif(FSFW_OSAL STREQUAL rtems)
-    set(FSFW_OS_NAME "RTEMS")
-    set(FSFW_OSAL_RTEMS ON)
+  set(FSFW_OS_NAME "RTEMS")
+  set(FSFW_OSAL_RTEMS ON)
 else()
-    message(WARNING
-        "Invalid operating system for FSFW specified! Setting to host.."
-    )
-    set(FSFW_OS_NAME "Host")
-    set(OS_FSFW "host")
+  message(
+    WARNING
+      "${MSG_PREFIX} Invalid operating system for FSFW specified! Setting to host.."
+  )
+  set(FSFW_OS_NAME "Host")
+  set(OS_FSFW "host")
 endif()
 
-if(FSFW_BUILD_UNITTESTS OR FSFW_BUILD_DOCS)
-    configure_file(src/fsfw/FSFW.h.in fsfw/FSFW.h)
-    configure_file(src/fsfw/FSFWVersion.h.in fsfw/FSFWVersion.h)
-else()
-    configure_file(src/fsfw/FSFW.h.in FSFW.h)
-    configure_file(src/fsfw/FSFWVersion.h.in FSFWVersion.h)
-endif()
+configure_file(src/fsfw/FSFW.h.in fsfw/FSFW.h)
+configure_file(src/fsfw/FSFWVersion.h.in fsfw/FSFWVersion.h)
 
-message(STATUS "Compiling FSFW for the ${FSFW_OS_NAME} operating system.")
+message(
+  STATUS "${MSG_PREFIX} Compiling FSFW for the ${FSFW_OS_NAME} operating system"
+)
 
 add_subdirectory(src)
-add_subdirectory(tests)
-if(FSFW_ADD_HAL)
-    add_subdirectory(hal)
-endif()
 add_subdirectory(contrib)
+if(FSFW_BUILD_TESTS)
+  add_subdirectory(unittests)
+endif()
 if(FSFW_BUILD_DOCS)
-    add_subdirectory(docs)
+  add_subdirectory(docs)
 endif()
 
-if(FSFW_BUILD_UNITTESTS)
-    if(FSFW_TESTS_GEN_COV)
-        if(CMAKE_COMPILER_IS_GNUCXX)
-            include(CodeCoverage)
+if(FSFW_BUILD_TESTS)
+  if(FSFW_TESTS_GEN_COV)
+    if(CMAKE_COMPILER_IS_GNUCXX)
+      include(CodeCoverage)
 
-            # Remove quotes.
-            separate_arguments(COVERAGE_COMPILER_FLAGS
-                NATIVE_COMMAND "${COVERAGE_COMPILER_FLAGS}"
-            )
+      # Remove quotes.
+      separate_arguments(COVERAGE_COMPILER_FLAGS NATIVE_COMMAND
+                         "${COVERAGE_COMPILER_FLAGS}")
 
-            # Add compile options manually, we don't want coverage for Catch2
-            target_compile_options(${FSFW_TEST_TGT} PRIVATE
-                "${COVERAGE_COMPILER_FLAGS}"
-            )
-            target_compile_options(${LIB_FSFW_NAME} PRIVATE
-                "${COVERAGE_COMPILER_FLAGS}"
-            )
+      # Add compile options manually, we don't want coverage for Catch2
+      target_compile_options(${FSFW_TEST_TGT}
+                             PRIVATE "${COVERAGE_COMPILER_FLAGS}")
+      target_compile_options(${LIB_FSFW_NAME}
+                             PRIVATE "${COVERAGE_COMPILER_FLAGS}")
 
-            # Exclude directories here
-            if(WIN32)
-                set(GCOVR_ADDITIONAL_ARGS
-                    "--exclude-throw-branches"
-                    "--exclude-unreachable-branches"
-                )
-                set(COVERAGE_EXCLUDES
-                    "/c/msys64/mingw64/*"
-                )
-            elseif(UNIX)
-                set(COVERAGE_EXCLUDES
-                    "/usr/include/*" "/usr/bin/*" "Catch2/*"
-                    "/usr/local/include/*" "*/fsfw_tests/*"
-                    "*/catch2-src/*"
-                )
-            endif()
+      # Exclude directories here
+      if(WIN32)
+        set(GCOVR_ADDITIONAL_ARGS "--exclude-throw-branches"
+                                  "--exclude-unreachable-branches")
+        set(COVERAGE_EXCLUDES "/c/msys64/mingw64/*" "*/fsfw_hal/*")
+      elseif(UNIX)
+        set(COVERAGE_EXCLUDES
+            "/usr/include/*"
+            "/usr/bin/*"
+            "Catch2/*"
+            "/usr/local/include/*"
+            "*/fsfw_tests/*"
+            "*/catch2-src/*"
+            "*/fsfw_hal/*")
+      endif()
 
-            target_link_options(${FSFW_TEST_TGT} PRIVATE
-                -fprofile-arcs
-                -ftest-coverage
-            )
-            target_link_options(${LIB_FSFW_NAME} PRIVATE
-                -fprofile-arcs
-                -ftest-coverage
-            )
-            # Need to specify this as an interface, otherwise there will the compile issues
-            target_link_options(${LIB_FSFW_NAME} INTERFACE
-                -fprofile-arcs
-                -ftest-coverage
-            )
+      target_link_options(${FSFW_TEST_TGT} PRIVATE -fprofile-arcs
+                          -ftest-coverage)
+      target_link_options(${LIB_FSFW_NAME} PRIVATE -fprofile-arcs
+                          -ftest-coverage)
+      # Need to specify this as an interface, otherwise there will the compile
+      # issues
+      target_link_options(${LIB_FSFW_NAME} INTERFACE -fprofile-arcs
+                          -ftest-coverage)
 
-            if(WIN32)
-                setup_target_for_coverage_gcovr_html(
-                    NAME ${FSFW_TEST_TGT}_coverage
-                    EXECUTABLE ${FSFW_TEST_TGT}
-                    DEPENDENCIES ${FSFW_TEST_TGT}
-                )
-            else()
-                setup_target_for_coverage_lcov(
-                    NAME ${FSFW_TEST_TGT}_coverage
-                    EXECUTABLE ${FSFW_TEST_TGT}
-                    DEPENDENCIES ${FSFW_TEST_TGT}
-                )
-            endif()
-        endif()
+      if(WIN32)
+        setup_target_for_coverage_gcovr_html(
+          NAME ${FSFW_TEST_TGT}_coverage EXECUTABLE ${FSFW_TEST_TGT}
+          DEPENDENCIES ${FSFW_TEST_TGT})
+      else()
+        setup_target_for_coverage_lcov(
+          NAME ${FSFW_TEST_TGT}_coverage EXECUTABLE ${FSFW_TEST_TGT}
+          DEPENDENCIES ${FSFW_TEST_TGT})
+      endif()
     endif()
-    target_link_libraries(${FSFW_TEST_TGT} PRIVATE Catch2::Catch2 ${LIB_FSFW_NAME})
+  endif()
+  target_link_libraries(${FSFW_TEST_TGT} PRIVATE Catch2::Catch2
+                                                 ${LIB_FSFW_NAME})
 endif()
 
-# The project CMakeLists file has to set the FSFW_CONFIG_PATH and add it.
-# If this is not given, we include the default configuration and emit a warning.
+# The project CMakeLists file has to set the FSFW_CONFIG_PATH and add it. If
+# this is not given, we include the default configuration and emit a warning.
 if(NOT FSFW_CONFIG_PATH)
-    set(DEF_CONF_PATH misc/defaultcfg/fsfwconfig)
-    if(NOT FSFW_BUILD_DOCS)
-        message(WARNING "Flight Software Framework configuration path not set!")
-        message(WARNING "Setting default configuration from ${DEF_CONF_PATH} ..")
-    endif()
-    add_subdirectory(${DEF_CONF_PATH})
-    set(FSFW_CONFIG_PATH ${DEF_CONF_PATH})
+  set(DEF_CONF_PATH misc/defaultcfg/fsfwconfig)
+  if(NOT FSFW_BUILD_DOCS)
+    message(
+      WARNING
+        "${MSG_PREFIX} Flight Software Framework configuration path not set")
+    message(
+      WARNING
+        "${MSG_PREFIX} Setting default configuration from ${DEF_CONF_PATH} ..")
+  endif()
+  add_subdirectory(${DEF_CONF_PATH})
+  set(FSFW_CONFIG_PATH ${DEF_CONF_PATH})
 endif()
 
-# FSFW might be part of a possibly complicated folder structure, so we 
-# extract the absolute path of the fsfwconfig folder.
+# FSFW might be part of a possibly complicated folder structure, so we extract
+# the absolute path of the fsfwconfig folder.
 if(IS_ABSOLUTE ${FSFW_CONFIG_PATH})
-	set(FSFW_CONFIG_PATH_ABSOLUTE ${FSFW_CONFIG_PATH})
+  set(FSFW_CONFIG_PATH_ABSOLUTE ${FSFW_CONFIG_PATH})
 else()
-	get_filename_component(FSFW_CONFIG_PATH_ABSOLUTE
-		${FSFW_CONFIG_PATH} REALPATH BASE_DIR ${CMAKE_SOURCE_DIR}
-	)
+  get_filename_component(FSFW_CONFIG_PATH_ABSOLUTE ${FSFW_CONFIG_PATH} REALPATH
+                         BASE_DIR ${CMAKE_SOURCE_DIR})
 endif()
 
 foreach(INCLUDE_PATH ${FSFW_ADDITIONAL_INC_PATHS})
-    if(IS_ABSOLUTE ${INCLUDE_PATH})
-        set(CURR_ABS_INC_PATH "${INCLUDE_PATH}")
-    else()
-        get_filename_component(CURR_ABS_INC_PATH
-            ${INCLUDE_PATH} REALPATH BASE_DIR ${CMAKE_SOURCE_DIR})
-    endif()
+  if(IS_ABSOLUTE ${INCLUDE_PATH})
+    set(CURR_ABS_INC_PATH "${INCLUDE_PATH}")
+  else()
+    get_filename_component(CURR_ABS_INC_PATH ${INCLUDE_PATH} REALPATH BASE_DIR
+                           ${CMAKE_SOURCE_DIR})
+  endif()
 
-    if(CMAKE_VERBOSE)
-        message(STATUS "FSFW include path: ${CURR_ABS_INC_PATH}")
-    endif()
+  if(CMAKE_VERBOSE)
+    message(STATUS "FSFW include path: ${CURR_ABS_INC_PATH}")
+  endif()
 
-    list(APPEND FSFW_ADD_INC_PATHS_ABS ${CURR_ABS_INC_PATH})
+  list(APPEND FSFW_ADD_INC_PATHS_ABS ${CURR_ABS_INC_PATH})
 endforeach()
 
 if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
-    if(NOT DEFINED FSFW_WARNING_FLAGS)
-	   set(FSFW_WARNING_FLAGS
-		  -Wall
-		  -Wextra
-		  -Wimplicit-fallthrough=1
-		  -Wno-unused-parameter
-		  -Wno-psabi
-        )
-    endif()
+  if(NOT DEFINED FSFW_WARNING_FLAGS)
+    set(FSFW_WARNING_FLAGS
+        -Wall
+        -Wextra
+        -Wimplicit-fallthrough=1
+        -Wno-unused-parameter
+        -Wno-psabi
+        -Wduplicated-cond # check for duplicate conditions
+        -Wduplicated-branches # check for duplicate branches
+        -Wlogical-op # Search for bitwise operations instead of logical
+        -Wnull-dereference # Search for NULL dereference
+        -Wundef # Warn if undefind marcos are used
+        -Wformat=2 # Format string problem detection
+        -Wformat-overflow=2 # Formatting issues in printf
+        -Wformat-truncation=2 # Formatting issues in printf
+        -Wformat-security # Search for dangerous printf operations
+        -Wstrict-overflow=3 # Warn if integer overflows might happen
+        -Warray-bounds=2 # Some array bounds violations will be found
+        -Wshift-overflow=2 # Search for bit left shift overflows (<c++14)
+        -Wcast-qual # Warn if the constness is cast away
+        -Wstringop-overflow=4
+        # -Wstack-protector # Emits a few false positives for low level access
+        # -Wconversion # Creates many false positives -Warith-conversion # Use
+        # with Wconversion to find more implicit conversions -fanalyzer # Should
+        # be used to look through problems
+    )
+  endif()
 
-    if(FSFW_GENERATE_SECTIONS)
-        target_compile_options(${LIB_FSFW_NAME} PRIVATE
-            "-ffunction-sections"
-            "-fdata-sections"
-        )
-    endif()
+  if(FSFW_GENERATE_SECTIONS)
+    target_compile_options(${LIB_FSFW_NAME} PRIVATE "-ffunction-sections"
+                                                    "-fdata-sections")
+  endif()
+
+  if(FSFW_REMOVE_UNUSED_CODE)
+    target_link_options(${LIB_FSFW_NAME} PRIVATE "Wl,--gc-sections")
+  endif()
+
+  if(FSFW_WARNING_SHADOW_LOCAL_GCC)
+    list(APPEND WARNING_FLAGS "-Wshadow=local")
+  endif()
 
-    if(FSFW_REMOVE_UNUSED_CODE)
-        target_link_options(${LIB_FSFW_NAME} PRIVATE
-            "Wl,--gc-sections"
-        )
-    endif()
-  
-    if(FSFW_WARNING_SHADOW_LOCAL_GCC)
-        list(APPEND WARNING_FLAGS "-Wshadow=local")
-    endif()
-	
 endif()
 
 if(CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
-	set(COMPILER_FLAGS "/permissive-")
+  set(COMPILER_FLAGS "/permissive-")
 endif()
 
 # Required include paths to compile the FSFW
-target_include_directories(${LIB_FSFW_NAME} INTERFACE 
-	${CMAKE_SOURCE_DIR}
-	${FSFW_CONFIG_PATH_ABSOLUTE}
-	${FSFW_CORE_INC_PATH}
-	${FSFW_ADD_INC_PATHS_ABS}
-)
+target_include_directories(
+  ${LIB_FSFW_NAME} INTERFACE ${CMAKE_SOURCE_DIR} ${FSFW_CONFIG_PATH_ABSOLUTE}
+                             ${FSFW_CORE_INC_PATH} ${FSFW_ADD_INC_PATHS_ABS})
 
-# Includes path required to compile FSFW itself as well
-# We assume that the fsfwconfig folder uses include relative to the project
-# root here!
-target_include_directories(${LIB_FSFW_NAME} PRIVATE 
-	${CMAKE_SOURCE_DIR}
-	${FSFW_CONFIG_PATH_ABSOLUTE}
-	${FSFW_CORE_INC_PATH}
-	${FSFW_ADD_INC_PATHS_ABS}
-)
+# Includes path required to compile FSFW itself as well We assume that the
+# fsfwconfig folder uses include relative to the project root here!
+target_include_directories(
+  ${LIB_FSFW_NAME} PRIVATE ${CMAKE_SOURCE_DIR} ${FSFW_CONFIG_PATH_ABSOLUTE}
+                           ${FSFW_CORE_INC_PATH} ${FSFW_ADD_INC_PATHS_ABS})
 
-target_compile_options(${LIB_FSFW_NAME} PRIVATE 
-	${FSFW_WARNING_FLAGS}
-	${COMPILER_FLAGS}
-)
+target_compile_options(${LIB_FSFW_NAME} PRIVATE ${FSFW_WARNING_FLAGS}
+                                                ${COMPILER_FLAGS})
 
-target_link_libraries(${LIB_FSFW_NAME} PRIVATE
-    ${FSFW_ADDITIONAL_LINK_LIBS}
-)
+target_link_libraries(${LIB_FSFW_NAME} PRIVATE ${FSFW_ADDITIONAL_LINK_LIBS})
+target_link_libraries(${LIB_FSFW_NAME} PUBLIC ${FSFW_ETL_LINK_TARGET})
 
-string(CONCAT POST_BUILD_COMMENT
+string(
+  CONCAT
+    POST_BUILD_COMMENT
     "######################################################################\n"
     "Built FSFW v${FSFW_VERSION}.${FSFW_SUBVERSION}.${FSFW_REVISION}, "
     "Target OSAL: ${FSFW_OS_NAME}\n"
-    "######################################################################\n"
-)
+    "######################################################################\n")
 
 add_custom_command(
-   TARGET ${LIB_FSFW_NAME}
-   POST_BUILD
-   COMMENT ${POST_BUILD_COMMENT}
-)
+  TARGET ${LIB_FSFW_NAME}
+  POST_BUILD
+  COMMENT ${POST_BUILD_COMMENT})

README.md

@@ -11,9 +11,15 @@ with Airbus Defence and Space GmbH.
 
 ## Quick facts
 
-The framework is designed for systems, which communicate with external devices, perform control loops, receive telecommands and send telemetry, and need to maintain a high level of availability. Therefore, a mode and health system provides control over the states of the software and the controlled devices. In addition, a simple mechanism of event based fault detection, isolation and recovery is implemented as well. 
+The framework is designed for systems, which communicate with external devices, perform control loops, 
+receive telecommands and send telemetry, and need to maintain a high level of availability. Therefore,
+a mode and health system provides control over the states of the software and the controlled devices.
+In addition, a simple mechanism of event based fault detection, isolation and recovery is implemented as well. 
 
-The FSFW provides abstraction layers for operating systems to provide a uniform operating system abstraction layer (OSAL). Some components of this OSAL are required internally by the FSFW but is also very useful for developers to implement the same application logic on different operating systems with a uniform interface.
+The FSFW provides abstraction layers for operating systems to provide a uniform operating system
+abstraction layer (OSAL). Some components of this OSAL are required internally by the FSFW but is
+also very useful for developers to implement the same application logic on different operating
+systems with a uniform interface.
 
 Currently, the FSFW provides the following OSALs:
 
@@ -45,6 +51,28 @@ A template configuration folder was provided and can be copied into the project
 a starting point. The [configuration section](docs/README-config.md#top) provides more specific 
 information about the possible options.
 
+## Prerequisites
+
+The Embedded Template Library (etl) is a dependency of the FSFW which is automatically
+installed and provided by the build system unless the correction version was installed.
+The current recommended version can be found inside the fsfw `CMakeLists.txt` file or by using
+`ccmake` and looking up the `FSFW_ETL_LIB_MAJOR_VERSION` variable.
+
+You can install the ETL library like this. On Linux, it might be necessary to add `sudo` before
+the install call:
+
+```cpp
+git clone https://github.com/ETLCPP/etl
+cd etl
+git checkout <currentRecommendedVersion>
+mkdir build && cd build
+cmake ..
+cmake --install .
+```
+
+It is recommended to install `20.27.2` or newer for the package version handling of
+ETL to work.
+
 ## Adding the library
 
 The following steps show how to add and use FSFW components. It is still recommended to
@@ -71,9 +99,9 @@ add and link against the FSFW library in general.
 
 4. Link against the FSFW library
 
-	```cmake
-	target_link_libraries(<YourProjectName> PRIVATE fsfw)
-	```
+   ```sh
+   target_link_libraries(${YourProjectName} PRIVATE fsfw)
+   ```
 
 5. It should now be possible use the FSFW as a static library from the user code.
 
@@ -83,6 +111,19 @@ The FSFW also has unittests which use the [Catch2 library](https://github.com/ca
 These are built by setting the CMake option `FSFW_BUILD_UNITTESTS` to `ON` or `TRUE`
 from your project `CMakeLists.txt` file or from the command line.
 
+You can install the Catch2 library, which prevents the build system to avoid re-downloading
+the dependency if the unit tests are completely rebuilt. The current recommended version
+can be found inside the fsfw `CMakeLists.txt` file or by using `ccmake` and looking up
+the `FSFW_CATCH2_LIB_VERSION` variable.
+
+```sh
+git clone https://github.com/catchorg/Catch2.git
+cd Catch2
+git checkout <currentRecommendedVersion>
+cmake -Bbuild -H. -DBUILD_TESTING=OFF
+sudo cmake --build build/ --target install
+```
+
 The fsfw-tests binary will be built as part of the static library and dropped alongside it.
 If the unittests are built, the library and the tests will be built with coverage information by
 default. This can be disabled by setting the `FSFW_TESTS_COV_GEN` option to `OFF` or `FALSE`.
@@ -90,15 +131,15 @@ default. This can be disabled by setting the `FSFW_TESTS_COV_GEN` option to `OFF
 You can use the following commands inside the `fsfw` folder to set up the build system
 
 ```sh
-mkdir build-Unittest && cd build-Unittest
-cmake -DFSFW_BUILD_UNITTESTS=ON -DFSFW_OSAL=host ..
+mkdir build-tests && cd build-tests
+cmake -DFSFW_BUILD_UNITTESTS=ON -DFSFW_OSAL=host -DCMAKE_BUILD_TYPE=Debug ..
 ```
 
 You can also use `-DFSFW_OSAL=linux` on Linux systems.
 
 Coverage data in HTML format can be generated using the `CodeCoverage`
 [CMake module](https://github.com/bilke/cmake-modules/tree/master).
-To build the unittests, run them and then generare the coverage data in this format,
+To build the unittests, run them and then generate the coverage data in this format,
 the following command can be used inside the build directory after the build system was set up
 
 ```sh
@@ -107,11 +148,50 @@ cmake --build . -- fsfw-tests_coverage -j
 
 The `coverage.py` script located in the `script` folder can also be used to do this conveniently.
 
+## Building the documentations
+
+The FSFW documentation is built using the tools Sphinx, doxygen and breathe based on the
+instructions provided in  [this blogpost](https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/). If you
+want to do this locally, set up the prerequisites first. This requires a ``python3``
+installation as well. Example here is for Ubuntu.
+
+```sh
+sudo apt-get install doxygen graphviz
+```
+
+And the following Python packages
+
+```sh
+python3 -m pip install sphinx breathe
+```
+
+You can set up a documentation build system using the following commands
+
+```sh
+mkdir build-docs && cd build-docs
+cmake -DFSFW_BUILD_DOCS=ON -DFSFW_OSAL=host ..
+```
+
+Then you can generate the documentation using
+
+```sh
+cmake --build . -j
+```
+
+You can find the generated documentation inside the `docs/sphinx` folder inside the build
+folder. Simply open the `index.html` in the webbrowser of your choice.
+
+The `helper.py` script located in the script` folder can also be used to create, build
+and open the documentation conveniently. Try `helper.py -h for more information.
+
 ## Formatting the sources
 
 The formatting is done by the `clang-format` tool. The configuration is contained within the
 `.clang-format` file in the repository root. As long as `clang-format` is installed, you
-can run the `apply-clang-format.sh` helper script to format all source files consistently.
+can run the `auto-format.sh` helper script to format all source files consistently. Furthermore cmake-format is required to format CMake files which can be installed with:
+````sh
+sudo pip install cmakelang
+````
 
 ## Index
 

automation/Dockerfile

@@ -5,4 +5,16 @@ RUN apt-get --yes upgrade
 
 #tzdata is a dependency, won't install otherwise
 ARG DEBIAN_FRONTEND=noninteractive
-RUN apt-get --yes install gcc g++ cmake make lcov git valgrind nano
+RUN apt-get --yes install gcc g++ cmake make lcov git valgrind nano iputils-ping
+
+RUN git clone https://github.com/catchorg/Catch2.git && \
+	cd Catch2 && \
+	git checkout v3.0.0-preview5 && \
+	cmake -Bbuild -H. -DBUILD_TESTING=OFF && \
+	cmake --build build/ --target install
+
+RUN git clone https://github.com/ETLCPP/etl.git && \
+	cd etl && \
+	git checkout 20.28.0 && \
+	cmake -B build . && \
+	cmake --install build/

automation/Jenkinsfile

@@ -1,67 +1,38 @@
 pipeline {
-    agent any
     environment {
-        BUILDDIR = 'build-unittests'
+        BUILDDIR = 'build-tests'
+    }
+    agent {
+        docker { image 'fsfw-ci:d3'}
     }
     stages {
-        stage('Create Docker') {
-            agent {
-                dockerfile {
-                    dir 'automation'
-                    additionalBuildArgs  '--no-cache'
-                    reuseNode true
-                }
-            }
+        stage('Clean') {
             steps {
                 sh 'rm -rf $BUILDDIR'
             }
         }
         stage('Configure') {
-            agent {
-                dockerfile {
-                    dir 'automation'
-                    reuseNode true
-                }
-            }
             steps {
                 dir(BUILDDIR) {
-                    sh 'cmake -DFSFW_OSAL=host -DFSFW_BUILD_UNITTESTS=ON ..'
+                    sh 'cmake -DFSFW_OSAL=host -DFSFW_BUILD_TESTS=ON -DFSFW_CICD_BUILD=ON ..'
                 }
             }
         }
         stage('Build') {
-            agent {
-                dockerfile {
-                    dir 'automation'
-                    reuseNode true
-                }
-            }
             steps {
                 dir(BUILDDIR) {
-                    sh 'cmake --build . -j'
+                    sh 'cmake --build . -j4'
                 }
             }
         }
         stage('Unittests') {
-            agent {
-                dockerfile {
-                    dir 'automation'
-                    reuseNode true
-                }
-            }
             steps {
                 dir(BUILDDIR) {
-                    sh 'cmake --build . -- fsfw-tests_coverage -j'
+                    sh 'cmake --build . -- fsfw-tests_coverage -j4'
                 }
             }
         }
         stage('Valgrind') {
-            agent {
-                dockerfile {
-                    dir 'automation'
-                    reuseNode true
-                }
-            }
             steps {
                 dir(BUILDDIR) {
                     sh 'valgrind --leak-check=full --error-exitcode=1 ./fsfw-tests'

cmake/FsfwHelpers.cmake

@@ -0,0 +1,28 @@
+# Determines the git version with git describe and returns it by setting
+# the GIT_INFO list in the parent scope. The list has the following entries
+# 1. Full version string
+# 2. Major version
+# 3. Minor version
+# 4. Revision
+# 5. git SHA hash and commits since tag
+function(determine_version_with_git)
+    include(GetGitRevisionDescription)
+    git_describe(VERSION ${ARGN})
+    string(FIND ${VERSION} "." VALID_VERSION)
+    if(VALID_VERSION EQUAL -1)
+        message(WARNING "Version string ${VERSION} retrieved with git describe is invalid")
+        return()
+    endif()
+    # Parse the version information into pieces.
+    string(REGEX REPLACE "^v([0-9]+)\\..*" "\\1" _VERSION_MAJOR "${VERSION}")
+    string(REGEX REPLACE "^v[0-9]+\\.([0-9]+).*" "\\1" _VERSION_MINOR "${VERSION}")
+    string(REGEX REPLACE "^v[0-9]+\\.[0-9]+\\.([0-9]+).*" "\\1" _VERSION_PATCH "${VERSION}")
+    string(REGEX REPLACE "^v[0-9]+\\.[0-9]+\\.[0-9]+-(.*)" "\\1" VERSION_SHA1 "${VERSION}")
+    set(GIT_INFO ${VERSION})
+    list(APPEND GIT_INFO ${_VERSION_MAJOR})
+    list(APPEND GIT_INFO ${_VERSION_MINOR})
+    list(APPEND GIT_INFO ${_VERSION_PATCH})
+    list(APPEND GIT_INFO ${VERSION_SHA1})
+    set(GIT_INFO ${GIT_INFO} PARENT_SCOPE)
+    message(STATUS "${MSG_PREFIX} Set git version info into GIT_INFO from the git tag ${VERSION}")
+endfunction()

cmake/cmake-modules/README.md

@@ -0,0 +1,7 @@
+The files in the `bilke` folder were manually copy and pasted from the
+[cmake-modules repository](https://github.com/bilke/cmake-modules). It was decided to do
+this because only a small subset of its provided functions are needed.
+
+The files in the `rpavlik` folder were manually copy and pasted from the
+[cmake-modules repository](https://github.com/rpavlik/cmake-modules). It was decided to do
+this because only a small subset of its provided functions are needed.

cmake/cmake-modules/bilke/CodeCoverage.cmake

@@ -0,0 +1,719 @@
+# Copyright (c) 2012 - 2017, Lars Bilke
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+# 1. Redistributions of source code must retain the above copyright notice, this
+#    list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+#    this list of conditions and the following disclaimer in the documentation
+#    and/or other materials provided with the distribution.
+#
+# 3. Neither the name of the copyright holder nor the names of its contributors
+#    may be used to endorse or promote products derived from this software without
+#    specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+#
+# CHANGES:
+#
+# 2012-01-31, Lars Bilke
+# - Enable Code Coverage
+#
+# 2013-09-17, Joakim Söderberg
+# - Added support for Clang.
+# - Some additional usage instructions.
+#
+# 2016-02-03, Lars Bilke
+# - Refactored functions to use named parameters
+#
+# 2017-06-02, Lars Bilke
+# - Merged with modified version from github.com/ufz/ogs
+#
+# 2019-05-06, Anatolii Kurotych
+# - Remove unnecessary --coverage flag
+#
+# 2019-12-13, FeRD (Frank Dana)
+# - Deprecate COVERAGE_LCOVR_EXCLUDES and COVERAGE_GCOVR_EXCLUDES lists in favor
+#   of tool-agnostic COVERAGE_EXCLUDES variable, or EXCLUDE setup arguments.
+# - CMake 3.4+: All excludes can be specified relative to BASE_DIRECTORY
+# - All setup functions: accept BASE_DIRECTORY, EXCLUDE list
+# - Set lcov basedir with -b argument
+# - Add automatic --demangle-cpp in lcovr, if 'c++filt' is available (can be
+#   overridden with NO_DEMANGLE option in setup_target_for_coverage_lcovr().)
+# - Delete output dir, .info file on 'make clean'
+# - Remove Python detection, since version mismatches will break gcovr
+# - Minor cleanup (lowercase function names, update examples...)
+#
+# 2019-12-19, FeRD (Frank Dana)
+# - Rename Lcov outputs, make filtered file canonical, fix cleanup for targets
+#
+# 2020-01-19, Bob Apthorpe
+# - Added gfortran support
+#
+# 2020-02-17, FeRD (Frank Dana)
+# - Make all add_custom_target()s VERBATIM to auto-escape wildcard characters
+#   in EXCLUDEs, and remove manual escaping from gcovr targets
+#
+# 2021-01-19, Robin Mueller
+# - Add CODE_COVERAGE_VERBOSE option which will allow to print out commands which are run
+# - Added the option for users to set the GCOVR_ADDITIONAL_ARGS variable to supply additional
+#   flags to the gcovr command
+#
+# 2020-05-04, Mihchael Davis
+#     - Add -fprofile-abs-path to make gcno files contain absolute paths
+#     - Fix BASE_DIRECTORY not working when defined
+#     - Change BYPRODUCT from folder to index.html to stop ninja from complaining about double defines
+#
+# 2021-05-10, Martin Stump
+#     - Check if the generator is multi-config before warning about non-Debug builds
+#
+# 2022-02-22, Marko Wehle
+#     - Change gcovr output from -o <filename> for --xml <filename> and --html <filename> output respectively.
+#       This will allow for Multiple Output Formats at the same time by making use of GCOVR_ADDITIONAL_ARGS, e.g. GCOVR_ADDITIONAL_ARGS "--txt".
+#
+# USAGE:
+#
+# 1. Copy this file into your cmake modules path.
+#
+# 2. Add the following line to your CMakeLists.txt (best inside an if-condition
+#    using a CMake option() to enable it just optionally):
+#      include(CodeCoverage)
+#
+# 3. Append necessary compiler flags for all supported source files:
+#      append_coverage_compiler_flags()
+#    Or for specific target:
+#      append_coverage_compiler_flags_to_target(YOUR_TARGET_NAME)
+#
+# 3.a (OPTIONAL) Set appropriate optimization flags, e.g. -O0, -O1 or -Og
+#
+# 4. If you need to exclude additional directories from the report, specify them
+#    using full paths in the COVERAGE_EXCLUDES variable before calling
+#    setup_target_for_coverage_*().
+#    Example:
+#      set(COVERAGE_EXCLUDES
+#          '${PROJECT_SOURCE_DIR}/src/dir1/*'
+#          '/path/to/my/src/dir2/*')
+#    Or, use the EXCLUDE argument to setup_target_for_coverage_*().
+#    Example:
+#      setup_target_for_coverage_lcov(
+#          NAME coverage
+#          EXECUTABLE testrunner
+#          EXCLUDE "${PROJECT_SOURCE_DIR}/src/dir1/*" "/path/to/my/src/dir2/*")
+#
+# 4.a NOTE: With CMake 3.4+, COVERAGE_EXCLUDES or EXCLUDE can also be set
+#     relative to the BASE_DIRECTORY (default: PROJECT_SOURCE_DIR)
+#     Example:
+#       set(COVERAGE_EXCLUDES "dir1/*")
+#       setup_target_for_coverage_gcovr_html(
+#           NAME coverage
+#           EXECUTABLE testrunner
+#           BASE_DIRECTORY "${PROJECT_SOURCE_DIR}/src"
+#           EXCLUDE "dir2/*")
+#
+# 5. Use the functions described below to create a custom make target which
+#    runs your test executable and produces a code coverage report.
+#
+# 6. Build a Debug build:
+#      cmake -DCMAKE_BUILD_TYPE=Debug ..
+#      make
+#      make my_coverage_target
+#
+
+include(CMakeParseArguments)
+
+option(CODE_COVERAGE_VERBOSE "Verbose information" FALSE)
+
+# Check prereqs
+find_program( GCOV_PATH gcov )
+find_program( LCOV_PATH  NAMES lcov lcov.bat lcov.exe lcov.perl)
+find_program( FASTCOV_PATH NAMES fastcov fastcov.py )
+find_program( GENHTML_PATH NAMES genhtml genhtml.perl genhtml.bat )
+find_program( GCOVR_PATH gcovr PATHS ${CMAKE_SOURCE_DIR}/scripts/test)
+find_program( CPPFILT_PATH NAMES c++filt )
+
+if(NOT GCOV_PATH)
+    message(FATAL_ERROR "gcov not found! Aborting...")
+endif() # NOT GCOV_PATH
+
+get_property(LANGUAGES GLOBAL PROPERTY ENABLED_LANGUAGES)
+list(GET LANGUAGES 0 LANG)
+
+if("${CMAKE_${LANG}_COMPILER_ID}" MATCHES "(Apple)?[Cc]lang")
+    if("${CMAKE_${LANG}_COMPILER_VERSION}" VERSION_LESS 3)
+        message(FATAL_ERROR "Clang version must be 3.0.0 or greater! Aborting...")
+    endif()
+elseif(NOT CMAKE_COMPILER_IS_GNUCXX)
+    if("${CMAKE_Fortran_COMPILER_ID}" MATCHES "[Ff]lang")
+        # Do nothing; exit conditional without error if true
+    elseif("${CMAKE_Fortran_COMPILER_ID}" MATCHES "GNU")
+        # Do nothing; exit conditional without error if true
+    else()
+        message(FATAL_ERROR "Compiler is not GNU gcc! Aborting...")
+    endif()
+endif()
+
+set(COVERAGE_COMPILER_FLAGS "-g -fprofile-arcs -ftest-coverage"
+    CACHE INTERNAL "")
+if(CMAKE_CXX_COMPILER_ID MATCHES "(GNU|Clang)")
+    include(CheckCXXCompilerFlag)
+    check_cxx_compiler_flag(-fprofile-abs-path HAVE_fprofile_abs_path)
+    if(HAVE_fprofile_abs_path)
+        set(COVERAGE_COMPILER_FLAGS "${COVERAGE_COMPILER_FLAGS} -fprofile-abs-path")
+    endif()
+endif()
+
+set(CMAKE_Fortran_FLAGS_COVERAGE
+    ${COVERAGE_COMPILER_FLAGS}
+    CACHE STRING "Flags used by the Fortran compiler during coverage builds."
+    FORCE )
+set(CMAKE_CXX_FLAGS_COVERAGE
+    ${COVERAGE_COMPILER_FLAGS}
+    CACHE STRING "Flags used by the C++ compiler during coverage builds."
+    FORCE )
+set(CMAKE_C_FLAGS_COVERAGE
+    ${COVERAGE_COMPILER_FLAGS}
+    CACHE STRING "Flags used by the C compiler during coverage builds."
+    FORCE )
+set(CMAKE_EXE_LINKER_FLAGS_COVERAGE
+    ""
+    CACHE STRING "Flags used for linking binaries during coverage builds."
+    FORCE )
+set(CMAKE_SHARED_LINKER_FLAGS_COVERAGE
+    ""
+    CACHE STRING "Flags used by the shared libraries linker during coverage builds."
+    FORCE )
+mark_as_advanced(
+    CMAKE_Fortran_FLAGS_COVERAGE
+    CMAKE_CXX_FLAGS_COVERAGE
+    CMAKE_C_FLAGS_COVERAGE
+    CMAKE_EXE_LINKER_FLAGS_COVERAGE
+    CMAKE_SHARED_LINKER_FLAGS_COVERAGE )
+
+get_property(GENERATOR_IS_MULTI_CONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
+if(NOT (CMAKE_BUILD_TYPE STREQUAL "Debug" OR GENERATOR_IS_MULTI_CONFIG))
+    message(WARNING "Code coverage results with an optimised (non-Debug) build may be misleading")
+endif() # NOT (CMAKE_BUILD_TYPE STREQUAL "Debug" OR GENERATOR_IS_MULTI_CONFIG)
+
+if(CMAKE_C_COMPILER_ID STREQUAL "GNU" OR CMAKE_Fortran_COMPILER_ID STREQUAL "GNU")
+    link_libraries(gcov)
+endif()
+
+# Defines a target for running and collection code coverage information
+# Builds dependencies, runs the given executable and outputs reports.
+# NOTE! The executable should always have a ZERO as exit code otherwise
+# the coverage generation will not complete.
+#
+# setup_target_for_coverage_lcov(
+#     NAME testrunner_coverage                    # New target name
+#     EXECUTABLE testrunner -j ${PROCESSOR_COUNT} # Executable in PROJECT_BINARY_DIR
+#     DEPENDENCIES testrunner                     # Dependencies to build first
+#     BASE_DIRECTORY "../"                        # Base directory for report
+#                                                 #  (defaults to PROJECT_SOURCE_DIR)
+#     EXCLUDE "src/dir1/*" "src/dir2/*"           # Patterns to exclude (can be relative
+#                                                 #  to BASE_DIRECTORY, with CMake 3.4+)
+#     NO_DEMANGLE                                 # Don't demangle C++ symbols
+#                                                 #  even if c++filt is found
+# )
+function(setup_target_for_coverage_lcov)
+
+    set(options NO_DEMANGLE)
+    set(oneValueArgs BASE_DIRECTORY NAME)
+    set(multiValueArgs EXCLUDE EXECUTABLE EXECUTABLE_ARGS DEPENDENCIES LCOV_ARGS GENHTML_ARGS)
+    cmake_parse_arguments(Coverage "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
+
+    if(NOT LCOV_PATH)
+        message(FATAL_ERROR "lcov not found! Aborting...")
+    endif() # NOT LCOV_PATH
+
+    if(NOT GENHTML_PATH)
+        message(FATAL_ERROR "genhtml not found! Aborting...")
+    endif() # NOT GENHTML_PATH
+
+    # Set base directory (as absolute path), or default to PROJECT_SOURCE_DIR
+    if(DEFINED Coverage_BASE_DIRECTORY)
+        get_filename_component(BASEDIR ${Coverage_BASE_DIRECTORY} ABSOLUTE)
+    else()
+        set(BASEDIR ${PROJECT_SOURCE_DIR})
+    endif()
+
+    # Collect excludes (CMake 3.4+: Also compute absolute paths)
+    set(LCOV_EXCLUDES "")
+    foreach(EXCLUDE ${Coverage_EXCLUDE} ${COVERAGE_EXCLUDES} ${COVERAGE_LCOV_EXCLUDES})
+        if(CMAKE_VERSION VERSION_GREATER 3.4)
+            get_filename_component(EXCLUDE ${EXCLUDE} ABSOLUTE BASE_DIR ${BASEDIR})
+        endif()
+        list(APPEND LCOV_EXCLUDES "${EXCLUDE}")
+    endforeach()
+    list(REMOVE_DUPLICATES LCOV_EXCLUDES)
+
+    # Conditional arguments
+    if(CPPFILT_PATH AND NOT ${Coverage_NO_DEMANGLE})
+      set(GENHTML_EXTRA_ARGS "--demangle-cpp")
+    endif()
+     
+    # Setting up commands which will be run to generate coverage data.
+    # Cleanup lcov
+    set(LCOV_CLEAN_CMD 
+        ${LCOV_PATH} ${Coverage_LCOV_ARGS} --gcov-tool ${GCOV_PATH} -directory . 
+        -b ${BASEDIR} --zerocounters
+    )
+    # Create baseline to make sure untouched files show up in the report
+    set(LCOV_BASELINE_CMD 
+        ${LCOV_PATH} ${Coverage_LCOV_ARGS} --gcov-tool ${GCOV_PATH} -c -i -d . -b 
+        ${BASEDIR} -o ${Coverage_NAME}.base
+    )
+    # Run tests
+    set(LCOV_EXEC_TESTS_CMD 
+        ${Coverage_EXECUTABLE} ${Coverage_EXECUTABLE_ARGS}
+    )    
+    # Capturing lcov counters and generating report
+    set(LCOV_CAPTURE_CMD 
+        ${LCOV_PATH} ${Coverage_LCOV_ARGS} --gcov-tool ${GCOV_PATH} --directory . -b 
+        ${BASEDIR} --capture --output-file ${Coverage_NAME}.capture
+    )
+    # add baseline counters
+    set(LCOV_BASELINE_COUNT_CMD
+        ${LCOV_PATH} ${Coverage_LCOV_ARGS} --gcov-tool ${GCOV_PATH} -a ${Coverage_NAME}.base 
+        -a ${Coverage_NAME}.capture --output-file ${Coverage_NAME}.total
+    ) 
+    # filter collected data to final coverage report
+    set(LCOV_FILTER_CMD 
+        ${LCOV_PATH} ${Coverage_LCOV_ARGS} --gcov-tool ${GCOV_PATH} --remove 
+        ${Coverage_NAME}.total ${LCOV_EXCLUDES} --output-file ${Coverage_NAME}.info
+    )    
+    # Generate HTML output
+    set(LCOV_GEN_HTML_CMD
+        ${GENHTML_PATH} ${GENHTML_EXTRA_ARGS} ${Coverage_GENHTML_ARGS} -o 
+        ${Coverage_NAME} ${Coverage_NAME}.info
+    )
+    
+
+    if(CODE_COVERAGE_VERBOSE)
+        message(STATUS "Executed command report")
+        message(STATUS "Command to clean up lcov: ")
+        string(REPLACE ";" " " LCOV_CLEAN_CMD_SPACED "${LCOV_CLEAN_CMD}")
+        message(STATUS "${LCOV_CLEAN_CMD_SPACED}")
+
+        message(STATUS "Command to create baseline: ")
+        string(REPLACE ";" " " LCOV_BASELINE_CMD_SPACED "${LCOV_BASELINE_CMD}")
+        message(STATUS "${LCOV_BASELINE_CMD_SPACED}")
+
+        message(STATUS "Command to run the tests: ")
+        string(REPLACE ";" " " LCOV_EXEC_TESTS_CMD_SPACED "${LCOV_EXEC_TESTS_CMD}")
+        message(STATUS "${LCOV_EXEC_TESTS_CMD_SPACED}")
+
+        message(STATUS "Command to capture counters and generate report: ")
+        string(REPLACE ";" " " LCOV_CAPTURE_CMD_SPACED "${LCOV_CAPTURE_CMD}")
+        message(STATUS "${LCOV_CAPTURE_CMD_SPACED}")
+
+        message(STATUS "Command to add baseline counters: ")
+        string(REPLACE ";" " " LCOV_BASELINE_COUNT_CMD_SPACED "${LCOV_BASELINE_COUNT_CMD}")
+        message(STATUS "${LCOV_BASELINE_COUNT_CMD_SPACED}")
+
+        message(STATUS "Command to filter collected data: ")
+        string(REPLACE ";" " " LCOV_FILTER_CMD_SPACED "${LCOV_FILTER_CMD}")
+        message(STATUS "${LCOV_FILTER_CMD_SPACED}")
+
+        message(STATUS "Command to generate lcov HTML output: ")
+        string(REPLACE ";" " " LCOV_GEN_HTML_CMD_SPACED "${LCOV_GEN_HTML_CMD}")
+        message(STATUS "${LCOV_GEN_HTML_CMD_SPACED}")
+    endif()
+
+    # Setup target
+    add_custom_target(${Coverage_NAME}
+        COMMAND ${LCOV_CLEAN_CMD}
+        COMMAND ${LCOV_BASELINE_CMD} 
+        COMMAND ${LCOV_EXEC_TESTS_CMD}
+        COMMAND ${LCOV_CAPTURE_CMD}
+        COMMAND ${LCOV_BASELINE_COUNT_CMD}
+        COMMAND ${LCOV_FILTER_CMD} 
+        COMMAND ${LCOV_GEN_HTML_CMD}
+
+        # Set output files as GENERATED (will be removed on 'make clean')
+        BYPRODUCTS
+            ${Coverage_NAME}.base
+            ${Coverage_NAME}.capture
+            ${Coverage_NAME}.total
+            ${Coverage_NAME}.info
+            ${Coverage_NAME}/index.html
+        WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
+        DEPENDS ${Coverage_DEPENDENCIES}
+        VERBATIM # Protect arguments to commands
+        COMMENT "Resetting code coverage counters to zero.\nProcessing code coverage counters and generating report."
+    )
+
+    # Show where to find the lcov info report
+    add_custom_command(TARGET ${Coverage_NAME} POST_BUILD
+        COMMAND ;
+        COMMENT "Lcov code coverage info report saved in ${Coverage_NAME}.info."
+    )
+
+    # Show info where to find the report
+    add_custom_command(TARGET ${Coverage_NAME} POST_BUILD
+        COMMAND ;
+        COMMENT "Open ./${Coverage_NAME}/index.html in your browser to view the coverage report."
+    )
+
+endfunction() # setup_target_for_coverage_lcov
+
+# Defines a target for running and collection code coverage information
+# Builds dependencies, runs the given executable and outputs reports.
+# NOTE! The executable should always have a ZERO as exit code otherwise
+# the coverage generation will not complete.
+#
+# setup_target_for_coverage_gcovr_xml(
+#     NAME ctest_coverage                    # New target name
+#     EXECUTABLE ctest -j ${PROCESSOR_COUNT} # Executable in PROJECT_BINARY_DIR
+#     DEPENDENCIES executable_target         # Dependencies to build first
+#     BASE_DIRECTORY "../"                   # Base directory for report
+#                                            #  (defaults to PROJECT_SOURCE_DIR)
+#     EXCLUDE "src/dir1/*" "src/dir2/*"      # Patterns to exclude (can be relative
+#                                            #  to BASE_DIRECTORY, with CMake 3.4+)
+# )
+# The user can set the variable GCOVR_ADDITIONAL_ARGS to supply additional flags to the
+# GCVOR command.
+function(setup_target_for_coverage_gcovr_xml)
+
+    set(options NONE)
+    set(oneValueArgs BASE_DIRECTORY NAME)
+    set(multiValueArgs EXCLUDE EXECUTABLE EXECUTABLE_ARGS DEPENDENCIES)
+    cmake_parse_arguments(Coverage "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
+
+    if(NOT GCOVR_PATH)
+        message(FATAL_ERROR "gcovr not found! Aborting...")
+    endif() # NOT GCOVR_PATH
+
+    # Set base directory (as absolute path), or default to PROJECT_SOURCE_DIR
+    if(DEFINED Coverage_BASE_DIRECTORY)
+        get_filename_component(BASEDIR ${Coverage_BASE_DIRECTORY} ABSOLUTE)
+    else()
+        set(BASEDIR ${PROJECT_SOURCE_DIR})
+    endif()
+
+    # Collect excludes (CMake 3.4+: Also compute absolute paths)
+    set(GCOVR_EXCLUDES "")
+    foreach(EXCLUDE ${Coverage_EXCLUDE} ${COVERAGE_EXCLUDES} ${COVERAGE_GCOVR_EXCLUDES})
+        if(CMAKE_VERSION VERSION_GREATER 3.4)
+            get_filename_component(EXCLUDE ${EXCLUDE} ABSOLUTE BASE_DIR ${BASEDIR})
+        endif()
+        list(APPEND GCOVR_EXCLUDES "${EXCLUDE}")
+    endforeach()
+    list(REMOVE_DUPLICATES GCOVR_EXCLUDES)
+
+    # Combine excludes to several -e arguments
+    set(GCOVR_EXCLUDE_ARGS "")
+    foreach(EXCLUDE ${GCOVR_EXCLUDES})
+        list(APPEND GCOVR_EXCLUDE_ARGS "-e")
+        list(APPEND GCOVR_EXCLUDE_ARGS "${EXCLUDE}")
+    endforeach()
+    
+    # Set up commands which will be run to generate coverage data
+    # Run tests
+    set(GCOVR_XML_EXEC_TESTS_CMD
+        ${Coverage_EXECUTABLE} ${Coverage_EXECUTABLE_ARGS}
+    )
+    # Running gcovr
+    set(GCOVR_XML_CMD
+        ${GCOVR_PATH} --xml ${Coverage_NAME}.xml -r ${BASEDIR} ${GCOVR_ADDITIONAL_ARGS}
+        ${GCOVR_EXCLUDE_ARGS} --object-directory=${PROJECT_BINARY_DIR}
+    )
+    
+    if(CODE_COVERAGE_VERBOSE)
+        message(STATUS "Executed command report")
+
+        message(STATUS "Command to run tests: ")
+        string(REPLACE ";" " " GCOVR_XML_EXEC_TESTS_CMD_SPACED "${GCOVR_XML_EXEC_TESTS_CMD}")
+        message(STATUS "${GCOVR_XML_EXEC_TESTS_CMD_SPACED}")
+
+        message(STATUS "Command to generate gcovr XML coverage data: ")
+        string(REPLACE ";" " " GCOVR_XML_CMD_SPACED "${GCOVR_XML_CMD}")
+        message(STATUS "${GCOVR_XML_CMD_SPACED}")
+    endif()
+
+    add_custom_target(${Coverage_NAME}
+        COMMAND ${GCOVR_XML_EXEC_TESTS_CMD}
+        COMMAND ${GCOVR_XML_CMD}
+        
+        BYPRODUCTS ${Coverage_NAME}.xml
+        WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
+        DEPENDS ${Coverage_DEPENDENCIES}
+        VERBATIM # Protect arguments to commands
+        COMMENT "Running gcovr to produce Cobertura code coverage report."
+    )
+
+    # Show info where to find the report
+    add_custom_command(TARGET ${Coverage_NAME} POST_BUILD
+        COMMAND ;
+        COMMENT "Cobertura code coverage report saved in ${Coverage_NAME}.xml."
+    )
+endfunction() # setup_target_for_coverage_gcovr_xml
+
+# Defines a target for running and collection code coverage information
+# Builds dependencies, runs the given executable and outputs reports.
+# NOTE! The executable should always have a ZERO as exit code otherwise
+# the coverage generation will not complete.
+#
+# setup_target_for_coverage_gcovr_html(
+#     NAME ctest_coverage                    # New target name
+#     EXECUTABLE ctest -j ${PROCESSOR_COUNT} # Executable in PROJECT_BINARY_DIR
+#     DEPENDENCIES executable_target         # Dependencies to build first
+#     BASE_DIRECTORY "../"                   # Base directory for report
+#                                            #  (defaults to PROJECT_SOURCE_DIR)
+#     EXCLUDE "src/dir1/*" "src/dir2/*"      # Patterns to exclude (can be relative
+#                                            #  to BASE_DIRECTORY, with CMake 3.4+)
+# )
+# The user can set the variable GCOVR_ADDITIONAL_ARGS to supply additional flags to the
+# GCVOR command.
+function(setup_target_for_coverage_gcovr_html)
+
+    set(options NONE)
+    set(oneValueArgs BASE_DIRECTORY NAME)
+    set(multiValueArgs EXCLUDE EXECUTABLE EXECUTABLE_ARGS DEPENDENCIES)
+    cmake_parse_arguments(Coverage "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
+
+    if(NOT GCOVR_PATH)
+        message(FATAL_ERROR "gcovr not found! Aborting...")
+    endif() # NOT GCOVR_PATH
+
+    # Set base directory (as absolute path), or default to PROJECT_SOURCE_DIR
+    if(DEFINED Coverage_BASE_DIRECTORY)
+        get_filename_component(BASEDIR ${Coverage_BASE_DIRECTORY} ABSOLUTE)
+    else()
+        set(BASEDIR ${PROJECT_SOURCE_DIR})
+    endif()
+
+    # Collect excludes (CMake 3.4+: Also compute absolute paths)
+    set(GCOVR_EXCLUDES "")
+    foreach(EXCLUDE ${Coverage_EXCLUDE} ${COVERAGE_EXCLUDES} ${COVERAGE_GCOVR_EXCLUDES})
+        if(CMAKE_VERSION VERSION_GREATER 3.4)
+            get_filename_component(EXCLUDE ${EXCLUDE} ABSOLUTE BASE_DIR ${BASEDIR})
+        endif()
+        list(APPEND GCOVR_EXCLUDES "${EXCLUDE}")
+    endforeach()
+    list(REMOVE_DUPLICATES GCOVR_EXCLUDES)
+
+    # Combine excludes to several -e arguments
+    set(GCOVR_EXCLUDE_ARGS "")
+    foreach(EXCLUDE ${GCOVR_EXCLUDES})
+        list(APPEND GCOVR_EXCLUDE_ARGS "-e")
+        list(APPEND GCOVR_EXCLUDE_ARGS "${EXCLUDE}")
+    endforeach()
+
+    # Set up commands which will be run to generate coverage data
+    # Run tests
+    set(GCOVR_HTML_EXEC_TESTS_CMD
+        ${Coverage_EXECUTABLE} ${Coverage_EXECUTABLE_ARGS}
+    )
+    # Create folder
+    set(GCOVR_HTML_FOLDER_CMD
+        ${CMAKE_COMMAND} -E make_directory ${PROJECT_BINARY_DIR}/${Coverage_NAME}
+    )
+    # Running gcovr
+    set(GCOVR_HTML_CMD
+        ${GCOVR_PATH} --html ${Coverage_NAME}/index.html --html-details -r ${BASEDIR} ${GCOVR_ADDITIONAL_ARGS}
+        ${GCOVR_EXCLUDE_ARGS} --object-directory=${PROJECT_BINARY_DIR}
+    )
+
+    if(CODE_COVERAGE_VERBOSE)
+        message(STATUS "Executed command report")
+
+        message(STATUS "Command to run tests: ")
+        string(REPLACE ";" " " GCOVR_HTML_EXEC_TESTS_CMD_SPACED "${GCOVR_HTML_EXEC_TESTS_CMD}")
+        message(STATUS "${GCOVR_HTML_EXEC_TESTS_CMD_SPACED}")
+
+        message(STATUS "Command to create a folder: ")
+        string(REPLACE ";" " " GCOVR_HTML_FOLDER_CMD_SPACED "${GCOVR_HTML_FOLDER_CMD}")
+        message(STATUS "${GCOVR_HTML_FOLDER_CMD_SPACED}")
+
+        message(STATUS "Command to generate gcovr HTML coverage data: ")
+        string(REPLACE ";" " " GCOVR_HTML_CMD_SPACED "${GCOVR_HTML_CMD}")
+        message(STATUS "${GCOVR_HTML_CMD_SPACED}")
+    endif()
+
+    add_custom_target(${Coverage_NAME}
+        COMMAND ${GCOVR_HTML_EXEC_TESTS_CMD}
+        COMMAND ${GCOVR_HTML_FOLDER_CMD}
+        COMMAND ${GCOVR_HTML_CMD}
+
+        BYPRODUCTS ${PROJECT_BINARY_DIR}/${Coverage_NAME}/index.html  # report directory
+        WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
+        DEPENDS ${Coverage_DEPENDENCIES}
+        VERBATIM # Protect arguments to commands
+        COMMENT "Running gcovr to produce HTML code coverage report."
+    )
+
+    # Show info where to find the report
+    add_custom_command(TARGET ${Coverage_NAME} POST_BUILD
+        COMMAND ;
+        COMMENT "Open ./${Coverage_NAME}/index.html in your browser to view the coverage report."
+    )
+
+endfunction() # setup_target_for_coverage_gcovr_html
+
+# Defines a target for running and collection code coverage information
+# Builds dependencies, runs the given executable and outputs reports.
+# NOTE! The executable should always have a ZERO as exit code otherwise
+# the coverage generation will not complete.
+#
+# setup_target_for_coverage_fastcov(
+#     NAME testrunner_coverage                    # New target name
+#     EXECUTABLE testrunner -j ${PROCESSOR_COUNT} # Executable in PROJECT_BINARY_DIR
+#     DEPENDENCIES testrunner                     # Dependencies to build first
+#     BASE_DIRECTORY "../"                        # Base directory for report
+#                                                 #  (defaults to PROJECT_SOURCE_DIR)
+#     EXCLUDE "src/dir1/" "src/dir2/"             # Patterns to exclude.
+#     NO_DEMANGLE                                 # Don't demangle C++ symbols
+#                                                 #  even if c++filt is found
+#     SKIP_HTML                                   # Don't create html report
+#     POST_CMD perl -i -pe s!${PROJECT_SOURCE_DIR}/!!g ctest_coverage.json  # E.g. for stripping source dir from file paths
+# )
+function(setup_target_for_coverage_fastcov)
+
+    set(options NO_DEMANGLE SKIP_HTML)
+    set(oneValueArgs BASE_DIRECTORY NAME)
+    set(multiValueArgs EXCLUDE EXECUTABLE EXECUTABLE_ARGS DEPENDENCIES FASTCOV_ARGS GENHTML_ARGS POST_CMD)
+    cmake_parse_arguments(Coverage "${options}" "${oneValueArgs}" "${multiValueArgs}" ${ARGN})
+
+    if(NOT FASTCOV_PATH)
+        message(FATAL_ERROR "fastcov not found! Aborting...")
+    endif()
+
+    if(NOT Coverage_SKIP_HTML AND NOT GENHTML_PATH)
+        message(FATAL_ERROR "genhtml not found! Aborting...")
+    endif()
+
+    # Set base directory (as absolute path), or default to PROJECT_SOURCE_DIR
+    if(Coverage_BASE_DIRECTORY)
+        get_filename_component(BASEDIR ${Coverage_BASE_DIRECTORY} ABSOLUTE)
+    else()
+        set(BASEDIR ${PROJECT_SOURCE_DIR})
+    endif()
+
+    # Collect excludes (Patterns, not paths, for fastcov)
+    set(FASTCOV_EXCLUDES "")
+    foreach(EXCLUDE ${Coverage_EXCLUDE} ${COVERAGE_EXCLUDES} ${COVERAGE_FASTCOV_EXCLUDES})
+        list(APPEND FASTCOV_EXCLUDES "${EXCLUDE}")
+    endforeach()
+    list(REMOVE_DUPLICATES FASTCOV_EXCLUDES)
+
+    # Conditional arguments
+    if(CPPFILT_PATH AND NOT ${Coverage_NO_DEMANGLE})
+        set(GENHTML_EXTRA_ARGS "--demangle-cpp")
+    endif()
+
+    # Set up commands which will be run to generate coverage data
+    set(FASTCOV_EXEC_TESTS_CMD ${Coverage_EXECUTABLE} ${Coverage_EXECUTABLE_ARGS})
+
+    set(FASTCOV_CAPTURE_CMD ${FASTCOV_PATH} ${Coverage_FASTCOV_ARGS} --gcov ${GCOV_PATH}
+        --search-directory ${BASEDIR}
+        --process-gcno
+        --output ${Coverage_NAME}.json
+        --exclude ${FASTCOV_EXCLUDES}
+        --exclude ${FASTCOV_EXCLUDES}
+    )
+    
+    set(FASTCOV_CONVERT_CMD ${FASTCOV_PATH}
+        -C ${Coverage_NAME}.json --lcov --output ${Coverage_NAME}.info
+    )
+
+    if(Coverage_SKIP_HTML)
+        set(FASTCOV_HTML_CMD ";")
+    else()
+        set(FASTCOV_HTML_CMD ${GENHTML_PATH} ${GENHTML_EXTRA_ARGS} ${Coverage_GENHTML_ARGS}
+            -o ${Coverage_NAME} ${Coverage_NAME}.info
+        )
+    endif()
+
+    set(FASTCOV_POST_CMD ";")
+    if(Coverage_POST_CMD)
+        set(FASTCOV_POST_CMD ${Coverage_POST_CMD})
+    endif()
+
+    if(CODE_COVERAGE_VERBOSE)
+        message(STATUS "Code coverage commands for target ${Coverage_NAME} (fastcov):")
+
+        message("   Running tests:")
+        string(REPLACE ";" " " FASTCOV_EXEC_TESTS_CMD_SPACED "${FASTCOV_EXEC_TESTS_CMD}")
+        message("     ${FASTCOV_EXEC_TESTS_CMD_SPACED}")
+
+        message("   Capturing fastcov counters and generating report:")
+        string(REPLACE ";" " " FASTCOV_CAPTURE_CMD_SPACED "${FASTCOV_CAPTURE_CMD}")
+        message("     ${FASTCOV_CAPTURE_CMD_SPACED}")
+
+        message("   Converting fastcov .json to lcov .info:")
+        string(REPLACE ";" " " FASTCOV_CONVERT_CMD_SPACED "${FASTCOV_CONVERT_CMD}")
+        message("     ${FASTCOV_CONVERT_CMD_SPACED}")
+
+        if(NOT Coverage_SKIP_HTML)
+            message("   Generating HTML report: ")
+            string(REPLACE ";" " " FASTCOV_HTML_CMD_SPACED "${FASTCOV_HTML_CMD}")
+            message("     ${FASTCOV_HTML_CMD_SPACED}")
+        endif()
+        if(Coverage_POST_CMD)
+            message("   Running post command: ")
+            string(REPLACE ";" " " FASTCOV_POST_CMD_SPACED "${FASTCOV_POST_CMD}")
+            message("     ${FASTCOV_POST_CMD_SPACED}")
+        endif()
+    endif()
+
+    # Setup target
+    add_custom_target(${Coverage_NAME}
+
+        # Cleanup fastcov
+        COMMAND ${FASTCOV_PATH} ${Coverage_FASTCOV_ARGS} --gcov ${GCOV_PATH}
+            --search-directory ${BASEDIR}
+            --zerocounters
+
+        COMMAND ${FASTCOV_EXEC_TESTS_CMD}
+        COMMAND ${FASTCOV_CAPTURE_CMD}
+        COMMAND ${FASTCOV_CONVERT_CMD}
+        COMMAND ${FASTCOV_HTML_CMD}
+        COMMAND ${FASTCOV_POST_CMD}
+
+        # Set output files as GENERATED (will be removed on 'make clean')
+        BYPRODUCTS
+             ${Coverage_NAME}.info
+             ${Coverage_NAME}.json
+             ${Coverage_NAME}/index.html  # report directory
+
+        WORKING_DIRECTORY ${PROJECT_BINARY_DIR}
+        DEPENDS ${Coverage_DEPENDENCIES}
+        VERBATIM # Protect arguments to commands
+        COMMENT "Resetting code coverage counters to zero. Processing code coverage counters and generating report."
+    )
+
+    set(INFO_MSG "fastcov code coverage info report saved in ${Coverage_NAME}.info and ${Coverage_NAME}.json.")
+    if(NOT Coverage_SKIP_HTML)
+        string(APPEND INFO_MSG " Open ${PROJECT_BINARY_DIR}/${Coverage_NAME}/index.html in your browser to view the coverage report.")
+    endif()
+    # Show where to find the fastcov info report
+    add_custom_command(TARGET ${Coverage_NAME} POST_BUILD
+        COMMAND ${CMAKE_COMMAND} -E echo ${INFO_MSG}
+    )
+
+endfunction() # setup_target_for_coverage_fastcov
+
+function(append_coverage_compiler_flags)
+    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${COVERAGE_COMPILER_FLAGS}" PARENT_SCOPE)
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${COVERAGE_COMPILER_FLAGS}" PARENT_SCOPE)
+    set(CMAKE_Fortran_FLAGS "${CMAKE_Fortran_FLAGS} ${COVERAGE_COMPILER_FLAGS}" PARENT_SCOPE)
+    message(STATUS "Appending code coverage compiler flags: ${COVERAGE_COMPILER_FLAGS}")
+endfunction() # append_coverage_compiler_flags
+
+# Setup coverage for specific library
+function(append_coverage_compiler_flags_to_target name)
+    target_compile_options(${name}
+        PRIVATE ${COVERAGE_COMPILER_FLAGS})
+endfunction()

cmake/cmake-modules/bilke/LICENSE_1_0.txt

@@ -0,0 +1,23 @@
+Boost Software License - Version 1.0 - August 17th, 2003
+
+Permission is hereby granted, free of charge, to any person or organization
+obtaining a copy of the software and accompanying documentation covered by
+this license (the "Software") to use, reproduce, display, distribute,
+execute, and transmit the Software, and to prepare derivative works of the
+Software, and to permit third-parties to whom the Software is furnished to
+do so, all subject to the following:
+
+The copyright notices in the Software and this entire statement, including
+the above license grant, this restriction and the following disclaimer,
+must be included in all copies of the Software, in whole or in part, and
+all derivative works of the Software, unless such copies or derivative
+works are solely in the form of machine-executable object code generated by
+a source language processor.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
+SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
+FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

cmake/cmake-modules/rpavlik/GetGitRevisionDescription.cmake

@@ -0,0 +1,284 @@
+# - Returns a version string from Git
+#
+# These functions force a re-configure on each git commit so that you can
+# trust the values of the variables in your build system.
+#
+#  get_git_head_revision(<refspecvar> <hashvar> [ALLOW_LOOKING_ABOVE_CMAKE_SOURCE_DIR])
+#
+# Returns the refspec and sha hash of the current head revision
+#
+#  git_describe(<var> [<additional arguments to git describe> ...])
+#
+# Returns the results of git describe on the source tree, and adjusting
+# the output so that it tests false if an error occurs.
+#
+#  git_describe_working_tree(<var> [<additional arguments to git describe> ...])
+#
+# Returns the results of git describe on the working tree (--dirty option),
+# and adjusting the output so that it tests false if an error occurs.
+#
+#  git_get_exact_tag(<var> [<additional arguments to git describe> ...])
+#
+# Returns the results of git describe --exact-match on the source tree,
+# and adjusting the output so that it tests false if there was no exact
+# matching tag.
+#
+#  git_local_changes(<var>)
+#
+# Returns either "CLEAN" or "DIRTY" with respect to uncommitted changes.
+# Uses the return code of "git diff-index --quiet HEAD --".
+# Does not regard untracked files.
+#
+# Requires CMake 2.6 or newer (uses the 'function' command)
+#
+# Original Author:
+# 2009-2020 Ryan Pavlik <ryan.pavlik@gmail.com> <abiryan@ryand.net>
+# http://academic.cleardefinition.com
+#
+# Copyright 2009-2013, Iowa State University.
+# Copyright 2013-2020, Ryan Pavlik
+# Copyright 2013-2020, Contributors
+# SPDX-License-Identifier: BSL-1.0
+# Distributed under the Boost Software License, Version 1.0.
+# (See accompanying file LICENSE_1_0.txt or copy at
+# http://www.boost.org/LICENSE_1_0.txt)
+
+if(__get_git_revision_description)
+    return()
+endif()
+set(__get_git_revision_description YES)
+
+# We must run the following at "include" time, not at function call time,
+# to find the path to this module rather than the path to a calling list file
+get_filename_component(_gitdescmoddir ${CMAKE_CURRENT_LIST_FILE} PATH)
+
+# Function _git_find_closest_git_dir finds the next closest .git directory
+# that is part of any directory in the path defined by _start_dir.
+# The result is returned in the parent scope variable whose name is passed
+# as variable _git_dir_var. If no .git directory can be found, the
+# function returns an empty string via _git_dir_var.
+#
+# Example: Given a path C:/bla/foo/bar and assuming C:/bla/.git exists and
+# neither foo nor bar contain a file/directory .git. This wil return
+# C:/bla/.git
+#
+function(_git_find_closest_git_dir _start_dir _git_dir_var)
+    set(cur_dir "${_start_dir}")
+    set(git_dir "${_start_dir}/.git")
+    while(NOT EXISTS "${git_dir}")
+        # .git dir not found, search parent directories
+        set(git_previous_parent "${cur_dir}")
+        get_filename_component(cur_dir "${cur_dir}" DIRECTORY)
+        if(cur_dir STREQUAL git_previous_parent)
+            # We have reached the root directory, we are not in git
+            set(${_git_dir_var}
+                ""
+                PARENT_SCOPE)
+            return()
+        endif()
+        set(git_dir "${cur_dir}/.git")
+    endwhile()
+    set(${_git_dir_var}
+        "${git_dir}"
+        PARENT_SCOPE)
+endfunction()
+
+function(get_git_head_revision _refspecvar _hashvar)
+    _git_find_closest_git_dir("${CMAKE_CURRENT_SOURCE_DIR}" GIT_DIR)
+
+    if("${ARGN}" STREQUAL "ALLOW_LOOKING_ABOVE_CMAKE_SOURCE_DIR")
+        set(ALLOW_LOOKING_ABOVE_CMAKE_SOURCE_DIR TRUE)
+    else()
+        set(ALLOW_LOOKING_ABOVE_CMAKE_SOURCE_DIR FALSE)
+    endif()
+    if(NOT "${GIT_DIR}" STREQUAL "")
+        file(RELATIVE_PATH _relative_to_source_dir "${CMAKE_SOURCE_DIR}"
+             "${GIT_DIR}")
+        if("${_relative_to_source_dir}" MATCHES "[.][.]" AND NOT ALLOW_LOOKING_ABOVE_CMAKE_SOURCE_DIR)
+            # We've gone above the CMake root dir.
+            set(GIT_DIR "")
+        endif()
+    endif()
+    if("${GIT_DIR}" STREQUAL "")
+        set(${_refspecvar}
+            "GITDIR-NOTFOUND"
+            PARENT_SCOPE)
+        set(${_hashvar}
+            "GITDIR-NOTFOUND"
+            PARENT_SCOPE)
+        return()
+    endif()
+
+    # Check if the current source dir is a git submodule or a worktree.
+    # In both cases .git is a file instead of a directory.
+    #
+    if(NOT IS_DIRECTORY ${GIT_DIR})
+        # The following git command will return a non empty string that
+        # points to the super project working tree if the current
+        # source dir is inside a git submodule.
+        # Otherwise the command will return an empty string.
+        #
+        execute_process(
+            COMMAND "${GIT_EXECUTABLE}" rev-parse
+                    --show-superproject-working-tree
+            WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
+            OUTPUT_VARIABLE out
+            ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE)
+        if(NOT "${out}" STREQUAL "")
+            # If out is empty, GIT_DIR/CMAKE_CURRENT_SOURCE_DIR is in a submodule
+            file(READ ${GIT_DIR} submodule)
+            string(REGEX REPLACE "gitdir: (.*)$" "\\1" GIT_DIR_RELATIVE
+                                 ${submodule})
+            string(STRIP ${GIT_DIR_RELATIVE} GIT_DIR_RELATIVE)
+            get_filename_component(SUBMODULE_DIR ${GIT_DIR} PATH)
+            get_filename_component(GIT_DIR ${SUBMODULE_DIR}/${GIT_DIR_RELATIVE}
+                                   ABSOLUTE)
+            set(HEAD_SOURCE_FILE "${GIT_DIR}/HEAD")
+        else()
+            # GIT_DIR/CMAKE_CURRENT_SOURCE_DIR is in a worktree
+            file(READ ${GIT_DIR} worktree_ref)
+            # The .git directory contains a path to the worktree information directory
+            # inside the parent git repo of the worktree.
+            #
+            string(REGEX REPLACE "gitdir: (.*)$" "\\1" git_worktree_dir
+                                 ${worktree_ref})
+            string(STRIP ${git_worktree_dir} git_worktree_dir)
+            _git_find_closest_git_dir("${git_worktree_dir}" GIT_DIR)
+            set(HEAD_SOURCE_FILE "${git_worktree_dir}/HEAD")
+        endif()
+    else()
+        set(HEAD_SOURCE_FILE "${GIT_DIR}/HEAD")
+    endif()
+    set(GIT_DATA "${CMAKE_CURRENT_BINARY_DIR}/CMakeFiles/git-data")
+    if(NOT EXISTS "${GIT_DATA}")
+        file(MAKE_DIRECTORY "${GIT_DATA}")
+    endif()
+
+    if(NOT EXISTS "${HEAD_SOURCE_FILE}")
+        return()
+    endif()
+    set(HEAD_FILE "${GIT_DATA}/HEAD")
+    configure_file("${HEAD_SOURCE_FILE}" "${HEAD_FILE}" COPYONLY)
+
+    configure_file("${_gitdescmoddir}/GetGitRevisionDescription.cmake.in"
+                   "${GIT_DATA}/grabRef.cmake" @ONLY)
+    include("${GIT_DATA}/grabRef.cmake")
+
+    set(${_refspecvar}
+        "${HEAD_REF}"
+        PARENT_SCOPE)
+    set(${_hashvar}
+        "${HEAD_HASH}"
+        PARENT_SCOPE)
+endfunction()
+
+function(git_describe _var)
+    if(NOT GIT_FOUND)
+        find_package(Git QUIET)
+    endif()
+    get_git_head_revision(refspec hash)
+    if(NOT GIT_FOUND)
+        set(${_var}
+            "GIT-NOTFOUND"
+            PARENT_SCOPE)
+        return()
+    endif()
+    if(NOT hash)
+        set(${_var}
+            "HEAD-HASH-NOTFOUND"
+            PARENT_SCOPE)
+        return()
+    endif()
+
+    # TODO sanitize
+    #if((${ARGN}" MATCHES "&&") OR
+    #   (ARGN MATCHES "||") OR
+    #   (ARGN MATCHES "\\;"))
+    #   message("Please report the following error to the project!")
+    #   message(FATAL_ERROR "Looks like someone's doing something nefarious with git_describe! Passed arguments ${ARGN}")
+    #endif()
+
+    #message(STATUS "Arguments to execute_process: ${ARGN}")
+
+    execute_process(
+        COMMAND "${GIT_EXECUTABLE}" describe --tags --always ${hash} ${ARGN}
+        WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
+        RESULT_VARIABLE res
+        OUTPUT_VARIABLE out
+        ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE)
+    if(NOT res EQUAL 0)
+        set(out "${out}-${res}-NOTFOUND")
+    endif()
+
+    set(${_var}
+        "${out}"
+        PARENT_SCOPE)
+endfunction()
+
+function(git_describe_working_tree _var)
+    if(NOT GIT_FOUND)
+        find_package(Git QUIET)
+    endif()
+    if(NOT GIT_FOUND)
+        set(${_var}
+            "GIT-NOTFOUND"
+            PARENT_SCOPE)
+        return()
+    endif()
+
+    execute_process(
+        COMMAND "${GIT_EXECUTABLE}" describe --dirty ${ARGN}
+        WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
+        RESULT_VARIABLE res
+        OUTPUT_VARIABLE out
+        ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE)
+    if(NOT res EQUAL 0)
+        set(out "${out}-${res}-NOTFOUND")
+    endif()
+
+    set(${_var}
+        "${out}"
+        PARENT_SCOPE)
+endfunction()
+
+function(git_get_exact_tag _var)
+    git_describe(out --exact-match ${ARGN})
+    set(${_var}
+        "${out}"
+        PARENT_SCOPE)
+endfunction()
+
+function(git_local_changes _var)
+    if(NOT GIT_FOUND)
+        find_package(Git QUIET)
+    endif()
+    get_git_head_revision(refspec hash)
+    if(NOT GIT_FOUND)
+        set(${_var}
+            "GIT-NOTFOUND"
+            PARENT_SCOPE)
+        return()
+    endif()
+    if(NOT hash)
+        set(${_var}
+            "HEAD-HASH-NOTFOUND"
+            PARENT_SCOPE)
+        return()
+    endif()
+
+    execute_process(
+        COMMAND "${GIT_EXECUTABLE}" diff-index --quiet HEAD --
+        WORKING_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"
+        RESULT_VARIABLE res
+        OUTPUT_VARIABLE out
+        ERROR_QUIET OUTPUT_STRIP_TRAILING_WHITESPACE)
+    if(res EQUAL 0)
+        set(${_var}
+            "CLEAN"
+            PARENT_SCOPE)
+    else()
+        set(${_var}
+            "DIRTY"
+            PARENT_SCOPE)
+    endif()
+endfunction()

cmake/cmake-modules/rpavlik/GetGitRevisionDescription.cmake.in

@@ -0,0 +1,43 @@
+#
+# Internal file for GetGitRevisionDescription.cmake
+#
+# Requires CMake 2.6 or newer (uses the 'function' command)
+#
+# Original Author:
+# 2009-2010 Ryan Pavlik <rpavlik@iastate.edu> <abiryan@ryand.net>
+# http://academic.cleardefinition.com
+# Iowa State University HCI Graduate Program/VRAC
+#
+# Copyright 2009-2012, Iowa State University
+# Copyright 2011-2015, Contributors
+# Distributed under the Boost Software License, Version 1.0.
+# (See accompanying file LICENSE_1_0.txt or copy at
+# http://www.boost.org/LICENSE_1_0.txt)
+# SPDX-License-Identifier: BSL-1.0
+
+set(HEAD_HASH)
+
+file(READ "@HEAD_FILE@" HEAD_CONTENTS LIMIT 1024)
+
+string(STRIP "${HEAD_CONTENTS}" HEAD_CONTENTS)
+if(HEAD_CONTENTS MATCHES "ref")
+    # named branch
+    string(REPLACE "ref: " "" HEAD_REF "${HEAD_CONTENTS}")
+    if(EXISTS "@GIT_DIR@/${HEAD_REF}")
+        configure_file("@GIT_DIR@/${HEAD_REF}" "@GIT_DATA@/head-ref" COPYONLY)
+    else()
+        configure_file("@GIT_DIR@/packed-refs" "@GIT_DATA@/packed-refs" COPYONLY)
+        file(READ "@GIT_DATA@/packed-refs" PACKED_REFS)
+        if(${PACKED_REFS} MATCHES "([0-9a-z]*) ${HEAD_REF}")
+            set(HEAD_HASH "${CMAKE_MATCH_1}")
+        endif()
+    endif()
+else()
+    # detached HEAD
+    configure_file("@GIT_DIR@/HEAD" "@GIT_DATA@/head-ref" COPYONLY)
+endif()
+
+if(NOT HEAD_HASH)
+    file(READ "@GIT_DATA@/head-ref" HEAD_HASH LIMIT 1024)
+    string(STRIP "${HEAD_HASH}" HEAD_HASH)
+endif()

cmake/cmake-modules/rpavlik/LICENSES/BSD-3-Clause.txt

@@ -0,0 +1,26 @@
+Copyright (c) <year> <owner>. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+may be used to endorse or promote products derived from this software without
+specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
+USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

cmake/cmake-modules/rpavlik/LICENSES/BSL-1.0.txt

@@ -0,0 +1,23 @@
+Boost Software License - Version 1.0 - August 17th, 2003
+
+Permission is hereby granted, free of charge, to any person or organization
+obtaining a copy of the software and accompanying documentation covered by
+this license (the "Software") to use, reproduce, display, distribute, execute,
+and transmit the Software, and to prepare derivative works of the Software,
+and to permit third-parties to whom the Software is furnished to do so, all
+subject to the following:
+
+The copyright notices in the Software and this entire statement, including
+the above license grant, this restriction and the following disclaimer, must
+be included in all copies of the Software, in whole or in part, and all derivative
+works of the Software, unless such copies or derivative works are solely in
+the form of machine-executable object code generated by a source language
+processor.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE FOR ANY DAMAGES
+OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

cmake/cmake-modules/rpavlik/LICENSE_1_0.txt

@@ -0,0 +1,23 @@
+Boost Software License - Version 1.0 - August 17th, 2003
+
+Permission is hereby granted, free of charge, to any person or organization
+obtaining a copy of the software and accompanying documentation covered by
+this license (the "Software") to use, reproduce, display, distribute,
+execute, and transmit the Software, and to prepare derivative works of the
+Software, and to permit third-parties to whom the Software is furnished to
+do so, all subject to the following:
+
+The copyright notices in the Software and this entire statement, including
+the above license grant, this restriction and the following disclaimer,
+must be included in all copies of the Software, in whole or in part, and
+all derivative works of the Software, unless such copies or derivative
+works are solely in the form of machine-executable object code generated by
+a source language processor.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
+SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
+FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.

docs/devicehandlers.rst

@@ -1,3 +1,110 @@
+.. _dhb-prim-doc:
+
 Device Handlers
 ==================
 
+Device handler components represent, control and monitor equipment, for example sensors or actuators
+of a spacecraft or the payload.
+
+Most device handlers have the same common functionality or
+requirements, which are fulfilled by implementing certain interfaces:
+
+- The handler/device needs to be commandable: :cpp:class:`HasActionsIF`
+- The handler needs to communicate with the physical device via a dedicated
+  communication bus, for example SpaceWire, UART or SPI: :cpp:class:`DeviceCommunicationIF`
+- The handler has housekeeping data which has to be exposed to the operator and/or other software
+  components: :cpp:class:`HasLocalDataPoolIF`
+- The handler has configurable parameters: :cpp:class:`ReceivesParameterMessagesIF` which
+  also implements :cpp:class:`HasParametersIF`
+- The handler has health states, for example to indicate a broken device:
+  :cpp:class:`HasHealthIF`
+- The handler has modes. For example there are the core modes `MODE_ON`, `MODE_OFF`
+  and `MODE_NORMAL` provided by the FSFW. `MODE_ON` means that a device is physically powered
+  but that it is not periodically polling data from the
+  physical device, `MODE_NORMAL` means that it is able to do that: :cpp:class:`HasModesIF`
+
+The device handler base therefore provides abstractions for a lot of common
+functionality, which can potentially avoid high amounts or logic and code duplication.
+
+Template Device Handler Base File
+----------------------------------
+
+This is an example template device handler header file with all necessary
+functions implemented:
+
+.. code-block:: cpp
+
+	#ifndef __TESTDEVICEHANDLER_H_
+	#define __TESTDEVICEHANDLER_H_
+
+	#include <fsfw/devicehandlers/DeviceHandlerBase.h>
+
+	class TestDeviceHandler: DeviceHandlerBase {
+	public:
+	  TestDeviceHandler(object_id_t objectId, object_id_t comIF, CookieIF* cookie);
+	private:
+	  void doStartUp() override;
+	  void doShutDown() override;
+	  ReturnValue_t buildNormalDeviceCommand(DeviceCommandId_t* id) override;
+	  ReturnValue_t buildTransitionDeviceCommand(DeviceCommandId_t* id) override;
+	  void fillCommandAndReplyMap() override;
+	  ReturnValue_t buildCommandFromCommand(DeviceCommandId_t deviceCommand, const uint8_t* commandData,
+	                                        size_t commandDataLen) override;
+	  ReturnValue_t scanForReply(const uint8_t* start, size_t remainingSize, DeviceCommandId_t* foundId,
+	                             size_t* foundLen) override;
+	  ReturnValue_t interpretDeviceReply(DeviceCommandId_t id, const uint8_t* packet) override;
+	  uint32_t getTransitionDelayMs(Mode_t modeFrom, Mode_t modeTo) override;
+	  ReturnValue_t initializeLocalDataPool(localpool::DataPool& localDataPoolMap,
+	                                        LocalDataPoolManager& poolManager) override;
+
+	};
+
+	#endif /* __TESTDEVICEHANDLER_H_ */
+
+and the respective source file with sensible default return values:
+
+.. code-block:: cpp
+
+	#include "TestDeviceHandler.h"
+
+	TestDeviceHandler::TestDeviceHandler(object_id_t objectId, object_id_t comIF, CookieIF* cookie)
+	    : DeviceHandlerBase(objectId, comIF, cookie) {}
+
+	void TestDeviceHandler::doStartUp() {}
+
+	void TestDeviceHandler::doShutDown() {}
+
+	ReturnValue_t TestDeviceHandler::buildNormalDeviceCommand(DeviceCommandId_t* id) {
+	  return HasReturnvaluesIF::RETURN_OK;
+	}
+
+	ReturnValue_t TestDeviceHandler::buildTransitionDeviceCommand(DeviceCommandId_t* id) {
+	  return HasReturnvaluesIF::RETURN_OK;
+	}
+
+	void TestDeviceHandler::fillCommandAndReplyMap() {}
+
+	ReturnValue_t TestDeviceHandler::buildCommandFromCommand(DeviceCommandId_t deviceCommand,
+	                                                         const uint8_t* commandData,
+	                                                         size_t commandDataLen) {
+	  return HasReturnvaluesIF::RETURN_OK;
+	}
+
+	ReturnValue_t TestDeviceHandler::scanForReply(const uint8_t* start, size_t remainingSize,
+	                                              DeviceCommandId_t* foundId, size_t* foundLen) {
+	  return HasReturnvaluesIF::RETURN_OK;
+	}
+
+	ReturnValue_t TestDeviceHandler::interpretDeviceReply(DeviceCommandId_t id,
+	                                                      const uint8_t* packet) {
+	  return HasReturnvaluesIF::RETURN_OK;
+	}
+
+	uint32_t TestDeviceHandler::getTransitionDelayMs(Mode_t modeFrom, Mode_t modeTo) {
+	  return 10000;
+	}
+
+	ReturnValue_t TestDeviceHandler::initializeLocalDataPool(localpool::DataPool& localDataPoolMap,
+	                                                         LocalDataPoolManager& poolManager) {
+	  return HasReturnvaluesIF::RETURN_OK;
+	}

docs/getting_started.rst

@@ -19,6 +19,29 @@ A template configuration folder was provided and can be copied into the project
 a starting point. The [configuration section](docs/README-config.md#top) provides more specific 
 information about the possible options.
 
+Prerequisites
+-------------------
+
+The Embedded Template Library (etl) is a dependency of the FSFW which is automatically
+installed and provided by the build system unless the correction version was installed.
+The current recommended version can be found inside the fsfw ``CMakeLists.txt`` file or by using
+``ccmake`` and looking up the ``FSFW_ETL_LIB_MAJOR_VERSION`` variable.
+
+You can install the ETL library like this. On Linux, it might be necessary to add ``sudo`` before
+the install call:
+
+.. code-block:: console
+
+   git clone https://github.com/ETLCPP/etl
+   cd etl
+   git checkout <currentRecommendedVersion>
+   mkdir build && cd build
+   cmake ..
+   cmake --install .
+
+It is recommended to install ``20.27.2`` or newer for the package version handling of
+ETL to work.
+
 Adding the library
 -------------------
 
@@ -60,6 +83,20 @@ The FSFW also has unittests which use the `Catch2 library`_.
 These are built by setting the CMake option ``FSFW_BUILD_UNITTESTS`` to ``ON`` or `TRUE`
 from your project `CMakeLists.txt` file or from the command line.
 
+You can install the Catch2 library, which prevents the build system to avoid re-downloading
+the dependency if the unit tests are completely rebuilt. The current recommended version
+can be found inside the fsfw ``CMakeLists.txt`` file or by using ``ccmake`` and looking up
+the ``FSFW_CATCH2_LIB_VERSION`` variable.
+
+.. code-block:: console
+
+   git clone https://github.com/catchorg/Catch2.git
+   cd Catch2
+   git checkout <currentRecommendedVersion>
+   cmake -Bbuild -H. -DBUILD_TESTING=OFF
+   sudo cmake --build build/ --target install
+
+
 The fsfw-tests binary will be built as part of the static library and dropped alongside it.
 If the unittests are built, the library and the tests will be built with coverage information by
 default. This can be disabled by setting the `FSFW_TESTS_COV_GEN` option to `OFF` or `FALSE`.
@@ -90,8 +127,21 @@ Building the documentation
 ----------------------------
 
 The FSFW documentation is built using the tools Sphinx, doxygen and breathe based on the
-instructions provided in `this blogpost <https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/>`_. You can set up a
-documentation build system using the following commands
+instructions provided in `this blogpost <https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/>`_. If you
+want to do this locally, set up the prerequisites first. This requires a ``python3``
+installation as well. Example here is for Ubuntu.
+
+.. code-block:: console
+
+   sudo apt-get install doxygen graphviz
+
+And the following Python packages
+
+.. code-block:: console
+
+   python3 -m pip install sphinx breathe
+
+You can set up a documentation build system using the following commands
 
 .. code-block:: bash
 
@@ -110,6 +160,14 @@ folder. Simply open the ``index.html`` in the webbrowser of your choice.
 The ``helper.py`` script located in the ``script`` folder can also be used to create, build
 and open the documentation conveniently. Try ``helper.py -h`` for more information.
 
+Formatting the source
+-----------------------
+
+The formatting is done by the ``clang-format`` tool. The configuration is contained within the
+``.clang-format`` file in the repository root. As long as ``clang-format`` is installed, you
+can run the ``apply-clang-format.sh`` helper script to format all source files consistently.
+
+
 .. _`Hosted FSFW example`: https://egit.irs.uni-stuttgart.de/fsfw/fsfw-example-hosted
 .. _`Catch2 library`: https://github.com/catchorg/Catch2
 .. _`Code coverage`: https://github.com/bilke/cmake-modules/tree/master

docs/highlevel.rst

@@ -118,7 +118,7 @@ The DH has mechanisms to monitor the communication with the physical device whic
 for FDIR reaction.  Device Handlers can be created by implementing ``DeviceHandlerBase``.
 A standard FDIR component for the DH will be created automatically but can
 be overwritten by the user. More information on DeviceHandlers can be found in the
-related [documentation section](doc/README-devicehandlers.md#top).
+related :ref:`documentation section <dhb-prim-doc>`.
 
 Modes and Health
 --------------------

hal/CMakeLists.txt

@@ -1,41 +0,0 @@
-cmake_minimum_required(VERSION 3.13)
-
-# Can also be changed by upper CMakeLists.txt file
-find_library(LIB_FSFW_NAME fsfw REQUIRED)
-
-option(FSFW_HAL_ADD_LINUX "Add the Linux HAL to the sources. Required gpiod library" OFF)
-option(FSFW_HAL_ADD_RASPBERRY_PI "Add Raspberry Pi specific code to the sources" OFF)
-option(FSFW_HAL_ADD_STM32H7 "Add the STM32H7 HAL to the sources" OFF)
-option(FSFW_HAL_WARNING_SHADOW_LOCAL_GCC "Enable -Wshadow=local warning in GCC" ON)
-
-set(LINUX_HAL_PATH_NAME linux)
-set(STM32H7_PATH_NAME stm32h7)
-
-add_subdirectory(src)
-
-foreach(INCLUDE_PATH ${FSFW_HAL_ADDITIONAL_INC_PATHS})
-    if(IS_ABSOLUTE ${INCLUDE_PATH})
-        set(CURR_ABS_INC_PATH "${INCLUDE_PATH}")
-    else()
-        get_filename_component(CURR_ABS_INC_PATH
-            ${INCLUDE_PATH} REALPATH BASE_DIR ${CMAKE_SOURCE_DIR})
-    endif()
-
-    if(CMAKE_VERBOSE)
-        message(STATUS "FSFW include path: ${CURR_ABS_INC_PATH}")
-    endif()
-
-    list(APPEND FSFW_HAL_ADD_INC_PATHS_ABS ${CURR_ABS_INC_PATH})
-endforeach()
-
-target_include_directories(${LIB_FSFW_NAME} PRIVATE
-    ${FSFW_HAL_ADD_INC_PATHS_ABS}
-)
-
-target_compile_definitions(${LIB_FSFW_NAME} PRIVATE
-    ${FSFW_HAL_DEFINES}
-)
-
-target_link_libraries(${LIB_FSFW_NAME} PRIVATE
-    ${FSFW_HAL_LINK_LIBS}
-)

hal/src/CMakeLists.txt

@@ -1,9 +0,0 @@
-target_include_directories(${LIB_FSFW_NAME} PRIVATE
-    ${CMAKE_CURRENT_SOURCE_DIR}
-)
-
-target_include_directories(${LIB_FSFW_NAME} INTERFACE
-    ${CMAKE_CURRENT_SOURCE_DIR}
-)
-
-add_subdirectory(fsfw_hal)

hal/src/fsfw_hal/common/gpio/GpioCookie.cpp

@@ -1,50 +0,0 @@
-#include "fsfw_hal/common/gpio/GpioCookie.h"
-#include "fsfw/serviceinterface/ServiceInterface.h"
-
-GpioCookie::GpioCookie() {
-}
-
-ReturnValue_t GpioCookie::addGpio(gpioId_t gpioId, GpioBase* gpioConfig) {
-    if (gpioConfig == nullptr) {
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-        sif::warning << "GpioCookie::addGpio: gpioConfig is nullpointer" << std::endl;
-#else
-        sif::printWarning("GpioCookie::addGpio: gpioConfig is nullpointer\n");
-#endif
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    auto gpioMapIter = gpioMap.find(gpioId);
-    if(gpioMapIter == gpioMap.end()) {
-        auto statusPair = gpioMap.emplace(gpioId, gpioConfig);
-        if (statusPair.second == false) {
-#if FSFW_VERBOSE_LEVEL >= 1
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-            sif::warning << "GpioCookie::addGpio: Failed to add GPIO " << gpioId <<
-                    " to GPIO map" << std::endl;
-#else
-            sif::printWarning("GpioCookie::addGpio: Failed to add GPIO %d to GPIO map\n", gpioId);
-#endif
-#endif
-            return HasReturnvaluesIF::RETURN_FAILED;
-        }
-        return HasReturnvaluesIF::RETURN_OK;
-    }
-#if FSFW_VERBOSE_LEVEL >= 1
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-    sif::warning << "GpioCookie::addGpio: GPIO already exists in GPIO map " << std::endl;
-#else
-    sif::printWarning("GpioCookie::addGpio: GPIO already exists in GPIO map\n");
-#endif
-#endif
-    return HasReturnvaluesIF::RETURN_FAILED;
-}
-
-GpioMap GpioCookie::getGpioMap() const {
-    return gpioMap;
-}
-
-GpioCookie::~GpioCookie() {
-    for(auto& config: gpioMap) {
-        delete(config.second);
-    }
-}

hal/src/fsfw_hal/common/gpio/GpioIF.h

@@ -1,54 +0,0 @@
-#ifndef COMMON_GPIO_GPIOIF_H_
-#define COMMON_GPIO_GPIOIF_H_
-
-#include "gpioDefinitions.h"
-#include <fsfw/returnvalues/HasReturnvaluesIF.h>
-#include <fsfw/devicehandlers/CookieIF.h>
-
-class GpioCookie;
-
-/**
- * @brief	This class defines the interface for objects requiring the control
- * 			over GPIOs.
- * @author	J. Meier
- */
-class GpioIF : public HasReturnvaluesIF {
-public:
-
-	virtual ~GpioIF() {};
-
-	/**
-	 * @brief   Called by the GPIO using object.
-	 * @param cookie	Cookie specifying informations of the GPIOs required
-	 * 					by a object.
-	 */
-	virtual ReturnValue_t addGpios(GpioCookie* cookie) = 0;
-
-	/**
-	 * @brief	By implementing this function a child must provide the
-	 * 			functionality to pull a certain GPIO to high logic level.
-	 *
-	 * @param gpioId	A unique number which specifies the GPIO to drive.
-	 * @return  Returns RETURN_OK for success. This should never return RETURN_FAILED.
-	 */
-	virtual ReturnValue_t pullHigh(gpioId_t gpioId) = 0;
-
-	/**
-	 * @brief	By implementing this function a child must provide the
-	 * 			functionality to pull a certain GPIO to low logic level.
-	 *
-	 * @param gpioId	A unique number which specifies the GPIO to drive.
-	 */
-	virtual ReturnValue_t pullLow(gpioId_t gpioId) = 0;
-
-	/**
-     * @brief   This function requires a child to implement the functionality to read the state of
-     *          an ouput or input gpio.
-     *
-     * @param gpioId    A unique number which specifies the GPIO to read.
-     * @param gpioState State of GPIO will be written to this pointer.
-     */
-    virtual ReturnValue_t readGpio(gpioId_t gpioId, int* gpioState) = 0;
-};
-
-#endif /* COMMON_GPIO_GPIOIF_H_ */

hal/src/fsfw_hal/common/gpio/gpioDefinitions.h

@@ -1,170 +0,0 @@
-#ifndef COMMON_GPIO_GPIODEFINITIONS_H_
-#define COMMON_GPIO_GPIODEFINITIONS_H_
-
-#include <string>
-#include <unordered_map>
-#include <map>
-
-using gpioId_t = uint16_t;
-
-namespace gpio {
-
-enum Levels: uint8_t {
-    LOW = 0,
-    HIGH = 1,
-    NONE = 99
-};
-
-enum Direction: uint8_t {
-    IN = 0,
-    OUT = 1
-};
-
-enum GpioOperation {
-    READ,
-    WRITE
-};
-
-enum class GpioTypes {
-    NONE,
-    GPIO_REGULAR_BY_CHIP,
-    GPIO_REGULAR_BY_LABEL,
-    GPIO_REGULAR_BY_LINE_NAME,
-    CALLBACK
-};
-
-static constexpr gpioId_t NO_GPIO = -1;
-
-using gpio_cb_t = void (*) (gpioId_t gpioId, gpio::GpioOperation gpioOp, gpio::Levels value,
-        void* args);
-
-}
-
-/**
- * @brief   Struct containing information about the GPIO to use. This is
- *          required by the libgpiod to access and drive a GPIO.
- * @param chipname      String of the chipname specifying the group which contains the GPIO to
- *                      access. E.g. gpiochip0. To detect names of GPIO groups run gpiodetect on
- *                      the linux command line.
- * @param lineNum       The offset of the GPIO within the GPIO group.
- * @param consumer      Name of the consumer. Simply a description of the GPIO configuration.
- * @param direction     Specifies whether the GPIO should be used as in- or output.
- * @param initValue     Defines the initial state of the GPIO when configured as output.
- *                      Only required for output GPIOs.
- * @param lineHandle    The handle returned by gpiod_chip_get_line will be later written to this
- *                      pointer.
- */
-class GpioBase {
-public:
-
-    GpioBase() = default;
-
-    GpioBase(gpio::GpioTypes gpioType, std::string consumer, gpio::Direction direction,
-            gpio::Levels initValue):
-            gpioType(gpioType), consumer(consumer),direction(direction), initValue(initValue) {}
-
-    virtual~ GpioBase() {};
-
-    // Can be used to cast GpioBase to a concrete child implementation
-    gpio::GpioTypes gpioType = gpio::GpioTypes::NONE;
-    std::string consumer;
-    gpio::Direction direction = gpio::Direction::IN;
-    gpio::Levels initValue = gpio::Levels::NONE;
-};
-
-class GpiodRegularBase: public GpioBase {
-public:
-    GpiodRegularBase(gpio::GpioTypes gpioType, std::string consumer, gpio::Direction direction,
-            gpio::Levels initValue, int lineNum):
-            GpioBase(gpioType, consumer, direction, initValue), lineNum(lineNum) {
-    }
-
-    // line number will be configured at a later point for the open by line name configuration
-    GpiodRegularBase(gpio::GpioTypes gpioType, std::string consumer, gpio::Direction direction,
-            gpio::Levels initValue): GpioBase(gpioType, consumer, direction, initValue) {
-    }
-
-    int lineNum = 0;
-    struct gpiod_line* lineHandle = nullptr;
-};
-
-class GpiodRegularByChip: public GpiodRegularBase {
-public:
-    GpiodRegularByChip() :
-            GpiodRegularBase(gpio::GpioTypes::GPIO_REGULAR_BY_CHIP,
-                    std::string(), gpio::Direction::IN, gpio::LOW, 0) {
-    }
-
-    GpiodRegularByChip(std::string chipname_, int lineNum_, std::string consumer_,
-            gpio::Direction direction_, gpio::Levels initValue_) :
-            GpiodRegularBase(gpio::GpioTypes::GPIO_REGULAR_BY_CHIP,
-                    consumer_, direction_, initValue_, lineNum_),
-            chipname(chipname_){
-    }
-
-    GpiodRegularByChip(std::string chipname_, int lineNum_, std::string consumer_) :
-            GpiodRegularBase(gpio::GpioTypes::GPIO_REGULAR_BY_CHIP, consumer_,
-                    gpio::Direction::IN, gpio::LOW, lineNum_),
-            chipname(chipname_) {
-    }
-
-    std::string chipname;
-};
-
-class GpiodRegularByLabel: public GpiodRegularBase {
-public:
-    GpiodRegularByLabel(std::string label_, int lineNum_, std::string consumer_,
-            gpio::Direction direction_, gpio::Levels initValue_) :
-            GpiodRegularBase(gpio::GpioTypes::GPIO_REGULAR_BY_LABEL, consumer_,
-                    direction_, initValue_, lineNum_),
-            label(label_) {
-    }
-
-    GpiodRegularByLabel(std::string label_, int lineNum_, std::string consumer_) :
-            GpiodRegularBase(gpio::GpioTypes::GPIO_REGULAR_BY_LABEL, consumer_,
-                    gpio::Direction::IN, gpio::LOW, lineNum_),
-            label(label_) {
-    }
-
-    std::string label;
-};
-
-/**
- * @brief   Passing this GPIO configuration to the GPIO IF object will try to open the GPIO by its
- *          line name. This line name can be set in the device tree and must be unique. Otherwise
- *          the driver will open the first line with the given name.
- */
-class GpiodRegularByLineName: public GpiodRegularBase {
-public:
-    GpiodRegularByLineName(std::string lineName_, std::string consumer_, gpio::Direction direction_,
-            gpio::Levels initValue_) :
-            GpiodRegularBase(gpio::GpioTypes::GPIO_REGULAR_BY_LINE_NAME, consumer_, direction_,
-                    initValue_), lineName(lineName_) {
-    }
-
-    GpiodRegularByLineName(std::string lineName_, std::string consumer_) :
-            GpiodRegularBase(gpio::GpioTypes::GPIO_REGULAR_BY_LINE_NAME, consumer_,
-                    gpio::Direction::IN, gpio::LOW), lineName(lineName_) {
-    }
-
-    std::string lineName;
-};
-
-class GpioCallback: public GpioBase {
-public:
-    GpioCallback(std::string consumer, gpio::Direction direction_, gpio::Levels initValue_,
-            gpio::gpio_cb_t callback, void* callbackArgs):
-            GpioBase(gpio::GpioTypes::CALLBACK, consumer, direction_, initValue_),
-            callback(callback), callbackArgs(callbackArgs) {}
-
-    gpio::gpio_cb_t callback = nullptr;
-    void* callbackArgs = nullptr;
-};
-
-
-using GpioMap = std::map<gpioId_t, GpioBase*>;
-using GpioUnorderedMap = std::unordered_map<gpioId_t, GpioBase*>;
-using GpioMapIter = GpioMap::iterator;
-using GpioUnorderedMapIter = GpioUnorderedMap::iterator;
-
-#endif /* LINUX_GPIO_GPIODEFINITIONS_H_ */

hal/src/fsfw_hal/devicehandlers/GyroL3GD20Handler.cpp

@@ -1,287 +0,0 @@
-#include "GyroL3GD20Handler.h"
-
-#include "fsfw/datapool/PoolReadGuard.h"
-
-#include <cmath>
-
-GyroHandlerL3GD20H::GyroHandlerL3GD20H(object_id_t objectId, object_id_t deviceCommunication,
-        CookieIF *comCookie, uint32_t transitionDelayMs):
-        DeviceHandlerBase(objectId, deviceCommunication, comCookie),
-        transitionDelayMs(transitionDelayMs), dataset(this) {
-#if FSFW_HAL_L3GD20_GYRO_DEBUG == 1
-    debugDivider = new PeriodicOperationDivider(3);
-#endif
-}
-
-GyroHandlerL3GD20H::~GyroHandlerL3GD20H() {}
-
-void GyroHandlerL3GD20H::doStartUp() {
-    if(internalState == InternalState::NONE) {
-        internalState = InternalState::CONFIGURE;
-    }
-
-    if(internalState == InternalState::CONFIGURE) {
-        if(commandExecuted) {
-            internalState = InternalState::CHECK_REGS;
-            commandExecuted = false;
-        }
-    }
-
-    if(internalState == InternalState::CHECK_REGS) {
-        if(commandExecuted) {
-            internalState = InternalState::NORMAL;
-            if(goNormalModeImmediately) {
-                setMode(MODE_NORMAL);
-            }
-            else {
-                setMode(_MODE_TO_ON);
-            }
-            commandExecuted = false;
-        }
-    }
-}
-
-void GyroHandlerL3GD20H::doShutDown() {
-    setMode(_MODE_POWER_DOWN);
-}
-
-ReturnValue_t GyroHandlerL3GD20H::buildTransitionDeviceCommand(DeviceCommandId_t *id) {
-    switch(internalState) {
-    case(InternalState::NONE):
-    case(InternalState::NORMAL): {
-        return NOTHING_TO_SEND;
-    }
-    case(InternalState::CONFIGURE): {
-        *id = L3GD20H::CONFIGURE_CTRL_REGS;
-        uint8_t command [5];
-        command[0] = L3GD20H::CTRL_REG_1_VAL;
-        command[1] = L3GD20H::CTRL_REG_2_VAL;
-        command[2] = L3GD20H::CTRL_REG_3_VAL;
-        command[3] = L3GD20H::CTRL_REG_4_VAL;
-        command[4] = L3GD20H::CTRL_REG_5_VAL;
-        return buildCommandFromCommand(*id, command, 5);
-    }
-    case(InternalState::CHECK_REGS): {
-        *id = L3GD20H::READ_REGS;
-        return buildCommandFromCommand(*id, nullptr, 0);
-    }
-    default:
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-        /* Might be a configuration error. */
-        sif::warning << "GyroL3GD20Handler::buildTransitionDeviceCommand: "
-                "Unknown internal state!" << std::endl;
-#else
-        sif::printDebug("GyroL3GD20Handler::buildTransitionDeviceCommand: "
-                "Unknown internal state!\n");
-#endif
-        return HasReturnvaluesIF::RETURN_OK;
-    }
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t GyroHandlerL3GD20H::buildNormalDeviceCommand(DeviceCommandId_t *id) {
-    *id = L3GD20H::READ_REGS;
-    return buildCommandFromCommand(*id, nullptr, 0);
-}
-
-ReturnValue_t GyroHandlerL3GD20H::buildCommandFromCommand(
-        DeviceCommandId_t deviceCommand, const uint8_t *commandData,
-        size_t commandDataLen) {
-    switch(deviceCommand) {
-    case(L3GD20H::READ_REGS): {
-        commandBuffer[0] = L3GD20H::READ_START | L3GD20H::AUTO_INCREMENT_MASK | L3GD20H::READ_MASK;
-        std::memset(commandBuffer + 1, 0, L3GD20H::READ_LEN);
-        rawPacket = commandBuffer;
-        rawPacketLen = L3GD20H::READ_LEN + 1;
-        break;
-    }
-    case(L3GD20H::CONFIGURE_CTRL_REGS): {
-        commandBuffer[0] = L3GD20H::CTRL_REG_1 | L3GD20H::AUTO_INCREMENT_MASK;
-        if(commandData == nullptr or commandDataLen != 5) {
-            return DeviceHandlerIF::INVALID_COMMAND_PARAMETER;
-        }
-
-        ctrlReg1Value = commandData[0];
-        ctrlReg2Value = commandData[1];
-        ctrlReg3Value = commandData[2];
-        ctrlReg4Value = commandData[3];
-        ctrlReg5Value = commandData[4];
-
-        bool fsH = ctrlReg4Value & L3GD20H::SET_FS_1;
-        bool fsL = ctrlReg4Value & L3GD20H::SET_FS_0;
-
-        if(not fsH and not fsL) {
-            sensitivity = L3GD20H::SENSITIVITY_00;
-        }
-        else if(not fsH and fsL) {
-            sensitivity = L3GD20H::SENSITIVITY_01;
-        }
-        else {
-            sensitivity = L3GD20H::SENSITIVITY_11;
-        }
-
-        commandBuffer[1] = ctrlReg1Value;
-        commandBuffer[2] = ctrlReg2Value;
-        commandBuffer[3] = ctrlReg3Value;
-        commandBuffer[4] = ctrlReg4Value;
-        commandBuffer[5] = ctrlReg5Value;
-
-        rawPacket = commandBuffer;
-        rawPacketLen = 6;
-        break;
-    }
-    case(L3GD20H::READ_CTRL_REGS): {
-        commandBuffer[0] = L3GD20H::READ_START | L3GD20H::AUTO_INCREMENT_MASK |
-                L3GD20H::READ_MASK;
-
-        std::memset(commandBuffer + 1, 0, 5);
-        rawPacket = commandBuffer;
-        rawPacketLen = 6;
-        break;
-    }
-    default:
-        return DeviceHandlerIF::COMMAND_NOT_IMPLEMENTED;
-    }
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t GyroHandlerL3GD20H::scanForReply(const uint8_t *start, size_t len,
-        DeviceCommandId_t *foundId, size_t *foundLen) {
-    // For SPI, the ID will always be the one of the last sent command
-    *foundId = this->getPendingCommand();
-    *foundLen = this->rawPacketLen;
-
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t GyroHandlerL3GD20H::interpretDeviceReply(DeviceCommandId_t id,
-        const uint8_t *packet) {
-    ReturnValue_t result = HasReturnvaluesIF::RETURN_OK;
-    switch(id) {
-    case(L3GD20H::CONFIGURE_CTRL_REGS): {
-        commandExecuted = true;
-        break;
-    }
-    case(L3GD20H::READ_CTRL_REGS): {
-        if(packet[1] == ctrlReg1Value and packet[2] == ctrlReg2Value and
-                packet[3] == ctrlReg3Value and packet[4] == ctrlReg4Value and
-                packet[5] == ctrlReg5Value) {
-            commandExecuted = true;
-        }
-        else {
-            // Attempt reconfiguration
-            internalState = InternalState::CONFIGURE;
-            return DeviceHandlerIF::DEVICE_REPLY_INVALID;
-        }
-        break;
-    }
-    case(L3GD20H::READ_REGS): {
-        if(packet[1] != ctrlReg1Value and packet[2] != ctrlReg2Value and
-                packet[3] != ctrlReg3Value and packet[4] != ctrlReg4Value and
-                packet[5] != ctrlReg5Value) {
-            return DeviceHandlerIF::DEVICE_REPLY_INVALID;
-        }
-        else {
-            if(internalState == InternalState::CHECK_REGS) {
-                commandExecuted = true;
-            }
-        }
-
-        statusReg = packet[L3GD20H::STATUS_IDX];
-
-        int16_t angVelocXRaw = packet[L3GD20H::OUT_X_H] << 8 | packet[L3GD20H::OUT_X_L];
-        int16_t angVelocYRaw = packet[L3GD20H::OUT_Y_H] << 8 | packet[L3GD20H::OUT_Y_L];
-        int16_t angVelocZRaw = packet[L3GD20H::OUT_Z_H] << 8 | packet[L3GD20H::OUT_Z_L];
-        float angVelocX = angVelocXRaw * sensitivity;
-        float angVelocY = angVelocYRaw * sensitivity;
-        float angVelocZ = angVelocZRaw * sensitivity;
-
-        int8_t temperaturOffset = (-1) * packet[L3GD20H::TEMPERATURE_IDX];
-        float temperature = 25.0 + temperaturOffset;
-#if FSFW_HAL_L3GD20_GYRO_DEBUG == 1
-        if(debugDivider->checkAndIncrement()) {
-            /* Set terminal to utf-8 if there is an issue with micro printout. */
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-            sif::info << "GyroHandlerL3GD20H: Angular velocities (deg/s):" << std::endl;
-            sif::info << "X: " << angVelocX << std::endl;
-            sif::info << "Y: " << angVelocY << std::endl;
-            sif::info << "Z: " << angVelocZ << std::endl;
-#else
-            sif::printInfo("GyroHandlerL3GD20H: Angular velocities (deg/s):\n");
-            sif::printInfo("X: %f\n", angVelocX);
-            sif::printInfo("Y: %f\n", angVelocY);
-            sif::printInfo("Z: %f\n", angVelocZ);
-#endif
-        }
-#endif
-
-        PoolReadGuard readSet(&dataset);
-        if(readSet.getReadResult() == HasReturnvaluesIF::RETURN_OK) {
-            if(std::abs(angVelocX) < this->absLimitX) {
-                dataset.angVelocX = angVelocX;
-                dataset.angVelocX.setValid(true);
-            }
-            else {
-                dataset.angVelocX.setValid(false);
-            }
-
-            if(std::abs(angVelocY) < this->absLimitY) {
-                dataset.angVelocY = angVelocY;
-                dataset.angVelocY.setValid(true);
-            }
-            else {
-                dataset.angVelocY.setValid(false);
-            }
-
-            if(std::abs(angVelocZ) < this->absLimitZ) {
-                dataset.angVelocZ = angVelocZ;
-                dataset.angVelocZ.setValid(true);
-            }
-            else {
-                dataset.angVelocZ.setValid(false);
-            }
-
-            dataset.temperature = temperature;
-            dataset.temperature.setValid(true);
-        }
-        break;
-    }
-    default:
-        return DeviceHandlerIF::COMMAND_NOT_IMPLEMENTED;
-    }
-    return result;
-}
-
-
-uint32_t GyroHandlerL3GD20H::getTransitionDelayMs(Mode_t from, Mode_t to) {
-    return this->transitionDelayMs;
-}
-
-void GyroHandlerL3GD20H::setToGoToNormalMode(bool enable) {
-    this->goNormalModeImmediately = true;
-}
-
-ReturnValue_t GyroHandlerL3GD20H::initializeLocalDataPool(
-        localpool::DataPool &localDataPoolMap, LocalDataPoolManager &poolManager) {
-    localDataPoolMap.emplace(L3GD20H::ANG_VELOC_X, new PoolEntry<float>({0.0}));
-    localDataPoolMap.emplace(L3GD20H::ANG_VELOC_Y, new PoolEntry<float>({0.0}));
-    localDataPoolMap.emplace(L3GD20H::ANG_VELOC_Z, new PoolEntry<float>({0.0}));
-    localDataPoolMap.emplace(L3GD20H::TEMPERATURE, new PoolEntry<float>({0.0}));
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-void GyroHandlerL3GD20H::fillCommandAndReplyMap() {
-    insertInCommandAndReplyMap(L3GD20H::READ_REGS, 1, &dataset);
-    insertInCommandAndReplyMap(L3GD20H::CONFIGURE_CTRL_REGS, 1);
-    insertInCommandAndReplyMap(L3GD20H::READ_CTRL_REGS, 1);
-}
-
-void GyroHandlerL3GD20H::modeChanged() {
-    internalState = InternalState::NONE;
-}
-
-void GyroHandlerL3GD20H::setAbsoluteLimits(float limitX, float limitY, float limitZ) {
-    this->absLimitX = limitX;
-    this->absLimitY = limitY;
-    this->absLimitZ = limitZ;
-}

hal/src/fsfw_hal/devicehandlers/GyroL3GD20Handler.h

@@ -1,99 +0,0 @@
-#ifndef MISSION_DEVICES_GYROL3GD20HANDLER_H_
-#define MISSION_DEVICES_GYROL3GD20HANDLER_H_
-
-#include "fsfw/FSFW.h"
-#include "devicedefinitions/GyroL3GD20Definitions.h"
-
-#include <fsfw/devicehandlers/DeviceHandlerBase.h>
-#include <fsfw/globalfunctions/PeriodicOperationDivider.h>
-
-/**
- * @brief 	Device Handler for the L3GD20H gyroscope sensor
- *          (https://www.st.com/en/mems-and-sensors/l3gd20h.html)
- * @details
- * Advanced documentation:
- * https://egit.irs.uni-stuttgart.de/redmine/projects/eive-flight-manual/wiki/L3GD20H_Gyro
- *
- * Data is read big endian with the smallest possible range of 245 degrees per second.
- */
-class GyroHandlerL3GD20H: public DeviceHandlerBase {
-public:
-    GyroHandlerL3GD20H(object_id_t objectId, object_id_t deviceCommunication,
-            CookieIF* comCookie, uint32_t transitionDelayMs);
-    virtual ~GyroHandlerL3GD20H();
-
-    /**
-     * Set the absolute limit for the values on the axis in degrees per second.
-     * The dataset values will be marked as invalid if that limit is exceeded
-     * @param xLimit
-     * @param yLimit
-     * @param zLimit
-     */
-    void setAbsoluteLimits(float limitX, float limitY, float limitZ);
-
-    /**
-     * @brief   Configure device handler to go to normal mode immediately
-     */
-    void setToGoToNormalMode(bool enable);
-protected:
-
-    /* DeviceHandlerBase overrides */
-    ReturnValue_t buildTransitionDeviceCommand(
-            DeviceCommandId_t *id) override;
-    void doStartUp() override;
-    void doShutDown() override;
-    ReturnValue_t buildNormalDeviceCommand(
-            DeviceCommandId_t *id) override;
-    ReturnValue_t buildCommandFromCommand(
-            DeviceCommandId_t deviceCommand, const uint8_t *commandData,
-            size_t commandDataLen) override;
-    ReturnValue_t scanForReply(const uint8_t *start, size_t len,
-            DeviceCommandId_t *foundId, size_t *foundLen) override;
-    virtual ReturnValue_t interpretDeviceReply(DeviceCommandId_t id,
-            const uint8_t *packet) override;
-
-    void fillCommandAndReplyMap() override;
-    void modeChanged() override;
-    virtual uint32_t getTransitionDelayMs(Mode_t from, Mode_t to) override;
-    ReturnValue_t initializeLocalDataPool(localpool::DataPool &localDataPoolMap,
-            LocalDataPoolManager &poolManager) override;
-
-private:
-    uint32_t transitionDelayMs = 0;
-    GyroPrimaryDataset dataset;
-
-    float absLimitX = L3GD20H::RANGE_DPS_00;
-    float absLimitY = L3GD20H::RANGE_DPS_00;
-    float absLimitZ = L3GD20H::RANGE_DPS_00;
-
-    enum class InternalState {
-        NONE,
-        CONFIGURE,
-        CHECK_REGS,
-        NORMAL
-    };
-    InternalState internalState = InternalState::NONE;
-    bool commandExecuted = false;
-
-    uint8_t statusReg = 0;
-    bool goNormalModeImmediately = false;
-
-    uint8_t ctrlReg1Value = L3GD20H::CTRL_REG_1_VAL;
-    uint8_t ctrlReg2Value = L3GD20H::CTRL_REG_2_VAL;
-    uint8_t ctrlReg3Value = L3GD20H::CTRL_REG_3_VAL;
-    uint8_t ctrlReg4Value = L3GD20H::CTRL_REG_4_VAL;
-    uint8_t ctrlReg5Value = L3GD20H::CTRL_REG_5_VAL;
-
-    uint8_t commandBuffer[L3GD20H::READ_LEN + 1];
-
-    // Set default value
-    float sensitivity = L3GD20H::SENSITIVITY_00;
-
-#if FSFW_HAL_L3GD20_GYRO_DEBUG == 1
-    PeriodicOperationDivider* debugDivider = nullptr;
-#endif
-};
-
-
-
-#endif /* MISSION_DEVICES_GYROL3GD20HANDLER_H_ */

hal/src/fsfw_hal/devicehandlers/MgmLIS3MDLHandler.cpp

@@ -1,520 +0,0 @@
-#include "MgmLIS3MDLHandler.h"
-
-#include "fsfw/datapool/PoolReadGuard.h"
-#if FSFW_HAL_LIS3MDL_MGM_DEBUG == 1
-#include "fsfw/globalfunctions/PeriodicOperationDivider.h"
-#endif
-
-#include <cmath>
-
-MgmLIS3MDLHandler::MgmLIS3MDLHandler(object_id_t objectId, object_id_t deviceCommunication,
-        CookieIF* comCookie, uint32_t transitionDelay):
-        DeviceHandlerBase(objectId, deviceCommunication, comCookie),
-        dataset(this), transitionDelay(transitionDelay) {
-#if FSFW_HAL_LIS3MDL_MGM_DEBUG == 1
-    debugDivider = new PeriodicOperationDivider(3);
-#endif
-    // Set to default values right away
-    registers[0] = MGMLIS3MDL::CTRL_REG1_DEFAULT;
-    registers[1] = MGMLIS3MDL::CTRL_REG2_DEFAULT;
-    registers[2] = MGMLIS3MDL::CTRL_REG3_DEFAULT;
-    registers[3] = MGMLIS3MDL::CTRL_REG4_DEFAULT;
-    registers[4] = MGMLIS3MDL::CTRL_REG5_DEFAULT;
-
-}
-
-MgmLIS3MDLHandler::~MgmLIS3MDLHandler() {
-}
-
-
-void MgmLIS3MDLHandler::doStartUp() {
-    switch (internalState) {
-    case(InternalState::STATE_NONE): {
-        internalState = InternalState::STATE_FIRST_CONTACT;
-        break;
-    }
-    case(InternalState::STATE_FIRST_CONTACT): {
-        /* Will be set by checking device ID (WHO AM I register) */
-        if(commandExecuted) {
-            commandExecuted = false;
-            internalState = InternalState::STATE_SETUP;
-        }
-        break;
-    }
-    case(InternalState::STATE_SETUP): {
-        internalState = InternalState::STATE_CHECK_REGISTERS;
-        break;
-    }
-    case(InternalState::STATE_CHECK_REGISTERS): {
-        /* Set up cached registers which will be used to configure the MGM. */
-        if(commandExecuted) {
-            commandExecuted = false;
-            if(goToNormalMode) {
-                setMode(MODE_NORMAL);
-            }
-            else {
-                setMode(_MODE_TO_ON);
-            }
-        }
-        break;
-    }
-    default:
-        break;
-    }
-
-}
-
-void MgmLIS3MDLHandler::doShutDown() {
-    setMode(_MODE_POWER_DOWN);
-}
-
-ReturnValue_t MgmLIS3MDLHandler::buildTransitionDeviceCommand(
-        DeviceCommandId_t *id) {
-    switch (internalState) {
-    case(InternalState::STATE_NONE):
-    case(InternalState::STATE_NORMAL): {
-        return DeviceHandlerBase::NOTHING_TO_SEND;
-    }
-    case(InternalState::STATE_FIRST_CONTACT): {
-        *id = MGMLIS3MDL::IDENTIFY_DEVICE;
-        break;
-    }
-    case(InternalState::STATE_SETUP): {
-        *id = MGMLIS3MDL::SETUP_MGM;
-        break;
-    }
-    case(InternalState::STATE_CHECK_REGISTERS): {
-        *id = MGMLIS3MDL::READ_CONFIG_AND_DATA;
-        break;
-    }
-    default: {
-        /* might be a configuration error. */
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-        sif::warning << "GyroHandler::buildTransitionDeviceCommand: Unknown internal state!" <<
-                std::endl;
-#else
-        sif::printWarning("GyroHandler::buildTransitionDeviceCommand: Unknown internal state!\n");
-#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
-        return HasReturnvaluesIF::RETURN_OK;
-    }
-
-    }
-    return buildCommandFromCommand(*id, NULL, 0);
-}
-
-uint8_t MgmLIS3MDLHandler::readCommand(uint8_t command, bool continuousCom) {
-    command |= (1 << MGMLIS3MDL::RW_BIT);
-    if (continuousCom == true) {
-        command |= (1 << MGMLIS3MDL::MS_BIT);
-    }
-    return command;
-}
-
-uint8_t MgmLIS3MDLHandler::writeCommand(uint8_t command, bool continuousCom) {
-    command &= ~(1 << MGMLIS3MDL::RW_BIT);
-    if (continuousCom == true) {
-        command |= (1 << MGMLIS3MDL::MS_BIT);
-    }
-    return command;
-}
-
-void MgmLIS3MDLHandler::setupMgm() {
-
-    registers[0] = MGMLIS3MDL::CTRL_REG1_DEFAULT;
-    registers[1] = MGMLIS3MDL::CTRL_REG2_DEFAULT;
-    registers[2] = MGMLIS3MDL::CTRL_REG3_DEFAULT;
-    registers[3] = MGMLIS3MDL::CTRL_REG4_DEFAULT;
-    registers[4] = MGMLIS3MDL::CTRL_REG5_DEFAULT;
-
-    prepareCtrlRegisterWrite();
-}
-
-ReturnValue_t MgmLIS3MDLHandler::buildNormalDeviceCommand(
-        DeviceCommandId_t *id) {
-    // Data/config register will be read in an alternating manner.
-    if(communicationStep == CommunicationStep::DATA) {
-        *id = MGMLIS3MDL::READ_CONFIG_AND_DATA;
-        communicationStep = CommunicationStep::TEMPERATURE;
-        return buildCommandFromCommand(*id, NULL, 0);
-    }
-    else {
-        *id = MGMLIS3MDL::READ_TEMPERATURE;
-        communicationStep = CommunicationStep::DATA;
-        return buildCommandFromCommand(*id, NULL, 0);
-    }
-
-}
-
-ReturnValue_t MgmLIS3MDLHandler::buildCommandFromCommand(
-        DeviceCommandId_t deviceCommand, const uint8_t *commandData,
-        size_t commandDataLen) {
-    switch(deviceCommand) {
-    case(MGMLIS3MDL::READ_CONFIG_AND_DATA): {
-        std::memset(commandBuffer, 0, sizeof(commandBuffer));
-        commandBuffer[0] = readCommand(MGMLIS3MDL::CTRL_REG1, true);
-
-        rawPacket = commandBuffer;
-        rawPacketLen = MGMLIS3MDL::NR_OF_DATA_AND_CFG_REGISTERS + 1;
-        return RETURN_OK;
-    }
-    case(MGMLIS3MDL::READ_TEMPERATURE): {
-        std::memset(commandBuffer, 0, 3);
-        commandBuffer[0] = readCommand(MGMLIS3MDL::TEMP_LOWBYTE, true);
-
-        rawPacket = commandBuffer;
-        rawPacketLen = 3;
-        return RETURN_OK;
-    }
-    case(MGMLIS3MDL::IDENTIFY_DEVICE): {
-        return identifyDevice();
-    }
-    case(MGMLIS3MDL::TEMP_SENSOR_ENABLE): {
-        return enableTemperatureSensor(commandData, commandDataLen);
-    }
-    case(MGMLIS3MDL::SETUP_MGM): {
-        setupMgm();
-        return HasReturnvaluesIF::RETURN_OK;
-    }
-    case(MGMLIS3MDL::ACCURACY_OP_MODE_SET): {
-        return setOperatingMode(commandData, commandDataLen);
-    }
-    default:
-        return DeviceHandlerIF::COMMAND_NOT_IMPLEMENTED;
-    }
-    return HasReturnvaluesIF::RETURN_FAILED;
-}
-
-ReturnValue_t MgmLIS3MDLHandler::identifyDevice() {
-    uint32_t size = 2;
-    commandBuffer[0] = readCommand(MGMLIS3MDL::IDENTIFY_DEVICE_REG_ADDR);
-    commandBuffer[1] = 0x00;
-
-    rawPacket = commandBuffer;
-    rawPacketLen = size;
-
-    return RETURN_OK;
-}
-
-ReturnValue_t MgmLIS3MDLHandler::scanForReply(const uint8_t *start,
-        size_t len, DeviceCommandId_t *foundId, size_t *foundLen) {
-    *foundLen = len;
-    if (len == MGMLIS3MDL::NR_OF_DATA_AND_CFG_REGISTERS + 1) {
-        *foundLen = len;
-        *foundId = MGMLIS3MDL::READ_CONFIG_AND_DATA;
-        // Check validity by checking config registers
-        if (start[1] != registers[0] or start[2] != registers[1] or
-                start[3] != registers[2] or start[4] != registers[3] or
-                start[5] != registers[4]) {
-#if FSFW_VERBOSE_LEVEL >= 1
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-            sif::warning << "MGMHandlerLIS3MDL::scanForReply: Invalid registers!" << std::endl;
-#else
-            sif::printWarning("MGMHandlerLIS3MDL::scanForReply: Invalid registers!\n");
-#endif
-#endif
-            return DeviceHandlerIF::INVALID_DATA;
-        }
-        if(mode == _MODE_START_UP) {
-            commandExecuted = true;
-        }
-
-    }
-    else if(len == MGMLIS3MDL::TEMPERATURE_REPLY_LEN) {
-        *foundLen = len;
-        *foundId = MGMLIS3MDL::READ_TEMPERATURE;
-    }
-    else if (len == MGMLIS3MDL::SETUP_REPLY_LEN) {
-        *foundLen = len;
-        *foundId = MGMLIS3MDL::SETUP_MGM;
-    }
-    else if (len == SINGLE_COMMAND_ANSWER_LEN) {
-        *foundLen = len;
-        *foundId = getPendingCommand();
-        if(*foundId == MGMLIS3MDL::IDENTIFY_DEVICE) {
-            if(start[1] != MGMLIS3MDL::DEVICE_ID) {
-#if FSFW_VERBOSE_LEVEL >= 1
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-                sif::warning << "MGMHandlerLIS3MDL::scanForReply: "
-                        "Device identification failed!" << std::endl;
-#else
-                sif::printWarning("MGMHandlerLIS3MDL::scanForReply: "
-                        "Device identification failed!\n");
-#endif
-#endif
-                return DeviceHandlerIF::INVALID_DATA;
-            }
-
-            if(mode == _MODE_START_UP) {
-                commandExecuted = true;
-            }
-        }
-    }
-    else {
-        return DeviceHandlerIF::INVALID_DATA;
-    }
-
-    /* Data with SPI Interface always has this answer */
-    if (start[0] == 0b11111111) {
-        return RETURN_OK;
-    }
-    else {
-        return DeviceHandlerIF::INVALID_DATA;
-    }
-
-}
-ReturnValue_t MgmLIS3MDLHandler::interpretDeviceReply(DeviceCommandId_t id,
-        const uint8_t *packet) {
-
-    switch (id) {
-    case MGMLIS3MDL::IDENTIFY_DEVICE: {
-        break;
-    }
-    case MGMLIS3MDL::SETUP_MGM: {
-        break;
-    }
-    case MGMLIS3MDL::READ_CONFIG_AND_DATA: {
-        // TODO: Store configuration in new local datasets.
-        float sensitivityFactor = getSensitivityFactor(getSensitivity(registers[2]));
-
-        int16_t mgmMeasurementRawX = packet[MGMLIS3MDL::X_HIGHBYTE_IDX] << 8
-                | packet[MGMLIS3MDL::X_LOWBYTE_IDX] ;
-        int16_t mgmMeasurementRawY = packet[MGMLIS3MDL::Y_HIGHBYTE_IDX] << 8
-                | packet[MGMLIS3MDL::Y_LOWBYTE_IDX] ;
-        int16_t mgmMeasurementRawZ = packet[MGMLIS3MDL::Z_HIGHBYTE_IDX] << 8
-                | packet[MGMLIS3MDL::Z_LOWBYTE_IDX] ;
-
-        /* Target value in microtesla */
-        float mgmX = static_cast<float>(mgmMeasurementRawX) * sensitivityFactor
-                *  MGMLIS3MDL::GAUSS_TO_MICROTESLA_FACTOR;
-        float mgmY = static_cast<float>(mgmMeasurementRawY) * sensitivityFactor
-                *  MGMLIS3MDL::GAUSS_TO_MICROTESLA_FACTOR;
-        float mgmZ = static_cast<float>(mgmMeasurementRawZ) * sensitivityFactor
-                *  MGMLIS3MDL::GAUSS_TO_MICROTESLA_FACTOR;
-
-#if FSFW_HAL_LIS3MDL_MGM_DEBUG == 1
-        if(debugDivider->checkAndIncrement()) {
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-            sif::info << "MGMHandlerLIS3: Magnetic field strength in"
-                    " microtesla:" << std::endl;
-            sif::info << "X: " << mgmX << " uT" << std::endl;
-            sif::info << "Y: " << mgmY << " uT" << std::endl;
-            sif::info << "Z: " << mgmZ << " uT" << std::endl;
-#else
-            sif::printInfo("MGMHandlerLIS3: Magnetic field strength in microtesla:\n");
-            sif::printInfo("X: %f uT\n", mgmX);
-            sif::printInfo("Y: %f uT\n", mgmY);
-            sif::printInfo("Z: %f uT\n", mgmZ);
-#endif /* FSFW_CPP_OSTREAM_ENABLED == 0 */
-        }
-#endif /* OBSW_VERBOSE_LEVEL >= 1 */
-        PoolReadGuard readHelper(&dataset);
-        if(readHelper.getReadResult() == HasReturnvaluesIF::RETURN_OK) {
-            if(std::abs(mgmX) < absLimitX) {
-                dataset.fieldStrengthX = mgmX;
-                dataset.fieldStrengthX.setValid(true);
-            }
-            else {
-                dataset.fieldStrengthX.setValid(false);
-            }
-
-            if(std::abs(mgmY) < absLimitY) {
-                dataset.fieldStrengthY = mgmY;
-                dataset.fieldStrengthY.setValid(true);
-            }
-            else {
-                dataset.fieldStrengthY.setValid(false);
-            }
-
-            if(std::abs(mgmZ) < absLimitZ) {
-                dataset.fieldStrengthZ = mgmZ;
-                dataset.fieldStrengthZ.setValid(true);
-            }
-            else {
-                dataset.fieldStrengthZ.setValid(false);
-            }
-        }
-        break;
-    }
-
-    case MGMLIS3MDL::READ_TEMPERATURE: {
-        int16_t tempValueRaw = packet[2] << 8 | packet[1];
-        float tempValue = 25.0 + ((static_cast<float>(tempValueRaw)) / 8.0);
-    #if FSFW_HAL_LIS3MDL_MGM_DEBUG == 1
-        if(debugDivider->check()) {
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-            sif::info << "MGMHandlerLIS3: Temperature: " << tempValue << " C" <<
-                    std::endl;
-#else
-            sif::printInfo("MGMHandlerLIS3: Temperature: %f C\n");
-#endif
-        }
-#endif
-        ReturnValue_t result = dataset.read();
-        if(result == HasReturnvaluesIF::RETURN_OK) {
-            dataset.temperature = tempValue;
-            dataset.commit();
-        }
-        break;
-    }
-
-    default: {
-        return DeviceHandlerIF::UNKNOWN_DEVICE_REPLY;
-    }
-
-    }
-    return RETURN_OK;
-}
-
-MGMLIS3MDL::Sensitivies MgmLIS3MDLHandler::getSensitivity(uint8_t ctrlRegister2) {
-    bool fs0Set = ctrlRegister2 & (1 << MGMLIS3MDL::FSO);  // Checks if FS0 bit is set
-    bool fs1Set = ctrlRegister2 & (1 << MGMLIS3MDL::FS1);  // Checks if FS1 bit is set
-
-    if (fs0Set && fs1Set)
-        return MGMLIS3MDL::Sensitivies::GAUSS_16;
-    else if (!fs0Set && fs1Set)
-        return MGMLIS3MDL::Sensitivies::GAUSS_12;
-    else if (fs0Set && !fs1Set)
-        return MGMLIS3MDL::Sensitivies::GAUSS_8;
-    else
-        return MGMLIS3MDL::Sensitivies::GAUSS_4;
-}
-
-float MgmLIS3MDLHandler::getSensitivityFactor(MGMLIS3MDL::Sensitivies sens) {
-    switch(sens) {
-    case(MGMLIS3MDL::GAUSS_4): {
-        return MGMLIS3MDL::FIELD_LSB_PER_GAUSS_4_SENS;
-    }
-    case(MGMLIS3MDL::GAUSS_8): {
-        return MGMLIS3MDL::FIELD_LSB_PER_GAUSS_8_SENS;
-    }
-    case(MGMLIS3MDL::GAUSS_12): {
-        return MGMLIS3MDL::FIELD_LSB_PER_GAUSS_12_SENS;
-    }
-    case(MGMLIS3MDL::GAUSS_16): {
-        return MGMLIS3MDL::FIELD_LSB_PER_GAUSS_16_SENS;
-    }
-    default: {
-        // Should never happen
-        return MGMLIS3MDL::FIELD_LSB_PER_GAUSS_4_SENS;
-    }
-    }
-}
-
-
-ReturnValue_t MgmLIS3MDLHandler::enableTemperatureSensor(
-        const uint8_t *commandData, size_t commandDataLen) {
-    triggerEvent(CHANGE_OF_SETUP_PARAMETER);
-    uint32_t size = 2;
-    commandBuffer[0] = writeCommand(MGMLIS3MDL::CTRL_REG1);
-    if (commandDataLen > 1) {
-        return INVALID_NUMBER_OR_LENGTH_OF_PARAMETERS;
-    }
-    switch (*commandData) {
-    case (MGMLIS3MDL::ON): {
-        commandBuffer[1] = registers[0] | (1 << 7);
-        break;
-    }
-    case (MGMLIS3MDL::OFF): {
-        commandBuffer[1] = registers[0] & ~(1 << 7);
-        break;
-    }
-    default:
-        return INVALID_COMMAND_PARAMETER;
-    }
-    registers[0] = commandBuffer[1];
-
-    rawPacket = commandBuffer;
-    rawPacketLen = size;
-
-    return RETURN_OK;
-}
-
-ReturnValue_t MgmLIS3MDLHandler::setOperatingMode(const uint8_t *commandData,
-        size_t commandDataLen) {
-    triggerEvent(CHANGE_OF_SETUP_PARAMETER);
-    if (commandDataLen != 1) {
-        return INVALID_NUMBER_OR_LENGTH_OF_PARAMETERS;
-    }
-
-    switch (commandData[0]) {
-    case MGMLIS3MDL::LOW:
-        registers[0] = (registers[0] & (~(1 << MGMLIS3MDL::OM1))) & (~(1 << MGMLIS3MDL::OM0));
-        registers[3] = (registers[3] & (~(1 << MGMLIS3MDL::OMZ1))) & (~(1 << MGMLIS3MDL::OMZ0));
-        break;
-    case MGMLIS3MDL::MEDIUM:
-        registers[0] = (registers[0] & (~(1 << MGMLIS3MDL::OM1))) | (1 << MGMLIS3MDL::OM0);
-        registers[3] = (registers[3] & (~(1 << MGMLIS3MDL::OMZ1))) | (1 << MGMLIS3MDL::OMZ0);
-        break;
-
-    case MGMLIS3MDL::HIGH:
-        registers[0] = (registers[0] | (1 << MGMLIS3MDL::OM1)) & (~(1 << MGMLIS3MDL::OM0));
-        registers[3] = (registers[3] | (1 << MGMLIS3MDL::OMZ1)) & (~(1 << MGMLIS3MDL::OMZ0));
-        break;
-
-    case MGMLIS3MDL::ULTRA:
-        registers[0] = (registers[0] | (1 << MGMLIS3MDL::OM1)) | (1 << MGMLIS3MDL::OM0);
-        registers[3] = (registers[3] | (1 << MGMLIS3MDL::OMZ1)) | (1 << MGMLIS3MDL::OMZ0);
-        break;
-    default:
-        break;
-    }
-
-    return prepareCtrlRegisterWrite();
-}
-
-void MgmLIS3MDLHandler::fillCommandAndReplyMap() {
-    insertInCommandAndReplyMap(MGMLIS3MDL::READ_CONFIG_AND_DATA, 1, &dataset);
-    insertInCommandAndReplyMap(MGMLIS3MDL::READ_TEMPERATURE, 1);
-    insertInCommandAndReplyMap(MGMLIS3MDL::SETUP_MGM, 1);
-    insertInCommandAndReplyMap(MGMLIS3MDL::IDENTIFY_DEVICE, 1);
-    insertInCommandAndReplyMap(MGMLIS3MDL::TEMP_SENSOR_ENABLE, 1);
-    insertInCommandAndReplyMap(MGMLIS3MDL::ACCURACY_OP_MODE_SET, 1);
-}
-
-void MgmLIS3MDLHandler::setToGoToNormalMode(bool enable) {
-    this->goToNormalMode = enable;
-}
-
-ReturnValue_t MgmLIS3MDLHandler::prepareCtrlRegisterWrite() {
-    commandBuffer[0] = writeCommand(MGMLIS3MDL::CTRL_REG1, true);
-
-    for (size_t i = 0; i < MGMLIS3MDL::NR_OF_CTRL_REGISTERS; i++) {
-        commandBuffer[i + 1] = registers[i];
-    }
-    rawPacket = commandBuffer;
-    rawPacketLen = MGMLIS3MDL::NR_OF_CTRL_REGISTERS + 1;
-
-    // We dont have to check if this is working because we just did i
-    return RETURN_OK;
-}
-
-void MgmLIS3MDLHandler::doTransition(Mode_t modeFrom, Submode_t subModeFrom) {
-
-}
-
-uint32_t MgmLIS3MDLHandler::getTransitionDelayMs(Mode_t from, Mode_t to) {
-    return transitionDelay;
-}
-
-void MgmLIS3MDLHandler::modeChanged(void) {
-    internalState = InternalState::STATE_NONE;
-}
-
-ReturnValue_t MgmLIS3MDLHandler::initializeLocalDataPool(
-        localpool::DataPool &localDataPoolMap, LocalDataPoolManager &poolManager) {
-    localDataPoolMap.emplace(MGMLIS3MDL::FIELD_STRENGTH_X,
-            new PoolEntry<float>({0.0}));
-    localDataPoolMap.emplace(MGMLIS3MDL::FIELD_STRENGTH_Y,
-            new PoolEntry<float>({0.0}));
-    localDataPoolMap.emplace(MGMLIS3MDL::FIELD_STRENGTH_Z,
-            new PoolEntry<float>({0.0}));
-    localDataPoolMap.emplace(MGMLIS3MDL::TEMPERATURE_CELCIUS,
-            new PoolEntry<float>({0.0}));
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-void MgmLIS3MDLHandler::setAbsoluteLimits(float xLimit, float yLimit, float zLimit) {
-    this->absLimitX = xLimit;
-    this->absLimitY = yLimit;
-    this->absLimitZ = zLimit;
-}

hal/src/fsfw_hal/devicehandlers/MgmLIS3MDLHandler.h

@@ -1,186 +0,0 @@
-#ifndef MISSION_DEVICES_MGMLIS3MDLHANDLER_H_
-#define MISSION_DEVICES_MGMLIS3MDLHANDLER_H_
-
-#include "fsfw/FSFW.h"
-#include "events/subsystemIdRanges.h"
-#include "devicedefinitions/MgmLIS3HandlerDefs.h"
-
-#include "fsfw/devicehandlers/DeviceHandlerBase.h"
-
-class PeriodicOperationDivider;
-
-/**
- * @brief   Device handler object for the LIS3MDL 3-axis magnetometer
- *          by STMicroeletronics
- * @details
- * Datasheet can be found online by googling LIS3MDL.
- * Flight manual:
- * https://egit.irs.uni-stuttgart.de/redmine/projects/eive-flight-manual/wiki/LIS3MDL_MGM
- * @author  L. Loidold, R. Mueller
- */
-class MgmLIS3MDLHandler: public DeviceHandlerBase {
-public:
-    enum class CommunicationStep {
-        DATA,
-        TEMPERATURE
-    };
-
-    static const uint8_t INTERFACE_ID = CLASS_ID::MGM_LIS3MDL;
-    static const uint8_t SUBSYSTEM_ID = SUBSYSTEM_ID::MGM_LIS3MDL;
-    //Notifies a command to change the setup parameters
-    static const Event CHANGE_OF_SETUP_PARAMETER = MAKE_EVENT(0, severity::LOW);
-
-    MgmLIS3MDLHandler(uint32_t objectId, object_id_t deviceCommunication, CookieIF* comCookie,
-            uint32_t transitionDelay);
-    virtual ~MgmLIS3MDLHandler();
-
-    /**
-     * Set the absolute limit for the values on the axis in microtesla. The dataset values will
-     * be marked as invalid if that limit is exceeded
-     * @param xLimit
-     * @param yLimit
-     * @param zLimit
-     */
-    void setAbsoluteLimits(float xLimit, float yLimit, float zLimit);
-    void setToGoToNormalMode(bool enable);
-
-protected:
-
-    /** DeviceHandlerBase overrides */
-    void doShutDown() override;
-    void doStartUp() override;
-    void doTransition(Mode_t modeFrom, Submode_t subModeFrom) override;
-    virtual uint32_t getTransitionDelayMs(Mode_t from, Mode_t to) override;
-    ReturnValue_t buildCommandFromCommand(
-            DeviceCommandId_t deviceCommand, const uint8_t *commandData,
-            size_t commandDataLen) override;
-    ReturnValue_t buildTransitionDeviceCommand(
-            DeviceCommandId_t *id) override;
-    ReturnValue_t buildNormalDeviceCommand(
-            DeviceCommandId_t *id) override;
-    ReturnValue_t scanForReply(const uint8_t *start, size_t len,
-            DeviceCommandId_t *foundId, size_t *foundLen) override;
-    /**
-     * This implementation is tailored towards space applications and will flag values larger
-     * than 100 microtesla on X,Y and 150 microtesla on Z as invalid
-     * @param id
-     * @param packet
-     * @return
-     */
-    virtual ReturnValue_t interpretDeviceReply(DeviceCommandId_t id,
-            const uint8_t *packet) override;
-    void fillCommandAndReplyMap() override;
-    void modeChanged(void) override;
-    ReturnValue_t initializeLocalDataPool(localpool::DataPool &localDataPoolMap,
-            LocalDataPoolManager &poolManager) override;
-
-private:
-    MGMLIS3MDL::MgmPrimaryDataset dataset;
-    //Length a single command SPI answer
-    static const uint8_t SINGLE_COMMAND_ANSWER_LEN = 2;
-
-    uint32_t transitionDelay;
-    // Single SPI command has 2 bytes, first for adress, second for content
-    size_t singleComandSize = 2;
-    // Has the size for all adresses of the lis3mdl + the continous write bit
-    uint8_t commandBuffer[MGMLIS3MDL::NR_OF_DATA_AND_CFG_REGISTERS + 1];
-
-    float absLimitX = 100;
-    float absLimitY = 100;
-    float absLimitZ = 150;
-
-    /**
-     * We want to save the registers we set, so we dont have to read the
-     * registers when we want to change something.
-     * --> everytime we change set a register we have to save it
-     */
-    uint8_t registers[MGMLIS3MDL::NR_OF_CTRL_REGISTERS];
-
-    uint8_t statusRegister = 0;
-    bool goToNormalMode = false;
-
-    enum class InternalState {
-        STATE_NONE,
-        STATE_FIRST_CONTACT,
-        STATE_SETUP,
-        STATE_CHECK_REGISTERS,
-        STATE_NORMAL
-    };
-
-    InternalState internalState = InternalState::STATE_NONE;
-    CommunicationStep communicationStep = CommunicationStep::DATA;
-    bool commandExecuted = false;
-
-    /*------------------------------------------------------------------------*/
-    /* Device specific commands and variables */
-    /*------------------------------------------------------------------------*/
-    /**
-     * Sets the read bit for the command
-     * @param single command to set the read-bit at
-     * @param boolean to select a continuous read bit, default = false
-     */
-    uint8_t readCommand(uint8_t command, bool continuousCom = false);
-
-    /**
-     * Sets the write bit for the command
-     * @param single command to set the write-bit at
-     * @param boolean to select a continuous write bit, default = false
-     */
-    uint8_t writeCommand(uint8_t command, bool continuousCom = false);
-
-    /**
-     * This Method gets the full scale for the measurement range
-     * e.g.: +- 4 gauss. See p.25 datasheet.
-     *  @return The ReturnValue does not contain the sign of the value
-     */
-    MGMLIS3MDL::Sensitivies getSensitivity(uint8_t ctrlReg2);
-
-    /**
-     * The 16 bit value needs to be multiplied with a sensitivity factor
-     * which depends on the sensitivity configuration
-     *
-     * @param sens Configured sensitivity of the LIS3 device
-     * @return Multiplication factor to get the sensor value from raw data.
-     */
-    float getSensitivityFactor(MGMLIS3MDL::Sensitivies sens);
-
-    /**
-     * This Command detects the device ID
-     */
-    ReturnValue_t identifyDevice();
-
-    virtual void setupMgm();
-
-    /*------------------------------------------------------------------------*/
-    /* Non normal commands */
-    /*------------------------------------------------------------------------*/
-    /**
-     * Enables/Disables the integrated Temperaturesensor
-     * @param commandData On or Off
-     * @param length of the commandData: has to be 1
-     */
-    virtual ReturnValue_t enableTemperatureSensor(const uint8_t *commandData,
-            size_t commandDataLen);
-
-    /**
-     * Sets the accuracy of the measurement of the axis. The noise is changing.
-     * @param commandData LOW, MEDIUM, HIGH, ULTRA
-     * @param length of the command, has to be 1
-     */
-    virtual ReturnValue_t setOperatingMode(const uint8_t *commandData,
-            size_t commandDataLen);
-
-    /**
-     * We always update all registers together, so this method updates
-     * the rawpacket and rawpacketLen, so we just manipulate the local
-     * saved register
-     *
-     */
-    ReturnValue_t prepareCtrlRegisterWrite();
-
-#if FSFW_HAL_LIS3MDL_MGM_DEBUG == 1
-    PeriodicOperationDivider* debugDivider;
-#endif
-};
-
-#endif /* MISSION_DEVICES_MGMLIS3MDLHANDLER_H_ */

hal/src/fsfw_hal/devicehandlers/MgmRM3100Handler.cpp

@@ -1,376 +0,0 @@
-#include "MgmRM3100Handler.h"
-
-#include "fsfw/datapool/PoolReadGuard.h"
-#include "fsfw/globalfunctions/bitutility.h"
-#include "fsfw/devicehandlers/DeviceHandlerMessage.h"
-#include "fsfw/objectmanager/SystemObjectIF.h"
-#include "fsfw/returnvalues/HasReturnvaluesIF.h"
-
-
-MgmRM3100Handler::MgmRM3100Handler(object_id_t objectId,
-        object_id_t deviceCommunication, CookieIF* comCookie, uint32_t transitionDelay):
-        DeviceHandlerBase(objectId, deviceCommunication, comCookie),
-        primaryDataset(this), transitionDelay(transitionDelay) {
-#if FSFW_HAL_RM3100_MGM_DEBUG == 1
-    debugDivider = new PeriodicOperationDivider(3);
-#endif
-}
-
-MgmRM3100Handler::~MgmRM3100Handler() {}
-
-void MgmRM3100Handler::doStartUp() {
-    switch(internalState) {
-    case(InternalState::NONE): {
-        internalState = InternalState::CONFIGURE_CMM;
-        break;
-    }
-    case(InternalState::CONFIGURE_CMM): {
-        internalState = InternalState::READ_CMM;
-        break;
-    }
-    case(InternalState::READ_CMM): {
-        if(commandExecuted) {
-            internalState = InternalState::STATE_CONFIGURE_TMRC;
-        }
-        break;
-    }
-    case(InternalState::STATE_CONFIGURE_TMRC): {
-        if(commandExecuted) {
-            internalState = InternalState::STATE_READ_TMRC;
-        }
-        break;
-    }
-    case(InternalState::STATE_READ_TMRC): {
-        if(commandExecuted) {
-            internalState = InternalState::NORMAL;
-            if(goToNormalModeAtStartup) {
-                setMode(MODE_NORMAL);
-            }
-            else {
-                setMode(_MODE_TO_ON);
-            }
-        }
-        break;
-    }
-    default: {
-        break;
-    }
-    }
-}
-
-void MgmRM3100Handler::doShutDown() {
-    setMode(_MODE_POWER_DOWN);
-}
-
-ReturnValue_t MgmRM3100Handler::buildTransitionDeviceCommand(
-        DeviceCommandId_t *id) {
-    size_t commandLen = 0;
-    switch(internalState) {
-    case(InternalState::NONE):
-    case(InternalState::NORMAL): {
-        return NOTHING_TO_SEND;
-    }
-    case(InternalState::CONFIGURE_CMM): {
-        *id = RM3100::CONFIGURE_CMM;
-        break;
-    }
-    case(InternalState::READ_CMM): {
-        *id = RM3100::READ_CMM;
-        break;
-    }
-    case(InternalState::STATE_CONFIGURE_TMRC): {
-        commandBuffer[0] = RM3100::TMRC_DEFAULT_VALUE;
-        commandLen = 1;
-        *id = RM3100::CONFIGURE_TMRC;
-        break;
-    }
-    case(InternalState::STATE_READ_TMRC): {
-        *id = RM3100::READ_TMRC;
-        break;
-    }
-    default:
-#if FSFW_VERBOSE_LEVEL >= 1
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-        // Might be a configuration error
-        sif::warning << "MgmRM3100Handler::buildTransitionDeviceCommand: "
-                "Unknown internal state" << std::endl;
-#else
-        sif::printWarning("MgmRM3100Handler::buildTransitionDeviceCommand: "
-                "Unknown internal state\n");
-#endif
-#endif
-        return HasReturnvaluesIF::RETURN_OK;
-    }
-
-    return buildCommandFromCommand(*id, commandBuffer, commandLen);
-}
-
-ReturnValue_t MgmRM3100Handler::buildCommandFromCommand(DeviceCommandId_t deviceCommand,
-        const uint8_t *commandData, size_t commandDataLen) {
-    switch(deviceCommand) {
-    case(RM3100::CONFIGURE_CMM): {
-        commandBuffer[0] = RM3100::CMM_REGISTER;
-        commandBuffer[1] = RM3100::CMM_VALUE;
-        rawPacket = commandBuffer;
-        rawPacketLen = 2;
-        break;
-    }
-    case(RM3100::READ_CMM): {
-        commandBuffer[0] = RM3100::CMM_REGISTER | RM3100::READ_MASK;
-        commandBuffer[1] = 0;
-        rawPacket = commandBuffer;
-        rawPacketLen = 2;
-        break;
-    }
-    case(RM3100::CONFIGURE_TMRC): {
-        return handleTmrcConfigCommand(deviceCommand, commandData, commandDataLen);
-    }
-    case(RM3100::READ_TMRC): {
-        commandBuffer[0] = RM3100::TMRC_REGISTER | RM3100::READ_MASK;
-        commandBuffer[1] = 0;
-        rawPacket = commandBuffer;
-        rawPacketLen = 2;
-        break;
-    }
-    case(RM3100::CONFIGURE_CYCLE_COUNT): {
-        return handleCycleCountConfigCommand(deviceCommand, commandData, commandDataLen);
-    }
-    case(RM3100::READ_CYCLE_COUNT): {
-        commandBuffer[0] = RM3100::CYCLE_COUNT_START_REGISTER | RM3100::READ_MASK;
-        std::memset(commandBuffer + 1, 0, 6);
-        rawPacket = commandBuffer;
-        rawPacketLen = 7;
-        break;
-    }
-    case(RM3100::READ_DATA): {
-        commandBuffer[0] = RM3100::MEASUREMENT_REG_START | RM3100::READ_MASK;
-        std::memset(commandBuffer + 1, 0,  9);
-        rawPacketLen = 10;
-        break;
-    }
-    default:
-        return DeviceHandlerIF::COMMAND_NOT_IMPLEMENTED;
-    }
-    return RETURN_OK;
-}
-
-ReturnValue_t MgmRM3100Handler::buildNormalDeviceCommand(
-        DeviceCommandId_t *id) {
-    *id = RM3100::READ_DATA;
-    return buildCommandFromCommand(*id, nullptr, 0);
-}
-
-ReturnValue_t MgmRM3100Handler::scanForReply(const uint8_t *start,
-        size_t len, DeviceCommandId_t *foundId,
-        size_t *foundLen) {
-
-    // For SPI, ID will always be the one of the last sent command
-    *foundId = this->getPendingCommand();
-    *foundLen = len;
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t MgmRM3100Handler::interpretDeviceReply(DeviceCommandId_t id, const uint8_t *packet) {
-    ReturnValue_t result = HasReturnvaluesIF::RETURN_OK;
-    switch(id) {
-    case(RM3100::CONFIGURE_CMM):
-    case(RM3100::CONFIGURE_CYCLE_COUNT):
-    case(RM3100::CONFIGURE_TMRC): {
-        // We can only check whether write was successful with read operation
-        if(mode == _MODE_START_UP) {
-            commandExecuted = true;
-        }
-        break;
-    }
-    case(RM3100::READ_CMM): {
-        uint8_t cmmValue = packet[1];
-        // We clear the seventh bit in any case
-        // because this one is zero sometimes for some reason
-        bitutil::clear(&cmmValue, 6);
-        if(cmmValue == cmmRegValue and internalState == InternalState::READ_CMM) {
-            commandExecuted = true;
-        }
-        else {
-            // Attempt reconfiguration
-            internalState = InternalState::CONFIGURE_CMM;
-            return DeviceHandlerIF::DEVICE_REPLY_INVALID;
-        }
-        break;
-    }
-    case(RM3100::READ_TMRC): {
-        if(packet[1] == tmrcRegValue) {
-            commandExecuted = true;
-            // Reading TMRC was commanded. Trigger event to inform ground
-            if(mode != _MODE_START_UP) {
-                triggerEvent(tmrcSet, tmrcRegValue, 0);
-            }
-        }
-        else {
-            // Attempt reconfiguration
-            internalState = InternalState::STATE_CONFIGURE_TMRC;
-            return DeviceHandlerIF::DEVICE_REPLY_INVALID;
-        }
-        break;
-    }
-    case(RM3100::READ_CYCLE_COUNT): {
-        uint16_t cycleCountX = packet[1] << 8 | packet[2];
-        uint16_t cycleCountY = packet[3] << 8 | packet[4];
-        uint16_t cycleCountZ = packet[5] << 8 | packet[6];
-        if(cycleCountX != cycleCountRegValueX or cycleCountY != cycleCountRegValueY or
-                cycleCountZ != cycleCountRegValueZ) {
-            return DeviceHandlerIF::DEVICE_REPLY_INVALID;
-        }
-        // Reading TMRC was commanded. Trigger event to inform ground
-        if(mode != _MODE_START_UP) {
-            uint32_t eventParam1 = (cycleCountX << 16) | cycleCountY;
-            triggerEvent(cycleCountersSet, eventParam1, cycleCountZ);
-        }
-        break;
-    }
-    case(RM3100::READ_DATA): {
-        result = handleDataReadout(packet);
-        break;
-    }
-    default:
-        return DeviceHandlerIF::UNKNOWN_DEVICE_REPLY;
-    }
-
-    return result;
-}
-
-ReturnValue_t MgmRM3100Handler::handleCycleCountConfigCommand(DeviceCommandId_t deviceCommand,
-        const uint8_t *commandData, size_t commandDataLen) {
-    if(commandData == nullptr) {
-        return DeviceHandlerIF::INVALID_COMMAND_PARAMETER;
-    }
-
-    // Set cycle count
-    if(commandDataLen == 2) {
-        handleCycleCommand(true, commandData, commandDataLen);
-    }
-    else if(commandDataLen == 6) {
-        handleCycleCommand(false, commandData, commandDataLen);
-    }
-    else {
-        return DeviceHandlerIF::INVALID_COMMAND_PARAMETER;
-    }
-
-    commandBuffer[0] = RM3100::CYCLE_COUNT_VALUE;
-    std::memcpy(commandBuffer + 1, &cycleCountRegValueX, 2);
-    std::memcpy(commandBuffer + 3, &cycleCountRegValueY, 2);
-    std::memcpy(commandBuffer + 5, &cycleCountRegValueZ, 2);
-    rawPacketLen = 7;
-    rawPacket = commandBuffer;
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t MgmRM3100Handler::handleCycleCommand(bool oneCycleValue,
-        const uint8_t *commandData, size_t commandDataLen) {
-    RM3100::CycleCountCommand command(oneCycleValue);
-    ReturnValue_t result = command.deSerialize(&commandData, &commandDataLen,
-            SerializeIF::Endianness::BIG);
-    if(result != HasReturnvaluesIF::RETURN_OK) {
-        return result;
-    }
-
-    // Data sheet p.30 "while noise limits the useful upper range to ~400 cycle counts."
-    if(command.cycleCountX > 450 ) {
-        return DeviceHandlerIF::INVALID_COMMAND_PARAMETER;
-    }
-
-    if(not oneCycleValue and (command.cycleCountY > 450 or command.cycleCountZ > 450)) {
-        return DeviceHandlerIF::INVALID_COMMAND_PARAMETER;
-    }
-
-    cycleCountRegValueX = command.cycleCountX;
-    cycleCountRegValueY = command.cycleCountY;
-    cycleCountRegValueZ = command.cycleCountZ;
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t MgmRM3100Handler::handleTmrcConfigCommand(DeviceCommandId_t deviceCommand,
-        const uint8_t *commandData, size_t commandDataLen) {
-    if(commandData == nullptr or commandDataLen != 1) {
-        return DeviceHandlerIF::INVALID_COMMAND_PARAMETER;
-    }
-
-    commandBuffer[0] = RM3100::TMRC_REGISTER;
-    commandBuffer[1] = commandData[0];
-    tmrcRegValue = commandData[0];
-    rawPacketLen = 2;
-    rawPacket = commandBuffer;
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-void MgmRM3100Handler::fillCommandAndReplyMap() {
-    insertInCommandAndReplyMap(RM3100::CONFIGURE_CMM, 3);
-    insertInCommandAndReplyMap(RM3100::READ_CMM, 3);
-
-    insertInCommandAndReplyMap(RM3100::CONFIGURE_TMRC, 3);
-    insertInCommandAndReplyMap(RM3100::READ_TMRC, 3);
-
-    insertInCommandAndReplyMap(RM3100::CONFIGURE_CYCLE_COUNT, 3);
-    insertInCommandAndReplyMap(RM3100::READ_CYCLE_COUNT, 3);
-
-    insertInCommandAndReplyMap(RM3100::READ_DATA, 3, &primaryDataset);
-}
-
-void MgmRM3100Handler::modeChanged(void) {
-    internalState = InternalState::NONE;
-}
-
-ReturnValue_t MgmRM3100Handler::initializeLocalDataPool(
-        localpool::DataPool &localDataPoolMap, LocalDataPoolManager &poolManager) {
-    localDataPoolMap.emplace(RM3100::FIELD_STRENGTH_X, new PoolEntry<float>({0.0}));
-    localDataPoolMap.emplace(RM3100::FIELD_STRENGTH_Y, new PoolEntry<float>({0.0}));
-    localDataPoolMap.emplace(RM3100::FIELD_STRENGTH_Z, new PoolEntry<float>({0.0}));
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-uint32_t MgmRM3100Handler::getTransitionDelayMs(Mode_t from, Mode_t to) {
-    return this->transitionDelay;
-}
-
-void MgmRM3100Handler::setToGoToNormalMode(bool enable) {
-    goToNormalModeAtStartup = enable;
-}
-
-ReturnValue_t MgmRM3100Handler::handleDataReadout(const uint8_t *packet) {
-    // Analyze data here. The sensor generates 24 bit signed values so we need to do some bitshift
-    // trickery here to calculate the raw values first
-    int32_t fieldStrengthRawX = ((packet[1] << 24) | (packet[2] << 16) | (packet[3] << 8)) >> 8;
-    int32_t fieldStrengthRawY = ((packet[4] << 24) | (packet[5] << 16) | (packet[6] << 8)) >> 8;
-    int32_t fieldStrengthRawZ  = ((packet[7] << 24) | (packet[8] << 16) | (packet[3] << 8)) >> 8;
-
-    // Now scale to physical value in microtesla
-    float fieldStrengthX = fieldStrengthRawX * scaleFactorX;
-    float fieldStrengthY = fieldStrengthRawY * scaleFactorX;
-    float fieldStrengthZ = fieldStrengthRawZ * scaleFactorX;
-
-#if FSFW_HAL_RM3100_MGM_DEBUG == 1
-    if(debugDivider->checkAndIncrement()) {
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-        sif::info << "MgmRM3100Handler: Magnetic field strength in"
-                " microtesla:" << std::endl;
-        sif::info << "X: " << fieldStrengthX << " uT" << std::endl;
-        sif::info << "Y: " << fieldStrengthY << " uT" << std::endl;
-        sif::info << "Z: " << fieldStrengthZ << " uT" << std::endl;
-#else
-        sif::printInfo("MgmRM3100Handler: Magnetic field strength in microtesla:\n");
-        sif::printInfo("X: %f uT\n", fieldStrengthX);
-        sif::printInfo("Y: %f uT\n", fieldStrengthY);
-        sif::printInfo("Z: %f uT\n", fieldStrengthZ);
-#endif
-    }
-#endif
-
-    // TODO: Sanity check on values?
-    PoolReadGuard readGuard(&primaryDataset);
-    if(readGuard.getReadResult() == HasReturnvaluesIF::RETURN_OK) {
-        primaryDataset.fieldStrengthX = fieldStrengthX;
-        primaryDataset.fieldStrengthY = fieldStrengthY;
-        primaryDataset.fieldStrengthZ = fieldStrengthZ;
-        primaryDataset.setValidity(true, true);
-    }
-    return RETURN_OK;
-}

hal/src/fsfw_hal/devicehandlers/MgmRM3100Handler.h

@@ -1,110 +0,0 @@
-#ifndef MISSION_DEVICES_MGMRM3100HANDLER_H_
-#define MISSION_DEVICES_MGMRM3100HANDLER_H_
-
-#include "fsfw/FSFW.h"
-#include "devicedefinitions/MgmRM3100HandlerDefs.h"
-#include "fsfw/devicehandlers/DeviceHandlerBase.h"
-
-#if FSFW_HAL_RM3100_MGM_DEBUG == 1
-#include "fsfw/globalfunctions/PeriodicOperationDivider.h"
-#endif
-
-/**
- * @brief 	Device Handler for the RM3100 geomagnetic magnetometer sensor
- *          (https://www.pnicorp.com/rm3100/)
- * @details
- * Flight manual:
- * https://egit.irs.uni-stuttgart.de/redmine/projects/eive-flight-manual/wiki/RM3100_MGM
- */
-class MgmRM3100Handler: public DeviceHandlerBase {
-public:
-	static const uint8_t INTERFACE_ID = CLASS_ID::MGM_RM3100;
-
-	//! [EXPORT] : [COMMENT] P1: TMRC value which was set, P2: 0
-	static constexpr Event tmrcSet = event::makeEvent(SUBSYSTEM_ID::MGM_RM3100,
-			0x00, severity::INFO);
-
-	//! [EXPORT] : [COMMENT] Cycle counter set. P1: First two bytes new Cycle Count X
-	//! P1: Second two bytes new Cycle Count Y
-	//! P2: New cycle count Z
-	static constexpr Event cycleCountersSet = event::makeEvent(
-			SUBSYSTEM_ID::MGM_RM3100, 0x01, severity::INFO);
-
-	MgmRM3100Handler(object_id_t objectId, object_id_t deviceCommunication,
-	        CookieIF* comCookie, uint32_t transitionDelay);
-	virtual ~MgmRM3100Handler();
-
-	/**
-	 * Configure device handler to go to normal mode after startup immediately
-	 * @param enable
-	 */
-	void setToGoToNormalMode(bool enable);
-
-protected:
-
-	/* DeviceHandlerBase overrides */
-	ReturnValue_t buildTransitionDeviceCommand(
-	        DeviceCommandId_t *id) override;
-	void doStartUp() override;
-	void doShutDown() override;
-	ReturnValue_t buildNormalDeviceCommand(DeviceCommandId_t *id) override;
-	ReturnValue_t buildCommandFromCommand(DeviceCommandId_t deviceCommand,
-	        const uint8_t *commandData, size_t commandDataLen) override;
-	ReturnValue_t scanForReply(const uint8_t *start, size_t len,
-			DeviceCommandId_t *foundId, size_t *foundLen) override;
-	ReturnValue_t interpretDeviceReply(DeviceCommandId_t id, const uint8_t *packet) override;
-
-	void fillCommandAndReplyMap() override;
-	void modeChanged(void) override;
-	virtual uint32_t getTransitionDelayMs(Mode_t from, Mode_t to) override;
-	ReturnValue_t initializeLocalDataPool(localpool::DataPool &localDataPoolMap,
-			LocalDataPoolManager &poolManager) override;
-
-private:
-
-	enum class InternalState {
-	    NONE,
-		CONFIGURE_CMM,
-		READ_CMM,
-		// The cycle count states are propably not going to be used because
-		// the default cycle count will be used.
-		STATE_CONFIGURE_CYCLE_COUNT,
-		STATE_READ_CYCLE_COUNT,
-		STATE_CONFIGURE_TMRC,
-		STATE_READ_TMRC,
-		NORMAL
-	};
-	InternalState internalState = InternalState::NONE;
-	bool commandExecuted = false;
-	RM3100::Rm3100PrimaryDataset primaryDataset;
-
-	uint8_t commandBuffer[10];
-	uint8_t commandBufferLen = 0;
-
-	uint8_t cmmRegValue = RM3100::CMM_VALUE;
-	uint8_t tmrcRegValue = RM3100::TMRC_DEFAULT_VALUE;
-	uint16_t cycleCountRegValueX = RM3100::CYCLE_COUNT_VALUE;
-	uint16_t cycleCountRegValueY = RM3100::CYCLE_COUNT_VALUE;
-	uint16_t cycleCountRegValueZ = RM3100::CYCLE_COUNT_VALUE;
-	float scaleFactorX = 1.0 / RM3100::DEFAULT_GAIN;
-	float scaleFactorY = 1.0 / RM3100::DEFAULT_GAIN;
-	float scaleFactorZ = 1.0 / RM3100::DEFAULT_GAIN;
-
-	bool goToNormalModeAtStartup = false;
-	uint32_t transitionDelay;
-
-	ReturnValue_t handleCycleCountConfigCommand(DeviceCommandId_t deviceCommand,
-			const uint8_t *commandData,size_t commandDataLen);
-	ReturnValue_t handleCycleCommand(bool oneCycleValue,
-			const uint8_t *commandData, size_t commandDataLen);
-
-	ReturnValue_t handleTmrcConfigCommand(DeviceCommandId_t deviceCommand,
-			const uint8_t *commandData,size_t commandDataLen);
-
-	ReturnValue_t handleDataReadout(const uint8_t* packet);
-#if FSFW_HAL_RM3100_MGM_DEBUG == 1
-	PeriodicOperationDivider* debugDivider;
-#endif
-};
-
-#endif /* MISSION_DEVICEHANDLING_MGMRM3100HANDLER_H_ */

hal/src/fsfw_hal/linux/CMakeLists.txt

@@ -1,13 +0,0 @@
-if(FSFW_HAL_ADD_RASPBERRY_PI)
-    add_subdirectory(rpi)
-endif()
-
-target_sources(${LIB_FSFW_NAME} PRIVATE
-	UnixFileGuard.cpp
-	utility.cpp
-)
-
-add_subdirectory(gpio)
-add_subdirectory(spi)
-add_subdirectory(i2c)
-add_subdirectory(uart)

hal/src/fsfw_hal/linux/UnixFileGuard.cpp

@@ -1,37 +0,0 @@
-#include "fsfw/FSFW.h"
-#include "fsfw/serviceinterface.h"
-#include "fsfw_hal/linux/UnixFileGuard.h"
-
-#include <cerrno>
-#include <cstring>
-
-UnixFileGuard::UnixFileGuard(std::string device, int* fileDescriptor, int flags,
-        std::string diagnosticPrefix):
-        fileDescriptor(fileDescriptor) {
-    if(fileDescriptor == nullptr) {
-        return;
-    }
-    *fileDescriptor = open(device.c_str(), flags);
-    if (*fileDescriptor < 0) {
-#if FSFW_VERBOSE_LEVEL >= 1
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-        sif::warning << diagnosticPrefix << ": Opening device failed with error code " <<
-                errno << ": " << strerror(errno) << std::endl;
-#else
-        sif::printWarning("%s: Opening device failed with error code %d: %s\n",
-                diagnosticPrefix, errno, strerror(errno));
-#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
-#endif /* FSFW_VERBOSE_LEVEL >= 1 */
-        openStatus = OPEN_FILE_FAILED;
-    }
-}
-
-UnixFileGuard::~UnixFileGuard() {
-    if(fileDescriptor != nullptr) {
-        close(*fileDescriptor);
-    }
-}
-
-ReturnValue_t UnixFileGuard::getOpenResult() const {
-    return openStatus;
-}

hal/src/fsfw_hal/linux/UnixFileGuard.h

@@ -1,33 +0,0 @@
-#ifndef LINUX_UTILITY_UNIXFILEGUARD_H_
-#define LINUX_UTILITY_UNIXFILEGUARD_H_
-
-#include <fsfw/returnvalues/HasReturnvaluesIF.h>
-
-#include <string>
-
-#include <fcntl.h>
-#include <unistd.h>
-
-
-class UnixFileGuard {
-public:
-    static constexpr int READ_WRITE_FLAG = O_RDWR;
-    static constexpr int READ_ONLY_FLAG = O_RDONLY;
-    static constexpr int NON_BLOCKING_IO_FLAG = O_NONBLOCK;
-
-    static constexpr ReturnValue_t OPEN_FILE_FAILED = 1;
-
-    UnixFileGuard(std::string device, int* fileDescriptor, int flags,
-            std::string diagnosticPrefix = "");
-
-    virtual~ UnixFileGuard();
-
-    ReturnValue_t getOpenResult() const;
-private:
-    int* fileDescriptor = nullptr;
-    ReturnValue_t openStatus = HasReturnvaluesIF::RETURN_OK;
-};
-
-
-
-#endif /* LINUX_UTILITY_UNIXFILEGUARD_H_ */

hal/src/fsfw_hal/linux/gpio/CMakeLists.txt

@@ -1,12 +0,0 @@
-target_sources(${LIB_FSFW_NAME} PRIVATE
-    LinuxLibgpioIF.cpp
-)
-
-# This abstraction layer requires the gpiod library. You can install this library
-# with "sudo apt-get install -y libgpiod-dev". If you are cross-compiling, you need
-# to install the package before syncing the sysroot to your host computer.
-find_library(LIB_GPIO gpiod REQUIRED)
-
-target_link_libraries(${LIB_FSFW_NAME} PRIVATE
-    ${LIB_GPIO}
-)

hal/src/fsfw_hal/linux/gpio/LinuxLibgpioIF.cpp

@@ -1,442 +0,0 @@
-#include "LinuxLibgpioIF.h"
-
-#include "fsfw_hal/common/gpio/gpioDefinitions.h"
-#include "fsfw_hal/common/gpio/GpioCookie.h"
-
-#include "fsfw/serviceinterface/ServiceInterface.h"
-
-#include <utility>
-#include <unistd.h>
-#include <gpiod.h>
-
-LinuxLibgpioIF::LinuxLibgpioIF(object_id_t objectId) : SystemObject(objectId) {
-}
-
-LinuxLibgpioIF::~LinuxLibgpioIF() {
-    for(auto& config: gpioMap) {
-        delete(config.second);
-    }
-}
-
-ReturnValue_t LinuxLibgpioIF::addGpios(GpioCookie* gpioCookie) {
-    ReturnValue_t result;
-    if(gpioCookie == nullptr) {
-        sif::error << "LinuxLibgpioIF::addGpios: Invalid cookie" << std::endl;
-        return RETURN_FAILED;
-    }
-
-    GpioMap mapToAdd = gpioCookie->getGpioMap();
-
-    /* Check whether this ID already exists in the map and remove duplicates */
-    result = checkForConflicts(mapToAdd);
-    if (result != RETURN_OK){
-        return result;
-    }
-
-    result = configureGpios(mapToAdd);
-    if (result != RETURN_OK) {
-        return RETURN_FAILED;
-    }
-
-    /* Register new GPIOs in gpioMap */
-    gpioMap.insert(mapToAdd.begin(), mapToAdd.end());
-
-    return RETURN_OK;
-}
-
-ReturnValue_t LinuxLibgpioIF::configureGpios(GpioMap& mapToAdd) {
-    for(auto& gpioConfig: mapToAdd) {
-        auto& gpioType = gpioConfig.second->gpioType;
-        switch(gpioType) {
-        case(gpio::GpioTypes::NONE): {
-            return GPIO_INVALID_INSTANCE;
-        }
-        case(gpio::GpioTypes::GPIO_REGULAR_BY_CHIP): {
-            auto regularGpio = dynamic_cast<GpiodRegularByChip*>(gpioConfig.second);
-            if(regularGpio == nullptr) {
-                return GPIO_INVALID_INSTANCE;
-            }
-            configureGpioByChip(gpioConfig.first, *regularGpio);
-            break;
-        }
-        case(gpio::GpioTypes::GPIO_REGULAR_BY_LABEL):{
-            auto regularGpio = dynamic_cast<GpiodRegularByLabel*>(gpioConfig.second);
-            if(regularGpio == nullptr) {
-                return GPIO_INVALID_INSTANCE;
-            }
-            configureGpioByLabel(gpioConfig.first, *regularGpio);
-            break;
-        }
-        case(gpio::GpioTypes::GPIO_REGULAR_BY_LINE_NAME):{
-            auto regularGpio = dynamic_cast<GpiodRegularByLineName*>(gpioConfig.second);
-            if(regularGpio == nullptr) {
-                return GPIO_INVALID_INSTANCE;
-            }
-            configureGpioByLineName(gpioConfig.first, *regularGpio);
-            break;
-        }
-        case(gpio::GpioTypes::CALLBACK): {
-            auto gpioCallback = dynamic_cast<GpioCallback*>(gpioConfig.second);
-            if(gpioCallback->callback == nullptr) {
-                return GPIO_INVALID_INSTANCE;
-            }
-            gpioCallback->callback(gpioConfig.first, gpio::GpioOperation::WRITE,
-                    gpioCallback->initValue, gpioCallback->callbackArgs);
-        }
-        }
-    }
-    return RETURN_OK;
-}
-
-ReturnValue_t LinuxLibgpioIF::configureGpioByLabel(gpioId_t gpioId,
-        GpiodRegularByLabel &gpioByLabel) {
-    std::string& label = gpioByLabel.label;
-    struct gpiod_chip* chip = gpiod_chip_open_by_label(label.c_str());
-    if (chip == nullptr) {
-        sif::warning << "LinuxLibgpioIF::configureGpioByLabel: Failed to open gpio from gpio "
-                << "group with label " << label << ". Gpio ID: " << gpioId << std::endl;
-        return RETURN_FAILED;
-
-    }
-    std::string failOutput = "label: " + label;
-    return configureRegularGpio(gpioId, chip, gpioByLabel, failOutput);
-}
-
-ReturnValue_t LinuxLibgpioIF::configureGpioByChip(gpioId_t gpioId,
-        GpiodRegularByChip &gpioByChip) {
-    std::string& chipname = gpioByChip.chipname;
-    struct gpiod_chip* chip = gpiod_chip_open_by_name(chipname.c_str());
-    if (chip == nullptr) {
-        sif::warning << "LinuxLibgpioIF::configureGpioByChip: Failed to open chip "
-                << chipname << ". Gpio ID: " << gpioId << std::endl;
-        return RETURN_FAILED;
-    }
-    std::string failOutput = "chipname: " + chipname;
-    return configureRegularGpio(gpioId, chip, gpioByChip, failOutput);
-}
-
-ReturnValue_t LinuxLibgpioIF::configureGpioByLineName(gpioId_t gpioId,
-        GpiodRegularByLineName &gpioByLineName) {
-    std::string& lineName = gpioByLineName.lineName;
-    char chipname[MAX_CHIPNAME_LENGTH];
-    unsigned int lineOffset;
-
-    int result = gpiod_ctxless_find_line(lineName.c_str(), chipname, MAX_CHIPNAME_LENGTH,
-            &lineOffset);
-    if (result != LINE_FOUND) {
-        parseFindeLineResult(result, lineName);
-        return RETURN_FAILED;
-    }
-
-    gpioByLineName.lineNum = static_cast<int>(lineOffset);
-
-    struct gpiod_chip* chip = gpiod_chip_open_by_name(chipname);
-    if (chip == nullptr) {
-        sif::warning << "LinuxLibgpioIF::configureGpioByLineName: Failed to open chip "
-                << chipname << ". <Gpio ID: " << gpioId << std::endl;
-        return RETURN_FAILED;
-    }
-    std::string failOutput = "line name: " + lineName;
-    return configureRegularGpio(gpioId, chip, gpioByLineName, failOutput);
-}
-
-ReturnValue_t LinuxLibgpioIF::configureRegularGpio(gpioId_t gpioId, struct gpiod_chip* chip,
-        GpiodRegularBase& regularGpio, std::string failOutput) {
-    unsigned int lineNum;
-    gpio::Direction direction;
-    std::string consumer;
-    struct gpiod_line *lineHandle;
-    int result = 0;
-
-    lineNum = regularGpio.lineNum;
-    lineHandle = gpiod_chip_get_line(chip, lineNum);
-    if (!lineHandle) {
-        sif::warning << "LinuxLibgpioIF::configureRegularGpio: Failed to open line " << std::endl;
-        sif::warning << "GPIO ID: " << gpioId << ", line number: " << lineNum <<
-                ", " << failOutput << std::endl;
-        sif::warning << "Check if Linux GPIO configuration has changed. " << std::endl;
-        gpiod_chip_close(chip);
-        return RETURN_FAILED;
-    }
-
-    direction = regularGpio.direction;
-    consumer = regularGpio.consumer;
-    /* Configure direction and add a description to the GPIO */
-    switch (direction) {
-    case(gpio::OUT): {
-        result = gpiod_line_request_output(lineHandle, consumer.c_str(),
-                regularGpio.initValue);
-        break;
-    }
-    case(gpio::IN): {
-        result = gpiod_line_request_input(lineHandle, consumer.c_str());
-        break;
-    }
-    default: {
-        sif::error << "LinuxLibgpioIF::configureGpios: Invalid direction specified"
-                << std::endl;
-        return GPIO_INVALID_INSTANCE;
-    }
-
-    if (result < 0) {
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-        sif::error << "LinuxLibgpioIF::configureRegularGpio: Failed to request line " <<
-                lineNum << " from GPIO instance with ID: " << gpioId << std::endl;
-#else
-        sif::printError("LinuxLibgpioIF::configureRegularGpio: "
-                "Failed to request line %d from GPIO instance with ID: %d\n", lineNum, gpioId);
-#endif
-        gpiod_line_release(lineHandle);
-        return RETURN_FAILED;
-    }
-
-    }
-    /**
-     * Write line handle to GPIO configuration instance so it can later be used to set or
-     * read states of GPIOs.
-     */
-    regularGpio.lineHandle = lineHandle;
-    return RETURN_OK;
-}
-
-ReturnValue_t LinuxLibgpioIF::pullHigh(gpioId_t gpioId) {
-    gpioMapIter = gpioMap.find(gpioId);
-    if (gpioMapIter == gpioMap.end()) {
-        sif::warning << "LinuxLibgpioIF::pullHigh: Unknown GPIO ID " << gpioId << std::endl;
-        return UNKNOWN_GPIO_ID;
-    }
-
-    auto gpioType = gpioMapIter->second->gpioType;
-    if (gpioType == gpio::GpioTypes::GPIO_REGULAR_BY_CHIP
-            or gpioType == gpio::GpioTypes::GPIO_REGULAR_BY_LABEL
-            or gpioType == gpio::GpioTypes::GPIO_REGULAR_BY_LINE_NAME) {
-        auto regularGpio = dynamic_cast<GpiodRegularBase*>(gpioMapIter->second);
-        if(regularGpio == nullptr) {
-            return GPIO_TYPE_FAILURE;
-        }
-        return driveGpio(gpioId, *regularGpio, gpio::HIGH);
-    }
-    else {
-        auto gpioCallback = dynamic_cast<GpioCallback*>(gpioMapIter->second);
-        if(gpioCallback->callback == nullptr) {
-            return GPIO_INVALID_INSTANCE;
-        }
-        gpioCallback->callback(gpioMapIter->first, gpio::GpioOperation::WRITE,
-                gpio::Levels::HIGH, gpioCallback->callbackArgs);
-        return RETURN_OK;
-    }
-    return GPIO_TYPE_FAILURE;
-}
-
-ReturnValue_t LinuxLibgpioIF::pullLow(gpioId_t gpioId) {
-    gpioMapIter = gpioMap.find(gpioId);
-    if (gpioMapIter == gpioMap.end()) {
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-        sif::warning << "LinuxLibgpioIF::pullLow: Unknown GPIO ID " << gpioId << std::endl;
-#else
-        sif::printWarning("LinuxLibgpioIF::pullLow: Unknown GPIO ID %d\n", gpioId);
-#endif
-        return UNKNOWN_GPIO_ID;
-    }
-
-    auto& gpioType = gpioMapIter->second->gpioType;
-    if (gpioType == gpio::GpioTypes::GPIO_REGULAR_BY_CHIP
-            or gpioType == gpio::GpioTypes::GPIO_REGULAR_BY_LABEL
-            or gpioType == gpio::GpioTypes::GPIO_REGULAR_BY_LINE_NAME) {
-        auto regularGpio = dynamic_cast<GpiodRegularBase*>(gpioMapIter->second);
-        if(regularGpio == nullptr) {
-            return GPIO_TYPE_FAILURE;
-        }
-        return driveGpio(gpioId, *regularGpio, gpio::LOW);
-    }
-    else {
-        auto gpioCallback = dynamic_cast<GpioCallback*>(gpioMapIter->second);
-        if(gpioCallback->callback == nullptr) {
-            return GPIO_INVALID_INSTANCE;
-        }
-        gpioCallback->callback(gpioMapIter->first, gpio::GpioOperation::WRITE,
-                gpio::Levels::LOW, gpioCallback->callbackArgs);
-        return RETURN_OK;
-    }
-    return GPIO_TYPE_FAILURE;
-}
-
-ReturnValue_t LinuxLibgpioIF::driveGpio(gpioId_t gpioId,
-        GpiodRegularBase& regularGpio, gpio::Levels logicLevel) {
-    int result = gpiod_line_set_value(regularGpio.lineHandle, logicLevel);
-    if (result < 0) {
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-        sif::warning << "LinuxLibgpioIF::driveGpio: Failed to pull GPIO with ID " << gpioId <<
-                " to logic level " << logicLevel << std::endl;
-#else
-        sif::printWarning("LinuxLibgpioIF::driveGpio: Failed to pull GPIO with ID %d to "
-                "logic level %d\n", gpioId, logicLevel);
-#endif
-        return DRIVE_GPIO_FAILURE;
-    }
-
-    return RETURN_OK;
-}
-
-ReturnValue_t LinuxLibgpioIF::readGpio(gpioId_t gpioId, int* gpioState) {
-    gpioMapIter = gpioMap.find(gpioId);
-    if (gpioMapIter == gpioMap.end()){
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-        sif::warning << "LinuxLibgpioIF::readGpio: Unknown GPIOD ID " << gpioId << std::endl;
-#else
-        sif::printWarning("LinuxLibgpioIF::readGpio: Unknown GPIOD ID %d\n", gpioId);
-#endif
-        return UNKNOWN_GPIO_ID;
-    }
-
-    auto gpioType = gpioMapIter->second->gpioType;
-    if (gpioType == gpio::GpioTypes::GPIO_REGULAR_BY_CHIP
-            or gpioType == gpio::GpioTypes::GPIO_REGULAR_BY_LABEL
-            or gpioType == gpio::GpioTypes::GPIO_REGULAR_BY_LINE_NAME) {
-        auto regularGpio = dynamic_cast<GpiodRegularBase*>(gpioMapIter->second);
-        if(regularGpio == nullptr) {
-            return GPIO_TYPE_FAILURE;
-        }
-        *gpioState = gpiod_line_get_value(regularGpio->lineHandle);
-    }
-    else {
-        auto gpioCallback = dynamic_cast<GpioCallback*>(gpioMapIter->second);
-        if(gpioCallback->callback == nullptr) {
-            return GPIO_INVALID_INSTANCE;
-        }
-        gpioCallback->callback(gpioMapIter->first, gpio::GpioOperation::READ,
-                gpio::Levels::NONE, gpioCallback->callbackArgs);
-        return RETURN_OK;
-    }
-    return RETURN_OK;
-}
-
-ReturnValue_t LinuxLibgpioIF::checkForConflicts(GpioMap& mapToAdd){
-    ReturnValue_t status = HasReturnvaluesIF::RETURN_OK;
-    ReturnValue_t result = HasReturnvaluesIF::RETURN_OK;
-    for(auto& gpioConfig: mapToAdd) {
-        switch(gpioConfig.second->gpioType) {
-        case(gpio::GpioTypes::GPIO_REGULAR_BY_CHIP):
-        case(gpio::GpioTypes::GPIO_REGULAR_BY_LABEL):
-        case(gpio::GpioTypes::GPIO_REGULAR_BY_LINE_NAME): {
-            auto regularGpio = dynamic_cast<GpiodRegularBase*>(gpioConfig.second);
-            if(regularGpio == nullptr)  {
-                return GPIO_TYPE_FAILURE;
-            }
-            // Check for conflicts and remove duplicates if necessary
-            result = checkForConflictsById(gpioConfig.first, gpioConfig.second->gpioType, mapToAdd);
-            if(result != HasReturnvaluesIF::RETURN_OK) {
-                status = result;
-            }
-            break;
-        }
-        case(gpio::GpioTypes::CALLBACK): {
-            auto callbackGpio = dynamic_cast<GpioCallback*>(gpioConfig.second);
-            if(callbackGpio == nullptr)  {
-                return GPIO_TYPE_FAILURE;
-            }
-            // Check for conflicts and remove duplicates if necessary
-            result = checkForConflictsById(gpioConfig.first,
-                    gpioConfig.second->gpioType, mapToAdd);
-            if(result != HasReturnvaluesIF::RETURN_OK) {
-                status = result;
-            }
-            break;
-        }
-        default: {
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-            sif::warning << "Invalid GPIO type detected for GPIO ID " << gpioConfig.first
-                    << std::endl;
-#else
-            sif::printWarning("Invalid GPIO type detected for GPIO ID %d\n", gpioConfig.first);
-#endif
-            status = GPIO_TYPE_FAILURE;
-        }
-        }
-    }
-    return status;
-}
-
-ReturnValue_t LinuxLibgpioIF::checkForConflictsById(gpioId_t gpioIdToCheck,
-        gpio::GpioTypes expectedType, GpioMap& mapToAdd) {
-    // Cross check with private map
-    gpioMapIter = gpioMap.find(gpioIdToCheck);
-    if(gpioMapIter != gpioMap.end()) {
-        auto& gpioType = gpioMapIter->second->gpioType;
-        bool eraseDuplicateDifferentType = false;
-        switch(expectedType) {
-        case(gpio::GpioTypes::NONE): {
-            break;
-        }
-        case(gpio::GpioTypes::GPIO_REGULAR_BY_CHIP):
-        case(gpio::GpioTypes::GPIO_REGULAR_BY_LABEL):
-        case(gpio::GpioTypes::GPIO_REGULAR_BY_LINE_NAME): {
-            if(gpioType == gpio::GpioTypes::NONE or gpioType == gpio::GpioTypes::CALLBACK) {
-                eraseDuplicateDifferentType = true;
-            }
-            break;
-        }
-        case(gpio::GpioTypes::CALLBACK): {
-            if(gpioType != gpio::GpioTypes::CALLBACK) {
-                eraseDuplicateDifferentType = true;
-            }
-        }
-        }
-        if(eraseDuplicateDifferentType) {
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-            sif::warning << "LinuxLibgpioIF::checkForConflicts: ID already exists for "
-                    "different GPIO type " << gpioIdToCheck <<
-                    ". Removing duplicate from map to add" << std::endl;
-#else
-            sif::printWarning("LinuxLibgpioIF::checkForConflicts: ID already exists for "
-                    "different GPIO type %d. Removing duplicate from map to add\n", gpioIdToCheck);
-#endif
-            mapToAdd.erase(gpioIdToCheck);
-            return GPIO_DUPLICATE_DETECTED;
-        }
-
-        // Remove element from map to add because a entry for this GPIO already exists
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-        sif::warning << "LinuxLibgpioIF::checkForConflictsRegularGpio: Duplicate GPIO "
-                "definition with ID " << gpioIdToCheck << " detected. " <<
-                "Duplicate will be removed from map to add" << std::endl;
-#else
-        sif::printWarning("LinuxLibgpioIF::checkForConflictsRegularGpio: Duplicate GPIO definition "
-                "with ID %d detected. Duplicate will be removed from map to add\n", gpioIdToCheck);
-#endif
-        mapToAdd.erase(gpioIdToCheck);
-        return GPIO_DUPLICATE_DETECTED;
-    }
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-void LinuxLibgpioIF::parseFindeLineResult(int result, std::string& lineName) {
-    switch (result) {
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-    case LINE_NOT_EXISTS:
-    case LINE_ERROR: {
-        sif::warning << "LinuxLibgpioIF::parseFindeLineResult: Line with name " << lineName <<
-                " does not exist" << std::endl;
-        break;
-    }
-    default: {
-        sif::warning << "LinuxLibgpioIF::parseFindeLineResult: Unknown return code for line "
-                "with name " << lineName << std::endl;
-        break;
-    }
-#else
-    case LINE_NOT_EXISTS:
-    case LINE_ERROR: {
-        sif::printWarning("LinuxLibgpioIF::parseFindeLineResult: Line with name %s "
-                "does not exist\n", lineName);
-        break;
-    }
-    default: {
-        sif::printWarning("LinuxLibgpioIF::parseFindeLineResult: Unknown return code for line "
-                "with name %s\n", lineName);
-        break;
-    }
-#endif
-    }
-
-}

hal/src/fsfw_hal/linux/gpio/LinuxLibgpioIF.h

@@ -1,91 +0,0 @@
-#ifndef LINUX_GPIO_LINUXLIBGPIOIF_H_
-#define LINUX_GPIO_LINUXLIBGPIOIF_H_
-
-#include "fsfw/returnvalues/FwClassIds.h"
-#include "fsfw_hal/common/gpio/GpioIF.h"
-#include "fsfw/objectmanager/SystemObject.h"
-
-class GpioCookie;
-class GpiodRegularIF;
-
-/**
- * @brief	This class implements the GpioIF for a linux based system.
- * @details
- * This implementation is based on the libgpiod lib which requires Linux 4.8 or higher.
- * @note
- * The Petalinux SDK from Xilinx supports libgpiod since Petalinux 2019.1.
- */
-class LinuxLibgpioIF : public GpioIF, public SystemObject {
-public:
-
-    static const uint8_t gpioRetvalId = CLASS_ID::HAL_GPIO;
-
-    static constexpr ReturnValue_t UNKNOWN_GPIO_ID =
-            HasReturnvaluesIF::makeReturnCode(gpioRetvalId, 1);
-    static constexpr ReturnValue_t DRIVE_GPIO_FAILURE =
-            HasReturnvaluesIF::makeReturnCode(gpioRetvalId, 2);
-    static constexpr ReturnValue_t GPIO_TYPE_FAILURE =
-            HasReturnvaluesIF::makeReturnCode(gpioRetvalId, 3);
-    static constexpr ReturnValue_t GPIO_INVALID_INSTANCE =
-            HasReturnvaluesIF::makeReturnCode(gpioRetvalId, 4);
-    static constexpr ReturnValue_t GPIO_DUPLICATE_DETECTED =
-            HasReturnvaluesIF::makeReturnCode(gpioRetvalId, 5);
-
-	LinuxLibgpioIF(object_id_t objectId);
-	virtual ~LinuxLibgpioIF();
-
-	ReturnValue_t addGpios(GpioCookie* gpioCookie) override;
-	ReturnValue_t pullHigh(gpioId_t gpioId) override;
-	ReturnValue_t pullLow(gpioId_t gpioId) override;
-	ReturnValue_t readGpio(gpioId_t gpioId, int* gpioState) override;
-
-private:
-
-	static const size_t MAX_CHIPNAME_LENGTH = 11;
-	static const int LINE_NOT_EXISTS = 0;
-	static const int LINE_ERROR = -1;
-	static const int LINE_FOUND = 1;
-
-	// Holds the information and configuration of all used GPIOs
-	GpioUnorderedMap gpioMap;
-	GpioUnorderedMapIter gpioMapIter;
-
-	/**
-	 * @brief	This functions drives line of a GPIO specified by the GPIO ID.
-	 *
-	 * @param gpioId	The GPIO ID of the GPIO to drive.
-	 * @param logiclevel	The logic level to set. O or 1.
-	 */
-	ReturnValue_t driveGpio(gpioId_t gpioId, GpiodRegularBase& regularGpio,
-	        gpio::Levels logicLevel);
-
-	ReturnValue_t configureGpioByLabel(gpioId_t gpioId, GpiodRegularByLabel& gpioByLabel);
-	ReturnValue_t configureGpioByChip(gpioId_t gpioId, GpiodRegularByChip& gpioByChip);
-    ReturnValue_t configureGpioByLineName(gpioId_t gpioId,
-            GpiodRegularByLineName &gpioByLineName);
-    ReturnValue_t configureRegularGpio(gpioId_t gpioId, struct gpiod_chip* chip,
-            GpiodRegularBase& regularGpio, std::string failOutput);
-
-	/**
-	 * @brief	This function checks if GPIOs are already registered and whether
-	 * 			there exists a conflict in the GPIO configuration. E.g. the
-	 * 			direction.
-	 *
-	 * @param mapToAdd	The GPIOs which shall be added to the gpioMap.
-	 *
-	 * @return	RETURN_OK if successful, otherwise RETURN_FAILED
-	 */
-	ReturnValue_t checkForConflicts(GpioMap& mapToAdd);
-
-	ReturnValue_t checkForConflictsById(gpioId_t gpiodId, gpio::GpioTypes type,
-	        GpioMap& mapToAdd);
-
-	/**
-	 * @brief   Performs the initial configuration of all GPIOs specified in the GpioMap mapToAdd.
-	 */
-	ReturnValue_t configureGpios(GpioMap& mapToAdd);
-
-	void parseFindeLineResult(int result, std::string& lineName);
-};
-
-#endif /* LINUX_GPIO_LINUXLIBGPIOIF_H_ */

hal/src/fsfw_hal/linux/i2c/I2cComIF.cpp

@@ -1,205 +0,0 @@
-#include "fsfw_hal/linux/i2c/I2cComIF.h"
-#include "fsfw_hal/linux/utility.h"
-#include "fsfw_hal/linux/UnixFileGuard.h"
-
-#include "fsfw/serviceinterface/ServiceInterface.h"
-
-#include <unistd.h>
-#include <fcntl.h>
-#include <sys/ioctl.h>
-#include <linux/i2c-dev.h>
-#include <errno.h>
-
-#include <cstring>
-
-
-I2cComIF::I2cComIF(object_id_t objectId): SystemObject(objectId){
-}
-
-I2cComIF::~I2cComIF() {}
-
-ReturnValue_t I2cComIF::initializeInterface(CookieIF* cookie) {
-
-    address_t i2cAddress;
-    std::string deviceFile;
-
-    if(cookie == nullptr) {
-        sif::error << "I2cComIF::initializeInterface: Invalid cookie!" << std::endl;
-        return NULLPOINTER;
-    }
-    I2cCookie* i2cCookie = dynamic_cast<I2cCookie*>(cookie);
-    if(i2cCookie == nullptr) {
-        sif::error << "I2cComIF::initializeInterface: Invalid I2C cookie!" << std::endl;
-        return NULLPOINTER;
-    }
-
-    i2cAddress = i2cCookie->getAddress();
-
-    i2cDeviceMapIter = i2cDeviceMap.find(i2cAddress);
-    if(i2cDeviceMapIter == i2cDeviceMap.end()) {
-        size_t maxReplyLen = i2cCookie->getMaxReplyLen();
-        I2cInstance i2cInstance = {std::vector<uint8_t>(maxReplyLen), 0};
-        auto statusPair = i2cDeviceMap.emplace(i2cAddress, i2cInstance);
-        if (not statusPair.second) {
-            sif::error << "I2cComIF::initializeInterface: Failed to insert device with address " <<
-                    i2cAddress << "to I2C device " << "map" << std::endl;
-            return HasReturnvaluesIF::RETURN_FAILED;
-        }
-        return HasReturnvaluesIF::RETURN_OK;
-    }
-
-    sif::error << "I2cComIF::initializeInterface: Device with address " << i2cAddress <<
-            "already in use" << std::endl;
-    return HasReturnvaluesIF::RETURN_FAILED;
-}
-
-ReturnValue_t I2cComIF::sendMessage(CookieIF *cookie,
-        const uint8_t *sendData, size_t sendLen) {
-
-    ReturnValue_t result;
-    int fd;
-    std::string deviceFile;
-
-    if(sendData == nullptr) {
-        sif::error << "I2cComIF::sendMessage: Send Data is nullptr"
-                << std::endl;
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-
-    if(sendLen == 0) {
-        return HasReturnvaluesIF::RETURN_OK;
-    }
-
-    I2cCookie* i2cCookie = dynamic_cast<I2cCookie*>(cookie);
-    if(i2cCookie == nullptr) {
-        sif::error << "I2cComIF::sendMessage: Invalid I2C Cookie!" << std::endl;
-        return NULLPOINTER;
-    }
-
-    address_t i2cAddress = i2cCookie->getAddress();
-    i2cDeviceMapIter = i2cDeviceMap.find(i2cAddress);
-    if (i2cDeviceMapIter == i2cDeviceMap.end()) {
-        sif::error << "I2cComIF::sendMessage: i2cAddress of Cookie not "
-                << "registered in i2cDeviceMap" << std::endl;
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-
-    deviceFile = i2cCookie->getDeviceFile();
-    UnixFileGuard fileHelper(deviceFile, &fd, O_RDWR, "I2cComIF::sendMessage");
-    if(fileHelper.getOpenResult() != HasReturnvaluesIF::RETURN_OK) {
-        return fileHelper.getOpenResult();
-    }
-    result = openDevice(deviceFile, i2cAddress, &fd);
-    if (result != HasReturnvaluesIF::RETURN_OK){
-        return result;
-    }
-
-    if (write(fd, sendData, sendLen) != (int)sendLen) {
-        sif::error << "I2cComIF::sendMessage: Failed to send data to I2C "
-                "device with error code " << errno << ". Error description: "
-                << strerror(errno) << std::endl;
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t I2cComIF::getSendSuccess(CookieIF *cookie) {
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t I2cComIF::requestReceiveMessage(CookieIF *cookie,
-        size_t requestLen) {
-    ReturnValue_t result;
-    int fd;
-    std::string deviceFile;
-
-    if (requestLen == 0) {
-        return HasReturnvaluesIF::RETURN_OK;
-    }
-
-    I2cCookie* i2cCookie = dynamic_cast<I2cCookie*>(cookie);
-    if(i2cCookie == nullptr) {
-        sif::error << "I2cComIF::requestReceiveMessage: Invalid I2C Cookie!" << std::endl;
-        i2cDeviceMapIter->second.replyLen = 0;
-        return NULLPOINTER;
-    }
-
-    address_t i2cAddress = i2cCookie->getAddress();
-    i2cDeviceMapIter = i2cDeviceMap.find(i2cAddress);
-    if (i2cDeviceMapIter == i2cDeviceMap.end()) {
-        sif::error << "I2cComIF::requestReceiveMessage: i2cAddress of Cookie not "
-                << "registered in i2cDeviceMap" << std::endl;
-        i2cDeviceMapIter->second.replyLen = 0;
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-
-    deviceFile = i2cCookie->getDeviceFile();
-    UnixFileGuard fileHelper(deviceFile, &fd, O_RDWR, "I2cComIF::requestReceiveMessage");
-    if(fileHelper.getOpenResult() != HasReturnvaluesIF::RETURN_OK) {
-        return fileHelper.getOpenResult();
-    }
-    result = openDevice(deviceFile, i2cAddress, &fd);
-    if (result != HasReturnvaluesIF::RETURN_OK){
-        i2cDeviceMapIter->second.replyLen = 0;
-        return result;
-    }
-
-    uint8_t* replyBuffer = i2cDeviceMapIter->second.replyBuffer.data();
-
-    int readLen = read(fd, replyBuffer, requestLen);
-    if (readLen != static_cast<int>(requestLen)) {
-#if FSFW_VERBOSE_LEVEL >= 1 and FSFW_CPP_OSTREAM_ENABLED == 1
-        sif::error << "I2cComIF::requestReceiveMessage: Reading from I2C "
-                << "device failed with error code " << errno <<". Description"
-                << " of error: " << strerror(errno) << std::endl;
-        sif::error << "I2cComIF::requestReceiveMessage: Read only " << readLen << " from "
-                << requestLen << " bytes" << std::endl;
-#endif
-        i2cDeviceMapIter->second.replyLen = 0;
-        sif::debug << "I2cComIF::requestReceiveMessage: Read "  << readLen << " of " << requestLen << " bytes" << std::endl;
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-
-    i2cDeviceMapIter->second.replyLen = requestLen;
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t I2cComIF::readReceivedMessage(CookieIF *cookie,
-        uint8_t **buffer, size_t* size) {
-    I2cCookie* i2cCookie = dynamic_cast<I2cCookie*>(cookie);
-    if(i2cCookie == nullptr) {
-        sif::error << "I2cComIF::readReceivedMessage: Invalid I2C Cookie!" << std::endl;
-        return NULLPOINTER;
-    }
-
-    address_t i2cAddress = i2cCookie->getAddress();
-    i2cDeviceMapIter = i2cDeviceMap.find(i2cAddress);
-    if (i2cDeviceMapIter == i2cDeviceMap.end()) {
-        sif::error << "I2cComIF::readReceivedMessage: i2cAddress of Cookie not "
-                << "found in i2cDeviceMap" << std::endl;
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    *buffer = i2cDeviceMapIter->second.replyBuffer.data();
-    *size = i2cDeviceMapIter->second.replyLen;
-
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t I2cComIF::openDevice(std::string deviceFile,
-        address_t i2cAddress, int* fileDescriptor) {
-
-    if (ioctl(*fileDescriptor, I2C_SLAVE, i2cAddress) < 0) {
-#if FSFW_VERBOSE_LEVEL >= 1
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-        sif::warning << "I2cComIF: Specifying target device failed with error code " << errno << "."
-                << std::endl;
-        sif::warning << "Error description " << strerror(errno) << std::endl;
-#else
-        sif::printWarning("I2cComIF: Specifying target device failed with error code %d.\n");
-        sif::printWarning("Error description: %s\n", strerror(errno));
-#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
-#endif /* FSFW_VERBOSE_LEVEL >= 1 */
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    return HasReturnvaluesIF::RETURN_OK;
-}

hal/src/fsfw_hal/linux/i2c/I2cComIF.h

@@ -1,61 +0,0 @@
-#ifndef LINUX_I2C_I2COMIF_H_
-#define LINUX_I2C_I2COMIF_H_
-
-#include "I2cCookie.h"
-#include <fsfw/objectmanager/SystemObject.h>
-#include <fsfw/devicehandlers/DeviceCommunicationIF.h>
-
-#include <unordered_map>
-#include <vector>
-
-/**
- * @brief 	This is the communication interface for I2C devices connected
- * 			to a system running a Linux OS.
- *
- * @note    The Xilinx Linux kernel might not support to read more than 255 bytes at once.
- *
- * @author 	J. Meier
- */
-class I2cComIF: public DeviceCommunicationIF, public SystemObject {
-public:
-	I2cComIF(object_id_t objectId);
-
-	virtual ~I2cComIF();
-
-	ReturnValue_t initializeInterface(CookieIF * cookie) override;
-	ReturnValue_t sendMessage(CookieIF *cookie,const uint8_t *sendData,
-			size_t sendLen) override;
-	ReturnValue_t getSendSuccess(CookieIF *cookie) override;
-	ReturnValue_t requestReceiveMessage(CookieIF *cookie,
-	        size_t requestLen) override;
-	ReturnValue_t readReceivedMessage(CookieIF *cookie, uint8_t **buffer,
-			size_t *size) override;
-
-private:
-
-	struct I2cInstance {
-		std::vector<uint8_t> replyBuffer;
-		size_t replyLen;
-	};
-
-	using I2cDeviceMap = std::unordered_map<address_t, I2cInstance>;
-	using I2cDeviceMapIter = I2cDeviceMap::iterator;
-
-	/* In this map all i2c devices will be registered with their address and
-	 * the appropriate file descriptor will be stored */
-	I2cDeviceMap i2cDeviceMap;
-	I2cDeviceMapIter i2cDeviceMapIter;
-
-	/**
-	 * @brief	This function opens an I2C device and binds the opened file
-	 * 			to a specific I2C address.
-	 * @param deviceFile	The name of the device file. E.g. i2c-0
-	 * @param i2cAddress	The address of the i2c slave device.
-	 * @param fileDescriptor	Pointer to device descriptor.
-	 * @return	RETURN_OK if successful, otherwise RETURN_FAILED.
-	 */
-	ReturnValue_t openDevice(std::string deviceFile,
-			address_t i2cAddress, int* fileDescriptor);
-};
-
-#endif /* LINUX_I2C_I2COMIF_H_ */

hal/src/fsfw_hal/linux/i2c/I2cCookie.cpp

@@ -1,20 +0,0 @@
-#include "fsfw_hal/linux/i2c/I2cCookie.h"
-
-I2cCookie::I2cCookie(address_t i2cAddress_, size_t maxReplyLen_,
-		std::string deviceFile_) :
-		i2cAddress(i2cAddress_), maxReplyLen(maxReplyLen_), deviceFile(deviceFile_) {
-}
-
-address_t I2cCookie::getAddress() const {
-	return i2cAddress;
-}
-
-size_t I2cCookie::getMaxReplyLen() const {
-	return maxReplyLen;
-}
-
-std::string I2cCookie::getDeviceFile() const {
-	return deviceFile;
-}
-
-I2cCookie::~I2cCookie() {}

hal/src/fsfw_hal/linux/i2c/I2cCookie.h

@@ -1,38 +0,0 @@
-#ifndef LINUX_I2C_I2CCOOKIE_H_
-#define LINUX_I2C_I2CCOOKIE_H_
-
-#include <fsfw/devicehandlers/CookieIF.h>
-#include <string>
-
-/**
- * @brief   Cookie for the i2cDeviceComIF.
- *
- * @author 	J. Meier
- */
-class I2cCookie: public CookieIF {
-public:
-
-	/**
-	 * @brief	Constructor for the I2C cookie.
-	 * @param i2cAddress_	The i2c address of the target device.
-	 * @param maxReplyLen_	The maximum expected length of a reply from the
-	 * 						target device.
-	 * @param devicFile_    The device file specifying the i2c interface to use. E.g. "/dev/i2c-0".
-	 */
-	I2cCookie(address_t i2cAddress_, size_t maxReplyLen_,
-			std::string deviceFile_);
-
-	virtual ~I2cCookie();
-
-	address_t getAddress() const;
-	size_t getMaxReplyLen() const;
-	std::string getDeviceFile() const;
-
-private:
-
-	address_t i2cAddress = 0;
-	size_t maxReplyLen = 0;
-	std::string deviceFile;
-};
-
-#endif /* LINUX_I2C_I2CCOOKIE_H_ */

hal/src/fsfw_hal/linux/rpi/GpioRPi.cpp

@@ -1,38 +0,0 @@
-#include "fsfw/FSFW.h"
-
-#include "fsfw_hal/linux/rpi/GpioRPi.h"
-#include "fsfw_hal/common/gpio/GpioCookie.h"
-
-#include <fsfw/serviceinterface/ServiceInterface.h>
-
-
-ReturnValue_t gpio::createRpiGpioConfig(GpioCookie* cookie, gpioId_t gpioId, int bcmPin,
-        std::string consumer, gpio::Direction direction, int initValue) {
-    if(cookie == nullptr) {
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-
-    auto config = new GpiodRegularByChip();
-    /* Default chipname for Raspberry Pi. There is still gpiochip1 for expansion, but most users
-    will not need this */
-    config->chipname = "gpiochip0";
-
-    config->consumer = consumer;
-    config->direction = direction;
-    config->initValue = initValue;
-
-    /* Sanity check for the BCM pins before assigning it */
-    if(bcmPin > 27) {
-#if FSFW_VERBOSE_LEVEL >= 1
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-        sif::error << "createRpiGpioConfig: BCM pin " << bcmPin << " invalid!" << std::endl;
-#else
-        sif::printError("createRpiGpioConfig: BCM pin %d invalid!\n", bcmPin);
-#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
-#endif /* FSFW_VERBOSE_LEVEL >= 1 */
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    config->lineNum = bcmPin;
-    cookie->addGpio(gpioId, config);
-    return HasReturnvaluesIF::RETURN_OK;
-}

hal/src/fsfw_hal/linux/spi/SpiComIF.cpp

@@ -1,408 +0,0 @@
-#include "fsfw/FSFW.h"
-#include "fsfw_hal/linux/spi/SpiComIF.h"
-#include "fsfw_hal/linux/spi/SpiCookie.h"
-#include "fsfw_hal/linux/utility.h"
-#include "fsfw_hal/linux/UnixFileGuard.h"
-
-#include <fsfw/ipc/MutexFactory.h>
-#include <fsfw/globalfunctions/arrayprinter.h>
-
-#include <linux/spi/spidev.h>
-#include <fcntl.h>
-#include <unistd.h>
-#include <sys/ioctl.h>
-
-#include <cerrno>
-#include <cstring>
-
-SpiComIF::SpiComIF(object_id_t objectId, GpioIF* gpioComIF):
-        SystemObject(objectId), gpioComIF(gpioComIF) {
-    if(gpioComIF == nullptr) {
-#if FSFW_VERBOSE_LEVEL >= 1
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-        sif::error << "SpiComIF::SpiComIF: GPIO communication interface invalid!" << std::endl;
-#else
-        sif::printError("SpiComIF::SpiComIF: GPIO communication interface invalid!\n");
-#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
-#endif /* FSFW_VERBOSE_LEVEL >= 1 */
-    }
-
-    spiMutex = MutexFactory::instance()->createMutex();
-}
-
-ReturnValue_t SpiComIF::initializeInterface(CookieIF *cookie) {
-    int retval = 0;
-    SpiCookie* spiCookie = dynamic_cast<SpiCookie*>(cookie);
-    if(spiCookie == nullptr) {
-        return NULLPOINTER;
-    }
-
-    address_t spiAddress = spiCookie->getSpiAddress();
-
-    auto iter = spiDeviceMap.find(spiAddress);
-    if(iter == spiDeviceMap.end()) {
-        size_t bufferSize = spiCookie->getMaxBufferSize();
-        SpiInstance spiInstance(bufferSize);
-        auto statusPair = spiDeviceMap.emplace(spiAddress, spiInstance);
-        if (not statusPair.second) {
-#if FSFW_VERBOSE_LEVEL >= 1
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-            sif::error << "SpiComIF::initializeInterface: Failed to insert device with address " <<
-                    spiAddress << "to SPI device map" << std::endl;
-#else
-            sif::printError("SpiComIF::initializeInterface: Failed to insert device with address "
-                    "%lu to SPI device map\n", static_cast<unsigned long>(spiAddress));
-#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
-#endif /* FSFW_VERBOSE_LEVEL >= 1 */
-            return HasReturnvaluesIF::RETURN_FAILED;
-        }
-        /* Now we emplaced the read buffer in the map, we still need to assign that location
-        to the SPI driver transfer struct */
-        spiCookie->assignReadBuffer(statusPair.first->second.replyBuffer.data());
-    }
-    else {
-#if FSFW_VERBOSE_LEVEL >= 1
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-        sif::error << "SpiComIF::initializeInterface: SPI address already exists!" << std::endl;
-#else
-        sif::printError("SpiComIF::initializeInterface: SPI address already exists!\n");
-#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
-#endif /* FSFW_VERBOSE_LEVEL >= 1 */
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-
-    /* Pull CS high in any case to be sure that device is inactive */
-    gpioId_t gpioId = spiCookie->getChipSelectPin();
-    if(gpioId != gpio::NO_GPIO) {
-        gpioComIF->pullHigh(gpioId);
-    }
-
-    uint32_t spiSpeed = 0;
-    spi::SpiModes spiMode = spi::SpiModes::MODE_0;
-
-    SpiCookie::UncommonParameters params;
-    spiCookie->getSpiParameters(spiMode, spiSpeed, &params);
-
-    int fileDescriptor = 0;
-    UnixFileGuard fileHelper(spiCookie->getSpiDevice(), &fileDescriptor, O_RDWR,
-            "SpiComIF::initializeInterface");
-    if(fileHelper.getOpenResult() != HasReturnvaluesIF::RETURN_OK) {
-        return fileHelper.getOpenResult();
-    }
-
-    /* These flags are rather uncommon */
-    if(params.threeWireSpi or params.noCs or params.csHigh) {
-        uint32_t currentMode = 0;
-        retval = ioctl(fileDescriptor, SPI_IOC_RD_MODE32, &currentMode);
-        if(retval != 0) {
-            utility::handleIoctlError("SpiComIF::initialiezInterface: Could not read full mode!");
-        }
-
-        if(params.threeWireSpi) {
-            currentMode |= SPI_3WIRE;
-        }
-        if(params.noCs) {
-            /* Some drivers like the Raspberry Pi ignore this flag in any case */
-            currentMode |= SPI_NO_CS;
-        }
-        if(params.csHigh) {
-            currentMode |= SPI_CS_HIGH;
-        }
-        /* Write adapted mode */
-        retval = ioctl(fileDescriptor, SPI_IOC_WR_MODE32, &currentMode);
-        if(retval != 0) {
-            utility::handleIoctlError("SpiComIF::initialiezInterface: Could not write full mode!");
-        }
-    }
-    if(params.lsbFirst) {
-        retval = ioctl(fileDescriptor, SPI_IOC_WR_LSB_FIRST, &params.lsbFirst);
-        if(retval != 0) {
-            utility::handleIoctlError("SpiComIF::initializeInterface: Setting LSB first failed");
-        }
-    }
-    if(params.bitsPerWord != 8) {
-        retval = ioctl(fileDescriptor, SPI_IOC_WR_BITS_PER_WORD, &params.bitsPerWord);
-        if(retval != 0) {
-            utility::handleIoctlError("SpiComIF::initializeInterface: "
-                    "Could not write bits per word!");
-        }
-    }
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t SpiComIF::sendMessage(CookieIF *cookie, const uint8_t *sendData, size_t sendLen) {
-    SpiCookie* spiCookie = dynamic_cast<SpiCookie*>(cookie);
-    ReturnValue_t result = HasReturnvaluesIF::RETURN_OK;
-
-    if(spiCookie == nullptr) {
-        return NULLPOINTER;
-    }
-
-    if(sendLen > spiCookie->getMaxBufferSize()) {
-#if FSFW_VERBOSE_LEVEL >= 1
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-        sif::warning << "SpiComIF::sendMessage: Too much data sent, send length " << sendLen <<
-                "larger than maximum buffer length " << spiCookie->getMaxBufferSize() << std::endl;
-#else
-        sif::printWarning("SpiComIF::sendMessage: Too much data sent, send length %lu larger "
-                "than maximum buffer length %lu!\n", static_cast<unsigned long>(sendLen),
-                static_cast<unsigned long>(spiCookie->getMaxBufferSize()));
-#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
-#endif /* FSFW_VERBOSE_LEVEL >= 1 */
-        return DeviceCommunicationIF::TOO_MUCH_DATA;
-    }
-
-    if(spiCookie->getComIfMode() == spi::SpiComIfModes::REGULAR) {
-        result = performRegularSendOperation(spiCookie, sendData, sendLen);
-    }
-    else if(spiCookie->getComIfMode() == spi::SpiComIfModes::CALLBACK) {
-        spi::send_callback_function_t sendFunc = nullptr;
-        void* funcArgs = nullptr;
-        spiCookie->getCallback(&sendFunc, &funcArgs);
-        if(sendFunc != nullptr) {
-            result = sendFunc(this, spiCookie, sendData, sendLen, funcArgs);
-        }
-    }
-    return result;
-}
-
-ReturnValue_t SpiComIF::performRegularSendOperation(SpiCookie *spiCookie, const uint8_t *sendData,
-        size_t sendLen) {
-    address_t spiAddress = spiCookie->getSpiAddress();
-    auto iter = spiDeviceMap.find(spiAddress);
-    if(iter != spiDeviceMap.end()) {
-        spiCookie->assignReadBuffer(iter->second.replyBuffer.data());
-    }
-
-    ReturnValue_t result = HasReturnvaluesIF::RETURN_OK;
-    int retval = 0;
-    /* Prepare transfer */
-    int fileDescriptor = 0;
-    std::string device = spiCookie->getSpiDevice();
-    UnixFileGuard fileHelper(device, &fileDescriptor, O_RDWR, "SpiComIF::sendMessage");
-    if(fileHelper.getOpenResult() != HasReturnvaluesIF::RETURN_OK) {
-        return OPENING_FILE_FAILED;
-    }
-    spi::SpiModes spiMode = spi::SpiModes::MODE_0;
-    uint32_t spiSpeed = 0;
-    spiCookie->getSpiParameters(spiMode, spiSpeed, nullptr);
-    setSpiSpeedAndMode(fileDescriptor, spiMode, spiSpeed);
-    spiCookie->assignWriteBuffer(sendData);
-    spiCookie->setTransferSize(sendLen);
-
-    bool fullDuplex = spiCookie->isFullDuplex();
-    gpioId_t gpioId = spiCookie->getChipSelectPin();
-
-    /* Pull SPI CS low. For now, no support for active high given  */
-    if(gpioId != gpio::NO_GPIO) {
-        result = spiMutex->lockMutex(timeoutType, timeoutMs);
-        if (result != RETURN_OK) {
-#if FSFW_VERBOSE_LEVEL >= 1
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-            sif::error << "SpiComIF::sendMessage: Failed to lock mutex" << std::endl;
-#else
-            sif::printError("SpiComIF::sendMessage: Failed to lock mutex\n");
-#endif
-#endif
-            return result;
-        }
-        ReturnValue_t result = gpioComIF->pullLow(gpioId);
-        if(result != HasReturnvaluesIF::RETURN_OK) {
-#if FSFW_VERBOSE_LEVEL >= 1
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-            sif::warning << "SpiComIF::sendMessage: Pulling low CS pin failed" << std::endl;
-#else
-            sif::printWarning("SpiComIF::sendMessage: Pulling low CS pin failed");
-#endif
-#endif
-            return result;
-        }
-    }
-
-    /* Execute transfer */
-    if(fullDuplex) {
-        /* Initiate a full duplex SPI transfer. */
-        retval = ioctl(fileDescriptor, SPI_IOC_MESSAGE(1), spiCookie->getTransferStructHandle());
-        if(retval < 0) {
-            utility::handleIoctlError("SpiComIF::sendMessage: ioctl error.");
-            result = FULL_DUPLEX_TRANSFER_FAILED;
-        }
-#if FSFW_HAL_SPI_WIRETAPPING == 1
-        performSpiWiretapping(spiCookie);
-#endif /* FSFW_LINUX_SPI_WIRETAPPING == 1 */
-    }
-    else {
-        /* We write with a blocking half-duplex transfer here */
-        if (write(fileDescriptor, sendData, sendLen) != static_cast<ssize_t>(sendLen)) {
-#if FSFW_VERBOSE_LEVEL >= 1
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-            sif::warning << "SpiComIF::sendMessage: Half-Duplex write operation failed!" <<
-                    std::endl;
-#else
-            sif::printWarning("SpiComIF::sendMessage: Half-Duplex write operation failed!\n");
-#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
-#endif /* FSFW_VERBOSE_LEVEL >= 1 */
-            result = HALF_DUPLEX_TRANSFER_FAILED;
-        }
-    }
-
-    if(gpioId != gpio::NO_GPIO) {
-        gpioComIF->pullHigh(gpioId);
-        result = spiMutex->unlockMutex();
-        if (result != RETURN_OK) {
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-            sif::error << "SpiComIF::sendMessage: Failed to unlock mutex" << std::endl;
-#endif
-            return result;
-        }
-    }
-    return result;
-}
-
-ReturnValue_t SpiComIF::getSendSuccess(CookieIF *cookie) {
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t SpiComIF::requestReceiveMessage(CookieIF *cookie, size_t requestLen) {
-    SpiCookie* spiCookie = dynamic_cast<SpiCookie*>(cookie);
-    if(spiCookie == nullptr) {
-        return NULLPOINTER;
-    }
-
-    if(spiCookie->isFullDuplex()) {
-        return HasReturnvaluesIF::RETURN_OK;
-    }
-
-    return performHalfDuplexReception(spiCookie);
-}
-
-
-ReturnValue_t SpiComIF::performHalfDuplexReception(SpiCookie* spiCookie) {
-    ReturnValue_t result = HasReturnvaluesIF::RETURN_OK;
-    std::string device = spiCookie->getSpiDevice();
-    int fileDescriptor = 0;
-    UnixFileGuard fileHelper(device, &fileDescriptor, O_RDWR,
-            "SpiComIF::requestReceiveMessage");
-    if(fileHelper.getOpenResult() != HasReturnvaluesIF::RETURN_OK) {
-        return OPENING_FILE_FAILED;
-    }
-
-    uint8_t* rxBuf = nullptr;
-    size_t readSize = spiCookie->getCurrentTransferSize();
-    result = getReadBuffer(spiCookie->getSpiAddress(), &rxBuf);
-    if(result != HasReturnvaluesIF::RETURN_OK) {
-        return result;
-    }
-
-    gpioId_t gpioId = spiCookie->getChipSelectPin();
-    if(gpioId != gpio::NO_GPIO) {
-        result = spiMutex->lockMutex(timeoutType, timeoutMs);
-        if (result != RETURN_OK) {
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-            sif::error << "SpiComIF::getSendSuccess: Failed to lock mutex" << std::endl;
-#endif
-            return result;
-        }
-        gpioComIF->pullLow(gpioId);
-    }
-
-    if(read(fileDescriptor, rxBuf, readSize) != static_cast<ssize_t>(readSize)) {
-#if FSFW_VERBOSE_LEVEL >= 1
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-        sif::warning << "SpiComIF::sendMessage: Half-Duplex read operation failed!" << std::endl;
-#else
-        sif::printWarning("SpiComIF::sendMessage: Half-Duplex read operation failed!\n");
-#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
-#endif /* FSFW_VERBOSE_LEVEL >= 1 */
-        result = HALF_DUPLEX_TRANSFER_FAILED;
-    }
-
-    if(gpioId != gpio::NO_GPIO) {
-        gpioComIF->pullHigh(gpioId);
-        result = spiMutex->unlockMutex();
-        if (result != RETURN_OK) {
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-            sif::error << "SpiComIF::getSendSuccess: Failed to unlock mutex" << std::endl;
-#endif
-            return result;
-        }
-    }
-
-    return result;
-}
-
-ReturnValue_t SpiComIF::readReceivedMessage(CookieIF *cookie, uint8_t **buffer, size_t *size) {
-    SpiCookie* spiCookie = dynamic_cast<SpiCookie*>(cookie);
-    if(spiCookie == nullptr) {
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    uint8_t* rxBuf = nullptr;
-    ReturnValue_t result = getReadBuffer(spiCookie->getSpiAddress(), &rxBuf);
-    if(result != HasReturnvaluesIF::RETURN_OK) {
-        return result;
-    }
-
-    *buffer = rxBuf;
-    *size = spiCookie->getCurrentTransferSize();
-    spiCookie->setTransferSize(0);
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-MutexIF* SpiComIF::getMutex(MutexIF::TimeoutType* timeoutType, uint32_t* timeoutMs) {
-    if(timeoutType != nullptr) {
-        *timeoutType = this->timeoutType;
-    }
-    if(timeoutMs != nullptr) {
-        *timeoutMs = this->timeoutMs;
-    }
-    return spiMutex;
-}
-
-void SpiComIF::performSpiWiretapping(SpiCookie* spiCookie) {
-    if(spiCookie == nullptr) {
-        return;
-    }
-    size_t dataLen = spiCookie->getTransferStructHandle()->len;
-    uint8_t* dataPtr = reinterpret_cast<uint8_t*>(spiCookie->getTransferStructHandle()->tx_buf);
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-    sif::info << "Sent SPI data: " << std::endl;
-    arrayprinter::print(dataPtr, dataLen, OutputType::HEX, false);
-    sif::info << "Received SPI data: " << std::endl;
-#else
-    sif::printInfo("Sent SPI data: \n");
-    arrayprinter::print(dataPtr, dataLen, OutputType::HEX, false);
-    sif::printInfo("Received SPI data: \n");
-#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
-    dataPtr = reinterpret_cast<uint8_t*>(spiCookie->getTransferStructHandle()->rx_buf);
-    arrayprinter::print(dataPtr, dataLen, OutputType::HEX, false);
-}
-
-ReturnValue_t SpiComIF::getReadBuffer(address_t spiAddress, uint8_t** buffer) {
-    if(buffer == nullptr) {
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-
-    auto iter = spiDeviceMap.find(spiAddress);
-    if(iter == spiDeviceMap.end()) {
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-
-    *buffer = iter->second.replyBuffer.data();
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-GpioIF* SpiComIF::getGpioInterface() {
-    return gpioComIF;
-}
-
-void SpiComIF::setSpiSpeedAndMode(int spiFd, spi::SpiModes mode, uint32_t speed) {
-    int retval = ioctl(spiFd, SPI_IOC_WR_MODE, reinterpret_cast<uint8_t*>(&mode));
-    if(retval != 0) {
-        utility::handleIoctlError("SpiComIF::setSpiSpeedAndMode: Setting SPI mode failed");
-    }
-
-    retval = ioctl(spiFd, SPI_IOC_WR_MAX_SPEED_HZ, &speed);
-    if(retval != 0) {
-        utility::handleIoctlError("SpiComIF::setSpiSpeedAndMode: Setting SPI speed failed");
-    }
-}

hal/src/fsfw_hal/linux/spi/SpiComIF.h

@@ -1,91 +0,0 @@
-#ifndef LINUX_SPI_SPICOMIF_H_
-#define LINUX_SPI_SPICOMIF_H_
-
-#include "fsfw/FSFW.h"
-#include "spiDefinitions.h"
-#include "returnvalues/classIds.h"
-#include "fsfw_hal/common/gpio/GpioIF.h"
-
-#include "fsfw/devicehandlers/DeviceCommunicationIF.h"
-#include "fsfw/objectmanager/SystemObject.h"
-
-#include <vector>
-#include <unordered_map>
-
-class SpiCookie;
-
-/**
- * @brief   Encapsulates access to linux SPI driver for FSFW objects
- * @details
- * Right now, only full-duplex SPI is supported. Most device specific transfer properties
- * are contained in the SPI cookie.
- * @author  R. Mueller
- */
-class SpiComIF: public DeviceCommunicationIF, public SystemObject {
-public:
-    static constexpr uint8_t spiRetvalId = CLASS_ID::HAL_SPI;
-    static constexpr ReturnValue_t OPENING_FILE_FAILED =
-            HasReturnvaluesIF::makeReturnCode(spiRetvalId, 0);
-    /* Full duplex (ioctl) transfer failure */
-    static constexpr ReturnValue_t FULL_DUPLEX_TRANSFER_FAILED =
-            HasReturnvaluesIF::makeReturnCode(spiRetvalId, 1);
-    /* Half duplex (read/write) transfer failure */
-    static constexpr ReturnValue_t HALF_DUPLEX_TRANSFER_FAILED =
-            HasReturnvaluesIF::makeReturnCode(spiRetvalId, 2);
-
-    SpiComIF(object_id_t objectId, GpioIF* gpioComIF);
-
-    ReturnValue_t initializeInterface(CookieIF * cookie) override;
-    ReturnValue_t sendMessage(CookieIF *cookie,const uint8_t *sendData,
-            size_t sendLen) override;
-    ReturnValue_t getSendSuccess(CookieIF *cookie) override;
-    ReturnValue_t requestReceiveMessage(CookieIF *cookie,
-            size_t requestLen) override;
-    ReturnValue_t readReceivedMessage(CookieIF *cookie, uint8_t **buffer,
-            size_t *size) override;
-
-    /**
-     * @brief   This function returns the mutex which can be used to protect the spi bus when
-     *          the chip select must be driven from outside of the com if.
-     */
-    MutexIF* getMutex(MutexIF::TimeoutType* timeoutType = nullptr, uint32_t* timeoutMs = nullptr);
-
-    /**
-     * Perform a regular send operation using Linux iotcl. This is public so it can be used
-     * in functions like a user callback if special handling is only necessary for certain commands.
-     * @param spiCookie
-     * @param sendData
-     * @param sendLen
-     * @return
-     */
-    ReturnValue_t performRegularSendOperation(SpiCookie* spiCookie, const uint8_t *sendData,
-            size_t sendLen);
-
-    GpioIF* getGpioInterface();
-    void setSpiSpeedAndMode(int spiFd, spi::SpiModes mode, uint32_t speed);
-    void performSpiWiretapping(SpiCookie* spiCookie);
-
-    ReturnValue_t getReadBuffer(address_t spiAddress, uint8_t** buffer);
-
-private:
-
-    struct SpiInstance {
-        SpiInstance(size_t maxRecvSize): replyBuffer(std::vector<uint8_t>(maxRecvSize)) {}
-        std::vector<uint8_t> replyBuffer;
-    };
-
-    GpioIF* gpioComIF = nullptr;
-
-    MutexIF* spiMutex = nullptr;
-    MutexIF::TimeoutType timeoutType = MutexIF::TimeoutType::WAITING;
-    uint32_t timeoutMs = 20;
-
-    using SpiDeviceMap = std::unordered_map<address_t, SpiInstance>;
-    using SpiDeviceMapIter = SpiDeviceMap::iterator;
-
-    SpiDeviceMap spiDeviceMap;
-
-    ReturnValue_t performHalfDuplexReception(SpiCookie* spiCookie);
-};
-
-#endif /* LINUX_SPI_SPICOMIF_H_ */

hal/src/fsfw_hal/linux/spi/SpiCookie.cpp

@@ -1,144 +0,0 @@
-#include "fsfw_hal/linux/spi/SpiCookie.h"
-
-SpiCookie::SpiCookie(address_t spiAddress, gpioId_t chipSelect, std::string spiDev,
-        const size_t maxSize, spi::SpiModes spiMode, uint32_t spiSpeed):
-        SpiCookie(spi::SpiComIfModes::REGULAR, spiAddress, chipSelect, spiDev, maxSize, spiMode,
-                spiSpeed, nullptr, nullptr) {
-
-}
-
-SpiCookie::SpiCookie(address_t spiAddress, std::string spiDev, const size_t maxSize,
-        spi::SpiModes spiMode, uint32_t spiSpeed):
-                SpiCookie(spiAddress, gpio::NO_GPIO, spiDev, maxSize, spiMode, spiSpeed) {
-}
-
-SpiCookie::SpiCookie(address_t spiAddress, gpioId_t chipSelect, std::string spiDev,
-        const size_t maxSize, spi::SpiModes spiMode, uint32_t spiSpeed,
-        spi::send_callback_function_t callback, void *args):
-		        SpiCookie(spi::SpiComIfModes::CALLBACK, spiAddress, chipSelect, spiDev, maxSize,
-		                spiMode, spiSpeed, callback, args) {
-}
-
-SpiCookie::SpiCookie(spi::SpiComIfModes comIfMode, address_t spiAddress, gpioId_t chipSelect,
-        std::string spiDev, const size_t maxSize, spi::SpiModes spiMode, uint32_t spiSpeed,
-        spi::send_callback_function_t callback, void* args):
-                spiAddress(spiAddress), chipSelectPin(chipSelect), spiDevice(spiDev),
-                comIfMode(comIfMode), maxSize(maxSize), spiMode(spiMode), spiSpeed(spiSpeed),
-                sendCallback(callback), callbackArgs(args) {
-}
-
-spi::SpiComIfModes SpiCookie::getComIfMode() const {
-    return this->comIfMode;
-}
-
-void SpiCookie::getSpiParameters(spi::SpiModes& spiMode, uint32_t& spiSpeed,
-        UncommonParameters* parameters) const {
-    spiMode = this->spiMode;
-    spiSpeed = this->spiSpeed;
-
-    if(parameters != nullptr) {
-        parameters->threeWireSpi = uncommonParameters.threeWireSpi;
-        parameters->lsbFirst = uncommonParameters.lsbFirst;
-        parameters->noCs = uncommonParameters.noCs;
-        parameters->bitsPerWord = uncommonParameters.bitsPerWord;
-        parameters->csHigh = uncommonParameters.csHigh;
-    }
-}
-
-gpioId_t SpiCookie::getChipSelectPin() const {
-    return chipSelectPin;
-}
-
-size_t SpiCookie::getMaxBufferSize() const {
-    return maxSize;
-}
-
-address_t SpiCookie::getSpiAddress() const {
-    return spiAddress;
-}
-
-std::string SpiCookie::getSpiDevice() const {
-    return spiDevice;
-}
-
-void SpiCookie::setThreeWireSpi(bool enable) {
-    uncommonParameters.threeWireSpi = enable;
-}
-
-void SpiCookie::setLsbFirst(bool enable) {
-    uncommonParameters.lsbFirst = enable;
-}
-
-void SpiCookie::setNoCs(bool enable) {
-    uncommonParameters.noCs = enable;
-}
-
-void SpiCookie::setBitsPerWord(uint8_t bitsPerWord) {
-    uncommonParameters.bitsPerWord = bitsPerWord;
-}
-
-void SpiCookie::setCsHigh(bool enable) {
-    uncommonParameters.csHigh = enable;
-}
-
-void SpiCookie::activateCsDeselect(bool deselectCs, uint16_t delayUsecs) {
-    spiTransferStruct.cs_change = deselectCs;
-    spiTransferStruct.delay_usecs = delayUsecs;
-}
-
-void SpiCookie::assignReadBuffer(uint8_t* rx) {
-    if(rx != nullptr) {
-        spiTransferStruct.rx_buf = reinterpret_cast<__u64>(rx);
-    }
-}
-
-void SpiCookie::assignWriteBuffer(const uint8_t* tx) {
-    if(tx != nullptr) {
-        spiTransferStruct.tx_buf = reinterpret_cast<__u64>(tx);
-    }
-}
-
-void SpiCookie::setCallbackMode(spi::send_callback_function_t callback,
-        void *args) {
-    this->comIfMode = spi::SpiComIfModes::CALLBACK;
-    this->sendCallback = callback;
-    this->callbackArgs = args;
-}
-
-void SpiCookie::setCallbackArgs(void *args) {
-    this->callbackArgs = args;
-}
-
-spi_ioc_transfer* SpiCookie::getTransferStructHandle() {
-    return &spiTransferStruct;
-}
-
-void SpiCookie::setFullOrHalfDuplex(bool halfDuplex) {
-    this->halfDuplex = halfDuplex;
-}
-
-bool SpiCookie::isFullDuplex() const {
-    return not this->halfDuplex;
-}
-
-void SpiCookie::setTransferSize(size_t transferSize) {
-    spiTransferStruct.len = transferSize;
-}
-
-size_t SpiCookie::getCurrentTransferSize() const {
-    return spiTransferStruct.len;
-}
-
-void SpiCookie::setSpiSpeed(uint32_t newSpeed) {
-    this->spiSpeed = newSpeed;
-}
-
-void SpiCookie::setSpiMode(spi::SpiModes newMode) {
-    this->spiMode = newMode;
-}
-
-void SpiCookie::getCallback(spi::send_callback_function_t *callback,
-        void **args) {
-    *callback = this->sendCallback;
-    *args = this->callbackArgs;
-}

hal/src/fsfw_hal/linux/spi/SpiCookie.h

@@ -1,183 +0,0 @@
-#ifndef LINUX_SPI_SPICOOKIE_H_
-#define LINUX_SPI_SPICOOKIE_H_
-
-#include "spiDefinitions.h"
-#include "../../common/gpio/gpioDefinitions.h"
-
-#include <fsfw/devicehandlers/CookieIF.h>
-
-#include <linux/spi/spidev.h>
-
-/**
- * @brief   This cookie class is passed to the SPI communication interface
- * @details
- * This cookie contains device specific properties like speed and SPI mode or the SPI transfer
- * struct required by the Linux SPI driver. It also contains a handle to a GPIO interface
- * to perform slave select switching when necessary.
- *
- * The user can specify gpio::NO_GPIO as the GPIO ID or use a custom send callback to meet
- * special requirements like expander slave select switching (e.g. GPIO or I2C expander)
- * or special timing related requirements.
- */
-class SpiCookie: public CookieIF {
-public:
-    /**
-     * Each SPI device will have a corresponding cookie. The cookie is used by the communication
-     * interface and contains device specific information like the largest expected size to be
-     * sent and received and the GPIO pin used to toggle the SPI slave select pin.
-     * @param spiAddress
-     * @param chipSelect    Chip select. gpio::NO_GPIO can be used for hardware slave selects.
-     * @param spiDev
-     * @param maxSize
-     */
-    SpiCookie(address_t spiAddress, gpioId_t chipSelect, std::string spiDev,
-            const size_t maxSize, spi::SpiModes spiMode, uint32_t spiSpeed);
-
-    /**
-     * Like constructor above, but without a dedicated GPIO CS. Can be used for hardware
-     * slave select or if CS logic is performed with decoders.
-     */
-    SpiCookie(address_t spiAddress, std::string spiDev, const size_t maxReplySize,
-            spi::SpiModes spiMode, uint32_t spiSpeed);
-
-    /**
-     * Use the callback mode of the SPI communication interface. The user can pass the callback
-     * function here or by using the setter function #setCallbackMode
-     */
-    SpiCookie(address_t spiAddress, gpioId_t chipSelect, std::string spiDev, const size_t maxSize,
-            spi::SpiModes spiMode, uint32_t spiSpeed, spi::send_callback_function_t callback,
-            void *args);
-
-    /**
-     * Get the callback function
-     * @param callback
-     * @param args
-     */
-    void getCallback(spi::send_callback_function_t* callback, void** args);
-
-    address_t getSpiAddress() const;
-    std::string getSpiDevice() const;
-    gpioId_t getChipSelectPin() const;
-    size_t getMaxBufferSize() const;
-
-    spi::SpiComIfModes getComIfMode() const;
-
-    /** Enables changing SPI speed at run-time */
-    void setSpiSpeed(uint32_t newSpeed);
-    /** Enables changing the SPI mode at run-time */
-    void setSpiMode(spi::SpiModes newMode);
-
-    /**
-     * Set the SPI to callback mode and assigns the user supplied callback and an argument
-     * passed to the callback.
-     * @param callback
-     * @param args
-     */
-    void setCallbackMode(spi::send_callback_function_t callback, void* args);
-
-    /**
-	 * Can be used to set the callback arguments and a later point than initialization.
-	 * @param args
-	 */
-	void setCallbackArgs(void* args);
-
-    /**
-     * True if SPI transfers should be performed in full duplex mode
-     * @return
-     */
-    bool isFullDuplex() const;
-
-    /**
-     * Set transfer type to full duplex or half duplex. Full duplex is the default setting,
-     * ressembling common SPI hardware implementation with shift registers, where read and writes
-     * happen simultaneosly.
-     * @param fullDuplex
-     */
-    void setFullOrHalfDuplex(bool halfDuplex);
-
-    /**
-     * This needs to be called to specify where the SPI driver writes to or reads from.
-     * @param readLocation
-     * @param writeLocation
-     */
-    void assignReadBuffer(uint8_t* rx);
-    void assignWriteBuffer(const uint8_t* tx);
-    /**
-     * Set size for the next transfer. Set to 0 for no transfer
-     * @param transferSize
-     */
-    void setTransferSize(size_t transferSize);
-    size_t getCurrentTransferSize() const;
-
-    struct UncommonParameters {
-        uint8_t bitsPerWord = 8;
-        bool noCs = false;
-        bool csHigh = false;
-        bool threeWireSpi = false;
-        /* MSB first is more common */
-        bool lsbFirst = false;
-    };
-
-    /**
-     * Can be used to explicitely disable hardware chip select.
-     * Some drivers like the Raspberry Pi Linux driver will not use hardware chip select by default
-     * (see https://www.raspberrypi.org/documentation/hardware/raspberrypi/spi/README.md)
-     * @param enable
-     */
-    void setNoCs(bool enable);
-    void setThreeWireSpi(bool enable);
-    void setLsbFirst(bool enable);
-    void setCsHigh(bool enable);
-    void setBitsPerWord(uint8_t bitsPerWord);
-
-    void getSpiParameters(spi::SpiModes& spiMode, uint32_t& spiSpeed,
-            UncommonParameters* parameters = nullptr) const;
-
-    /**
-     * See spidev.h cs_change and delay_usecs
-     * @param deselectCs
-     * @param delayUsecs
-     */
-    void activateCsDeselect(bool deselectCs, uint16_t delayUsecs);
-
-    spi_ioc_transfer* getTransferStructHandle();
-private:
-
-    /**
-     * Internal constructor which initializes every field
-     * @param spiAddress
-     * @param chipSelect
-     * @param spiDev
-     * @param maxSize
-     * @param spiMode
-     * @param spiSpeed
-     * @param callback
-     * @param args
-     */
-    SpiCookie(spi::SpiComIfModes comIfMode, address_t spiAddress, gpioId_t chipSelect,
-            std::string spiDev, const size_t maxSize, spi::SpiModes spiMode, uint32_t spiSpeed,
-            spi::send_callback_function_t callback, void* args);
-
-    address_t spiAddress;
-    gpioId_t chipSelectPin;
-    std::string spiDevice;
-
-    spi::SpiComIfModes comIfMode;
-
-    // Required for regular mode
-    const size_t maxSize;
-    spi::SpiModes spiMode;
-    uint32_t spiSpeed;
-    bool halfDuplex = false;
-
-    // Required for callback mode
-    spi::send_callback_function_t sendCallback = nullptr;
-    void* callbackArgs = nullptr;
-
-    struct spi_ioc_transfer spiTransferStruct = {};
-    UncommonParameters uncommonParameters;
-};
-
-
-
-#endif /* LINUX_SPI_SPICOOKIE_H_ */

hal/src/fsfw_hal/linux/uart/UartComIF.cpp

@@ -1,529 +0,0 @@
-#include "UartComIF.h"
-#include "OBSWConfig.h"
-
-#include "fsfw_hal/linux/utility.h"
-#include "fsfw/serviceinterface/ServiceInterface.h"
-
-#include <cstring>
-#include <fcntl.h>
-#include <errno.h>
-#include <termios.h>
-#include <unistd.h>
-
-UartComIF::UartComIF(object_id_t objectId): SystemObject(objectId){
-}
-
-UartComIF::~UartComIF() {}
-
-ReturnValue_t UartComIF::initializeInterface(CookieIF* cookie) {
-
-    std::string deviceFile;
-    UartDeviceMapIter uartDeviceMapIter;
-
-    if(cookie == nullptr) {
-        return NULLPOINTER;
-    }
-
-    UartCookie* uartCookie = dynamic_cast<UartCookie*>(cookie);
-    if (uartCookie == nullptr) {
-        sif::error << "UartComIF::initializeInterface: Invalid UART Cookie!" << std::endl;
-        return NULLPOINTER;
-    }
-
-    deviceFile = uartCookie->getDeviceFile();
-
-    uartDeviceMapIter = uartDeviceMap.find(deviceFile);
-    if(uartDeviceMapIter == uartDeviceMap.end()) {
-        int fileDescriptor = configureUartPort(uartCookie);
-        if (fileDescriptor < 0) {
-            return RETURN_FAILED;
-        }
-        size_t maxReplyLen = uartCookie->getMaxReplyLen();
-        UartElements uartElements = {fileDescriptor, std::vector<uint8_t>(maxReplyLen), 0};
-        auto status = uartDeviceMap.emplace(deviceFile, uartElements);
-        if (status.second == false) {
-            sif::warning << "UartComIF::initializeInterface: Failed to insert device " <<
-                    deviceFile << "to UART device map" << std::endl;
-            return RETURN_FAILED;
-        }
-    }
-    else {
-        sif::warning << "UartComIF::initializeInterface: UART device " << deviceFile <<
-                " already in use" << std::endl;
-        return RETURN_FAILED;
-    }
-
-    return RETURN_OK;
-}
-
-int UartComIF::configureUartPort(UartCookie* uartCookie) {
-
-    struct termios options = {};
-
-    std::string deviceFile = uartCookie->getDeviceFile();
-    int flags = O_RDWR;
-    if(uartCookie->getUartMode() == UartModes::CANONICAL) {
-        // In non-canonical mode, don't specify O_NONBLOCK because these properties will be
-        // controlled by the VTIME and VMIN parameters and O_NONBLOCK would override this
-        flags |= O_NONBLOCK;
-    }
-    int fd = open(deviceFile.c_str(), flags);
-
-    if (fd < 0) {
-        sif::warning << "UartComIF::configureUartPort: Failed to open uart " << deviceFile <<
-                "with error code " << errno << strerror(errno) << std::endl;
-        return fd;
-    }
-
-    /* Read in existing settings */
-    if(tcgetattr(fd, &options) != 0) {
-        sif::warning << "UartComIF::configureUartPort: Error " << errno << "from tcgetattr: "
-                << strerror(errno) << std::endl;
-        return fd;
-    }
-
-    setParityOptions(&options, uartCookie);
-    setStopBitOptions(&options, uartCookie);
-    setDatasizeOptions(&options, uartCookie);
-    setFixedOptions(&options);
-    setUartMode(&options, *uartCookie);
-    if(uartCookie->getInputShouldBeFlushed()) {
-        tcflush(fd, TCIFLUSH);
-    }
-
-    /* Sets uart to non-blocking mode. Read returns immediately when there are no data available */
-    options.c_cc[VTIME] = 0;
-    options.c_cc[VMIN] = 0;
-
-    configureBaudrate(&options, uartCookie);
-
-    /* Save option settings */
-    if (tcsetattr(fd, TCSANOW, &options) != 0) {
-        sif::warning << "UartComIF::configureUartPort: Failed to set options with error " <<
-                errno << ": " << strerror(errno);
-        return fd;
-    }
-    return fd;
-}
-
-void UartComIF::setParityOptions(struct termios* options, UartCookie* uartCookie) {
-    /* Clear parity bit */
-    options->c_cflag &= ~PARENB;
-    switch (uartCookie->getParity()) {
-    case Parity::EVEN:
-        options->c_cflag |= PARENB;
-        options->c_cflag &= ~PARODD;
-        break;
-    case Parity::ODD:
-        options->c_cflag |= PARENB;
-        options->c_cflag |= PARODD;
-        break;
-    default:
-        break;
-    }
-}
-
-void UartComIF::setStopBitOptions(struct termios* options, UartCookie* uartCookie) {
-    /* Clear stop field. Sets stop bit to one bit */
-    options->c_cflag &= ~CSTOPB;
-    switch (uartCookie->getStopBits()) {
-    case StopBits::TWO_STOP_BITS:
-        options->c_cflag |= CSTOPB;
-        break;
-    default:
-        break;
-    }
-}
-
-void UartComIF::setDatasizeOptions(struct termios* options, UartCookie* uartCookie) {
-    /* Clear size bits */
-    options->c_cflag &= ~CSIZE;
-    switch (uartCookie->getBitsPerWord()) {
-    case 5:
-        options->c_cflag |= CS5;
-        break;
-    case 6:
-        options->c_cflag |= CS6;
-        break;
-    case 7:
-        options->c_cflag |= CS7;
-        break;
-    case 8:
-        options->c_cflag |= CS8;
-        break;
-    default:
-        sif::warning << "UartComIF::setDatasizeOptions: Invalid size specified" << std::endl;
-        break;
-    }
-}
-
-void UartComIF::setFixedOptions(struct termios* options) {
-    /* Disable RTS/CTS hardware flow control */
-    options->c_cflag &= ~CRTSCTS;
-    /* Turn on READ & ignore ctrl lines (CLOCAL = 1) */
-    options->c_cflag |= CREAD | CLOCAL;
-    /* Disable echo */
-    options->c_lflag &= ~ECHO;
-    /* Disable erasure */
-    options->c_lflag &= ~ECHOE;
-    /* Disable new-line echo */
-    options->c_lflag &= ~ECHONL;
-    /* Disable interpretation of INTR, QUIT and SUSP */
-    options->c_lflag &= ~ISIG;
-    /* Turn off s/w flow ctrl */
-    options->c_iflag &= ~(IXON | IXOFF | IXANY);
-    /* Disable any special handling of received bytes */
-    options->c_iflag &= ~(IGNBRK|BRKINT|PARMRK|ISTRIP|INLCR|IGNCR|ICRNL);
-    /* Prevent special interpretation of output bytes (e.g. newline chars) */
-    options->c_oflag &= ~OPOST;
-    /* Prevent conversion of newline to carriage return/line feed */
-    options->c_oflag &= ~ONLCR;
-}
-
-void UartComIF::configureBaudrate(struct termios* options, UartCookie* uartCookie) {
-    switch (uartCookie->getBaudrate()) {
-    case 50:
-        cfsetispeed(options, B50);
-        cfsetospeed(options, B50);
-        break;
-    case 75:
-        cfsetispeed(options, B75);
-        cfsetospeed(options, B75);
-        break;
-    case 110:
-        cfsetispeed(options, B110);
-        cfsetospeed(options, B110);
-        break;
-    case 134:
-        cfsetispeed(options, B134);
-        cfsetospeed(options, B134);
-        break;
-    case 150:
-        cfsetispeed(options, B150);
-        cfsetospeed(options, B150);
-        break;
-    case 200:
-        cfsetispeed(options, B200);
-        cfsetospeed(options, B200);
-        break;
-    case 300:
-        cfsetispeed(options, B300);
-        cfsetospeed(options, B300);
-        break;
-    case 600:
-        cfsetispeed(options, B600);
-        cfsetospeed(options, B600);
-        break;
-    case 1200:
-        cfsetispeed(options, B1200);
-        cfsetospeed(options, B1200);
-        break;
-    case 1800:
-        cfsetispeed(options, B1800);
-        cfsetospeed(options, B1800);
-        break;
-    case 2400:
-        cfsetispeed(options, B2400);
-        cfsetospeed(options, B2400);
-        break;
-    case 4800:
-        cfsetispeed(options, B4800);
-        cfsetospeed(options, B4800);
-        break;
-    case 9600:
-        cfsetispeed(options, B9600);
-        cfsetospeed(options, B9600);
-        break;
-    case 19200:
-        cfsetispeed(options, B19200);
-        cfsetospeed(options, B19200);
-        break;
-    case 38400:
-        cfsetispeed(options, B38400);
-        cfsetospeed(options, B38400);
-        break;
-    case 57600:
-        cfsetispeed(options, B57600);
-        cfsetospeed(options, B57600);
-        break;
-    case 115200:
-        cfsetispeed(options, B115200);
-        cfsetospeed(options, B115200);
-        break;
-    case 230400:
-        cfsetispeed(options, B230400);
-        cfsetospeed(options, B230400);
-        break;
-    case 460800:
-        cfsetispeed(options, B460800);
-        cfsetospeed(options, B460800);
-        break;
-    default:
-        sif::warning << "UartComIF::configureBaudrate: Baudrate not supported" << std::endl;
-        break;
-    }
-}
-
-ReturnValue_t UartComIF::sendMessage(CookieIF *cookie,
-        const uint8_t *sendData, size_t sendLen) {
-    int fd = 0;
-    std::string deviceFile;
-    UartDeviceMapIter uartDeviceMapIter;
-
-    if(sendLen == 0) {
-        return RETURN_OK;
-    }
-
-    if(sendData == nullptr) {
-        sif::warning << "UartComIF::sendMessage: Send data is nullptr" << std::endl;
-        return RETURN_FAILED;
-    }
-
-    UartCookie* uartCookie = dynamic_cast<UartCookie*>(cookie);
-    if(uartCookie == nullptr) {
-        sif::warning << "UartComIF::sendMessasge: Invalid UART Cookie!" << std::endl;
-        return NULLPOINTER;
-    }
-
-    deviceFile = uartCookie->getDeviceFile();
-    uartDeviceMapIter = uartDeviceMap.find(deviceFile);
-    if (uartDeviceMapIter == uartDeviceMap.end()) {
-        sif::debug << "UartComIF::sendMessage: Device file " << deviceFile <<
-                "not in UART map" << std::endl;
-        return RETURN_FAILED;
-    }
-
-    fd = uartDeviceMapIter->second.fileDescriptor;
-
-    if (write(fd, sendData, sendLen) != (int)sendLen) {
-        sif::error << "UartComIF::sendMessage: Failed to send data with error code " <<
-                errno << ": Error description: " << strerror(errno) << std::endl;
-        return RETURN_FAILED;
-    }
-
-    return RETURN_OK;
-}
-
-ReturnValue_t UartComIF::getSendSuccess(CookieIF *cookie) {
-    return RETURN_OK;
-}
-
-ReturnValue_t UartComIF::requestReceiveMessage(CookieIF *cookie, size_t requestLen) {
-    std::string deviceFile;
-    UartDeviceMapIter uartDeviceMapIter;
-
-    UartCookie* uartCookie = dynamic_cast<UartCookie*>(cookie);
-    if(uartCookie == nullptr) {
-        sif::debug << "UartComIF::requestReceiveMessage: Invalid Uart Cookie!" << std::endl;
-        return NULLPOINTER;
-    }
-
-    UartModes uartMode = uartCookie->getUartMode();
-    deviceFile = uartCookie->getDeviceFile();
-    uartDeviceMapIter = uartDeviceMap.find(deviceFile);
-
-    if(uartMode == UartModes::NON_CANONICAL and requestLen == 0) {
-        return RETURN_OK;
-    }
-
-    if (uartDeviceMapIter == uartDeviceMap.end()) {
-        sif::debug << "UartComIF::requestReceiveMessage: Device file " << deviceFile
-                << " not in uart map" << std::endl;
-        return RETURN_FAILED;
-    }
-
-    if (uartMode == UartModes::CANONICAL) {
-        return handleCanonicalRead(*uartCookie, uartDeviceMapIter, requestLen);
-    }
-    else if (uartMode == UartModes::NON_CANONICAL) {
-        return handleNoncanonicalRead(*uartCookie, uartDeviceMapIter, requestLen);
-    }
-    else {
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-}
-
-ReturnValue_t UartComIF::handleCanonicalRead(UartCookie& uartCookie, UartDeviceMapIter& iter,
-        size_t requestLen) {
-    ReturnValue_t result = HasReturnvaluesIF::RETURN_OK;
-    uint8_t maxReadCycles = uartCookie.getReadCycles();
-    uint8_t currentReadCycles = 0;
-    int bytesRead = 0;
-    size_t currentBytesRead = 0;
-    size_t maxReplySize = uartCookie.getMaxReplyLen();
-    int fd = iter->second.fileDescriptor;
-    auto bufferPtr = iter->second.replyBuffer.data();
-    iter->second.replyLen = 0;
-    do {
-        size_t allowedReadSize = 0;
-        if(currentBytesRead >= maxReplySize) {
-            // Overflow risk. Emit warning, trigger event and break. If this happens,
-            // the reception buffer is not large enough or data is not polled often enough.
-#if FSFW_VERBOSE_LEVEL >= 1
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-            sif::warning << "UartComIF::requestReceiveMessage: Next read would cause overflow!"
-                    << std::endl;
-#else
-            sif::printWarning("UartComIF::requestReceiveMessage: "
-                    "Next read would cause overflow!");
-#endif
-#endif
-            result = UART_RX_BUFFER_TOO_SMALL;
-            break;
-        }
-        else {
-            allowedReadSize = maxReplySize - currentBytesRead;
-        }
-
-        bytesRead = read(fd, bufferPtr, allowedReadSize);
-        if (bytesRead < 0) {
-            // EAGAIN: No data available in non-blocking mode
-            if(errno != EAGAIN) {
-#if FSFW_VERBOSE_LEVEL >= 1
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-                sif::warning << "UartComIF::handleCanonicalRead: read failed with code" <<
-                        errno << ": " << strerror(errno) << std::endl;
-#else
-                sif::printWarning("UartComIF::handleCanonicalRead: read failed with code %d: %s\n",
-                        errno, strerror(errno));
-#endif
-#endif
-                return RETURN_FAILED;
-            }
-
-        }
-        else if(bytesRead > 0) {
-            iter->second.replyLen += bytesRead;
-            bufferPtr += bytesRead;
-            currentBytesRead += bytesRead;
-        }
-        currentReadCycles++;
-    } while(bytesRead > 0 and currentReadCycles < maxReadCycles);
-    return result;
-}
-
-ReturnValue_t UartComIF::handleNoncanonicalRead(UartCookie &uartCookie, UartDeviceMapIter &iter,
-        size_t requestLen) {
-    int fd = iter->second.fileDescriptor;
-    auto bufferPtr = iter->second.replyBuffer.data();
-    // Size check to prevent buffer overflow
-    if(requestLen > uartCookie.getMaxReplyLen()) {
-#if OBSW_VERBOSE_LEVEL >= 1
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-        sif::warning << "UartComIF::requestReceiveMessage: Next read would cause overflow!"
-                << std::endl;
-#else
-        sif::printWarning("UartComIF::requestReceiveMessage: "
-                "Next read would cause overflow!");
-#endif
-#endif
-        return UART_RX_BUFFER_TOO_SMALL;
-    }
-    int bytesRead = read(fd, bufferPtr, requestLen);
-    if (bytesRead < 0) {
-        return RETURN_FAILED;
-    }
-    else if (bytesRead != static_cast<int>(requestLen)) {
-        if(uartCookie.isReplySizeFixed()) {
-            sif::warning << "UartComIF::requestReceiveMessage: Only read " << bytesRead <<
-                    " of " << requestLen << " bytes" << std::endl;
-            return RETURN_FAILED;
-        }
-    }
-    iter->second.replyLen = bytesRead;
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t UartComIF::readReceivedMessage(CookieIF *cookie,
-        uint8_t **buffer, size_t* size) {
-
-    std::string deviceFile;
-    UartDeviceMapIter uartDeviceMapIter;
-
-    UartCookie* uartCookie = dynamic_cast<UartCookie*>(cookie);
-    if(uartCookie == nullptr) {
-        sif::debug << "UartComIF::readReceivedMessage: Invalid uart cookie!" << std::endl;
-        return NULLPOINTER;
-    }
-
-    deviceFile = uartCookie->getDeviceFile();
-    uartDeviceMapIter = uartDeviceMap.find(deviceFile);
-    if (uartDeviceMapIter == uartDeviceMap.end()) {
-        sif::debug << "UartComIF::readReceivedMessage: Device file " << deviceFile <<
-                " not in uart map" << std::endl;
-        return RETURN_FAILED;
-    }
-
-    *buffer = uartDeviceMapIter->second.replyBuffer.data();
-    *size = uartDeviceMapIter->second.replyLen;
-
-    /* Length is reset to 0 to prevent reading the same data twice */
-    uartDeviceMapIter->second.replyLen = 0;
-
-    return RETURN_OK;
-}
-
-ReturnValue_t UartComIF::flushUartRxBuffer(CookieIF *cookie) {
-    std::string deviceFile;
-    UartDeviceMapIter uartDeviceMapIter;
-    UartCookie* uartCookie = dynamic_cast<UartCookie*>(cookie);
-    if(uartCookie == nullptr) {
-        sif::warning << "UartComIF::flushUartRxBuffer: Invalid uart cookie!" << std::endl;
-        return NULLPOINTER;
-    }
-    deviceFile = uartCookie->getDeviceFile();
-    uartDeviceMapIter = uartDeviceMap.find(deviceFile);
-    if(uartDeviceMapIter != uartDeviceMap.end()) {
-        int fd = uartDeviceMapIter->second.fileDescriptor;
-        tcflush(fd, TCIFLUSH);
-        return RETURN_OK;
-    }
-    return RETURN_FAILED;
-}
-
-ReturnValue_t UartComIF::flushUartTxBuffer(CookieIF *cookie) {
-    std::string deviceFile;
-    UartDeviceMapIter uartDeviceMapIter;
-    UartCookie* uartCookie = dynamic_cast<UartCookie*>(cookie);
-    if(uartCookie == nullptr) {
-        sif::warning << "UartComIF::flushUartTxBuffer: Invalid uart cookie!" << std::endl;
-        return NULLPOINTER;
-    }
-    deviceFile = uartCookie->getDeviceFile();
-    uartDeviceMapIter = uartDeviceMap.find(deviceFile);
-    if(uartDeviceMapIter != uartDeviceMap.end()) {
-        int fd = uartDeviceMapIter->second.fileDescriptor;
-        tcflush(fd, TCOFLUSH);
-        return RETURN_OK;
-    }
-    return RETURN_FAILED;
-}
-
-ReturnValue_t UartComIF::flushUartTxAndRxBuf(CookieIF *cookie) {
-    std::string deviceFile;
-    UartDeviceMapIter uartDeviceMapIter;
-    UartCookie* uartCookie = dynamic_cast<UartCookie*>(cookie);
-    if(uartCookie == nullptr) {
-        sif::warning << "UartComIF::flushUartTxAndRxBuf: Invalid uart cookie!" << std::endl;
-        return NULLPOINTER;
-    }
-    deviceFile = uartCookie->getDeviceFile();
-    uartDeviceMapIter = uartDeviceMap.find(deviceFile);
-    if(uartDeviceMapIter != uartDeviceMap.end()) {
-        int fd = uartDeviceMapIter->second.fileDescriptor;
-        tcflush(fd, TCIOFLUSH);
-        return RETURN_OK;
-    }
-    return RETURN_FAILED;
-}
-
-void UartComIF::setUartMode(struct termios *options, UartCookie &uartCookie) {
-    UartModes uartMode = uartCookie.getUartMode();
-    if(uartMode == UartModes::NON_CANONICAL) {
-        /* Disable canonical mode */
-        options->c_lflag &= ~ICANON;
-    }
-    else if(uartMode == UartModes::CANONICAL) {
-        options->c_lflag |= ICANON;
-    }
-}

hal/src/fsfw_hal/linux/uart/UartComIF.h

@@ -1,125 +0,0 @@
-#ifndef BSP_Q7S_COMIF_UARTCOMIF_H_
-#define BSP_Q7S_COMIF_UARTCOMIF_H_
-
-#include "UartCookie.h"
-#include <fsfw/objectmanager/SystemObject.h>
-#include <fsfw/devicehandlers/DeviceCommunicationIF.h>
-
-#include <unordered_map>
-#include <vector>
-
-/**
- * @brief 	This is the communication interface to access serial ports on linux based operating
- *          systems.
- *
- * @details The implementation follows the instructions from https://blog.mbedded.ninja/programming/
- *          operating-systems/linux/linux-serial-ports-using-c-cpp/#disabling-canonical-mode
- *
- * @author 	J. Meier
- */
-class UartComIF: public DeviceCommunicationIF, public SystemObject {
-public:
-    static constexpr uint8_t uartRetvalId = CLASS_ID::HAL_UART;
-
-    static constexpr ReturnValue_t UART_READ_FAILURE =
-            HasReturnvaluesIF::makeReturnCode(uartRetvalId, 1);
-    static constexpr ReturnValue_t UART_READ_SIZE_MISSMATCH =
-            HasReturnvaluesIF::makeReturnCode(uartRetvalId, 2);
-    static constexpr ReturnValue_t UART_RX_BUFFER_TOO_SMALL =
-            HasReturnvaluesIF::makeReturnCode(uartRetvalId, 3);
-
-    UartComIF(object_id_t objectId);
-
-    virtual ~UartComIF();
-
-    ReturnValue_t initializeInterface(CookieIF * cookie) override;
-    ReturnValue_t sendMessage(CookieIF *cookie,const uint8_t *sendData,
-            size_t sendLen) override;
-    ReturnValue_t getSendSuccess(CookieIF *cookie) override;
-    ReturnValue_t requestReceiveMessage(CookieIF *cookie,
-            size_t requestLen) override;
-    ReturnValue_t readReceivedMessage(CookieIF *cookie, uint8_t **buffer,
-            size_t *size) override;
-
-    /**
-     * @brief   This function discards all data received but not read in the UART buffer.
-     */
-    ReturnValue_t flushUartRxBuffer(CookieIF *cookie);
-
-    /**
-     * @brief   This function discards all data in the transmit buffer of the UART driver.
-     */
-    ReturnValue_t flushUartTxBuffer(CookieIF *cookie);
-
-    /**
-     * @brief   This function discards both data in the transmit and receive buffer of the UART.
-     */
-    ReturnValue_t flushUartTxAndRxBuf(CookieIF *cookie);
-
-private:
-
-    using UartDeviceFile_t = std::string;
-
-    struct UartElements {
-        int fileDescriptor;
-        std::vector<uint8_t> replyBuffer;
-        /** Number of bytes read will be written to this variable */
-        size_t replyLen;
-    };
-
-    using UartDeviceMap = std::unordered_map<UartDeviceFile_t, UartElements>;
-    using UartDeviceMapIter = UartDeviceMap::iterator;
-
-    /**
-     * The uart devie map stores informations of initialized uart ports.
-     */
-    UartDeviceMap uartDeviceMap;
-
-    /**
-     * @brief	This function opens and configures a uart device by using the information stored
-     *          in the uart cookie.
-     * @param uartCookie    Pointer to uart cookie with information about the uart. Contains the
-     *                      uart device file, baudrate, parity, stopbits etc.
-     * @return  The file descriptor of the configured uart.
-     */
-    int configureUartPort(UartCookie* uartCookie);
-
-    /**
-     * @brief   This function adds the parity settings to the termios options struct.
-     *
-     * @param options   Pointer to termios options struct which will be modified to enable or disable
-     *                  parity checking.
-     * @param uartCookie    Pointer to uart cookie containing the information about the desired
-     *                      parity settings.
-     *
-     */
-    void setParityOptions(struct termios* options, UartCookie* uartCookie);
-
-    void setStopBitOptions(struct termios* options, UartCookie* uartCookie);
-
-    /**
-     * @brief   This function sets options which are not configurable by the uartCookie.
-     */
-    void setFixedOptions(struct termios* options);
-
-    /**
-     * @brief   With this function the datasize settings are added to the termios options struct.
-     */
-    void setDatasizeOptions(struct termios* options, UartCookie* uartCookie);
-
-    /**
-     * @brief   This functions adds the  baudrate specified in the uartCookie to the termios options
-     *          struct.
-     */
-    void configureBaudrate(struct termios* options, UartCookie* uartCookie);
-
-    void setUartMode(struct termios* options, UartCookie& uartCookie);
-
-    ReturnValue_t handleCanonicalRead(UartCookie& uartCookie, UartDeviceMapIter& iter,
-            size_t requestLen);
-    ReturnValue_t handleNoncanonicalRead(UartCookie& uartCookie, UartDeviceMapIter& iter,
-            size_t requestLen);
-
-};
-
-#endif /* BSP_Q7S_COMIF_UARTCOMIF_H_ */

hal/src/fsfw_hal/linux/uart/UartCookie.cpp

@@ -1,97 +0,0 @@
-#include "fsfw_hal/linux/uart/UartCookie.h"
-
-#include <fsfw/serviceinterface/ServiceInterface.h>
-
-UartCookie::UartCookie(object_id_t handlerId, std::string deviceFile, UartModes uartMode,
-        uint32_t baudrate, size_t maxReplyLen):
-        handlerId(handlerId), deviceFile(deviceFile), uartMode(uartMode),
-        baudrate(baudrate), maxReplyLen(maxReplyLen) {
-}
-
-UartCookie::~UartCookie() {}
-
-uint32_t UartCookie::getBaudrate() const {
-    return baudrate;
-}
-
-size_t UartCookie::getMaxReplyLen() const {
-    return maxReplyLen;
-}
-
-std::string UartCookie::getDeviceFile() const {
-    return deviceFile;
-}
-
-void UartCookie::setParityOdd() {
-    parity = Parity::ODD;
-}
-
-void UartCookie::setParityEven() {
-    parity = Parity::EVEN;
-}
-
-Parity UartCookie::getParity() const {
-    return parity;
-}
-
-void UartCookie::setBitsPerWord(uint8_t bitsPerWord_) {
-    switch(bitsPerWord_) {
-    case 5:
-    case 6:
-    case 7:
-    case 8:
-        break;
-    default:
-        sif::debug << "UartCookie::setBitsPerWord: Invalid bits per word specified" << std::endl;
-        return;
-    }
-    bitsPerWord = bitsPerWord_;
-}
-
-uint8_t UartCookie::getBitsPerWord() const {
-    return bitsPerWord;
-}
-
-StopBits UartCookie::getStopBits() const {
-    return stopBits;
-}
-
-void UartCookie::setTwoStopBits() {
-    stopBits = StopBits::TWO_STOP_BITS;
-}
-
-void UartCookie::setOneStopBit() {
-    stopBits = StopBits::ONE_STOP_BIT;
-}
-
-UartModes UartCookie::getUartMode() const {
-    return uartMode;
-}
-
-void UartCookie::setReadCycles(uint8_t readCycles) {
-    this->readCycles = readCycles;
-}
-
-void UartCookie::setToFlushInput(bool enable) {
-    this->flushInput = enable;
-}
-
-uint8_t UartCookie::getReadCycles() const {
-    return readCycles;
-}
-
-bool UartCookie::getInputShouldBeFlushed() {
-    return this->flushInput;
-}
-
-object_id_t UartCookie::getHandlerId() const {
-    return this->handlerId;
-}
-
-void UartCookie::setNoFixedSizeReply() {
-    replySizeFixed = false;
-}
-
-bool UartCookie::isReplySizeFixed() {
-    return replySizeFixed;
-}

hal/src/fsfw_hal/linux/uart/UartCookie.h

@@ -1,121 +0,0 @@
-#ifndef SAM9G20_COMIF_COOKIES_UART_COOKIE_H_
-#define SAM9G20_COMIF_COOKIES_UART_COOKIE_H_
-
-#include <fsfw/devicehandlers/CookieIF.h>
-#include <fsfw/objectmanager/SystemObjectIF.h>
-
-#include <string>
-
-enum class Parity {
-    NONE,
-    EVEN,
-    ODD
-};
-
-enum class StopBits {
-    ONE_STOP_BIT,
-    TWO_STOP_BITS
-};
-
-enum class UartModes {
-    CANONICAL,
-    NON_CANONICAL
-};
-
-/**
- * @brief   Cookie for the UartComIF. There are many options available to configure the UART driver.
- *          The constructor only requests for common options like the baudrate. Other options can
- *          be set by member functions.
- *
- * @author 	J. Meier
- */
-class UartCookie: public CookieIF {
-public:
-
-    /**
-     * @brief	Constructor for the uart cookie.
-     * @param deviceFile    The device file specifying the uart to use, e.g. "/dev/ttyPS1"
-     * @param uartMode      Specify the UART mode. The canonical mode should be used if the
-     *                      messages are separated by a delimited character like '\n'. See the
-     *                      termios documentation for more information
-     * @param baudrate      The baudrate to use for input and output. Possible Baudrates are: 50,
-     *                      75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800, 9600, B19200,
-     *                      38400, 57600, 115200, 230400, 460800
-     * @param maxReplyLen   The maximum size an object using this cookie expects
-     * @details
-     * Default configuration: No parity
-     *                        8 databits (number of bits transfered with one uart frame)
-     *                        One stop bit
-     */
-    UartCookie(object_id_t handlerId, std::string deviceFile, UartModes uartMode,
-            uint32_t baudrate, size_t maxReplyLen);
-
-    virtual ~UartCookie();
-
-    uint32_t getBaudrate() const;
-    size_t getMaxReplyLen() const;
-    std::string getDeviceFile() const;
-    Parity getParity() const;
-    uint8_t getBitsPerWord() const;
-    StopBits getStopBits() const;
-    UartModes getUartMode() const;
-    object_id_t getHandlerId() const;
-
-    /**
-     * The UART ComIF will only perform a specified number of read cycles for the canonical mode.
-     * The user can specify how many of those read cycles are performed for one device handler
-     * communication cycle. An example use-case would be to read all available GPS NMEA strings
-     * at once.
-     * @param readCycles
-     */
-    void setReadCycles(uint8_t readCycles);
-    uint8_t getReadCycles() const;
-
-    /**
-     * Allows to flush the data which was received but has not been read yet. This is useful
-     * to discard obsolete data at software startup.
-     */
-    void setToFlushInput(bool enable);
-    bool getInputShouldBeFlushed();
-
-    /**
-     * Functions two enable parity checking.
-     */
-    void setParityOdd();
-    void setParityEven();
-
-    /**
-     * Function two set number of bits per UART frame.
-     */
-    void setBitsPerWord(uint8_t bitsPerWord_);
-
-    /**
-     * Function to specify the number of stopbits.
-     */
-    void setTwoStopBits();
-    void setOneStopBit();
-
-    /**
-     * Calling this function prevents the UartComIF to return failed if not all requested bytes
-     * could be read. This is required by a device handler when the size of a reply is not known.
-     */
-    void setNoFixedSizeReply();
-
-    bool isReplySizeFixed();
-
-private:
-
-    const object_id_t handlerId;
-    std::string deviceFile;
-    const UartModes uartMode;
-    bool flushInput = false;
-    uint32_t baudrate;
-    size_t maxReplyLen = 0;
-    Parity parity = Parity::NONE;
-    uint8_t bitsPerWord = 8;
-    uint8_t readCycles = 1;
-    StopBits stopBits = StopBits::ONE_STOP_BIT;
-    bool replySizeFixed = true;
-};
-
-#endif

hal/src/fsfw_hal/linux/utility.cpp

@@ -1,26 +0,0 @@
-#include "fsfw/FSFW.h"
-#include "fsfw/serviceinterface/ServiceInterface.h"
-#include "fsfw_hal/linux/utility.h"
-
-#include <cerrno>
-#include <cstring>
-
-void utility::handleIoctlError(const char* const customPrintout) {
-#if FSFW_VERBOSE_LEVEL >= 1
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-    if(customPrintout != nullptr) {
-        sif::warning << customPrintout << std::endl;
-    }
-    sif::warning << "handleIoctlError: Error code " << errno << ", "<< strerror(errno) <<
-            std::endl;
-#else
-    if(customPrintout != nullptr) {
-        sif::printWarning("%s\n", customPrintout);
-    }
-    sif::printWarning("handleIoctlError: Error code %d, %s\n", errno, strerror(errno));
-#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
-#endif /* FSFW_VERBOSE_LEVEL >= 1 */
-
-}
-
-

hal/src/fsfw_hal/stm32h7/devicetest/GyroL3GD20H.cpp

@@ -1,558 +0,0 @@
-#include "fsfw_hal/stm32h7/devicetest/GyroL3GD20H.h"
-
-#include "fsfw_hal/stm32h7/spi/mspInit.h"
-#include "fsfw_hal/stm32h7/spi/spiDefinitions.h"
-#include "fsfw_hal/stm32h7/spi/spiCore.h"
-#include "fsfw_hal/stm32h7/spi/spiInterrupts.h"
-#include "fsfw_hal/stm32h7/spi/stm32h743zi.h"
-
-#include "fsfw/tasks/TaskFactory.h"
-#include "fsfw/serviceinterface/ServiceInterface.h"
-
-#include "stm32h7xx_hal_spi.h"
-#include "stm32h7xx_hal_rcc.h"
-
-#include <cstring>
-
-alignas(32) std::array<uint8_t, GyroL3GD20H::recvBufferSize> GyroL3GD20H::rxBuffer;
-alignas(32) std::array<uint8_t, GyroL3GD20H::txBufferSize>
-GyroL3GD20H::txBuffer __attribute__((section(".dma_buffer")));
-
-TransferStates transferState = TransferStates::IDLE;
-spi::TransferModes  GyroL3GD20H::transferMode = spi::TransferModes::POLLING;
-
-
-GyroL3GD20H::GyroL3GD20H(SPI_HandleTypeDef *spiHandle, spi::TransferModes transferMode_):
-        spiHandle(spiHandle) {
-    txDmaHandle = new DMA_HandleTypeDef();
-    rxDmaHandle = new DMA_HandleTypeDef();
-    spi::setSpiHandle(spiHandle);
-    spi::assignSpiUserArgs(spi::SpiBus::SPI_1, spiHandle);
-    transferMode = transferMode_;
-    if(transferMode == spi::TransferModes::DMA) {
-        mspCfg = new spi::MspDmaConfigStruct();
-        auto typedCfg = dynamic_cast<spi::MspDmaConfigStruct*>(mspCfg);
-        spi::setDmaHandles(txDmaHandle, rxDmaHandle);
-        stm32h7::h743zi::standardDmaCfg(*typedCfg, IrqPriorities::HIGHEST_FREERTOS,
-                IrqPriorities::HIGHEST_FREERTOS, IrqPriorities::HIGHEST_FREERTOS);
-        spi::setSpiDmaMspFunctions(typedCfg);
-    }
-    else if(transferMode == spi::TransferModes::INTERRUPT) {
-        mspCfg = new spi::MspIrqConfigStruct();
-        auto typedCfg = dynamic_cast<spi::MspIrqConfigStruct*>(mspCfg);
-        stm32h7::h743zi::standardInterruptCfg(*typedCfg, IrqPriorities::HIGHEST_FREERTOS);
-        spi::setSpiIrqMspFunctions(typedCfg);
-    }
-    else if(transferMode == spi::TransferModes::POLLING) {
-        mspCfg = new spi::MspPollingConfigStruct();
-        auto typedCfg = dynamic_cast<spi::MspPollingConfigStruct*>(mspCfg);
-        stm32h7::h743zi::standardPollingCfg(*typedCfg);
-        spi::setSpiPollingMspFunctions(typedCfg);
-    }
-
-    spi::assignTransferRxTxCompleteCallback(&spiTransferCompleteCallback, nullptr);
-    spi::assignTransferErrorCallback(&spiTransferErrorCallback, nullptr);
-
-    GPIO_InitTypeDef chipSelect = {};
-    __HAL_RCC_GPIOD_CLK_ENABLE();
-    chipSelect.Pin = GPIO_PIN_14;
-    chipSelect.Mode = GPIO_MODE_OUTPUT_PP;
-    HAL_GPIO_Init(GPIOD, &chipSelect);
-    HAL_GPIO_WritePin(GPIOD, GPIO_PIN_14, GPIO_PIN_SET);
-}
-
-GyroL3GD20H::~GyroL3GD20H() {
-    delete txDmaHandle;
-    delete rxDmaHandle;
-    if(mspCfg != nullptr) {
-        delete mspCfg;
-    }
-}
-
-ReturnValue_t GyroL3GD20H::initialize() {
-    // Configure the SPI peripheral
-    spiHandle->Instance               = SPI1;
-    spiHandle->Init.BaudRatePrescaler = spi::getPrescaler(HAL_RCC_GetHCLKFreq(), 3900000);
-    spiHandle->Init.Direction         = SPI_DIRECTION_2LINES;
-    spi::assignSpiMode(spi::SpiModes::MODE_3, *spiHandle);
-    spiHandle->Init.DataSize          = SPI_DATASIZE_8BIT;
-    spiHandle->Init.FirstBit          = SPI_FIRSTBIT_MSB;
-    spiHandle->Init.TIMode            = SPI_TIMODE_DISABLE;
-    spiHandle->Init.CRCCalculation    = SPI_CRCCALCULATION_DISABLE;
-    spiHandle->Init.CRCPolynomial     = 7;
-    spiHandle->Init.CRCLength         = SPI_CRC_LENGTH_8BIT;
-    spiHandle->Init.NSS               = SPI_NSS_SOFT;
-    spiHandle->Init.NSSPMode          = SPI_NSS_PULSE_DISABLE;
-    // Recommended setting to avoid glitches
-    spiHandle->Init.MasterKeepIOState = SPI_MASTER_KEEP_IO_STATE_ENABLE;
-    spiHandle->Init.Mode = SPI_MODE_MASTER;
-    if(HAL_SPI_Init(spiHandle) != HAL_OK) {
-        sif::printWarning("Error initializing SPI\n");
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-
-    delete mspCfg;
-    transferState = TransferStates::WAIT;
-
-    sif::printInfo("GyroL3GD20H::performOperation: Reading WHO AM I register\n");
-
-    txBuffer[0] = WHO_AM_I_REG | STM_READ_MASK;
-    txBuffer[1] = 0;
-
-    switch(transferMode)  {
-    case(spi::TransferModes::DMA): {
-        return handleDmaTransferInit();
-    }
-    case(spi::TransferModes::INTERRUPT): {
-        return handleInterruptTransferInit();
-    }
-    case(spi::TransferModes::POLLING): {
-        return handlePollingTransferInit();
-    }
-    default: {
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    }
-
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t GyroL3GD20H::performOperation() {
-    switch(transferMode)  {
-    case(spi::TransferModes::DMA): {
-        return handleDmaSensorRead();
-    }
-    case(spi::TransferModes::POLLING): {
-        return handlePollingSensorRead();
-    }
-    case(spi::TransferModes::INTERRUPT): {
-        return handleInterruptSensorRead();
-    }
-    default: {
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    }
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t GyroL3GD20H::handleDmaTransferInit() {
-    /* Clean D-cache */
-    /* Make sure the address is 32-byte aligned and add 32-bytes to length,
-    in case it overlaps cacheline */
-    // See https://community.st.com/s/article/FAQ-DMA-is-not-working-on-STM32H7-devices
-    HAL_StatusTypeDef result = performDmaTransfer(2);
-    if(result != HAL_OK) {
-        // Transfer error in transmission process
-        sif::printWarning("GyroL3GD20H::initialize: Error transmitting SPI with DMA\n");
-    }
-
-    // Wait for the transfer to complete
-    while (transferState == TransferStates::WAIT) {
-        TaskFactory::delayTask(1);
-    }
-
-    switch(transferState) {
-    case(TransferStates::SUCCESS): {
-        uint8_t whoAmIVal = rxBuffer[1];
-        if(whoAmIVal != EXPECTED_WHO_AM_I_VAL) {
-            sif::printDebug("GyroL3GD20H::initialize: "
-                    "Read WHO AM I value %d not equal to expected value!\n", whoAmIVal);
-        }
-        transferState = TransferStates::IDLE;
-        break;
-    }
-    case(TransferStates::FAILURE): {
-        sif::printWarning("Transfer failure\n");
-        transferState = TransferStates::FAILURE;
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    default: {
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    }
-
-    sif::printInfo("GyroL3GD20H::initialize: Configuring device\n");
-    // Configure the 5 configuration registers
-    uint8_t configRegs[5];
-    prepareConfigRegs(configRegs);
-
-    result = performDmaTransfer(6);
-    if(result != HAL_OK) {
-        // Transfer error in transmission process
-        sif::printWarning("Error transmitting SPI with DMA\n");
-    }
-
-    // Wait for the transfer to complete
-    while (transferState == TransferStates::WAIT) {
-        TaskFactory::delayTask(1);
-    }
-
-    switch(transferState) {
-    case(TransferStates::SUCCESS): {
-        sif::printInfo("GyroL3GD20H::initialize: Configuration transfer success\n");
-        transferState = TransferStates::IDLE;
-        break;
-    }
-    case(TransferStates::FAILURE): {
-        sif::printWarning("GyroL3GD20H::initialize: Configuration transfer failure\n");
-        transferState = TransferStates::FAILURE;
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    default: {
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    }
-
-
-    txBuffer[0] = CTRL_REG_1 | STM_AUTO_INCREMENT_MASK | STM_READ_MASK;
-    std::memset(txBuffer.data() + 1, 0 , 5);
-    result = performDmaTransfer(6);
-    if(result != HAL_OK) {
-        // Transfer error in transmission process
-        sif::printWarning("Error transmitting SPI with DMA\n");
-    }
-    // Wait for the transfer to complete
-    while (transferState == TransferStates::WAIT) {
-        TaskFactory::delayTask(1);
-    }
-
-    switch(transferState) {
-    case(TransferStates::SUCCESS): {
-        if(rxBuffer[1] != configRegs[0] or rxBuffer[2] != configRegs[1] or
-                rxBuffer[3] != configRegs[2] or rxBuffer[4] != configRegs[3] or
-                rxBuffer[5] != configRegs[4]) {
-            sif::printWarning("GyroL3GD20H::initialize: Configuration failure\n");
-        }
-        else {
-            sif::printInfo("GyroL3GD20H::initialize: Configuration success\n");
-        }
-        transferState = TransferStates::IDLE;
-        break;
-    }
-    case(TransferStates::FAILURE): {
-        sif::printWarning("GyroL3GD20H::initialize: Configuration transfer failure\n");
-        transferState = TransferStates::FAILURE;
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    default: {
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    }
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t GyroL3GD20H::handleDmaSensorRead() {
-    txBuffer[0] = CTRL_REG_1 | STM_AUTO_INCREMENT_MASK | STM_READ_MASK;
-    std::memset(txBuffer.data() + 1, 0 , 14);
-
-    HAL_StatusTypeDef result = performDmaTransfer(15);
-    if(result != HAL_OK) {
-        // Transfer error in transmission process
-        sif::printDebug("GyroL3GD20H::handleDmaSensorRead: Error transmitting SPI with DMA\n");
-    }
-    // Wait for the transfer to complete
-    while (transferState == TransferStates::WAIT) {
-        TaskFactory::delayTask(1);
-    }
-
-    switch(transferState) {
-    case(TransferStates::SUCCESS): {
-        handleSensorReadout();
-        break;
-    }
-    case(TransferStates::FAILURE): {
-        sif::printWarning("GyroL3GD20H::handleDmaSensorRead: Sensor read failure\n");
-        transferState = TransferStates::FAILURE;
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    default: {
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    }
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-HAL_StatusTypeDef GyroL3GD20H::performDmaTransfer(size_t sendSize) {
-    transferState = TransferStates::WAIT;
-#if STM_USE_PERIPHERAL_TX_BUFFER_MPU_PROTECTION == 0
-    SCB_CleanDCache_by_Addr((uint32_t*)(((uint32_t)txBuffer.data()) & ~(uint32_t)0x1F),
-            txBuffer.size()+32);
-#endif
-
-    // Start SPI transfer via DMA
-    HAL_GPIO_WritePin(GPIOD, GPIO_PIN_14, GPIO_PIN_RESET);
-    return HAL_SPI_TransmitReceive_DMA(spiHandle, txBuffer.data(), rxBuffer.data(), sendSize);
-}
-
-ReturnValue_t GyroL3GD20H::handlePollingTransferInit() {
-    HAL_GPIO_WritePin(GPIOD, GPIO_PIN_14, GPIO_PIN_RESET);
-    auto result = HAL_SPI_TransmitReceive(spiHandle, txBuffer.data(), rxBuffer.data(), 2, 1000);
-    HAL_GPIO_WritePin(GPIOD, GPIO_PIN_14, GPIO_PIN_SET);
-    switch(result) {
-    case(HAL_OK): {
-        sif::printInfo("GyroL3GD20H::initialize: Polling transfer success\n");
-        uint8_t whoAmIVal = rxBuffer[1];
-        if(whoAmIVal != EXPECTED_WHO_AM_I_VAL) {
-            sif::printDebug("GyroL3GD20H::performOperation: "
-                    "Read WHO AM I value %d not equal to expected value!\n", whoAmIVal);
-        }
-        break;
-    }
-    case(HAL_TIMEOUT): {
-        sif::printDebug("GyroL3GD20H::initialize: Polling transfer timeout\n");
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    case(HAL_ERROR): {
-        sif::printDebug("GyroL3GD20H::initialize: Polling transfer failure\n");
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    default: {
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    }
-
-    sif::printInfo("GyroL3GD20H::initialize: Configuring device\n");
-    // Configure the 5 configuration registers
-    uint8_t configRegs[5];
-    prepareConfigRegs(configRegs);
-
-    HAL_GPIO_WritePin(GPIOD, GPIO_PIN_14, GPIO_PIN_RESET);
-    result = HAL_SPI_TransmitReceive(spiHandle, txBuffer.data(), rxBuffer.data(), 6, 1000);
-    HAL_GPIO_WritePin(GPIOD, GPIO_PIN_14, GPIO_PIN_SET);
-    switch(result) {
-    case(HAL_OK): {
-        break;
-    }
-    case(HAL_TIMEOUT): {
-        sif::printDebug("GyroL3GD20H::initialize: Polling transfer timeout\n");
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    case(HAL_ERROR): {
-        sif::printDebug("GyroL3GD20H::initialize: Polling transfer failure\n");
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    default: {
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    }
-
-    txBuffer[0] = CTRL_REG_1 | STM_AUTO_INCREMENT_MASK | STM_READ_MASK;
-    std::memset(txBuffer.data() + 1, 0 , 5);
-
-    HAL_GPIO_WritePin(GPIOD, GPIO_PIN_14, GPIO_PIN_RESET);
-    result = HAL_SPI_TransmitReceive(spiHandle, txBuffer.data(), rxBuffer.data(), 6, 1000);
-    HAL_GPIO_WritePin(GPIOD, GPIO_PIN_14, GPIO_PIN_SET);
-    switch(result) {
-    case(HAL_OK): {
-        if(rxBuffer[1] != configRegs[0] or rxBuffer[2] != configRegs[1] or
-                rxBuffer[3] != configRegs[2] or rxBuffer[4] != configRegs[3] or
-                rxBuffer[5] != configRegs[4]) {
-            sif::printWarning("GyroL3GD20H::initialize: Configuration failure\n");
-        }
-        else {
-            sif::printInfo("GyroL3GD20H::initialize: Configuration success\n");
-        }
-        break;
-    }
-    case(HAL_TIMEOUT): {
-        sif::printDebug("GyroL3GD20H::initialize: Polling transfer timeout\n");
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    case(HAL_ERROR): {
-        sif::printDebug("GyroL3GD20H::initialize: Polling transfer failure\n");
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    default: {
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    }
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t GyroL3GD20H::handlePollingSensorRead() {
-    txBuffer[0] = CTRL_REG_1 | STM_AUTO_INCREMENT_MASK | STM_READ_MASK;
-    std::memset(txBuffer.data() + 1, 0 , 14);
-    HAL_GPIO_WritePin(GPIOD, GPIO_PIN_14, GPIO_PIN_RESET);
-    auto result = HAL_SPI_TransmitReceive(spiHandle, txBuffer.data(), rxBuffer.data(), 15, 1000);
-    HAL_GPIO_WritePin(GPIOD, GPIO_PIN_14, GPIO_PIN_SET);
-
-    switch(result) {
-    case(HAL_OK): {
-        handleSensorReadout();
-        break;
-    }
-    case(HAL_TIMEOUT): {
-        sif::printDebug("GyroL3GD20H::initialize: Polling transfer timeout\n");
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    case(HAL_ERROR): {
-        sif::printDebug("GyroL3GD20H::initialize: Polling transfer failure\n");
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    default: {
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    }
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t GyroL3GD20H::handleInterruptTransferInit() {
-    HAL_GPIO_WritePin(GPIOD, GPIO_PIN_14, GPIO_PIN_RESET);
-    switch(HAL_SPI_TransmitReceive_IT(spiHandle, txBuffer.data(), rxBuffer.data(), 2)) {
-    case(HAL_OK): {
-        sif::printInfo("GyroL3GD20H::initialize: Interrupt transfer success\n");
-        // Wait for the transfer to complete
-        while (transferState == TransferStates::WAIT) {
-            TaskFactory::delayTask(1);
-        }
-
-        uint8_t whoAmIVal = rxBuffer[1];
-        if(whoAmIVal != EXPECTED_WHO_AM_I_VAL) {
-            sif::printDebug("GyroL3GD20H::initialize: "
-                    "Read WHO AM I value %d not equal to expected value!\n", whoAmIVal);
-        }
-        break;
-    }
-    case(HAL_BUSY):
-    case(HAL_ERROR):
-    case(HAL_TIMEOUT): {
-        sif::printDebug("GyroL3GD20H::initialize: Initialization failure using interrupts\n");
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    }
-
-    sif::printInfo("GyroL3GD20H::initialize: Configuring device\n");
-    transferState = TransferStates::WAIT;
-    // Configure the 5 configuration registers
-    uint8_t configRegs[5];
-    prepareConfigRegs(configRegs);
-    HAL_GPIO_WritePin(GPIOD, GPIO_PIN_14, GPIO_PIN_RESET);
-    switch(HAL_SPI_TransmitReceive_IT(spiHandle, txBuffer.data(), rxBuffer.data(), 6)) {
-    case(HAL_OK): {
-        // Wait for the transfer to complete
-        while (transferState == TransferStates::WAIT) {
-            TaskFactory::delayTask(1);
-        }
-        break;
-    }
-    case(HAL_BUSY):
-    case(HAL_ERROR):
-    case(HAL_TIMEOUT): {
-        sif::printDebug("GyroL3GD20H::initialize: Initialization failure using interrupts\n");
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    }
-
-    txBuffer[0] = CTRL_REG_1 | STM_AUTO_INCREMENT_MASK | STM_READ_MASK;
-    std::memset(txBuffer.data() + 1, 0 , 5);
-    transferState = TransferStates::WAIT;
-    HAL_GPIO_WritePin(GPIOD, GPIO_PIN_14, GPIO_PIN_RESET);
-    switch(HAL_SPI_TransmitReceive_IT(spiHandle, txBuffer.data(), rxBuffer.data(), 6)) {
-    case(HAL_OK): {
-        // Wait for the transfer to complete
-        while (transferState == TransferStates::WAIT) {
-            TaskFactory::delayTask(1);
-        }
-        if(rxBuffer[1] != configRegs[0] or rxBuffer[2] != configRegs[1] or
-                rxBuffer[3] != configRegs[2] or rxBuffer[4] != configRegs[3] or
-                rxBuffer[5] != configRegs[4]) {
-            sif::printWarning("GyroL3GD20H::initialize: Configuration failure\n");
-        }
-        else {
-            sif::printInfo("GyroL3GD20H::initialize: Configuration success\n");
-        }
-        break;
-    }
-    case(HAL_BUSY):
-    case(HAL_ERROR):
-    case(HAL_TIMEOUT): {
-        sif::printDebug("GyroL3GD20H::initialize: Initialization failure using interrupts\n");
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    }
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t GyroL3GD20H::handleInterruptSensorRead() {
-    transferState = TransferStates::WAIT;
-    txBuffer[0] = CTRL_REG_1 | STM_AUTO_INCREMENT_MASK | STM_READ_MASK;
-    std::memset(txBuffer.data() + 1, 0 , 14);
-    HAL_GPIO_WritePin(GPIOD, GPIO_PIN_14, GPIO_PIN_RESET);
-    switch(HAL_SPI_TransmitReceive_IT(spiHandle, txBuffer.data(), rxBuffer.data(), 15)) {
-    case(HAL_OK): {
-        // Wait for the transfer to complete
-        while (transferState == TransferStates::WAIT) {
-            TaskFactory::delayTask(1);
-        }
-        handleSensorReadout();
-        break;
-    }
-    case(HAL_BUSY):
-    case(HAL_ERROR):
-    case(HAL_TIMEOUT): {
-        sif::printDebug("GyroL3GD20H::initialize: Sensor read failure using interrupts\n");
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    }
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-void GyroL3GD20H::prepareConfigRegs(uint8_t* configRegs) {
-    // Enable sensor
-    configRegs[0] = 0b00001111;
-    configRegs[1] = 0b00000000;
-    configRegs[2] = 0b00000000;
-    // Big endian select
-    configRegs[3] = 0b01000000;
-    configRegs[4] = 0b00000000;
-
-    txBuffer[0] = CTRL_REG_1 | STM_AUTO_INCREMENT_MASK;
-    std::memcpy(txBuffer.data() + 1, configRegs, 5);
-}
-
-uint8_t GyroL3GD20H::readRegPolling(uint8_t reg) {
-    uint8_t rxBuf[2] = {};
-    uint8_t txBuf[2] = {};
-    txBuf[0] = reg | STM_READ_MASK;
-    HAL_GPIO_WritePin(GPIOD, GPIO_PIN_14, GPIO_PIN_RESET);
-    auto result = HAL_SPI_TransmitReceive(spiHandle, txBuf, rxBuf, 2, 1000);
-    if(result) {};
-    HAL_GPIO_WritePin(GPIOD, GPIO_PIN_14, GPIO_PIN_SET);
-    return rxBuf[1];
-}
-
-void GyroL3GD20H::handleSensorReadout() {
-    uint8_t statusReg = rxBuffer[8];
-    int16_t gyroXRaw = rxBuffer[9] << 8 | rxBuffer[10];
-    float gyroX = static_cast<float>(gyroXRaw) * 0.00875;
-    int16_t gyroYRaw = rxBuffer[11] << 8 | rxBuffer[12];
-    float gyroY =  static_cast<float>(gyroYRaw) * 0.00875;
-    int16_t gyroZRaw = rxBuffer[13] << 8 | rxBuffer[14];
-    float gyroZ =  static_cast<float>(gyroZRaw) * 0.00875;
-    sif::printInfo("Status register: 0b" BYTE_TO_BINARY_PATTERN "\n", BYTE_TO_BINARY(statusReg));
-    sif::printInfo("Gyro X: %f\n", gyroX);
-    sif::printInfo("Gyro Y: %f\n", gyroY);
-    sif::printInfo("Gyro Z: %f\n", gyroZ);
-}
-
-
-void GyroL3GD20H::spiTransferCompleteCallback(SPI_HandleTypeDef *hspi, void* args) {
-    transferState = TransferStates::SUCCESS;
-    HAL_GPIO_WritePin(GPIOD, GPIO_PIN_14, GPIO_PIN_SET);
-    if(GyroL3GD20H::transferMode == spi::TransferModes::DMA) {
-        // Invalidate cache prior to access by CPU
-        SCB_InvalidateDCache_by_Addr ((uint32_t *)GyroL3GD20H::rxBuffer.data(),
-                GyroL3GD20H::recvBufferSize);
-    }
-}
-
-/**
- * @brief  SPI error callbacks.
- * @param  hspi: SPI handle
- * @note   This example shows a simple way to report transfer error, and you can
- *         add your own implementation.
- * @retval None
- */
-void GyroL3GD20H::spiTransferErrorCallback(SPI_HandleTypeDef *hspi, void* args) {
-    transferState = TransferStates::FAILURE;
-}

hal/src/fsfw_hal/stm32h7/devicetest/GyroL3GD20H.h

@@ -1,70 +0,0 @@
-#ifndef FSFW_HAL_STM32H7_DEVICETEST_GYRO_L3GD20H_H_
-#define FSFW_HAL_STM32H7_DEVICETEST_GYRO_L3GD20H_H_
-
-#include "stm32h7xx_hal.h"
-#include "stm32h7xx_hal_spi.h"
-#include "../spi/mspInit.h"
-#include "../spi/spiDefinitions.h"
-
-#include "fsfw/returnvalues/HasReturnvaluesIF.h"
-
-#include <cstdint>
-#include <array>
-
-enum class TransferStates {
-    IDLE,
-    WAIT,
-    SUCCESS,
-    FAILURE
-};
-
-class GyroL3GD20H {
-public:
-    GyroL3GD20H(SPI_HandleTypeDef* spiHandle, spi::TransferModes transferMode);
-    ~GyroL3GD20H();
-
-    ReturnValue_t initialize();
-    ReturnValue_t performOperation();
-
-private:
-
-    const uint8_t WHO_AM_I_REG = 0b00001111;
-    const uint8_t STM_READ_MASK = 0b10000000;
-    const uint8_t STM_AUTO_INCREMENT_MASK = 0b01000000;
-    const uint8_t EXPECTED_WHO_AM_I_VAL = 0b11010111;
-    const uint8_t CTRL_REG_1 = 0b00100000;
-    const uint32_t L3G_RANGE = 245;
-
-    SPI_HandleTypeDef* spiHandle;
-
-    static spi::TransferModes transferMode;
-    static constexpr size_t recvBufferSize = 32 * 10;
-    static std::array<uint8_t, recvBufferSize> rxBuffer;
-    static constexpr size_t txBufferSize = 32;
-    static std::array<uint8_t, txBufferSize> txBuffer;
-
-    ReturnValue_t handleDmaTransferInit();
-    ReturnValue_t handlePollingTransferInit();
-    ReturnValue_t handleInterruptTransferInit();
-
-    ReturnValue_t handleDmaSensorRead();
-    HAL_StatusTypeDef performDmaTransfer(size_t sendSize);
-    ReturnValue_t handlePollingSensorRead();
-    ReturnValue_t handleInterruptSensorRead();
-
-    uint8_t readRegPolling(uint8_t reg);
-
-    static void spiTransferCompleteCallback(SPI_HandleTypeDef *hspi, void* args);
-    static void spiTransferErrorCallback(SPI_HandleTypeDef *hspi, void* args);
-
-
-    void prepareConfigRegs(uint8_t* configRegs);
-    void handleSensorReadout();
-
-
-    DMA_HandleTypeDef* txDmaHandle = {};
-    DMA_HandleTypeDef* rxDmaHandle = {};
-    spi::MspCfgBase* mspCfg = {};
-};
-
-#endif /*  FSFW_HAL_STM32H7_DEVICETEST_GYRO_L3GD20H_H_ */

hal/src/fsfw_hal/stm32h7/dma.cpp

@@ -1,84 +0,0 @@
-#include <fsfw_hal/stm32h7/dma.h>
-
-#include <cstdint>
-#include <cstddef>
-
-user_handler_t DMA_1_USER_HANDLERS[8];
-user_args_t DMA_1_USER_ARGS[8];
-
-user_handler_t DMA_2_USER_HANDLERS[8];
-user_args_t DMA_2_USER_ARGS[8];
-
-void dma::assignDmaUserHandler(DMAIndexes dma_idx, DMAStreams stream_idx,
-        user_handler_t user_handler, user_args_t user_args) {
-    if(dma_idx == DMA_1) {
-        DMA_1_USER_HANDLERS[stream_idx] = user_handler;
-        DMA_1_USER_ARGS[stream_idx] = user_args;
-    }
-    else if(dma_idx == DMA_2) {
-        DMA_2_USER_HANDLERS[stream_idx] = user_handler;
-        DMA_2_USER_ARGS[stream_idx] = user_args;
-    }
-}
-
-// The interrupt handlers in the format required for the IRQ vector table
-
-/* Do not change these function names! They need to be exactly equal to the name of the functions
-defined in the startup_stm32h743xx.s files! */
-
-#define GENERIC_DMA_IRQ_HANDLER(DMA_IDX, STREAM_IDX) \
-    if(DMA_##DMA_IDX##_USER_HANDLERS[STREAM_IDX] != NULL) { \
-        DMA_##DMA_IDX##_USER_HANDLERS[STREAM_IDX](DMA_##DMA_IDX##_USER_ARGS[STREAM_IDX]); \
-        return; \
-    } \
-    Default_Handler() \
-
-extern"C" void DMA1_Stream0_IRQHandler() {
-    GENERIC_DMA_IRQ_HANDLER(1, 0);
-}
-extern"C" void DMA1_Stream1_IRQHandler() {
-    GENERIC_DMA_IRQ_HANDLER(1, 1);
-}
-extern"C" void DMA1_Stream2_IRQHandler() {
-    GENERIC_DMA_IRQ_HANDLER(1, 2);
-}
-extern"C" void DMA1_Stream3_IRQHandler() {
-    GENERIC_DMA_IRQ_HANDLER(1, 3);
-}
-extern"C" void DMA1_Stream4_IRQHandler() {
-    GENERIC_DMA_IRQ_HANDLER(1, 4);
-}
-extern"C" void DMA1_Stream5_IRQHandler() {
-    GENERIC_DMA_IRQ_HANDLER(1, 5);
-}
-extern"C" void DMA1_Stream6_IRQHandler() {
-    GENERIC_DMA_IRQ_HANDLER(1, 6);
-}
-extern"C" void DMA1_Stream7_IRQHandler() {
-    GENERIC_DMA_IRQ_HANDLER(1, 7);
-}
-
-extern"C" void DMA2_Stream0_IRQHandler() {
-    GENERIC_DMA_IRQ_HANDLER(2, 0);
-}
-extern"C" void DMA2_Stream1_IRQHandler() {
-    GENERIC_DMA_IRQ_HANDLER(2, 1);
-}
-extern"C" void DMA2_Stream2_IRQHandler() {
-    GENERIC_DMA_IRQ_HANDLER(2, 2);
-}
-extern"C" void DMA2_Stream3_IRQHandler() {
-    GENERIC_DMA_IRQ_HANDLER(2, 3);
-}
-extern"C" void DMA2_Stream4_IRQHandler() {
-    GENERIC_DMA_IRQ_HANDLER(2, 4);
-}
-extern"C" void DMA2_Stream5_IRQHandler() {
-    GENERIC_DMA_IRQ_HANDLER(2, 5);
-}
-extern"C" void DMA2_Stream6_IRQHandler() {
-    GENERIC_DMA_IRQ_HANDLER(2, 6);
-}
-extern"C" void DMA2_Stream7_IRQHandler() {
-    GENERIC_DMA_IRQ_HANDLER(2, 7);
-}

hal/src/fsfw_hal/stm32h7/gpio/gpio.cpp

@@ -1,71 +0,0 @@
-#include "fsfw_hal/stm32h7/gpio/gpio.h"
-
-#include "stm32h7xx_hal_rcc.h"
-
-void gpio::initializeGpioClock(GPIO_TypeDef* gpioPort) {
-#ifdef GPIOA
-    if(gpioPort == GPIOA) {
-        __HAL_RCC_GPIOA_CLK_ENABLE();
-    }
-#endif
-
-#ifdef GPIOB
-    if(gpioPort == GPIOB) {
-        __HAL_RCC_GPIOB_CLK_ENABLE();
-    }
-#endif
-
-#ifdef GPIOC
-    if(gpioPort == GPIOC) {
-        __HAL_RCC_GPIOC_CLK_ENABLE();
-    }
-#endif
-
-#ifdef GPIOD
-    if(gpioPort == GPIOD) {
-        __HAL_RCC_GPIOD_CLK_ENABLE();
-    }
-#endif
-
-#ifdef GPIOE
-    if(gpioPort == GPIOE) {
-        __HAL_RCC_GPIOE_CLK_ENABLE();
-    }
-#endif
-
-#ifdef GPIOF
-    if(gpioPort == GPIOF) {
-        __HAL_RCC_GPIOF_CLK_ENABLE();
-    }
-#endif
-
-#ifdef GPIOG
-    if(gpioPort == GPIOG) {
-        __HAL_RCC_GPIOG_CLK_ENABLE();
-    }
-#endif
-
-#ifdef GPIOH
-    if(gpioPort == GPIOH) {
-        __HAL_RCC_GPIOH_CLK_ENABLE();
-    }
-#endif
-
-#ifdef GPIOI
-    if(gpioPort == GPIOI) {
-        __HAL_RCC_GPIOI_CLK_ENABLE();
-    }
-#endif
-
-#ifdef GPIOJ
-    if(gpioPort == GPIOJ) {
-        __HAL_RCC_GPIOJ_CLK_ENABLE();
-    }
-#endif
-
-#ifdef GPIOK
-    if(gpioPort == GPIOK) {
-        __HAL_RCC_GPIOK_CLK_ENABLE();
-    }
-#endif
-}

hal/src/fsfw_hal/stm32h7/spi/SpiComIF.cpp

@@ -1,480 +0,0 @@
-#include "fsfw_hal/stm32h7/spi/SpiComIF.h"
-#include "fsfw_hal/stm32h7/spi/SpiCookie.h"
-
-#include "fsfw/tasks/SemaphoreFactory.h"
-#include "fsfw_hal/stm32h7/spi/spiCore.h"
-#include "fsfw_hal/stm32h7/spi/spiInterrupts.h"
-#include "fsfw_hal/stm32h7/spi/mspInit.h"
-#include "fsfw_hal/stm32h7/gpio/gpio.h"
-
-// FreeRTOS required special Semaphore handling from an ISR. Therefore, we use the concrete
-// instance here, because RTEMS and FreeRTOS are the only relevant OSALs currently
-// and it is not trivial to add a releaseFromISR to the SemaphoreIF
-#if defined FSFW_OSAL_RTEMS
-#include "fsfw/osal/rtems/BinarySemaphore.h"
-#elif defined FSFW_OSAL_FREERTOS
-#include "fsfw/osal/freertos/TaskManagement.h"
-#include "fsfw/osal/freertos/BinarySemaphore.h"
-#endif
-
-#include "stm32h7xx_hal_gpio.h"
-
-SpiComIF::SpiComIF(object_id_t objectId): SystemObject(objectId) {
-    void* irqArgsVoided = reinterpret_cast<void*>(&irqArgs);
-    spi::assignTransferRxTxCompleteCallback(&spiTransferCompleteCallback, irqArgsVoided);
-    spi::assignTransferRxCompleteCallback(&spiTransferRxCompleteCallback, irqArgsVoided);
-    spi::assignTransferTxCompleteCallback(&spiTransferTxCompleteCallback, irqArgsVoided);
-    spi::assignTransferErrorCallback(&spiTransferErrorCallback, irqArgsVoided);
-}
-
-void SpiComIF::configureCacheMaintenanceOnTxBuffer(bool enable) {
-    this->cacheMaintenanceOnTxBuffer = enable;
-}
-
-void SpiComIF::addDmaHandles(DMA_HandleTypeDef *txHandle, DMA_HandleTypeDef *rxHandle) {
-    spi::setDmaHandles(txHandle, rxHandle);
-}
-
-ReturnValue_t SpiComIF::initialize() {
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t SpiComIF::initializeInterface(CookieIF *cookie) {
-    SpiCookie* spiCookie = dynamic_cast<SpiCookie*>(cookie);
-    if(spiCookie == nullptr) {
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-        sif::error < "SpiComIF::initializeInterface: Invalid cookie" << std::endl;
-#else
-        sif::printError("SpiComIF::initializeInterface: Invalid cookie\n");
-#endif
-        return NULLPOINTER;
-    }
-    auto transferMode = spiCookie->getTransferMode();
-
-    if(transferMode == spi::TransferModes::DMA) {
-        DMA_HandleTypeDef *txHandle = nullptr;
-        DMA_HandleTypeDef *rxHandle = nullptr;
-        spi::getDmaHandles(&txHandle, &rxHandle);
-        if(txHandle == nullptr or rxHandle == nullptr) {
-            sif::printError("SpiComIF::initialize: DMA handles not set!\n");
-            return HasReturnvaluesIF::RETURN_FAILED;
-        }
-    }
-    // This semaphore ensures thread-safety for a given bus
-    spiSemaphore = dynamic_cast<BinarySemaphore*>(
-            SemaphoreFactory::instance()->createBinarySemaphore());
-    address_t spiAddress = spiCookie->getDeviceAddress();
-
-    auto iter = spiDeviceMap.find(spiAddress);
-    if(iter == spiDeviceMap.end()) {
-        size_t bufferSize = spiCookie->getMaxRecvSize();
-        auto statusPair = spiDeviceMap.emplace(spiAddress, SpiInstance(bufferSize));
-        if (not statusPair.second) {
-#if FSFW_VERBOSE_LEVEL >= 1
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-            sif::error << "SpiComIF::initializeInterface: Failed to insert device with address " <<
-                    spiAddress << "to SPI device map" << std::endl;
-#else
-            sif::printError("SpiComIF::initializeInterface: Failed to insert device with address "
-                    "%lu to SPI device map\n", static_cast<unsigned long>(spiAddress));
-#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
-#endif /* FSFW_VERBOSE_LEVEL >= 1 */
-            return HasReturnvaluesIF::RETURN_FAILED;
-        }
-    }
-    auto gpioPin = spiCookie->getChipSelectGpioPin();
-    auto gpioPort = spiCookie->getChipSelectGpioPort();
-
-    SPI_HandleTypeDef& spiHandle = spiCookie->getSpiHandle();
-
-    auto spiIdx = spiCookie->getSpiIdx();
-    if(spiIdx == spi::SpiBus::SPI_1) {
-#ifdef SPI1
-        spiHandle.Instance = SPI1;
-#endif
-    }
-    else if(spiIdx == spi::SpiBus::SPI_2) {
-#ifdef SPI2
-        spiHandle.Instance = SPI2;
-#endif
-    }
-    else {
-        printCfgError("SPI Bus Index");
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-
-    auto mspCfg = spiCookie->getMspCfg();
-
-    if(transferMode == spi::TransferModes::POLLING) {
-        auto typedCfg = dynamic_cast<spi::MspPollingConfigStruct*>(mspCfg);
-        if(typedCfg == nullptr) {
-            printCfgError("Polling MSP");
-            return HasReturnvaluesIF::RETURN_FAILED;
-        }
-        spi::setSpiPollingMspFunctions(typedCfg);
-    }
-    else if(transferMode == spi::TransferModes::INTERRUPT) {
-        auto typedCfg = dynamic_cast<spi::MspIrqConfigStruct*>(mspCfg);
-        if(typedCfg == nullptr) {
-            printCfgError("IRQ MSP");
-            return HasReturnvaluesIF::RETURN_FAILED;
-        }
-        spi::setSpiIrqMspFunctions(typedCfg);
-    }
-    else if(transferMode == spi::TransferModes::DMA) {
-        auto typedCfg = dynamic_cast<spi::MspDmaConfigStruct*>(mspCfg);
-        if(typedCfg == nullptr) {
-            printCfgError("DMA MSP");
-            return HasReturnvaluesIF::RETURN_FAILED;
-        }
-        // Check DMA handles
-        DMA_HandleTypeDef* txHandle = nullptr;
-        DMA_HandleTypeDef* rxHandle = nullptr;
-        spi::getDmaHandles(&txHandle, &rxHandle);
-        if(txHandle == nullptr or rxHandle == nullptr) {
-            printCfgError("DMA Handle");
-            return HasReturnvaluesIF::RETURN_FAILED;
-        }
-        spi::setSpiDmaMspFunctions(typedCfg);
-    }
-
-    if(gpioPort != nullptr) {
-        gpio::initializeGpioClock(gpioPort);
-        GPIO_InitTypeDef chipSelect = {};
-        chipSelect.Pin = gpioPin;
-        chipSelect.Mode = GPIO_MODE_OUTPUT_PP;
-        HAL_GPIO_Init(gpioPort, &chipSelect);
-        HAL_GPIO_WritePin(gpioPort, gpioPin, GPIO_PIN_SET);
-    }
-
-    if(HAL_SPI_Init(&spiHandle) != HAL_OK) {
-        sif::printWarning("SpiComIF::initialize: Error initializing SPI\n");
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    // The MSP configuration struct is not required anymore
-    spiCookie->deleteMspCfg();
-
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t SpiComIF::sendMessage(CookieIF *cookie, const uint8_t *sendData, size_t sendLen) {
-    SpiCookie* spiCookie = dynamic_cast<SpiCookie*>(cookie);
-    if(spiCookie == nullptr) {
-        return NULLPOINTER;
-    }
-
-    SPI_HandleTypeDef& spiHandle = spiCookie->getSpiHandle();
-
-    auto iter = spiDeviceMap.find(spiCookie->getDeviceAddress());
-    if(iter == spiDeviceMap.end()) {
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    iter->second.currentTransferLen = sendLen;
-
-    auto transferMode = spiCookie->getTransferMode();
-    switch(spiCookie->getTransferState()) {
-    case(spi::TransferStates::IDLE): {
-        break;
-    }
-    case(spi::TransferStates::WAIT):
-    case(spi::TransferStates::FAILURE):
-    case(spi::TransferStates::SUCCESS):
-    default: {
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    }
-
-    switch(transferMode) {
-    case(spi::TransferModes::POLLING): {
-        return handlePollingSendOperation(iter->second.replyBuffer.data(), spiHandle, *spiCookie,
-                sendData, sendLen);
-    }
-    case(spi::TransferModes::INTERRUPT): {
-        return handleInterruptSendOperation(iter->second.replyBuffer.data(), spiHandle, *spiCookie,
-                sendData, sendLen);
-    }
-    case(spi::TransferModes::DMA): {
-        return handleDmaSendOperation(iter->second.replyBuffer.data(), spiHandle, *spiCookie,
-                sendData, sendLen);
-    }
-    }
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t SpiComIF::getSendSuccess(CookieIF *cookie) {
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t SpiComIF::requestReceiveMessage(CookieIF *cookie, size_t requestLen) {
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t SpiComIF::readReceivedMessage(CookieIF *cookie, uint8_t **buffer, size_t *size) {
-    SpiCookie* spiCookie = dynamic_cast<SpiCookie*>(cookie);
-    if(spiCookie == nullptr) {
-        return NULLPOINTER;
-    }
-    switch(spiCookie->getTransferState()) {
-    case(spi::TransferStates::SUCCESS): {
-        auto iter = spiDeviceMap.find(spiCookie->getDeviceAddress());
-        if(iter == spiDeviceMap.end()) {
-            return HasReturnvaluesIF::RETURN_FAILED;
-        }
-        *buffer = iter->second.replyBuffer.data();
-        *size = iter->second.currentTransferLen;
-        spiCookie->setTransferState(spi::TransferStates::IDLE);
-        break;
-    }
-    case(spi::TransferStates::FAILURE): {
-#if FSFW_VERBOSE_LEVEL >= 1
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-        sif::warning << "SpiComIF::readReceivedMessage: Transfer failure" << std::endl;
-#else
-        sif::printWarning("SpiComIF::readReceivedMessage: Transfer failure\n");
-#endif
-#endif
-        spiCookie->setTransferState(spi::TransferStates::IDLE);
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    case(spi::TransferStates::WAIT):
-    case(spi::TransferStates::IDLE): {
-        break;
-    }
-    default: {
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    }
-
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-void SpiComIF::setDefaultPollingTimeout(dur_millis_t timeout) {
-    this->defaultPollingTimeout = timeout;
-}
-
-ReturnValue_t SpiComIF::handlePollingSendOperation(uint8_t* recvPtr, SPI_HandleTypeDef& spiHandle,
-        SpiCookie& spiCookie, const uint8_t *sendData, size_t sendLen) {
-    auto gpioPort = spiCookie.getChipSelectGpioPort();
-    auto gpioPin = spiCookie.getChipSelectGpioPin();
-    auto returnval = spiSemaphore->acquire(timeoutType, timeoutMs);
-    if(returnval != HasReturnvaluesIF::RETURN_OK) {
-        return returnval;
-    }
-    spiCookie.setTransferState(spi::TransferStates::WAIT);
-    if(gpioPort != nullptr) {
-        HAL_GPIO_WritePin(gpioPort, gpioPin, GPIO_PIN_RESET);
-    }
-
-    auto result = HAL_SPI_TransmitReceive(&spiHandle, const_cast<uint8_t*>(sendData),
-            recvPtr, sendLen, defaultPollingTimeout);
-    if(gpioPort != nullptr) {
-        HAL_GPIO_WritePin(gpioPort, gpioPin,  GPIO_PIN_SET);
-    }
-    spiSemaphore->release();
-    switch(result) {
-    case(HAL_OK): {
-        spiCookie.setTransferState(spi::TransferStates::SUCCESS);
-        break;
-    }
-    case(HAL_TIMEOUT): {
-#if FSFW_VERBOSE_LEVEL >= 1
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-        sif::warning << "SpiComIF::sendMessage: Polling Mode | Timeout for SPI device" <<
-                spiCookie->getDeviceAddress() << std::endl;
-#else
-        sif::printWarning("SpiComIF::sendMessage: Polling Mode | Timeout for SPI device %d\n",
-                spiCookie.getDeviceAddress());
-#endif
-#endif
-        spiCookie.setTransferState(spi::TransferStates::FAILURE);
-        return spi::HAL_TIMEOUT_RETVAL;
-    }
-    case(HAL_ERROR):
-    default: {
-#if FSFW_VERBOSE_LEVEL >= 1
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-        sif::warning << "SpiComIF::sendMessage: Polling Mode | HAL error for SPI device" <<
-                spiCookie->getDeviceAddress() << std::endl;
-#else
-        sif::printWarning("SpiComIF::sendMessage: Polling Mode | HAL error for SPI device %d\n",
-                spiCookie.getDeviceAddress());
-#endif
-#endif
-        spiCookie.setTransferState(spi::TransferStates::FAILURE);
-        return spi::HAL_ERROR_RETVAL;
-    }
-    }
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t SpiComIF::handleInterruptSendOperation(uint8_t* recvPtr, SPI_HandleTypeDef& spiHandle,
-        SpiCookie& spiCookie, const uint8_t * sendData, size_t sendLen) {
-    return handleIrqSendOperation(recvPtr, spiHandle, spiCookie, sendData, sendLen);
-}
-
-ReturnValue_t SpiComIF::handleDmaSendOperation(uint8_t* recvPtr, SPI_HandleTypeDef& spiHandle,
-        SpiCookie& spiCookie, const uint8_t * sendData, size_t sendLen) {
-    return handleIrqSendOperation(recvPtr, spiHandle, spiCookie, sendData, sendLen);
-}
-
-ReturnValue_t SpiComIF::handleIrqSendOperation(uint8_t *recvPtr, SPI_HandleTypeDef& spiHandle,
-        SpiCookie& spiCookie, const uint8_t *sendData, size_t sendLen) {
-    ReturnValue_t result = genericIrqSendSetup(recvPtr, spiHandle, spiCookie, sendData, sendLen);
-    if(result != HasReturnvaluesIF::RETURN_OK) {
-        return result;
-    }
-    // yet another HAL driver which is not const-correct..
-    HAL_StatusTypeDef status = HAL_OK;
-    auto transferMode = spiCookie.getTransferMode();
-    if(transferMode == spi::TransferModes::DMA) {
-        if(cacheMaintenanceOnTxBuffer) {
-            /* Clean D-cache. Make sure the address is 32-byte aligned and add 32-bytes to length,
-            in case it overlaps cacheline */
-            SCB_CleanDCache_by_Addr((uint32_t*)(((uint32_t) sendData ) & ~(uint32_t)0x1F),
-                    sendLen + 32);
-        }
-        status = HAL_SPI_TransmitReceive_DMA(&spiHandle, const_cast<uint8_t*>(sendData),
-                currentRecvPtr, sendLen);
-    }
-    else {
-        status = HAL_SPI_TransmitReceive_IT(&spiHandle, const_cast<uint8_t*>(sendData),
-                currentRecvPtr, sendLen);
-    }
-    switch(status) {
-    case(HAL_OK): {
-        break;
-    }
-    default: {
-        return halErrorHandler(status, transferMode);
-    }
-    }
-    return result;
-}
-
-ReturnValue_t SpiComIF::halErrorHandler(HAL_StatusTypeDef status, spi::TransferModes transferMode) {
-    char modeString[10];
-    if(transferMode == spi::TransferModes::DMA) {
-        std::snprintf(modeString, sizeof(modeString), "Dma");
-    }
-    else {
-        std::snprintf(modeString, sizeof(modeString), "Interrupt");
-    }
-    sif::printWarning("SpiComIF::handle%sSendOperation: HAL error %d occured\n", modeString,
-            status);
-    switch(status) {
-    case(HAL_BUSY): {
-        return spi::HAL_BUSY_RETVAL;
-    }
-    case(HAL_ERROR): {
-        return spi::HAL_ERROR_RETVAL;
-    }
-    case(HAL_TIMEOUT): {
-        return spi::HAL_TIMEOUT_RETVAL;
-    }
-    default: {
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    }
-}
-
-
-ReturnValue_t SpiComIF::genericIrqSendSetup(uint8_t *recvPtr, SPI_HandleTypeDef& spiHandle,
-        SpiCookie& spiCookie, const uint8_t *sendData, size_t sendLen) {
-    currentRecvPtr = recvPtr;
-    currentRecvBuffSize = sendLen;
-
-    // Take the semaphore which will be released by a callback when the transfer is complete
-    ReturnValue_t result = spiSemaphore->acquire(SemaphoreIF::TimeoutType::WAITING, timeoutMs);
-    if(result != HasReturnvaluesIF::RETURN_OK) {
-        // Configuration error
-        sif::printWarning("SpiComIF::handleInterruptSendOperation: Semaphore "
-                "could not be acquired after %d ms\n", timeoutMs);
-        return result;
-    }
-    // Cache the current SPI handle in any case
-    spi::setSpiHandle(&spiHandle);
-    // Assign the IRQ arguments for the user callbacks
-    irqArgs.comIF = this;
-    irqArgs.spiCookie = &spiCookie;
-    // The SPI handle is passed to the default SPI callback as a void argument. This callback
-    // is different from the user callbacks specified above!
-    spi::assignSpiUserArgs(spiCookie.getSpiIdx(), reinterpret_cast<void*>(&spiHandle));
-    if(spiCookie.getChipSelectGpioPort() != nullptr) {
-        HAL_GPIO_WritePin(spiCookie.getChipSelectGpioPort(), spiCookie.getChipSelectGpioPin(),
-                GPIO_PIN_RESET);
-    }
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-void SpiComIF::spiTransferTxCompleteCallback(SPI_HandleTypeDef *hspi, void *args) {
-    genericIrqHandler(args, spi::TransferStates::SUCCESS);
-}
-
-void SpiComIF::spiTransferRxCompleteCallback(SPI_HandleTypeDef *hspi, void *args) {
-    genericIrqHandler(args, spi::TransferStates::SUCCESS);
-}
-
-void SpiComIF::spiTransferCompleteCallback(SPI_HandleTypeDef *hspi, void *args) {
-    genericIrqHandler(args, spi::TransferStates::SUCCESS);
-}
-
-void SpiComIF::spiTransferErrorCallback(SPI_HandleTypeDef *hspi, void *args) {
-    genericIrqHandler(args, spi::TransferStates::FAILURE);
-}
-
-void SpiComIF::genericIrqHandler(void *irqArgsVoid, spi::TransferStates targetState) {
-    IrqArgs* irqArgs = reinterpret_cast<IrqArgs*>(irqArgsVoid);
-    if(irqArgs == nullptr) {
-        return;
-    }
-    SpiCookie* spiCookie = irqArgs->spiCookie;
-    SpiComIF* comIF = irqArgs->comIF;
-    if(spiCookie == nullptr or comIF == nullptr) {
-        return;
-    }
-
-    spiCookie->setTransferState(targetState);
-
-    if(spiCookie->getChipSelectGpioPort() != nullptr) {
-        // Pull CS pin high again
-        HAL_GPIO_WritePin(spiCookie->getChipSelectGpioPort(), spiCookie->getChipSelectGpioPin(),
-                GPIO_PIN_SET);
-    }
-
-
-#if defined FSFW_OSAL_FREERTOS
-    // Release the task semaphore
-    BaseType_t taskWoken = pdFALSE;
-    ReturnValue_t result = BinarySemaphore::releaseFromISR(comIF->spiSemaphore->getSemaphore(),
-            &taskWoken);
-#elif defined FSFW_OSAL_RTEMS
-    ReturnValue_t result = comIF->spiSemaphore->release();
-#endif
-    if(result != HasReturnvaluesIF::RETURN_OK) {
-        // Configuration error
-        printf("SpiComIF::genericIrqHandler: Failure releasing Semaphore!\n");
-    }
-
-    // Perform cache maintenance operation for DMA transfers
-    if(spiCookie->getTransferMode() == spi::TransferModes::DMA) {
-        // Invalidate cache prior to access by CPU
-        SCB_InvalidateDCache_by_Addr ((uint32_t *) comIF->currentRecvPtr,
-                comIF->currentRecvBuffSize);
-    }
-#if defined FSFW_OSAL_FREERTOS
-    /* Request a context switch if the SPI ComIF task was woken up and has a higher priority
-    than the currently running task */
-    if(taskWoken == pdTRUE) {
-        TaskManagement::requestContextSwitch(CallContext::ISR);
-    }
-#endif
-}
-
-void SpiComIF::printCfgError(const char *const type) {
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-    sif::warning << "SpiComIF::initializeInterface: Invalid " << type << " configuration"
-            << std::endl;
-#else
-    sif::printWarning("SpiComIF::initializeInterface: Invalid %s configuration\n", type);
-#endif
-}

hal/src/fsfw_hal/stm32h7/spi/SpiComIF.h

@@ -1,129 +0,0 @@
-#ifndef FSFW_HAL_STM32H7_SPI_SPICOMIF_H_
-#define FSFW_HAL_STM32H7_SPI_SPICOMIF_H_
-
-#include "fsfw/tasks/SemaphoreIF.h"
-#include "fsfw/devicehandlers/DeviceCommunicationIF.h"
-#include "fsfw/objectmanager/SystemObject.h"
-
-#include "fsfw_hal/stm32h7/spi/spiDefinitions.h"
-#include "stm32h7xx_hal_spi.h"
-#include "stm32h743xx.h"
-
-#include <vector>
-#include <map>
-
-class SpiCookie;
-class BinarySemaphore;
-
-/**
- * @brief   This communication interface allows using generic device handlers with using
- *          the STM32H7 SPI peripherals
- * @details
- * This communication interface supports all three major communcation modes:
- *  - Polling: Simple, but not recommended to real use-cases, blocks the CPU
- *  - Interrupt: Good for small data only arriving occasionally
- *  - DMA: Good for large data which also occur regularly. Please note that the number
- *    of DMA channels in limited
- * The device specific information is usually kept in the SpiCookie class. The current
- * implementation limits the transfer mode for a given SPI bus.
- * @author  R. Mueller
- */
-class SpiComIF:
-        public SystemObject,
-        public DeviceCommunicationIF {
-public:
-    /**
-     * Create a SPI communication interface for the given SPI peripheral (spiInstance)
-     * @param objectId
-     * @param spiInstance
-     * @param spiHandle
-     * @param transferMode
-     */
-    SpiComIF(object_id_t objectId);
-
-    /**
-     * Allows the user to disable cache maintenance on the TX buffer. This can be done if the
-     * TX buffers are places and MPU protected properly like specified in this link:
-     * https://community.st.com/s/article/FAQ-DMA-is-not-working-on-STM32H7-devices
-     * The cache maintenace is enabled by default.
-     * @param enable
-     */
-    void configureCacheMaintenanceOnTxBuffer(bool enable);
-
-    void setDefaultPollingTimeout(dur_millis_t timeout);
-
-    /**
-     * Add the DMA handles. These need to be set in the DMA transfer mode is used.
-     * @param txHandle
-     * @param rxHandle
-     */
-    void addDmaHandles(DMA_HandleTypeDef* txHandle, DMA_HandleTypeDef* rxHandle);
-
-    ReturnValue_t initialize() override;
-
-    // DeviceCommunicationIF overrides
-    virtual ReturnValue_t initializeInterface(CookieIF * cookie) override;
-    virtual ReturnValue_t sendMessage(CookieIF *cookie,
-            const uint8_t * sendData, size_t sendLen) override;
-    virtual ReturnValue_t getSendSuccess(CookieIF *cookie) override;
-    virtual ReturnValue_t requestReceiveMessage(CookieIF *cookie,
-            size_t requestLen) override;
-    virtual ReturnValue_t readReceivedMessage(CookieIF *cookie,
-            uint8_t **buffer, size_t *size) override;
-
-protected:
-
-    struct SpiInstance {
-        SpiInstance(size_t maxRecvSize): replyBuffer(std::vector<uint8_t>(maxRecvSize)) {}
-        std::vector<uint8_t> replyBuffer;
-        size_t currentTransferLen = 0;
-    };
-
-    struct IrqArgs {
-        SpiComIF* comIF = nullptr;
-        SpiCookie* spiCookie = nullptr;
-    };
-
-    IrqArgs irqArgs;
-
-    uint32_t defaultPollingTimeout = 50;
-
-    SemaphoreIF::TimeoutType timeoutType = SemaphoreIF::TimeoutType::WAITING;
-    dur_millis_t timeoutMs = 20;
-
-    BinarySemaphore* spiSemaphore = nullptr;
-    bool cacheMaintenanceOnTxBuffer = true;
-
-    using SpiDeviceMap = std::map<address_t, SpiInstance>;
-    using SpiDeviceMapIter = SpiDeviceMap::iterator;
-
-    uint8_t* currentRecvPtr = nullptr;
-    size_t currentRecvBuffSize = 0;
-
-    SpiDeviceMap spiDeviceMap;
-
-    ReturnValue_t handlePollingSendOperation(uint8_t* recvPtr, SPI_HandleTypeDef& spiHandle,
-            SpiCookie& spiCookie, const uint8_t * sendData, size_t sendLen);
-    ReturnValue_t handleInterruptSendOperation(uint8_t* recvPtr, SPI_HandleTypeDef& spiHandle,
-            SpiCookie& spiCookie, const uint8_t * sendData, size_t sendLen);
-    ReturnValue_t handleDmaSendOperation(uint8_t* recvPtr, SPI_HandleTypeDef& spiHandle,
-            SpiCookie& spiCookie, const uint8_t * sendData, size_t sendLen);
-    ReturnValue_t handleIrqSendOperation(uint8_t* recvPtr, SPI_HandleTypeDef& spiHandle,
-            SpiCookie& spiCookie, const uint8_t * sendData, size_t sendLen);
-    ReturnValue_t genericIrqSendSetup(uint8_t* recvPtr, SPI_HandleTypeDef& spiHandle,
-            SpiCookie& spiCookie, const uint8_t * sendData, size_t sendLen);
-    ReturnValue_t halErrorHandler(HAL_StatusTypeDef status, spi::TransferModes transferMode);
-
-    static void spiTransferTxCompleteCallback(SPI_HandleTypeDef *hspi, void* args);
-    static void spiTransferRxCompleteCallback(SPI_HandleTypeDef *hspi, void* args);
-    static void spiTransferCompleteCallback(SPI_HandleTypeDef *hspi, void* args);
-    static void spiTransferErrorCallback(SPI_HandleTypeDef *hspi, void* args);
-
-    static void genericIrqHandler(void* irqArgs, spi::TransferStates targetState);
-
-    void printCfgError(const char* const type);
-};
-
-
-
-#endif /* FSFW_HAL_STM32H7_SPI_SPICOMIF_H_ */

hal/src/fsfw_hal/stm32h7/spi/SpiCookie.cpp

@@ -1,78 +0,0 @@
-#include "fsfw_hal/stm32h7/spi/SpiCookie.h"
-
-
-SpiCookie::SpiCookie(address_t deviceAddress, spi::SpiBus spiIdx, spi::TransferModes transferMode,
-        spi::MspCfgBase* mspCfg, uint32_t spiSpeed, spi::SpiModes spiMode,
-        size_t maxRecvSize, stm32h7::GpioCfg csGpio):
-        deviceAddress(deviceAddress), spiIdx(spiIdx), spiSpeed(spiSpeed), spiMode(spiMode),
-        transferMode(transferMode), csGpio(csGpio),
-        mspCfg(mspCfg), maxRecvSize(maxRecvSize) {
-    spiHandle.Init.DataSize          = SPI_DATASIZE_8BIT;
-    spiHandle.Init.FirstBit          = SPI_FIRSTBIT_MSB;
-    spiHandle.Init.TIMode            = SPI_TIMODE_DISABLE;
-    spiHandle.Init.CRCCalculation    = SPI_CRCCALCULATION_DISABLE;
-    spiHandle.Init.CRCPolynomial     = 7;
-    spiHandle.Init.CRCLength         = SPI_CRC_LENGTH_8BIT;
-    spiHandle.Init.NSS               = SPI_NSS_SOFT;
-    spiHandle.Init.NSSPMode          = SPI_NSS_PULSE_DISABLE;
-    spiHandle.Init.Direction         = SPI_DIRECTION_2LINES;
-    // Recommended setting to avoid glitches
-    spiHandle.Init.MasterKeepIOState = SPI_MASTER_KEEP_IO_STATE_ENABLE;
-    spiHandle.Init.Mode = SPI_MODE_MASTER;
-    spi::assignSpiMode(spiMode, spiHandle);
-    spiHandle.Init.BaudRatePrescaler = spi::getPrescaler(HAL_RCC_GetHCLKFreq(), spiSpeed);
-}
-
-uint16_t SpiCookie::getChipSelectGpioPin() const {
-    return csGpio.pin;
-}
-
-GPIO_TypeDef* SpiCookie::getChipSelectGpioPort() {
-    return csGpio.port;
-}
-
-address_t SpiCookie::getDeviceAddress() const {
-    return deviceAddress;
-}
-
-spi::SpiBus SpiCookie::getSpiIdx() const {
-    return spiIdx;
-}
-
-spi::SpiModes SpiCookie::getSpiMode() const {
-    return spiMode;
-}
-
-uint32_t SpiCookie::getSpiSpeed() const {
-    return spiSpeed;
-}
-
-size_t SpiCookie::getMaxRecvSize() const {
-    return maxRecvSize;
-}
-
-SPI_HandleTypeDef& SpiCookie::getSpiHandle() {
-    return spiHandle;
-}
-
-spi::MspCfgBase* SpiCookie::getMspCfg() {
-    return mspCfg;
-}
-
-void SpiCookie::deleteMspCfg() {
-    if(mspCfg != nullptr) {
-        delete mspCfg;
-    }
-}
-
-spi::TransferModes SpiCookie::getTransferMode() const {
-    return transferMode;
-}
-
-void SpiCookie::setTransferState(spi::TransferStates transferState) {
-    this->transferState = transferState;
-}
-
-spi::TransferStates SpiCookie::getTransferState() const {
-    return this->transferState;
-}

hal/src/fsfw_hal/stm32h7/spi/SpiCookie.h

@@ -1,80 +0,0 @@
-#ifndef FSFW_HAL_STM32H7_SPI_SPICOOKIE_H_
-#define FSFW_HAL_STM32H7_SPI_SPICOOKIE_H_
-
-#include "spiDefinitions.h"
-#include "mspInit.h"
-#include "../definitions.h"
-
-#include "fsfw/devicehandlers/CookieIF.h"
-
-#include "stm32h743xx.h"
-
-#include <utility>
-
-/**
- * @brief   SPI cookie implementation for the STM32H7 device family
- * @details
- * This cookie contains and caches device specific information to be used by the
- * SPI communication interface
- * @author  R. Mueller
- */
-class SpiCookie: public CookieIF {
-    friend class SpiComIF;
-public:
-
-    /**
-     * Allows construction of a SPI cookie for a connected SPI device
-     * @param deviceAddress
-     * @param spiIdx                SPI bus, e.g. SPI1 or SPI2
-     * @param transferMode
-     * @param mspCfg                This is the MSP configuration. The user is expected to supply
-     *                              a valid MSP configuration. See mspInit.h for functions
-     *                              to create one.
-     * @param spiSpeed
-     * @param spiMode
-     * @param chipSelectGpioPin     GPIO port. Don't use a number here, use the 16 bit type
-     *                              definitions supplied in the MCU header file! (e.g. GPIO_PIN_X)
-     * @param chipSelectGpioPort    GPIO port (e.g. GPIOA)
-     * @param maxRecvSize           Maximum expected receive size. Chose as small as possible.
-     * @param csGpio                Optional CS GPIO definition.
-     */
-    SpiCookie(address_t deviceAddress, spi::SpiBus spiIdx, spi::TransferModes transferMode,
-            spi::MspCfgBase* mspCfg, uint32_t spiSpeed, spi::SpiModes spiMode,
-            size_t maxRecvSize, stm32h7::GpioCfg csGpio = stm32h7::GpioCfg(nullptr, 0, 0));
-
-    uint16_t getChipSelectGpioPin() const;
-    GPIO_TypeDef* getChipSelectGpioPort();
-    address_t getDeviceAddress() const;
-    spi::SpiBus getSpiIdx() const;
-    spi::SpiModes getSpiMode() const;
-    spi::TransferModes getTransferMode() const;
-    uint32_t getSpiSpeed() const;
-    size_t getMaxRecvSize() const;
-    SPI_HandleTypeDef& getSpiHandle();
-
-private:
-    address_t deviceAddress;
-    SPI_HandleTypeDef spiHandle = {};
-    spi::SpiBus spiIdx;
-    uint32_t spiSpeed;
-    spi::SpiModes spiMode;
-    spi::TransferModes transferMode;
-    volatile spi::TransferStates transferState = spi::TransferStates::IDLE;
-    stm32h7::GpioCfg csGpio;
-
-    // The MSP configuration is cached here. Be careful when using this, it is automatically
-    // deleted by the SPI  communication interface if it is not required anymore!
-    spi::MspCfgBase* mspCfg = nullptr;
-    const size_t maxRecvSize;
-
-    // Only the SpiComIF is allowed to use this to prevent dangling pointers issues
-    spi::MspCfgBase* getMspCfg();
-    void deleteMspCfg();
-
-    void setTransferState(spi::TransferStates transferState);
-    spi::TransferStates getTransferState() const;
-};
-
-
-
-#endif /* FSFW_HAL_STM32H7_SPI_SPICOOKIE_H_ */

hal/src/fsfw_hal/stm32h7/spi/mspInit.cpp

@@ -1,253 +0,0 @@
-#include "fsfw_hal/stm32h7/dma.h"
-#include "fsfw_hal/stm32h7/spi/mspInit.h"
-#include "fsfw_hal/stm32h7/spi/spiCore.h"
-#include "fsfw_hal/stm32h7/spi/spiInterrupts.h"
-
-#include "stm32h743xx.h"
-#include "stm32h7xx_hal_spi.h"
-#include "stm32h7xx_hal_dma.h"
-#include "stm32h7xx_hal_def.h"
-
-#include <cstdio>
-
-spi::msp_func_t mspInitFunc = nullptr;
-spi::MspCfgBase* mspInitArgs = nullptr;
-
-spi::msp_func_t mspDeinitFunc = nullptr;
-spi::MspCfgBase* mspDeinitArgs = nullptr;
-
-/**
- * @brief SPI MSP Initialization
- *        This function configures the hardware resources used in this example:
- *           - Peripheral's clock enable
- *           - Peripheral's GPIO Configuration
- *           - DMA configuration for transmission request by peripheral
- *           - NVIC configuration for DMA interrupt request enable
- * @param hspi: SPI handle pointer
- * @retval None
- */
-void spi::halMspInitDma(SPI_HandleTypeDef* hspi, MspCfgBase* cfgBase) {
-    auto cfg = dynamic_cast<MspDmaConfigStruct*>(cfgBase);
-    if(hspi == nullptr or cfg == nullptr) {
-        return;
-    }
-    setSpiHandle(hspi);
-
-    DMA_HandleTypeDef* hdma_tx = nullptr;
-    DMA_HandleTypeDef* hdma_rx = nullptr;
-    spi::getDmaHandles(&hdma_tx, &hdma_rx);
-    if(hdma_tx == nullptr or hdma_rx == nullptr) {
-        printf("HAL_SPI_MspInit: Invalid DMA handles. Make sure to call setDmaHandles!\n");
-        return;
-    }
-
-    spi::halMspInitInterrupt(hspi, cfg);
-
-    // DMA setup
-    if(cfg->dmaClkEnableWrapper == nullptr) {
-        mspErrorHandler("spi::halMspInitDma", "DMA Clock init invalid");
-    }
-    cfg->dmaClkEnableWrapper();
-
-    // Configure the DMA
-    /* Configure the DMA handler for Transmission process */
-    if(hdma_tx->Instance == nullptr) {
-        // Assume it was not configured properly
-        mspErrorHandler("spi::halMspInitDma", "DMA TX handle invalid");
-    }
-
-    HAL_DMA_Init(hdma_tx);
-    /* Associate the initialized DMA handle to the the SPI handle */
-    __HAL_LINKDMA(hspi, hdmatx, *hdma_tx);
-
-    HAL_DMA_Init(hdma_rx);
-    /* Associate the initialized DMA handle to the the SPI handle */
-    __HAL_LINKDMA(hspi, hdmarx, *hdma_rx);
-
-    /*##-4- Configure the NVIC for DMA #########################################*/
-    /* NVIC configuration for DMA transfer complete interrupt (SPI1_RX) */
-    // Assign the interrupt handler
-    dma::assignDmaUserHandler(cfg->rxDmaIndex, cfg->rxDmaStream, &spi::dmaRxIrqHandler, hdma_rx);
-    HAL_NVIC_SetPriority(cfg->rxDmaIrqNumber, cfg->rxPreEmptPriority, cfg->rxSubpriority);
-    HAL_NVIC_EnableIRQ(cfg->rxDmaIrqNumber);
-
-    /* NVIC configuration for DMA transfer complete interrupt (SPI1_TX) */
-    // Assign the interrupt handler
-    dma::assignDmaUserHandler(cfg->txDmaIndex, cfg->txDmaStream,
-            &spi::dmaTxIrqHandler, hdma_tx);
-    HAL_NVIC_SetPriority(cfg->txDmaIrqNumber, cfg->txPreEmptPriority, cfg->txSubpriority);
-    HAL_NVIC_EnableIRQ(cfg->txDmaIrqNumber);
-}
-
-/**
- * @brief SPI MSP De-Initialization
- *        This function frees the hardware resources used in this example:
- *          - Disable the Peripheral's clock
- *          - Revert GPIO, DMA and NVIC configuration to their default state
- * @param hspi: SPI handle pointer
- * @retval None
- */
-void spi::halMspDeinitDma(SPI_HandleTypeDef* hspi, MspCfgBase* cfgBase) {
-    auto cfg = dynamic_cast<MspDmaConfigStruct*>(cfgBase);
-    if(hspi == nullptr or cfg == nullptr) {
-        return;
-    }
-    spi::halMspDeinitInterrupt(hspi, cfgBase);
-    DMA_HandleTypeDef* hdma_tx = NULL;
-    DMA_HandleTypeDef* hdma_rx = NULL;
-    spi::getDmaHandles(&hdma_tx, &hdma_rx);
-    if(hdma_tx == NULL || hdma_rx == NULL) {
-        printf("HAL_SPI_MspInit: Invalid DMA handles. Make sure to call setDmaHandles!\n");
-    }
-    else {
-        // Disable the DMA
-        /* De-Initialize the DMA associated to transmission process */
-        HAL_DMA_DeInit(hdma_tx);
-        /* De-Initialize the DMA associated to reception process */
-        HAL_DMA_DeInit(hdma_rx);
-    }
-
-    // Disable the NVIC for DMA
-    HAL_NVIC_DisableIRQ(cfg->txDmaIrqNumber);
-    HAL_NVIC_DisableIRQ(cfg->rxDmaIrqNumber);
-
-}
-
-void spi::halMspInitPolling(SPI_HandleTypeDef* hspi, MspCfgBase* cfgBase) {
-    auto cfg = dynamic_cast<MspPollingConfigStruct*>(cfgBase);
-    GPIO_InitTypeDef GPIO_InitStruct = {};
-    /*##-1- Enable peripherals and GPIO Clocks #################################*/
-    /* Enable GPIO TX/RX clock */
-    cfg->setupCb();
-
-    /*##-2- Configure peripheral GPIO ##########################################*/
-    /* SPI SCK GPIO pin configuration  */
-    GPIO_InitStruct.Pin       = cfg->sck.pin;
-    GPIO_InitStruct.Mode      = GPIO_MODE_AF_PP;
-    GPIO_InitStruct.Pull      = GPIO_PULLDOWN;
-    GPIO_InitStruct.Speed     = GPIO_SPEED_FREQ_HIGH;
-    GPIO_InitStruct.Alternate = cfg->sck.altFnc;
-    HAL_GPIO_Init(cfg->sck.port, &GPIO_InitStruct);
-
-    /* SPI MISO GPIO pin configuration  */
-    GPIO_InitStruct.Pin = cfg->miso.pin;
-    GPIO_InitStruct.Alternate = cfg->miso.altFnc;
-    HAL_GPIO_Init(cfg->miso.port, &GPIO_InitStruct);
-
-    /* SPI MOSI GPIO pin configuration  */
-    GPIO_InitStruct.Pin = cfg->mosi.pin;
-    GPIO_InitStruct.Alternate = cfg->mosi.altFnc;
-    HAL_GPIO_Init(cfg->mosi.port, &GPIO_InitStruct);
-}
-
-void spi::halMspDeinitPolling(SPI_HandleTypeDef* hspi, MspCfgBase* cfgBase) {
-    auto cfg = reinterpret_cast<MspPollingConfigStruct*>(cfgBase);
-    // Reset peripherals
-    cfg->cleanupCb();
-
-    // Disable peripherals and GPIO Clocks
-    /* Configure SPI SCK as alternate function  */
-    HAL_GPIO_DeInit(cfg->sck.port, cfg->sck.pin);
-    /* Configure SPI MISO as alternate function  */
-    HAL_GPIO_DeInit(cfg->miso.port, cfg->miso.pin);
-    /* Configure SPI MOSI as alternate function  */
-    HAL_GPIO_DeInit(cfg->mosi.port, cfg->mosi.pin);
-}
-
-void spi::halMspInitInterrupt(SPI_HandleTypeDef* hspi, MspCfgBase* cfgBase) {
-    auto cfg = dynamic_cast<MspIrqConfigStruct*>(cfgBase);
-    if(cfg == nullptr or hspi == nullptr) {
-        return;
-    }
-
-    spi::halMspInitPolling(hspi, cfg);
-    // Configure the NVIC for SPI
-    spi::assignSpiUserHandler(cfg->spiBus, cfg->spiIrqHandler, cfg->spiUserArgs);
-    HAL_NVIC_SetPriority(cfg->spiIrqNumber, cfg->preEmptPriority, cfg->subpriority);
-    HAL_NVIC_EnableIRQ(cfg->spiIrqNumber);
-}
-
-void spi::halMspDeinitInterrupt(SPI_HandleTypeDef* hspi, MspCfgBase* cfgBase) {
-    auto cfg = dynamic_cast<MspIrqConfigStruct*>(cfgBase);
-    spi::halMspDeinitPolling(hspi, cfg);
-    // Disable the NVIC for SPI
-    HAL_NVIC_DisableIRQ(cfg->spiIrqNumber);
-}
-
-void spi::getMspInitFunction(msp_func_t* init_func, MspCfgBase** args) {
-    if(init_func != NULL && args != NULL) {
-        *init_func = mspInitFunc;
-        *args = mspInitArgs;
-    }
-}
-
-void spi::getMspDeinitFunction(msp_func_t* deinit_func, MspCfgBase** args) {
-    if(deinit_func != NULL && args != NULL) {
-        *deinit_func = mspDeinitFunc;
-        *args = mspDeinitArgs;
-    }
-}
-
-void spi::setSpiDmaMspFunctions(MspDmaConfigStruct* cfg,
-        msp_func_t initFunc, msp_func_t deinitFunc) {
-    mspInitFunc = initFunc;
-    mspDeinitFunc = deinitFunc;
-    mspInitArgs = cfg;
-    mspDeinitArgs = cfg;
-}
-
-void spi::setSpiIrqMspFunctions(MspIrqConfigStruct *cfg, msp_func_t initFunc,
-        msp_func_t deinitFunc) {
-    mspInitFunc = initFunc;
-    mspDeinitFunc = deinitFunc;
-    mspInitArgs = cfg;
-    mspDeinitArgs = cfg;
-}
-
-void spi::setSpiPollingMspFunctions(MspPollingConfigStruct *cfg, msp_func_t initFunc,
-        msp_func_t deinitFunc) {
-    mspInitFunc = initFunc;
-    mspDeinitFunc = deinitFunc;
-    mspInitArgs = cfg;
-    mspDeinitArgs = cfg;
-}
-
-/**
- * @brief SPI MSP Initialization
- *        This function configures the hardware resources used in this example:
- *           - Peripheral's clock enable
- *           - Peripheral's GPIO Configuration
- *           - DMA configuration for transmission request by peripheral
- *           - NVIC configuration for DMA interrupt request enable
- * @param hspi: SPI handle pointer
- * @retval None
- */
-extern "C" void HAL_SPI_MspInit(SPI_HandleTypeDef *hspi) {
-    if(mspInitFunc != NULL) {
-        mspInitFunc(hspi, mspInitArgs);
-    }
-    else {
-        printf("HAL_SPI_MspInit: Please call set_msp_functions to assign SPI MSP functions\n");
-    }
-}
-
-/**
- * @brief SPI MSP De-Initialization
- *        This function frees the hardware resources used in this example:
- *          - Disable the Peripheral's clock
- *          - Revert GPIO, DMA and NVIC configuration to their default state
- * @param hspi: SPI handle pointer
- * @retval None
- */
-extern "C" void HAL_SPI_MspDeInit(SPI_HandleTypeDef *hspi) {
-    if(mspDeinitFunc != NULL) {
-        mspDeinitFunc(hspi, mspDeinitArgs);
-    }
-    else {
-        printf("HAL_SPI_MspDeInit: Please call set_msp_functions to assign SPI MSP functions\n");
-    }
-}
-
-void spi::mspErrorHandler(const char* const function, const char *const message) {
-    printf("%s failure: %s\n", function, message);
-}

hal/src/fsfw_hal/stm32h7/spi/mspInit.h

@@ -1,132 +0,0 @@
-#ifndef FSFW_HAL_STM32H7_SPI_MSPINIT_H_
-#define FSFW_HAL_STM32H7_SPI_MSPINIT_H_
-
-#include "spiDefinitions.h"
-#include "../definitions.h"
-#include "../dma.h"
-
-#include "stm32h7xx_hal_spi.h"
-
-#include <cstdint>
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-using mspCb = void (*) (void);
-
-/**
- * @brief   This file provides MSP implementation for DMA, IRQ and Polling mode for the
- *          SPI peripheral. This configuration is required for the SPI communication to work.
- */
-namespace spi {
-
-struct MspCfgBase {
-    MspCfgBase();
-    MspCfgBase(stm32h7::GpioCfg sck, stm32h7::GpioCfg mosi, stm32h7::GpioCfg miso,
-            mspCb cleanupCb = nullptr, mspCb setupCb = nullptr):
-        sck(sck), mosi(mosi), miso(miso), cleanupCb(cleanupCb),
-        setupCb(setupCb) {}
-
-    virtual ~MspCfgBase() = default;
-
-    stm32h7::GpioCfg sck;
-    stm32h7::GpioCfg mosi;
-    stm32h7::GpioCfg miso;
-
-    mspCb cleanupCb = nullptr;
-    mspCb setupCb = nullptr;
-};
-
-struct MspPollingConfigStruct: public MspCfgBase {
-    MspPollingConfigStruct(): MspCfgBase() {};
-    MspPollingConfigStruct(stm32h7::GpioCfg sck, stm32h7::GpioCfg mosi, stm32h7::GpioCfg miso,
-            mspCb cleanupCb = nullptr, mspCb setupCb = nullptr):
-            MspCfgBase(sck, mosi, miso, cleanupCb, setupCb) {}
-};
-
-/* A valid instance of this struct must be passed to the MSP initialization function as a void*
-argument */
-struct MspIrqConfigStruct: public MspPollingConfigStruct {
-    MspIrqConfigStruct(): MspPollingConfigStruct() {};
-    MspIrqConfigStruct(stm32h7::GpioCfg sck, stm32h7::GpioCfg mosi, stm32h7::GpioCfg miso,
-            mspCb cleanupCb = nullptr, mspCb setupCb = nullptr):
-            MspPollingConfigStruct(sck, mosi, miso, cleanupCb, setupCb) {}
-
-    SpiBus spiBus = SpiBus::SPI_1;
-    user_handler_t spiIrqHandler = nullptr;
-    user_args_t spiUserArgs = nullptr;
-    IRQn_Type spiIrqNumber = SPI1_IRQn;
-    // Priorities for NVIC
-    // Pre-Empt priority ranging from 0 to 15. If FreeRTOS calls are used, only 5-15 are allowed
-    IrqPriorities preEmptPriority = IrqPriorities::LOWEST;
-    IrqPriorities subpriority = IrqPriorities::LOWEST;
-};
-
-/* A valid instance of this struct must be passed to the MSP initialization function as a void*
-argument */
-struct MspDmaConfigStruct: public MspIrqConfigStruct {
-    MspDmaConfigStruct(): MspIrqConfigStruct() {};
-    MspDmaConfigStruct(stm32h7::GpioCfg sck, stm32h7::GpioCfg mosi, stm32h7::GpioCfg miso,
-            mspCb cleanupCb = nullptr, mspCb setupCb = nullptr):
-            MspIrqConfigStruct(sck, mosi, miso, cleanupCb, setupCb) {}
-    void (* dmaClkEnableWrapper) (void) = nullptr;
-
-    dma::DMAIndexes txDmaIndex = dma::DMAIndexes::DMA_1;
-    dma::DMAIndexes rxDmaIndex = dma::DMAIndexes::DMA_1;
-    dma::DMAStreams txDmaStream = dma::DMAStreams::STREAM_0;
-    dma::DMAStreams rxDmaStream = dma::DMAStreams::STREAM_0;
-    IRQn_Type txDmaIrqNumber = DMA1_Stream0_IRQn;
-    IRQn_Type rxDmaIrqNumber = DMA1_Stream1_IRQn;
-    // Priorities for NVIC
-    IrqPriorities txPreEmptPriority = IrqPriorities::LOWEST;
-    IrqPriorities rxPreEmptPriority = IrqPriorities::LOWEST;
-    IrqPriorities txSubpriority = IrqPriorities::LOWEST;
-    IrqPriorities rxSubpriority = IrqPriorities::LOWEST;
-};
-
-using msp_func_t = void (*) (SPI_HandleTypeDef* hspi, MspCfgBase* cfg);
-
-
-void getMspInitFunction(msp_func_t* init_func, MspCfgBase **args);
-void getMspDeinitFunction(msp_func_t* deinit_func, MspCfgBase **args);
-
-void halMspInitDma(SPI_HandleTypeDef* hspi, MspCfgBase* cfg);
-void halMspDeinitDma(SPI_HandleTypeDef* hspi, MspCfgBase* cfg);
-
-void halMspInitInterrupt(SPI_HandleTypeDef* hspi, MspCfgBase* cfg);
-void halMspDeinitInterrupt(SPI_HandleTypeDef* hspi, MspCfgBase* cfg);
-
-void halMspInitPolling(SPI_HandleTypeDef* hspi, MspCfgBase* cfg);
-void halMspDeinitPolling(SPI_HandleTypeDef* hspi, MspCfgBase* cfg);
-
-/**
- * Assign MSP init functions. Important for SPI configuration
- * @param init_func
- * @param init_args
- * @param deinit_func
- * @param deinit_args
- */
-void setSpiDmaMspFunctions(MspDmaConfigStruct* cfg,
-        msp_func_t initFunc = &spi::halMspInitDma,
-        msp_func_t deinitFunc= &spi::halMspDeinitDma
-);
-void setSpiIrqMspFunctions(MspIrqConfigStruct* cfg,
-        msp_func_t initFunc = &spi::halMspInitInterrupt,
-        msp_func_t deinitFunc= &spi::halMspDeinitInterrupt
-);
-void setSpiPollingMspFunctions(MspPollingConfigStruct* cfg,
-        msp_func_t initFunc = &spi::halMspInitPolling,
-        msp_func_t deinitFunc= &spi::halMspDeinitPolling
-);
-
-void mspErrorHandler(const char* const function, const char *const message);
-
-}
-
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif /* FSFW_HAL_STM32H7_SPI_MSPINIT_H_ */

hal/src/fsfw_hal/stm32h7/spi/spiCore.cpp

@@ -1,341 +0,0 @@
-#include "fsfw_hal/stm32h7/spi/spiCore.h"
-#include "fsfw_hal/stm32h7/spi/spiDefinitions.h"
-
-#include <cstdio>
-
-SPI_HandleTypeDef* spiHandle = nullptr;
-DMA_HandleTypeDef* hdmaTx = nullptr;
-DMA_HandleTypeDef* hdmaRx = nullptr;
-
-spi_transfer_cb_t rxTxCb = nullptr;
-void* rxTxArgs = nullptr;
-spi_transfer_cb_t txCb = nullptr;
-void* txArgs = nullptr;
-spi_transfer_cb_t rxCb = nullptr;
-void* rxArgs = nullptr;
-spi_transfer_cb_t errorCb = nullptr;
-void* errorArgs = nullptr;
-
-void mapIndexAndStream(DMA_HandleTypeDef* handle, dma::DMAType dmaType, dma::DMAIndexes dmaIdx,
-        dma::DMAStreams dmaStream, IRQn_Type* dmaIrqNumber);
-void mapSpiBus(DMA_HandleTypeDef *handle, dma::DMAType dmaType, spi::SpiBus spiBus);
-
-void spi::configureDmaHandle(DMA_HandleTypeDef *handle, spi::SpiBus spiBus, dma::DMAType dmaType,
-        dma::DMAIndexes dmaIdx, dma::DMAStreams dmaStream, IRQn_Type* dmaIrqNumber,
-        uint32_t dmaMode, uint32_t dmaPriority) {
-    using namespace dma;
-    mapIndexAndStream(handle, dmaType, dmaIdx, dmaStream, dmaIrqNumber);
-    mapSpiBus(handle, dmaType, spiBus);
-
-    if(dmaType == DMAType::TX) {
-        handle->Init.Direction = DMA_MEMORY_TO_PERIPH;
-    }
-    else {
-        handle->Init.Direction = DMA_PERIPH_TO_MEMORY;
-    }
-
-    handle->Init.Priority = dmaPriority;
-    handle->Init.Mode = dmaMode;
-
-    // Standard settings for the rest for now
-    handle->Init.FIFOMode            = DMA_FIFOMODE_DISABLE;
-    handle->Init.FIFOThreshold       = DMA_FIFO_THRESHOLD_FULL;
-    handle->Init.MemBurst            = DMA_MBURST_INC4;
-    handle->Init.PeriphBurst         = DMA_PBURST_INC4;
-    handle->Init.PeriphInc           = DMA_PINC_DISABLE;
-    handle->Init.MemInc              = DMA_MINC_ENABLE;
-    handle->Init.PeriphDataAlignment = DMA_PDATAALIGN_BYTE;
-    handle->Init.MemDataAlignment    = DMA_MDATAALIGN_BYTE;
-}
-
-void spi::setDmaHandles(DMA_HandleTypeDef* txHandle, DMA_HandleTypeDef* rxHandle) {
-    hdmaTx = txHandle;
-    hdmaRx = rxHandle;
-}
-
-void spi::getDmaHandles(DMA_HandleTypeDef** txHandle, DMA_HandleTypeDef** rxHandle) {
-    *txHandle = hdmaTx;
-    *rxHandle = hdmaRx;
-}
-
-void spi::setSpiHandle(SPI_HandleTypeDef *spiHandle_) {
-    if(spiHandle_ == NULL) {
-        return;
-    }
-    spiHandle = spiHandle_;
-}
-
-void spi::assignTransferRxTxCompleteCallback(spi_transfer_cb_t callback, void *userArgs) {
-    rxTxCb = callback;
-    rxTxArgs = userArgs;
-}
-
-void spi::assignTransferRxCompleteCallback(spi_transfer_cb_t callback, void *userArgs) {
-    rxCb = callback;
-    rxArgs = userArgs;
-}
-
-void spi::assignTransferTxCompleteCallback(spi_transfer_cb_t callback, void *userArgs) {
-    txCb = callback;
-    txArgs = userArgs;
-}
-
-void spi::assignTransferErrorCallback(spi_transfer_cb_t callback, void *userArgs) {
-    errorCb = callback;
-    errorArgs = userArgs;
-}
-
-SPI_HandleTypeDef* spi::getSpiHandle() {
-    return spiHandle;
-}
-
-
-
-/**
- * @brief  TxRx Transfer completed callback.
- * @param  hspi: SPI handle
- */
-extern "C" void HAL_SPI_TxRxCpltCallback(SPI_HandleTypeDef *hspi) {
-    if(rxTxCb != NULL) {
-        rxTxCb(hspi, rxTxArgs);
-    }
-    else {
-        printf("HAL_SPI_TxRxCpltCallback: No user callback specified\n");
-    }
-}
-
-/**
- * @brief  TxRx Transfer completed callback.
- * @param  hspi: SPI handle
- */
-extern "C" void HAL_SPI_TxCpltCallback(SPI_HandleTypeDef *hspi) {
-    if(txCb != NULL) {
-        txCb(hspi, txArgs);
-    }
-    else {
-        printf("HAL_SPI_TxCpltCallback: No user callback specified\n");
-    }
-}
-
-/**
- * @brief  TxRx Transfer completed callback.
- * @param  hspi: SPI handle
- */
-extern "C" void HAL_SPI_RxCpltCallback(SPI_HandleTypeDef *hspi) {
-    if(rxCb != nullptr) {
-        rxCb(hspi, rxArgs);
-    }
-    else {
-        printf("HAL_SPI_RxCpltCallback: No user callback specified\n");
-    }
-}
-
-/**
- * @brief  SPI error callbacks.
- * @param  hspi: SPI handle
- * @note   This example shows a simple way to report transfer error, and you can
- *         add your own implementation.
- * @retval None
- */
-extern "C" void HAL_SPI_ErrorCallback(SPI_HandleTypeDef *hspi) {
-    if(errorCb != nullptr) {
-        errorCb(hspi, rxArgs);
-    }
-    else {
-        printf("HAL_SPI_ErrorCallback: No user callback specified\n");
-    }
-}
-
-void mapIndexAndStream(DMA_HandleTypeDef* handle, dma::DMAType dmaType, dma::DMAIndexes dmaIdx,
-        dma::DMAStreams dmaStream, IRQn_Type* dmaIrqNumber) {
-    using namespace dma;
-    if(dmaIdx == DMAIndexes::DMA_1) {
-#ifdef DMA1
-        switch(dmaStream) {
-        case(DMAStreams::STREAM_0): {
-#ifdef DMA1_Stream0
-            handle->Instance = DMA1_Stream0;
-            if(dmaIrqNumber != nullptr) {
-                *dmaIrqNumber = DMA1_Stream0_IRQn;
-            }
-#endif
-            break;
-        }
-        case(DMAStreams::STREAM_1): {
-#ifdef DMA1_Stream1
-            handle->Instance = DMA1_Stream1;
-            if(dmaIrqNumber != nullptr) {
-                *dmaIrqNumber = DMA1_Stream1_IRQn;
-            }
-#endif
-            break;
-        }
-        case(DMAStreams::STREAM_2): {
-#ifdef DMA1_Stream2
-            handle->Instance = DMA1_Stream2;
-            if(dmaIrqNumber != nullptr) {
-                *dmaIrqNumber = DMA1_Stream2_IRQn;
-            }
-#endif
-            break;
-        }
-        case(DMAStreams::STREAM_3): {
-#ifdef DMA1_Stream3
-            handle->Instance = DMA1_Stream3;
-            if(dmaIrqNumber != nullptr) {
-                *dmaIrqNumber = DMA1_Stream3_IRQn;
-            }
-#endif
-            break;
-        }
-        case(DMAStreams::STREAM_4): {
-#ifdef DMA1_Stream4
-            handle->Instance = DMA1_Stream4;
-            if(dmaIrqNumber != nullptr) {
-                *dmaIrqNumber = DMA1_Stream4_IRQn;
-            }
-#endif
-            break;
-        }
-        case(DMAStreams::STREAM_5): {
-#ifdef DMA1_Stream5
-            handle->Instance = DMA1_Stream5;
-            if(dmaIrqNumber != nullptr) {
-                *dmaIrqNumber = DMA1_Stream5_IRQn;
-            }
-#endif
-            break;
-        }
-        case(DMAStreams::STREAM_6): {
-#ifdef DMA1_Stream6
-            handle->Instance = DMA1_Stream6;
-            if(dmaIrqNumber != nullptr) {
-                *dmaIrqNumber = DMA1_Stream6_IRQn;
-            }
-#endif
-            break;
-        }
-        case(DMAStreams::STREAM_7): {
-#ifdef DMA1_Stream7
-            handle->Instance = DMA1_Stream7;
-            if(dmaIrqNumber != nullptr) {
-                *dmaIrqNumber = DMA1_Stream7_IRQn;
-            }
-#endif
-            break;
-        }
-        }
-        if(dmaType == DMAType::TX) {
-            handle->Init.Request = DMA_REQUEST_SPI1_TX;
-        }
-        else {
-            handle->Init.Request = DMA_REQUEST_SPI1_RX;
-        }
-#endif /* DMA1 */
-    }
-    if(dmaIdx == DMAIndexes::DMA_2) {
-#ifdef DMA2
-        switch(dmaStream) {
-        case(DMAStreams::STREAM_0): {
-#ifdef DMA2_Stream0
-            handle->Instance = DMA2_Stream0;
-            if(dmaIrqNumber != nullptr) {
-                *dmaIrqNumber = DMA2_Stream0_IRQn;
-            }
-#endif
-            break;
-        }
-        case(DMAStreams::STREAM_1): {
-#ifdef DMA2_Stream1
-            handle->Instance = DMA2_Stream1;
-            if(dmaIrqNumber != nullptr) {
-                *dmaIrqNumber = DMA2_Stream1_IRQn;
-            }
-#endif
-            break;
-        }
-        case(DMAStreams::STREAM_2): {
-#ifdef DMA2_Stream2
-            handle->Instance = DMA2_Stream2;
-            if(dmaIrqNumber != nullptr) {
-                *dmaIrqNumber = DMA2_Stream2_IRQn;
-            }
-#endif
-            break;
-        }
-        case(DMAStreams::STREAM_3): {
-#ifdef DMA2_Stream3
-            handle->Instance = DMA2_Stream3;
-            if(dmaIrqNumber != nullptr) {
-                *dmaIrqNumber = DMA2_Stream3_IRQn;
-            }
-#endif
-            break;
-        }
-        case(DMAStreams::STREAM_4): {
-#ifdef DMA2_Stream4
-            handle->Instance = DMA2_Stream4;
-            if(dmaIrqNumber != nullptr) {
-                *dmaIrqNumber = DMA2_Stream4_IRQn;
-            }
-#endif
-            break;
-        }
-        case(DMAStreams::STREAM_5): {
-#ifdef DMA2_Stream5
-            handle->Instance = DMA2_Stream5;
-            if(dmaIrqNumber != nullptr) {
-                *dmaIrqNumber = DMA2_Stream5_IRQn;
-            }
-#endif
-            break;
-        }
-        case(DMAStreams::STREAM_6): {
-#ifdef DMA2_Stream6
-            handle->Instance = DMA2_Stream6;
-            if(dmaIrqNumber != nullptr) {
-                *dmaIrqNumber = DMA2_Stream6_IRQn;
-            }
-#endif
-            break;
-        }
-        case(DMAStreams::STREAM_7): {
-#ifdef DMA2_Stream7
-            handle->Instance = DMA2_Stream7;
-            if(dmaIrqNumber != nullptr) {
-                *dmaIrqNumber = DMA2_Stream7_IRQn;
-            }
-#endif
-            break;
-        }
-        }
-#endif /* DMA2 */
-    }
-}
-
-void mapSpiBus(DMA_HandleTypeDef *handle, dma::DMAType dmaType, spi::SpiBus spiBus) {
-    if(dmaType == dma::DMAType::TX) {
-        if(spiBus == spi::SpiBus::SPI_1) {
-#ifdef DMA_REQUEST_SPI1_TX
-            handle->Init.Request = DMA_REQUEST_SPI1_TX;
-#endif
-        }
-        else if(spiBus == spi::SpiBus::SPI_2) {
-#ifdef DMA_REQUEST_SPI2_TX
-            handle->Init.Request = DMA_REQUEST_SPI2_TX;
-#endif
-        }
-    }
-    else {
-        if(spiBus == spi::SpiBus::SPI_1) {
-#ifdef DMA_REQUEST_SPI1_RX
-            handle->Init.Request = DMA_REQUEST_SPI1_RX;
-#endif
-        }
-        else if(spiBus == spi::SpiBus::SPI_2) {
-#ifdef DMA_REQUEST_SPI2_RX
-            handle->Init.Request = DMA_REQUEST_SPI2_RX;
-#endif
-        }
-    }
-}

hal/src/fsfw_hal/stm32h7/spi/spiDefinitions.cpp

@@ -1,52 +0,0 @@
-#include "fsfw_hal/stm32h7/spi/spiDefinitions.h"
-
-void spi::assignSpiMode(SpiModes spiMode, SPI_HandleTypeDef& spiHandle) {
-    switch(spiMode) {
-    case(SpiModes::MODE_0): {
-        spiHandle.Init.CLKPolarity = SPI_POLARITY_LOW;
-        spiHandle.Init.CLKPhase = SPI_PHASE_1EDGE;
-        break;
-    }
-    case(SpiModes::MODE_1): {
-        spiHandle.Init.CLKPolarity = SPI_POLARITY_LOW;
-        spiHandle.Init.CLKPhase = SPI_PHASE_2EDGE;
-        break;
-    }
-    case(SpiModes::MODE_2): {
-        spiHandle.Init.CLKPolarity = SPI_POLARITY_HIGH;
-        spiHandle.Init.CLKPhase = SPI_PHASE_1EDGE;
-        break;
-    }
-    case(SpiModes::MODE_3): {
-        spiHandle.Init.CLKPolarity = SPI_POLARITY_HIGH;
-        spiHandle.Init.CLKPhase = SPI_PHASE_2EDGE;
-        break;
-    }
-    }
-}
-
-uint32_t spi::getPrescaler(uint32_t clock_src_freq, uint32_t baudrate_mbps) {
-    uint32_t divisor = 0;
-    uint32_t spi_clk = clock_src_freq;
-    uint32_t presc = 0;
-    static const uint32_t baudrate[] = {
-            SPI_BAUDRATEPRESCALER_2,
-            SPI_BAUDRATEPRESCALER_4,
-            SPI_BAUDRATEPRESCALER_8,
-            SPI_BAUDRATEPRESCALER_16,
-            SPI_BAUDRATEPRESCALER_32,
-            SPI_BAUDRATEPRESCALER_64,
-            SPI_BAUDRATEPRESCALER_128,
-            SPI_BAUDRATEPRESCALER_256,
-    };
-
-    while( spi_clk > baudrate_mbps) {
-        presc = baudrate[divisor];
-        if (++divisor > 7)
-            break;
-
-        spi_clk = ( spi_clk >> 1);
-    }
-
-    return presc;
-}

hal/src/fsfw_hal/stm32h7/spi/spiInterrupts.cpp

@@ -1,106 +0,0 @@
-#include "fsfw_hal/stm32h7/spi/spiInterrupts.h"
-#include "fsfw_hal/stm32h7/spi/spiCore.h"
-
-#include "stm32h7xx_hal.h"
-#include "stm32h7xx_hal_dma.h"
-#include "stm32h7xx_hal_spi.h"
-
-#include <stddef.h>
-
-user_handler_t spi1UserHandler = &spi::spiIrqHandler;
-user_args_t spi1UserArgs = nullptr;
-
-user_handler_t spi2UserHandler = &spi::spiIrqHandler;
-user_args_t spi2UserArgs = nullptr;
-
-/**
- * @brief  This function handles DMA Rx interrupt request.
- * @param  None
- * @retval None
- */
-void spi::dmaRxIrqHandler(void* dmaHandle) {
-    if(dmaHandle == nullptr) {
-        return;
-    }
-    HAL_DMA_IRQHandler((DMA_HandleTypeDef *) dmaHandle);
-}
-
-/**
- * @brief  This function handles DMA Rx interrupt request.
- * @param  None
- * @retval None
- */
-void spi::dmaTxIrqHandler(void* dmaHandle) {
-    if(dmaHandle == nullptr) {
-        return;
-    }
-    HAL_DMA_IRQHandler((DMA_HandleTypeDef *) dmaHandle);
-}
-
-/**
- * @brief  This function handles SPIx interrupt request.
- * @param  None
- * @retval None
- */
-void spi::spiIrqHandler(void* spiHandle) {
-    if(spiHandle == nullptr) {
-        return;
-    }
-    //auto currentSpiHandle = spi::getSpiHandle();
-    HAL_SPI_IRQHandler((SPI_HandleTypeDef *) spiHandle);
-}
-
-void spi::assignSpiUserHandler(spi::SpiBus spiIdx, user_handler_t userHandler,
-        user_args_t userArgs) {
-    if(spiIdx == spi::SpiBus::SPI_1) {
-        spi1UserHandler = userHandler;
-        spi1UserArgs = userArgs;
-    }
-    else {
-        spi2UserHandler = userHandler;
-        spi2UserArgs = userArgs;
-    }
-}
-
-void spi::getSpiUserHandler(spi::SpiBus spiBus, user_handler_t *userHandler,
-        user_args_t *userArgs) {
-    if(userHandler == nullptr or userArgs == nullptr) {
-        return;
-    }
-    if(spiBus == spi::SpiBus::SPI_1) {
-        *userArgs = spi1UserArgs;
-        *userHandler = spi1UserHandler;
-    }
-    else {
-        *userArgs = spi2UserArgs;
-        *userHandler = spi2UserHandler;
-    }
-}
-
-void spi::assignSpiUserArgs(spi::SpiBus spiBus, user_args_t userArgs) {
-    if(spiBus == spi::SpiBus::SPI_1) {
-        spi1UserArgs = userArgs;
-    }
-    else {
-        spi2UserArgs = userArgs;
-    }
-}
-
-/* Do not change these function names! They need to be exactly equal to the name of the functions
-defined in the startup_stm32h743xx.s files! */
-
-extern "C" void SPI1_IRQHandler() {
-    if(spi1UserHandler != NULL) {
-        spi1UserHandler(spi1UserArgs);
-        return;
-    }
-    Default_Handler();
-}
-
-extern "C"  void SPI2_IRQHandler() {
-    if(spi2UserHandler != nullptr) {
-        spi2UserHandler(spi2UserArgs);
-        return;
-    }
-    Default_Handler();
-}

hal/src/fsfw_hal/stm32h7/spi/stm32h743zi.cpp

@@ -1,82 +0,0 @@
-#include "fsfw_hal/stm32h7/spi/stm32h743zi.h"
-#include "fsfw_hal/stm32h7/spi/spiCore.h"
-#include "fsfw_hal/stm32h7/spi/spiInterrupts.h"
-
-#include "stm32h7xx_hal.h"
-#include "stm32h7xx_hal_rcc.h"
-
-#include <cstdio>
-
-void spiSetupWrapper() {
-    __HAL_RCC_GPIOA_CLK_ENABLE();
-    __HAL_RCC_GPIOB_CLK_ENABLE();
-    __HAL_RCC_SPI1_CLK_ENABLE();
-}
-
-void spiCleanUpWrapper() {
-    __HAL_RCC_SPI1_FORCE_RESET();
-    __HAL_RCC_SPI1_RELEASE_RESET();
-}
-
-void spiDmaClockEnableWrapper() {
-    __HAL_RCC_DMA2_CLK_ENABLE();
-}
-
-void stm32h7::h743zi::standardPollingCfg(spi::MspPollingConfigStruct& cfg) {
-    cfg.setupCb =  &spiSetupWrapper;
-    cfg.cleanupCb = &spiCleanUpWrapper;
-    cfg.sck.port = GPIOA;
-    cfg.sck.pin = GPIO_PIN_5;
-    cfg.miso.port = GPIOA;
-    cfg.miso.pin = GPIO_PIN_6;
-    cfg.mosi.port = GPIOA;
-    cfg.mosi.pin = GPIO_PIN_7;
-    cfg.sck.altFnc = GPIO_AF5_SPI1;
-    cfg.mosi.altFnc = GPIO_AF5_SPI1;
-    cfg.miso.altFnc = GPIO_AF5_SPI1;
-}
-
-void stm32h7::h743zi::standardInterruptCfg(spi::MspIrqConfigStruct& cfg, IrqPriorities spiIrqPrio,
-        IrqPriorities spiSubprio) {
-    // High, but works on FreeRTOS as well (priorities range from 0 to 15)
-    cfg.preEmptPriority = spiIrqPrio;
-    cfg.subpriority = spiSubprio;
-    cfg.spiIrqNumber = SPI1_IRQn;
-    cfg.spiBus = spi::SpiBus::SPI_1;
-    user_handler_t spiUserHandler = nullptr;
-    user_args_t spiUserArgs = nullptr;
-    getSpiUserHandler(spi::SpiBus::SPI_1, &spiUserHandler, &spiUserArgs);
-    if(spiUserHandler == nullptr) {
-        printf("spi::h743zi::standardInterruptCfg: Invalid SPI user handlers\n");
-        return;
-    }
-    cfg.spiUserArgs = spiUserArgs;
-    cfg.spiIrqHandler = spiUserHandler;
-    standardPollingCfg(cfg);
-}
-
-void stm32h7::h743zi::standardDmaCfg(spi::MspDmaConfigStruct& cfg, IrqPriorities spiIrqPrio,
-        IrqPriorities txIrqPrio, IrqPriorities rxIrqPrio, IrqPriorities spiSubprio,
-        IrqPriorities txSubprio, IrqPriorities rxSubprio) {
-    cfg.dmaClkEnableWrapper = &spiDmaClockEnableWrapper;
-    cfg.rxDmaIndex = dma::DMAIndexes::DMA_2;
-    cfg.txDmaIndex = dma::DMAIndexes::DMA_2;
-    cfg.txDmaStream = dma::DMAStreams::STREAM_3;
-    cfg.rxDmaStream = dma::DMAStreams::STREAM_2;
-    DMA_HandleTypeDef* txHandle;
-    DMA_HandleTypeDef* rxHandle;
-    spi::getDmaHandles(&txHandle, &rxHandle);
-    if(txHandle == nullptr or rxHandle == nullptr) {
-        printf("spi::h743zi::standardDmaCfg: Invalid DMA handles\n");
-        return;
-    }
-    spi::configureDmaHandle(txHandle, spi::SpiBus::SPI_1, dma::DMAType::TX, cfg.txDmaIndex,
-            cfg.txDmaStream, &cfg.txDmaIrqNumber);
-    spi::configureDmaHandle(rxHandle, spi::SpiBus::SPI_1, dma::DMAType::RX, cfg.rxDmaIndex,
-            cfg.rxDmaStream, &cfg.rxDmaIrqNumber, DMA_NORMAL, DMA_PRIORITY_HIGH);
-    cfg.txPreEmptPriority = txIrqPrio;
-    cfg.rxPreEmptPriority = txSubprio;
-    cfg.txSubpriority = rxIrqPrio;
-    cfg.rxSubpriority = rxSubprio;
-    standardInterruptCfg(cfg, spiIrqPrio, spiSubprio);
-}

misc/defaultcfg/fsfwconfig/devices/logicalAddresses.h

@@ -10,7 +10,7 @@
  */
 namespace addresses {
 	/* Logical addresses have uint32_t datatype */
-	enum logicalAddresses: address_t {
+	enum LogAddr: address_t {
 	};
 }
 

scripts/apply-clang-format.sh

@@ -1,8 +0,0 @@
-#!/bin/bash
-if [[ ! -f README.md ]]; then
-	cd ..
-fi
-
-find ./src -iname *.h -o -iname *.cpp -o -iname *.c | xargs clang-format --style=file -i
-find ./hal -iname *.h -o -iname *.cpp -o -iname *.c | xargs clang-format --style=file -i
-find ./tests -iname *.h -o -iname *.cpp -o -iname *.c | xargs clang-format --style=file -i

scripts/auto-formatter.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+if [[ ! -f README.md ]]; then
+  cd ..
+fi
+
+cmake_fmt="cmake-format"
+file_selectors="-iname CMakeLists.txt"
+if command -v ${cmake_fmt} &> /dev/null; then
+  ${cmake_fmt} -i CMakeLists.txt
+  find ./src ${file_selectors} | xargs ${cmake_fmt}  -i
+else
+  echo "No ${cmake_fmt} tool found, not formatting CMake files"
+fi
+
+cpp_format="clang-format"
+file_selectors="-iname *.h -o -iname *.cpp -o -iname *.c -o -iname *.tpp"
+if command -v ${cpp_format} &> /dev/null; then
+  find ./src ${file_selectors} | xargs ${cpp_format} --style=file -i
+  find ./hal ${file_selectors} | xargs ${cpp_format} --style=file -i
+  find ./tests ${file_selectors} | xargs ${cpp_format} --style=file -i
+else
+  echo "No ${cpp_format} tool found, not formatting C++/C files"
+fi

scripts/helper.py

@@ -9,36 +9,58 @@ import webbrowser
 import shutil
 import sys
 import time
+from shutil import which
 from typing import List
 
 
-UNITTEST_FOLDER_NAME = 'build-tests'
-DOCS_FOLDER_NAME = 'build-docs'
+UNITTEST_FOLDER_NAME = "build-tests"
+DOCS_FOLDER_NAME = "build-docs"
 
 
 def main():
 
     parser = argparse.ArgumentParser(description="FSFW helper script")
-    choices = ('docs', 'tests')
+    choices = ("docs", "tests")
     parser.add_argument(
-        'type', metavar='type', choices=choices,
-        help=f'Target type. Choices: {choices}'
+        "type", metavar="type", choices=choices, help=f"Target type. Choices: {choices}"
     )
     parser.add_argument(
-        '-a', '--all', action='store_true',
-        help='Create, build and open specified type'
+        "-a", "--all", action="store_true", help="Create, build and open specified type"
     )
     parser.add_argument(
-        '-c', '--create', action='store_true',
-        help='Create docs or test build configuration'
+        "-c",
+        "--create",
+        action="store_true",
+        help="Create docs or test build configuration",
     )
     parser.add_argument(
-        '-b', '--build', action='store_true',
-        help='Build the specified type'
+        "-b", "--build", action="store_true", help="Build the specified type"
     )
     parser.add_argument(
-        '-o', '--open', action='store_true',
-        help='Open test or documentation data in webbrowser'
+        "-o",
+        "--open",
+        action="store_true",
+        help="Open test or documentation data in webbrowser",
+    )
+    parser.add_argument(
+        "-v",
+        "--valgrind",
+        action="store_true",
+        help="Run valgrind on generated test binary",
+    )
+    parser.add_argument(
+        "-g",
+        "--generators",
+        default = "Ninja",
+        action="store",
+        help="CMake generators",
+    )
+    parser.add_argument(
+        "-w",
+        "--windows",
+        default=False,
+        action="store_true",
+        help="Run on windows",
     )
 
     args = parser.parse_args()
@@ -46,26 +68,26 @@ def main():
         args.build = True
         args.create = True
         args.open = True
-    elif not args.build and not args.create and not args.open:
+    elif not args.build and not args.create and not args.open and not args.valgrind:
         print(
-            'Please select at least one operation to perform. '
-            'Use helper.py -h for more information'
+            "Please select at least one operation to perform. "
+            "Use helper.py -h for more information"
         )
         sys.exit(1)
 
     # This script can be called from root and from script folder
-    if not os.path.isfile('README.md'):
-        os.chdir('..')
+    if not os.path.isfile("README.md"):
+        os.chdir("..")
     build_dir_list = []
     if not args.create:
         build_dir_list = build_build_dir_list()
 
-    if args.type == 'tests':
+    if args.type == "tests":
         handle_tests_type(args, build_dir_list)
-    elif args.type == 'docs':
+    elif args.type == "docs":
         handle_docs_type(args, build_dir_list)
     else:
-        print('Invalid or unknown type')
+        print("Invalid or unknown type")
         sys.exit(1)
 
 
@@ -76,7 +98,9 @@ def handle_docs_type(args, build_dir_list: list):
         create_docs_build_cfg()
         build_directory = DOCS_FOLDER_NAME
     elif len(build_dir_list) == 0:
-        print('No valid CMake docs build directory found. Trying to set up docs build system')
+        print(
+            "No valid CMake docs build directory found. Trying to set up docs build system"
+        )
         shutil.rmtree(DOCS_FOLDER_NAME)
         create_docs_build_cfg()
         build_directory = DOCS_FOLDER_NAME
@@ -87,32 +111,32 @@ def handle_docs_type(args, build_dir_list: list):
         build_directory = determine_build_dir(build_dir_list)
     os.chdir(build_directory)
     if args.build:
-        os.system('cmake --build . -j')
+        cmd_runner("cmake --build . -j")
     if args.open:
-        if not os.path.isfile('docs/sphinx/index.html'):
+        if not os.path.isfile("docs/sphinx/index.html"):
             # try again..
-            os.system('cmake --build . -j')
-            if not os.path.isfile('docs/sphinx/index.html'):
+            cmd_runner("cmake --build . -j")
+            if not os.path.isfile("docs/sphinx/index.html"):
                 print(
                     "No Sphinx documentation file detected. "
                     "Try to build it first with the -b argument"
                 )
                 sys.exit(1)
-        webbrowser.open('docs/sphinx/index.html')
+        webbrowser.open("docs/sphinx/index.html")
 
 
 def handle_tests_type(args, build_dir_list: list):
     if args.create:
         if os.path.exists(UNITTEST_FOLDER_NAME):
             shutil.rmtree(UNITTEST_FOLDER_NAME)
-        create_tests_build_cfg()
+        create_tests_build_cfg(args)
         build_directory = UNITTEST_FOLDER_NAME
     elif len(build_dir_list) == 0:
         print(
-            'No valid CMake tests build directory found. '
-            'Trying to set up test build system'
+            "No valid CMake tests build directory found. "
+            "Trying to set up test build system"
         )
-        create_tests_build_cfg()
+        create_tests_build_cfg(args)
         build_directory = UNITTEST_FOLDER_NAME
     elif len(build_dir_list) == 1:
         build_directory = build_dir_list[0]
@@ -123,24 +147,37 @@ def handle_tests_type(args, build_dir_list: list):
     if args.build:
         perform_lcov_operation(build_directory, False)
     if args.open:
-        if not os.path.isdir('fsfw-tests_coverage'):
-            print("No Unittest folder detected. Try to build them first with the -b argument")
+        if not os.path.isdir("fsfw-tests_coverage"):
+            print(
+                "No Unittest folder detected. Try to build them first with the -b argument"
+            )
             sys.exit(1)
-        webbrowser.open('fsfw-tests_coverage/index.html')
+        webbrowser.open("fsfw-tests_coverage/index.html")
+    if args.valgrind:
+        if which("valgrind") is None:
+            print("Please install valgrind first")
+            sys.exit(1)
+        cmd_runner("valgrind --leak-check=full ./fsfw-tests")
+        os.chdir("..")
 
 
-def create_tests_build_cfg():
+def create_tests_build_cfg(args):
     os.mkdir(UNITTEST_FOLDER_NAME)
     os.chdir(UNITTEST_FOLDER_NAME)
-    os.system('cmake -DFSFW_OSAL=host -DFSFW_BUILD_UNITTESTS=ON ..')
-    os.chdir('..')
+    if args.windows:
+        cmake_cmd = 'cmake -G "' + args.generators + '" -DFSFW_OSAL=host -DFSFW_BUILD_TESTS=ON \
+        -DGCOVR_PATH="py -m gcovr" ..'
+    else:
+        cmake_cmd = 'cmake -G "' + args.generators + '" -DFSFW_OSAL=host -DFSFW_BUILD_TESTS=ON ..'
+    cmd_runner(cmake_cmd)
+    os.chdir("..")
 
 
 def create_docs_build_cfg():
     os.mkdir(DOCS_FOLDER_NAME)
     os.chdir(DOCS_FOLDER_NAME)
-    os.system('cmake -DFSFW_OSAL=host -DFSFW_BUILD_DOCS=ON ..')
-    os.chdir('..')
+    cmd_runner("cmake -DFSFW_OSAL=host -DFSFW_BUILD_DOCS=ON ..")
+    os.chdir("..")
 
 
 def build_build_dir_list() -> list:
@@ -162,7 +199,7 @@ def check_for_cmake_build_dir(build_dir_list: list) -> list:
 def perform_lcov_operation(directory: str, chdir: bool):
     if chdir:
         os.chdir(directory)
-    os.system("cmake --build . -- fsfw-tests_coverage -j")
+    cmd_runner("cmake --build . -- fsfw-tests_coverage -j")
 
 
 def determine_build_dir(build_dir_list: List[str]):
@@ -184,5 +221,10 @@ def determine_build_dir(build_dir_list: List[str]):
     return build_directory
 
 
+def cmd_runner(cmd: str):
+    print(f"Executing command: {cmd}")
+    os.system(cmd)
+
+
 if __name__ == "__main__":
     main()

src/CMakeLists.txt

@@ -1,18 +1,11 @@
-target_include_directories(${LIB_FSFW_NAME} PRIVATE
-    ${CMAKE_CURRENT_SOURCE_DIR}
-)
+target_include_directories(${LIB_FSFW_NAME} PRIVATE ${CMAKE_CURRENT_SOURCE_DIR})
 
-target_include_directories(${LIB_FSFW_NAME} INTERFACE
-    ${CMAKE_CURRENT_SOURCE_DIR}
-)
+target_include_directories(${LIB_FSFW_NAME}
+                           INTERFACE ${CMAKE_CURRENT_SOURCE_DIR})
 
 add_subdirectory(fsfw)
+if(FSFW_ADD_HAL)
+  add_subdirectory(fsfw_hal)
+endif()
 
-# Configure File
-
-target_include_directories(${LIB_FSFW_NAME} PRIVATE
-    ${CMAKE_CURRENT_BINARY_DIR}
-)
-target_include_directories(${LIB_FSFW_NAME} INTERFACE
-    ${CMAKE_CURRENT_BINARY_DIR}
-)
+add_subdirectory(fsfw_tests)

src/fsfw/CMakeLists.txt

@@ -1,6 +1,9 @@
+target_sources(${LIB_FSFW_NAME} PRIVATE version.cpp)
+
 # Core
 
 add_subdirectory(action)
+add_subdirectory(cfdp)
 add_subdirectory(container)
 add_subdirectory(controller)
 add_subdirectory(datapool)
@@ -32,22 +35,22 @@ add_subdirectory(tmtcservices)
 # Optional
 
 if(FSFW_ADD_MONITORING)
-add_subdirectory(monitoring)
+  add_subdirectory(monitoring)
 endif()
 if(FSFW_ADD_PUS)
-    add_subdirectory(pus)
+  add_subdirectory(pus)
 endif()
 if(FSFW_ADD_TMSTORAGE)
-    add_subdirectory(tmstorage)
+  add_subdirectory(tmstorage)
 endif()
 if(FSFW_ADD_COORDINATES)
-    add_subdirectory(coordinates)
+  add_subdirectory(coordinates)
 endif()
 if(FSFW_ADD_RMAP)
-    add_subdirectory(rmap)
+  add_subdirectory(rmap)
 endif()
 if(FSFW_ADD_DATALINKLAYER)
-    add_subdirectory(datalinklayer)
+  add_subdirectory(datalinklayer)
 endif()
 
 # OSAL

src/fsfw/FSFW.h.in

@@ -18,6 +18,10 @@
 
 // FSFW core defines
 
+#ifndef FSFW_TCP_RECV_WIRETAPPING_ENABLED
+#define FSFW_TCP_RECV_WIRETAPPING_ENABLED   0
+#endif
+
 #ifndef FSFW_CPP_OSTREAM_ENABLED
 #define FSFW_CPP_OSTREAM_ENABLED            1
 #endif /* FSFW_CPP_OSTREAM_ENABLED */
@@ -26,6 +30,10 @@
 #define FSFW_VERBOSE_LEVEL                  1
 #endif /* FSFW_VERBOSE_LEVEL */
 
+#ifndef FSFW_DISABLE_PRINTOUT
+#define FSFW_DISABLE_PRINTOUT               0
+#endif
+
 #ifndef FSFW_USE_REALTIME_FOR_LINUX
 #define FSFW_USE_REALTIME_FOR_LINUX         0
 #endif /* FSFW_USE_REALTIME_FOR_LINUX */
@@ -42,6 +50,10 @@
 #define FSFW_USE_PUS_C_TELECOMMANDS         1
 #endif
 
+#ifndef FSFW_TCP_RECV_WIRETAPPING_ENABLED
+#define FSFW_TCP_RECV_WIRETAPPING_ENABLED   0
+#endif
+
 // FSFW HAL defines
 
 // Can be used for low-level debugging of the SPI bus
@@ -49,16 +61,9 @@
 #define FSFW_HAL_SPI_WIRETAPPING            0
 #endif
 
-#ifndef FSFW_HAL_L3GD20_GYRO_DEBUG
-#define FSFW_HAL_L3GD20_GYRO_DEBUG          0
-#endif /* FSFW_HAL_L3GD20_GYRO_DEBUG */
-
-#ifndef FSFW_HAL_RM3100_MGM_DEBUG
-#define FSFW_HAL_RM3100_MGM_DEBUG           0
-#endif /* FSFW_HAL_RM3100_MGM_DEBUG */
-
-#ifndef FSFW_HAL_LIS3MDL_MGM_DEBUG
-#define FSFW_HAL_LIS3MDL_MGM_DEBUG          0
-#endif /* FSFW_HAL_LIS3MDL_MGM_DEBUG */
+// Can be used for low-level debugging of the I2C bus
+#ifndef FSFW_HAL_I2C_WIRETAPPING
+#define FSFW_HAL_I2C_WIRETAPPING            0
+#endif
 
 #endif /* FSFW_FSFW_H_ */

src/fsfw/FSFWVersion.h.in

@@ -1,9 +1,11 @@
 #ifndef FSFW_VERSION_H_
 #define FSFW_VERSION_H_
 
-// Versioning is kept in project CMakeLists.txt file
-#define FSFW_VERSION @FSFW_VERSION@
-#define FSFW_SUBVERSION @FSFW_SUBVERSION@
-#define FSFW_REVISION @FSFW_REVISION@
+// Versioning is managed in project CMakeLists.txt file
+static constexpr int FSFW_VERSION_MAJOR = @FSFW_VERSION@;
+static constexpr int FSFW_VERSION_MINOR = @FSFW_SUBVERSION@;
+static constexpr int FSFW_VERSION_REVISION = @FSFW_REVISION@;
+// Also contains CST (Commits since tag) information
+static const char FSFW_VCS_INFO[] = "@FSFW_VCS_INFO@";
 
 #endif /* FSFW_VERSION_H_ */

src/fsfw/action.h

@@ -4,8 +4,8 @@
 #include "fsfw/action/ActionHelper.h"
 #include "fsfw/action/ActionMessage.h"
 #include "fsfw/action/CommandActionHelper.h"
-#include "fsfw/action/HasActionsIF.h"
 #include "fsfw/action/CommandsActionsIF.h"
+#include "fsfw/action/HasActionsIF.h"
 #include "fsfw/action/SimpleActionHelper.h"
 
 #endif /* FSFW_INC_FSFW_ACTION_H_ */

src/fsfw/action/ActionHelper.cpp

@@ -1,177 +1,165 @@
 #include "fsfw/action.h"
-
 #include "fsfw/ipc/MessageQueueSenderIF.h"
 #include "fsfw/objectmanager/ObjectManager.h"
 #include "fsfw/serviceinterface/ServiceInterface.h"
 
-ActionHelper::ActionHelper(HasActionsIF* setOwner,
-        MessageQueueIF* useThisQueue) :
-        owner(setOwner), queueToUse(useThisQueue) {
-}
+ActionHelper::ActionHelper(HasActionsIF* setOwner, MessageQueueIF* useThisQueue)
+    : owner(setOwner), queueToUse(useThisQueue) {}
 
-ActionHelper::~ActionHelper() {
-}
+ActionHelper::~ActionHelper() = default;
 
 ReturnValue_t ActionHelper::handleActionMessage(CommandMessage* command) {
-    if (command->getCommand() == ActionMessage::EXECUTE_ACTION) {
-        ActionId_t currentAction = ActionMessage::getActionId(command);
-        prepareExecution(command->getSender(), currentAction,
-                ActionMessage::getStoreId(command));
-        return HasReturnvaluesIF::RETURN_OK;
-    } else {
-        return CommandMessage::UNKNOWN_COMMAND;
-    }
+  if (command->getCommand() == ActionMessage::EXECUTE_ACTION) {
+    ActionId_t currentAction = ActionMessage::getActionId(command);
+    prepareExecution(command->getSender(), currentAction, ActionMessage::getStoreId(command));
+    return HasReturnvaluesIF::RETURN_OK;
+  } else {
+    return CommandMessage::UNKNOWN_COMMAND;
+  }
 }
 
 ReturnValue_t ActionHelper::initialize(MessageQueueIF* queueToUse_) {
-    ipcStore = ObjectManager::instance()->get<StorageManagerIF>(objects::IPC_STORE);
-    if (ipcStore == nullptr) {
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    if(queueToUse_ != nullptr) {
-        setQueueToUse(queueToUse_);
-    }
+  ipcStore = ObjectManager::instance()->get<StorageManagerIF>(objects::IPC_STORE);
+  if (ipcStore == nullptr) {
+    return HasReturnvaluesIF::RETURN_FAILED;
+  }
+  if (queueToUse_ != nullptr) {
+    setQueueToUse(queueToUse_);
+  }
 
-    if(queueToUse == nullptr) {
+  if (queueToUse == nullptr) {
 #if FSFW_VERBOSE_LEVEL >= 1
 #if FSFW_CPP_OSTREAM_ENABLED == 1
-        sif::warning << "ActionHelper::initialize: No queue set" << std::endl;
+    sif::warning << "ActionHelper::initialize: No queue set" << std::endl;
 #else
-        sif::printWarning("ActionHelper::initialize: No queue set\n");
+    sif::printWarning("ActionHelper::initialize: No queue set\n");
 #endif
 #endif /* FSFW_VERBOSE_LEVEL >= 1 */
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
+    return HasReturnvaluesIF::RETURN_FAILED;
+  }
 
-    return HasReturnvaluesIF::RETURN_OK;
+  return HasReturnvaluesIF::RETURN_OK;
 }
 
-void ActionHelper::step(uint8_t step, MessageQueueId_t reportTo,
-        ActionId_t commandId, ReturnValue_t result) {
-    CommandMessage reply;
-    ActionMessage::setStepReply(&reply, commandId, step + STEP_OFFSET, result);
-    queueToUse->sendMessage(reportTo, &reply);
+void ActionHelper::step(uint8_t step, MessageQueueId_t reportTo, ActionId_t commandId,
+                        ReturnValue_t result) {
+  CommandMessage reply;
+  ActionMessage::setStepReply(&reply, commandId, step + STEP_OFFSET, result);
+  queueToUse->sendMessage(reportTo, &reply);
 }
 
 void ActionHelper::finish(bool success, MessageQueueId_t reportTo, ActionId_t commandId,
-        ReturnValue_t result) {
+                          ReturnValue_t result) {
+  CommandMessage reply;
+  ActionMessage::setCompletionReply(&reply, commandId, success, result);
+  queueToUse->sendMessage(reportTo, &reply);
+}
+
+void ActionHelper::setQueueToUse(MessageQueueIF* queue) { queueToUse = queue; }
+
+void ActionHelper::prepareExecution(MessageQueueId_t commandedBy, ActionId_t actionId,
+                                    store_address_t dataAddress) {
+  const uint8_t* dataPtr = nullptr;
+  size_t size = 0;
+  ReturnValue_t result = ipcStore->getData(dataAddress, &dataPtr, &size);
+  if (result != HasReturnvaluesIF::RETURN_OK) {
     CommandMessage reply;
-    ActionMessage::setCompletionReply(&reply, commandId, success, result);
-    queueToUse->sendMessage(reportTo, &reply);
-}
-
-void ActionHelper::setQueueToUse(MessageQueueIF* queue) {
-    queueToUse = queue;
-}
-
-void ActionHelper::prepareExecution(MessageQueueId_t commandedBy,
-        ActionId_t actionId, store_address_t dataAddress) {
-    const uint8_t* dataPtr = NULL;
-    size_t size = 0;
-    ReturnValue_t result = ipcStore->getData(dataAddress, &dataPtr, &size);
-    if (result != HasReturnvaluesIF::RETURN_OK) {
-        CommandMessage reply;
-        ActionMessage::setStepReply(&reply, actionId, 0, result);
-        queueToUse->sendMessage(commandedBy, &reply);
-        return;
-    }
-    result = owner->executeAction(actionId, commandedBy, dataPtr, size);
-    ipcStore->deleteData(dataAddress);
-    if(result == HasActionsIF::EXECUTION_FINISHED) {
-        CommandMessage reply;
-        ActionMessage::setCompletionReply(&reply, actionId, true, result);
-        queueToUse->sendMessage(commandedBy, &reply);
-    }
-    if (result != HasReturnvaluesIF::RETURN_OK) {
-        CommandMessage reply;
-        ActionMessage::setStepReply(&reply, actionId, 0, result);
-        queueToUse->sendMessage(commandedBy, &reply);
-        return;
-    }
-}
-
-ReturnValue_t ActionHelper::reportData(MessageQueueId_t reportTo,
-        ActionId_t replyId, SerializeIF* data, bool hideSender) {
+    ActionMessage::setStepReply(&reply, actionId, 0, result);
+    queueToUse->sendMessage(commandedBy, &reply);
+    return;
+  }
+  result = owner->executeAction(actionId, commandedBy, dataPtr, size);
+  ipcStore->deleteData(dataAddress);
+  if (result == HasActionsIF::EXECUTION_FINISHED) {
     CommandMessage reply;
-    store_address_t storeAddress;
-    uint8_t *dataPtr;
-    size_t maxSize = data->getSerializedSize();
-    if (maxSize == 0) {
-        /* No error, there's simply nothing to report. */
-        return HasReturnvaluesIF::RETURN_OK;
-    }
-    size_t size = 0;
-    ReturnValue_t result = ipcStore->getFreeElement(&storeAddress, maxSize,
-            &dataPtr);
-    if (result != HasReturnvaluesIF::RETURN_OK) {
+    ActionMessage::setCompletionReply(&reply, actionId, true, result);
+    queueToUse->sendMessage(commandedBy, &reply);
+  }
+  if (result != HasReturnvaluesIF::RETURN_OK) {
+    CommandMessage reply;
+    ActionMessage::setStepReply(&reply, actionId, 0, result);
+    queueToUse->sendMessage(commandedBy, &reply);
+    return;
+  }
+}
+
+ReturnValue_t ActionHelper::reportData(MessageQueueId_t reportTo, ActionId_t replyId,
+                                       SerializeIF* data, bool hideSender) {
+  CommandMessage reply;
+  store_address_t storeAddress;
+  uint8_t* dataPtr;
+  size_t maxSize = data->getSerializedSize();
+  if (maxSize == 0) {
+    /* No error, there's simply nothing to report. */
+    return HasReturnvaluesIF::RETURN_OK;
+  }
+  size_t size = 0;
+  ReturnValue_t result = ipcStore->getFreeElement(&storeAddress, maxSize, &dataPtr);
+  if (result != HasReturnvaluesIF::RETURN_OK) {
 #if FSFW_CPP_OSTREAM_ENABLED == 1
-        sif::warning << "ActionHelper::reportData: Getting free element from IPC store failed!" <<
-                std::endl;
+    sif::warning << "ActionHelper::reportData: Getting free element from IPC store failed!"
+                 << std::endl;
 #else
-        sif::printWarning("ActionHelper::reportData: Getting free element from IPC "
-                "store failed!\n");
+    sif::printWarning(
+        "ActionHelper::reportData: Getting free element from IPC "
+        "store failed!\n");
 #endif
-        return result;
-    }
-    result = data->serialize(&dataPtr, &size, maxSize,
-            SerializeIF::Endianness::BIG);
-    if (result != HasReturnvaluesIF::RETURN_OK) {
-        ipcStore->deleteData(storeAddress);
-        return result;
-    }
-
-    /* We don't need to report the objectId, as we receive REQUESTED data before the completion
-    success message. True aperiodic replies need to be reported with another dedicated message. */
-    ActionMessage::setDataReply(&reply, replyId, storeAddress);
-
-    /* If the sender needs to be hidden, for example to handle packet
-    as unrequested reply, this will be done here. */
-    if (hideSender) {
-        result = MessageQueueSenderIF::sendMessage(reportTo, &reply);
-    }
-    else {
-        result = queueToUse->sendMessage(reportTo, &reply);
-    }
-
-    if (result != HasReturnvaluesIF::RETURN_OK){
-        ipcStore->deleteData(storeAddress);
-    }
     return result;
+  }
+  result = data->serialize(&dataPtr, &size, maxSize, SerializeIF::Endianness::BIG);
+  if (result != HasReturnvaluesIF::RETURN_OK) {
+    ipcStore->deleteData(storeAddress);
+    return result;
+  }
+
+  /* We don't need to report the objectId, as we receive REQUESTED data before the completion
+  success message. True aperiodic replies need to be reported with another dedicated message. */
+  ActionMessage::setDataReply(&reply, replyId, storeAddress);
+
+  /* If the sender needs to be hidden, for example to handle packet
+  as unrequested reply, this will be done here. */
+  if (hideSender) {
+    result = MessageQueueSenderIF::sendMessage(reportTo, &reply);
+  } else {
+    result = queueToUse->sendMessage(reportTo, &reply);
+  }
+
+  if (result != HasReturnvaluesIF::RETURN_OK) {
+    ipcStore->deleteData(storeAddress);
+  }
+  return result;
 }
 
-void ActionHelper::resetHelper() {
-}
+void ActionHelper::resetHelper() {}
 
-ReturnValue_t ActionHelper::reportData(MessageQueueId_t reportTo,
-        ActionId_t replyId, const uint8_t *data, size_t dataSize,
-        bool hideSender) {
-    CommandMessage reply;
-    store_address_t storeAddress;
-    ReturnValue_t result = ipcStore->addData(&storeAddress, data, dataSize);
-    if (result != HasReturnvaluesIF::RETURN_OK) {
+ReturnValue_t ActionHelper::reportData(MessageQueueId_t reportTo, ActionId_t replyId,
+                                       const uint8_t* data, size_t dataSize, bool hideSender) {
+  CommandMessage reply;
+  store_address_t storeAddress;
+  ReturnValue_t result = ipcStore->addData(&storeAddress, data, dataSize);
+  if (result != HasReturnvaluesIF::RETURN_OK) {
 #if FSFW_CPP_OSTREAM_ENABLED == 1
-        sif::warning << "ActionHelper::reportData: Adding data to IPC store failed!" << std::endl;
+    sif::warning << "ActionHelper::reportData: Adding data to IPC store failed!" << std::endl;
 #else
-        sif::printWarning("ActionHelper::reportData: Adding data to IPC store failed!\n");
+    sif::printWarning("ActionHelper::reportData: Adding data to IPC store failed!\n");
 #endif
-        return result;
-    }
-
-    /* We don't need to report the objectId, as we receive REQUESTED data before the completion
-    success message. True aperiodic replies need to be reported with another dedicated message. */
-    ActionMessage::setDataReply(&reply, replyId, storeAddress);
-
-    /* If the sender needs to be hidden, for example to handle packet
-    as unrequested reply, this will be done here. */
-    if (hideSender) {
-        result = MessageQueueSenderIF::sendMessage(reportTo, &reply);
-    }
-    else {
-        result = queueToUse->sendMessage(reportTo, &reply);
-    }
-
-    if (result != HasReturnvaluesIF::RETURN_OK) {
-        ipcStore->deleteData(storeAddress);
-    }
     return result;
+  }
+
+  /* We don't need to report the objectId, as we receive REQUESTED data before the completion
+  success message. True aperiodic replies need to be reported with another dedicated message. */
+  ActionMessage::setDataReply(&reply, replyId, storeAddress);
+
+  /* If the sender needs to be hidden, for example to handle packet
+  as unrequested reply, this will be done here. */
+  if (hideSender) {
+    result = MessageQueueSenderIF::sendMessage(reportTo, &reply);
+  } else {
+    result = queueToUse->sendMessage(reportTo, &reply);
+  }
+
+  if (result != HasReturnvaluesIF::RETURN_OK) {
+    ipcStore->deleteData(storeAddress);
+  }
+  return result;
 }

src/fsfw/action/ActionHelper.h

@@ -2,8 +2,8 @@
 #define FSFW_ACTION_ACTIONHELPER_H_
 
 #include "ActionMessage.h"
-#include "../serialize/SerializeIF.h"
-#include "../ipc/MessageQueueIF.h"
+#include "fsfw/ipc/MessageQueueIF.h"
+#include "fsfw/serialize/SerializeIF.h"
 /**
  * @brief Action Helper is a helper class which handles action messages
  *
@@ -17,110 +17,110 @@
 class HasActionsIF;
 
 class ActionHelper {
-public:
-    /**
-     * Constructor of the action helper
-     * @param setOwner Pointer to the owner of the interface
-     * @param useThisQueue  messageQueue to be used, can be set during
-     *                      initialize function as well.
-     */
-    ActionHelper(HasActionsIF* setOwner, MessageQueueIF* useThisQueue);
+ public:
+  /**
+   * Constructor of the action helper
+   * @param setOwner Pointer to the owner of the interface
+   * @param useThisQueue  messageQueue to be used, can be set during
+   *                      initialize function as well.
+   */
+  ActionHelper(HasActionsIF* setOwner, MessageQueueIF* useThisQueue);
 
-    virtual ~ActionHelper();
-    /**
-     * Function to be called from the owner with a new command message
-     *
-     * If the message is a valid action message the helper will use the
-     * executeAction function from HasActionsIF.
-     * If the message is invalid or the callback fails a message reply will be
-     * send to the sender of the message automatically.
-     *
-     * @param command Pointer to a command message received by the owner
-     * @return HasReturnvaluesIF::RETURN_OK if the message is a action message,
-     *         CommandMessage::UNKNOW_COMMAND if this message ID is unkown
-     */
-    ReturnValue_t handleActionMessage(CommandMessage* command);
-    /**
-     * Helper initialize function. Must be called before use of any other
-     * helper function
-     * @param queueToUse_   Pointer to the messageQueue to be used, optional
-     *                      if queue was set in constructor
-     * @return Returns RETURN_OK if successful
-     */
-    ReturnValue_t initialize(MessageQueueIF* queueToUse_ = nullptr);
-    /**
-     * Function to be called from the owner to send a step message.
-     * Success or failure will be determined by the result value.
-     *
-     * @param step Number of steps already done
-     * @param reportTo The messageQueueId to report the step message to
-     * @param commandId ID of the executed command
-     * @param result Result of the execution
-     */
-    void step(uint8_t step, MessageQueueId_t reportTo,
-            ActionId_t commandId,
+  virtual ~ActionHelper();
+  /**
+   * Function to be called from the owner with a new command message
+   *
+   * If the message is a valid action message the helper will use the
+   * executeAction function from HasActionsIF.
+   * If the message is invalid or the callback fails a message reply will be
+   * send to the sender of the message automatically.
+   *
+   * @param command Pointer to a command message received by the owner
+   * @return HasReturnvaluesIF::RETURN_OK if the message is a action message,
+   *         CommandMessage::UNKNOW_COMMAND if this message ID is unkown
+   */
+  ReturnValue_t handleActionMessage(CommandMessage* command);
+  /**
+   * Helper initialize function. Must be called before use of any other
+   * helper function
+   * @param queueToUse_   Pointer to the messageQueue to be used, optional
+   *                      if queue was set in constructor
+   * @return Returns RETURN_OK if successful
+   */
+  ReturnValue_t initialize(MessageQueueIF* queueToUse_ = nullptr);
+  /**
+   * Function to be called from the owner to send a step message.
+   * Success or failure will be determined by the result value.
+   *
+   * @param step Number of steps already done
+   * @param reportTo The messageQueueId to report the step message to
+   * @param commandId ID of the executed command
+   * @param result Result of the execution
+   */
+  void step(uint8_t step, MessageQueueId_t reportTo, ActionId_t commandId,
             ReturnValue_t result = HasReturnvaluesIF::RETURN_OK);
-    /**
-     * Function to be called by the owner to send a action completion message
-     * @param success   Specify whether action was completed successfully or not.
-     * @param reportTo MessageQueueId_t to report the action completion message to
-     * @param commandId ID of the executed command
-     * @param result Result of the execution
-     */
-    void finish(bool success, MessageQueueId_t reportTo, ActionId_t commandId,
-            ReturnValue_t result = HasReturnvaluesIF::RETURN_OK);
-    /**
-     * Function to be called by the owner if an action does report data.
-     * Takes a SerializeIF* pointer and serializes it into the IPC store.
-     * @param reportTo  MessageQueueId_t to report the action completion
-     *                  message to
-     * @param replyId ID of the executed command
-     * @param data Pointer to the data
-     * @return Returns RETURN_OK if successful, otherwise failure code
-     */
-    ReturnValue_t reportData(MessageQueueId_t reportTo, ActionId_t replyId,
-            SerializeIF* data, bool hideSender = false);
-    /**
-     * Function to be called by the owner if an action does report data.
-     * Takes the raw data and writes it into the IPC store.
-     * @param reportTo  MessageQueueId_t to report the action completion
-     *                  message to
-     * @param replyId ID of the executed command
-     * @param data Pointer to the data
-     * @return Returns RETURN_OK if successful, otherwise failure code
-     */
-    ReturnValue_t reportData(MessageQueueId_t reportTo, ActionId_t replyId,
-            const uint8_t* data, size_t dataSize, bool hideSender = false);
-    /**
-     * Function to setup the MessageQueueIF* of the helper. Can be used to
-     * set the MessageQueueIF* if message queue is unavailable at construction
-     * and initialize but must be setup before first call of other functions.
-     * @param queue Queue to be used by the helper
-     */
-    void setQueueToUse(MessageQueueIF *queue);
-protected:
-    //! Increase of value of this per step
-    static const uint8_t STEP_OFFSET = 1;
-    //! Pointer to the owner
-    HasActionsIF* owner;
-    //! Queue to be used as response sender, has to be set in ctor or with
-    //! setQueueToUse
-    MessageQueueIF* queueToUse;
-    //! Pointer to an IPC Store, initialized during construction or
-    StorageManagerIF* ipcStore = nullptr;
+  /**
+   * Function to be called by the owner to send a action completion message
+   * @param success   Specify whether action was completed successfully or not.
+   * @param reportTo MessageQueueId_t to report the action completion message to
+   * @param commandId ID of the executed command
+   * @param result Result of the execution
+   */
+  void finish(bool success, MessageQueueId_t reportTo, ActionId_t commandId,
+              ReturnValue_t result = HasReturnvaluesIF::RETURN_OK);
+  /**
+   * Function to be called by the owner if an action does report data.
+   * Takes a SerializeIF* pointer and serializes it into the IPC store.
+   * @param reportTo  MessageQueueId_t to report the action completion
+   *                  message to
+   * @param replyId ID of the executed command
+   * @param data Pointer to the data
+   * @return Returns RETURN_OK if successful, otherwise failure code
+   */
+  ReturnValue_t reportData(MessageQueueId_t reportTo, ActionId_t replyId, SerializeIF* data,
+                           bool hideSender = false);
+  /**
+   * Function to be called by the owner if an action does report data.
+   * Takes the raw data and writes it into the IPC store.
+   * @param reportTo  MessageQueueId_t to report the action completion
+   *                  message to
+   * @param replyId ID of the executed command
+   * @param data Pointer to the data
+   * @return Returns RETURN_OK if successful, otherwise failure code
+   */
+  ReturnValue_t reportData(MessageQueueId_t reportTo, ActionId_t replyId, const uint8_t* data,
+                           size_t dataSize, bool hideSender = false);
+  /**
+   * Function to setup the MessageQueueIF* of the helper. Can be used to
+   * set the MessageQueueIF* if message queue is unavailable at construction
+   * and initialize but must be setup before first call of other functions.
+   * @param queue Queue to be used by the helper
+   */
+  void setQueueToUse(MessageQueueIF* queue);
 
-    /**
-     * Internal function called by handleActionMessage
-     * @param commandedBy MessageQueueID of Commander
-     * @param actionId ID of action to be done
-     * @param dataAddress Address of additional data in IPC Store
-     */
-    virtual void prepareExecution(MessageQueueId_t commandedBy,
-            ActionId_t actionId, store_address_t dataAddress);
-    /**
-     * @brief Default implementation is empty.
-     */
-    virtual void resetHelper();
+ protected:
+  //! Increase of value of this per step
+  static const uint8_t STEP_OFFSET = 1;
+  //! Pointer to the owner
+  HasActionsIF* owner;
+  //! Queue to be used as response sender, has to be set in ctor or with
+  //! setQueueToUse
+  MessageQueueIF* queueToUse;
+  //! Pointer to an IPC Store, initialized during construction or
+  StorageManagerIF* ipcStore = nullptr;
+
+  /**
+   * Internal function called by handleActionMessage
+   * @param commandedBy MessageQueueID of Commander
+   * @param actionId ID of action to be done
+   * @param dataAddress Address of additional data in IPC Store
+   */
+  virtual void prepareExecution(MessageQueueId_t commandedBy, ActionId_t actionId,
+                                store_address_t dataAddress);
+  /**
+   * @brief Default implementation is empty.
+   */
+  virtual void resetHelper();
 };
 
 #endif /* FSFW_ACTION_ACTIONHELPER_H_ */

src/fsfw/action/ActionMessage.cpp

@@ -1,81 +1,76 @@
 #include "fsfw/action.h"
-
 #include "fsfw/objectmanager/ObjectManager.h"
 #include "fsfw/storagemanager/StorageManagerIF.h"
 
-ActionMessage::ActionMessage() {
-}
+ActionMessage::ActionMessage() = default;
 
-ActionMessage::~ActionMessage() {
-}
+ActionMessage::~ActionMessage() = default;
 
 void ActionMessage::setCommand(CommandMessage* message, ActionId_t fid,
-        store_address_t parameters) {
-    message->setCommand(EXECUTE_ACTION);
-    message->setParameter(fid);
-    message->setParameter2(parameters.raw);
+                               store_address_t parameters) {
+  message->setCommand(EXECUTE_ACTION);
+  message->setParameter(fid);
+  message->setParameter2(parameters.raw);
 }
 
 ActionId_t ActionMessage::getActionId(const CommandMessage* message) {
-    return ActionId_t(message->getParameter());
+  return ActionId_t(message->getParameter());
 }
 
 store_address_t ActionMessage::getStoreId(const CommandMessage* message) {
-    store_address_t temp;
-    temp.raw = message->getParameter2();
-    return temp;
+  store_address_t temp;
+  temp.raw = message->getParameter2();
+  return temp;
 }
 
 void ActionMessage::setStepReply(CommandMessage* message, ActionId_t fid, uint8_t step,
-        ReturnValue_t result) {
-    if (result == HasReturnvaluesIF::RETURN_OK) {
-        message->setCommand(STEP_SUCCESS);
-    } else {
-        message->setCommand(STEP_FAILED);
-    }
-    message->setParameter(fid);
-    message->setParameter2((step << 16) + result);
+                                 ReturnValue_t result) {
+  if (result == HasReturnvaluesIF::RETURN_OK) {
+    message->setCommand(STEP_SUCCESS);
+  } else {
+    message->setCommand(STEP_FAILED);
+  }
+  message->setParameter(fid);
+  message->setParameter2((step << 16) + result);
 }
 
 uint8_t ActionMessage::getStep(const CommandMessage* message) {
-    return uint8_t((message->getParameter2() >> 16) & 0xFF);
+  return uint8_t((message->getParameter2() >> 16) & 0xFF);
 }
 
 ReturnValue_t ActionMessage::getReturnCode(const CommandMessage* message) {
-    return message->getParameter2() & 0xFFFF;
+  return message->getParameter2() & 0xFFFF;
 }
 
 void ActionMessage::setDataReply(CommandMessage* message, ActionId_t actionId,
-        store_address_t data) {
-    message->setCommand(DATA_REPLY);
-    message->setParameter(actionId);
-    message->setParameter2(data.raw);
+                                 store_address_t data) {
+  message->setCommand(DATA_REPLY);
+  message->setParameter(actionId);
+  message->setParameter2(data.raw);
 }
 
-void ActionMessage::setCompletionReply(CommandMessage* message,
-        ActionId_t fid, bool success, ReturnValue_t result) {
-    if (success) {
-        message->setCommand(COMPLETION_SUCCESS);
-    }
-    else {
-        message->setCommand(COMPLETION_FAILED);
-    }
-    message->setParameter(fid);
-    message->setParameter2(result);
+void ActionMessage::setCompletionReply(CommandMessage* message, ActionId_t fid, bool success,
+                                       ReturnValue_t result) {
+  if (success) {
+    message->setCommand(COMPLETION_SUCCESS);
+  } else {
+    message->setCommand(COMPLETION_FAILED);
+  }
+  message->setParameter(fid);
+  message->setParameter2(result);
 }
 
 void ActionMessage::clear(CommandMessage* message) {
-    switch(message->getCommand()) {
+  switch (message->getCommand()) {
     case EXECUTE_ACTION:
     case DATA_REPLY: {
-        StorageManagerIF *ipcStore = ObjectManager::instance()->get<StorageManagerIF>(
-                objects::IPC_STORE);
-        if (ipcStore != NULL) {
-            ipcStore->deleteData(getStoreId(message));
-        }
-        break;
+      auto* ipcStore = ObjectManager::instance()->get<StorageManagerIF>(objects::IPC_STORE);
+      if (ipcStore != nullptr) {
+        ipcStore->deleteData(getStoreId(message));
+      }
+      break;
     }
     default:
-        break;
-    }
+      break;
+  }
 }

src/fsfw/action/ActionMessage.h

@@ -14,34 +14,33 @@ using ActionId_t = uint32_t;
  * ActionHelper are able to process these messages.
  */
 class ActionMessage {
-private:
-    ActionMessage();
-public:
-    static const uint8_t MESSAGE_ID = messagetypes::ACTION;
-    static const Command_t EXECUTE_ACTION = MAKE_COMMAND_ID(1);
-    static const Command_t STEP_SUCCESS = MAKE_COMMAND_ID(2);
-    static const Command_t STEP_FAILED = MAKE_COMMAND_ID(3);
-    static const Command_t DATA_REPLY =  MAKE_COMMAND_ID(4);
-    static const Command_t COMPLETION_SUCCESS = MAKE_COMMAND_ID(5);
-    static const Command_t COMPLETION_FAILED = MAKE_COMMAND_ID(6);
+ private:
+  ActionMessage();
 
-    virtual ~ActionMessage();
-    static void setCommand(CommandMessage* message, ActionId_t fid,
-            store_address_t parameters);
+ public:
+  static const uint8_t MESSAGE_ID = messagetypes::ACTION;
+  static const Command_t EXECUTE_ACTION = MAKE_COMMAND_ID(1);
+  static const Command_t STEP_SUCCESS = MAKE_COMMAND_ID(2);
+  static const Command_t STEP_FAILED = MAKE_COMMAND_ID(3);
+  static const Command_t DATA_REPLY = MAKE_COMMAND_ID(4);
+  static const Command_t COMPLETION_SUCCESS = MAKE_COMMAND_ID(5);
+  static const Command_t COMPLETION_FAILED = MAKE_COMMAND_ID(6);
 
-    static ActionId_t getActionId(const CommandMessage* message );
-    static store_address_t getStoreId(const CommandMessage* message);
+  virtual ~ActionMessage();
+  static void setCommand(CommandMessage* message, ActionId_t fid, store_address_t parameters);
 
-    static void setStepReply(CommandMessage* message, ActionId_t fid,
-            uint8_t step, ReturnValue_t result = HasReturnvaluesIF::RETURN_OK);
-    static uint8_t getStep(const CommandMessage* message );
-    static ReturnValue_t getReturnCode(const CommandMessage* message );
-    static void setDataReply(CommandMessage* message, ActionId_t actionId,
-            store_address_t data);
-    static void setCompletionReply(CommandMessage* message, ActionId_t fid,
-            bool success, ReturnValue_t result = HasReturnvaluesIF::RETURN_OK);
+  static ActionId_t getActionId(const CommandMessage* message);
+  static store_address_t getStoreId(const CommandMessage* message);
 
-    static void clear(CommandMessage* message);
+  static void setStepReply(CommandMessage* message, ActionId_t fid, uint8_t step,
+                           ReturnValue_t result = HasReturnvaluesIF::RETURN_OK);
+  static uint8_t getStep(const CommandMessage* message);
+  static ReturnValue_t getReturnCode(const CommandMessage* message);
+  static void setDataReply(CommandMessage* message, ActionId_t actionId, store_address_t data);
+  static void setCompletionReply(CommandMessage* message, ActionId_t fid, bool success,
+                                 ReturnValue_t result = HasReturnvaluesIF::RETURN_OK);
+
+  static void clear(CommandMessage* message);
 };
 
 #endif /* FSFW_ACTION_ACTIONMESSAGE_H_ */

src/fsfw/action/CMakeLists.txt

@@ -1,7 +1,3 @@
-target_sources(${LIB_FSFW_NAME} 
-    PRIVATE 
-        ActionHelper.cpp
-        ActionMessage.cpp
-        CommandActionHelper.cpp
-        SimpleActionHelper.cpp
-)
+target_sources(
+  ${LIB_FSFW_NAME} PRIVATE ActionHelper.cpp ActionMessage.cpp
+                           CommandActionHelper.cpp SimpleActionHelper.cpp)

src/fsfw/action/CommandActionHelper.cpp

@@ -1,125 +1,112 @@
 #include "fsfw/action.h"
-
 #include "fsfw/objectmanager/ObjectManager.h"
 
-CommandActionHelper::CommandActionHelper(CommandsActionsIF *setOwner) :
-        owner(setOwner), queueToUse(NULL), ipcStore(
-        NULL), commandCount(0), lastTarget(0) {
-}
+CommandActionHelper::CommandActionHelper(CommandsActionsIF *setOwner)
+    : owner(setOwner), queueToUse(nullptr), ipcStore(nullptr), commandCount(0), lastTarget(0) {}
 
-CommandActionHelper::~CommandActionHelper() {
-}
+CommandActionHelper::~CommandActionHelper() = default;
 
-ReturnValue_t CommandActionHelper::commandAction(object_id_t commandTo,
-        ActionId_t actionId, SerializeIF *data) {
-    HasActionsIF *receiver = ObjectManager::instance()->get<HasActionsIF>(commandTo);
-    if (receiver == NULL) {
-        return CommandsActionsIF::OBJECT_HAS_NO_FUNCTIONS;
-    }
-    store_address_t storeId;
-    uint8_t *storePointer;
-    size_t maxSize = data->getSerializedSize();
-    ReturnValue_t result = ipcStore->getFreeElement(&storeId, maxSize,
-            &storePointer);
-    if (result != HasReturnvaluesIF::RETURN_OK) {
-        return result;
-    }
-    size_t size = 0;
-    result = data->serialize(&storePointer, &size, maxSize,
-            SerializeIF::Endianness::BIG);
-    if (result != HasReturnvaluesIF::RETURN_OK) {
-        return result;
-    }
-    return sendCommand(receiver->getCommandQueue(), actionId, storeId);
-}
-
-ReturnValue_t CommandActionHelper::commandAction(object_id_t commandTo,
-        ActionId_t actionId, const uint8_t *data, uint32_t size) {
-//    if (commandCount != 0) {
-//        return CommandsFunctionsIF::ALREADY_COMMANDING;
-//    }
-    HasActionsIF *receiver = ObjectManager::instance()->get<HasActionsIF>(commandTo);
-    if (receiver == NULL) {
-        return CommandsActionsIF::OBJECT_HAS_NO_FUNCTIONS;
-    }
-    store_address_t storeId;
-    ReturnValue_t result = ipcStore->addData(&storeId, data, size);
-    if (result != HasReturnvaluesIF::RETURN_OK) {
-        return result;
-    }
-    return sendCommand(receiver->getCommandQueue(), actionId, storeId);
-}
-
-ReturnValue_t CommandActionHelper::sendCommand(MessageQueueId_t queueId,
-        ActionId_t actionId, store_address_t storeId) {
-    CommandMessage command;
-    ActionMessage::setCommand(&command, actionId, storeId);
-    ReturnValue_t result = queueToUse->sendMessage(queueId, &command);
-    if (result != HasReturnvaluesIF::RETURN_OK) {
-        ipcStore->deleteData(storeId);
-    }
-    lastTarget = queueId;
-    commandCount++;
+ReturnValue_t CommandActionHelper::commandAction(object_id_t commandTo, ActionId_t actionId,
+                                                 SerializeIF *data) {
+  auto *receiver = ObjectManager::instance()->get<HasActionsIF>(commandTo);
+  if (receiver == nullptr) {
+    return CommandsActionsIF::OBJECT_HAS_NO_FUNCTIONS;
+  }
+  store_address_t storeId;
+  uint8_t *storePointer;
+  size_t maxSize = data->getSerializedSize();
+  ReturnValue_t result = ipcStore->getFreeElement(&storeId, maxSize, &storePointer);
+  if (result != HasReturnvaluesIF::RETURN_OK) {
     return result;
+  }
+  size_t size = 0;
+  result = data->serialize(&storePointer, &size, maxSize, SerializeIF::Endianness::BIG);
+  if (result != HasReturnvaluesIF::RETURN_OK) {
+    return result;
+  }
+  return sendCommand(receiver->getCommandQueue(), actionId, storeId);
+}
+
+ReturnValue_t CommandActionHelper::commandAction(object_id_t commandTo, ActionId_t actionId,
+                                                 const uint8_t *data, uint32_t size) {
+  auto *receiver = ObjectManager::instance()->get<HasActionsIF>(commandTo);
+  if (receiver == nullptr) {
+    return CommandsActionsIF::OBJECT_HAS_NO_FUNCTIONS;
+  }
+  store_address_t storeId;
+  ReturnValue_t result = ipcStore->addData(&storeId, data, size);
+  if (result != HasReturnvaluesIF::RETURN_OK) {
+    return result;
+  }
+  return sendCommand(receiver->getCommandQueue(), actionId, storeId);
+}
+
+ReturnValue_t CommandActionHelper::sendCommand(MessageQueueId_t queueId, ActionId_t actionId,
+                                               store_address_t storeId) {
+  CommandMessage command;
+  ActionMessage::setCommand(&command, actionId, storeId);
+  ReturnValue_t result = queueToUse->sendMessage(queueId, &command);
+  if (result != HasReturnvaluesIF::RETURN_OK) {
+    ipcStore->deleteData(storeId);
+  }
+  lastTarget = queueId;
+  commandCount++;
+  return result;
 }
 
 ReturnValue_t CommandActionHelper::initialize() {
-    ipcStore = ObjectManager::instance()->get<StorageManagerIF>(objects::IPC_STORE);
-    if (ipcStore == NULL) {
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
+  ipcStore = ObjectManager::instance()->get<StorageManagerIF>(objects::IPC_STORE);
+  if (ipcStore == nullptr) {
+    return HasReturnvaluesIF::RETURN_FAILED;
+  }
 
-    queueToUse = owner->getCommandQueuePtr();
-    if (queueToUse == NULL) {
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    return HasReturnvaluesIF::RETURN_OK;
+  queueToUse = owner->getCommandQueuePtr();
+  if (queueToUse == nullptr) {
+    return HasReturnvaluesIF::RETURN_FAILED;
+  }
+  return HasReturnvaluesIF::RETURN_OK;
 }
 
 ReturnValue_t CommandActionHelper::handleReply(CommandMessage *reply) {
-    if (reply->getSender() != lastTarget) {
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
-    switch (reply->getCommand()) {
+  if (reply->getSender() != lastTarget) {
+    return HasReturnvaluesIF::RETURN_FAILED;
+  }
+  switch (reply->getCommand()) {
     case ActionMessage::COMPLETION_SUCCESS:
-        commandCount--;
-        owner->completionSuccessfulReceived(ActionMessage::getActionId(reply));
-        return HasReturnvaluesIF::RETURN_OK;
+      commandCount--;
+      owner->completionSuccessfulReceived(ActionMessage::getActionId(reply));
+      return HasReturnvaluesIF::RETURN_OK;
     case ActionMessage::COMPLETION_FAILED:
-        commandCount--;
-        owner->completionFailedReceived(ActionMessage::getActionId(reply),
-                ActionMessage::getReturnCode(reply));
-        return HasReturnvaluesIF::RETURN_OK;
+      commandCount--;
+      owner->completionFailedReceived(ActionMessage::getActionId(reply),
+                                      ActionMessage::getReturnCode(reply));
+      return HasReturnvaluesIF::RETURN_OK;
     case ActionMessage::STEP_SUCCESS:
-        owner->stepSuccessfulReceived(ActionMessage::getActionId(reply),
-                ActionMessage::getStep(reply));
-        return HasReturnvaluesIF::RETURN_OK;
+      owner->stepSuccessfulReceived(ActionMessage::getActionId(reply),
+                                    ActionMessage::getStep(reply));
+      return HasReturnvaluesIF::RETURN_OK;
     case ActionMessage::STEP_FAILED:
-        commandCount--;
-        owner->stepFailedReceived(ActionMessage::getActionId(reply),
-                ActionMessage::getStep(reply),
-                ActionMessage::getReturnCode(reply));
-        return HasReturnvaluesIF::RETURN_OK;
+      commandCount--;
+      owner->stepFailedReceived(ActionMessage::getActionId(reply), ActionMessage::getStep(reply),
+                                ActionMessage::getReturnCode(reply));
+      return HasReturnvaluesIF::RETURN_OK;
     case ActionMessage::DATA_REPLY:
-        extractDataForOwner(ActionMessage::getActionId(reply),
-                ActionMessage::getStoreId(reply));
-        return HasReturnvaluesIF::RETURN_OK;
+      extractDataForOwner(ActionMessage::getActionId(reply), ActionMessage::getStoreId(reply));
+      return HasReturnvaluesIF::RETURN_OK;
     default:
-        return HasReturnvaluesIF::RETURN_FAILED;
-    }
+      return HasReturnvaluesIF::RETURN_FAILED;
+  }
 }
 
-uint8_t CommandActionHelper::getCommandCount() const {
-    return commandCount;
-}
+uint8_t CommandActionHelper::getCommandCount() const { return commandCount; }
 
 void CommandActionHelper::extractDataForOwner(ActionId_t actionId, store_address_t storeId) {
-    const uint8_t * data = NULL;
-    size_t size = 0;
-    ReturnValue_t result = ipcStore->getData(storeId, &data, &size);
-    if (result != HasReturnvaluesIF::RETURN_OK) {
-        return;
-    }
-    owner->dataReceived(actionId, data, size);
-    ipcStore->deleteData(storeId);
+  const uint8_t *data = nullptr;
+  size_t size = 0;
+  ReturnValue_t result = ipcStore->getData(storeId, &data, &size);
+  if (result != HasReturnvaluesIF::RETURN_OK) {
+    return;
+  }
+  owner->dataReceived(actionId, data, size);
+  ipcStore->deleteData(storeId);
 }

src/fsfw/action/CommandActionHelper.h

@@ -2,35 +2,35 @@
 #define COMMANDACTIONHELPER_H_
 
 #include "ActionMessage.h"
+#include "fsfw/ipc/MessageQueueIF.h"
 #include "fsfw/objectmanager/ObjectManagerIF.h"
 #include "fsfw/returnvalues/HasReturnvaluesIF.h"
 #include "fsfw/serialize/SerializeIF.h"
 #include "fsfw/storagemanager/StorageManagerIF.h"
-#include "fsfw/ipc/MessageQueueIF.h"
 
 class CommandsActionsIF;
 
 class CommandActionHelper {
-    friend class CommandsActionsIF;
-public:
-    CommandActionHelper(CommandsActionsIF* owner);
-    virtual ~CommandActionHelper();
-    ReturnValue_t commandAction(object_id_t commandTo,
-            ActionId_t actionId, const uint8_t* data, uint32_t size);
-    ReturnValue_t commandAction(object_id_t commandTo,
-            ActionId_t actionId, SerializeIF* data);
-    ReturnValue_t initialize();
-    ReturnValue_t handleReply(CommandMessage* reply);
-    uint8_t getCommandCount() const;
-private:
-    CommandsActionsIF* owner;
-    MessageQueueIF* queueToUse;
-    StorageManagerIF* ipcStore;
-    uint8_t commandCount;
-    MessageQueueId_t lastTarget;
-    void extractDataForOwner(ActionId_t actionId, store_address_t storeId);
-    ReturnValue_t sendCommand(MessageQueueId_t queueId, ActionId_t actionId,
-            store_address_t storeId);
+  friend class CommandsActionsIF;
+
+ public:
+  explicit CommandActionHelper(CommandsActionsIF* owner);
+  virtual ~CommandActionHelper();
+  ReturnValue_t commandAction(object_id_t commandTo, ActionId_t actionId, const uint8_t* data,
+                              uint32_t size);
+  ReturnValue_t commandAction(object_id_t commandTo, ActionId_t actionId, SerializeIF* data);
+  ReturnValue_t initialize();
+  ReturnValue_t handleReply(CommandMessage* reply);
+  [[nodiscard]] uint8_t getCommandCount() const;
+
+ private:
+  CommandsActionsIF* owner;
+  MessageQueueIF* queueToUse;
+  StorageManagerIF* ipcStore;
+  uint8_t commandCount;
+  MessageQueueId_t lastTarget;
+  void extractDataForOwner(ActionId_t actionId, store_address_t storeId);
+  ReturnValue_t sendCommand(MessageQueueId_t queueId, ActionId_t actionId, store_address_t storeId);
 };
 
 #endif /* COMMANDACTIONHELPER_H_ */

src/fsfw/action/CommandsActionsIF.h

@@ -2,8 +2,8 @@
 #define FSFW_ACTION_COMMANDSACTIONSIF_H_
 
 #include "CommandActionHelper.h"
-#include "../returnvalues/HasReturnvaluesIF.h"
-#include "../ipc/MessageQueueIF.h"
+#include "fsfw/ipc/MessageQueueIF.h"
+#include "fsfw/returnvalues/HasReturnvaluesIF.h"
 
 /**
  * Interface to separate commanding actions of other objects.
@@ -15,23 +15,21 @@
  * - replyReceived(id, step, cause) (if cause == OK, it's a success).
  */
 class CommandsActionsIF {
-    friend class CommandActionHelper;
-public:
-    static const uint8_t INTERFACE_ID = CLASS_ID::COMMANDS_ACTIONS_IF;
-    static const ReturnValue_t OBJECT_HAS_NO_FUNCTIONS = MAKE_RETURN_CODE(1);
-    static const ReturnValue_t ALREADY_COMMANDING = MAKE_RETURN_CODE(2);
-    virtual ~CommandsActionsIF() {}
-    virtual MessageQueueIF* getCommandQueuePtr() = 0;
-protected:
-    virtual void stepSuccessfulReceived(ActionId_t actionId, uint8_t step) = 0;
-    virtual void stepFailedReceived(ActionId_t actionId, uint8_t step,
-            ReturnValue_t returnCode) = 0;
-    virtual void dataReceived(ActionId_t actionId, const uint8_t* data,
-            uint32_t size) = 0;
-    virtual void completionSuccessfulReceived(ActionId_t actionId) = 0;
-    virtual void completionFailedReceived(ActionId_t actionId,
-            ReturnValue_t returnCode) = 0;
+  friend class CommandActionHelper;
+
+ public:
+  static const uint8_t INTERFACE_ID = CLASS_ID::COMMANDS_ACTIONS_IF;
+  static const ReturnValue_t OBJECT_HAS_NO_FUNCTIONS = MAKE_RETURN_CODE(1);
+  static const ReturnValue_t ALREADY_COMMANDING = MAKE_RETURN_CODE(2);
+  virtual ~CommandsActionsIF() = default;
+  virtual MessageQueueIF* getCommandQueuePtr() = 0;
+
+ protected:
+  virtual void stepSuccessfulReceived(ActionId_t actionId, uint8_t step) = 0;
+  virtual void stepFailedReceived(ActionId_t actionId, uint8_t step, ReturnValue_t returnCode) = 0;
+  virtual void dataReceived(ActionId_t actionId, const uint8_t* data, uint32_t size) = 0;
+  virtual void completionSuccessfulReceived(ActionId_t actionId) = 0;
+  virtual void completionFailedReceived(ActionId_t actionId, ReturnValue_t returnCode) = 0;
 };
 
-
 #endif /* FSFW_ACTION_COMMANDSACTIONSIF_H_ */

src/fsfw/action/HasActionsIF.h

@@ -4,8 +4,8 @@
 #include "ActionHelper.h"
 #include "ActionMessage.h"
 #include "SimpleActionHelper.h"
-#include "../returnvalues/HasReturnvaluesIF.h"
-#include "../ipc/MessageQueueIF.h"
+#include "fsfw/ipc/MessageQueueIF.h"
+#include "fsfw/returnvalues/HasReturnvaluesIF.h"
 
 /**
  * @brief
@@ -34,30 +34,29 @@
  * @ingroup interfaces
  */
 class HasActionsIF {
-public:
-    static const uint8_t INTERFACE_ID = CLASS_ID::HAS_ACTIONS_IF;
-    static const ReturnValue_t IS_BUSY = MAKE_RETURN_CODE(1);
-    static const ReturnValue_t INVALID_PARAMETERS = MAKE_RETURN_CODE(2);
-    static const ReturnValue_t EXECUTION_FINISHED = MAKE_RETURN_CODE(3);
-    static const ReturnValue_t INVALID_ACTION_ID = MAKE_RETURN_CODE(4);
-    virtual ~HasActionsIF() { }
-    /**
-     * Function to get the MessageQueueId_t of the implementing object
-     * @return MessageQueueId_t of the object
-     */
-    virtual MessageQueueId_t getCommandQueue() const = 0;
-    /**
-     * Execute or initialize the execution of a certain function.
-     * The ActionHelpers will execute this function and behave differently
-     * depending on the returnvalue.
-     *
-     * @return
-     * -@c EXECUTION_FINISHED Finish reply will be generated
-     * -@c Not RETURN_OK Step failure reply will be generated
-     */
-    virtual ReturnValue_t executeAction(ActionId_t actionId,
-            MessageQueueId_t commandedBy, const uint8_t* data, size_t size) = 0;
+ public:
+  static const uint8_t INTERFACE_ID = CLASS_ID::HAS_ACTIONS_IF;
+  static const ReturnValue_t IS_BUSY = MAKE_RETURN_CODE(1);
+  static const ReturnValue_t INVALID_PARAMETERS = MAKE_RETURN_CODE(2);
+  static const ReturnValue_t EXECUTION_FINISHED = MAKE_RETURN_CODE(3);
+  static const ReturnValue_t INVALID_ACTION_ID = MAKE_RETURN_CODE(4);
+  virtual ~HasActionsIF() = default;
+  /**
+   * Function to get the MessageQueueId_t of the implementing object
+   * @return MessageQueueId_t of the object
+   */
+  [[nodiscard]] virtual MessageQueueId_t getCommandQueue() const = 0;
+  /**
+   * Execute or initialize the execution of a certain function.
+   * The ActionHelpers will execute this function and behave differently
+   * depending on the returnvalue.
+   *
+   * @return
+   * -@c EXECUTION_FINISHED Finish reply will be generated
+   * -@c Not RETURN_OK Step failure reply will be generated
+   */
+  virtual ReturnValue_t executeAction(ActionId_t actionId, MessageQueueId_t commandedBy,
+                                      const uint8_t* data, size_t size) = 0;
 };
 
-
 #endif /* FSFW_ACTION_HASACTIONSIF_H_ */

src/fsfw/action/SimpleActionHelper.cpp

@@ -1,74 +1,67 @@
 #include "fsfw/action.h"
 
-SimpleActionHelper::SimpleActionHelper(HasActionsIF* setOwner,
-        MessageQueueIF* useThisQueue) :
-        ActionHelper(setOwner, useThisQueue), isExecuting(false) {
-}
+SimpleActionHelper::SimpleActionHelper(HasActionsIF* setOwner, MessageQueueIF* useThisQueue)
+    : ActionHelper(setOwner, useThisQueue), isExecuting(false) {}
 
-SimpleActionHelper::~SimpleActionHelper() {
-}
+SimpleActionHelper::~SimpleActionHelper() = default;
 
 void SimpleActionHelper::step(ReturnValue_t result) {
-    // STEP_OFFESET is subtracted to compensate for adding offset in base
-    // method, which is not necessary here.
-    ActionHelper::step(stepCount - STEP_OFFSET, lastCommander, lastAction,
-            result);
-    if (result != HasReturnvaluesIF::RETURN_OK) {
-        resetHelper();
-    }
+  // STEP_OFFESET is subtracted to compensate for adding offset in base
+  // method, which is not necessary here.
+  ActionHelper::step(stepCount - STEP_OFFSET, lastCommander, lastAction, result);
+  if (result != HasReturnvaluesIF::RETURN_OK) {
+    resetHelper();
+  }
 }
 
 void SimpleActionHelper::finish(ReturnValue_t result) {
-    ActionHelper::finish(lastCommander, lastAction, result);
-    resetHelper();
+  ActionHelper::finish(lastCommander, lastAction, result);
+  resetHelper();
 }
 
 ReturnValue_t SimpleActionHelper::reportData(SerializeIF* data) {
-    return ActionHelper::reportData(lastCommander, lastAction, data);
+  return ActionHelper::reportData(lastCommander, lastAction, data);
 }
 
 void SimpleActionHelper::resetHelper() {
-    stepCount = 0;
-    isExecuting = false;
-    lastAction = 0;
-    lastCommander = 0;
+  stepCount = 0;
+  isExecuting = false;
+  lastAction = 0;
+  lastCommander = 0;
 }
 
-void SimpleActionHelper::prepareExecution(MessageQueueId_t commandedBy,
-        ActionId_t actionId, store_address_t dataAddress) {
-    CommandMessage reply;
-    if (isExecuting) {
-        ipcStore->deleteData(dataAddress);
-        ActionMessage::setStepReply(&reply, actionId, 0,
-                HasActionsIF::IS_BUSY);
-        queueToUse->sendMessage(commandedBy, &reply);
-    }
-    const uint8_t* dataPtr = NULL;
-    size_t size = 0;
-    ReturnValue_t result = ipcStore->getData(dataAddress, &dataPtr, &size);
-    if (result != HasReturnvaluesIF::RETURN_OK) {
-        ActionMessage::setStepReply(&reply, actionId, 0, result);
-        queueToUse->sendMessage(commandedBy, &reply);
-        return;
-    }
-    lastCommander = commandedBy;
-    lastAction = actionId;
-    result = owner->executeAction(actionId, commandedBy, dataPtr, size);
+void SimpleActionHelper::prepareExecution(MessageQueueId_t commandedBy, ActionId_t actionId,
+                                          store_address_t dataAddress) {
+  CommandMessage reply;
+  if (isExecuting) {
     ipcStore->deleteData(dataAddress);
-    switch (result) {
+    ActionMessage::setStepReply(&reply, actionId, 0, HasActionsIF::IS_BUSY);
+    queueToUse->sendMessage(commandedBy, &reply);
+  }
+  const uint8_t* dataPtr = nullptr;
+  size_t size = 0;
+  ReturnValue_t result = ipcStore->getData(dataAddress, &dataPtr, &size);
+  if (result != HasReturnvaluesIF::RETURN_OK) {
+    ActionMessage::setStepReply(&reply, actionId, 0, result);
+    queueToUse->sendMessage(commandedBy, &reply);
+    return;
+  }
+  lastCommander = commandedBy;
+  lastAction = actionId;
+  result = owner->executeAction(actionId, commandedBy, dataPtr, size);
+  ipcStore->deleteData(dataAddress);
+  switch (result) {
     case HasReturnvaluesIF::RETURN_OK:
-        isExecuting = true;
-        stepCount++;
-        break;
+      isExecuting = true;
+      stepCount++;
+      break;
     case HasActionsIF::EXECUTION_FINISHED:
-        ActionMessage::setCompletionReply(&reply, actionId,
-                true, HasReturnvaluesIF::RETURN_OK);
-        queueToUse->sendMessage(commandedBy, &reply);
-        break;
+      ActionMessage::setCompletionReply(&reply, actionId, true, HasReturnvaluesIF::RETURN_OK);
+      queueToUse->sendMessage(commandedBy, &reply);
+      break;
     default:
-        ActionMessage::setStepReply(&reply, actionId, 0, result);
-        queueToUse->sendMessage(commandedBy, &reply);
-        break;
-    }
-
+      ActionMessage::setStepReply(&reply, actionId, 0, result);
+      queueToUse->sendMessage(commandedBy, &reply);
+      break;
+  }
 }

src/fsfw/action/SimpleActionHelper.h

@@ -8,23 +8,24 @@
  *             at a time but remembers last commander and last action which
  *             simplifies usage
  */
-class SimpleActionHelper: public ActionHelper {
-public:
-    SimpleActionHelper(HasActionsIF* setOwner, MessageQueueIF* useThisQueue);
-    virtual ~SimpleActionHelper();
-    void step(ReturnValue_t result = HasReturnvaluesIF::RETURN_OK);
-    void finish(ReturnValue_t result = HasReturnvaluesIF::RETURN_OK);
-    ReturnValue_t reportData(SerializeIF* data);
+class SimpleActionHelper : public ActionHelper {
+ public:
+  SimpleActionHelper(HasActionsIF* setOwner, MessageQueueIF* useThisQueue);
+  ~SimpleActionHelper() override;
+  void step(ReturnValue_t result = HasReturnvaluesIF::RETURN_OK);
+  void finish(ReturnValue_t result = HasReturnvaluesIF::RETURN_OK);
+  ReturnValue_t reportData(SerializeIF* data);
 
-protected:
-    void prepareExecution(MessageQueueId_t commandedBy, ActionId_t actionId,
-            store_address_t dataAddress);
-    virtual void resetHelper();
-private:
-    bool isExecuting;
-    MessageQueueId_t lastCommander = MessageQueueIF::NO_QUEUE;
-    ActionId_t lastAction = 0;
-    uint8_t stepCount = 0;
+ protected:
+  void prepareExecution(MessageQueueId_t commandedBy, ActionId_t actionId,
+                        store_address_t dataAddress) override;
+  void resetHelper() override;
+
+ private:
+  bool isExecuting;
+  MessageQueueId_t lastCommander = MessageQueueIF::NO_QUEUE;
+  ActionId_t lastAction = 0;
+  uint8_t stepCount = 0;
 };
 
-#endif /* SIMPLEACTIONHELPER_H_ */
+#endif /* FSFW_ACTION_SIMPLEACTIONHELPER_H_ */

src/fsfw/cfdp/CFDPHandler.cpp

@@ -0,0 +1,57 @@
+#include "fsfw/cfdp/CFDPHandler.h"
+
+#include "fsfw/cfdp/CFDPMessage.h"
+#include "fsfw/ipc/CommandMessage.h"
+#include "fsfw/ipc/QueueFactory.h"
+#include "fsfw/objectmanager/ObjectManager.h"
+#include "fsfw/storagemanager/storeAddress.h"
+#include "fsfw/tmtcservices/AcceptsTelemetryIF.h"
+
+object_id_t CFDPHandler::packetSource = 0;
+object_id_t CFDPHandler::packetDestination = 0;
+
+CFDPHandler::CFDPHandler(object_id_t setObjectId, CFDPDistributor* dist)
+    : SystemObject(setObjectId) {
+  requestQueue = QueueFactory::instance()->createMessageQueue(CFDP_HANDLER_MAX_RECEPTION);
+  distributor = dist;
+}
+
+CFDPHandler::~CFDPHandler() {}
+
+ReturnValue_t CFDPHandler::initialize() {
+  ReturnValue_t result = SystemObject::initialize();
+  if (result != RETURN_OK) {
+    return result;
+  }
+  this->distributor->registerHandler(this);
+  return HasReturnvaluesIF::RETURN_OK;
+}
+
+ReturnValue_t CFDPHandler::handleRequest(store_address_t storeId) {
+#if FSFW_VERBOSE_LEVEL >= 1
+#if FSFW_CPP_OSTREAM_ENABLED == 1
+  sif::debug << "CFDPHandler::handleRequest" << std::endl;
+#else
+  sif::printDebug("CFDPHandler::handleRequest\n");
+#endif /* !FSFW_CPP_OSTREAM_ENABLED == 1 */
+#endif
+
+  // TODO read out packet from store using storeId
+
+  return RETURN_OK;
+}
+
+ReturnValue_t CFDPHandler::performOperation(uint8_t opCode) {
+  ReturnValue_t status = RETURN_OK;
+  CommandMessage currentMessage;
+  for (status = this->requestQueue->receiveMessage(&currentMessage); status == RETURN_OK;
+       status = this->requestQueue->receiveMessage(&currentMessage)) {
+    store_address_t storeId = CFDPMessage::getStoreId(&currentMessage);
+    this->handleRequest(storeId);
+  }
+  return RETURN_OK;
+}
+
+uint16_t CFDPHandler::getIdentifier() { return 0; }
+
+MessageQueueId_t CFDPHandler::getRequestQueue() { return this->requestQueue->getId(); }

src/fsfw/cfdp/CFDPHandler.h

@@ -0,0 +1,63 @@
+#ifndef FSFW_CFDP_CFDPHANDLER_H_
+#define FSFW_CFDP_CFDPHANDLER_H_
+
+#include "fsfw/ipc/MessageQueueIF.h"
+#include "fsfw/objectmanager/SystemObject.h"
+#include "fsfw/returnvalues/HasReturnvaluesIF.h"
+#include "fsfw/tasks/ExecutableObjectIF.h"
+#include "fsfw/tcdistribution/CFDPDistributor.h"
+#include "fsfw/tmtcservices/AcceptsTelecommandsIF.h"
+
+namespace Factory {
+void setStaticFrameworkObjectIds();
+}
+
+class CFDPHandler : public ExecutableObjectIF,
+                    public AcceptsTelecommandsIF,
+                    public SystemObject,
+                    public HasReturnvaluesIF {
+  friend void(Factory::setStaticFrameworkObjectIds)();
+
+ public:
+  CFDPHandler(object_id_t setObjectId, CFDPDistributor* distributor);
+  /**
+   * The destructor is empty.
+   */
+  virtual ~CFDPHandler();
+
+  virtual ReturnValue_t handleRequest(store_address_t storeId);
+
+  virtual ReturnValue_t initialize() override;
+  virtual uint16_t getIdentifier() override;
+  MessageQueueId_t getRequestQueue() override;
+  ReturnValue_t performOperation(uint8_t opCode) override;
+
+ protected:
+  /**
+   * This is a complete instance of the telecommand reception queue
+   * of the class. It is initialized on construction of the class.
+   */
+  MessageQueueIF* requestQueue = nullptr;
+
+  CFDPDistributor* distributor = nullptr;
+
+  /**
+   * The current CFDP packet to be processed.
+   * It is deleted after handleRequest was executed.
+   */
+  CFDPPacketStored currentPacket;
+
+  static object_id_t packetSource;
+
+  static object_id_t packetDestination;
+
+ private:
+  /**
+   * This constant sets the maximum number of packets accepted per call.
+   * Remember that one packet must be completely handled in one
+   * #handleRequest call.
+   */
+  static const uint8_t CFDP_HANDLER_MAX_RECEPTION = 100;
+};
+
+#endif /* FSFW_CFDP_CFDPHANDLER_H_ */

src/fsfw/cfdp/CFDPMessage.cpp

@@ -0,0 +1,17 @@
+#include "CFDPMessage.h"
+
+CFDPMessage::CFDPMessage() {}
+
+CFDPMessage::~CFDPMessage() {}
+
+void CFDPMessage::setCommand(CommandMessage *message, store_address_t cfdpPacket) {
+  message->setParameter(cfdpPacket.raw);
+}
+
+store_address_t CFDPMessage::getStoreId(const CommandMessage *message) {
+  store_address_t storeAddressCFDPPacket;
+  storeAddressCFDPPacket = message->getParameter();
+  return storeAddressCFDPPacket;
+}
+
+void CFDPMessage::clear(CommandMessage *message) {}

src/fsfw/cfdp/CFDPMessage.h

@@ -0,0 +1,23 @@
+#ifndef FSFW_CFDP_CFDPMESSAGE_H_
+#define FSFW_CFDP_CFDPMESSAGE_H_
+
+#include "fsfw/ipc/CommandMessage.h"
+#include "fsfw/objectmanager/ObjectManagerIF.h"
+#include "fsfw/storagemanager/StorageManagerIF.h"
+
+class CFDPMessage {
+ private:
+  CFDPMessage();
+
+ public:
+  static const uint8_t MESSAGE_ID = messagetypes::CFDP;
+
+  virtual ~CFDPMessage();
+  static void setCommand(CommandMessage* message, store_address_t cfdpPacket);
+
+  static store_address_t getStoreId(const CommandMessage* message);
+
+  static void clear(CommandMessage* message);
+};
+
+#endif /* FSFW_CFDP_CFDPMESSAGE_H_ */

src/fsfw/cfdp/CMakeLists.txt

@@ -0,0 +1,4 @@
+target_sources(${LIB_FSFW_NAME} PRIVATE CFDPHandler.cpp CFDPMessage.cpp)
+
+add_subdirectory(pdu)
+add_subdirectory(tlv)

src/fsfw/cfdp/FileSize.h

@@ -0,0 +1,78 @@
+#ifndef FSFW_SRC_FSFW_CFDP_FILESIZE_H_
+#define FSFW_SRC_FSFW_CFDP_FILESIZE_H_
+
+#include "fsfw/serialize/SerializeAdapter.h"
+#include "fsfw/serialize/SerializeIF.h"
+
+namespace cfdp {
+
+struct FileSize : public SerializeIF {
+ public:
+  FileSize() : largeFile(false){};
+
+  FileSize(uint64_t fileSize, bool isLarge = false) { setFileSize(fileSize, isLarge); };
+
+  ReturnValue_t serialize(bool isLarge, uint8_t **buffer, size_t *size, size_t maxSize,
+                          Endianness streamEndianness) {
+    this->largeFile = isLarge;
+    return serialize(buffer, size, maxSize, streamEndianness);
+  }
+
+  ReturnValue_t serialize(uint8_t **buffer, size_t *size, size_t maxSize,
+                          Endianness streamEndianness) const override {
+    if (not largeFile) {
+      uint32_t fileSizeTyped = fileSize;
+      return SerializeAdapter::serialize(&fileSizeTyped, buffer, size, maxSize, streamEndianness);
+    }
+    return SerializeAdapter::serialize(&fileSize, buffer, size, maxSize, streamEndianness);
+  }
+
+  size_t getSerializedSize() const override {
+    if (largeFile) {
+      return 8;
+    } else {
+      return 4;
+    }
+  }
+
+  ReturnValue_t deSerialize(const uint8_t **buffer, size_t *size,
+                            Endianness streamEndianness) override {
+    if (largeFile) {
+      return SerializeAdapter::deSerialize(&size, buffer, size, streamEndianness);
+    } else {
+      uint32_t sizeTmp = 0;
+      ReturnValue_t result =
+          SerializeAdapter::deSerialize(&sizeTmp, buffer, size, streamEndianness);
+      if (result == HasReturnvaluesIF::RETURN_OK) {
+        fileSize = sizeTmp;
+      }
+      return result;
+    }
+  }
+
+  ReturnValue_t setFileSize(uint64_t fileSize, bool largeFile) {
+    if (not largeFile and fileSize > UINT32_MAX) {
+      // TODO: emit warning here
+      return HasReturnvaluesIF::RETURN_FAILED;
+    }
+    this->fileSize = fileSize;
+    this->largeFile = largeFile;
+    return HasReturnvaluesIF::RETURN_OK;
+  }
+
+  bool isLargeFile() const { return largeFile; }
+  uint64_t getSize(bool *largeFile = nullptr) const {
+    if (largeFile != nullptr) {
+      *largeFile = this->largeFile;
+    }
+    return fileSize;
+  }
+
+ private:
+  uint64_t fileSize = 0;
+  bool largeFile = false;
+};
+
+}  // namespace cfdp
+
+#endif /* FSFW_SRC_FSFW_CFDP_FILESIZE_H_ */

src/fsfw/cfdp/definitions.h

@@ -0,0 +1,137 @@
+#ifndef FSFW_SRC_FSFW_CFDP_PDU_DEFINITIONS_H_
+#define FSFW_SRC_FSFW_CFDP_PDU_DEFINITIONS_H_
+
+#include <fsfw/serialize/SerializeIF.h>
+
+#include <cstddef>
+#include <cstdint>
+
+#include "fsfw/returnvalues/FwClassIds.h"
+#include "fsfw/returnvalues/HasReturnvaluesIF.h"
+
+namespace cfdp {
+
+static constexpr uint8_t VERSION_BITS = 0b00100000;
+
+static constexpr uint8_t CFDP_CLASS_ID = CLASS_ID::CFDP;
+
+static constexpr ReturnValue_t INVALID_TLV_TYPE =
+    HasReturnvaluesIF::makeReturnCode(CFDP_CLASS_ID, 1);
+static constexpr ReturnValue_t INVALID_DIRECTIVE_FIELDS =
+    HasReturnvaluesIF::makeReturnCode(CFDP_CLASS_ID, 2);
+static constexpr ReturnValue_t INVALID_PDU_DATAFIELD_LEN =
+    HasReturnvaluesIF::makeReturnCode(CFDP_CLASS_ID, 3);
+static constexpr ReturnValue_t INVALID_ACK_DIRECTIVE_FIELDS =
+    HasReturnvaluesIF::makeReturnCode(CFDP_CLASS_ID, 4);
+//! Can not parse options. This can also occur because there are options
+//! available but the user did not pass a valid options array
+static constexpr ReturnValue_t METADATA_CANT_PARSE_OPTIONS =
+    HasReturnvaluesIF::makeReturnCode(CFDP_CLASS_ID, 5);
+static constexpr ReturnValue_t NAK_CANT_PARSE_OPTIONS =
+    HasReturnvaluesIF::makeReturnCode(CFDP_CLASS_ID, 6);
+static constexpr ReturnValue_t FINISHED_CANT_PARSE_FS_RESPONSES =
+    HasReturnvaluesIF::makeReturnCode(CFDP_CLASS_ID, 6);
+static constexpr ReturnValue_t FILESTORE_REQUIRES_SECOND_FILE =
+    HasReturnvaluesIF::makeReturnCode(CFDP_CLASS_ID, 8);
+//! Can not parse filestore response because user did not pass a valid instance
+//! or remaining size is invalid
+static constexpr ReturnValue_t FILESTORE_RESPONSE_CANT_PARSE_FS_MESSAGE =
+    HasReturnvaluesIF::makeReturnCode(CFDP_CLASS_ID, 9);
+
+//! Checksum types according to the SANA Checksum Types registry
+//! https://sanaregistry.org/r/checksum_identifiers/
+enum ChecksumType {
+  // Modular legacy checksum
+  MODULAR = 0,
+  CRC_32_PROXIMITY_1 = 1,
+  CRC_32C = 2,
+  CRC_32 = 3,
+  NULL_CHECKSUM = 15
+};
+
+enum PduType : bool { FILE_DIRECTIVE = 0, FILE_DATA = 1 };
+
+enum TransmissionModes : bool { ACKNOWLEDGED = 0, UNACKNOWLEDGED = 1 };
+
+enum SegmentMetadataFlag : bool { NOT_PRESENT = 0, PRESENT = 1 };
+
+enum Direction : bool { TOWARDS_RECEIVER = 0, TOWARDS_SENDER = 1 };
+
+enum SegmentationControl : bool {
+  NO_RECORD_BOUNDARIES_PRESERVATION = 0,
+  RECORD_BOUNDARIES_PRESERVATION = 1
+};
+
+enum WidthInBytes : uint8_t {
+  // Only those are supported for now
+  ONE_BYTE = 1,
+  TWO_BYTES = 2,
+  FOUR_BYTES = 4,
+};
+
+enum FileDirectives : uint8_t {
+  INVALID_DIRECTIVE = 0x0f,
+  EOF_DIRECTIVE = 0x04,
+  FINISH = 0x05,
+  ACK = 0x06,
+  METADATA = 0x07,
+  NAK = 0x08,
+  PROMPT = 0x09,
+  KEEP_ALIVE = 0x0c
+};
+
+enum ConditionCode : uint8_t {
+  NO_CONDITION_FIELD = 0xff,
+  NO_ERROR = 0b0000,
+  POSITIVE_ACK_LIMIT_REACHED = 0b0001,
+  KEEP_ALIVE_LIMIT_REACHED = 0b0010,
+  INVALID_TRANSMISSION_MODE = 0b0011,
+  FILESTORE_REJECTION = 0b0100,
+  FILE_CHECKSUM_FAILURE = 0b0101,
+  FILE_SIZE_ERROR = 0b0110,
+  NAK_LIMIT_REACHED = 0b0111,
+  INACTIVITY_DETECTED = 0b1000,
+  CHECK_LIMIT_REACHED = 0b1010,
+  UNSUPPORTED_CHECKSUM_TYPE = 0b1011,
+  SUSPEND_REQUEST_RECEIVED = 0b1110,
+  CANCEL_REQUEST_RECEIVED = 0b1111
+};
+
+enum AckTransactionStatus {
+  UNDEFINED = 0b00,
+  ACTIVE = 0b01,
+  TERMINATED = 0b10,
+  UNRECOGNIZED = 0b11
+};
+
+enum FinishedDeliveryCode { DATA_COMPLETE = 0, DATA_INCOMPLETE = 1 };
+
+enum FinishedFileStatus {
+  DISCARDED_DELIBERATELY = 0,
+  DISCARDED_FILESTORE_REJECTION = 1,
+  RETAINED_IN_FILESTORE = 2,
+  FILE_STATUS_UNREPORTED = 3
+};
+
+enum PromptResponseRequired : bool { PROMPT_NAK = 0, PROMPT_KEEP_ALIVE = 1 };
+
+enum TlvTypes : uint8_t {
+  FILESTORE_REQUEST = 0x00,
+  FILESTORE_RESPONSE = 0x01,
+  MSG_TO_USER = 0x02,
+  FAULT_HANDLER = 0x04,
+  FLOW_LABEL = 0x05,
+  ENTITY_ID = 0x06,
+  INVALID_TLV = 0xff,
+};
+
+enum RecordContinuationState {
+  NO_START_NO_END = 0b00,
+  CONTAINS_START_NO_END = 0b01,
+  CONTAINS_END_NO_START = 0b10,
+  CONTAINS_START_AND_END = 0b11
+};
+
+}  // namespace cfdp
+
+#endif /* FSFW_SRC_FSFW_CFDP_PDU_DEFINITIONS_H_ */

src/fsfw/cfdp/pdu/AckInfo.cpp

@@ -0,0 +1,45 @@
+#include "AckInfo.h"
+
+AckInfo::AckInfo(cfdp::FileDirectives ackedDirective, cfdp::ConditionCode ackedConditionCode,
+                 cfdp::AckTransactionStatus transactionStatus, uint8_t directiveSubtypeCode)
+    : ackedDirective(ackedDirective),
+      ackedConditionCode(ackedConditionCode),
+      transactionStatus(transactionStatus),
+      directiveSubtypeCode(directiveSubtypeCode) {
+  if (ackedDirective == cfdp::FileDirectives::FINISH) {
+    this->directiveSubtypeCode = 0b0001;
+  } else {
+    this->directiveSubtypeCode = 0b0000;
+  }
+}
+
+cfdp::ConditionCode AckInfo::getAckedConditionCode() const { return ackedConditionCode; }
+
+void AckInfo::setAckedConditionCode(cfdp::ConditionCode ackedConditionCode) {
+  this->ackedConditionCode = ackedConditionCode;
+  if (ackedDirective == cfdp::FileDirectives::FINISH) {
+    this->directiveSubtypeCode = 0b0001;
+  } else {
+    this->directiveSubtypeCode = 0b0000;
+  }
+}
+
+cfdp::FileDirectives AckInfo::getAckedDirective() const { return ackedDirective; }
+
+void AckInfo::setAckedDirective(cfdp::FileDirectives ackedDirective) {
+  this->ackedDirective = ackedDirective;
+}
+
+uint8_t AckInfo::getDirectiveSubtypeCode() const { return directiveSubtypeCode; }
+
+void AckInfo::setDirectiveSubtypeCode(uint8_t directiveSubtypeCode) {
+  this->directiveSubtypeCode = directiveSubtypeCode;
+}
+
+cfdp::AckTransactionStatus AckInfo::getTransactionStatus() const { return transactionStatus; }
+
+AckInfo::AckInfo() {}
+
+void AckInfo::setTransactionStatus(cfdp::AckTransactionStatus transactionStatus) {
+  this->transactionStatus = transactionStatus;
+}

src/fsfw/cfdp/pdu/AckInfo.h

@@ -0,0 +1,31 @@
+#ifndef FSFW_SRC_FSFW_CFDP_PDU_ACKINFO_H_
+#define FSFW_SRC_FSFW_CFDP_PDU_ACKINFO_H_
+
+#include "../definitions.h"
+
+class AckInfo {
+ public:
+  AckInfo();
+  AckInfo(cfdp::FileDirectives ackedDirective, cfdp::ConditionCode ackedConditionCode,
+          cfdp::AckTransactionStatus transactionStatus, uint8_t directiveSubtypeCode = 0);
+
+  cfdp::ConditionCode getAckedConditionCode() const;
+  void setAckedConditionCode(cfdp::ConditionCode ackedConditionCode);
+
+  cfdp::FileDirectives getAckedDirective() const;
+  void setAckedDirective(cfdp::FileDirectives ackedDirective);
+
+  uint8_t getDirectiveSubtypeCode() const;
+  void setDirectiveSubtypeCode(uint8_t directiveSubtypeCode);
+
+  cfdp::AckTransactionStatus getTransactionStatus() const;
+  void setTransactionStatus(cfdp::AckTransactionStatus transactionStatus);
+
+ private:
+  cfdp::FileDirectives ackedDirective = cfdp::FileDirectives::INVALID_DIRECTIVE;
+  cfdp::ConditionCode ackedConditionCode = cfdp::ConditionCode::NO_CONDITION_FIELD;
+  cfdp::AckTransactionStatus transactionStatus = cfdp::AckTransactionStatus::UNDEFINED;
+  uint8_t directiveSubtypeCode = 0;
+};
+
+#endif /* FSFW_SRC_FSFW_CFDP_PDU_ACKINFO_H_ */

src/fsfw/cfdp/pdu/AckPduDeserializer.cpp

@@ -0,0 +1,37 @@
+#include "AckPduDeserializer.h"
+
+AckPduDeserializer::AckPduDeserializer(const uint8_t* pduBuf, size_t maxSize, AckInfo& info)
+    : FileDirectiveDeserializer(pduBuf, maxSize), info(info) {}
+
+ReturnValue_t AckPduDeserializer::parseData() {
+  ReturnValue_t result = FileDirectiveDeserializer::parseData();
+  if (result != HasReturnvaluesIF::RETURN_OK) {
+    return result;
+  }
+  size_t currentIdx = FileDirectiveDeserializer::getHeaderSize();
+  if (currentIdx + 2 > this->maxSize) {
+    return SerializeIF::BUFFER_TOO_SHORT;
+  }
+  if (not checkAndSetCodes(rawPtr[currentIdx], rawPtr[currentIdx + 1])) {
+    return cfdp::INVALID_ACK_DIRECTIVE_FIELDS;
+  }
+  return HasReturnvaluesIF::RETURN_OK;
+}
+
+bool AckPduDeserializer::checkAndSetCodes(uint8_t firstByte, uint8_t secondByte) {
+  uint8_t ackedDirective = static_cast<cfdp::FileDirectives>(firstByte >> 4);
+
+  if (ackedDirective != cfdp::FileDirectives::EOF_DIRECTIVE and
+      ackedDirective != cfdp::FileDirectives::FINISH) {
+    return false;
+  }
+  this->info.setAckedDirective(static_cast<cfdp::FileDirectives>(ackedDirective));
+  uint8_t directiveSubtypeCode = firstByte & 0x0f;
+  if (directiveSubtypeCode != 0b0000 and directiveSubtypeCode != 0b0001) {
+    return false;
+  }
+  this->info.setDirectiveSubtypeCode(directiveSubtypeCode);
+  this->info.setAckedConditionCode(static_cast<cfdp::ConditionCode>(secondByte >> 4));
+  this->info.setTransactionStatus(static_cast<cfdp::AckTransactionStatus>(secondByte & 0x0f));
+  return true;
+}

src/fsfw/cfdp/pdu/AckPduDeserializer.h

@@ -0,0 +1,23 @@
+#ifndef FSFW_SRC_FSFW_CFDP_PDU_ACKPDUDESERIALIZER_H_
+#define FSFW_SRC_FSFW_CFDP_PDU_ACKPDUDESERIALIZER_H_
+
+#include "AckInfo.h"
+#include "fsfw/cfdp/pdu/FileDirectiveDeserializer.h"
+
+class AckPduDeserializer : public FileDirectiveDeserializer {
+ public:
+  AckPduDeserializer(const uint8_t* pduBuf, size_t maxSize, AckInfo& info);
+
+  /**
+   *
+   * @return
+   *  - cfdp::INVALID_DIRECTIVE_FIELDS: Invalid fields
+   */
+  ReturnValue_t parseData();
+
+ private:
+  bool checkAndSetCodes(uint8_t rawAckedByte, uint8_t rawAckedConditionCode);
+  AckInfo& info;
+};
+
+#endif /* FSFW_SRC_FSFW_CFDP_PDU_ACKPDUDESERIALIZER_H_ */

src/fsfw/cfdp/pdu/AckPduSerializer.cpp

@@ -0,0 +1,36 @@
+#include "AckPduSerializer.h"
+
+AckPduSerializer::AckPduSerializer(AckInfo &ackInfo, PduConfig &pduConf)
+    : FileDirectiveSerializer(pduConf, cfdp::FileDirectives::ACK, 2), ackInfo(ackInfo) {}
+
+size_t AckPduSerializer::getSerializedSize() const {
+  return FileDirectiveSerializer::getWholePduSize();
+}
+
+ReturnValue_t AckPduSerializer::serialize(uint8_t **buffer, size_t *size, size_t maxSize,
+                                          Endianness streamEndianness) const {
+  ReturnValue_t result =
+      FileDirectiveSerializer::serialize(buffer, size, maxSize, streamEndianness);
+  if (result != HasReturnvaluesIF::RETURN_OK) {
+    return result;
+  }
+  cfdp::FileDirectives ackedDirective = ackInfo.getAckedDirective();
+  uint8_t directiveSubtypeCode = ackInfo.getDirectiveSubtypeCode();
+  cfdp::ConditionCode ackedConditionCode = ackInfo.getAckedConditionCode();
+  cfdp::AckTransactionStatus transactionStatus = ackInfo.getTransactionStatus();
+  if (ackedDirective != cfdp::FileDirectives::FINISH and
+      ackedDirective != cfdp::FileDirectives::EOF_DIRECTIVE) {
+    // TODO: better returncode
+    return HasReturnvaluesIF::RETURN_FAILED;
+  }
+  if (*size + 2 > maxSize) {
+    return SerializeIF::BUFFER_TOO_SHORT;
+  }
+  **buffer = ackedDirective << 4 | directiveSubtypeCode;
+  *buffer += 1;
+  *size += 1;
+  **buffer = ackedConditionCode << 4 | transactionStatus;
+  *buffer += 1;
+  *size += 1;
+  return HasReturnvaluesIF::RETURN_OK;
+}

src/fsfw/cfdp/pdu/AckPduSerializer.h

@@ -0,0 +1,30 @@
+#ifndef FSFW_SRC_FSFW_CFDP_PDU_ACKPDUSERIALIZER_H_
+#define FSFW_SRC_FSFW_CFDP_PDU_ACKPDUSERIALIZER_H_
+
+#include "AckInfo.h"
+#include "FileDirectiveDeserializer.h"
+#include "FileDirectiveSerializer.h"
+
+class AckPduSerializer : public FileDirectiveSerializer {
+ public:
+  /**
+   * @brief   Serializer to pack ACK PDUs
+   * @details
+   * Please note that only Finished PDUs and EOF are acknowledged.
+   * @param ackedDirective
+   * @param ackedConditionCode
+   * @param transactionStatus
+   * @param pduConf
+   */
+  AckPduSerializer(AckInfo& ackInfo, PduConfig& pduConf);
+
+  size_t getSerializedSize() const override;
+
+  ReturnValue_t serialize(uint8_t** buffer, size_t* size, size_t maxSize,
+                          Endianness streamEndianness) const override;
+
+ private:
+  AckInfo& ackInfo;
+};
+
+#endif /* FSFW_SRC_FSFW_CFDP_PDU_ACKPDUSERIALIZER_H_ */