Merge pull request 'Added new functions to add sequences and tables' (#606) from eive/fsfw:mueller/new-ss-adder-functions into development

Reviewed-on: fsfw/fsfw#606

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

CHANGELOG.md

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

CMakeLists.txt

@@ -1,5 +1,39 @@
 cmake_minimum_required(VERSION 3.13)
 
+set(LIB_FSFW_NAME fsfw)
+project(${LIB_FSFW_NAME})
+
+if(NOT CMAKE_CXX_STANDARD)
+    set(CMAKE_CXX_STANDARD 17)
+    set(CMAKE_CXX_STANDARD_REQUIRED True)
+elseif(${CMAKE_CXX_STANDARD} LESS 17)
+    message(FATAL_ERROR "Compiling the FSFW requires a minimum of C++17 support")
+endif()
+
+set(FSFW_VERSION 4)
+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})
+
+set(FSFW_ETL_LIB_MAJOR_VERSION 20 CACHE STRING
+    "ETL library major version requirement"
+)
+set(FSFW_ETL_LIB_VERSION ${FSFW_ETL_LIB_MAJOR_VERSION}.27.3 CACHE STRING
+    "ETL library exact version requirement"
+)
+set(FSFW_ETL_LINK_TARGET etl::etl)
+
+set(FSFW_CATCH2_LIB_MAJOR_VERSION 3 CACHE STRING
+    "Catch2 library major version requirement"
+)
+set(FSFW_CATCH2_LIB_VERSION v${FSFW_CATCH2_LIB_MAJOR_VERSION}.0.0-preview5 CACHE STRING
+    "Catch2 library exact version requirement"
+)
+
+set(FSFW_ETL_LIB_NAME etl)
+
 option(FSFW_GENERATE_SECTIONS
     "Generate function and data sections. Required to remove unused code" ON
 )
@@ -7,9 +41,17 @@ 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_ADD_INTERNAL_TESTS "Add internal unit tests" 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)
@@ -21,23 +63,107 @@ option(FSFW_ADD_COORDINATES "Compile with coordinate components" OFF)
 option(FSFW_ADD_TMSTORAGE "Compile with tm storage components" OFF)
 
 # Contrib sources
-option(FSFW_ADD_SPG4_PROPAGATOR "Add SPG4 propagator code" OFF)
+option(FSFW_ADD_SGP4_PROPAGATOR "Add SGP4 propagator code" OFF)
+
+
+set(FSFW_TEST_TGT fsfw-tests)
+set(FSFW_DUMMY_TGT fsfw-dummy)
 
-set(LIB_FSFW_NAME fsfw)
 add_library(${LIB_FSFW_NAME})
