ironside: Generate periphconf from Zephyr images instead of sysbuild

SebastianBoe · SebastianBoe · commit e2028387a558 · 2025-09-09T09:12:23.000+02:00
Rewrite the periphconf CMake code to have each individual Zephyr image
generate periphconf instead of doing it from the sysbuild image.

This aligns better with how upstream has moved gen_uicr.py out of
SYSBUILD.

Also, add a sample that uses this infrastructure.

Signed-off-by: Sebastian Bøe &lt;sebastian.boe@nordicsemi.no&gt;
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -35,9 +35,3 @@ add_subdirectory(subsys)
 add_subdirectory(modules)
 add_subdirectory(drivers)
 add_subdirectory(tests)
-
-# TEMPHACK: Add a source file generated by cmake/sysbuild/periphconf_migrate.cmake
-if(SYSBUILD AND CONFIG_NRF_HALTIUM_GENERATE_UICR)
-  file(TOUCH ${APPLICATION_BINARY_DIR}/../periphconf_migrated.c)
-  zephyr_sources(${APPLICATION_BINARY_DIR}/../periphconf_migrated.c)
-endif()
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -527,6 +527,7 @@
 /samples/nrf5340/empty_app_core/          @nrfconnect/ncs-si-muffin
 /samples/nrf5340/extxip_smp_svr/          @nrfconnect/ncs-pluto
 /samples/nrf54h20/empty_app_core/         @nrfconnect/ncs-aurora
+/samples/ironside_se/                     @nrfconnect/ncs-aurora
 /samples/nrf_compress/                    @nordicjm
 /samples/nrf_profiler/                    @nrfconnect/ncs-si-bluebagel
 /samples/nrf_rpc/protocols_serialization/ @nrfconnect/ncs-protocols-serialization
@@ -637,6 +638,7 @@
 /samples/event_manager_proxy/*.rst        @nrfconnect/ncs-si-muffin-doc
 /samples/gazell/**/*.rst                  @nrfconnect/ncs-si-muffin-doc
 /samples/hw_id/*.rst                      @nrfconnect/ncs-cia-doc
+/samples/ironside_se/**/*.rst             @nrfconnect/ncs-aurora-doc
 /samples/ipc/ipc_service/*.rst            @nrfconnect/ncs-si-muffin-doc
 /samples/keys/**/*.rst                    @nrfconnect/ncs-aegir-doc
 /samples/matter/**/*.rst                  @nrfconnect/ncs-matter-doc
diff --git a/cmake/sysbuild/periphconf_migrate.cmake b/cmake/sysbuild/periphconf_migrate.cmake
diff --git a/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst b/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst
@@ -472,6 +472,8 @@ Wi-Fi samples
 Other samples
 -------------
 
+* Added the :ref:`secondary_boot_sample` sample that demonstrates how to build and boot a secondary application image on the nRF54H20 DK.
+
 * :ref:`nrf_profiler_sample` sample:
 
   * Added a new testing step demonstrating how to calculate event propagation statistics.
