Merge remote-tracking branch 'upstream/master' to the fork ro include all fsfw changes and tags

.clang-format

@@ -0,0 +1,7 @@
+---
+BasedOnStyle: Google
+IndentWidth: 2
+---
+Language: Cpp
+ColumnLimit: 100
+---

.gitignore

@@ -2,3 +2,5 @@
 .project
 .settings
 .metadata
+
+/build*

CHANGELOG

@@ -1,4 +1,81 @@
-## Changes from ASTP 0.0.1 to 1.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
 

CMakeLists.txt

@@ -1,124 +1,254 @@
 cmake_minimum_required(VERSION 3.13)
 
+set(FSFW_VERSION 2)
+set(FSFW_SUBVERSION 0)
+set(FSFW_REVISION 0)
+
+# Add the cmake folder so the FindSphinx module is found
+set(CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake" ${CMAKE_MODULE_PATH})
+
 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_UNITTESTS "Build unittest binary in addition to static library" 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)
+endif()
+
 option(FSFW_WARNING_SHADOW_LOCAL_GCC "Enable -Wshadow=local warning in GCC" ON)
 # Options to exclude parts of the FSFW from compilation.
-option(FSFW_USE_RMAP "Compile with RMAP" ON)
+option(FSFW_ADD_INTERNAL_TESTS "Add internal unit tests" ON)
-option(FSFW_USE_DATALINKLAYER "Compile with Data Link Layer" ON)
+option(FSFW_ADD_UNITTESTS "Add regular unittests. Requires Catch2" OFF)
+option(FSFW_ADD_HAL "Add Hardware Abstraction Layer" ON)
+
+# Optional sources
+option(FSFW_ADD_PUS "Compile with PUS sources" ON)
+option(FSFW_ADD_MONITORING "Compile with monitoring components" ON)
+
+option(FSFW_ADD_RMAP "Compile with RMAP" OFF)
+option(FSFW_ADD_DATALINKLAYER "Compile with Data Link Layer" OFF)
+option(FSFW_ADD_COORDINATES "Compile with coordinate components" OFF)
+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})
 
-set_property(CACHE OS_FSFW PROPERTY STRINGS host linux rtems freertos)
+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(NOT OS_FSFW)
+        FetchContent_Declare(
-	message(STATUS "No OS for FSFW via OS_FSFW set. Assuming host OS")
+            Catch2
+            GIT_REPOSITORY https://github.com/catchorg/Catch2.git
+            GIT_TAG        v3.0.0-preview3
+        )
+
+        FetchContent_MakeAvailable(Catch2)
+    endif()
+
+    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)
+
+    project(${FSFW_TEST_TGT} CXX C)
+    add_executable(${FSFW_TEST_TGT})
+
+    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()
+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()
+
+# 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)
+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(OS_FSFW  "linux" 
+		set(FSFW_OSAL  "linux" 
 			CACHE STRING 
 			"OS abstraction layer used in the FSFW"
 		)
 	elseif(WIN32)
-		set(OS_FSFW  "host" 
+		set(FSFW_OSAL  "host" 
 			CACHE STRING "OS abstraction layer used in the FSFW"
 		)
 	endif()
 
 endif()
 
-set(FSFW_OSAL_DEFINITION FSFW_HOST)
+set(FSFW_OSAL_DEFINITION FSFW_OSAL_HOST)
 
-if(${OS_FSFW} STREQUAL host)
+if(FSFW_OSAL MATCHES host)
-	set(OS_FSFW_NAME "Host")
+    set(FSFW_OS_NAME "Host")
-elseif(${OS_FSFW} STREQUAL linux)
+    set(FSFW_OSAL_HOST ON)
-	set(OS_FSFW_NAME "Linux")
+elseif(FSFW_OSAL MATCHES linux)
-	set(FSFW_OSAL_DEFINITION FSFW_LINUX)
+    set(FSFW_OS_NAME "Linux")
-elseif(${OS_FSFW} STREQUAL  freertos)
+    set(FSFW_OSAL_LINUX ON)
-	set(OS_FSFW_NAME "FreeRTOS")
+elseif(FSFW_OSAL MATCHES freertos)
-	set(FSFW_OSAL_DEFINITION FSFW_FREERTOS)
+    set(FSFW_OS_NAME "FreeRTOS")
-	target_link_libraries(${LIB_FSFW_NAME} PRIVATE
+    set(FSFW_OSAL_FREERTOS ON)
+    target_link_libraries(${LIB_FSFW_NAME} PRIVATE
         ${LIB_OS_NAME}
-	)
+    )
-elseif(${OS_FSFW} STREQUAL rtems)
+elseif(FSFW_OSAL STREQUAL rtems)
-	set(OS_FSFW_NAME "RTEMS")
+    set(FSFW_OS_NAME "RTEMS")
-    set(FSFW_OSAL_DEFINITION FSFW_RTEMS)
+    set(FSFW_OSAL_RTEMS ON)
 else()
-	message(WARNING 
+    message(WARNING
-		"Invalid operating system for FSFW specified! Setting to host.."
+        "Invalid operating system for FSFW specified! Setting to host.."
-	)
+    )
-	set(OS_FSFW_NAME "Host")
+    set(FSFW_OS_NAME "Host")
-	set(OS_FSFW "host")
+    set(OS_FSFW "host")
 endif()
 
-target_compile_definitions(${LIB_FSFW_NAME} PRIVATE
+if(FSFW_BUILD_UNITTESTS OR FSFW_BUILD_DOCS)
-    ${FSFW_OSAL_DEFINITION}
+    configure_file(src/fsfw/FSFW.h.in fsfw/FSFW.h)
-)
+    configure_file(src/fsfw/FSFWVersion.h.in fsfw/FSFWVersion.h)
-
+else()
-target_compile_definitions(${LIB_FSFW_NAME} INTERFACE
+    configure_file(src/fsfw/FSFW.h.in FSFW.h)
-    ${FSFW_OSAL_DEFINITION}
+    configure_file(src/fsfw/FSFWVersion.h.in FSFWVersion.h)
-)
-
-message(STATUS "Compiling FSFW for the ${OS_FSFW_NAME} operating system.")
-
-add_subdirectory(action)
-add_subdirectory(container)
-add_subdirectory(controller)
-add_subdirectory(coordinates)
-
-if(FSFW_USE_DATALINKLAYER)
-	add_subdirectory(datalinklayer)
 endif()
 
-add_subdirectory(datapool)
+message(STATUS "Compiling FSFW for the ${FSFW_OS_NAME} operating system.")
-add_subdirectory(datapoollocal)
-add_subdirectory(housekeeping)
-add_subdirectory(devicehandlers)
-add_subdirectory(events)
-add_subdirectory(fdir)
-add_subdirectory(globalfunctions)
-add_subdirectory(health)
-add_subdirectory(internalError)
-add_subdirectory(ipc)
-add_subdirectory(memory)
-add_subdirectory(modes)
-add_subdirectory(monitoring)
-add_subdirectory(objectmanager)
-add_subdirectory(osal)
-add_subdirectory(parameters)
-add_subdirectory(power)
-add_subdirectory(pus)
 
-if(FSFW_USE_RMAP)
+add_subdirectory(src)
-	add_subdirectory(rmap)
+add_subdirectory(tests)
+if(FSFW_ADD_HAL)
+    add_subdirectory(hal)
+endif()
+add_subdirectory(contrib)
+if(FSFW_BUILD_DOCS)
+    add_subdirectory(docs)
 endif()
 
-add_subdirectory(serialize)
+if(FSFW_BUILD_UNITTESTS)
-add_subdirectory(serviceinterface)
+    if(FSFW_TESTS_GEN_COV)
-add_subdirectory(storagemanager)
+        if(CMAKE_COMPILER_IS_GNUCXX)
-add_subdirectory(subsystem)
+            include(CodeCoverage)
-add_subdirectory(tasks)
+
-add_subdirectory(tcdistribution)
+            # Remove quotes.
-add_subdirectory(thermal)
+            separate_arguments(COVERAGE_COMPILER_FLAGS
-add_subdirectory(timemanager)
+                NATIVE_COMMAND "${COVERAGE_COMPILER_FLAGS}"
-add_subdirectory(tmstorage)
+            )
-add_subdirectory(tmtcpacket)
+
-add_subdirectory(tmtcservices)
+            # Add compile options manually, we don't want coverage for Catch2
-add_subdirectory(unittest)
+            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()
+
+            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()
+    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.
 if(NOT FSFW_CONFIG_PATH)
-	message(WARNING "Flight Software Framework configuration path not set!")
+    set(DEF_CONF_PATH misc/defaultcfg/fsfwconfig)
-	message(WARNING "Setting default configuration!")
+    if(NOT FSFW_BUILD_DOCS)
-	add_subdirectory(defaultcfg/fsfwconfig)
+        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})
 endif()
 
 # FSFW might be part of a possibly complicated folder structure, so we 
@@ -131,9 +261,9 @@ else()
 	)
 endif()
 
-foreach(INCLUDE_PATH ${FSFW_ADDITIONAL_INC_PATH})
+foreach(INCLUDE_PATH ${FSFW_ADDITIONAL_INC_PATHS})
     if(IS_ABSOLUTE ${INCLUDE_PATH})
-        set(CURR_ABS_INC_PATH "${FREERTOS_PATH}")
+        set(CURR_ABS_INC_PATH "${INCLUDE_PATH}")
     else()
         get_filename_component(CURR_ABS_INC_PATH
             ${INCLUDE_PATH} REALPATH BASE_DIR ${CMAKE_SOURCE_DIR})
@@ -184,6 +314,7 @@ endif()
 target_include_directories(${LIB_FSFW_NAME} INTERFACE 
 	${CMAKE_SOURCE_DIR}
 	${FSFW_CONFIG_PATH_ABSOLUTE}
+	${FSFW_CORE_INC_PATH}
 	${FSFW_ADD_INC_PATHS_ABS}
 )
 