+
+if(FSFW_BUILD_UNITTESTS)
+    message(STATUS "Building the FSFW unittests in addition to the static library")
+    # Check whether the user has already installed Catch2 first
+    find_package(Catch2 ${FSFW_CATCH2_LIB_MAJOR_VERSION})
+    # Not installed, so use FetchContent to download and provide Catch2
+    if(NOT Catch2_FOUND)
+        message(STATUS "Catch2 installation not found. Downloading Catch2 library with FetchContent")
+        include(FetchContent)
+
+        FetchContent_Declare(
+            Catch2
+            GIT_REPOSITORY https://github.com/catchorg/Catch2.git
+            GIT_TAG        ${FSFW_CATCH2_LIB_VERSION}
+        )
+
+        list(APPEND FSFW_FETCH_CONTENT_TARGETS 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()
+
+message(STATUS "Finding and/or providing ETL library")
+
+# Check whether the user has already installed ETL first
+find_package(${FSFW_ETL_LIB_NAME} ${FSFW_ETL_LIB_MAJOR_VERSION} QUIET)
+# Not installed, so use FetchContent to download and provide etl
+if(NOT ${FSFW_ETL_LIB_NAME}_FOUND)
+    message(STATUS
+        "No ETL installation was found with find_package. Installing and providing "
+        "etl with FindPackage"
+    )
+    include(FetchContent)
+
+    FetchContent_Declare(
+        ${FSFW_ETL_LIB_NAME}
+        GIT_REPOSITORY https://github.com/ETLCPP/etl
+        GIT_TAG        ${FSFW_ETL_LIB_VERSION}
+    )
+
+    list(APPEND FSFW_FETCH_CONTENT_TARGETS ${FSFW_ETL_LIB_NAME})
+endif()
+
+# The documentation for FetchContent recommends declaring all the dependencies
+# before making them available. We make all declared dependency available here
+# after their declaration
+if(FSFW_FETCH_CONTENT_TARGETS)
+    FetchContent_MakeAvailable(${FSFW_FETCH_CONTENT_TARGETS})
+    if(TARGET ${FSFW_ETL_LIB_NAME})
+        add_library(${FSFW_ETL_LINK_TARGET} ALIAS ${FSFW_ETL_LIB_NAME})
+    endif()
+    if(TARGET Catch2)
+        # Fixes regression -preview4, to be confirmed in later releases
+        # Related GitHub issue: https://github.com/catchorg/Catch2/issues/2417
+        set_target_properties(Catch2 PROPERTIES DEBUG_POSTFIX "")
+    endif()
+endif()
+
 set(FSFW_CORE_INC_PATH "inc")
 
 set_property(CACHE FSFW_OSAL PROPERTY STRINGS host linux rtems freertos)
 
-if(NOT CMAKE_CXX_STANDARD)
-    set(CMAKE_CXX_STANDARD 11)
-    set(CMAKE_CXX_STANDARD_REQUIRED True)
-elseif(${CMAKE_CXX_STANDARD} LESS 11)
-    message(FATAL_ERROR "Compiling the FSFW requires a minimum of C++11 support")
-endif()
+# For configure files
+target_include_directories(${LIB_FSFW_NAME} PRIVATE
+    ${CMAKE_CURRENT_BINARY_DIR}
+)
+target_include_directories(${LIB_FSFW_NAME} INTERFACE
+    ${CMAKE_CURRENT_BINARY_DIR}
+)
+
 
 # Backwards comptability
-if(OS_FSFW)
+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()
@@ -61,48 +187,120 @@ endif()
 set(FSFW_OSAL_DEFINITION FSFW_OSAL_HOST)
 
 if(FSFW_OSAL MATCHES host)
-	set(OS_FSFW_NAME "Host")
+    set(FSFW_OS_NAME "Host")
+    set(FSFW_OSAL_HOST ON)
 elseif(FSFW_OSAL MATCHES linux)
-	set(OS_FSFW_NAME "Linux")
-	set(FSFW_OSAL_DEFINITION FSFW_OSAL_LINUX)
+    set(FSFW_OS_NAME "Linux")
+    set(FSFW_OSAL_LINUX ON)
 elseif(FSFW_OSAL MATCHES freertos)
-	set(OS_FSFW_NAME "FreeRTOS")
-	set(FSFW_OSAL_DEFINITION FSFW_OSAL_FREERTOS)
-	target_link_libraries(${LIB_FSFW_NAME} PRIVATE
+    set(FSFW_OS_NAME "FreeRTOS")
+    set(FSFW_OSAL_FREERTOS ON)
+    target_link_libraries(${LIB_FSFW_NAME} PRIVATE
         ${LIB_OS_NAME}
-	)
+    )
 elseif(FSFW_OSAL STREQUAL rtems)
-	set(OS_FSFW_NAME "RTEMS")
-    set(FSFW_OSAL_DEFINITION FSFW_OSAL_RTEMS)
+    set(FSFW_OS_NAME "RTEMS")
+    set(FSFW_OSAL_RTEMS ON)
 else()
-	message(WARNING 
-		"Invalid operating system for FSFW specified! Setting to host.."
-	)
-	set(OS_FSFW_NAME "Host")
-	set(OS_FSFW "host")
+    message(WARNING
+        "Invalid operating system for FSFW specified! Setting to host.."
+    )
+    set(FSFW_OS_NAME "Host")
+    set(OS_FSFW "host")
 endif()
 
-target_compile_definitions(${LIB_FSFW_NAME} PRIVATE
-    ${FSFW_OSAL_DEFINITION}
-)
+configure_file(src/fsfw/FSFW.h.in fsfw/FSFW.h)
+configure_file(src/fsfw/FSFWVersion.h.in fsfw/FSFWVersion.h)
 
-target_compile_definitions(${LIB_FSFW_NAME} INTERFACE
-    ${FSFW_OSAL_DEFINITION}
-)
-
-message(STATUS "Compiling FSFW for the ${OS_FSFW_NAME} operating system.")
+message(STATUS "Compiling FSFW for the ${FSFW_OS_NAME} operating system.")
 
 add_subdirectory(src)
 add_subdirectory(tests)
-add_subdirectory(hal)
+if(FSFW_ADD_HAL)
+    add_subdirectory(hal)
+endif()
 add_subdirectory(contrib)
+if(FSFW_BUILD_DOCS)
+    add_subdirectory(docs)
+endif()
+
+if(FSFW_BUILD_UNITTESTS)
+    if(FSFW_TESTS_GEN_COV)
+        if(CMAKE_COMPILER_IS_GNUCXX)
+            include(CodeCoverage)
+
+            # Remove quotes.
+            separate_arguments(COVERAGE_COMPILER_FLAGS
+                NATIVE_COMMAND "${COVERAGE_COMPILER_FLAGS}"
+            )
+
+            # Add compile options manually, we don't want coverage for Catch2
+            target_compile_options(${FSFW_TEST_TGT} PRIVATE
+                "${COVERAGE_COMPILER_FLAGS}"
+            )
+            target_compile_options(${LIB_FSFW_NAME} PRIVATE
+                "${COVERAGE_COMPILER_FLAGS}"
+            )
+
+            # Exclude directories here
+            if(WIN32)
+                set(GCOVR_ADDITIONAL_ARGS
+                    "--exclude-throw-branches"
+                    "--exclude-unreachable-branches"
+                )
+                set(COVERAGE_EXCLUDES
+                    "/c/msys64/mingw64/*" "*/fsfw_hal/*"
+                )
+            elseif(UNIX)
+                set(COVERAGE_EXCLUDES
+                    "/usr/include/*" "/usr/bin/*" "Catch2/*"
+                    "/usr/local/include/*" "*/fsfw_tests/*"
+                    "*/catch2-src/*" "*/fsfw_hal/*"
+                )
+            endif()
+
+            target_link_options(${FSFW_TEST_TGT} PRIVATE
+                -fprofile-arcs
+                -ftest-coverage
+            )
+            target_link_options(${LIB_FSFW_NAME} PRIVATE
+                -fprofile-arcs
+                -ftest-coverage
+            )
+            # Need to specify this as an interface, otherwise there will the compile issues
+            target_link_options(${LIB_FSFW_NAME} INTERFACE
+                -fprofile-arcs
+                -ftest-coverage
+            )
+
+            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!")
-	message(WARNING "Setting default configuration!")
-	add_subdirectory(defaultcfg/fsfwconfig)
+    set(DEF_CONF_PATH misc/defaultcfg/fsfwconfig)
+    if(NOT FSFW_BUILD_DOCS)
+        message(WARNING "Flight Software Framework configuration path not set!")
+        message(WARNING "Setting default configuration from ${DEF_CONF_PATH} ..")
+    endif()
+    add_subdirectory(${DEF_CONF_PATH})
+    set(FSFW_CONFIG_PATH ${DEF_CONF_PATH})
 endif()
 
 # FSFW might be part of a possibly complicated folder structure, so we 
@@ -138,6 +336,24 @@ if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
 		  -Wimplicit-fallthrough=1
 		  -Wno-unused-parameter
 		  -Wno-psabi
+          -Wduplicated-cond # check for duplicate conditions
+          -Wduplicated-branches # check for duplicate branches
+          -Wlogical-op # Search for bitwise operations instead of logical 
+          -Wnull-dereference # Search for NULL dereference
+          -Wundef # Warn if undefind marcos are used
+          -Wformat=2 # Format string problem detection
+          -Wformat-overflow=2 # Formatting issues in printf
+          -Wformat-truncation=2 # Formatting issues in printf
+          -Wformat-security # Search for dangerous printf operations
+          -Wstrict-overflow=3 # Warn if integer overflows might happen
+          -Warray-bounds=2 # Some array bounds violations will be found
+          -Wshift-overflow=2 # Search for bit left shift overflows (<c++14)
+          -Wcast-qual # Warn if the constness is cast away
+          -Wstringop-overflow=4
+          # -Wstack-protector # Emits a few false positives for low level access
+          # -Wconversion # Creates many false positives
+          # -Warith-conversion # Use with Wconversion to find more implicit conversions
+          # -fanalyzer # Should be used to look through problems
         )
     endif()
 
