Sys Runtime Configuration Registry

examples/registry_cli/Makefile

@@ -0,0 +1,31 @@
+# name of the application
+APPLICATION = registry_example_cli
+
+# 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
+USEMODULE += shell
+USEMODULE += shell_cmds_default
+
+USEMODULE += littlefs2
+USEMODULE += mtd
+
+USEMODULE +=  registry_string_path
+USEMODULE +=  registry_storage_vfs
+USEMODULE +=  registry_namespace_sys_rgb_led
+USEMODULE +=  registry_namespace_tests_full
+USEMODULE +=  registry_namespace_tests_nested
+
+# 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/registry_cli/main.c

@@ -0,0 +1,127 @@
+/*
+ * Copyright (C) 2023 HAW Hamburg
+ *
+ * This file is subject to the terms and conditions of the GNU Lesser
+ * General Public License v2.1. See the file LICENSE in the top level
+ * directory for more details.
+ */
+
+/**
+ * @ingroup     examples
+ * @{
+ *
+ * @file
+ * @brief       RIOT Registry example application
+ *
+ * @author      Lasse Rosenow <[email protected]>
+ *
+ * @}
+ */
+
+#include <string.h>
+#include <stdio.h>
+
+#include "msg.h"
+#include "shell.h"
+#include "board.h"
+#include "mtd.h"
+#include "vfs.h"
+#include "fs/littlefs2_fs.h"
+#include "registry.h"
+#include "registry/namespace/sys.h"
+#include "registry/namespace/sys/rgb_led.h"
+#include "registry/storage.h"
+#include "registry/string_path.h"
+#include "registry/namespace/tests.h"
+#include "registry/namespace/tests/nested.h"
+
+int rgb_led_instance_0_commit_cb(const registry_commit_cb_scope_t scope,
+                                 const registry_group_or_parameter_id_t *group_or_parameter_id,
+                                 const void *context)
+{
+    (void)scope;
+    (void)context;
+    printf("RGB instance commit_cb was executed on ");
+
+    if (group_or_parameter_id != NULL) {
+        printf("param: %d", *group_or_parameter_id);
+    }
+    else {
+        printf("whole instance");
+    }
+
+    printf("\n");
+
+    return 0;
+}
+
+registry_sys_rgb_led_instance_t rgb_led_instance_0_data = {
+    .red = 0,
+    .green = 255,
+    .blue = 70,
+};
+registry_instance_t rgb_led_instance_0 = {
+    .name = "rgb-0",
+    .data = &rgb_led_instance_0_data,
+    .commit_cb = &rgb_led_instance_0_commit_cb,
+};
+
+registry_sys_rgb_led_instance_t rgb_led_instance_1_data = {
+    .red = 90,
+    .green = 4,
+    .blue = 0,
+};
+registry_instance_t rgb_led_instance_1 = {
+    .name = "rgb-1",
+    .data = &rgb_led_instance_1_data,
+    .commit_cb = &rgb_led_instance_0_commit_cb,
+};
+
+static littlefs2_desc_t fs_desc = {
+    .lock = MUTEX_INIT,
+};
+
+static vfs_mount_t _vfs_mount = {
+    .fs = &littlefs2_file_system,
+    .mount_point = "/sda",
+    .private_data = &fs_desc,
+};
+
+static registry_storage_instance_t vfs_instance = {
+    .storage = &registry_storage_vfs,
+    .data = &_vfs_mount,
+};
+
+REGISTRY_ADD_STORAGE_SOURCE(vfs_instance);
+REGISTRY_SET_STORAGE_DESTINATION(vfs_instance);
+
+static registry_tests_nested_instance_t test_nested_instance_data = {
+    .parameter = 9,
+    .group_parameter = 5,
+};
+
+static registry_instance_t test_nested_instance = {
+    .name = "instance-1",
+    .data = &test_nested_instance_data,
+    .commit_cb = NULL,
+};
+
+int main(void)
+{
+    registry_init();
+
+    /* init schemas */
+    registry_add_schema_instance(&registry_sys_rgb_led, &rgb_led_instance_0);
+    registry_add_schema_instance(&registry_sys_rgb_led, &rgb_led_instance_1);
+    registry_add_schema_instance(&registry_tests_nested, &test_nested_instance);
+
+    /* init storage */
+    #if IS_USED(MODULE_LITTLEFS2)
+    fs_desc.dev = MTD_0;
+    #endif
+
+    /* init and run CLI */
+    char line_buf[SHELL_DEFAULT_BUFSIZE];
+    shell_run(NULL, line_buf, sizeof(line_buf));
+    return 0;
+}

examples/registry_core/Makefile

@@ -0,0 +1,22 @@
+# name of the application
+APPLICATION = registry_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
+USEMODULE += registry_namespace_sys_board_led
+USEMODULE += ztimer_msec
+
+# 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/registry_core/main.c

