sys/runtime_config: add runtime configuration

doc/doxygen/riot.doxyfile

@@ -1481,7 +1481,11 @@ HTML_EXTRA_FILES       = src/css/bootstrap.min.css \
                          src/js/riot-doxy.js \
                          ../../sys/net/application_layer/unicoap/docs/unicoap-layers.svg \
                          ../../sys/net/application_layer/unicoap/docs/unicoap-layers-comms.svg \
-                         ../../sys/net/application_layer/unicoap/docs/unicoap-layers-comms-apis.svg
+                         ../../sys/net/application_layer/unicoap/docs/unicoap-layers-comms-apis.svg\
+                         ../../sys/runtime_config/docs/api_structure.svg\
+                         ../../sys/runtime_config/docs/architecture.svg\
+                         ../../sys/runtime_config/docs/namespaces_and_storages.svg\
+                         ../../sys/runtime_config/docs/runtime_config.svg
 
 # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output
 # should be rendered with a dark or light theme.

examples/README.md

@@ -128,7 +128,6 @@ Here is a quick overview of the examples available in the RIOT:
 | [sock_tcp_echo](./networking/misc/sock_tcp_echo/README.md) | This is a simple TCP echo server / client that uses the SOCK API. |
 | [lwip_ipv4](./networking/misc/lwip_ipv4/README.md) | This is a simple UDP client / server using LWIP for IPv4. |
 
-
 ## Advanced Examples
 
 | Example | Description |
@@ -144,6 +143,7 @@ Here is a quick overview of the examples available in the RIOT:
 | [senml_saul](./advanced/senml_saul/README.md) | This example demonstrates the usage of the SAUL (Sensor Actuator Uber Layer) module with the SenML (Sensor Measurement Lists) format. |
 | [opendsme](./advanced/opendsme/README.md) | This example demonstrates the usage of the OpenDSME module in RIOT. |
 | [xipfs](./advanced/xipfs/README.md) | This example demonstrates the usage of XIPFS for creating and executing an executable file. |
+| [runtime_config_core](./advanced/runtime_config/runtime_config_core/README.md) | This example demonstrates the most basic usage of the `Runtime configuration` module. |
 
 ## Examples from Guides
 

examples/advanced/runtime_config/runtime_config_core/Makefile

@@ -0,0 +1,24 @@
+# name of the application
+APPLICATION = runtime_config_example_core
+
+# If no BOARD is found in the environment, use this default:
+BOARD ?= native
+
+# This has to be the absolute path to the RIOT base directory:
+RIOTBASE ?= $(CURDIR)/../../../..
+
+# required modules
+# enable board_led schema (sys/board_led) of the Runtime configuration module
+USEMODULE += runtime_config_namespace_sys_board_led
+# enable the ztimer to turn the led on and off every second
+USEMODULE += ztimer_sec
+
+# Comment this out to disable code in RIOT that does safety checking
+# which is not needed in a production environment but helps in the
+# development process:
+DEVELHELP ?= 1
+
+# Change this to 0 show compiler invocation lines by default:
+QUIET ?= 1
+
+include $(RIOTBASE)/Makefile.include

examples/advanced/runtime_config/runtime_config_core/README.md

@@ -0,0 +1,14 @@
+# Runtime Configuration Core
+
+This application demonstrates the most basic usage of the `Runtime configuration` module.
+It implements a BOARD LED schema and continuously changes its value every second.
+
+## Usage
+
+Simply build and flash the application for your target board:
+
+```shell
+BOARD=YOUR_BOARD_NAME_HERE make flash term
+```
+
+Now you should see the terminal continuously print out different LED states.

examples/advanced/runtime_config/runtime_config_core/main.c