@@ -188,5 +404,19 @@ target_compile_options(${LIB_FSFW_NAME} PRIVATE
 )
 
 target_link_libraries(${LIB_FSFW_NAME} PRIVATE
+    ${FSFW_ETL_LINK_TARGET}
     ${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}
+)

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)
 
@@ -11,9 +11,15 @@ with Airbus Defence and Space GmbH.
 
 ## Quick facts
 
-The framework is designed for systems, which communicate with external devices, perform control loops, receive telecommands and send telemetry, and need to maintain a high level of availability. Therefore, a mode and health system provides control over the states of the software and the controlled devices. In addition, a simple mechanism of event based fault detection, isolation and recovery is implemented as well. 
+The framework is designed for systems, which communicate with external devices, perform control loops, 
+receive telecommands and send telemetry, and need to maintain a high level of availability. Therefore,
+a mode and health system provides control over the states of the software and the controlled devices.
+In addition, a simple mechanism of event based fault detection, isolation and recovery is implemented as well. 
 
-The FSFW provides abstraction layers for operating systems to provide a uniform operating system abstraction layer (OSAL). Some components of this OSAL are required internally by the FSFW but is also very useful for developers to implement the same application logic on different operating systems with a uniform interface.
+The FSFW provides abstraction layers for operating systems to provide a uniform operating system
+abstraction layer (OSAL). Some components of this OSAL are required internally by the FSFW but is
+also very useful for developers to implement the same application logic on different operating
+systems with a uniform interface.
 
 Currently, the FSFW provides the following OSALs:
 