@@ -0,0 +1,107 @@
+/*
+ * Copyright (C) 2023 HAW Hamburg
+ *
+ * This file is subject to the terms and conditions of the GNU Lesser
+ * General Public License v2.1. See the file LICENSE in the top level
+ * directory for more details.
+ */
+
+/**
+ * @ingroup     examples
+ * @{
+ *
+ * @file
+ * @brief       RIOT Registry example application
+ *
+ * @author      Lasse Rosenow <[email protected]>
+ *
+ * @}
+ */
+
+#include <string.h>
+#include <stdio.h>
+#include <unistd.h>
+
+#include "periph_cpu.h"
+#include "led.h"
+#include "board.h"
+#include "registry.h"
+#include "registry/namespace/sys.h"
+#include "registry/namespace/sys/board_led.h"
+#include "ztimer.h"
+
+int board_led_instance_0_commit_cb(const registry_commit_cb_scope_t scope,
+                                 const registry_group_or_parameter_id_t *group_or_parameter_id,
+                                 const void *context);
+
+/* This belongs into the BOARD or Driver for example */
+registry_sys_board_led_instance_t board_led_instance_0_data = {
+    .enabled = 0,
+};
+
+registry_instance_t board_led_instance = {
+    .data = &board_led_instance_0_data,
+    .commit_cb = &board_led_instance_0_commit_cb,
+};
+
+int board_led_instance_0_commit_cb(const registry_commit_cb_scope_t scope,
+                                 const registry_group_or_parameter_id_t *group_or_parameter_id,
+                                 const void *context)
+{
+    (void)scope;
+    (void)context;
+
+    if (group_or_parameter_id != NULL) {
+        if (*group_or_parameter_id == REGISTRY_SYS_BOARD_LED_ENABLED) {
+            /* The Driver owns the board_led data instance, so we can just get our value from there */
+            bool led_state = board_led_instance_0_data.enabled;
+
+            /* Turn the LED on or off depending on the led_state */
+            if (led_state == true) {
+                /* This is the commit_cb function of instance 0, so we toggle LED 0 as well */
+                LED_ON(0);
+            } else {
+                LED_OFF(0);
+            }
+        }
+    }
+    else {
+        /* The whole instance got committed in one go, so apply all parameters (BOARD_LED has only one anyways)*/
+
+        bool led_state = board_led_instance_0_data.enabled;
+        if (led_state == true) {
+            LED_ON(0);
+        } else {
+            LED_OFF(0);
+        }
+    }
+
+    return 0;
+}
+
+/* This belongs into our main application */
+int main(void)
+{
+    registry_init();
+
+    /* init schemas */
+    registry_add_schema_instance(&registry_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;
+
+        /* Set new registry value */
+        registry_set(&board_led_instance, &registry_sys_board_led_enabled, &board_led_enabled, sizeof(board_led_enabled));
+
+        /* Apply the registry value to change the LED state (calls the commit_cb function implemented by the BOARD for example)*/
+        registry_commit_parameter(&board_led_instance, &registry_sys_board_led_enabled);
+
+        /* Sleep for 1 second and then do it again*/
+        ztimer_sleep(ZTIMER_MSEC, 1000);
+    }
+
+    return 0;
+}

makefiles/pseudomodules.inc.mk

@@ -396,6 +396,11 @@ PSEUDOMODULES += fortuna_reseed
 ##              will be removed after 2023.07 release.
 PSEUDOMODULES += random_cmd
 ## @}
+PSEUDOMODULES += registry_%
+NO_PSEUDOMODULES += registry_namespace_sys
+NO_PSEUDOMODULES += registry_namespace_tests
+NO_PSEUDOMODULES += registry_storage
+
 PSEUDOMODULES += riotboot_%
 PSEUDOMODULES += rtt_cmd
 PSEUDOMODULES += saul_adc
@@ -485,6 +490,7 @@ PSEUDOMODULES += shell_cmd_openwsn
 PSEUDOMODULES += shell_cmd_pm
 PSEUDOMODULES += shell_cmd_ps
 PSEUDOMODULES += shell_cmd_random
+PSEUDOMODULES += shell_cmd_registry
 PSEUDOMODULES += shell_cmd_rtc
 PSEUDOMODULES += shell_cmd_rtt
 PSEUDOMODULES += shell_cmd_saul_reg

sys/Kconfig

@@ -94,6 +94,7 @@ rsource "preprocessor/Kconfig"
 rsource "progress_bar/Kconfig"
 rsource "ps/Kconfig"
 rsource "random/Kconfig"
+rsource "registry/Kconfig"
 rsource "rtc_utils/Kconfig"
 rsource "rust_riotmodules/Kconfig"
 rsource "saul_reg/Kconfig"

sys/Makefile

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

sys/Makefile.dep

@@ -694,4 +694,8 @@ ifneq (,$(filter auto_init%,$(USEMODULE)))
   USEMODULE += preprocessor_successor
 endif
 
+ifneq (,$(filter registry%,$(USEMODULE)))
+  include $(RIOTBASE)/sys/registry/Makefile.dep
+endif
+
 include $(RIOTBASE)/sys/test_utils/Makefile.dep

sys/Makefile.include

@@ -188,3 +188,7 @@ endif
 ifneq (,$(filter gcoap,$(USEMODULE)))
   include $(RIOTBASE)/sys/net/application_layer/gcoap/Makefile.include
 endif
+
+ifneq (,$(filter registry%,$(USEMODULE)))
+  include $(RIOTBASE)/sys/registry/Makefile.include
+endif