@@ -193,6 +324,7 @@ target_include_directories(${LIB_FSFW_NAME} INTERFACE
 target_include_directories(${LIB_FSFW_NAME} PRIVATE 
 	${CMAKE_SOURCE_DIR}
 	${FSFW_CONFIG_PATH_ABSOLUTE}
+	${FSFW_CORE_INC_PATH}
 	${FSFW_ADD_INC_PATHS_ABS}
 )
 
@@ -204,3 +336,16 @@ target_compile_options(${LIB_FSFW_NAME} PRIVATE
 target_link_libraries(${LIB_FSFW_NAME} PRIVATE
     ${FSFW_ADDITIONAL_LINK_LIBS}
 )
+
+string(CONCAT POST_BUILD_COMMENT
+    "######################################################################\n"
+    "Built FSFW v${FSFW_VERSION}.${FSFW_SUBVERSION}.${FSFW_REVISION}, "
+    "Target OSAL: ${FSFW_OS_NAME}\n"
+    "######################################################################\n"
+)
+
+add_custom_command(
+   TARGET ${LIB_FSFW_NAME}
+   POST_BUILD
+   COMMENT ${POST_BUILD_COMMENT}
+)

FSFWVersion.h

@@ -1,12 +0,0 @@
-#ifndef FSFW_DEFAULTCFG_VERSION_H_
-#define FSFW_DEFAULTCFG_VERSION_H_
-
-const char* const FSFW_VERSION_NAME = "ASTP";
-
-#define FSFW_VERSION        1
-#define	FSFW_SUBVERSION     0
-#define	FSFW_REVISION       0
-
-
-
-#endif /* FSFW_DEFAULTCFG_VERSION_H_ */

README.md

@@ -1,4 +1,4 @@
-![FSFW Logo](logo/FSFW_Logo_V3_bw.png)
+![FSFW Logo](misc/logo/FSFW_Logo_V3_bw.png)
 
 # Flight Software Framework (FSFW)
 
@@ -22,27 +22,107 @@ Currently, the FSFW provides the following OSALs:
 - FreeRTOS
 - RTEMS
 
-The recommended hardware is a microprocessor with more than 1 MB of RAM and 1 MB of non-volatile Memory. For reference, current applications use a Cobham Gaisler UT699 (LEON3FT), a ISISPACE IOBC or a Zynq-7020 SoC. The `fsfw` was also successfully run on the STM32H743ZI-Nucleo board and on a Raspberry Pi and is currently running on the active satellite mission Flying Laptop.
+The recommended hardware is a microprocessor with more than 1 MB of RAM and 1 MB of non-volatile
+memory. For reference, current applications use a Cobham Gaisler UT699 (LEON3FT), a
+ISISPACE IOBC or a Zynq-7020 SoC. The `fsfw` was also successfully run on the
+STM32H743ZI-Nucleo board and on a Raspberry Pi and is currently running on the active
+satellite mission Flying Laptop.
 
 ## Getting started
 
-The [FSFW example](https://egit.irs.uni-stuttgart.de/fsfw/fsfw_example) provides a good starting point and a demo to see the FSFW capabilities and build it with the Make or the CMake build system. It is recommended to evaluate the FSFW by building and playing around with the demo application.
+The [Hosted FSFW example](https://egit.irs.uni-stuttgart.de/fsfw/fsfw-example-hosted) provides a
+good starting point and a demo to see the FSFW capabilities.
+It is recommended to get started by building and playing around with the demo application.
+There are also other examples provided for all OSALs using the popular embedded platforms
+Raspberry Pi, Beagle Bone Black and STM32H7.
 
-Generally, the FSFW is included in a project by compiling the FSFW sources and providing
+Generally, the FSFW is included in a project by providing
-a configuration folder and adding it to the include path. There are some functions like `printChar` which are different depending on the target architecture and need to be implemented by the mission developer.
+a configuration folder, building the static library and linking against it. 
+There are some functions like `printChar` which are different depending on the target architecture
+and need to be implemented by the mission developer.
 
 A template configuration folder was provided and can be copied into the project root to have
-a starting point. The [configuration section](doc/README-config.md#top) provides more specific information about the possible options.
+a starting point. The [configuration section](docs/README-config.md#top) provides more specific 
+information about the possible options.
+
+## Adding the library
+
+The following steps show how to add and use FSFW components. It is still recommended to
+try out the example mentioned above to get started, but the following steps show how to
+add and link against the FSFW library in general.
+
+1. Add this repository as a submodule
+
+   ```sh
+   git submodule add https://egit.irs.uni-stuttgart.de/fsfw/fsfw.git fsfw   
+   ```
+
+2. Add the following directive inside the uppermost `CMakeLists.txt` file of your project
+
+   ```cmake
+   add_subdirectory(fsfw)
+   ```
+
+3. Make sure to provide a configuration folder and supply the path to that folder with
+   the `FSFW_CONFIG_PATH` CMake variable from the uppermost `CMakeLists.txt` file.
+   It is also necessary to provide the `printChar` function. You can find an example
+   implementation for a hosted build 
+   [here](https://egit.irs.uni-stuttgart.de/fsfw/fsfw-example-hosted/src/branch/master/bsp_hosted/utility/printChar.c).
+
+4. Link against the FSFW library
+
+	```cmake
+	target_link_libraries(<YourProjectName> PRIVATE fsfw)
+	```
+
+5. It should now be possible use the FSFW as a static library from the user code.
+
+## Building the unittests
+
+The FSFW also has unittests which use the [Catch2 library](https://github.com/catchorg/Catch2).
+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.
+
+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`.
+
+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 ..
+```
+
+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,
+the following command can be used inside the build directory after the build system was set up
+
+```sh
+cmake --build . -- fsfw-tests_coverage -j
+```
+
+The `coverage.py` script located in the `script` folder can also be used to do this conveniently.
+
+## 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.
 
 ## Index
 
-[1. High-level overview](doc/README-highlevel.md#top) <br>
+[1. High-level overview](docs/README-highlevel.md#top) <br>
-[2. Core components](doc/README-core.md#top) <br>
+[2. Core components](docs/README-core.md#top) <br>
-[3. OSAL overview](doc/README-osal.md#top) <br>
+[3. Configuration](docs/README-config.md#top) <br>
-[4. PUS services](doc/README-pus.md#top) <br>
+[4. OSAL overview](docs/README-osal.md#top) <br>
-[5. Device Handler overview](doc/README-devicehandlers.md#top) <br>
+[5. PUS services](docs/README-pus.md#top) <br>
-[6. Controller overview](doc/README-controllers.md#top) <br>
+[6. Device Handler overview](docs/README-devicehandlers.md#top) <br>
-[7. Local Data Pools](doc/README-localpools.md#top) <br>
+[7. Controller overview](docs/README-controllers.md#top) <br>
+[8. Local Data Pools](docs/README-localpools.md#top) <br>
 
 
 

automation/Dockerfile

@@ -0,0 +1,8 @@
+FROM ubuntu:focal
+
+RUN apt-get update
+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

automation/Jenkinsfile

@@ -0,0 +1,72 @@
+pipeline {
+    agent any
+    environment {
+        BUILDDIR = 'build-unittests'
+    }
+    stages {
+        stage('Create Docker') {
+            agent {
+                dockerfile {
+                    dir 'automation'
+                    additionalBuildArgs  '--no-cache'
+                    reuseNode true
+                }
+            }
+            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 ..'
+                }
+            }
+        }
+        stage('Build') {
+            agent {
+                dockerfile {
+                    dir 'automation'
+                    reuseNode true
+                }
+            }
+            steps {
+                dir(BUILDDIR) {
+                    sh 'cmake --build . -j'
+                }
+            }
+        }
+        stage('Unittests') {
+            agent {
+                dockerfile {
+                    dir 'automation'
+                    reuseNode true
+                }
+            }
+            steps {
+                dir(BUILDDIR) {
+                    sh 'cmake --build . -- fsfw-tests_coverage -j'
+                }
+            }
+        }
+        stage('Valgrind') {
+            agent {
+                dockerfile {
+                    dir 'automation'
+                    reuseNode true
+                }
+            }
+            steps {
+                dir(BUILDDIR) {
+                    sh 'valgrind --leak-check=full --error-exitcode=1 ./fsfw-tests'
+                }
+            }
+        }
+    }
+}

cmake/FindSphinx.cmake

@@ -0,0 +1,13 @@
+# Look for an executable called sphinx-build
+find_program(SPHINX_EXECUTABLE
+             NAMES sphinx-build
+             DOC "Path to sphinx-build executable")
+
+include(FindPackageHandleStandardArgs)
+
+# Handle standard arguments to find_package like REQUIRED and QUIET
+find_package_handle_standard_args(
+    Sphinx
+    "Failed to find sphinx-build executable"
+    SPHINX_EXECUTABLE
+)

contrib/CMakeLists.txt

@@ -0,0 +1,9 @@
+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_contrib)

contrib/fsfw_contrib/CMakeLists.txt

@@ -0,0 +1,11 @@
+if(FSFW_ADD_SGP4_PROPAGATOR)
+    target_sources(${LIB_FSFW_NAME} PRIVATE
+        sgp4/sgp4unit.cpp
+    )
+    target_include_directories(${LIB_FSFW_NAME} PRIVATE
+        ${CMAKE_CURRENT_SOURCE_DIR}/sgp4
+    )
+    target_include_directories(${LIB_FSFW_NAME} INTERFACE
+        ${CMAKE_CURRENT_SOURCE_DIR}/sgp4
+    )
+endif()

datapoollocal/LocalDataPoolManager.cpp

@@ -1,942 +0,0 @@
-#include "HasLocalDataPoolIF.h"
-#include "LocalDataPoolManager.h"
-#include "LocalPoolObjectBase.h"
-#include "LocalPoolDataSetBase.h"
-#include "internal/LocalPoolDataSetAttorney.h"
-#include "internal/HasLocalDpIFManagerAttorney.h"
-
-#include "../housekeeping/HousekeepingSetPacket.h"
-#include "../housekeeping/HousekeepingSnapshot.h"
-#include "../housekeeping/AcceptsHkPacketsIF.h"
-#include "../timemanager/CCSDSTime.h"
-#include "../ipc/MutexFactory.h"
-#include "../ipc/MutexGuard.h"
-#include "../ipc/QueueFactory.h"
-
-#include <array>
-#include <cmath>
-
-object_id_t LocalDataPoolManager::defaultHkDestination = objects::PUS_SERVICE_3_HOUSEKEEPING;
-
-LocalDataPoolManager::LocalDataPoolManager(HasLocalDataPoolIF* owner, MessageQueueIF* queueToUse,
-		bool appendValidityBuffer):
-		appendValidityBuffer(appendValidityBuffer) {
-	if(owner == nullptr) {
-		printWarningOrError(sif::OutputTypes::OUT_WARNING,
-				"LocalDataPoolManager", HasReturnvaluesIF::RETURN_FAILED,
-				"Invalid supplied owner");
-		return;
-	}
-	this->owner = owner;
-	mutex = MutexFactory::instance()->createMutex();
-	if(mutex == nullptr) {
-		printWarningOrError(sif::OutputTypes::OUT_ERROR,
-				"LocalDataPoolManager", HasReturnvaluesIF::RETURN_FAILED,
-				"Could not create mutex");
-	}
-
-	hkQueue = queueToUse;
-}
-
-LocalDataPoolManager::~LocalDataPoolManager() {
-    if(mutex != nullptr) {
-        MutexFactory::instance()->deleteMutex(mutex);
-    }
-}
-
-ReturnValue_t LocalDataPoolManager::initialize(MessageQueueIF* queueToUse) {
-	if(queueToUse == nullptr) {
-		/* Error, all destinations invalid */
-		printWarningOrError(sif::OutputTypes::OUT_ERROR, "initialize",
-		        QUEUE_OR_DESTINATION_INVALID);
-	}
-	hkQueue = queueToUse;
-
-	ipcStore = objectManager->get<StorageManagerIF>(objects::IPC_STORE);
-	if(ipcStore == nullptr) {
-		/* Error, all destinations invalid */
-		printWarningOrError(sif::OutputTypes::OUT_ERROR,
-				"initialize", HasReturnvaluesIF::RETURN_FAILED,
-				"Could not set IPC store.");
-		return HasReturnvaluesIF::RETURN_FAILED;
-	}
-
-
-	if(defaultHkDestination != objects::NO_OBJECT) {
-		AcceptsHkPacketsIF* hkPacketReceiver =
-				objectManager->get<AcceptsHkPacketsIF>(defaultHkDestination);
-		if(hkPacketReceiver != nullptr) {
-			hkDestinationId = hkPacketReceiver->getHkQueue();
-		}
-		else {
-			printWarningOrError(sif::OutputTypes::OUT_ERROR,
-					"initialize", QUEUE_OR_DESTINATION_INVALID);
-			return QUEUE_OR_DESTINATION_INVALID;
-		}
-	}
-
-	return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t LocalDataPoolManager::initializeAfterTaskCreation(
-		uint8_t nonDiagInvlFactor) {
-	setNonDiagnosticIntervalFactor(nonDiagInvlFactor);
-	return initializeHousekeepingPoolEntriesOnce();
-}
-
-ReturnValue_t LocalDataPoolManager::initializeHousekeepingPoolEntriesOnce() {
-	if(not mapInitialized) {
-		ReturnValue_t result = owner->initializeLocalDataPool(localPoolMap,
-				*this);
-		if(result == HasReturnvaluesIF::RETURN_OK) {
-			mapInitialized = true;
-		}
-		return result;
-	}
-
-	printWarningOrError(sif::OutputTypes::OUT_WARNING,
-			"initialize", HasReturnvaluesIF::RETURN_FAILED,
-			"The map should only be initialized once");
-	return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t LocalDataPoolManager::performHkOperation() {
-	ReturnValue_t status = HasReturnvaluesIF::RETURN_OK;
-	for(auto& receiver: hkReceivers) {
-		switch(receiver.reportingType) {
-		case(ReportingType::PERIODIC): {
-			if(receiver.dataType == DataType::LOCAL_POOL_VARIABLE) {
-				/* Periodic packets shall only be generated from datasets */
-				continue;
-			}
-			performPeriodicHkGeneration(receiver);
-			break;
-		}
-		case(ReportingType::UPDATE_HK): {
-			handleHkUpdate(receiver, status);
-			break;
-		}
-		case(ReportingType::UPDATE_NOTIFICATION): {
-			handleNotificationUpdate(receiver, status);
-			break;
-		}
-		case(ReportingType::UPDATE_SNAPSHOT): {
-			handleNotificationSnapshot(receiver, status);
-			break;
-		}
-		default:
-			// This should never happen.
-			return HasReturnvaluesIF::RETURN_FAILED;
-		}
-	}
-	resetHkUpdateResetHelper();
-	return status;
-}
-
-ReturnValue_t LocalDataPoolManager::handleHkUpdate(HkReceiver& receiver,
-		ReturnValue_t& status) {
-	if(receiver.dataType == DataType::LOCAL_POOL_VARIABLE) {
-		/* Update packets shall only be generated from datasets. */
-		return HasReturnvaluesIF::RETURN_FAILED;
-	}
-	LocalPoolDataSetBase* dataSet = HasLocalDpIFManagerAttorney::getDataSetHandle(owner,
-			receiver.dataId.sid);
-	if(dataSet == nullptr) {
-        return DATASET_NOT_FOUND;
-	}
-	if(dataSet->hasChanged()) {
-		/* Prepare and send update notification */
-		ReturnValue_t result = generateHousekeepingPacket(
-				receiver.dataId.sid, dataSet, true);
-		if(result != HasReturnvaluesIF::RETURN_OK) {
-			status = result;
-		}
-	}
-	handleChangeResetLogic(receiver.dataType, receiver.dataId,
-			dataSet);
-	return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t LocalDataPoolManager::handleNotificationUpdate(HkReceiver& receiver,
-		ReturnValue_t& status) {
-	MarkChangedIF* toReset = nullptr;
-	if(receiver.dataType == DataType::LOCAL_POOL_VARIABLE) {
-		LocalPoolObjectBase* poolObj = HasLocalDpIFManagerAttorney::getPoolObjectHandle(owner,
-				receiver.dataId.localPoolId);
-		if(poolObj == nullptr) {
-			printWarningOrError(sif::OutputTypes::OUT_WARNING,
-					"handleNotificationUpdate", POOLOBJECT_NOT_FOUND);
-			return POOLOBJECT_NOT_FOUND;
-		}
-		if(poolObj->hasChanged()) {
-			/* Prepare and send update notification. */
-			CommandMessage notification;
-			HousekeepingMessage::setUpdateNotificationVariableCommand(&notification,
-			        gp_id_t(owner->getObjectId(), receiver.dataId.localPoolId));
-			ReturnValue_t result = hkQueue->sendMessage(receiver.destinationQueue, &notification);
-			if(result != HasReturnvaluesIF::RETURN_OK) {
-				status = result;
-			}
-			toReset = poolObj;
-		}
-
-	}
-	else {
-		LocalPoolDataSetBase* dataSet = HasLocalDpIFManagerAttorney::getDataSetHandle(owner,
-				receiver.dataId.sid);
-		if(dataSet == nullptr) {
-			printWarningOrError(sif::OutputTypes::OUT_WARNING,
-					"handleNotificationUpdate", DATASET_NOT_FOUND);
-			return DATASET_NOT_FOUND;
-		}
-		if(dataSet->hasChanged()) {
-			/* Prepare and send update notification */
-			CommandMessage notification;
-			HousekeepingMessage::setUpdateNotificationSetCommand(&notification,
-			        receiver.dataId.sid);
-			ReturnValue_t result = hkQueue->sendMessage(
-					receiver.destinationQueue, &notification);
-			if(result != HasReturnvaluesIF::RETURN_OK) {
-				status = result;
-			}
-			toReset = dataSet;
-		}
-	}
-	if(toReset != nullptr) {
-		handleChangeResetLogic(receiver.dataType, receiver.dataId, toReset);
-	}
-	return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t LocalDataPoolManager::handleNotificationSnapshot(
-		HkReceiver& receiver, ReturnValue_t& status) {
-	MarkChangedIF* toReset = nullptr;
-	/* Check whether data has changed and send messages in case it has */
-	if(receiver.dataType == DataType::LOCAL_POOL_VARIABLE) {
-		LocalPoolObjectBase* poolObj = HasLocalDpIFManagerAttorney::getPoolObjectHandle(owner,
-				receiver.dataId.localPoolId);
-		if(poolObj == nullptr) {
-			printWarningOrError(sif::OutputTypes::OUT_WARNING,
-					"handleNotificationSnapshot", POOLOBJECT_NOT_FOUND);
-			return POOLOBJECT_NOT_FOUND;
-		}
-
-		if (not poolObj->hasChanged()) {
-			return HasReturnvaluesIF::RETURN_OK;
-		}
-
-		/* Prepare and send update snapshot */
-		timeval now;
-		Clock::getClock_timeval(&now);
-		CCSDSTime::CDS_short cds;
-		CCSDSTime::convertToCcsds(&cds, &now);
-		HousekeepingSnapshot updatePacket(reinterpret_cast<uint8_t*>(&cds), sizeof(cds),
-		        HasLocalDpIFManagerAttorney::getPoolObjectHandle(
-		                owner,receiver.dataId.localPoolId));
-
-		store_address_t storeId;
-		ReturnValue_t result = addUpdateToStore(updatePacket, storeId);
-		if(result != HasReturnvaluesIF::RETURN_OK) {
-			return result;
-		}
-
-		CommandMessage notification;
-		HousekeepingMessage::setUpdateSnapshotVariableCommand(&notification,
-				gp_id_t(owner->getObjectId(), receiver.dataId.localPoolId), storeId);
-		result = hkQueue->sendMessage(receiver.destinationQueue,
-				&notification);
-		if (result != HasReturnvaluesIF::RETURN_OK) {
-			status = result;
-		}
-		toReset = poolObj;
-	}
-	else {
-		LocalPoolDataSetBase* dataSet = HasLocalDpIFManagerAttorney::getDataSetHandle(owner,
-				receiver.dataId.sid);
-		if(dataSet == nullptr) {
-			printWarningOrError(sif::OutputTypes::OUT_WARNING,
-					"handleNotificationSnapshot", DATASET_NOT_FOUND);
-			return DATASET_NOT_FOUND;
-		}
-
-		if(not dataSet->hasChanged()) {
-			return HasReturnvaluesIF::RETURN_OK;
-		}
-
-		/* Prepare and send update snapshot */
-		timeval now;
-		Clock::getClock_timeval(&now);
-		CCSDSTime::CDS_short cds;
-		CCSDSTime::convertToCcsds(&cds, &now);
-		HousekeepingSnapshot updatePacket(reinterpret_cast<uint8_t*>(&cds),
-				sizeof(cds), HasLocalDpIFManagerAttorney::getDataSetHandle(owner,
-						receiver.dataId.sid));
-
-		store_address_t storeId;
-		ReturnValue_t result = addUpdateToStore(updatePacket, storeId);
-		if(result != HasReturnvaluesIF::RETURN_OK) {
-			return result;
-		}
-
-		CommandMessage notification;
-		HousekeepingMessage::setUpdateSnapshotSetCommand(
-				&notification, receiver.dataId.sid, storeId);
-		result = hkQueue->sendMessage(receiver.destinationQueue, &notification);
-		if(result != HasReturnvaluesIF::RETURN_OK) {
-			status = result;
-		}
-		toReset = dataSet;
-
-	}
-	if(toReset != nullptr) {
-		handleChangeResetLogic(receiver.dataType,
-				receiver.dataId, toReset);
-	}
-	return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t LocalDataPoolManager::addUpdateToStore(
-		HousekeepingSnapshot& updatePacket, store_address_t& storeId) {
-	size_t updatePacketSize = updatePacket.getSerializedSize();
-	uint8_t *storePtr = nullptr;
-	ReturnValue_t result = ipcStore->getFreeElement(&storeId,
-			updatePacket.getSerializedSize(), &storePtr);
-	if (result != HasReturnvaluesIF::RETURN_OK) {
-		return result;
-	}
-	size_t serializedSize = 0;
-	result = updatePacket.serialize(&storePtr, &serializedSize,
-			updatePacketSize, SerializeIF::Endianness::MACHINE);
-	return result;;
-}
-
-void LocalDataPoolManager::handleChangeResetLogic(
-		DataType type, DataId dataId, MarkChangedIF* toReset) {
-	if(hkUpdateResetList == nullptr) {
-		/* Config error */
-		return;
-	}
-	HkUpdateResetList& listRef = *hkUpdateResetList;
-	for(auto& changeInfo: listRef) {
-		if(changeInfo.dataType != type) {
-			continue;
-		}
-		if((changeInfo.dataType == DataType::DATA_SET) and
-				(changeInfo.dataId.sid != dataId.sid)) {
-			continue;
-		}
-		if((changeInfo.dataType == DataType::LOCAL_POOL_VARIABLE) and
-				(changeInfo.dataId.localPoolId != dataId.localPoolId)) {
-			continue;
-		}
-
-		/* Only one update recipient, we can reset changes status immediately */
-		if(changeInfo.updateCounter <= 1) {
-			toReset->setChanged(false);
-		}
-		/* All recipients have been notified, reset the changed flag */
-		else if(changeInfo.currentUpdateCounter <= 1) {
-			toReset->setChanged(false);
-			changeInfo.currentUpdateCounter = 0;
-		}
-		/* Not all recipiens have been notified yet, decrement */
-		else {
-			changeInfo.currentUpdateCounter--;
-		}
-		return;
-	}
-}
-
-void LocalDataPoolManager::resetHkUpdateResetHelper() {
-	if(hkUpdateResetList == nullptr) {
-		return;
-	}
-
-	for(auto& changeInfo: *hkUpdateResetList) {
-		changeInfo.currentUpdateCounter = changeInfo.updateCounter;
-	}
-}
-
-ReturnValue_t LocalDataPoolManager::subscribeForPeriodicPacket(sid_t sid,
-		bool enableReporting, float collectionInterval, bool isDiagnostics,
-		object_id_t packetDestination) {
-	AcceptsHkPacketsIF* hkReceiverObject =
-			objectManager->get<AcceptsHkPacketsIF>(packetDestination);
-	if(hkReceiverObject == nullptr) {
-		printWarningOrError(sif::OutputTypes::OUT_WARNING,
-				"subscribeForPeriodicPacket", QUEUE_OR_DESTINATION_INVALID);
-		return QUEUE_OR_DESTINATION_INVALID;
-	}
-
-	struct HkReceiver hkReceiver;
-	hkReceiver.dataId.sid = sid;
-	hkReceiver.reportingType = ReportingType::PERIODIC;
-	hkReceiver.dataType = DataType::DATA_SET;
-	hkReceiver.destinationQueue = hkReceiverObject->getHkQueue();
-
-	LocalPoolDataSetBase* dataSet = HasLocalDpIFManagerAttorney::getDataSetHandle(owner, sid);
-	if(dataSet != nullptr) {
-		LocalPoolDataSetAttorney::setReportingEnabled(*dataSet, enableReporting);
-		LocalPoolDataSetAttorney::setDiagnostic(*dataSet, isDiagnostics);
-		LocalPoolDataSetAttorney::initializePeriodicHelper(*dataSet, collectionInterval,
-				owner->getPeriodicOperationFrequency());
-	}
-
-	hkReceivers.push_back(hkReceiver);
-	return HasReturnvaluesIF::RETURN_OK;
-}
-
-
-ReturnValue_t LocalDataPoolManager::subscribeForUpdatePacket(sid_t sid,
-		bool isDiagnostics, bool reportingEnabled,
-		object_id_t packetDestination) {
-	AcceptsHkPacketsIF* hkReceiverObject =
-			objectManager->get<AcceptsHkPacketsIF>(packetDestination);
-	if(hkReceiverObject == nullptr) {
-		printWarningOrError(sif::OutputTypes::OUT_WARNING,
-				"subscribeForPeriodicPacket", QUEUE_OR_DESTINATION_INVALID);
-		return QUEUE_OR_DESTINATION_INVALID;
-	}
-
-	struct HkReceiver hkReceiver;
-	hkReceiver.dataId.sid = sid;
-	hkReceiver.reportingType = ReportingType::UPDATE_HK;
-	hkReceiver.dataType = DataType::DATA_SET;
-	hkReceiver.destinationQueue = hkReceiverObject->getHkQueue();
-
-	LocalPoolDataSetBase* dataSet = HasLocalDpIFManagerAttorney::getDataSetHandle(owner, sid);
-	if(dataSet != nullptr) {
-		LocalPoolDataSetAttorney::setReportingEnabled(*dataSet, true);
-		LocalPoolDataSetAttorney::setDiagnostic(*dataSet, isDiagnostics);
-	}
-
-	hkReceivers.push_back(hkReceiver);
-
-	handleHkUpdateResetListInsertion(hkReceiver.dataType, hkReceiver.dataId);
-	return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t LocalDataPoolManager::subscribeForSetUpdateMessage(
-		const uint32_t setId, object_id_t destinationObject,
-		MessageQueueId_t targetQueueId, bool generateSnapshot) {
-	struct HkReceiver hkReceiver;
-	hkReceiver.dataType = DataType::DATA_SET;
-	hkReceiver.dataId.sid = sid_t(owner->getObjectId(), setId);
-	hkReceiver.destinationQueue = targetQueueId;
-	hkReceiver.objectId = destinationObject;
-	if(generateSnapshot) {
-		hkReceiver.reportingType = ReportingType::UPDATE_SNAPSHOT;
-	}
-	else {
-		hkReceiver.reportingType = ReportingType::UPDATE_NOTIFICATION;
-	}
-
-	hkReceivers.push_back(hkReceiver);
-
-	handleHkUpdateResetListInsertion(hkReceiver.dataType, hkReceiver.dataId);
-	return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t LocalDataPoolManager::subscribeForVariableUpdateMessage(
-		const lp_id_t localPoolId, object_id_t destinationObject,
-		MessageQueueId_t targetQueueId, bool generateSnapshot) {
-	struct HkReceiver hkReceiver;
-	hkReceiver.dataType = DataType::LOCAL_POOL_VARIABLE;
-	hkReceiver.dataId.localPoolId = localPoolId;
-	hkReceiver.destinationQueue = targetQueueId;
-	hkReceiver.objectId = destinationObject;
-	if(generateSnapshot) {
-		hkReceiver.reportingType = ReportingType::UPDATE_SNAPSHOT;
-	}
-	else {
-		hkReceiver.reportingType = ReportingType::UPDATE_NOTIFICATION;
-	}
-
-	hkReceivers.push_back(hkReceiver);
-
-	handleHkUpdateResetListInsertion(hkReceiver.dataType, hkReceiver.dataId);
-	return HasReturnvaluesIF::RETURN_OK;
-}
-
-void LocalDataPoolManager::handleHkUpdateResetListInsertion(DataType dataType,
-		DataId dataId) {
-	if(hkUpdateResetList == nullptr) {
-		hkUpdateResetList = new std::vector<struct HkUpdateResetHelper>();
-	}
-
-	for(auto& updateResetStruct: *hkUpdateResetList) {
-		if(dataType == DataType::DATA_SET) {
-			if(updateResetStruct.dataId.sid == dataId.sid) {
-				updateResetStruct.updateCounter++;
-				updateResetStruct.currentUpdateCounter++;
-				return;
-			}
-		}
-		else {
-			if(updateResetStruct.dataId.localPoolId == dataId.localPoolId) {
-				updateResetStruct.updateCounter++;
-				updateResetStruct.currentUpdateCounter++;
-				return;
-			}
-		}
-
-	}
-	HkUpdateResetHelper hkUpdateResetHelper;
-	hkUpdateResetHelper.currentUpdateCounter = 1;
-	hkUpdateResetHelper.updateCounter = 1;
-	hkUpdateResetHelper.dataType = dataType;
-	if(dataType == DataType::DATA_SET) {
-		hkUpdateResetHelper.dataId.sid = dataId.sid;
-	}
-	else {
-		hkUpdateResetHelper.dataId.localPoolId = dataId.localPoolId;
-	}
-	hkUpdateResetList->push_back(hkUpdateResetHelper);
-}
-
-ReturnValue_t LocalDataPoolManager::handleHousekeepingMessage(
-		CommandMessage* message) {
-	Command_t command = message->getCommand();
-	sid_t sid = HousekeepingMessage::getSid(message);
-	ReturnValue_t result = HasReturnvaluesIF::RETURN_OK;
-	switch(command) {
-	// Houskeeping interface handling.
-	case(HousekeepingMessage::ENABLE_PERIODIC_DIAGNOSTICS_GENERATION): {
-		result = togglePeriodicGeneration(sid, true, true);
-		break;
-	}
-
-	case(HousekeepingMessage::DISABLE_PERIODIC_DIAGNOSTICS_GENERATION): {
-		result = togglePeriodicGeneration(sid, false, true);
-		break;
-	}
-
-	case(HousekeepingMessage::ENABLE_PERIODIC_HK_REPORT_GENERATION): {
-		result = togglePeriodicGeneration(sid, true, false);
-		break;
-	}
-
-	case(HousekeepingMessage::DISABLE_PERIODIC_HK_REPORT_GENERATION): {
-		result = togglePeriodicGeneration(sid, false, false);
-		break;
-	}
-
-	case(HousekeepingMessage::REPORT_DIAGNOSTICS_REPORT_STRUCTURES): {
-		result = generateSetStructurePacket(sid, true);
-		if(result == HasReturnvaluesIF::RETURN_OK) {
-		    return result;
-		}
-		break;
-	}
-
-	case(HousekeepingMessage::REPORT_HK_REPORT_STRUCTURES): {
-		result = generateSetStructurePacket(sid, false);
-        if(result == HasReturnvaluesIF::RETURN_OK) {
-            return result;
-        }
-        break;
-	}
-	case(HousekeepingMessage::MODIFY_DIAGNOSTICS_REPORT_COLLECTION_INTERVAL):
-	case(HousekeepingMessage::MODIFY_PARAMETER_REPORT_COLLECTION_INTERVAL): {
-		float newCollIntvl = 0;
-		HousekeepingMessage::getCollectionIntervalModificationCommand(message,
-				&newCollIntvl);
-		if(command == HousekeepingMessage::
-				MODIFY_DIAGNOSTICS_REPORT_COLLECTION_INTERVAL) {
-			result = changeCollectionInterval(sid, newCollIntvl, true);
-		}
-		else {
-			result = changeCollectionInterval(sid, newCollIntvl, false);
-		}
-		break;
-	}
-
-	case(HousekeepingMessage::GENERATE_ONE_PARAMETER_REPORT):
-	case(HousekeepingMessage::GENERATE_ONE_DIAGNOSTICS_REPORT): {
-		LocalPoolDataSetBase* dataSet =HasLocalDpIFManagerAttorney::getDataSetHandle(owner, sid);
-		if(command == HousekeepingMessage::GENERATE_ONE_PARAMETER_REPORT
-				and LocalPoolDataSetAttorney::isDiagnostics(*dataSet)) {
-			result = WRONG_HK_PACKET_TYPE;
-			break;
-		}
-		else if(command == HousekeepingMessage::GENERATE_ONE_DIAGNOSTICS_REPORT
-				and not LocalPoolDataSetAttorney::isDiagnostics(*dataSet)) {
-            result = WRONG_HK_PACKET_TYPE;
-            break;
-		}
-		return generateHousekeepingPacket(HousekeepingMessage::getSid(message),
-				dataSet, true);
-	}
-
-	/* Notification handling */
-	case(HousekeepingMessage::UPDATE_NOTIFICATION_SET): {
-		owner->handleChangedDataset(sid);
-		return HasReturnvaluesIF::RETURN_OK;
-	}
-	case(HousekeepingMessage::UPDATE_NOTIFICATION_VARIABLE): {
-		gp_id_t globPoolId = HousekeepingMessage::getUpdateNotificationVariableCommand(message);
-		owner->handleChangedPoolVariable(globPoolId);
-		return HasReturnvaluesIF::RETURN_OK;
-	}
-	case(HousekeepingMessage::UPDATE_SNAPSHOT_SET): {
-		store_address_t storeId;
-		HousekeepingMessage::getUpdateSnapshotSetCommand(message, &storeId);
-		bool clearMessage = true;
-		owner->handleChangedDataset(sid, storeId, &clearMessage);
-		if(clearMessage) {
-	        message->clear();
-		}
-		return HasReturnvaluesIF::RETURN_OK;
-	}
-	case(HousekeepingMessage::UPDATE_SNAPSHOT_VARIABLE): {
-		store_address_t storeId;
-		gp_id_t globPoolId = HousekeepingMessage::getUpdateSnapshotVariableCommand(message,
-		        &storeId);
-		bool clearMessage = true;
-		owner->handleChangedPoolVariable(globPoolId, storeId, &clearMessage);
-		if(clearMessage) {
-	        message->clear();
-		}
-		return HasReturnvaluesIF::RETURN_OK;
-	}
-
-	default:
-		return CommandMessageIF::UNKNOWN_COMMAND;
-	}
-
-	CommandMessage reply;
-	if(result != HasReturnvaluesIF::RETURN_OK) {
-		HousekeepingMessage::setHkRequestFailureReply(&reply, sid, result);
-	}
-	else {
-		HousekeepingMessage::setHkRequestSuccessReply(&reply, sid);
-	}
-	hkQueue->sendMessage(hkDestinationId, &reply);
-	return result;
-}
-
-ReturnValue_t LocalDataPoolManager::printPoolEntry(
-		lp_id_t localPoolId) {
-	auto poolIter = localPoolMap.find(localPoolId);
-	if (poolIter == localPoolMap.end()) {
-		printWarningOrError(sif::OutputTypes::OUT_WARNING, "printPoolEntry",
-				localpool::POOL_ENTRY_NOT_FOUND);
-		return localpool::POOL_ENTRY_NOT_FOUND;
-	}
-	poolIter->second->print();
-	return HasReturnvaluesIF::RETURN_OK;
-}
-
-MutexIF* LocalDataPoolManager::getMutexHandle() {
-	return mutex;
-}
-
-HasLocalDataPoolIF* LocalDataPoolManager::getOwner() {
-	return owner;
-}
-
-ReturnValue_t LocalDataPoolManager::generateHousekeepingPacket(sid_t sid,
-		LocalPoolDataSetBase* dataSet, bool forDownlink,
-		MessageQueueId_t destination) {
-	if(dataSet == nullptr) {
-		/* Configuration error. */
-		printWarningOrError(sif::OutputTypes::OUT_WARNING,
-				"generateHousekeepingPacket",
-				DATASET_NOT_FOUND);
-		return DATASET_NOT_FOUND;
-	}
-
-	store_address_t storeId;
-	HousekeepingPacketDownlink hkPacket(sid, dataSet);
-	size_t serializedSize = 0;
-	ReturnValue_t result = serializeHkPacketIntoStore(hkPacket, storeId,
-			forDownlink, &serializedSize);
-	if(result != HasReturnvaluesIF::RETURN_OK or serializedSize == 0) {
-		return result;
-	}
-
-	/* Now we set a HK message and send it the HK packet destination. */
-	CommandMessage hkMessage;
-	if(LocalPoolDataSetAttorney::isDiagnostics(*dataSet)) {
-		HousekeepingMessage::setHkDiagnosticsReply(&hkMessage, sid, storeId);
-	}
-	else {
-		HousekeepingMessage::setHkReportReply(&hkMessage, sid, storeId);
-	}
-
-	if(hkQueue == nullptr) {
-		/* Error, no queue available to send packet with. */
-		printWarningOrError(sif::OutputTypes::OUT_WARNING,
-				"generateHousekeepingPacket",
-				QUEUE_OR_DESTINATION_INVALID);
-		return QUEUE_OR_DESTINATION_INVALID;
-	}
-	if(destination == MessageQueueIF::NO_QUEUE) {
-		if(hkDestinationId == MessageQueueIF::NO_QUEUE) {
-			/* Error, all destinations invalid */
-			printWarningOrError(sif::OutputTypes::OUT_WARNING,
-					"generateHousekeepingPacket",
-					QUEUE_OR_DESTINATION_INVALID);
-		}
-		destination = hkDestinationId;
-	}
-
-	return hkQueue->sendMessage(destination, &hkMessage);
-}
-
-ReturnValue_t LocalDataPoolManager::serializeHkPacketIntoStore(
-		HousekeepingPacketDownlink& hkPacket,
-		store_address_t& storeId, bool forDownlink,
-		size_t* serializedSize) {
-	uint8_t* dataPtr = nullptr;
-	const size_t maxSize = hkPacket.getSerializedSize();
-	ReturnValue_t result = ipcStore->getFreeElement(&storeId,
-			maxSize, &dataPtr);
-	if(result != HasReturnvaluesIF::RETURN_OK) {
-		return result;
-	}
-
-	if(forDownlink) {
-		return hkPacket.serialize(&dataPtr, serializedSize, maxSize,
-				SerializeIF::Endianness::BIG);
-	}
-	return hkPacket.serialize(&dataPtr, serializedSize, maxSize,
-			SerializeIF::Endianness::MACHINE);
-}
-
-void LocalDataPoolManager::setNonDiagnosticIntervalFactor(
-		uint8_t nonDiagInvlFactor) {
-	this->nonDiagnosticIntervalFactor = nonDiagInvlFactor;
-}
-
-void LocalDataPoolManager::performPeriodicHkGeneration(HkReceiver& receiver) {
-	sid_t sid = receiver.dataId.sid;
-	LocalPoolDataSetBase* dataSet = HasLocalDpIFManagerAttorney::getDataSetHandle(owner, sid);
-	if(dataSet == nullptr) {
-		printWarningOrError(sif::OutputTypes::OUT_WARNING,
-				"performPeriodicHkGeneration",
-				DATASET_NOT_FOUND);
-		return;
-	}
-
-	if(not LocalPoolDataSetAttorney::getReportingEnabled(*dataSet)) {
-		return;
-	}
-
-	PeriodicHousekeepingHelper* periodicHelper =
-			LocalPoolDataSetAttorney::getPeriodicHelper(*dataSet);
-
-	if(periodicHelper == nullptr) {
-		/* Configuration error */
-		return;
-	}
-
-	if(not periodicHelper->checkOpNecessary()) {
-		return;
-	}
-
-	ReturnValue_t result = generateHousekeepingPacket(
-			sid, dataSet, true);
-	if(result != HasReturnvaluesIF::RETURN_OK) {
-		/* Configuration error */
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-		sif::warning << "LocalDataPoolManager::performHkOperation: HK generation failed." <<
-		        std::endl;
-#else
-		sif::printWarning("LocalDataPoolManager::performHkOperation: HK generation failed.\n");
-#endif
-	}
-}
-
-
-ReturnValue_t LocalDataPoolManager::togglePeriodicGeneration(sid_t sid,
-		bool enable, bool isDiagnostics) {
-	LocalPoolDataSetBase* dataSet = HasLocalDpIFManagerAttorney::getDataSetHandle(owner, sid);
-    if(dataSet == nullptr) {
-        printWarningOrError(sif::OutputTypes::OUT_WARNING, "togglePeriodicGeneration",
-                DATASET_NOT_FOUND);
-        return DATASET_NOT_FOUND;
-    }
-
-	if((LocalPoolDataSetAttorney::isDiagnostics(*dataSet) and not isDiagnostics) or
-			(not LocalPoolDataSetAttorney::isDiagnostics(*dataSet) and isDiagnostics)) {
-		return WRONG_HK_PACKET_TYPE;
-	}
-
-	if((LocalPoolDataSetAttorney::getReportingEnabled(*dataSet) and enable) or
-			(not LocalPoolDataSetAttorney::getReportingEnabled(*dataSet) and not enable)) {
-		return REPORTING_STATUS_UNCHANGED;
-	}
-
-	LocalPoolDataSetAttorney::setReportingEnabled(*dataSet, enable);
-	return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t LocalDataPoolManager::changeCollectionInterval(sid_t sid,
-		float newCollectionInterval, bool isDiagnostics) {
-	LocalPoolDataSetBase* dataSet = HasLocalDpIFManagerAttorney::getDataSetHandle(owner, sid);
-	if(dataSet == nullptr) {
-        printWarningOrError(sif::OutputTypes::OUT_WARNING, "changeCollectionInterval",
-                DATASET_NOT_FOUND);
-	    return DATASET_NOT_FOUND;
-	}
-
-	bool targetIsDiagnostics = LocalPoolDataSetAttorney::isDiagnostics(*dataSet);
-	if((targetIsDiagnostics and not isDiagnostics) or
-			(not targetIsDiagnostics and isDiagnostics)) {
-		return WRONG_HK_PACKET_TYPE;
-	}
-
-	PeriodicHousekeepingHelper* periodicHelper =
-			LocalPoolDataSetAttorney::getPeriodicHelper(*dataSet);
-
-	if(periodicHelper == nullptr) {
-		/* Configuration error, set might not have a corresponding pool manager */
-		return PERIODIC_HELPER_INVALID;
-	}
-
-	periodicHelper->changeCollectionInterval(newCollectionInterval);
-	return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t LocalDataPoolManager::generateSetStructurePacket(sid_t sid,
-		bool isDiagnostics) {
-	/* Get and check dataset first. */
-	LocalPoolDataSetBase* dataSet = HasLocalDpIFManagerAttorney::getDataSetHandle(owner, sid);
-	if(dataSet == nullptr) {
-		printWarningOrError(sif::OutputTypes::OUT_WARNING,
-				"performPeriodicHkGeneration", DATASET_NOT_FOUND);
-		return DATASET_NOT_FOUND;
-	}
-
-
-	bool targetIsDiagnostics = LocalPoolDataSetAttorney::isDiagnostics(*dataSet);
-	if((targetIsDiagnostics and not isDiagnostics) or
-			(not targetIsDiagnostics and isDiagnostics)) {
-		return WRONG_HK_PACKET_TYPE;
-	}
-
-	bool valid = dataSet->isValid();
-	bool reportingEnabled = LocalPoolDataSetAttorney::getReportingEnabled(*dataSet);
-	float collectionInterval = LocalPoolDataSetAttorney::getPeriodicHelper(*dataSet)->
-			getCollectionIntervalInSeconds();
-
-	// Generate set packet which can be serialized.
-	HousekeepingSetPacket setPacket(sid,
-			reportingEnabled, valid, collectionInterval, dataSet);
-	size_t expectedSize = setPacket.getSerializedSize();
-	uint8_t* storePtr = nullptr;
-	store_address_t storeId;
-	ReturnValue_t result = ipcStore->getFreeElement(&storeId,
-			expectedSize,&storePtr);
-	if(result != HasReturnvaluesIF::RETURN_OK) {
-		printWarningOrError(sif::OutputTypes::OUT_ERROR,
-				"generateSetStructurePacket", HasReturnvaluesIF::RETURN_FAILED,
-				"Could not get free element from IPC store.");
-		return result;
-	}
-
-	// Serialize set packet into store.
-	size_t size = 0;
-	result = setPacket.serialize(&storePtr, &size, expectedSize,
-			SerializeIF::Endianness::BIG);
-	if(expectedSize != size) {
-		printWarningOrError(sif::OutputTypes::OUT_WARNING,
-				"generateSetStructurePacket", HasReturnvaluesIF::RETURN_FAILED,
-				"Expected size is not equal to serialized size");
-	}
-
-	// Send structure reporting reply.
-	CommandMessage reply;
-	if(isDiagnostics) {
-		HousekeepingMessage::setDiagnosticsStuctureReportReply(&reply,
-				sid, storeId);
-	}
-	else {
-		HousekeepingMessage::setHkStuctureReportReply(&reply,
-				sid, storeId);
-	}
-
-	hkQueue->reply(&reply);
-	return result;
-}
-
-void LocalDataPoolManager::clearReceiversList() {
-	/* Clear the vector completely and releases allocated memory. */
-	HkReceivers().swap(hkReceivers);
-	/* Also clear the reset helper if it exists */
-	if(hkUpdateResetList != nullptr) {
-	    HkUpdateResetList().swap(*hkUpdateResetList);
-	}
-}
-
-MutexIF* LocalDataPoolManager::getLocalPoolMutex() {
-	return this->mutex;
-}
-
-object_id_t LocalDataPoolManager::getCreatorObjectId() const {
-	return owner->getObjectId();
-}
-
-void LocalDataPoolManager::printWarningOrError(sif::OutputTypes outputType,
-		const char* functionName, ReturnValue_t error, const char* errorPrint) {
-#if FSFW_VERBOSE_LEVEL >= 1
-	if(errorPrint == nullptr) {
-		if(error == DATASET_NOT_FOUND) {
-			errorPrint = "Dataset not found";
-		}
-		else if(error == POOLOBJECT_NOT_FOUND) {
-			errorPrint = "Pool Object not found";
-		}
-		else if(error == HasReturnvaluesIF::RETURN_FAILED) {
-			if(outputType == sif::OutputTypes::OUT_WARNING) {
-				errorPrint = "Generic Warning";
-			}
-			else {
-				errorPrint = "Generic error";
-			}
-		}
-		else if(error == QUEUE_OR_DESTINATION_INVALID) {
-			errorPrint = "Queue or destination not set";
-		}
-		else if(error == localpool::POOL_ENTRY_TYPE_CONFLICT) {
-			errorPrint = "Pool entry type conflict";
-		}
-		else if(error == localpool::POOL_ENTRY_NOT_FOUND) {
-			errorPrint = "Pool entry not found";
-		}
-		else {
-			errorPrint = "Unknown error";
-		}
-	}
-	object_id_t objectId = 0xffffffff;
-	if(owner != nullptr) {
-	    objectId = owner->getObjectId();
-	}
-
-	if(outputType == sif::OutputTypes::OUT_WARNING) {
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-		sif::warning << "LocalDataPoolManager::" << functionName << ": Object ID 0x" <<
-		        std::setw(8) << std::setfill('0') << std::hex << objectId << " | " << errorPrint <<
-		        std::dec << std::setfill(' ') << std::endl;
-#else
-		sif::printWarning("LocalDataPoolManager::%s: Object ID 0x%08x | %s\n",
-				functionName, objectId, errorPrint);
-#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
-	}
-	else if(outputType == sif::OutputTypes::OUT_ERROR) {
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-		sif::error << "LocalDataPoolManager::" << functionName << ": Object ID 0x" <<
-		        std::setw(8) << std::setfill('0') << std::hex << objectId << " | " << errorPrint <<
-		        std::dec << std::setfill(' ') << std::endl;
-#else
-		sif::printError("LocalDataPoolManager::%s: Object ID 0x%08x | %s\n",
-				functionName, objectId, errorPrint);
-#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
-	}
-#endif /* #if FSFW_VERBOSE_LEVEL >= 1 */
-}
-
-LocalDataPoolManager* LocalDataPoolManager::getPoolManagerHandle() {
-	return this;
-}

datapoollocal/datapoollocal.h

@@ -1,12 +0,0 @@
-#ifndef FSFW_DATAPOOLLOCAL_DATAPOOLLOCAL_H_
-#define FSFW_DATAPOOLLOCAL_DATAPOOLLOCAL_H_
-
-/* Collected related headers */
-#include "LocalPoolVariable.h"
-#include "LocalPoolVector.h"
-#include "StaticLocalDataSet.h"
-#include "LocalDataSet.h"
-#include "SharedLocalDataSet.h"
-
-
-#endif /* FSFW_DATAPOOLLOCAL_DATAPOOLLOCAL_H_ */

defaultcfg/fsfwconfig/CMakeLists.txt

@@ -1,15 +0,0 @@
-target_sources(${LIB_FSFW_NAME} PRIVATE
-	ipc/missionMessageTypes.cpp
-	objects/FsfwFactory.cpp
-	pollingsequence/PollingSequenceFactory.cpp
-)
-
-# Should be added to include path
-target_include_directories(${TARGET_NAME} PRIVATE
-	${CMAKE_CURRENT_SOURCE_DIR}
-)
-
-if(NOT FSFW_CONFIG_PATH)
-	set(FSFW_CONFIG_PATH ${CMAKE_CURRENT_SOURCE_DIR})
-endif()
-

defaultcfg/fsfwconfig/fsfwconfig.mk

@@ -1,15 +0,0 @@
-CXXSRC += $(wildcard $(CURRENTPATH)/ipc/*.cpp)
-CXXSRC += $(wildcard $(CURRENTPATH)/objects/*.cpp)
-CXXSRC += $(wildcard $(CURRENTPATH)/pollingsequence/*.cpp)
-CXXSRC += $(wildcard $(CURRENTPATH)/events/*.cpp)
-CXXSRC += $(wildcard $(CURRENTPATH)/tmtc/*.cpp)
-CXXSRC += $(wildcard $(CURRENTPATH)/devices/*.cpp)
-
-INCLUDES += $(CURRENTPATH)
-INCLUDES += $(CURRENTPATH)/objects
-INCLUDES += $(CURRENTPATH)/returnvalues
-INCLUDES += $(CURRENTPATH)/tmtc
-INCLUDES += $(CURRENTPATH)/events
-INCLUDES += $(CURRENTPATH)/devices
-INCLUDES += $(CURRENTPATH)/pollingsequence
-INCLUDES += $(CURRENTPATH)/ipc

doc/README-config.md

@@ -1,21 +0,0 @@
-
-## Configuring the FSFW
-
-The FSFW can be configured via the `fsfwconfig` folder. A template folder has
-been provided to have a starting point for this. The folder should be added
-to the include path.
-
-
-### Configuring the Event Manager
-
-The number of allowed subscriptions can be modified with the following
-parameters:
-
-``` c++
-namespace fsfwconfig {
-//! Configure the allocated pool sizes for the event manager.
-static constexpr size_t FSFW_EVENTMGMR_MATCHTREE_NODES = 240;
-static constexpr size_t FSFW_EVENTMGMT_EVENTIDMATCHERS = 120;
-static constexpr size_t FSFW_EVENTMGMR_RANGEMATCHERS   = 120;
-}
-```

doc/README-highlevel.md

@@ -1,99 +0,0 @@
-# High-level overview
-
-## Structure
-
-The general structure is driven by the usage of interfaces provided by objects. 
-The FSFW uses C++11 as baseline. The intention behind this is that this C++ Standard should be widely available, even with older compilers.
-The FSFW uses dynamic allocation during the initialization but provides static containers during runtime. 
-This simplifies the instantiation of objects and allows the usage of some standard containers. 
-Dynamic Allocation after initialization is discouraged and different solutions are provided in the FSFW to achieve that.
-The fsfw uses run-time type information but exceptions are not allowed.
-
-### Failure Handling
-
-Functions should return a defined ReturnValue_t to signal to the caller that something has gone wrong. 
-Returnvalues must be unique. For this the function HasReturnvaluesIF::makeReturnCode or the Macro MAKE_RETURN can be used.
-The CLASS_ID is a unique id for that type of object. See returnvalues/FwClassIds.
-
-### OSAL
-
-The FSFW provides operation system abstraction layers for Linux, FreeRTOS and RTEMS. 
-The OSAL provides periodic tasks, message queues, clocks and semaphores as well as mutexes.
-The [OSAL README](doc/README-osal.md#top) provides more detailed information on provided components and how to use them.
-
-### Core Components 
-
-The FSFW has following core components. More detailed informations can be found in the
-[core component section](doc/README-core.md#top):
-
-1. Tasks: Abstraction for different (periodic) task types like periodic tasks or tasks with fixed timeslots
-2. ObjectManager: This module stores all `SystemObjects` by mapping a provided unique object ID to the object handles.
-3. Static Stores: Different stores are provided to store data of variable size (like telecommands or small telemetry) in a pool structure without
-   using dynamic memory allocation. These pools are allocated up front.
-3. Clock: This module provided common time related functions
-4. EventManager: This module allows routing of events generated by `SystemObjects`
-5. HealthTable: A component which stores the health states of objects
-
-### Static IDs in the framework
-
-Some parts of the framework use a static routing address for communication. 
-An example setup of ids can be found in the example config in "defaultcft/fsfwconfig/objects/Factory::setStaticFrameworkObjectIds()".
-
-### Events
-
-Events are tied to objects. EventIds can be generated by calling the Macro MAKE_EVENT. This works analog to the returnvalues.
-Every object that needs own EventIds has to get a unique SUBSYSTEM_ID. 
-Every SystemObject can call triggerEvent from the parent class.
-Therefore, event messages contain the specific EventId and the objectId of the object that has triggered.
-
-### Internal Communication
-
-Components communicate mostly over Message through Queues. 
-Those queues are created by calling the singleton QueueFactory::instance()->create(). 
-
-### External Communication
-
-The external communication with the mission control system is mostly up to the user implementation.
-The FSFW provides PUS Services which can be used to but don't need to be used. 
-The services can be seen as a conversion from a TC to a message based communication and back.
-
-#### CCSDS Frames, CCSDS Space Packets and PUS
-
-If the communication is based on CCSDS Frames and Space Packets, several classes can be used to distributed the packets to the corresponding services. Those can be found in tcdistribution. 
-If Space Packets are used, a timestamper must be created. 
-An example can be found in the timemanager folder, this uses CCSDSTime::CDS_short.
-
-#### Device Handlers
-
-DeviceHandlers are another important component of the FSFW. 
-The idea is, to have a software counterpart of every physical device to provide a simple mode, health and commanding interface.
-By separating the underlying Communication Interface with DeviceCommunicationIF, a device handler (DH) can be tested on different hardware.
-The DH has mechanisms to monitor the communication with the physical device which allow for FDIR reaction. 
-Device Handlers can be created by overriding `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).
-
-#### Modes, Health
-
-The two interfaces HasModesIF and HasHealthIF provide access for commanding and monitoring of components.
-On-board Mode Management is implement in hierarchy system. 
-DeviceHandlers and Controllers are the lowest part of the hierarchy. 
-The next layer are Assemblies. Those assemblies act as a component which handle redundancies of handlers. 
-Assemblies share a common core with the next level which are the Subsystems. 
-
-Those Assemblies are intended to act as auto-generated components from a database which describes the subsystem modes. 
-The definitions contain transition and target tables which contain the DH, Assembly and Controller Modes to be commanded.
-Transition tables contain as many steps as needed to reach the mode from any other mode, e.g. a switch into any higher AOCS mode might first turn on the sensors, than the actuators and the controller as last component. 
-The target table is used to describe the state that is checked continuously by the subsystem. 
-All of this allows System Modes to be generated as Subsystem object as well from the same database. 
-This System contains list of subsystem modes in the transition and target tables. 
-Therefore, it allows a modular system to create system modes and easy commanding of those, because only the highest components must be commanded.
-
-The health state represents if the component is able to perform its tasks. 
-This can be used to signal the system to avoid using this component instead of a redundant one.
-The on-board FDIR uses the health state for isolation and recovery. 
-
-## Unit Tests
-
-Unit Tests are provided in the unittest folder. Those use the catch2 framework but do not include catch2 itself. More information on how to run these tests can be found in the separate
-[`fsfw_tests` reposoitory](https://egit.irs.uni-stuttgart.de/fsfw/fsfw_tests)

docs/.gitignore

@@ -0,0 +1 @@
+/_build

docs/CMakeLists.txt

@@ -0,0 +1,66 @@
+# This is based on this excellent posting provided by Sy: 
+# https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/
+find_package(Doxygen REQUIRED)
+find_package(Sphinx REQUIRED)
+
+get_target_property(LIB_FSFW_PUBLIC_HEADER_DIRS ${LIB_FSFW_NAME} INTERFACE_INCLUDE_DIRECTORIES)
+# TODO: Add HAL as well
+file(GLOB_RECURSE LIB_FSFW_PUBLIC_HEADERS ${PROJECT_SOURCE_DIR}/src/*.h)
+file(GLOB_RECURSE RST_DOC_FILES ${PROJECT_SOURCE_DIR}/docs/*.rst)
+
+set(DOXYGEN_INPUT_DIR ${PROJECT_SOURCE_DIR}/src)
+set(DOXYGEN_OUTPUT_DIR ${CMAKE_CURRENT_BINARY_DIR}/doxygen)
+set(DOXYGEN_INDEX_FILE ${DOXYGEN_OUTPUT_DIR}/xml/index.xml)
+set(DOXYFILE_IN ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.in)
+set(DOXYFILE_OUT ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile)
+
+# Replace variables inside @@ with the current values
+configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY)
+
+# Doxygen won't create this for us
+file(MAKE_DIRECTORY ${DOXYGEN_OUTPUT_DIR})
+
+# Only regenerate Doxygen when the Doxyfile or public headers change
+add_custom_command(
+  OUTPUT ${DOXYGEN_INDEX_FILE}
+  DEPENDS ${LIB_FSFW_PUBLIC_HEADERS}
+  COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE_OUT}
+  MAIN_DEPENDENCY ${DOXYFILE_OUT} ${DOXYFILE_IN}
+  COMMENT "Generating docs"
+  VERBATIM
+)
+
+# Nice named target so we can run the job easily
+add_custom_target(Doxygen ALL DEPENDS ${DOXYGEN_INDEX_FILE})
+
+set(SPHINX_SOURCE ${CMAKE_CURRENT_SOURCE_DIR})
+set(SPHINX_BUILD ${CMAKE_CURRENT_BINARY_DIR}/sphinx)
+set(SPHINX_INDEX_FILE ${SPHINX_BUILD}/index.html)
+
+# Only regenerate Sphinx when:
+# - Doxygen has rerun
+# - Our doc files have been updated
+# - The Sphinx config has been updated
+add_custom_command(
+  OUTPUT ${SPHINX_INDEX_FILE}
+  COMMAND
+    ${SPHINX_EXECUTABLE} -b html
+    # Tell Breathe where to find the Doxygen output
+    -Dbreathe_projects.fsfw=${DOXYGEN_OUTPUT_DIR}/xml
+  ${SPHINX_SOURCE} ${SPHINX_BUILD}
+  WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+  DEPENDS
+  # Other docs files you want to track should go here (or in some variable)
+  ${RST_DOC_FILES}
+  ${DOXYGEN_INDEX_FILE}
+  MAIN_DEPENDENCY ${SPHINX_SOURCE}/conf.py
+  COMMENT "Generating documentation with Sphinx"
+)
+
+# Nice named target so we can run the job easily
+add_custom_target(Sphinx ALL DEPENDS ${SPHINX_INDEX_FILE})
+
+# Add an install target to install the docs
+include(GNUInstallDirs)
+install(DIRECTORY ${SPHINX_BUILD}
+DESTINATION ${CMAKE_INSTALL_DOCDIR})

docs/Doxyfile.in

@@ -0,0 +1,7 @@
+INPUT = "@DOXYGEN_INPUT_DIR@"
+
+RECURSIVE = YES
+
+OUTPUT_DIRECTORY = "@DOXYGEN_OUTPUT_DIR@"
+
+GENERATE_XML = YES

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/README-config.md

@@ -0,0 +1,40 @@
+Configuring the FSFW
+======
+
+The FSFW can be configured via the `fsfwconfig` folder. A template folder has
+been provided to have a starting point for this. The folder should be added
+to the include path. The primary configuration file is the `FSFWConfig.h` folder. Some
+of the available options will be explained in more detail here.
+
+# Auto-Translation of Events
+
+The FSFW allows the automatic translation of events, which allows developers to track triggered
+events directly via console output. Using this feature requires:
+
+1. `FSFW_OBJ_EVENT_TRANSLATION` set to 1 in the configuration file.
+2. Special auto-generated translation files which translate event IDs and object IDs into
+   human readable strings. These files can be generated using the 
+   [modgen Python scripts](https://git.ksat-stuttgart.de/source/modgen.git).
+3. The generated translation files for the object IDs should be named `translatesObjects.cpp`
+   and `translateObjects.h` and should be copied to the `fsfwconfig/objects` folder
+4. The generated translation files for the event IDs should be named `translateEvents.cpp` and
+   `translateEvents.h` and should be copied to the `fsfwconfig/events` folder
+   
+An example implementations of these translation file generators can be found as part
+of the [SOURCE project here](https://git.ksat-stuttgart.de/source/sourceobsw/-/tree/development/generators)
+or the [FSFW example](https://egit.irs.uni-stuttgart.de/fsfw/fsfw_example_public/src/branch/master/generators)
+
+## Configuring the Event Manager
+
+The number of allowed subscriptions can be modified with the following
+parameters:
+
+``` c++
+namespace fsfwconfig {
+//! Configure the allocated pool sizes for the event manager.
+static constexpr size_t FSFW_EVENTMGMR_MATCHTREE_NODES = 240;
+static constexpr size_t FSFW_EVENTMGMT_EVENTIDMATCHERS = 120;
+static constexpr size_t FSFW_EVENTMGMR_RANGEMATCHERS   = 120;
+}
+```
+

docs/README-core.md

@@ -19,8 +19,9 @@ A nullptr check of the returning Pointer must be done. This function is based on
 ```cpp
 template <typename T> T* ObjectManagerIF::get( object_id_t id )
 ```
-* A typical way to create all objects on startup is a handing a static produce function to the ObjectManager on creation.
+* A typical way to create all objects on startup is a handing a static produce function to the
-By calling objectManager->initialize() the produce function will be called and all SystemObjects will be initialized afterwards.
+  ObjectManager on creation. By calling objectManager->initialize() the produce function will be
+  called and all SystemObjects will be initialized afterwards.
 
 ### Event Manager
 
@@ -36,14 +37,19 @@ By calling objectManager->initialize() the produce function will be called and a
 
 ### Stores
 
-* The message based communication can only exchange a few bytes of information inside the message itself. Therefore, additional information can 
+* The message based communication can only exchange a few bytes of information inside the message
-  be exchanged with Stores. With this, only the store address must be exchanged in the message.
+  itself. Therefore, additional information can  be exchanged with Stores. With this, only the
-* Internally, the FSFW uses an IPC Store to exchange data between processes. For incoming TCs a TC Store is used. For outgoing TM a TM store is used.
+  store address must be exchanged in the message.
+* Internally, the FSFW uses an IPC Store to exchange data between processes. For incoming TCs a TC
+  Store is used. For outgoing TM a TM store is used.
 * All of them should use the Thread Safe Class storagemanager/PoolManager
 
 ### Tasks
 
 There are two different types of tasks:
- * The PeriodicTask just executes objects that are of type ExecutableObjectIF in the order of the insertion to the Tasks.
+ * The PeriodicTask just executes objects that are of type ExecutableObjectIF in the order of the
- * FixedTimeslotTask executes a list of calls in the order of the given list. This is intended for DeviceHandlers, where polling should be in a defined order. An example can be found in defaultcfg/fsfwconfig/pollingSequence
+   insertion to the Tasks.
+ * FixedTimeslotTask executes a list of calls in the order of the given list. This is intended for
+   DeviceHandlers, where polling should be in a defined order. An example can be found in 
+   `defaultcfg/fsfwconfig/pollingSequence` folder
 

docs/README-highlevel.md

@@ -0,0 +1,135 @@
+High-level overview
+======
+
+# Structure
+
+The general structure is driven by the usage of interfaces provided by objects. 
+The FSFW uses C++11 as baseline. The intention behind this is that this C++ Standard should be
+widely available, even with older compilers.
+The FSFW uses dynamic allocation during the initialization but provides static containers during runtime. 
+This simplifies the instantiation of objects and allows the usage of some standard containers. 
+Dynamic Allocation after initialization is discouraged and different solutions are provided in the
+FSFW to achieve that. The fsfw uses run-time type information but exceptions are not allowed.
+
+# Failure Handling
+
+Functions should return a defined `ReturnValue_t` to signal to the caller that something has
+gone wrong. Returnvalues must be unique. For this the function `HasReturnvaluesIF::makeReturnCode`
+or the macro `MAKE_RETURN` can be used. The `CLASS_ID` is a unique id for that type of object.
+See `returnvalues/FwClassIds` folder. The user can add custom `CLASS_ID`s via the
+`fsfwconfig` folder.
+
+# OSAL
+
+The FSFW provides operation system abstraction layers for Linux, FreeRTOS and RTEMS. 
+The OSAL provides periodic tasks, message queues, clocks and semaphores as well as mutexes.
+The [OSAL README](doc/README-osal.md#top) provides more detailed information on provided components
+and how to use them.
+
+# Core Components 
+
+The FSFW has following core components. More detailed informations can be found in the
+[core component section](doc/README-core.md#top):
+
+1. Tasks: Abstraction for different (periodic) task types like periodic tasks or tasks 
+   with fixed timeslots
+2. ObjectManager: This module stores all `SystemObjects` by mapping a provided unique object ID
+   to the object handles.
+3. Static Stores: Different stores are provided to store data of variable size (like telecommands 
+   or small telemetry) in a pool structure without using dynamic memory allocation.
+   These pools are allocated up front.
+3. Clock: This module provided common time related functions
+4. EventManager: This module allows routing of events generated by `SystemObjects`
+5. HealthTable: A component which stores the health states of objects
+
+# Static IDs in the framework
+
+Some parts of the framework use a static routing address for communication. 
+An example setup of ids can be found in the example config in `defaultcft/fsfwconfig/objects`
+ inside the function `Factory::setStaticFrameworkObjectIds()`.
+
+# Events
+
+Events are tied to objects. EventIds can be generated by calling the Macro MAKE_EVENT. 
+This works analog to the returnvalues. Every object that needs own EventIds has to get a
+unique SUBSYSTEM_ID. Every SystemObject can call triggerEvent from the parent class.
+Therefore, event messages contain the specific EventId and the objectId of the object that
+has triggered.
+
+# Internal Communication
+
+Components communicate mostly via Messages through Queues. 
+Those queues are created by calling the singleton `QueueFactory::instance()->create()` which
+will create `MessageQueue` instances for the used OSAL.
+
+# External Communication
+
+The external communication with the mission control system is mostly up to the user implementation.
+The FSFW provides PUS Services which can be used to but don't need to be used. 
+The services can be seen as a conversion from a TC to a message based communication and back.
+
+## TMTC Communication
+
+The FSFW provides some components to facilitate TMTC handling via the PUS commands.
+For example, a UDP or TCP PUS server socket can be opened on a specific port using the
+files located in `osal/common`. The FSFW example uses this functionality to allow sending telecommands
+and receiving telemetry using the [TMTC commander application](https://github.com/spacefisch/tmtccmd).
+Simple commands like the PUS Service 17 ping service can be tested by simply running the
+`tmtc_client_cli.py` or `tmtc_client_gui.py` utility in 
+the [example tmtc folder](https://egit.irs.uni-stuttgart.de/fsfw/fsfw_example_public/src/branch/master/tmtc)
+while the `fsfw_example` application is running.
+
+More generally, any class responsible for handling incoming telecommands and sending telemetry
+can implement the generic `TmTcBridge` class located in `tmtcservices`. Many applications
+also use a dedicated polling task for reading telecommands which passes telecommands
+to the `TmTcBridge` implementation.
+
+## CCSDS Frames, CCSDS Space Packets and PUS
+
+If the communication is based on CCSDS Frames and Space Packets, several classes can be used to
+distributed the packets to the corresponding services. Those can be found in `tcdistribution`. 
+If Space Packets are used, a timestamper has to be provided by the user. 
+An example can be found in the `timemanager` folder, which uses `CCSDSTime::CDS_short`.
+
+# Device Handlers
+
+DeviceHandlers are another important component of the FSFW. 
+The idea is, to have a software counterpart of every physical device to provide a simple mode,
+health and commanding interface. By separating the underlying Communication Interface with 
+`DeviceCommunicationIF`, a device handler (DH) can be tested on different hardware.
+The DH has mechanisms to monitor the communication with the physical device which allow
+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).
+
+# Modes and Health
+
+The two interfaces `HasModesIF` and `HasHealthIF` provide access for commanding and monitoring
+of components. On-board Mode Management is implement in hierarchy system. 
+DeviceHandlers and Controllers are the lowest part of the hierarchy. 
+The next layer are Assemblies. Those assemblies act as a component which handle
+redundancies of handlers. Assemblies share a common core with the next level which
+are the Subsystems. 
+
+Those Assemblies are intended to act as auto-generated components from a database which describes
+the subsystem modes. The definitions contain transition and target tables which contain the DH,
+Assembly and Controller Modes to be commanded.
+Transition tables contain as many steps as needed to reach the mode from any other mode, e.g. a
+switch into any higher AOCS mode might first turn on the sensors, than the actuators and the
+controller as last component. 
+The target table is used to describe the state that is checked continuously by the subsystem. 
+All of this allows System Modes to be generated as Subsystem object as well from the same database. 
+This System contains list of subsystem modes in the transition and target tables. 
+Therefore, it allows a modular system to create system modes and easy commanding of those, because
+only the highest components must be commanded.
+
+The health state represents if the component is able to perform its tasks. 
+This can be used to signal the system to avoid using this component instead of a redundant one.
+The on-board FDIR uses the health state for isolation and recovery. 
+
+# Unit Tests
+
+Unit Tests are provided in the unittest folder. Those use the catch2 framework but do not include
+catch2 itself. More information on how to run these tests can be found in the separate
+[`fsfw_tests` reposoitory](https://egit.irs.uni-stuttgart.de/fsfw/fsfw_tests)

docs/README-localpools.md

@@ -31,7 +31,9 @@ cohesive pool variables. These sets simply iterator over the list of variables a
 `read` and `commit` functions of each variable. The following diagram shows the
 high-level architecture of the local data pools.
 
-<img align="center" src="./images/PoolArchitecture.png" width="50%"> <br>
+.. image:: ../misc/logo/FSFW_Logo_V3_bw.png
+   :alt: FSFW Logo
+
 
 An example is shown for using the local data pools with a Gyroscope.
 For example, the following code shows an implementation to access data from a Gyroscope taken

docs/api.rst

@@ -0,0 +1,16 @@
+API
+====
+
+.. toctree::
+   :maxdepth: 4
+
+   api/objectmanager
+   api/task
+   api/ipc
+   api/returnvalue
+   api/event
+   api/modes
+   api/health
+   api/action
+   api/devicehandler
+   api/controller

docs/api/action.rst

@@ -0,0 +1,15 @@
+Action Module API
+=================
+
+``ActionHelper``
+-----------------
+
+.. doxygenclass:: ActionHelper
+	:members:
+
+``HasActionsIF``
+-----------------
+
+.. doxygenclass:: HasActionsIF
+	:members:
+	:protected-members:

docs/api/controller.rst

@@ -0,0 +1,16 @@
+Controller API
+=================
+
+``ControllerBase``
+-------------------------
+
+.. doxygenclass:: ControllerBase
+	:members:
+	:protected-members:
+
+``ExtendedControllerBase``
+-----------------------------
+
+.. doxygenclass:: ExtendedControllerBase
+	:members:
+	:protected-members:

docs/api/devicehandler.rst

@@ -0,0 +1,16 @@
+Device Handler Base API
+=========================
+
+``DeviceHandlerBase``
+-----------------------
+
+.. doxygenclass:: DeviceHandlerBase
+	:members:
+	:protected-members:
+
+``DeviceHandlerIF``
+-----------------------
+
+.. doxygenclass:: DeviceHandlerIF
+	:members:
+	:protected-members:

docs/api/event.rst

@@ -0,0 +1,6 @@
+.. _eventapi:
+
+Event API
+============
+
+.. doxygenfile:: Event.h

docs/api/health.rst

@@ -0,0 +1,9 @@
+Health API
+===========
+
+``HasHealthIF``
+------------------
+
+.. doxygenclass:: HasHealthIF
+	:members:
+	:protected-members:

docs/api/ipc.rst

@@ -0,0 +1,9 @@
+IPC Module API
+=================
+
+``MessageQueueIF``
+-------------------
+
+.. doxygenclass:: MessageQueueIF
+	:members:
+	:protected-members:

docs/api/modes.rst

@@ -0,0 +1,10 @@
+Modes API
+=========
+
+
+``HasModesIF``
+---------------
+
+.. doxygenclass:: HasModesIF
+	:members:
+	:protected-members:

docs/api/objectmanager.rst

@@ -0,0 +1,30 @@
+Object Manager API
+=========================
+
+``SystemObject``
+--------------------
+
+.. doxygenclass:: SystemObject
+	:members:
+	:protected-members:
+
+``ObjectManager``
+-----------------------
+
+.. doxygenclass:: ObjectManager
+	:members:
+	:protected-members:
+
+``SystemObjectIF``
+--------------------
+
+.. doxygenclass:: SystemObjectIF
+	:members:
+	:protected-members:
+
+``ObjectManagerIF``
+-----------------------
+
+.. doxygenclass:: ObjectManagerIF
+	:members:
+	:protected-members:

docs/api/returnvalue.rst

@@ -0,0 +1,10 @@
+.. _retvalapi:
+
+Returnvalue API
+==================
+
+.. doxygenfile:: HasReturnvaluesIF.h
+
+.. _fwclassids:
+
+.. doxygenfile:: FwClassIds.h

docs/api/task.rst

@@ -0,0 +1,8 @@
+Task API
+=========
+
+``ExecutableObjectIF``
+-----------------------
+
+.. doxygenclass:: ExecutableObjectIF
+	:members:

docs/conf.py

@@ -0,0 +1,56 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Flight Software Framework'
+copyright = '2021, Institute of Space Systems (IRS)'
+author = 'Institute of Space Systems (IRS)'
+
+# The full version, including alpha/beta/rc tags
+release = '2.0.1'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [ "breathe" ]
+
+breathe_default_project = "fsfw"
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = []

docs/config.rst

@@ -0,0 +1,41 @@
+Configuring the FSFW
+=====================
+
+The FSFW can be configured via the ``fsfwconfig`` folder. A template folder has been provided in
+``misc/defaultcfg`` to have a starting point for this. The folder should be added
+to the include path. The primary configuration file is the ``FSFWConfig.h`` folder. Some
+of the available options will be explained in more detail here.
+
+Auto-Translation of Events
+----------------------------
+
+The FSFW allows the automatic translation of events, which allows developers to track triggered
+events directly via console output. Using this feature requires:
+
+1. ``FSFW_OBJ_EVENT_TRANSLATION`` set to 1 in the configuration file.
+2. Special auto-generated translation files which translate event IDs and object IDs into
+   human readable strings. These files can be generated using the
+   `fsfwgen Python scripts <https://egit.irs.uni-stuttgart.de/fsfw/fsfw-gen>`_.
+3. The generated translation files for the object IDs should be named ``translatesObjects.cpp``
+   and ``translateObjects.h`` and should be copied to the ``fsfwconfig/objects`` folder
+4. The generated translation files for the event IDs should be named ``translateEvents.cpp`` and
+   ``translateEvents.h`` and should be copied to the ``fsfwconfig/events`` folder
+
+An example implementations of these translation file generators can be found as part
+of the `SOURCE project here <https://git.ksat-stuttgart.de/source/sourceobsw/-/tree/develop/generators>`_
+or the `FSFW example <https://egit.irs.uni-stuttgart.de/fsfw/fsfw-example-hosted/src/branch/master/generators>`_
+
+Configuring the Event Manager
+----------------------------------
+
+The number of allowed subscriptions can be modified with the following
+parameters:
+
+.. code-block:: cpp
+
+   namespace fsfwconfig {
+   //! Configure the allocated pool sizes for the event manager.
+   static constexpr size_t FSFW_EVENTMGMR_MATCHTREE_NODES = 240;
+   static constexpr size_t FSFW_EVENTMGMT_EVENTIDMATCHERS = 120;
+   static constexpr size_t FSFW_EVENTMGMR_RANGEMATCHERS   = 120;
+   }

docs/controllers.rst

@@ -0,0 +1,2 @@
+Controllers
+=============

docs/core.rst

@@ -0,0 +1,70 @@
+.. _core:
+
+Core Modules
+=============
+
+The core modules provide the most important functionalities of the Flight Software Framework.
+
+Clock
+------
+
+- This is a class of static functions that can be used at anytime
+- Leap Seconds must be set if any time conversions from UTC to other times is used
+
+Object Manager
+---------------
+
+- Must be created during program startup
+- The component which handles all references. All :cpp:class:`SystemObject`\s register at this
+  component.
+- All :cpp:class:`SystemObject`\s needs to have a unique Object ID. Those can be managed like
+  framework objects.
+- A reference to an object can be retrieved by calling the ``get`` function of
+  :cpp:class:`ObjectManagerIF`. The target type must be specified as a template argument.
+  A ``nullptr`` check of the returning pointer must be done. This function is based on
+  run-time type information.
+
+	.. code-block:: cpp
+
+		template <typename T> T* ObjectManagerIF::get(object_id_t id);
+
+- A typical way to create all objects on startup is a handing a static produce function to the
+  ObjectManager on creation. By calling ``ObjectManager::instance()->initialize(produceFunc)`` the
+  produce function will be called and all :cpp:class:`SystemObject`\s will be initialized
+  afterwards.
+
+Event Manager
+---------------
+
+- Component which allows routing of events
+- Other objects can subscribe to specific events, ranges of events or all events of an object.
+- Subscriptions can be done during runtime but should be done during initialization
+- Amounts of allowed subscriptions can be configured in ``FSFWConfig.h``
+
+Health Table
+---------------
+
+- A component which holds every health state
+- Provides a thread safe way to access all health states without the need of message exchanges
+
+Stores
+--------------
+
+- The message based communication can only exchange a few bytes of information inside the message
+  itself. Therefore, additional information can  be exchanged with Stores. With this, only the
+  store address must be exchanged in the message.
+- Internally, the FSFW uses an IPC Store to exchange data between processes. For incoming TCs a TC
+  Store is used. For outgoing TM a TM store is used.
+- All of them should use the Thread Safe Class storagemanager/PoolManager
+
+Tasks
+---------
+
+There are two different types of tasks:
+
+- The PeriodicTask just executes objects that are of type ExecutableObjectIF in the order of the
+  insertion to the Tasks.
+- FixedTimeslotTask executes a list of calls in the order of the given list. This is intended for
+  DeviceHandlers, where polling should be in a defined order. An example can be found in 
+  ``defaultcfg/fsfwconfig/pollingSequence`` folder
+

docs/devicehandlers.rst

@@ -0,0 +1,3 @@
+Device Handlers
+==================
+

docs/getting_started.rst

@@ -0,0 +1,115 @@
+Getting Started
+================
+
+
+Getting started
+----------------
+
+The `Hosted FSFW example`_ provides a good starting point and a demo to see the FSFW capabilities.
+It is recommended to get started by building and playing around with the demo application.
+There are also other examples provided for all OSALs using the popular embedded platforms
+Raspberry Pi, Beagle Bone Black and STM32H7.
+
+Generally, the FSFW is included in a project by providing
+a configuration folder, building the static library and linking against it. 
+There are some functions like ``printChar`` which are different depending on the target architecture
+and need to be implemented by the mission developer.
+
+A template configuration folder was provided and can be copied into the project root to have
+a starting point. The [configuration section](docs/README-config.md#top) provides more specific 
+information about the possible options.
+
+Adding the library
+-------------------
+
+The following steps show how to add and use FSFW components. It is still recommended to
+try out the example mentioned above to get started, but the following steps show how to
+add and link against the FSFW library in general.
+
+1. Add this repository as a submodule
+
+   .. code-block:: console
+
+      git submodule add https://egit.irs.uni-stuttgart.de/fsfw/fsfw.git fsfw
+
+2. Add the following directive inside the uppermost ``CMakeLists.txt`` file of your project
+
+   .. code-block:: cmake
+
+      add_subdirectory(fsfw)
+
+3. Make sure to provide a configuration folder and supply the path to that folder with
+   the `FSFW_CONFIG_PATH` CMake variable from the uppermost `CMakeLists.txt` file.
+   It is also necessary to provide the `printChar` function. You can find an example
+   implementation for a hosted build
+   `here <https://egit.irs.uni-stuttgart.de/fsfw/fsfw-example-hosted/src/branch/master/bsp_hosted/utility/printChar.c>`_.
+
+4. Link against the FSFW library
+
+   .. code-block:: cmake
+
+      target_link_libraries(<YourProjectName> PRIVATE fsfw)
+
+
+5. It should now be possible use the FSFW as a static library from the user code.
+
+Building the unittests
+-------------------------
+
+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.
+
+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`.
+
+You can use the following commands inside the ``fsfw`` folder to set up the build system
+
+.. code-block:: console
+
+   mkdir build-tests && cd build-tests
+   cmake -DFSFW_BUILD_UNITTESTS=ON -DFSFW_OSAL=host ..
+
+
+You can also use ``-DFSFW_OSAL=linux`` on Linux systems.
+
+Coverage data in HTML format can be generated using the `Code coverage`_ CMake module.
+To build the unittests, run them and then generare the coverage data in this format,
+the following command can be used inside the build directory after the build system was set up
+
+.. code-block:: console
+
+   cmake --build . -- fsfw-tests_coverage -j
+
+
+The ``helper.py`` script located in the ``script`` folder can also be used to create, build
+and open the unittests conveniently. Try ``helper.py -h`` for more information.
+
+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
+
+.. code-block:: bash
+
+   mkdir build-docs && cd build-docs
+   cmake -DFSFW_BUILD_DOCS=ON -DFSFW_OSAL=host ..
+
+Then you can generate the documentation using
+
+.. code-block:: bash
+
+   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.
+
+.. _`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

@@ -0,0 +1,149 @@
+.. _highlevel:
+
+High-level overview
+===================
+
+Structure
+----------
+
+The general structure is driven by the usage of interfaces provided by objects.
+The FSFW uses C++11 as baseline. The intention behind this is that this C++ Standard should be
+widely available, even with older compilers.
+The FSFW uses dynamic allocation during the initialization but provides static containers during runtime.
+This simplifies the instantiation of objects and allows the usage of some standard containers.
+Dynamic Allocation after initialization is discouraged and different solutions are provided in the
+FSFW to achieve that. The fsfw uses run-time type information but exceptions are not allowed.
+
+Failure Handling
+-----------------
+
+Functions should return a defined :cpp:type:`ReturnValue_t` to signal to the caller that something has
+gone wrong. Returnvalues must be unique. For this the function :cpp:func:`HasReturnvaluesIF::makeReturnCode`
+or the :ref:`macro MAKE_RETURN_CODE <retvalapi>` can be used. The ``CLASS_ID`` is a unique ID for that type of object.
+See the :ref:`FSFW Class IDs file <fwclassids>`. The user can add custom ``CLASS_ID``\s via the
+``fsfwconfig`` folder.
+
+OSAL
+------------
+
+The FSFW provides operation system abstraction layers for Linux, FreeRTOS and RTEMS.
+The OSAL provides periodic tasks, message queues, clocks and semaphores as well as mutexes.
+The :ref:`OSAL README <osal>` provides more detailed information on provided components
+and how to use them.
+
+Core Components
+----------------
+
+The FSFW has following core components. More detailed informations can be found in the
+:ref:`core component section <core>`:
+
+1. Tasks: Abstraction for different (periodic) task types like periodic tasks or tasks
+   with fixed timeslots
+2. ObjectManager: This module stores all `SystemObjects` by mapping a provided unique object ID
+   to the object handles.
+3. Static Stores: Different stores are provided to store data of variable size (like telecommands
+   or small telemetry) in a pool structure without using dynamic memory allocation.
+   These pools are allocated up front.
+4. Clock: This module provided common time related functions
+5. EventManager: This module allows routing of events generated by `SystemObjects`
+6. HealthTable: A component which stores the health states of objects
+
+Static IDs in the framework
+--------------------------------
+
+Some parts of the framework use a static routing address for communication.
+An example setup of IDs can be found in the example config in ``misc/defaultcfg/fsfwconfig/objects``
+inside the function ``Factory::setStaticFrameworkObjectIds``.
+
+Events
+----------------
+
+Events are tied to objects. EventIds can be generated by calling the
+:ref:`macro MAKE_EVENT <eventapi>` or the function :cpp:func:`event::makeEvent`.
+This works analog to the returnvalues. Every object that needs own Event IDs has to get a
+unique ``SUBSYSTEM_ID``. Every :cpp:class:`SystemObject` can call
+:cpp:func:`SystemObject::triggerEvent` from the parent class.
+Therefore, event messages contain the specific EventId and the objectId of the object that
+has triggered.
+
+Internal Communication
+-------------------------
+
+Components communicate mostly via Messages through Queues.
+Those queues are created by calling the singleton ``QueueFactory::instance()->create`` which
+will create `MessageQueue` instances for the used OSAL.
+
+External Communication
+--------------------------
+
+The external communication with the mission control system is mostly up to the user implementation.
+The FSFW provides PUS Services which can be used to but don't need to be used.
+The services can be seen as a conversion from a TC to a message based communication and back.
+
+TMTC Communication
+~~~~~~~~~~~~~~~~~~~
+
+The FSFW provides some components to facilitate TMTC handling via the PUS commands.
+For example, a UDP or TCP PUS server socket can be opened on a specific port using the
+files located in ``osal/common``. The FSFW example uses this functionality to allow sending
+telecommands and receiving telemetry using the
+`TMTC commander application <https://github.com/robamu-org/tmtccmd>`_.
+
+Simple commands like the PUS Service 17 ping service can be tested by simply running the
+``tmtc_client_cli.py`` or ``tmtc_client_gui.py`` utility in
+the `example tmtc folder <https://egit.irs.uni-stuttgart.de/fsfw/fsfw_example_public/src/branch/master/tmtc>`_
+while the `fsfw_example` application is running.
+
+More generally, any class responsible for handling incoming telecommands and sending telemetry
+can implement the generic ``TmTcBridge`` class located in ``tmtcservices``. Many applications
+also use a dedicated polling task for reading telecommands which passes telecommands
+to the ``TmTcBridge`` implementation.
+
+CCSDS Frames, CCSDS Space Packets and PUS
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If the communication is based on CCSDS Frames and Space Packets, several classes can be used to
+distributed the packets to the corresponding services. Those can be found in ``tcdistribution``.
+If Space Packets are used, a timestamper has to be provided by the user.
+An example can be found in the ``timemanager`` folder, which uses ``CCSDSTime::CDS_short``.
+
+Device Handlers
+--------------------------
+
+DeviceHandlers are another important component of the FSFW. The idea is, to have a software
+counterpart of every physical device to provide a simple mode, health and commanding interface.
+By separating the underlying Communication Interface with
+``DeviceCommunicationIF``, a device handler (DH) can be tested on different hardware.
+The DH has mechanisms to monitor the communication with the physical device which allow
+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).
+
+Modes and Health
+--------------------
+
+The two interfaces ``HasModesIF`` and ``HasHealthIF`` provide access for commanding and monitoring
+of components. On-board mode management is implement in hierarchy system.
+
+- Device handlers and controllers are the lowest part of the hierarchy.
+- The next layer are assemblies. Those assemblies act as a component which handle
+  redundancies of handlers. Assemblies share a common core with the top level subsystem components
+- The top level subsystem components are used to group assemblies, controllers and device handlers.
+  For example, a spacecraft can have a atttitude control subsystem and a power subsystem.
+
+Those assemblies are intended to act as auto-generated components from a database which describes
+the subsystem modes. The definitions contain transition and target tables which contain the DH,
+Assembly and Controller Modes to be commanded.
+Transition tables contain as many steps as needed to reach the mode from any other mode, e.g. a
+switch into any higher AOCS mode might first turn on the sensors, than the actuators and the
+controller as last component.
+The target table is used to describe the state that is checked continuously by the subsystem.
+All of this allows System Modes to be generated as Subsystem object as well from the same database.
+This System contains list of subsystem modes in the transition and target tables.
+Therefore, it allows a modular system to create system modes and easy commanding of those, because
+only the highest components must be commanded.
+
+The health state represents if the component is able to perform its tasks.
+This can be used to signal the system to avoid using this component instead of a redundant one.
+The on-board FDIR uses the health state for isolation and recovery.

docs/index.rst

@@ -0,0 +1,69 @@
+.. Flight Software Framework documentation master file, created by
+   sphinx-quickstart on Tue Nov 30 10:56:03 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Flight Software Framework (FSFW) documentation
+================================================
+
+.. image:: ../misc/logo/FSFW_Logo_V3_bw.png
+   :alt: FSFW Logo
+
+The Flight Software Framework is a C++ Object Oriented Framework for unmanned,
+automated systems like Satellites. 
+
+The initial version of the Flight Software Framework was developed during
+the Flying Laptop Project by the University of Stuttgart in cooperation
+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 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:
+
+- Linux
+- Host 
+- FreeRTOS
+- RTEMS
+
+The recommended hardware is a microprocessor with more than 1 MB of RAM and 1 MB of non-volatile
+memory. For reference, current applications use a Cobham Gaisler UT699 (LEON3FT), a
+ISISPACE IOBC or a Zynq-7020 SoC. The ``fsfw`` was also successfully run on the
+STM32H743ZI-Nucleo board and on a Raspberry Pi and is currently running on the active
+satellite mission Flying Laptop.
+
+Index
+-------
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   getting_started
+   highlevel
+   core
+   config
+   osal
+   pus
+   devicehandlers
+   controllers
+   localpools
+   api
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/localpools.rst

@@ -0,0 +1,181 @@
+Local Data Pools
+=========================================
+
+The following text is targeted towards mission software developers which would like
+to use the local data pools provided by the FSFW to store data like sensor values so they can be
+used by other software objects like controllers as well. If a custom class should have a local
+pool which  can be used by other software objects as well, following steps have to be performed:
+
+1. Create a ``LocalDataPoolManager`` member object in the custom class
+2. Implement the ``HasLocalDataPoolIF`` with specifies the interface between the local pool
+   manager and the class owning the local pool.
+
+The local data pool manager is also able to process housekeeping service requests in form
+of messages, generate periodic housekeeping packet, generate notification and snapshots of changed
+variables and datasets and process notifications and snapshots coming from other objects.
+The two former tasks are related to the external interface using telemetry and telecommands (TMTC)
+while the later two are related to data consumers like controllers only acting on data change
+detected by the data creator instead of checking the data manually each cycle. Two important
+framework classes ``DeviceHandlerBase`` and ``ExtendedControllerBase`` already perform the two steps
+shown above so the steps required are altered slightly.
+
+Storing and Accessing pool data
+-------------------------------------
+
+The pool manager is responsible for thread-safe access of the pool data, but the actual
+access to the pool data from the point of view of a mission software developer happens via proxy
+classes like pool variable classes. These classes store a copy
+of the pool variable with the matching datatype and copy the actual data from the local pool
+on a ``read`` call. Changed variables can then be written to the local pool with a ``commit`` call.
+The ``read`` and ``commit`` calls are thread-safe and can be called concurrently from data creators
+and data consumers. Generally, a user will create a dataset class which in turn groups all
+cohesive pool variables. These sets simply iterator over the list of variables and call the
+``read`` and ``commit`` functions of each variable. The following diagram shows the
+high-level architecture of the local data pools.
+
+.. image:: ../docs/images/PoolArchitecture.png
+	:alt: Pool Architecture
+
+An example is shown for using the local data pools with a Gyroscope.
+For example, the following code shows an implementation to access data from a Gyroscope taken
+from the SOURCE CubeSat project:
+
+.. code-block:: cpp
+
+	class GyroPrimaryDataset: public StaticLocalDataSet<3 * sizeof(float)> {
+	public:
+	    /**
+	     * Constructor for data users
+	     * @param gyroId
+	     */
+	    GyroPrimaryDataset(object_id_t gyroId):
+	            StaticLocalDataSet(sid_t(gyroId, gyrodefs::GYRO_DATA_SET_ID)) {
+	        setAllVariablesReadOnly();
+	    }
+
+	    lp_var_t<float> angVelocityX = lp_var_t<float>(sid.objectId,
+	            gyrodefs::ANGULAR_VELOCITY_X, this);
+	    lp_var_t<float> angVelocityY = lp_var_t<float>(sid.objectId,
+	            gyrodefs::ANGULAR_VELOCITY_Y, this);
+	    lp_var_t<float> angVelocityZ = lp_var_t<float>(sid.objectId,
+	            gyrodefs::ANGULAR_VELOCITY_Z, this);
+	private:
+
+	    friend class GyroHandler;
+	    /**
+	     * Constructor for data creator
+	     * @param hkOwner
+	     */
+	    GyroPrimaryDataset(HasLocalDataPoolIF* hkOwner):
+	            StaticLocalDataSet(hkOwner, gyrodefs::GYRO_DATA_SET_ID) {}
+	};
+
+There is a public constructor for users which sets all variables to read-only and there is a
+constructor for the GyroHandler data creator by marking it private and declaring the ``GyroHandler``
+as a friend class. Both the atittude controller and the ``GyroHandler`` can now
+use the same class definition to access the pool variables with ``read`` and ``commit`` semantics
+in a thread-safe way. Generally, each class requiring access will have the set class as a member
+class. The data creator will also be generally a ``DeviceHandlerBase`` subclass and some additional
+steps are necessary to expose the set for housekeeping purposes.
+
+Using the local data pools in a ``DeviceHandlerBase`` subclass
+--------------------------------------------------------------
+
+It is very common to store data generated by devices like a sensor into a pool which can
+then be used by other objects. Therefore, the ``DeviceHandlerBase`` already has a
+local pool. Using the aforementioned example, the ``GyroHandler`` will now have the set class
+as a member:
+
+.. code-block:: cpp
+
+	class GyroHandler: ... {
+
+	public:
+		...
+	private:
+		...
+		GyroPrimaryDataset gyroData;
+		...
+	};
+
+
+The constructor used for the creators expects the owner class as a parameter, so we initialize
+the object in the `GyroHandler` constructor like this:
+
+.. code-block:: cpp
+
+	GyroHandler::GyroHandler(object_id_t objectId, object_id_t comIF,
+	        CookieIF *comCookie, uint8_t switchId):
+	        DeviceHandlerBase(objectId, comIF, comCookie), switchId(switchId),
+			gyroData(this) {}
+
+
+We need to assign the set to a reply ID used in the ``DeviceHandlerBase``.
+The combination of the ``GyroHandler`` object ID and the reply ID will be the 64-bit structure ID
+``sid_t`` and is used to globally identify the set, for example when requesting housekeeping data or
+generating update messages. We need to assign our custom set class in some way so that the local
+pool manager can access the custom data sets as well.
+By default, the ``getDataSetHandle`` will take care of this tasks. The default implementation for a
+``DeviceHandlerBase`` subclass will use the internal command map to retrieve
+a handle to a dataset from a given reply ID. Therefore,
+we assign the set in the ``fillCommandAndReplyMap`` function:
+
+.. code-block:: cpp
+
+	void GyroHandler::fillCommandAndReplyMap() {
+		...
+		this->insertInCommandAndReplyMap(gyrodefs::GYRO_DATA, 3, &gyroData);
+		...
+	}
+
+
+Now, we need to create the actual pool entries as well, using the ``initializeLocalDataPool``
+function. Here, we also immediately subscribe for periodic housekeeping packets
+with an interval of 4 seconds. They are still disabled in this example and can be enabled
+with a housekeeping service command.
+
+.. code-block:: cpp
+
+	ReturnValue_t GyroHandler::initializeLocalDataPool(localpool::DataPool &localDataPoolMap,
+			LocalDataPoolManager &poolManager) {
+		localDataPoolMap.emplace(gyrodefs::ANGULAR_VELOCITY_X,
+				new PoolEntry<float>({0.0}));
+		localDataPoolMap.emplace(gyrodefs::ANGULAR_VELOCITY_Y,
+				new PoolEntry<float>({0.0}));
+		localDataPoolMap.emplace(gyrodefs::ANGULAR_VELOCITY_Z,
+				new PoolEntry<float>({0.0}));
+		localDataPoolMap.emplace(gyrodefs::GENERAL_CONFIG_REG42,
+				new PoolEntry<uint8_t>({0}));
+		localDataPoolMap.emplace(gyrodefs::RANGE_CONFIG_REG43,
+				new PoolEntry<uint8_t>({0}));
+
+		poolManager.subscribeForPeriodicPacket(gyroData.getSid(), false, 4.0, false);
+		return HasReturnvaluesIF::RETURN_OK;
+	}
+
+Now, if we receive some sensor data and converted them into the right format,
+we can write it into the pool like this, using a guard class to ensure the set is commited back
+in any case:
+
+.. code-block:: cpp
+
+	PoolReadGuard readHelper(&gyroData);
+	if(readHelper.getReadResult() == HasReturnvaluesIF::RETURN_OK) {
+		if(not gyroData.isValid()) {
+			gyroData.setValidity(true, true);
+		}
+
+		gyroData.angVelocityX = angularVelocityX;
+		gyroData.angVelocityY = angularVelocityY;
+		gyroData.angVelocityZ = angularVelocityZ;
+	}
+
+
+The guard class will commit the changed data on destruction automatically.
+
+Using the local data pools in a ``ExtendedControllerBase`` subclass
+----------------------------------------------------------------------
+
+Coming soon
+
+

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/osal.rst

@@ -0,0 +1,63 @@
+.. _osal:
+
+Operating System Abstraction Layer (OSAL)
+============================================
+
+Some specific information on the provided OSALs are provided.
+
+Linux
+-------
+
+This OSAL can be used to compile for Linux host systems like Ubuntu 20.04 or for
+embedded Linux targets like the Raspberry Pi. This OSAL generally requires threading support
+and real-time functionalities. For most UNIX systems, this is done by adding ``-lrt`` and
+``-lpthread`` to the linked libraries in the compilation process. The CMake build support provided
+will do this automatically for the ``fsfw`` target. It should be noted that most UNIX systems need
+to be configured specifically to allow the real-time functionalities required by the FSFW.
+
+Hosted OSAL
+-------------------
+
+This is the newest OSAL. Support for Semaphores has not been implemented yet and will propably be
+implemented as soon as C++20 with Semaphore support has matured. This OSAL can be used to run the
+FSFW on any host system, but currently has only been tested on Windows 10 and Ubuntu 20.04. Unlike
+the other OSALs, it uses dynamic memory allocation (e.g. for the message queue implementation).
+Cross-platform serial port (USB) support might be added soon.
+
+FreeRTOS OSAL
+------------------
+
+FreeRTOS is not included and the developer needs to take care of compiling the FreeRTOS sources and
+adding the  ``FreeRTOSConfig.h`` file location to the include path. This OSAL has only been tested
+extensively with the pre-emptive scheduler configuration so far but it should in principle also be
+possible to use a cooperative scheduler. It is recommended to use the `heap_4` allocation scheme.
+When using newlib (nano), it is also recommended to add ``#define configUSE_NEWLIB_REENTRANT`` to
+the FreeRTOS configuration file to ensure thread-safety.
+
+When using this OSAL, developers also need to provide an implementation for the
+``vRequestContextSwitchFromISR`` function. This has been done because the call to request a context
+switch from an ISR is generally located in the ``portmacro.h`` header and is different depending on
+the target architecture or device.
+
+RTEMS OSAL
+---------------
+
+The RTEMS OSAL was the first implemented OSAL which is also used on the active satellite Flying Laptop.
+
+TCP/IP socket abstraction
+------------------------------
+
+The Linux and Host OSAL provide abstraction layers for the socket API. Currently, only UDP sockets
+have been imlemented. This is very useful to test TMTC handling either on the host computer
+directly (targeting localhost with a TMTC application) or on embedded Linux devices, sending
+TMTC packets via Ethernet.
+
+Example Applications
+----------------------
+
+There are example applications available for each OSAL
+
+- `Hosted OSAL <https://egit.irs.uni-stuttgart.de/fsfw/fsfw-example-hosted>`_
+- `Linux OSAL for MCUs <https://egit.irs.uni-stuttgart.de/fsfw/fsfw-example-linux-mcu>`_
+- `FreeRTOS OSAL on the STM32H743ZIT <https://egit.irs.uni-stuttgart.de/fsfw/fsfw-example-stm32h7-freertos>`_
+- `RTEMS OSAL on the STM32H743ZIT <https://egit.irs.uni-stuttgart.de/fsfw/fsfw-example-stm32h7-rtems>`_

docs/pus.rst

@@ -0,0 +1,2 @@
+PUS Services
+==============

events/CMakeLists.txt

@@ -1,7 +0,0 @@
-target_sources(${LIB_FSFW_NAME} 
-	PRIVATE 
-		EventManager.cpp
-		EventMessage.cpp
-)
-
-add_subdirectory(eventmatching)

events/EventManager.cpp

@@ -1,177 +0,0 @@
-#include "EventManager.h"
-#include "EventMessage.h"
-
-#include <FSFWConfig.h>
-#include "../serviceinterface/ServiceInterfaceStream.h"
-#include "../ipc/QueueFactory.h"
-#include "../ipc/MutexFactory.h"
-
-MessageQueueId_t EventManagerIF::eventmanagerQueue = MessageQueueIF::NO_QUEUE;
-
-// If one checks registerListener calls, there are around 40 (to max 50)
-// objects registering for certain events.
-// Each listener requires 1 or 2 EventIdMatcher and 1 or 2 ReportRangeMatcher.
-// So a good guess is 75 to a max of 100 pools required for each, which fits well.
-const LocalPool::LocalPoolConfig EventManager::poolConfig = {
-        {fsfwconfig::FSFW_EVENTMGMR_MATCHTREE_NODES,
-        		sizeof(EventMatchTree::Node)},
-        {fsfwconfig::FSFW_EVENTMGMT_EVENTIDMATCHERS,
-        		sizeof(EventIdRangeMatcher)},
-        {fsfwconfig::FSFW_EVENTMGMR_RANGEMATCHERS,
-        		sizeof(ReporterRangeMatcher)}
-};
-
-EventManager::EventManager(object_id_t setObjectId) :
-		SystemObject(setObjectId),
-		factoryBackend(0, poolConfig, false, true) {
-	mutex = MutexFactory::instance()->createMutex();
-	eventReportQueue = QueueFactory::instance()->createMessageQueue(
-			MAX_EVENTS_PER_CYCLE, EventMessage::EVENT_MESSAGE_SIZE);
-}
-
-EventManager::~EventManager() {
-	QueueFactory::instance()->deleteMessageQueue(eventReportQueue);
-	MutexFactory::instance()->deleteMutex(mutex);
-}
-
-MessageQueueId_t EventManager::getEventReportQueue() {
-	return eventReportQueue->getId();
-}
-
-ReturnValue_t EventManager::performOperation(uint8_t opCode) {
-	ReturnValue_t result = HasReturnvaluesIF::RETURN_OK;
-	while (result == HasReturnvaluesIF::RETURN_OK) {
-		EventMessage message;
-		result = eventReportQueue->receiveMessage(&message);
-		if (result == HasReturnvaluesIF::RETURN_OK) {
-#if FSFW_OBJ_EVENT_TRANSLATION == 1
-			printEvent(&message);
-#endif
-			notifyListeners(&message);
-		}
-	}
-	return HasReturnvaluesIF::RETURN_OK;
-}
-
-void EventManager::notifyListeners(EventMessage* message) {
-	lockMutex();
-	for (auto iter = listenerList.begin(); iter != listenerList.end(); ++iter) {
-		if (iter->second.match(message)) {
-			MessageQueueSenderIF::sendMessage(iter->first, message,
-					message->getSender());
-		}
-	}
-	unlockMutex();
-}
-
-ReturnValue_t EventManager::registerListener(MessageQueueId_t listener,
-bool forwardAllButSelected) {
-	auto result = listenerList.insert(
-			std::pair<MessageQueueId_t, EventMatchTree>(listener,
-					EventMatchTree(&factoryBackend, forwardAllButSelected)));
-	if (!result.second) {
-		return HasReturnvaluesIF::RETURN_FAILED;
-	}
-	return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t EventManager::subscribeToEvent(MessageQueueId_t listener,
-		EventId_t event) {
-	return subscribeToEventRange(listener, event);
-}
-
-ReturnValue_t EventManager::subscribeToAllEventsFrom(MessageQueueId_t listener,
-		object_id_t object) {
-	return subscribeToEventRange(listener, 0, 0, true, object);
-}
-
-ReturnValue_t EventManager::subscribeToEventRange(MessageQueueId_t listener,
-		EventId_t idFrom, EventId_t idTo, bool idInverted,
-		object_id_t reporterFrom, object_id_t reporterTo,
-		bool reporterInverted) {
-	auto iter = listenerList.find(listener);
-	if (iter == listenerList.end()) {
-		return LISTENER_NOT_FOUND;
-	}
-	lockMutex();
-	ReturnValue_t result = iter->second.addMatch(idFrom, idTo, idInverted,
-			reporterFrom, reporterTo, reporterInverted);
-	unlockMutex();
-	return result;
-}
-
-ReturnValue_t EventManager::unsubscribeFromEventRange(MessageQueueId_t listener,
-		EventId_t idFrom, EventId_t idTo, bool idInverted,
-		object_id_t reporterFrom, object_id_t reporterTo,
-		bool reporterInverted) {
-	auto iter = listenerList.find(listener);
-	if (iter == listenerList.end()) {
-		return LISTENER_NOT_FOUND;
-	}
-	lockMutex();
-	ReturnValue_t result = iter->second.removeMatch(idFrom, idTo, idInverted,
-			reporterFrom, reporterTo, reporterInverted);
-	unlockMutex();
-	return result;
-}
-
-#if FSFW_OBJ_EVENT_TRANSLATION == 1
-
-void EventManager::printEvent(EventMessage* message) {
-	const char *string = 0;
-	switch (message->getSeverity()) {
-	case severity::INFO:
-#if DEBUG_INFO_EVENT == 1
-		string = translateObject(message->getReporter());
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-		sif::info << "EVENT: ";
-		if (string != 0) {
-			sif::info << string;
-		} else {
-			sif::info << "0x" << std::hex << message->getReporter() << std::dec;
-		}
-		sif::info << " reported " << translateEvents(message->getEvent()) << " ("
-				<< std::dec << message->getEventId() << std::hex << ") P1: 0x"
-				<< message->getParameter1() << " P2: 0x"
-				<< message->getParameter2() << std::dec << std::endl;
-#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
-#endif /* DEBUG_INFO_EVENT == 1 */
-		break;
-	default:
-		string = translateObject(message->getReporter());
-#if FSFW_CPP_OSTREAM_ENABLED == 1
-		sif::debug << "EventManager: ";
-		if (string != 0) {
-			sif::debug << string;
-		}
-		else {
-			sif::debug << "0x" << std::hex << message->getReporter() << std::dec;
-		}
-		sif::debug << " reported " << translateEvents(message->getEvent())
-				<< " (" << std::dec << message->getEventId() << ") "
-				<< std::endl;
-		sif::debug << std::hex << "P1 Hex: 0x" << message->getParameter1()
-				<< ", P1 Dec: " << std::dec << message->getParameter1()
-				<< std::endl;
-		sif::debug << std::hex << "P2 Hex: 0x" << message->getParameter2()
-				<< ", P2 Dec: " <<  std::dec << message->getParameter2()
-				<< std::endl;
-#endif
-		break;
-	}
-}
-#endif
-
-void EventManager::lockMutex() {
-	mutex->lockMutex(timeoutType, timeoutMs);
-}
-
-void EventManager::unlockMutex() {
-	mutex->unlockMutex();
-}
-
-void EventManager::setMutexTimeout(MutexIF::TimeoutType timeoutType,
-		uint32_t timeoutMs) {
-	this->timeoutType = timeoutType;
-	this->timeoutMs = timeoutMs;
-}

events/fwSubsystemIdRanges.h

@@ -1,30 +0,0 @@
-#ifndef FSFW_EVENTS_FWSUBSYSTEMIDRANGES_H_
-#define FSFW_EVENTS_FWSUBSYSTEMIDRANGES_H_
-
-namespace SUBSYSTEM_ID {
-enum {
-	MEMORY = 22,
-	OBSW = 26,
-	CDH = 28,
-	TCS_1 = 59,
-	PCDU_1 = 42,
-	PCDU_2 = 43,
-	HEATER = 50,
-	T_SENSORS = 52,
-	FDIR = 70,
-	FDIR_1 = 71,
-	FDIR_2 = 72,
-	HK = 73,
-	SYSTEM_MANAGER = 74,
-	SYSTEM_MANAGER_1 = 75,
-	SYSTEM_1 = 79,
-	PUS_SERVICE_1 = 80,
-	PUS_SERVICE_9 = 89,
-	PUS_SERVICE_17 = 97,
-	FW_SUBSYSTEM_ID_RANGE
-};
-}
-
-
-
-#endif /* FSFW_EVENTS_FWSUBSYSTEMIDRANGES_H_ */

fsfw.mk

@@ -1,75 +0,0 @@
-# This submake file needs to be included by the primary Makefile.
-# This file needs FRAMEWORK_PATH and OS_FSFW set correctly by another Makefile.
-# Valid API settings: rtems, linux, freeRTOS, host
-
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/action/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/container/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/contrib/sgp4/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/controller/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/coordinates/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/datalinklayer/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/datapool/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/datapoollocal/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/datapoollocal/internal/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/housekeeping/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/devicehandlers/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/events/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/events/eventmatching/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/fdir/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/globalfunctions/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/globalfunctions/matching/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/globalfunctions/math/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/health/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/internalError/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/ipc/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/memory/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/modes/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/monitoring/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/objectmanager/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/osal/*.cpp)
-
-# select the OS
-ifeq ($(OS_FSFW),rtems)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/osal/rtems/*.cpp)
-
-else ifeq ($(OS_FSFW),linux)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/osal/linux/*.cpp)
-
-else ifeq ($(OS_FSFW),freeRTOS)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/osal/FreeRTOS/*.cpp)
-
-else ifeq ($(OS_FSFW),host)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/osal/host/*.cpp)
-ifeq ($(OS),Windows_NT)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/osal/windows/*.cpp)
-else
-# For now, the linux UDP bridge sources needs to be included manually by upper makefile
-# for host OS because we can't be sure the OS is linux.
-# Following lines can be used to do this:
-# CXXSRC += $(FRAMEWORK_PATH)/osal/linux/TcUnixUdpPollingTask.cpp
-# CXXSRC += $(FRAMEWORK_PATH)/osal/linux/TmTcUnixUdpBridge.cpp
-endif
-
-else
-$(error invalid OS_FSFW specified, valid OS_FSFW are rtems, linux, freeRTOS, host)
-endif
-
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/parameters/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/power/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/returnvalues/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/rmap/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/serialize/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/serviceinterface/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/storagemanager/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/subsystem/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/subsystem/modes/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/tasks/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/tcdistribution/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/thermal/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/timemanager/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/tmstorage/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/tmtcpacket/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/tmtcpacket/packetmatcher/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/tmtcpacket/pus/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/tmtcservices/*.cpp)
-CXXSRC += $(wildcard $(FRAMEWORK_PATH)/pus/*.cpp)

globalfunctions/DleEncoder.cpp

@@ -1,124 +0,0 @@
-#include "../globalfunctions/DleEncoder.h"
-
-DleEncoder::DleEncoder() {}
-
-DleEncoder::~DleEncoder() {}
-
-ReturnValue_t DleEncoder::encode(const uint8_t* sourceStream,
-		size_t sourceLen, uint8_t* destStream, size_t maxDestLen,
-		size_t* encodedLen, bool addStxEtx) {
-	if (maxDestLen < 2) {
-		return STREAM_TOO_SHORT;
-	}
-	size_t encodedIndex = 0, sourceIndex = 0;
-	uint8_t nextByte;
-	if (addStxEtx) {
-		destStream[0] = STX_CHAR;
-		++encodedIndex;
-	}
-
-	while (encodedIndex < maxDestLen and sourceIndex < sourceLen)
-	{
-		nextByte = sourceStream[sourceIndex];
-		// STX, ETX and CR characters in the stream need to be escaped with DLE
-		if (nextByte == STX_CHAR or nextByte == ETX_CHAR or nextByte == CARRIAGE_RETURN) {
-			if (encodedIndex + 1 >= maxDestLen) {
-				return STREAM_TOO_SHORT;
-			}
-			else {
-				destStream[encodedIndex] = DLE_CHAR;
-				++encodedIndex;
-				/* Escaped byte will be actual byte + 0x40. This prevents
-				 * STX, ETX, and carriage return characters from appearing
-				 * in the encoded data stream at all, so when polling an
-				 * encoded stream, the transmission can be stopped at ETX.
-				 * 0x40 was chosen at random with special requirements:
-				 *  - Prevent going from one control char to another
-				 *  - Prevent overflow for common characters */
-				destStream[encodedIndex] = nextByte + 0x40;
-			}
-		}
-		// DLE characters are simply escaped with DLE.
-		else if (nextByte == DLE_CHAR) {
-			if (encodedIndex + 1 >= maxDestLen) {
-			    return STREAM_TOO_SHORT;
-			}
-			else {
-				destStream[encodedIndex] = DLE_CHAR;
-				++encodedIndex;
-				destStream[encodedIndex] = DLE_CHAR;
-			}
-		}
-		else {
-			destStream[encodedIndex] = nextByte;
-		}
-		++encodedIndex;
-		++sourceIndex;
-	}
-
-	if (sourceIndex == sourceLen and encodedIndex < maxDestLen) {
-		if (addStxEtx) {
-			destStream[encodedIndex] = ETX_CHAR;
-			++encodedIndex;
-		}
-		*encodedLen = encodedIndex;
-		return RETURN_OK;
-	}
-	else {
-		return STREAM_TOO_SHORT;
-	}
-}
-
-ReturnValue_t DleEncoder::decode(const uint8_t *sourceStream,
-		size_t sourceStreamLen, size_t *readLen, uint8_t *destStream,
-		size_t maxDestStreamlen, size_t *decodedLen) {
-	size_t encodedIndex = 0, decodedIndex = 0;
-	uint8_t nextByte;
-	if (*sourceStream != STX_CHAR) {
-		return DECODING_ERROR;
-	}
-	++encodedIndex;
-
-	while ((encodedIndex < sourceStreamLen) && (decodedIndex < maxDestStreamlen)
-			&& (sourceStream[encodedIndex] != ETX_CHAR)
-			&& (sourceStream[encodedIndex] != STX_CHAR)) {
-		if (sourceStream[encodedIndex] == DLE_CHAR) {
-			nextByte = sourceStream[encodedIndex + 1];
-			// The next byte is a DLE character that was escaped by another
-			// DLE character, so we can write it to the destination stream.
-			if (nextByte == DLE_CHAR) {
-				destStream[decodedIndex] = nextByte;
-			}
-			else {
-			    /* The next byte is a STX, DTX or 0x0D character which
-			     * was escaped by a DLE character. The actual byte was
-				 * also encoded by adding + 0x40 to prevent having control chars,
-				 * in the stream at all, so we convert it back. */
-				if (nextByte == 0x42 or nextByte == 0x43 or nextByte == 0x4D) {
-					destStream[decodedIndex] = nextByte - 0x40;
-				}
-				else {
-				    return DECODING_ERROR;
-				}
-			}
-			++encodedIndex;
-		}
-		else {
-			destStream[decodedIndex] = sourceStream[encodedIndex];
-		}
-
-		++encodedIndex;
-		++decodedIndex;
-	}
-
-	if (sourceStream[encodedIndex] != ETX_CHAR) {
-		*readLen = ++encodedIndex;
-		return DECODING_ERROR;
-	}
-	else {
-		*readLen = ++encodedIndex;
-		*decodedLen = decodedIndex;
-		return RETURN_OK;
-	}
-}
-

globalfunctions/DleEncoder.h

@@ -1,79 +0,0 @@
-#ifndef FRAMEWORK_GLOBALFUNCTIONS_DLEENCODER_H_
-#define FRAMEWORK_GLOBALFUNCTIONS_DLEENCODER_H_
-
-#include "../returnvalues/HasReturnvaluesIF.h"
-#include <cstddef>
-
-/**
- * @brief   This DLE Encoder (Data Link Encoder) can be used to encode and
- *          decode arbitrary data with ASCII control characters
- * @details
- * List of control codes:
- * https://en.wikipedia.org/wiki/C0_and_C1_control_codes
- *
- * This encoder can be used to achieve a basic transport layer when using
- * char based transmission systems.
- * The passed source strean is converted into a encoded stream by adding
- * a STX marker at the start of the stream and an ETX marker at the end of
- * the stream. Any STX, ETX, DLE and CR occurrences in the source stream are
- * escaped by a DLE character. The encoder also replaces escaped control chars
- * by another char, so STX, ETX and CR should not appear anywhere in the actual
- * encoded data stream.
- *
- * When using a strictly char based reception of packets encoded with DLE,
- * STX can be used to notify a reader that actual data will start to arrive
- * while ETX can be used to notify the reader that the data has ended.
- */
-class DleEncoder: public HasReturnvaluesIF {
-private:
-	DleEncoder();
-	virtual ~DleEncoder();
-
-public:
-	static constexpr uint8_t INTERFACE_ID = CLASS_ID::DLE_ENCODER;
-	static constexpr ReturnValue_t STREAM_TOO_SHORT = MAKE_RETURN_CODE(0x01);
-	static constexpr ReturnValue_t DECODING_ERROR = MAKE_RETURN_CODE(0x02);
-
-	//! Start Of Text character. First character is encoded stream
-	static constexpr uint8_t STX_CHAR = 0x02;
-	//! End Of Text character. Last character in encoded stream
-	static constexpr uint8_t ETX_CHAR = 0x03;
-	//! Data Link Escape character. Used to escape STX, ETX and DLE occurrences
-	//! in the source stream.
-	static constexpr uint8_t DLE_CHAR = 0x10;
-	static constexpr uint8_t CARRIAGE_RETURN = 0x0D;
-
-    /**
-     * Encodes the give data stream by preceding it with the STX marker
-     * and ending it with an ETX marker. STX, ETX and DLE characters inside
-     * the stream are escaped by DLE characters and also replaced by adding
-     * 0x40 (which is reverted in the decoding process).
-     * @param sourceStream
-     * @param sourceLen
-     * @param destStream
-     * @param maxDestLen
-     * @param encodedLen
-     * @param addStxEtx
-     * Adding STX and ETX can be omitted, if they are added manually.
-     * @return
-     */
-    static ReturnValue_t encode(const uint8_t *sourceStream, size_t sourceLen,
-            uint8_t *destStream, size_t maxDestLen, size_t *encodedLen,
-            bool addStxEtx = true);
-
-    /**
-     * Converts an encoded stream back.
-     * @param sourceStream
-     * @param sourceStreamLen
-     * @param readLen
-     * @param destStream
-     * @param maxDestStreamlen
-     * @param decodedLen
-     * @return
-     */
-	static ReturnValue_t decode(const uint8_t *sourceStream,
-			size_t sourceStreamLen, size_t *readLen, uint8_t *destStream,
-			size_t maxDestStreamlen, size_t *decodedLen);
-};
-
-#endif /* FRAMEWORK_GLOBALFUNCTIONS_DLEENCODER_H_ */

globalfunctions/PeriodicOperationDivider.cpp

@@ -1,44 +0,0 @@
-#include "PeriodicOperationDivider.h"
-
-
-PeriodicOperationDivider::PeriodicOperationDivider(uint32_t divider,
-		bool resetAutomatically): resetAutomatically(resetAutomatically),
-		counter(divider), divider(divider) {
-}
-
-bool PeriodicOperationDivider::checkAndIncrement() {
-	bool opNecessary = check();
-	if(opNecessary) {
-		if(resetAutomatically) {
-			counter = 0;
-		}
-		return opNecessary;
-	}
-	counter ++;
-	return opNecessary;
-}
-
-bool PeriodicOperationDivider::check() {
-	if(counter >= divider) {
-		return true;
-	}
-	return false;
-}
-
-
-
-void PeriodicOperationDivider::resetCounter() {
-	counter = 0;
-}
-
-void PeriodicOperationDivider::setDivider(uint32_t newDivider) {
-	divider = newDivider;
-}
-
-uint32_t PeriodicOperationDivider::getCounter() const {
-	return counter;
-}
-
-uint32_t PeriodicOperationDivider::getDivider() const {
-	return divider;
-}

globalfunctions/PeriodicOperationDivider.h

@@ -1,65 +0,0 @@
-#ifndef FSFW_GLOBALFUNCTIONS_PERIODICOPERATIONDIVIDER_H_
-#define FSFW_GLOBALFUNCTIONS_PERIODICOPERATIONDIVIDER_H_
-
-#include <cstdint>
-
-/**
- * @brief	Lightweight helper class to facilitate periodic operation with
- * 			decreased frequencies.
- * @details
- * This class is useful to perform operations which have to be performed
- * with a reduced frequency, like debugging printouts in high periodic tasks
- * or low priority operations.
- */
-class PeriodicOperationDivider {
-public:
-	/**
-	 * Initialize with the desired divider and specify whether the internal
-	 * counter will be reset automatically.
-	 * @param divider
-	 * @param resetAutomatically
-	 */
-	PeriodicOperationDivider(uint32_t divider, bool resetAutomatically = true);
-
-
-	/**
-	 * Check whether operation is necessary.
-	 * If an operation is necessary and the class has been
-	 * configured to be reset automatically, the counter will be reset.
-	 *
-	 * @return
-	 * -@c true if the counter is larger or equal to the divider
-	 * -@c false otherwise
-	 */
-	bool checkAndIncrement();
-
-	/**
-	 * Checks whether an operation is necessary.
-	 * This function will not increment the counter!
-	 * @return
-	 * -@c true if the counter is larger or equal to the divider
-	 * -@c false otherwise
-	 */
-	bool check();
-
-	/**
-	 * Can be used to reset the counter to 0 manually.
-	 */
-	void resetCounter();
-	uint32_t getCounter() const;
-
-	/**
-	 * Can be used to set a new divider value.
-	 * @param newDivider
-	 */
-	void setDivider(uint32_t newDivider);
-	uint32_t getDivider() const;
-private:
-	bool resetAutomatically = true;
-	uint32_t counter = 0;
-	uint32_t divider = 0;
-};
-
-
-
-#endif /* FSFW_GLOBALFUNCTIONS_PERIODICOPERATIONDIVIDER_H_ */

globalfunctions/bitutility.h

@@ -1,18 +0,0 @@
-#ifndef FSFW_GLOBALFUNCTIONS_BITUTIL_H_
-#define FSFW_GLOBALFUNCTIONS_BITUTIL_H_
-
-#include <cstdint>
-
-namespace bitutil {
-
-/* Helper functions for manipulating the individual bits of a byte.
-Position refers to n-th bit of a byte, going from 0 (most significant bit) to
-7 (least significant bit) */
-void bitSet(uint8_t* byte, uint8_t position);
-void bitToggle(uint8_t* byte, uint8_t position);
-void bitClear(uint8_t* byte, uint8_t position);
-bool bitGet(const uint8_t* byte, uint8_t position);
-
-}
-
-#endif /* FSFW_GLOBALFUNCTIONS_BITUTIL_H_ */

hal/CMakeLists.txt

@@ -0,0 +1,41 @@
+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

@@ -0,0 +1,9 @@
+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/CMakeLists.txt

@@ -0,0 +1,10 @@
+add_subdirectory(devicehandlers)
+add_subdirectory(common)
+
+if(FSFW_HAL_ADD_LINUX)
+    add_subdirectory(linux)
+endif()
+
+if(FSFW_HAL_ADD_STM32H7)
+    add_subdirectory(stm32h7)
+endif()

hal/src/fsfw_hal/common/CMakeLists.txt

@@ -0,0 +1 @@
+add_subdirectory(gpio)

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

@@ -0,0 +1,3 @@
+target_sources(${LIB_FSFW_NAME} PRIVATE
+    GpioCookie.cpp
+)

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

@@ -0,0 +1,50 @@
+#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/GpioCookie.h

@@ -0,0 +1,41 @@
+#ifndef COMMON_GPIO_GPIOCOOKIE_H_
+#define COMMON_GPIO_GPIOCOOKIE_H_
+
+#include "GpioIF.h"
+#include "gpioDefinitions.h"
+
+#include <fsfw/devicehandlers/CookieIF.h>
+#include <fsfw/returnvalues/HasReturnvaluesIF.h>
+
+/**
+ * @brief   Cookie for the GpioIF. Allows the GpioIF to determine which
+ * 			GPIOs to initialize and whether they should be configured as in- or
+ * 			output.
+ * @details	One GpioCookie can hold multiple GPIO configurations. To add a new
+ * 			GPIO configuration to a GpioCookie use the GpioCookie::addGpio
+ * 			function.
+ *
+ * @author 	J. Meier
+ */
+class GpioCookie: public CookieIF {
+public:
+
+    GpioCookie();
+
+    virtual ~GpioCookie();
+
+    ReturnValue_t addGpio(gpioId_t gpioId, GpioBase* gpioConfig);
+
+    /**
+     * @brief	Get map with registered GPIOs.
+     */
+    GpioMap getGpioMap() const;
+
+private:
+    /**
+     * Returns a copy of the internal GPIO map.
+     */
+    GpioMap gpioMap;
+};
+
+#endif /* COMMON_GPIO_GPIOCOOKIE_H_ */

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

@@ -0,0 +1,54 @@
+#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

@@ -0,0 +1,170 @@
+#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/common/spi/spiCommon.h

@@ -0,0 +1,17 @@
+#ifndef FSFW_HAL_COMMON_SPI_SPICOMMON_H_
+#define FSFW_HAL_COMMON_SPI_SPICOMMON_H_
+
+#include <cstdint>
+
+namespace spi {
+
+enum SpiModes: uint8_t {
+    MODE_0,
+    MODE_1,
+    MODE_2,
+    MODE_3
+};
+
+}
+
+#endif /* FSFW_HAL_COMMON_SPI_SPICOMMON_H_ */

hal/src/fsfw_hal/devicehandlers/CMakeLists.txt

@@ -0,0 +1,5 @@
+target_sources(${LIB_FSFW_NAME} PRIVATE
+    GyroL3GD20Handler.cpp
+    MgmRM3100Handler.cpp
+    MgmLIS3MDLHandler.cpp
+)

hal/src/fsfw_hal/devicehandlers/GyroL3GD20Handler.cpp

@@ -0,0 +1,287 @@
+#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

@@ -0,0 +1,99 @@
+#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

@@ -0,0 +1,520 @@
+#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

@@ -0,0 +1,186 @@
+#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

@@ -0,0 +1,376 @@
+#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

@@ -0,0 +1,110 @@
+#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/devicehandlers/devicedefinitions/GyroL3GD20Definitions.h

@@ -0,0 +1,143 @@
+#ifndef MISSION_DEVICES_DEVICEDEFINITIONS_GYROL3GD20DEFINITIONS_H_
+#define MISSION_DEVICES_DEVICEDEFINITIONS_GYROL3GD20DEFINITIONS_H_
+
+#include <fsfw/datapoollocal/StaticLocalDataSet.h>
+#include <fsfw/devicehandlers/DeviceHandlerIF.h>
+#include <cstdint>
+
+namespace L3GD20H {
+
+/* Actual size is 15 but we round up a bit */
+static constexpr size_t MAX_BUFFER_SIZE = 16;
+
+static constexpr uint8_t READ_MASK = 0b10000000;
+
+static constexpr uint8_t AUTO_INCREMENT_MASK = 0b01000000;
+
+static constexpr uint8_t WHO_AM_I_REG = 0b00001111;
+static constexpr uint8_t WHO_AM_I_VAL = 0b11010111;
+
+/*------------------------------------------------------------------------*/
+/* Control registers */
+/*------------------------------------------------------------------------*/
+static constexpr uint8_t CTRL_REG_1 = 0b00100000;
+static constexpr uint8_t CTRL_REG_2 = 0b00100001;
+static constexpr uint8_t CTRL_REG_3 = 0b00100010;
+static constexpr uint8_t CTRL_REG_4 = 0b00100011;
+static constexpr uint8_t CTRL_REG_5 = 0b00100100;
+
+/* Register 1 */
+static constexpr uint8_t SET_DR_1 = 1 << 7;
+static constexpr uint8_t SET_DR_0 = 1 << 6;
+static constexpr uint8_t SET_BW_1 = 1 << 5;
+static constexpr uint8_t SET_BW_0 = 1 << 4;
+static constexpr uint8_t SET_POWER_NORMAL_MODE = 1 << 3;
+static constexpr uint8_t SET_Z_ENABLE = 1 << 2;
+static constexpr uint8_t SET_X_ENABLE = 1 << 1;
+static constexpr uint8_t SET_Y_ENABLE = 1;
+
+static constexpr uint8_t CTRL_REG_1_VAL = SET_POWER_NORMAL_MODE | SET_Z_ENABLE |
+		SET_Y_ENABLE | SET_X_ENABLE;
+
+/* Register 2 */
+static constexpr uint8_t EXTERNAL_EDGE_ENB = 1 << 7;
+static constexpr uint8_t LEVEL_SENSITIVE_TRIGGER = 1 << 6;
+static constexpr uint8_t SET_HPM_1 = 1 << 5;
+static constexpr uint8_t SET_HPM_0 = 1 << 4;
+static constexpr uint8_t SET_HPCF_3 = 1 << 3;
+static constexpr uint8_t SET_HPCF_2 = 1 << 2;
+static constexpr uint8_t SET_HPCF_1 = 1 << 1;
+static constexpr uint8_t SET_HPCF_0 = 1;
+
+static constexpr uint8_t CTRL_REG_2_VAL = 0b00000000;
+
+/* Register 3 */
+static constexpr uint8_t CTRL_REG_3_VAL = 0b00000000;
+
+/* Register 4 */
+static constexpr uint8_t SET_BNU = 1 << 7;
+static constexpr uint8_t SET_BLE = 1 << 6;
+static constexpr uint8_t SET_FS_1 = 1 << 5;
+static constexpr uint8_t SET_FS_0 = 1 << 4;
+static constexpr uint8_t SET_IMP_ENB = 1 << 3;
+static constexpr uint8_t SET_SELF_TEST_ENB_1 = 1 << 2;
+static constexpr uint8_t SET_SELF_TEST_ENB_0 = 1 << 1;
+static constexpr uint8_t SET_SPI_IF_SELECT = 1;
+
+/* Enable big endian data format */
+static constexpr uint8_t CTRL_REG_4_VAL = SET_BLE;
+
+/* Register 5 */
+static constexpr uint8_t SET_REBOOT_MEM = 1 << 7;
+static constexpr uint8_t SET_FIFO_ENB = 1 << 6;
+
+static constexpr uint8_t CTRL_REG_5_VAL = 0b00000000;
+
+/* Possible range values in degrees per second (DPS). */
+static constexpr uint16_t RANGE_DPS_00 = 245;
+static constexpr float SENSITIVITY_00 = 8.75 * 0.001;
+static constexpr uint16_t RANGE_DPS_01 = 500;
+static constexpr float SENSITIVITY_01 = 17.5 * 0.001;
+static constexpr uint16_t RANGE_DPS_11 = 2000;
+static constexpr float SENSITIVITY_11 = 70.0 * 0.001;
+
+static constexpr uint8_t READ_START = CTRL_REG_1;
+static constexpr size_t READ_LEN = 14;
+
+/* Indexing */
+static constexpr uint8_t REFERENCE_IDX = 6;
+static constexpr uint8_t TEMPERATURE_IDX = 7;
+static constexpr uint8_t STATUS_IDX = 8;
+static constexpr uint8_t OUT_X_H = 9;
+static constexpr uint8_t OUT_X_L = 10;
+static constexpr uint8_t OUT_Y_H = 11;
+static constexpr uint8_t OUT_Y_L = 12;
+static constexpr uint8_t OUT_Z_H = 13;
+static constexpr uint8_t OUT_Z_L = 14;
+
+/*------------------------------------------------------------------------*/
+/* Device Handler specific */
+/*------------------------------------------------------------------------*/
+static constexpr DeviceCommandId_t READ_REGS = 0;
+static constexpr DeviceCommandId_t CONFIGURE_CTRL_REGS = 1;
+static constexpr DeviceCommandId_t READ_CTRL_REGS = 2;
+
+static constexpr uint32_t GYRO_DATASET_ID = READ_REGS;
+
+enum GyroPoolIds: lp_id_t {
+    ANG_VELOC_X,
+	ANG_VELOC_Y,
+	ANG_VELOC_Z,
+	TEMPERATURE
+};
+
+}
+
+class GyroPrimaryDataset: public StaticLocalDataSet<5> {
+public:
+
+    /** Constructor  for data users like controllers */
+    GyroPrimaryDataset(object_id_t mgmId):
+        StaticLocalDataSet(sid_t(mgmId, L3GD20H::GYRO_DATASET_ID)) {
+        setAllVariablesReadOnly();
+    }
+
+    /* Angular velocities in degrees per second (DPS) */
+    lp_var_t<float> angVelocX = lp_var_t<float>(sid.objectId,
+            L3GD20H::ANG_VELOC_X, this);
+    lp_var_t<float> angVelocY = lp_var_t<float>(sid.objectId,
+            L3GD20H::ANG_VELOC_Y, this);
+    lp_var_t<float> angVelocZ = lp_var_t<float>(sid.objectId,
+            L3GD20H::ANG_VELOC_Z, this);
+    lp_var_t<float> temperature = lp_var_t<float>(sid.objectId,
+            L3GD20H::TEMPERATURE, this);
+private:
+
+    friend class GyroHandlerL3GD20H;
+    /** Constructor  for the data creator */
+    GyroPrimaryDataset(HasLocalDataPoolIF* hkOwner):
+            StaticLocalDataSet(hkOwner, L3GD20H::GYRO_DATASET_ID) {}
+};
+
+
+#endif /* MISSION_DEVICES_DEVICEDEFINITIONS_GYROL3GD20DEFINITIONS_H_ */

hal/src/fsfw_hal/devicehandlers/devicedefinitions/MgmLIS3HandlerDefs.h

@@ -0,0 +1,178 @@
+#ifndef MISSION_DEVICES_DEVICEDEFINITIONS_MGMLIS3HANDLERDEFS_H_
+#define MISSION_DEVICES_DEVICEDEFINITIONS_MGMLIS3HANDLERDEFS_H_
+
+#include <fsfw/datapoollocal/StaticLocalDataSet.h>
+#include <fsfw/datapoollocal/LocalPoolVariable.h>
+#include <fsfw/devicehandlers/DeviceHandlerIF.h>
+#include <cstdint>
+
+namespace MGMLIS3MDL {
+
+enum Set {
+    ON, OFF
+};
+enum OpMode {
+    LOW, MEDIUM, HIGH, ULTRA
+};
+
+enum Sensitivies: uint8_t {
+    GAUSS_4 = 4,
+    GAUSS_8 = 8,
+    GAUSS_12 = 12,
+    GAUSS_16 = 16
+};
+
+/* Actually 15, we just round up a bit */
+static constexpr size_t MAX_BUFFER_SIZE = 16;
+
+/* Field data register scaling */
+static constexpr uint8_t GAUSS_TO_MICROTESLA_FACTOR = 100;
+static constexpr float FIELD_LSB_PER_GAUSS_4_SENS = 1.0 / 6842.0;
+static constexpr float FIELD_LSB_PER_GAUSS_8_SENS = 1.0 / 3421.0;
+static constexpr float FIELD_LSB_PER_GAUSS_12_SENS = 1.0 / 2281.0;
+static constexpr float FIELD_LSB_PER_GAUSS_16_SENS = 1.0 / 1711.0;
+
+static const DeviceCommandId_t READ_CONFIG_AND_DATA = 0x00;
+static const DeviceCommandId_t SETUP_MGM = 0x01;
+static const DeviceCommandId_t READ_TEMPERATURE = 0x02;
+static const DeviceCommandId_t IDENTIFY_DEVICE = 0x03;
+static const DeviceCommandId_t TEMP_SENSOR_ENABLE = 0x04;
+static const DeviceCommandId_t ACCURACY_OP_MODE_SET = 0x05;
+
+/* Number of all control registers */
+static const uint8_t NR_OF_CTRL_REGISTERS = 5;
+/* Number of registers in the MGM */
+static const uint8_t NR_OF_REGISTERS = 19;
+/* Total number of adresses for all registers */
+static const uint8_t TOTAL_NR_OF_ADRESSES = 52;
+static const uint8_t NR_OF_DATA_AND_CFG_REGISTERS = 14;
+static const uint8_t TEMPERATURE_REPLY_LEN = 3;
+static const uint8_t SETUP_REPLY_LEN = 6;
+
+/*------------------------------------------------------------------------*/
+/* Register adresses */
+/*------------------------------------------------------------------------*/
+/* Register adress returns identifier of device with default 0b00111101 */
+static const uint8_t IDENTIFY_DEVICE_REG_ADDR = 0b00001111;
+static const uint8_t DEVICE_ID = 0b00111101;            // Identifier for Device
+
+/* Register adress to access register 1 */
+static const uint8_t CTRL_REG1 = 0b00100000;
+/* Register adress to access register 2 */
+static const uint8_t CTRL_REG2 = 0b00100001;
+/* Register adress to access register 3 */
+static const uint8_t CTRL_REG3 = 0b00100010;
+/* Register adress to access register 4 */
+static const uint8_t CTRL_REG4 = 0b00100011;
+/* Register adress to access register 5 */
+static const uint8_t CTRL_REG5 = 0b00100100;
+
+/* Register adress to access status register */
+static const uint8_t STATUS_REG_IDX = 8;
+static const uint8_t STATUS_REG = 0b00100111;
+
+/* Register adress to access low byte of x-axis */
+static const uint8_t X_LOWBYTE_IDX = 9;
+static const uint8_t X_LOWBYTE = 0b00101000;
+/* Register adress to access high byte of x-axis */
+static const uint8_t X_HIGHBYTE_IDX = 10;
+static const uint8_t X_HIGHBYTE = 0b00101001;
+/* Register adress to access low byte of y-axis */
+static const uint8_t Y_LOWBYTE_IDX = 11;
+static const uint8_t Y_LOWBYTE = 0b00101010;
+/* Register adress to access high byte of y-axis */
+static const uint8_t Y_HIGHBYTE_IDX = 12;
+static const uint8_t Y_HIGHBYTE = 0b00101011;
+/* Register adress to access low byte of z-axis */
+static const uint8_t Z_LOWBYTE_IDX = 13;
+static const uint8_t Z_LOWBYTE = 0b00101100;
+/* Register adress to access high byte of z-axis */
+static const uint8_t Z_HIGHBYTE_IDX = 14;
+static const uint8_t Z_HIGHBYTE = 0b00101101;
+
+/* Register adress to access low byte of temperature sensor */
+static const uint8_t TEMP_LOWBYTE = 0b00101110;
+/* Register adress to access high byte of temperature sensor */
+static const uint8_t TEMP_HIGHBYTE = 0b00101111;
+
+/*------------------------------------------------------------------------*/
+/* Initialize Setup Register set bits                                     */
+/*------------------------------------------------------------------------*/
+/* General transfer bits */
+// Read=1 / Write=0 Bit
+static const uint8_t RW_BIT = 7;
+// Continous Read/Write Bit, increment adress
+static const uint8_t MS_BIT = 6;
+
+/* CTRL_REG1 bits */
+static const uint8_t ST = 0;        // Self test enable bit, enabled = 1
+// Enable rates higher than 80 Hz enabled = 1
+static const uint8_t FAST_ODR = 1;
+static const uint8_t DO0 = 2;       // Output data rate bit 2
+static const uint8_t DO1 = 3;       // Output data rate bit 3
+static const uint8_t DO2 = 4;       // Output data rate bit 4
+static const uint8_t OM0 = 5;       // XY operating mode bit 5
+static const uint8_t OM1 = 6;       // XY operating mode bit 6
+static const uint8_t TEMP_EN = 7;   // Temperature sensor enable enabled = 1
+static const uint8_t CTRL_REG1_DEFAULT = (1 << TEMP_EN) | (1 << OM1) |
+        (1 << DO0) | (1 << DO1) | (1 << DO2);
+
+/* CTRL_REG2 bits */
+//reset configuration registers and user registers
+static const uint8_t SOFT_RST = 2;
+static const uint8_t REBOOT = 3;    //reboot memory content
+static const uint8_t FSO = 5;       //full-scale selection bit 5
+static const uint8_t FS1 = 6;       //full-scale selection bit 6
+static const uint8_t CTRL_REG2_DEFAULT = 0;
+
+/* CTRL_REG3 bits */
+static const uint8_t MD0 = 0;       //Operating mode bit 0
+static const uint8_t MD1 = 1;       //Operating mode bit 1
+//SPI serial interface mode selection enabled = 3-wire-mode
+static const uint8_t SIM = 2;
+static const uint8_t LP = 5;        //low-power mode
+static const uint8_t CTRL_REG3_DEFAULT = 0;
+
+/* CTRL_REG4 bits */
+//big/little endian data selection enabled = MSb at lower adress
+static const uint8_t BLE = 1;
+static const uint8_t OMZ0 = 2;      //Z operating mode bit 2
+static const uint8_t OMZ1 = 3;      //Z operating mode bit 3
+static const uint8_t CTRL_REG4_DEFAULT = (1 << OMZ1);
+
+/* CTRL_REG5 bits */
+static const uint8_t BDU = 6;       //Block data update
+static const uint8_t FAST_READ = 7; //Fast read enabled = 1
+static const uint8_t CTRL_REG5_DEFAULT = 0;
+
+static const uint32_t MGM_DATA_SET_ID = READ_CONFIG_AND_DATA;
+
+enum MgmPoolIds: lp_id_t {
+    FIELD_STRENGTH_X,
+    FIELD_STRENGTH_Y,
+    FIELD_STRENGTH_Z,
+    TEMPERATURE_CELCIUS
+};
+
+class MgmPrimaryDataset: public StaticLocalDataSet<4> {
+public:
+    MgmPrimaryDataset(HasLocalDataPoolIF* hkOwner):
+        StaticLocalDataSet(hkOwner, MGM_DATA_SET_ID) {}
+
+    MgmPrimaryDataset(object_id_t mgmId):
+        StaticLocalDataSet(sid_t(mgmId, MGM_DATA_SET_ID)) {}
+
+    lp_var_t<float> fieldStrengthX = lp_var_t<float>(sid.objectId,
+            FIELD_STRENGTH_X, this);
+    lp_var_t<float> fieldStrengthY = lp_var_t<float>(sid.objectId,
+            FIELD_STRENGTH_Y, this);
+    lp_var_t<float> fieldStrengthZ = lp_var_t<float>(sid.objectId,
+            FIELD_STRENGTH_Z, this);
+    lp_var_t<float> temperature = lp_var_t<float>(sid.objectId,
+            TEMPERATURE_CELCIUS, this);
+};
+
+}
+
+
+#endif /* MISSION_DEVICES_DEVICEDEFINITIONS_MGMLIS3HANDLERDEFS_H_ */

hal/src/fsfw_hal/devicehandlers/devicedefinitions/MgmRM3100HandlerDefs.h

@@ -0,0 +1,132 @@
+#ifndef MISSION_DEVICES_DEVICEDEFINITIONS_MGMHANDLERRM3100DEFINITIONS_H_
+#define MISSION_DEVICES_DEVICEDEFINITIONS_MGMHANDLERRM3100DEFINITIONS_H_
+
+#include <fsfw/datapoollocal/StaticLocalDataSet.h>
+#include <fsfw/datapoollocal/LocalPoolVariable.h>
+#include <fsfw/devicehandlers/DeviceHandlerIF.h>
+#include <fsfw/serialize/SerialLinkedListAdapter.h>
+#include <cstdint>
+
+namespace RM3100 {
+
+/* Actually 10, we round up a little bit */
+static constexpr size_t MAX_BUFFER_SIZE = 12;
+
+static constexpr uint8_t READ_MASK = 0x80;
+
+/*----------------------------------------------------------------------------*/
+/* CMM Register */
+/*----------------------------------------------------------------------------*/
+static constexpr uint8_t SET_CMM_CMZ = 1 << 6;
+static constexpr uint8_t SET_CMM_CMY = 1 << 5;
+static constexpr uint8_t SET_CMM_CMX = 1 << 4;
+static constexpr uint8_t SET_CMM_DRDM = 1 << 2;
+static constexpr uint8_t SET_CMM_START = 1;
+static constexpr uint8_t CMM_REGISTER = 0x01;
+
+static constexpr uint8_t CMM_VALUE = SET_CMM_CMZ | SET_CMM_CMY | SET_CMM_CMX |
+		SET_CMM_DRDM | SET_CMM_START;
+
+/*----------------------------------------------------------------------------*/
+/* Cycle count register */
+/*----------------------------------------------------------------------------*/
+// Default value (200)
+static constexpr uint8_t CYCLE_COUNT_VALUE = 0xC8;
+
+static constexpr float DEFAULT_GAIN = static_cast<float>(CYCLE_COUNT_VALUE) /
+		100 * 38;
+static constexpr uint8_t CYCLE_COUNT_START_REGISTER = 0x04;
+
+/*----------------------------------------------------------------------------*/
+/* TMRC register */
+/*----------------------------------------------------------------------------*/
+static constexpr uint8_t TMRC_150HZ_VALUE = 0x94;
+static constexpr uint8_t TMRC_75HZ_VALUE = 0x95;
+static constexpr uint8_t TMRC_DEFAULT_37HZ_VALUE = 0x96;
+
+static constexpr uint8_t TMRC_REGISTER = 0x0B;
+static constexpr uint8_t TMRC_DEFAULT_VALUE = TMRC_DEFAULT_37HZ_VALUE;
+
+static constexpr uint8_t MEASUREMENT_REG_START = 0x24;
+static constexpr uint8_t BIST_REGISTER = 0x33;
+static constexpr uint8_t DATA_READY_VAL = 0b10000000;
+static constexpr uint8_t STATUS_REGISTER = 0x34;
+static constexpr uint8_t REVID_REGISTER = 0x36;
+
+// Range in Microtesla. 1 T equals 10000 Gauss (for comparison with LIS3 MGM)
+static constexpr uint16_t RANGE = 800;
+
+static constexpr DeviceCommandId_t READ_DATA = 0;
+
+static constexpr DeviceCommandId_t CONFIGURE_CMM = 1;
+static constexpr DeviceCommandId_t READ_CMM = 2;
+
+static constexpr DeviceCommandId_t CONFIGURE_TMRC = 3;
+static constexpr DeviceCommandId_t READ_TMRC = 4;
+
+static constexpr DeviceCommandId_t CONFIGURE_CYCLE_COUNT = 5;
+static constexpr DeviceCommandId_t READ_CYCLE_COUNT = 6;
+
+class CycleCountCommand: public SerialLinkedListAdapter<SerializeIF> {
+public:
+	CycleCountCommand(bool oneCycleCount = true): oneCycleCount(oneCycleCount) {
+		setLinks(oneCycleCount);
+	}
+
+	ReturnValue_t deSerialize(const uint8_t** buffer, size_t* size,
+			Endianness streamEndianness) override {
+		ReturnValue_t result = SerialLinkedListAdapter::deSerialize(buffer,
+				size, streamEndianness);
+		if(oneCycleCount) {
+			cycleCountY = cycleCountX;
+			cycleCountZ = cycleCountX;
+		}
+		return result;
+	}
+
+	SerializeElement<uint16_t> cycleCountX;
+	SerializeElement<uint16_t> cycleCountY;
+	SerializeElement<uint16_t> cycleCountZ;
+
+private:
+	void setLinks(bool oneCycleCount) {
+		setStart(&cycleCountX);
+		if(not oneCycleCount) {
+			cycleCountX.setNext(&cycleCountY);
+			cycleCountY.setNext(&cycleCountZ);
+		}
+	}
+
+	bool oneCycleCount;
+};
+
+static constexpr uint32_t MGM_DATASET_ID = READ_DATA;
+
+enum MgmPoolIds: lp_id_t {
+    FIELD_STRENGTH_X,
+    FIELD_STRENGTH_Y,
+    FIELD_STRENGTH_Z,
+};
+
+class Rm3100PrimaryDataset: public StaticLocalDataSet<3> {
+public:
+	Rm3100PrimaryDataset(HasLocalDataPoolIF* hkOwner):
+        StaticLocalDataSet(hkOwner, MGM_DATASET_ID) {}
+
+	Rm3100PrimaryDataset(object_id_t mgmId):
+        StaticLocalDataSet(sid_t(mgmId, MGM_DATASET_ID)) {}
+
+	// Field strengths in micro Tesla.
+    lp_var_t<float> fieldStrengthX = lp_var_t<float>(sid.objectId,
+            FIELD_STRENGTH_X, this);
+    lp_var_t<float> fieldStrengthY = lp_var_t<float>(sid.objectId,
+            FIELD_STRENGTH_Y, this);
+    lp_var_t<float> fieldStrengthZ = lp_var_t<float>(sid.objectId,
+            FIELD_STRENGTH_Z, this);
+};
+
+}
+
+
+
+#endif /* MISSION_DEVICES_DEVICEDEFINITIONS_MGMHANDLERRM3100DEFINITIONS_H_ */

hal/src/fsfw_hal/host/CMakeLists.txt

@@ -0,0 +1 @@
+

hal/src/fsfw_hal/linux/CMakeLists.txt

@@ -0,0 +1,13 @@
+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

@@ -0,0 +1,37 @@
+#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

@@ -0,0 +1,33 @@
+#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

@@ -0,0 +1,12 @@
+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

@@ -0,0 +1,442 @@
+#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

@@ -0,0 +1,91 @@
+#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/CMakeLists.txt

@@ -0,0 +1,8 @@
+target_sources(${LIB_FSFW_NAME} PUBLIC
+    I2cComIF.cpp
+    I2cCookie.cpp
+)
+
+
+
+

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

@@ -0,0 +1,205 @@
+#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

@@ -0,0 +1,61 @@
+#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

@@ -0,0 +1,20 @@
+#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

@@ -0,0 +1,38 @@
+#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/CMakeLists.txt

@@ -0,0 +1,3 @@
+target_sources(${LIB_FSFW_NAME} PRIVATE
+    GpioRPi.cpp
+)