@@ -22,28 +28,178 @@ 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
-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.
+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](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.
+
+## Prerequisites
+
+The Embedded Template Library (etl) is a dependency of the FSFW which is automatically
+installed and provided by the build system unless the correction version was installed.
+The current recommended version can be found inside the fsfw `CMakeLists.txt` file or by using
+`ccmake` and looking up the `FSFW_ETL_LIB_MAJOR_VERSION` variable.
+
+You can install the ETL library like this. On Linux, it might be necessary to add `sudo` before
+the install call:
+
+```cpp
+git clone https://github.com/ETLCPP/etl
+cd etl
+git checkout <currentRecommendedVersion>
+mkdir build && cd build
+cmake ..
+cmake --install .
+```
+
+It is recommended to install `20.27.2` or newer for the package version handling of
+ETL to work.
+
+## Adding the library
+
+The following steps show how to add and use FSFW components. It is still recommended to
+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.
+
+You can install the Catch2 library, which prevents the build system to avoid re-downloading
+the dependency if the unit tests are completely rebuilt. The current recommended version
+can be found inside the fsfw `CMakeLists.txt` file or by using `ccmake` and looking up
+the `FSFW_CATCH2_LIB_VERSION` variable.
+
+```sh
+git clone https://github.com/catchorg/Catch2.git
+cd Catch2
+git checkout <currentRecommendedVersion>
+cmake -Bbuild -H. -DBUILD_TESTING=OFF
+sudo cmake --build build/ --target install
+```
+
+The fsfw-tests binary will be built as part of the static library and dropped alongside it.
+If the unittests are built, the library and the tests will be built with coverage information by
+default. This can be disabled by setting the `FSFW_TESTS_COV_GEN` option to `OFF` or `FALSE`.
+
+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 -DCMAKE_BUILD_TYPE=Debug ..
+```
+
+You can also use `-DFSFW_OSAL=linux` on Linux systems.
+
+Coverage data in HTML format can be generated using the `CodeCoverage`
+[CMake module](https://github.com/bilke/cmake-modules/tree/master).
+To build the unittests, run them and then generare the coverage data in this format,
+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.
+
+## Building the documentations
+
+The FSFW documentation is built using the tools Sphinx, doxygen and breathe based on the
+instructions provided in  [this blogpost](https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/). If you
+want to do this locally, set up the prerequisites first. This requires a ``python3``
+installation as well. Example here is for Ubuntu.
+
+```sh
+sudo apt-get install doxygen graphviz
+```
+
+And the following Python packages
+
+```sh
+python3 -m pip install sphinx breathe
+```
+
+You can set up a documentation build system using the following commands
+
+```sh
+mkdir build-docs && cd build-docs
+cmake -DFSFW_BUILD_DOCS=ON -DFSFW_OSAL=host ..
+```
+
+Then you can generate the documentation using
+
+```sh
+cmake --build . -j
+```
+
+You can find the generated documentation inside the `docs/sphinx` folder inside the build
+folder. Simply open the `index.html` in the webbrowser of your choice.
+
+The `helper.py` script located in the script` folder can also be used to create, build
+and open the documentation conveniently. Try `helper.py -h for more information.
+
+## Formatting the sources
+
+The formatting is done by the `clang-format` tool. The configuration is contained within the
+`.clang-format` file in the repository root. As long as `clang-format` is installed, you
+can run the `apply-clang-format.sh` helper script to format all source files consistently.
 
 ## Index
 
-[1. High-level overview](doc/README-highlevel.md#top) <br>
-[2. Core components](doc/README-core.md#top) <br>
-[3. Configuration](doc/README-config.md#top) <br>
-[4. OSAL overview](doc/README-osal.md#top) <br>
-[5. PUS services](doc/README-pus.md#top) <br>
-[6. Device Handler overview](doc/README-devicehandlers.md#top) <br>
-[7. Controller overview](doc/README-controllers.md#top) <br>
-[8. Local Data Pools](doc/README-localpools.md#top) <br>
+[1. High-level overview](docs/README-highlevel.md#top) <br>
+[2. Core components](docs/README-core.md#top) <br>
+[3. Configuration](docs/README-config.md#top) <br>
+[4. OSAL overview](docs/README-osal.md#top) <br>
+[5. PUS services](docs/README-pus.md#top) <br>
+[6. Device Handler overview](docs/README-devicehandlers.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,14 @@
+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 iputils-ping
+
+RUN git clone https://github.com/catchorg/Catch2.git && \
+	cd Catch2 && \
+	git checkout v3.0.0-preview5 && \
+	cmake -Bbuild -H. -DBUILD_TESTING=OFF && \
+	cmake --build build/ --target install

automation/Jenkinsfile

@@ -0,0 +1,43 @@
+pipeline {
+    environment {
+        BUILDDIR = 'build-tests'
+    }
+    agent {
+        docker { image 'fsfw-ci:d2'}
+    }
+    stages {
+        stage('Clean') {
+            steps {
+                sh 'rm -rf $BUILDDIR'
+            }
+        }
+        stage('Configure') {
+            steps {
+                dir(BUILDDIR) {
+                    sh 'cmake -DFSFW_OSAL=host -DFSFW_BUILD_UNITTESTS=ON ..'
+                }
+            }
+        }
+        stage('Build') {
+            steps {
+                dir(BUILDDIR) {
+                    sh 'cmake --build . -j4'
+                }
+            }
+        }
+        stage('Unittests') {
+            steps {
+                dir(BUILDDIR) {
+                    sh 'cmake --build . -- fsfw-tests_coverage -j4'
+                }
+            }
+        }
+        stage('Valgrind') {
+            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

@@ -1,11 +1,9 @@
-if(FSFW_ADD_SPG4_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()
+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()

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

docs/getting_started.rst

@@ -0,0 +1,173 @@
+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.
+
+Prerequisites
+-------------------
+
+The Embedded Template Library (etl) is a dependency of the FSFW which is automatically
+installed and provided by the build system unless the correction version was installed.
+The current recommended version can be found inside the fsfw ``CMakeLists.txt`` file or by using
+``ccmake`` and looking up the ``FSFW_ETL_LIB_MAJOR_VERSION`` variable.
+
+You can install the ETL library like this. On Linux, it might be necessary to add ``sudo`` before
+the install call:
+
+.. code-block:: console
+
+   git clone https://github.com/ETLCPP/etl
+   cd etl
+   git checkout <currentRecommendedVersion>
+   mkdir build && cd build
+   cmake ..
+   cmake --install .
+
+It is recommended to install ``20.27.2`` or newer for the package version handling of
+ETL to work.
+
+Adding the library
+-------------------
+
+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.
+
+You can install the Catch2 library, which prevents the build system to avoid re-downloading
+the dependency if the unit tests are completely rebuilt. The current recommended version
+can be found inside the fsfw ``CMakeLists.txt`` file or by using ``ccmake`` and looking up
+the ``FSFW_CATCH2_LIB_VERSION`` variable.
+
+.. code-block:: console
+
+   git clone https://github.com/catchorg/Catch2.git
+   cd Catch2
+   git checkout <currentRecommendedVersion>
+   cmake -Bbuild -H. -DBUILD_TESTING=OFF
+   sudo cmake --build build/ --target install
+
+
+The fsfw-tests binary will be built as part of the static library and dropped alongside it.
+If the unittests are built, the library and the tests will be built with coverage information by
+default. This can be disabled by setting the `FSFW_TESTS_COV_GEN` option to `OFF` or `FALSE`.
+
+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/>`_. If you
+want to do this locally, set up the prerequisites first. This requires a ``python3``
+installation as well. Example here is for Ubuntu.
+
+.. code-block:: console
+
+   sudo apt-get install doxygen graphviz
+
+And the following Python packages
+
+.. code-block:: console
+
+   python3 -m pip install sphinx breathe
+
+You can set up a documentation build system using the following commands
+
+.. code-block:: bash
+
+   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.
+
+Formatting the source
+-----------------------
+
+The formatting is done by the ``clang-format`` tool. The configuration is contained within the
+``.clang-format`` file in the repository root. As long as ``clang-format`` is installed, you
+can run the ``apply-clang-format.sh`` helper script to format all source files consistently.
+
+
+.. _`Hosted FSFW example`: https://egit.irs.uni-stuttgart.de/fsfw/fsfw-example-hosted
+.. _`Catch2 library`: https://github.com/catchorg/Catch2
+.. _`Code coverage`: https://github.com/bilke/cmake-modules/tree/master

docs/highlevel.rst

@@ -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 :ref:`documentation section <dhb-prim-doc>`.
+
+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
+==============

hal/CMakeLists.txt

@@ -3,7 +3,14 @@ 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_LINUX "Add the Linux HAL to the sources. Requires gpiod library" OFF)
+# On by default for now because I did not have an issue including and compiling those files
+# and libraries on a Desktop Linux system and the primary target of the FSFW is still embedded
+# Linux. The only exception from this is the gpiod library which requires a dedicated installation,
+# but CMake is able to determine whether this library is installed with find_library.
+option(FSFW_HAL_LINUX_ADD_PERIPHERAL_DRIVERS "Add peripheral drivers for embedded Linux" ON)
+option(FSFW_HAL_LINUX_ADD_LIBGPIOD "Target implements libgpiod" ON)
+
 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)

