Merge branch 'mueller/master' into mueller/restructuring

CMakeLists.txt

@@ -10,6 +10,7 @@ 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_HAL "Add Hardware Abstraction Layer" ON)
 
 # Optional sources
 option(FSFW_ADD_PUS "Compile with PUS sources" ON)
@@ -21,7 +22,7 @@ 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(LIB_FSFW_NAME fsfw)
 add_library(${LIB_FSFW_NAME})
@@ -94,7 +95,9 @@ message(STATUS "Compiling FSFW for the ${OS_FSFW_NAME} operating system.")
 
 add_subdirectory(src)
 add_subdirectory(tests)
+if(FSFW_ADD_HAL)
     add_subdirectory(hal)
+endif()
 add_subdirectory(contrib)
 
 # The project CMakeLists file has to set the FSFW_CONFIG_PATH and add it.

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
+    ${CMAKE_CURRENT_SOURCE_DIR}
 )
+
 target_include_directories(${LIB_FSFW_NAME} INTERFACE
-        ${CMAKE_CURRENT_SOURCE_DIR}/sgp4
+    ${CMAKE_CURRENT_SOURCE_DIR}
 )
-endif()
+
+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()

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-hal/common/gpio/GpioCookie.cpp

@@ -1,4 +1,4 @@
-#include "fsfw/hal/common/gpio/GpioCookie.h"
+#include "fsfw-hal/common/gpio/GpioCookie.h"
 #include "fsfw/serviceinterface/ServiceInterface.h"
 
 GpioCookie::GpioCookie() {

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

@@ -1,4 +1,4 @@
-#include "fsfw/hal/devicehandlers/GyroL3GD20Handler.h"
+#include "fsfw-hal/devicehandlers/GyroL3GD20Handler.h"
 
 #include "fsfw/datapool/PoolReadGuard.h"
 

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

@@ -1,14 +1,14 @@
 #ifndef MISSION_DEVICES_GYROL3GD20HANDLER_H_
 #define MISSION_DEVICES_GYROL3GD20HANDLER_H_
 
-#include "OBSWConfig.h"
+#include "fsfw/FSFW.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
+#define FSFW_HAL_L3GD20_GYRO_DEBUG   0
 #endif /* FSFW_HAL_L3GD20_GYRO_DEBUG */
 
 /**

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

@@ -1,4 +1,4 @@
-#include "fsfw/hal/linux/UnixFileGuard.h"
+#include "fsfw-hal/linux/UnixFileGuard.h"
 
 UnixFileGuard::UnixFileGuard(std::string device, int* fileDescriptor, int flags,
         std::string diagnosticPrefix):

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

@@ -1,6 +1,6 @@
-#include "fsfw/hal/linux/gpio/LinuxLibgpioIF.h"
+#include "fsfw-hal/linux/gpio/LinuxLibgpioIF.h"
-#include "fsfw/hal/common/gpio/gpioDefinitions.h"
+#include "fsfw-hal/common/gpio/gpioDefinitions.h"
-#include "fsfw/hal/common/gpio/GpioCookie.h"
+#include "fsfw-hal/common/gpio/GpioCookie.h"
 
 #include <fsfw/serviceinterface/ServiceInterface.h>
 

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

@@ -1,6 +1,6 @@
-#include "fsfw/hal/linux/i2c/I2cComIF.h"
+#include "fsfw-hal/linux/i2c/I2cComIF.h"
-#include "fsfw/hal/linux/utility.h"
+#include "fsfw-hal/linux/utility.h"
-#include "fsfw/hal/linux/UnixFileGuard.h"
+#include "fsfw-hal/linux/UnixFileGuard.h"
 
 #include "fsfw/serviceinterface/ServiceInterface.h"
 

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

@@ -1,4 +1,4 @@
-#include "fsfw/hal/linux/i2c/I2cCookie.h"
+#include "fsfw-hal/linux/i2c/I2cCookie.h"
 
 I2cCookie::I2cCookie(address_t i2cAddress_, size_t maxReplyLen_,
 		std::string deviceFile_) :

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

@@ -1,7 +1,7 @@
 #include "fsfw/FSFW.h"
 
-#include "fsfw/hal/linux/rpi/GpioRPi.h"
+#include "fsfw-hal/linux/rpi/GpioRPi.h"
-#include "fsfw/hal/common/gpio/GpioCookie.h"
+#include "fsfw-hal/common/gpio/GpioCookie.h"
 
 #include <fsfw/serviceinterface/ServiceInterface.h>
 

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

@@ -1,8 +1,8 @@
 #include "fsfw/FSFW.h"
-#include "fsfw/hal/linux/spi/SpiComIF.h"
+#include "fsfw-hal/linux/spi/SpiComIF.h"
-#include "fsfw/hal/linux/spi/SpiCookie.h"
+#include "fsfw-hal/linux/spi/SpiCookie.h"
-#include "fsfw/hal/linux/utility.h"
+#include "fsfw-hal/linux/utility.h"
-#include "fsfw/hal/linux/UnixFileGuard.h"
+#include "fsfw-hal/linux/UnixFileGuard.h"
 
 #include <fsfw/ipc/MutexFactory.h>
 #include <fsfw/globalfunctions/arrayprinter.h>

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

@@ -3,7 +3,7 @@
 
 #include "spiDefinitions.h"
 #include "returnvalues/classIds.h"
-#include "fsfw/hal/common/gpio/GpioIF.h"
+#include "fsfw-hal/common/gpio/GpioIF.h"
 
 #include "fsfw/devicehandlers/DeviceCommunicationIF.h"
 #include "fsfw/objectmanager/SystemObject.h"

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

@@ -1,4 +1,4 @@
-#include "fsfw/hal/linux/spi/SpiCookie.h"
+#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):

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

@@ -1,4 +1,4 @@
-#include "fsfw/hal/linux/uart/UartComIF.h"
+#include "fsfw-hal/linux/uart/UartComIF.h"
 #include "OBSWConfig.h"
 
 #include "fsfw/serviceinterface/ServiceInterface.h"

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

@@ -1,4 +1,4 @@
-#include "fsfw/hal/linux/uart/UartCookie.h"
+#include "fsfw-hal/linux/uart/UartCookie.h"
 
 #include <fsfw/serviceinterface/ServiceInterface.h>
 

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

@@ -1,6 +1,6 @@
 #include "fsfw/FSFW.h"
 #include "fsfw/serviceinterface/ServiceInterface.h"
-#include "fsfw/hal/linux/utility.h"
+#include "fsfw-hal/linux/utility.h"
 
 #include <cerrno>
 #include <cstring>

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

@@ -1,10 +1,10 @@
-#include "fsfw/hal/stm32h7/devicetest/GyroL3GD20H.h"
+#include "fsfw-hal/stm32h7/devicetest/GyroL3GD20H.h"
 
-#include "fsfw/hal/stm32h7/spi/mspInit.h"
+#include "fsfw-hal/stm32h7/spi/mspInit.h"
-#include "fsfw/hal/stm32h7/spi/spiDefinitions.h"
+#include "fsfw-hal/stm32h7/spi/spiDefinitions.h"
-#include "fsfw/hal/stm32h7/spi/spiCore.h"
+#include "fsfw-hal/stm32h7/spi/spiCore.h"
-#include "fsfw/hal/stm32h7/spi/spiInterrupts.h"
+#include "fsfw-hal/stm32h7/spi/spiInterrupts.h"
-#include "fsfw/hal/stm32h7/spi/stm32h743ziSpi.h"
+#include "fsfw-hal/stm32h7/spi/stm32h743ziSpi.h"
 
 #include "fsfw/tasks/TaskFactory.h"
 #include "fsfw/serviceinterface/ServiceInterface.h"

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

@@ -1,4 +1,4 @@
-#include <fsfw/hal/stm32h7/dma.h>
+#include <fsfw-hal/stm32h7/dma.h>
 
 #include <cstdint>
 #include <cstddef>

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

@@ -1,4 +1,4 @@
-#include "fsfw/hal/stm32h7/gpio/gpio.h"
+#include "fsfw-hal/stm32h7/gpio/gpio.h"
 
 #include "stm32h7xx_hal_rcc.h"
 

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

@@ -1,11 +1,11 @@
-#include "fsfw/hal/stm32h7/spi/SpiComIF.h"
+#include "fsfw-hal/stm32h7/spi/SpiComIF.h"
-#include "fsfw/hal/stm32h7/spi/SpiCookie.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/spiCore.h"
-#include "fsfw/hal/stm32h7/spi/spiInterrupts.h"
+#include "fsfw-hal/stm32h7/spi/spiInterrupts.h"
-#include "fsfw/hal/stm32h7/spi/mspInit.h"
+#include "fsfw-hal/stm32h7/spi/mspInit.h"
-#include "fsfw/hal/stm32h7/gpio/gpio.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

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

@@ -5,7 +5,7 @@
 #include "fsfw/devicehandlers/DeviceCommunicationIF.h"
 #include "fsfw/objectmanager/SystemObject.h"
 
-#include "fsfw/hal/stm32h7/spi/spiDefinitions.h"
+#include "fsfw-hal/stm32h7/spi/spiDefinitions.h"
 #include "stm32h7xx_hal_spi.h"
 #include "stm32h743xx.h"
 

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

@@ -1,4 +1,4 @@
-#include "fsfw/hal/stm32h7/spi/SpiCookie.h"
+#include "fsfw-hal/stm32h7/spi/SpiCookie.h"
 
 
 SpiCookie::SpiCookie(address_t deviceAddress, spi::SpiBus spiIdx, spi::TransferModes transferMode,

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

@@ -1,7 +1,7 @@
-#include "fsfw/hal/stm32h7/dma.h"
+#include "fsfw-hal/stm32h7/dma.h"
-#include "fsfw/hal/stm32h7/spi/mspInit.h"
+#include "fsfw-hal/stm32h7/spi/mspInit.h"
-#include "fsfw/hal/stm32h7/spi/spiCore.h"
+#include "fsfw-hal/stm32h7/spi/spiCore.h"
-#include "fsfw/hal/stm32h7/spi/spiInterrupts.h"
+#include "fsfw-hal/stm32h7/spi/spiInterrupts.h"
 
 #include "stm32h743xx.h"
 #include "stm32h7xx_hal_spi.h"

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

@@ -1,5 +1,5 @@
-#include "fsfw/hal/stm32h7/spi/spiCore.h"
+#include "fsfw-hal/stm32h7/spi/spiCore.h"
-#include "fsfw/hal/stm32h7/spi/spiDefinitions.h"
+#include "fsfw-hal/stm32h7/spi/spiDefinitions.h"
 
 #include <cstdio>
 

hal/src/fsfw-hal/stm32h7/spi/spiCore.h

@@ -1,8 +1,8 @@
 #ifndef FSFW_HAL_STM32H7_SPI_SPICORE_H_
 #define FSFW_HAL_STM32H7_SPI_SPICORE_H_
 
-#include "fsfw/hal/stm32h7/dma.h"
+#include "fsfw-hal/stm32h7/dma.h"
-#include "fsfw/hal/stm32h7/spi/spiDefinitions.h"
+#include "fsfw-hal/stm32h7/spi/spiDefinitions.h"
 
 #include "stm32h7xx_hal.h"
 #include "stm32h7xx_hal_dma.h"

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

@@ -1,4 +1,4 @@
-#include "fsfw/hal/stm32h7/spi/spiDefinitions.h"
+#include "fsfw-hal/stm32h7/spi/spiDefinitions.h"
 
 void spi::assignSpiMode(SpiModes spiMode, SPI_HandleTypeDef& spiHandle) {
     switch(spiMode) {

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

@@ -1,5 +1,5 @@
-#include "fsfw/hal/stm32h7/spi/spiInterrupts.h"
+#include "fsfw-hal/stm32h7/spi/spiInterrupts.h"
-#include "fsfw/hal/stm32h7/spi/spiCore.h"
+#include "fsfw-hal/stm32h7/spi/spiCore.h"
 
 #include "stm32h7xx_hal.h"
 #include "stm32h7xx_hal_dma.h"

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

@@ -1,6 +1,6 @@
-#include "fsfw/hal/stm32h7/spi/stm32h743ziSpi.h"
+#include "fsfw-hal/stm32h7/spi/stm32h743ziSpi.h"
-#include "fsfw/hal/stm32h7/spi/spiCore.h"
+#include "fsfw-hal/stm32h7/spi/spiCore.h"
-#include "fsfw/hal/stm32h7/spi/spiInterrupts.h"
+#include "fsfw-hal/stm32h7/spi/spiInterrupts.h"
 
 #include "stm32h7xx_hal.h"
 #include "stm32h7xx_hal_rcc.h"

hal/src/fsfw/CMakeLists.txt

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

src/fsfw/FSFW.h.in

@@ -9,5 +9,10 @@
 #cmakedefine FSFW_ADD_COORDINATES
 #cmakedefine FSFW_ADD_PUS
 #cmakedefine FSFW_ADD_MONITORING
+#cmakedefine FSFW_ADD_SGP4_PROPAGATOR
+
+#ifndef FSFW_HAL_L3GD20_GYRO_DEBUG
+#define FSFW_HAL_L3GD20_GYRO_DEBUG   0
+#endif /* FSFW_HAL_L3GD20_GYRO_DEBUG */
 
 #endif /* FSFW_FSFW_H_ */

src/fsfw/coordinates/Sgp4Propagator.h

@@ -7,7 +7,7 @@
 #ifndef PLATFORM_WIN
 #include <sys/time.h>
 #endif
-#include "fsfw/contrib/sgp4/sgp4unit.h"
+#include "fsfw-contrib/sgp4/sgp4unit.h"
 #include "fsfw/returnvalues/HasReturnvaluesIF.h"
 
 class Sgp4Propagator {

src/fsfw/coordinates/coordinatesConf.h

@@ -8,4 +8,9 @@
     not enabled with FSFW_ADD_COORDINATES
 #endif
 
+#ifndef FSFW_ADD_SGP4_PROPAGATOR
+#warning Coordinates files were included but SGP4 contributed code compilation was \
+    not enabled with FSFW_ADD_SGP4_PROPAGATOR
+#endif
+
 #endif /* FSFW_SRC_FSFW_COORDINATES_COORDINATESCONF_H_ */

src/fsfw/serviceinterface/ServiceInterface.h

@@ -1,7 +1,7 @@
 #ifndef FSFW_SERVICEINTERFACE_SERVICEINTERFACE_H_
 #define FSFW_SERVICEINTERFACE_SERVICEINTERFACE_H_
 
-#include <FSFWConfig.h>
+#include "fsfw/FSFW.h"
 #include "serviceInterfaceDefintions.h"
 
 #if FSFW_CPP_OSTREAM_ENABLED == 1

tests/src/CMakeLists.txt

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

tests/src/fsfw-tests/internal/InternalUnitTester.cpp

@@ -1,11 +1,11 @@
-#include "fsfw/tests/internal/InternalUnitTester.h"
+#include "fsfw-tests/internal/InternalUnitTester.h"
-#include "fsfw/tests/internal/UnittDefinitions.h"
+#include "fsfw-tests/internal/UnittDefinitions.h"
 
-#include "fsfw/tests/internal/osal/IntTestMq.h"
+#include "fsfw-tests/internal/osal/IntTestMq.h"
-#include "fsfw/tests/internal/osal/IntTestSemaphore.h"
+#include "fsfw-tests/internal/osal/IntTestSemaphore.h"
-#include "fsfw/tests/internal/osal/IntTestMutex.h"
+#include "fsfw-tests/internal/osal/IntTestMutex.h"
-#include "fsfw/tests/internal/serialize/IntTestSerialization.h"
+#include "fsfw-tests/internal/serialize/IntTestSerialization.h"
-#include "fsfw/tests/internal/globalfunctions/TestArrayPrinter.h"
+#include "fsfw-tests/internal/globalfunctions/TestArrayPrinter.h"
 
 #include <cstdlib>
 

tests/src/fsfw-tests/internal/UnittDefinitions.cpp

@@ -1,4 +1,4 @@
-#include "fsfw/tests/internal/UnittDefinitions.h"
+#include "fsfw-tests/internal/UnittDefinitions.h"
 
  ReturnValue_t unitt::put_error(std::string errorId) {
 #if FSFW_CPP_OSTREAM_ENABLED == 1

tests/src/fsfw-tests/internal/globalfunctions/TestArrayPrinter.cpp

@@ -1,4 +1,4 @@
-#include "fsfw/tests/internal/globalfunctions/TestArrayPrinter.h"
+#include "fsfw-tests/internal/globalfunctions/TestArrayPrinter.h"
 
 void arrayprinter::testArrayPrinter() {
     {

tests/src/fsfw-tests/internal/osal/IntTestMq.cpp

@@ -1,5 +1,5 @@
-#include "fsfw/tests/internal/osal/IntTestMq.h"
+#include "fsfw-tests/internal/osal/IntTestMq.h"
-#include "fsfw/tests/internal/UnittDefinitions.h"
+#include "fsfw-tests/internal/UnittDefinitions.h"
 
 #include <fsfw/ipc/MessageQueueIF.h>
 #include <fsfw/ipc/QueueFactory.h>

tests/src/fsfw-tests/internal/osal/IntTestMutex.cpp

@@ -1,5 +1,5 @@
-#include "fsfw/tests/internal/osal/IntTestMutex.h"
+#include "fsfw-tests/internal/osal/IntTestMutex.h"
-#include "fsfw/tests/internal/UnittDefinitions.h"
+#include "fsfw-tests/internal/UnittDefinitions.h"
 
 #include <fsfw/ipc/MutexFactory.h>
 

tests/src/fsfw-tests/internal/osal/IntTestSemaphore.cpp

@@ -1,5 +1,5 @@
-#include "fsfw/tests/internal/osal/IntTestSemaphore.h"
+#include "fsfw-tests/internal/osal/IntTestSemaphore.h"
-#include "fsfw/tests/internal/UnittDefinitions.h"
+#include "fsfw-tests/internal/UnittDefinitions.h"
 
 #include <fsfw/tasks/SemaphoreFactory.h>
 #include <fsfw/serviceinterface/ServiceInterface.h>

tests/src/fsfw-tests/internal/serialize/IntTestSerialization.cpp

@@ -1,5 +1,5 @@
-#include "fsfw/tests/internal/serialize/IntTestSerialization.h"
+#include "fsfw-tests/internal/serialize/IntTestSerialization.h"
-#include "fsfw/tests/internal/UnittDefinitions.h"
+#include "fsfw-tests/internal/UnittDefinitions.h"
 
 #include <fsfw/serialize/SerializeElement.h>
 #include <fsfw/serialize/SerialBufferAdapter.h>