@@ -0,0 +1,106 @@
+/*
+ * SPDX-FileCopyrightText: 2023-2026 Lasse Rosenow <lasse.rosenow@haw-hamburg.de>
+ * SPDX-FileCopyrightText: 2023-2026 HAW Hamburg
+ * SPDX-License-Identifier: LGPL-2.1-only
+ */
+
+/**
+ * @ingroup     examples
+ * @{
+ *
+ * @file
+ * @brief       Runtime configuration core minimal example application to demonstrate
+ *              how to use the "Runtime configuration" module without any of its extensions.
+ *
+ * @author      Lasse Rosenow <lasse.rosenow@haw-hamburg.de>
+ *
+ * @}
+ */
+
+#include <string.h>
+#include <stdio.h>
+#include <unistd.h>
+
+#include "periph_cpu.h"
+#include "led.h"
+#include "board.h"
+#include "runtime_config.h"
+#include "runtime_config/namespace/sys.h"
+#include "runtime_config/namespace/sys/board_led.h"
+#include "ztimer.h"
+
+/* This callback gets called, when new configurations shall be applied.
+ * If interacting with configurations of drivers then this callback should be
+ * implemented by the driver itself. For custom application logic, we need to
+ * define this for ourselves. */
+static runtime_config_error_t board_led_instance_apply_cb(
+    const runtime_config_group_or_parameter_id_t *group_or_parameter_id,
+    const runtime_config_schema_instance_t *instance)
+{
+    const runtime_config_sys_board_led_instance_t *instance_data = (const runtime_config_sys_board_led_instance_t *)instance->data;
+
+    /* Either apply all parameters of the instance or only the given parameter.
+     * For a single LED there is no difference as it only has one parameter. */
+    if ((group_or_parameter_id == NULL) ||
+        (*group_or_parameter_id == RUNTIME_CONFIG_SYS_BOARD_LED_ENABLED)) {
+        /* Get the correct field from the instance_data variable */
+        bool led_state = instance_data->enabled;
+        /* Turn the LED on or off depending on the led_state */
+        if (led_state == true) {
+            /* This is the apply_cb function of instance 0, so we toggle LED 0 as well */
+            LED_ON(0);
+        }
+        else {
+            LED_OFF(0);
+        }
+    }
+
+    return 0;
+}
+
+/* This belongs into the BOARD or Driver for example */
+static runtime_config_sys_board_led_instance_t board_led_instance_data = {
+    .enabled = 0,
+};
+
+static runtime_config_schema_instance_t board_led_instance = {
+    .data = &board_led_instance_data,
+    .apply_cb = &board_led_instance_apply_cb,
+};
+
+/* This belongs into our main application */
+int main(void)
+{
+    runtime_config_init();
+
+    /* init schemas */
+    runtime_config_add_schema_instance(&runtime_config_sys_board_led, &board_led_instance);
+
+    bool board_led_enabled = false;
+
+    while (true) {
+        /* Invert the BOARD LED, to make it turn on and off on each subsequent cycle */
+        board_led_enabled = !board_led_enabled;
+
+        /* Create runtime_config_node_t for the board_led_parameter */
+        const runtime_config_node_t parameter_node = {
+            .type = RUNTIME_CONFIG_NODE_PARAMETER,
+            .value.parameter = {
+                .instance = &board_led_instance,
+                .parameter = &runtime_config_sys_board_led_enabled,
+            },
+        };
+
+        /* Set new runtime configuration value */
+        runtime_config_set(&parameter_node, &board_led_enabled, sizeof(board_led_enabled));
+
+        /* Apply the runtime configuration value to change the LED state
+         * (in this case calls the apply_cb function: "board_led_instance_apply_cb") */
+        runtime_config_apply(&parameter_node);
+
+        /* Sleep for 1 second and then do it again*/
+        ztimer_sleep(ZTIMER_SEC, 1);
+    }
+
+    return 0;
+}

makefiles/pseudomodules.inc.mk

@@ -355,6 +355,12 @@ PSEUDOMODULES += psa_riot_hashes_sha_512_224
 PSEUDOMODULES += psa_riot_hashes_sha_512_256
 PSEUDOMODULES += psa_riot_hashes_hmac_sha256
 PSEUDOMODULES += fortuna_reseed
+
+# Runtime configuration modules are pseudomodules unless stated otherwise
+PSEUDOMODULES += runtime_config_%
+# Runtime configuration sys schemas
+NO_PSEUDOMODULES += runtime_config_namespace_sys
+
 PSEUDOMODULES += riotboot_%
 PSEUDOMODULES += rtt_cmd
 PSEUDOMODULES += saul_adc

sys/Kconfig

@@ -16,6 +16,7 @@ rsource "fido2/Kconfig"
 rsource "net/Kconfig"
 rsource "progress_bar/Kconfig"
 rsource "psa_crypto/Kconfig"
+rsource "runtime_config/Kconfig"
 rsource "shell/Kconfig"
 rsource "shell_lock/Kconfig"
 rsource "usb/Kconfig"

sys/Makefile

@@ -131,6 +131,9 @@ endif
 ifneq (,$(filter netutils,$(USEMODULE)))
   DIRS += net/netutils
 endif
+ifneq (,$(filter runtime_config,$(USEMODULE)))
+  DIRS += runtime_config
+endif
 ifneq (,$(filter sema,$(USEMODULE)))
   DIRS += sema
 endif

sys/Makefile.dep

@@ -730,4 +730,8 @@ ifneq (,$(filter wifi_scan_list,$(USEMODULE)))
   USEMODULE += l2scan_list
 endif
 
+ifneq (,$(filter runtime_config%,$(USEMODULE)))
+  include $(RIOTBASE)/sys/runtime_config/Makefile.dep
+endif
+
 include $(RIOTBASE)/sys/test_utils/Makefile.dep