hal/src/CMakeLists.txt

@@ -6,4 +6,4 @@ target_include_directories(${LIB_FSFW_NAME} INTERFACE
     ${CMAKE_CURRENT_SOURCE_DIR}
 )
 
-add_subdirectory(fsfw)
+add_subdirectory(fsfw_hal)

hal/src/fsfw/CMakeLists.txt

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

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

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

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

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

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

@@ -1,110 +0,0 @@
-#ifndef COMMON_GPIO_GPIODEFINITIONS_H_
-#define COMMON_GPIO_GPIODEFINITIONS_H_
-
-#include <string>
-#include <unordered_map>
-#include <map>
-
-using gpioId_t = uint16_t;
-
-namespace gpio {
-
-enum Levels {
-    LOW = 0,
-    HIGH = 1
-};
-
-enum Direction {
-    IN = 0,
-    OUT = 1
-};
-
-enum GpioOperation {
-    READ,
-    WRITE
-};
-
-enum GpioTypes {
-    NONE,
-    GPIO_REGULAR,
-    CALLBACK
-};
-
-static constexpr gpioId_t NO_GPIO = -1;
-
-using gpio_cb_t = void (*) (gpioId_t gpioId, gpio::GpioOperation gpioOp, int 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,
-            int 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;
-    int initValue = 0;
-};
-
-class GpiodRegular: public GpioBase {
-public:
-    GpiodRegular() :
-            GpioBase(gpio::GpioTypes::GPIO_REGULAR, std::string(), gpio::Direction::IN, 0) {
-    }
-    ;
-
-    GpiodRegular(std::string chipname_, int lineNum_, std::string consumer_,
-            gpio::Direction direction_, int initValue_) :
-            GpioBase(gpio::GpioTypes::GPIO_REGULAR, consumer_, direction_, initValue_),
-            chipname(chipname_), lineNum(lineNum_) {
-    }
-
-    GpiodRegular(std::string chipname_, int lineNum_, std::string consumer_) :
-            GpioBase(gpio::GpioTypes::GPIO_REGULAR, consumer_, gpio::Direction::IN, 0),
-            chipname(chipname_), lineNum(lineNum_) {
-    }
-    std::string chipname;
-    int lineNum = 0;
-    struct gpiod_line* lineHandle = nullptr;
-};
-
-class GpioCallback: public GpioBase {
-public:
-    GpioCallback(std::string consumer, gpio::Direction direction_, int initValue_,
-            gpio::gpio_cb_t callback, void* callbackArgs):
-            GpioBase(gpio::GpioTypes::CALLBACK, consumer, direction_, initValue_),
-            callback(callback), callbackArgs(callbackArgs) {}
-
-    gpio::gpio_cb_t callback = nullptr;
-    void* callbackArgs = nullptr;
-};
-
-
-using GpioMap = std::map<gpioId_t, GpioBase*>;
-using GpioUnorderedMap = std::unordered_map<gpioId_t, GpioBase*>;
-using GpioMapIter = GpioMap::iterator;
-using GpioUnorderedMapIter = GpioUnorderedMap::iterator;
-
-#endif /* LINUX_GPIO_GPIODEFINITIONS_H_ */

hal/src/fsfw/hal/devicehandlers/GyroL3GD20Handler.cpp

@@ -1,262 +0,0 @@
-#include "fsfw/hal/devicehandlers/GyroL3GD20Handler.h"
-
-#include "fsfw/datapool/PoolReadGuard.h"
-
-GyroHandlerL3GD20H::GyroHandlerL3GD20H(object_id_t objectId, object_id_t deviceCommunication,
-        CookieIF *comCookie):
-        DeviceHandlerBase(objectId, deviceCommunication, comCookie),
-        dataset(this) {
-#if FSFW_HAL_L3GD20_GYRO_DEBUG == 1
-    debugDivider = new PeriodicOperationDivider(5);
-#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 HasReturnvaluesIF::RETURN_OK;
-    }
-    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::debug << "GyroHandler::buildTransitionDeviceCommand: Unknown internal state!" <<
-        std::endl;
-#else
-        sif::printDebug("GyroHandler::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 in degrees per second:" <<
-                    std::endl;
-            sif::info << "X: " << angVelocX << " \xC2\xB0" << std::endl;
-            sif::info << "Y: " << angVelocY << " \xC2\xB0" << std::endl;
-            sif::info << "Z: " << angVelocZ << " \xC2\xB0" << std::endl;
-#else
-            sif::printInfo("GyroHandlerL3GD20H: Angular velocities in degrees per second:\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) {
-            dataset.angVelocX = angVelocX;
-            dataset.angVelocY = angVelocY;
-            dataset.angVelocZ = angVelocZ;
-            dataset.temperature = temperature;
-            dataset.setValidity(true, true);
-        }
-        break;
-    }
-    default:
-        return DeviceHandlerIF::COMMAND_NOT_IMPLEMENTED;
-    }
-    return result;
-}
-
-
-uint32_t GyroHandlerL3GD20H::getTransitionDelayMs(Mode_t from, Mode_t to) {
-    return 10000;
-}
-
-void GyroHandlerL3GD20H::setGoNormalModeAtStartup() {
-    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;
-}