diff --git a/doc/nrf/samples/other.rst b/doc/nrf/samples/other.rst
@@ -21,5 +21,6 @@ This section lists single |NCS| samples for various uses that are not part of ot
    ../../../samples/mpsl/*/README
    ../../../samples/benchmarks/*/README
    ../../../samples/nrf_compress/*/README
+   ../../../samples/ironside_se/*/README
    ../../../tests/benchmarks/multicore/*/README
    ../../../samples/zephyr/smp_svr_mini_boot/README
diff --git a/samples/ironside_se/secondary_boot_gen_uicr/CMakeLists.txt b/samples/ironside_se/secondary_boot_gen_uicr/CMakeLists.txt
@@ -0,0 +1,15 @@
+#
+# Copyright (c) 2025 Nordic Semiconductor ASA
+#
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+#
+
+cmake_minimum_required(VERSION 3.13.1)
+
+find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
+
+project(secondary_boot_primary)
+
+target_sources(app PRIVATE
+  src/main.c
+  )
diff --git a/samples/ironside_se/secondary_boot_gen_uicr/README.rst b/samples/ironside_se/secondary_boot_gen_uicr/README.rst
@@ -0,0 +1,57 @@
+.. _secondary_boot_sample:
+
+Secondary boot
+##############
+
+.. contents::
+   :local:
+   :depth: 2
+
+This sample demonstrates how to boot a secondary application image on the nRF54H20 DK board, where both the primary and secondary application images print ``Hello World`` messages.
+
+Overview
+********
+
+The sample consists of two applications:
+
+* *Primary Image*: Runs initially on the application core (``cpuapp``), prints a ``Hello World`` message, and includes stub functions for the Secure Domain service calls to boot the secondary image.
+
+* **Secondary Image**: Runs on the same application core (cpuapp/secondary) after the primary image initiates the boot sequence and prints its own hello world message.
+
+Requirements
+************
+
+The sample supports the following development kit:
+
+.. table-from-sample-yaml::
+
+Building and running
+********************
+
+.. |sample path| replace:: :file:`samples/ironside_se/secondary_boot_gen_uicr`
+
+.. include:: /includes/build_and_run_ns.txt
+
+To build the sample for the nRF54H20 DK, run the following command:
+
+.. code-block:: console
+
+   west build -b nrf54h20dk/nrf54h20/cpuapp samples/secondary_boot --sysbuild
+
+The ``--sysbuild`` flag is required as this sample builds multiple images.
+
+To program the sample on the device, run the following command:
+
+.. code-block:: console
+
+   west flash
+
+Sample output
+*************
+
+When the sample runs successfully, you should see output similar to the following:
+
+.. code-block:: console
+
+   [00:00:00.123,456] === Hello World from Primary Image ===
+   [00:00:00.456,789] === Hello World from Secondary Image ===
diff --git a/samples/ironside_se/secondary_boot_gen_uicr/prj.conf b/samples/ironside_se/secondary_boot_gen_uicr/prj.conf
@@ -0,0 +1,14 @@
+#
+# Copyright (c) 2025 Nordic Semiconductor ASA
+#
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+#
+
+# Enable console and UART
+CONFIG_CONSOLE=y
+CONFIG_UART_CONSOLE=y
+
+# Enable printk
+CONFIG_PRINTK=y
+
+CONFIG_NRF_IRONSIDE_BOOTMODE_SERVICE=y
diff --git a/samples/ironside_se/secondary_boot_gen_uicr/sample.yaml b/samples/ironside_se/secondary_boot_gen_uicr/sample.yaml
@@ -0,0 +1,26 @@
+sample:
+  name: Secondary Boot Sample
+  description: |
+    Sample demonstrating secondary application image boot on nRF54H20DK.
+    The primary image prints hello world, calls stub functions for UICR
+    update and secure domain service to boot the secondary image. The
+    secondary image prints its own hello world message.
+
+common:
+  sysbuild: true
+  harness: console
+  harness_config:
+    type: multi_line
+    regex:
+      - "=== Hello World from Primary Image ==="
+      - "=== Hello World from Secondary Image ==="
+
+tests:
+  samples.secondary_boot.nrf54h20dk:
+    tags:
+      - sysbuild
+      - ci_samples_secondary_boot
+    platform_allow:
+      - nrf54h20dk/nrf54h20/cpuapp
+    integration_platforms:
+      - nrf54h20dk/nrf54h20/cpuapp
diff --git a/samples/ironside_se/secondary_boot_gen_uicr/secondary/CMakeLists.txt b/samples/ironside_se/secondary_boot_gen_uicr/secondary/CMakeLists.txt
@@ -0,0 +1,11 @@
+# Copyright (c) 2025 Nordic Semiconductor ASA
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+
+cmake_minimum_required(VERSION 3.13.1)
+find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
+project(secondary_boot_secondary)
+
+# Create empty marker file at configure-time
+file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/is_secondary_firmware.txt "")
+
+target_sources(app PRIVATE src/main.c)
diff --git a/samples/ironside_se/secondary_boot_gen_uicr/secondary/prj.conf b/samples/ironside_se/secondary_boot_gen_uicr/secondary/prj.conf
@@ -0,0 +1,7 @@
+#
+# Copyright (c) 2025 Nordic Semiconductor ASA
+#
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+#
+
+# NB: Using device tree overlay to set chosen code-partition to secondary_partition
diff --git a/samples/ironside_se/secondary_boot_gen_uicr/secondary/secondary_partition.overlay b/samples/ironside_se/secondary_boot_gen_uicr/secondary/secondary_partition.overlay
@@ -0,0 +1,11 @@
+/*
+ * Copyright (c) 2025 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+ */
+
+/ {
+	chosen {
+		zephyr,code-partition = &secondary_partition;
+	};
+};
diff --git a/samples/ironside_se/secondary_boot_gen_uicr/secondary/src/main.c b/samples/ironside_se/secondary_boot_gen_uicr/secondary/src/main.c
@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2025 Nordic Semiconductor ASA.
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+ */
+
+#include <zephyr/kernel.h>
+#include <zephyr/sys/printk.h>
+
+int main(void)
+{
+	printk("=== Hello World from Secondary Image ===\n");
+
+	printk("Secondary image initialization complete\n");
+
+	/* Keep the secondary image running */
+	while (1) {
+		k_msleep(3000);
+		printk("Secondary image heartbeat\n");
+	}
+
+	return 0;
+}
diff --git a/samples/ironside_se/secondary_boot_gen_uicr/src/main.c b/samples/ironside_se/secondary_boot_gen_uicr/src/main.c
@@ -0,0 +1,31 @@
+/*
+ * Copyright (c) 2025 Nordic Semiconductor ASA.
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+ */
+
+#include <zephyr/kernel.h>
+#include <zephyr/sys/printk.h>
+#include <nrf_ironside/bootmode.h>
+#include <string.h>
+
+int main(void)
+{
+	int err;
+
+	printk("=== Hello World from Primary Image ===\n");
+
+	printk("Booting secondary image\n");
+	err = ironside_bootmode_secondary_reboot(NULL, 0);
+	if (err != 0) {
+		printk("Secondary image boot failed: %d\n", err);
+		return err;
+	}
+
+	while (1) {
+		printk("FAILURE: Primary should not be running - secondary boot failed\n");
+		k_msleep(1000);
+	}
+
+	return 0;
+}
diff --git a/samples/ironside_se/secondary_boot_gen_uicr/sysbuild.conf b/samples/ironside_se/secondary_boot_gen_uicr/sysbuild.conf
@@ -0,0 +1,5 @@
+# Copyright (c) 2025 Nordic Semiconductor ASA
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+
+# Select secondary boot image with UICR generation
+SB_CONFIG_SECONDARY_BOOT_GEN_UICR=y
diff --git a/samples/ironside_se/secondary_boot_gen_uicr/sysbuild/uicr.conf b/samples/ironside_se/secondary_boot_gen_uicr/sysbuild/uicr.conf
@@ -0,0 +1,6 @@
+# Copyright (c) 2025 Nordic Semiconductor ASA
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+
+# Configuration overlay for uicr image
+# Enable UICR.SECONDARY.ENABLE
+CONFIG_GEN_UICR_SECONDARY=y
diff --git a/subsys/CMakeLists.txt b/subsys/CMakeLists.txt
@@ -62,6 +62,7 @@ add_subdirectory_ifdef(CONFIG_AUDIO_MODULE audio_module)
 add_subdirectory_ifdef(CONFIG_AUDIO_MODULE_TEMPLATE audio/audio_module_template)
 add_subdirectory_ifdef(CONFIG_UART_ASYNC_ADAPTER uart_async_adapter)
 add_subdirectory_ifdef(CONFIG_SDFW_SERVICES_ENABLED sdfw_services)
