fix(cmake): fix custom targets

.github/workflows/run_checks.yml

@@ -66,9 +66,7 @@ jobs:
     runs-on: ubuntu-latest
     needs:
       - clang-format
-    strategy:
-      matrix:
-        config: [1, 2]
+
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
@@ -83,20 +81,17 @@ jobs:
           sudo apt install -y ninja-build
       - name: Setup CMake
         run: |
-          cmake -B build/unit-tests -D UNIT_TEST:BOOL=ON -D CMAKE_BUILD_TYPE=DEBUG -D REVISION=${{ matrix.config }} -G Ninja .
+          cmake -B build/host -D UNIT_TEST:BOOL=ON -D CMAKE_BUILD_TYPE=DEBUG -D ELASTIC_AI_TARGET=HOST -G Ninja .
       - name: Build Targets
         run: |
-          cmake --build build/unit-tests -j 4
+          cmake --build build/host -j 4
       - name: Run Unit-Tests
-        run: ctest --test-dir build/unit-tests/test/unit --output-on-failure
+        run: ctest --test-dir build/host/test/unit --output-on-failure
 
   build_all_targets:
     runs-on: ubuntu-latest
     needs:
       - unit-tests
-    strategy:
-      matrix:
-        config: [1, 2]
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
@@ -107,7 +102,7 @@ jobs:
           sudo apt update && sudo apt install -y ninja-build gcc-arm-none-eabi graphviz
       - name: Setup CMake
         run: |
-          cmake -B build -D CMAKE_BUILD_TYPE=RELEASE -D REVISION=${{ matrix.config }} -G Ninja .
+          cmake -B build -D CMAKE_BUILD_TYPE=RELEASE -D ELASTIC_AI_TARGET=ENV5_REV2 -G Ninja .
       - name: Build Targets
         run: |
           cmake --build build

CMakeLists.txt

@@ -1,69 +1,64 @@
 cmake_minimum_required(VERSION 3.20...3.24)
-include(helpers.cmake)
+
+include(cmake/set_build_target.cmake)
+
+
+include(cmake/third_party_deps.cmake)
+
+add_pico_sdk("2.0.0")
+add_unity()
+add_cexception()
+add_runtime_c()
+
+
 
 set(CMAKE_EXPORT_COMPILE_COMMANDS 1)
 
-# enable debug prints
 if (DEBUG_OUTPUT)
     add_definitions(-DDEBUG_MODE)
 endif ()
 
-if (UNIT_TEST)
-    message(NOTICE "INFO: Building for local machine")
-else ()
-    message(NOTICE "INFO: Building for enV5 hardware (Type: ${CMAKE_BUILD_TYPE})")
-    setupPicoSdk("2.0.0")
-endif ()
-
 project(enV5 C CXX ASM)
 
-# enable test execution via CMake
+
+pico_sdk_init()
+
+include(cmake/custom_targets.cmake)
+include(cmake/pico_targets.cmake)
+
 include(CTest)
 
-# include unit-test framework
-add_unity()
 
-# include required standard libs for testing
 
-if(UNIT_TEST)
-    add_runtime_c()
-    add_cexception()
+add_freertos()
+
+if(BUILDING_FOR_ELASTIC_NODE)
+    add_subdirectory(test/hardware)
+    add_subdirectory(src)
+else()
+    add_compile_options(-ftrapv) # abort execution on integer overflow
+
     add_subdirectory(src/common)
-    add_subdirectory(src/network/atCommands)
-    add_subdirectory(src/network/config)
-
-    # include dummies for local machine
-    add_subdirectory(test/unit/dummies)
-
-    # include our own libraries to test
-    add_subdirectory(src/hal/enV5HwConfiguration)
-    add_subdirectory(src/sensor/sht3x)
-    add_subdirectory(src/sensor/adxl345b)
-    add_subdirectory(src/sensor/pac193x)
-    add_subdirectory(src/network/wifi)
-    add_subdirectory(src/network/http)
-    add_subdirectory(src/network/broker)
-    add_subdirectory(src/fpga/fpgaConfigurationHandler)
     add_subdirectory(src/filesystem)
+    add_subdirectory(src/flash)
+    add_subdirectory(src/fpga/fpgaConfigurationHandler)
+    add_subdirectory(src/hal)
+    add_subdirectory(src/network)
+    add_subdirectory(src/rtos)
+    add_subdirectory(src/sensor)
+    add_subdirectory(src/usb_protocol)
 
-    # include unit-tests
     add_subdirectory(test/unit)
-else ()
-    pico_sdk_init()
-
-    if (TARGET tinyusb_device)
-        # include required libraries
-        add_basic_functionality()
-        add_freertos_kernel()
-
-        add_rp2040_hal()
-        add_sensor_libraries()
-
-        # include hardware tests
-        add_subdirectory(test/hardware)
+    add_subdirectory(test/unit/Pac193x)
+    add_subdirectory(test/unit/FpgaConfigurationHandler)
+    add_subdirectory(test/unit/Http)
+    add_subdirectory(test/unit/Network)
+    add_subdirectory(test/unit/MqttBroker)
+    add_subdirectory(test/unit/Sht3x)
+endif ()
 