hal/src/fsfw/hal/devicehandlers/GyroL3GD20Handler.h

@@ -1,86 +0,0 @@
-#ifndef MISSION_DEVICES_GYROL3GD20HANDLER_H_
-#define MISSION_DEVICES_GYROL3GD20HANDLER_H_
-
-#include "OBSWConfig.h"
-#include "devicedefinitions/GyroL3GD20Definitions.h"
-
-#include <fsfw/devicehandlers/DeviceHandlerBase.h>
-#include <fsfw/globalfunctions/PeriodicOperationDivider.h>
-
-#ifndef FSFW_HAL_L3GD20_GYRO_DEBUG
-#define FSFW_HAL_L3GD20_GYRO_DEBUG   1
-#endif /* FSFW_HAL_L3GD20_GYRO_DEBUG */
-
-/**
- * @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);
-    virtual ~GyroHandlerL3GD20H();
-
-    void setGoNormalModeAtStartup();
-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() override;
-    uint32_t getTransitionDelayMs(Mode_t from, Mode_t to) override;
-    ReturnValue_t initializeLocalDataPool(localpool::DataPool &localDataPoolMap,
-            LocalDataPoolManager &poolManager) override;
-
-private:
-    GyroPrimaryDataset dataset;
-
-    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/linux/CMakeLists.txt

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

hal/src/fsfw/hal/linux/UnixFileGuard.cpp

@@ -1,33 +0,0 @@
-#include "fsfw/hal/linux/UnixFileGuard.h"
-
-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 <<
-                "." << std::endl;
-        sif::warning << "Error description: " << strerror(errno) << std::endl;
-#else
-        sif::printError("%sOpening device failed with error code %d.\n", diagnosticPrefix);
-        sif::printWarning("Error description: %s\n", strerror(errno));
-#endif /* FSFW_CPP_OSTREAM_ENABLED == 1 */
-#endif /* FSFW_VERBOSE_LEVEL >= 1 */
-        openStatus = OPEN_FILE_FAILED;
-    }
-}
-
-UnixFileGuard::~UnixFileGuard() {
-    if(fileDescriptor != nullptr) {
-        close(*fileDescriptor);
-    }
-}
-
-ReturnValue_t UnixFileGuard::getOpenResult() const {
-    return openStatus;
-}

hal/src/fsfw/hal/linux/UnixFileGuard.h

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

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

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

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