+add_subdirectory_ifdef(CONFIG_NRF_PERIPHCONF_MIGRATE periphconf)
 add_subdirectory_ifdef(CONFIG_DULT dult)
 add_subdirectory_ifdef(CONFIG_NRF_COMPRESS nrf_compress)
 add_subdirectory(mgmt/mcumgr)
diff --git a/subsys/Kconfig b/subsys/Kconfig
@@ -36,6 +36,7 @@ rsource "audio/audio_module_template/Kconfig"
 rsource "uart_async_adapter/Kconfig"
 rsource "trusted_storage/Kconfig"
 rsource "secure_storage/Kconfig"
+rsource "periphconf/Kconfig"
 rsource "logging/Kconfig"
 rsource "sdfw_services/Kconfig"
 rsource "dult/Kconfig"
diff --git a/subsys/periphconf/CMakeLists.txt b/subsys/periphconf/CMakeLists.txt
@@ -0,0 +1,31 @@
+# Copyright (c) 2025 Nordic Semiconductor ASA
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+
+find_program(NRF_REGTOOL nrf-regtool REQUIRED)
+
+execute_process(
+  COMMAND
+  ${CMAKE_COMMAND} -E env PYTHONPATH=${ZEPHYR_BASE}/scripts/dts/python-devicetree/src
+  ${NRF_REGTOOL}
+  uicr-compile
+  --edt-pickle-file ${EDT_PICKLE}
+  --product-name ${CONFIG_SOC}
+  --output-file ${PROJECT_BINARY_DIR}/uicr_legacy.hex
+  WORKING_DIRECTORY ${APPLICATION_SOURCE_DIR}
+  COMMAND_ERROR_IS_FATAL ANY
+  )
+
+execute_process(
+  COMMAND
+  ${CMAKE_COMMAND} -E env PYTHONPATH=${ZEPHYR_BASE}/scripts/dts/python-devicetree/src
+  ${NRF_REGTOOL}
+  uicr-migrate
+  --edt-pickle-file ${EDT_PICKLE}
+  --uicr-hex-file ${PROJECT_BINARY_DIR}/uicr_legacy.hex
+  --output-periphconf-file ${PROJECT_BINARY_DIR}/periphconf_migrated.c
+  WORKING_DIRECTORY ${APPLICATION_SOURCE_DIR}
+  COMMAND_ERROR_IS_FATAL ANY
+  )
+message(STATUS "Generated periphconf_migrated.c: ${PROJECT_BINARY_DIR}/periphconf_migrated.c")
+
+zephyr_sources(${PROJECT_BINARY_DIR}/periphconf_migrated.c)
diff --git a/subsys/periphconf/Kconfig b/subsys/periphconf/Kconfig
@@ -0,0 +1,18 @@
+# Copyright (c) 2025 Nordic Semiconductor
+# SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
+
+# Periphconf integration
+
+config NRF_PERIPHCONF_MIGRATE
+	bool "Generate periphconf_migrated.c"
+	default y
+	depends on SOC_NRF54H20_CPURAD
+	depends on SOC_NRF54H20_CPUAPP
+	help
+	  Enable autogenerating UICR.PERIPHCONF tables to migrate an
+	  existing project for running with IronSide SE. Disable when
+	  providing your own UICR.PERIPHCONF file.
+
+	  Note that PPR and FLPR are in the global domain, and
+	  generation of periphconf_migrated.c is only supported for local
+	  domains.
diff --git a/sysbuild/CMakeLists.txt b/sysbuild/CMakeLists.txt
diff --git a/sysbuild/Kconfig.periphconf b/sysbuild/Kconfig.periphconf
diff --git a/sysbuild/Kconfig.secondary b/sysbuild/Kconfig.secondary
diff --git a/sysbuild/Kconfig.sysbuild b/sysbuild/Kconfig.sysbuild
diff --git a/sysbuild/secondary.cmake b/sysbuild/secondary.cmake
diff --git a/west.yml b/west.yml