-        add_dependency_graph()
-    elseif (PICO_ON_DEVICE)
-        message(WARNING "Not building Project, because TinyUSB submodule is not initialized in the SDK!")
-    endif ()
+if(BUILDING_FOR_ELASTIC_NODE AND NOT TARGET tinyusb_device)
+    message(WARNING "not building project, because tinyusb not initialized")
+else()
 endif ()
+

CMakePresets.json

@@ -0,0 +1,76 @@
+{
+  "version": 6,
+  "cmakeMinimumRequired": {
+    "major": 3,
+    "minor": 20,
+    "patch": 0
+  },
+  "configurePresets": [
+    {
+      "name": "host",
+      "displayName": "Host Config",
+      "description": "Build for your host system (MacOs, Linux, Windows)",
+      "generator": "Ninja",
+      "binaryDir": "build/host/",
+      "cacheVariables": {
+        "ELASTIC_AI_TARGET": "HOST",
+        "CMAKE_BUILD_TYPE": "Release"
+      }
+    },
+    {
+      "name": "env5_rev2",
+      "displayName": "EnV5 Rev2",
+      "generator": "Ninja",
+      "binaryDir": "build/env5_rev2",
+      "cacheVariables": {
+        "ELASTIC_AI_TARGET": "ENV5_REV2",
+        "CMAKE_BUILD_TYPE": "Release"
+      }
+    },
+    {
+      "name": "env5_rev2_debug",
+      "displayName": "EnV5 Rev2 Debug",
+      "generator": "Ninja",
+      "binaryDir": "build/env5_rev2_debug",
+      "cacheVariables": {
+        "ELASTIC_AI_TARGET": "ENV5_REV2",
+        "CMAKE_BUILD_TYPE": "Debug",
+        "DEBUG_MODE": "ON"
+      }
+    }
+  ],
+  "buildPresets": [
+    {
+      "name": "host",
+      "configurePreset": "host",
+      "jobs": 4
+    },
+    {
+      "name": "env5_rev2",
+      "configurePreset": "env5_rev2",
+      "jobs": 6
+    },
+    {
+      "name": "unit_test",
+      "inherits": "host",
+      "targets": "all_unit_tests"
+    }
+  ],
+  "testPresets": [
+    {
+      "name": "unit_test",
+      "displayName": "Unit Tests",
+      "configurePreset": "host",
+      "output": {
+        "outputJUnitFile": "unit-test.junit",
+        "outputOnFailure": true
+      },
+      "filter": {
+        "include": {
+          "label": "unit"
+        }
+      }
+
+    }
+  ]
+}

cmake/Readme.adoc

@@ -0,0 +1,49 @@
+== Cmake Scripts
+
+=== Encapsulated Libraries
+
+We want to have the following goals
+
+- fine-grained control over dependencies for flexibility and to facilitate link-time substitution
+- prevent access to header files of transitive dependencies, i.e., if you call a function defined in `libB` you have to explicitly depend on it. There should not be a way to include a header provided by `B` without declaring that explicit dependency. This way, we avoid hidden source code dependencies. And each module only sees the header files it actually needs.
+- for convenience, we want to have a target combines implementation and headers.
+
+We achieve these by (typically) defining four build targets for each of our modules. Assuming we want to define a new library `A` that performs a direct call to library `B`. Then we define
+
+`A__hdrs`:: providing access to all public header files of our module `A`, e.g.,
++
+[source, cmake]
+----
+add_library(A__hdrs INTERFACE)
+target_include_directories(A__hdrs INTERFACE include)
+----
+`A__impl`:: containing the implementation of `A`. This target needs access to the headers of its dependent modules, e.g.,
++
+[source, cmake]
+----
+add_library(A__impl A.c)
+target_link_libraries(A__impl PRIVATE B__hdrs)
+----
++
+`A`:: providing access to public headers for consuming targets (e.g., executables) and transitively providing dependent library implementations
+[source, cmake]
+----
+add_library(A INTERFACE)
+target_link_libraries(A INTERFACE A__impl A__hdrs)
+----
+
+Currently, the `elastic_ai_add_library` function provides most of this functionality. However, using it will prevent the IDE from automatically discovering your targets for the sake of jump-to-definition and auto-completion.
+
+=== Building HW Dependent Libs
+The build scripts will set a global variable `BUILDING_FOR_ELASTIC_NODE` to `true` iff we're building for an elastic node hardware.
+If you need to define a HW dependent lib, e.g., because it calls into the pico_sdk, you should ask for that flag and define the `__impl` as an empty interface target. E.g.,
+
+[source, cmake]
+----
+if(BUILDING_FOR_ELASTIC_NODE)
+  add_library(A__impl A.c)
+  target_link_libraries(A__impl PRIVATE Pico::pico_runtime__hdrs)
+else()
+  add_library(A__impl INTERFACE)
+endif ()
+----