@@ -1,305 +0,0 @@
-#include "fsfw/hal/linux/gpio/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::initialize: 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) {
-        switch(gpioConfig.second->gpioType) {
-        case(gpio::GpioTypes::NONE): {
-            return GPIO_INVALID_INSTANCE;
-        }
-        case(gpio::GpioTypes::GPIO_REGULAR): {
-            GpiodRegular* regularGpio = dynamic_cast<GpiodRegular*>(gpioConfig.second);
-            if(regularGpio == nullptr) {
-                return GPIO_INVALID_INSTANCE;
-            }
-            configureRegularGpio(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::configureRegularGpio(gpioId_t gpioId, GpiodRegular *regularGpio) {
-    std::string chipname;
-    unsigned int lineNum;
-    struct gpiod_chip *chip;
-    gpio::Direction direction;
-    std::string consumer;
-    struct gpiod_line *lineHandle;
-    int result = 0;
-
-    chipname = regularGpio->chipname;
-    chip = gpiod_chip_open_by_name(chipname.c_str());
-    if (!chip) {
-        sif::warning << "LinuxLibgpioIF::configureRegularGpio: Failed to open chip "
-                << chipname << ". Gpio ID: " << gpioId << std::endl;
-        return RETURN_FAILED;
-    }
-
-    lineNum = regularGpio->lineNum;
-    lineHandle = gpiod_chip_get_line(chip, lineNum);
-    if (!lineHandle) {
-        sif::debug << "LinuxLibgpioIF::configureRegularGpio: Failed to open line " << std::endl;
-        sif::debug << "GPIO ID: " << gpioId << ", line number: " << lineNum <<
-                ", chipname: " << chipname << std::endl;
-        sif::debug << "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);
-        if (result < 0) {
-            sif::error << "LinuxLibgpioIF::configureRegularGpio: Failed to request line " << lineNum <<
-                    " from GPIO instance with ID: " << gpioId << std::endl;
-            gpiod_line_release(lineHandle);
-            return RETURN_FAILED;
-        }
-        break;
-    }
-    case(gpio::IN): {
-        result = gpiod_line_request_input(lineHandle, consumer.c_str());
-        if (result < 0) {
-            sif::error << "LinuxLibgpioIF::configureGpios: Failed to request line "
-                    << lineNum << " from GPIO instance with ID: " << gpioId << std::endl;
-            gpiod_line_release(lineHandle);
-            return RETURN_FAILED;
-        }
-        break;
-    }
-    default: {
-        sif::error << "LinuxLibgpioIF::configureGpios: Invalid direction specified"
-                << std::endl;
-        return GPIO_INVALID_INSTANCE;
-    }
-
-    }
-    /**
-     * 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;
-    }
-
-    if(gpioMapIter->second->gpioType == gpio::GpioTypes::GPIO_REGULAR) {
-        return driveGpio(gpioId, dynamic_cast<GpiodRegular*>(gpioMapIter->second), 1);
-    }
-    else {
-        auto gpioCallback = dynamic_cast<GpioCallback*>(gpioMapIter->second);
-        if(gpioCallback->callback == nullptr) {
-            return GPIO_INVALID_INSTANCE;
-        }
-        gpioCallback->callback(gpioMapIter->first, gpio::GpioOperation::WRITE,
-                1, gpioCallback->callbackArgs);
-        return RETURN_OK;
-    }
-    return GPIO_TYPE_FAILURE;
-}
-
-ReturnValue_t LinuxLibgpioIF::pullLow(gpioId_t gpioId) {
-    gpioMapIter = gpioMap.find(gpioId);
-    if (gpioMapIter == gpioMap.end()) {
-        sif::warning << "LinuxLibgpioIF::pullLow: Unknown GPIO ID " << gpioId << std::endl;
-        return UNKNOWN_GPIO_ID;
-    }
-
-    if(gpioMapIter->second->gpioType == gpio::GpioTypes::GPIO_REGULAR) {
-        return driveGpio(gpioId, dynamic_cast<GpiodRegular*>(gpioMapIter->second), 0);
-    }
-    else {
-        auto gpioCallback = dynamic_cast<GpioCallback*>(gpioMapIter->second);
-        if(gpioCallback->callback == nullptr) {
-            return GPIO_INVALID_INSTANCE;
-        }
-        gpioCallback->callback(gpioMapIter->first, gpio::GpioOperation::WRITE,
-                0, gpioCallback->callbackArgs);
-        return RETURN_OK;
-    }
-    return GPIO_TYPE_FAILURE;
-}
-
-ReturnValue_t LinuxLibgpioIF::driveGpio(gpioId_t gpioId,
-        GpiodRegular* regularGpio, unsigned int logicLevel) {
-    if(regularGpio == nullptr) {
-        return GPIO_TYPE_FAILURE;
-    }
-
-    int result = gpiod_line_set_value(regularGpio->lineHandle, logicLevel);
-    if (result < 0) {
-        sif::warning << "LinuxLibgpioIF::driveGpio: Failed to pull GPIO with ID " << gpioId <<
-                " to logic level " << logicLevel << std::endl;
-        return DRIVE_GPIO_FAILURE;
-    }
-
-    return RETURN_OK;
-}
-
-ReturnValue_t LinuxLibgpioIF::readGpio(gpioId_t gpioId, int* gpioState) {
-    gpioMapIter = gpioMap.find(gpioId);
-    if (gpioMapIter == gpioMap.end()){
-        sif::warning << "LinuxLibgpioIF::readGpio: Unknown GPIOD ID " << gpioId << std::endl;
-        return UNKNOWN_GPIO_ID;
-    }
-
-    if(gpioMapIter->second->gpioType == gpio::GpioTypes::GPIO_REGULAR) {
-        GpiodRegular* regularGpio = dynamic_cast<GpiodRegular*>(gpioMapIter->second);
-        if(regularGpio == nullptr) {
-            return GPIO_TYPE_FAILURE;
-        }
-        *gpioState = gpiod_line_get_value(regularGpio->lineHandle);
-    }
-    else {
-
-    }
-
-
-    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): {
-            auto regularGpio = dynamic_cast<GpiodRegular*>(gpioConfig.second);
-            if(regularGpio == nullptr)  {
-                return GPIO_TYPE_FAILURE;
-            }
-            /* Check for conflicts and remove duplicates if necessary */
-            result = checkForConflictsRegularGpio(gpioConfig.first, regularGpio, 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 = checkForConflictsCallbackGpio(gpioConfig.first, callbackGpio, mapToAdd);
-            if(result != HasReturnvaluesIF::RETURN_OK) {
-                status = result;
-            }
-            break;
-        }
-        default: {
-
-        }
-        }
-    }
-    return status;
-}
-
-
-ReturnValue_t LinuxLibgpioIF::checkForConflictsRegularGpio(gpioId_t gpioIdToCheck,
-        GpiodRegular* gpioToCheck, GpioMap& mapToAdd) {
-    /* Cross check with private map */
-    gpioMapIter = gpioMap.find(gpioIdToCheck);
-    if(gpioMapIter != gpioMap.end()) {
-        if(gpioMapIter->second->gpioType != gpio::GpioTypes::GPIO_REGULAR) {
-            sif::warning << "LinuxLibgpioIF::checkForConflicts: ID already exists for different "
-                    "GPIO type" << gpioIdToCheck << ". Removing duplicate." << std::endl;
-            mapToAdd.erase(gpioIdToCheck);
-            return HasReturnvaluesIF::RETURN_OK;
-        }
-        auto ownRegularGpio = dynamic_cast<GpiodRegular*>(gpioMapIter->second);
-        if(ownRegularGpio == nullptr) {
-            return GPIO_TYPE_FAILURE;
-        }
-
-        /* Remove element from map to add because a entry for this GPIO
-        already exists */
-        sif::warning << "LinuxLibgpioIF::checkForConflictsRegularGpio: Duplicate GPIO definition"
-                << " detected. Duplicate will be removed from map to add." << std::endl;
-        mapToAdd.erase(gpioIdToCheck);
-    }
-    return HasReturnvaluesIF::RETURN_OK;
-}
-
-ReturnValue_t LinuxLibgpioIF::checkForConflictsCallbackGpio(gpioId_t gpioIdToCheck,
-        GpioCallback *callbackGpio, GpioMap& mapToAdd) {
-    /* Cross check with private map */
-    gpioMapIter = gpioMap.find(gpioIdToCheck);
-    if(gpioMapIter != gpioMap.end()) {
-        if(gpioMapIter->second->gpioType != gpio::GpioTypes::CALLBACK) {
-            sif::warning << "LinuxLibgpioIF::checkForConflicts: ID already exists for different "
-                    "GPIO type" << gpioIdToCheck << ". Removing duplicate." << std::endl;
-            mapToAdd.erase(gpioIdToCheck);
-            return HasReturnvaluesIF::RETURN_OK;
-        }
-
-        /* Remove element from map to add because a entry for this GPIO
-        already exists */
-        sif::warning << "LinuxLibgpioIF::checkForConflictsRegularGpio: Duplicate GPIO definition"
-                << " detected. Duplicate will be removed from map to add." << std::endl;
-        mapToAdd.erase(gpioIdToCheck);
-    }
-    return HasReturnvaluesIF::RETURN_OK;
-}

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

@@ -1,77 +0,0 @@
-#ifndef LINUX_GPIO_LINUXLIBGPIOIF_H_
-#define LINUX_GPIO_LINUXLIBGPIOIF_H_
-
-#include "../../common/gpio/GpioIF.h"
-#include <returnvalues/classIds.h>
-#include <fsfw/objectmanager/SystemObject.h>
-
-class GpioCookie;
-
-/**
- * @brief	This class implements the GpioIF for a linux based system. The
- * 			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);
-
-	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:
-	/* 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, GpiodRegular* regularGpio, unsigned int logiclevel);
-
-	ReturnValue_t configureRegularGpio(gpioId_t gpioId, GpiodRegular* regularGpio);
-
-	/**
-	 * @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 checkForConflictsRegularGpio(gpioId_t gpiodId, GpiodRegular* regularGpio,
-	        GpioMap& mapToAdd);
-    ReturnValue_t checkForConflictsCallbackGpio(gpioId_t gpiodId, GpioCallback* regularGpio,
-            GpioMap& mapToAdd);
-
-	/**
-	 * @brief   Performs the initial configuration of all GPIOs specified in the GpioMap mapToAdd.
-	 */
-	ReturnValue_t configureGpios(GpioMap& mapToAdd);
-
-};
-
-#endif /* LINUX_GPIO_LINUXLIBGPIOIF_H_ */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

hal/src/fsfw/hal/linux/utility.cpp

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

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

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

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

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

hal/src/fsfw/hal/stm32h7/dma.cpp

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

hal/src/fsfw/hal/stm32h7/gpio/gpio.cpp

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

hal/src/fsfw/hal/stm32h7/spi/stm32h743ziSpi.cpp

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

hal/src/fsfw/hal/stm32h7/spi/stm32h743ziSpi.h

@@ -1,23 +0,0 @@
-#ifndef FSFW_HAL_STM32H7_SPI_STM32H743ZISPI_H_
-#define FSFW_HAL_STM32H7_SPI_STM32H743ZISPI_H_
-
-#include "mspInit.h"
-
-namespace spi {
-
-namespace h743zi {
-
-void standardPollingCfg(MspPollingConfigStruct& cfg);
-void standardInterruptCfg(MspIrqConfigStruct& cfg, IrqPriorities spiIrqPrio,
-        IrqPriorities spiSubprio = HIGHEST);
-void standardDmaCfg(MspDmaConfigStruct& cfg, IrqPriorities spiIrqPrio,
-        IrqPriorities txIrqPrio, IrqPriorities rxIrqPrio,
-        IrqPriorities spiSubprio = HIGHEST, IrqPriorities txSubPrio = HIGHEST,
-        IrqPriorities rxSubprio = HIGHEST);
-
-}
-}
-
-
-
-#endif /* FSFW_HAL_STM32H7_SPI_STM32H743ZISPI_H_ */

hal/src/fsfw_hal/CMakeLists.txt

@@ -1,7 +1,7 @@
 add_subdirectory(devicehandlers)
 add_subdirectory(common)
 
-if(FSFW_HAL_ADD_LINUX)
+if(UNIX)
     add_subdirectory(linux)
 endif()
 

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

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

@@ -1,12 +1,12 @@
 #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>
 
+#include "GpioIF.h"
+#include "gpioDefinitions.h"
+
 /**
  * @brief   Cookie for the GpioIF. Allows the GpioIF to determine which
  * 			GPIOs to initialize and whether they should be configured as in- or
@@ -17,25 +17,24 @@
  *
  * @author 	J. Meier
  */
-class GpioCookie: public CookieIF {
-public:
+class GpioCookie : public CookieIF {
+ public:
+  GpioCookie();
 
-    GpioCookie();
+  virtual ~GpioCookie();
 
-    virtual ~GpioCookie();
+  ReturnValue_t addGpio(gpioId_t gpioId, GpioBase* gpioConfig);
 
-    ReturnValue_t addGpio(gpioId_t gpioId, GpioBase* gpioConfig);
+  /**
+   * @brief	Get map with registered GPIOs.
+   */
+  GpioMap getGpioMap() const;
 
-    /**
-     * @brief	Get map with registered GPIOs.
-     */
-    GpioMap getGpioMap() const;
-
-private:
-    /**
-     * Returns a copy of the internal GPIO map.
-     */
-    GpioMap gpioMap;
+ private:
+  /**
+   * Returns a copy of the internal GPIO map.
+   */
+  GpioMap gpioMap;
 };
 
 #endif /* COMMON_GPIO_GPIOCOOKIE_H_ */