sysbuild: full example of sysbuild with mcuboot and multiple images

jameswalmsley · jameswalmsley · commit a955764bd90d · 2025-05-18T20:18:04.000+01:00
diff --git a/sysbuild-example/CMakeLists.txt b/sysbuild-example/CMakeLists.txt
@@ -0,0 +1,12 @@
+# SPDX-License-Identifier: Apache-2.0
+# Author: James Walmsley <james@fullfat-fs.co.uk>
+
+cmake_minimum_required(VERSION 3.20.0)
+
+find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
+test_sysbuild(REQUIRED)
+
+project(sysbuild-example)
+
+target_sources(app PRIVATE main_image/src/main.c)
+
diff --git a/sysbuild-example/README.md b/sysbuild-example/README.md
@@ -0,0 +1,15 @@
+# Example Sysbuild Project
+
+The aim of this folder is to demonstrate a typical sysbuild project from the ground-up.
+
+## Build
+
+```
+cd my-workspace/example-application
+west build --sysbuild sysbuild-example \
+    -DEXTRA_DTC_OVERLAY_FILE=(pwd)/sysbuild-example/overlays/nucleo_f413zh_partitions.overlay \
+    -Dmcuboot_EXTRA_DTC_OVERLAY_FILE=(pwd)/sysbuild-example/overlays/nucleo_f413zh_partitions.overlay \
+    -Dmfg_image_EXTRA_DTC_OVERLAY_FILE=(pwd)/sysbuild-example/overlays/nucleo_f413zh_partitions.overlay \
+    -Ddfu_app_EXTRA_DTC_OVERLAY_FILE=(pwd)/sysbuild-example/overlays/nucleo_f413zh_partitions.overlay
+```
+
diff --git a/sysbuild-example/boards/nucleo_f413zh.overlay b/sysbuild-example/boards/nucleo_f413zh.overlay
@@ -0,0 +1,7 @@
+/ {
+	chosen {
+		zephyr,code-partition = &app_partition;
+	};
+};
+
+
diff --git a/sysbuild-example/dfu_app/CMakeLists.txt b/sysbuild-example/dfu_app/CMakeLists.txt
@@ -0,0 +1,9 @@
+# Copyright (c) 2025 James Walmsley <james@fullfat-fs.co.uk>
+# SPDX-License-Identifier: Apache-2.0
+
+cmake_minimum_required(VERSION 3.20.0)
+find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
+
+project(dfu_app)
+target_sources(app PRIVATE src/main.c)
+
diff --git a/sysbuild-example/dfu_app/boards/nucleo_f413zh.overlay b/sysbuild-example/dfu_app/boards/nucleo_f413zh.overlay
@@ -0,0 +1,7 @@
+/ {
+	chosen {
+		zephyr,code-partition = &app_partition;
+	};
+};
+
+
diff --git a/sysbuild-example/dfu_app/prj.conf b/sysbuild-example/dfu_app/prj.conf
@@ -0,0 +1,9 @@
+CONFIG_BOOTLOADER_MCUBOOT=y
+CONFIG_MCUBOOT_SIGNATURE_KEY_FILE="bootloader/mcuboot/root-rsa-2048.pem"
+CONFIG_FLASH=y
+CONFIG_IMG_MANAGER=y
+CONFIG_STREAM_FLASH=y
+CONFIG_USB_DFU_CLASS=y
+CONFIG_USB_DEVICE_STACK=y
+CONFIG_FLASH_MAP=y
+
diff --git a/sysbuild-example/dfu_app/src/main.c b/sysbuild-example/dfu_app/src/main.c
@@ -0,0 +1,15 @@
+/*
+ * Copyright (c) 2025 James Walmsley
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <zephyr/sys/printk.h>
+
+int main(void)
+{
+	printk("Hello world from 2 %s\n", CONFIG_BOARD_TARGET);
+
+	return 0;
+}
+
+
diff --git a/sysbuild-example/main_image/src/main.c b/sysbuild-example/main_image/src/main.c
@@ -0,0 +1,14 @@
+/*
+ * Copyright (c) 2025 James Walmsley
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <zephyr/sys/printk.h>
+
+int main(void)
+{
+	printk("Main image on: %s\n", CONFIG_BOARD_TARGET);
+    return 0;
+}
+
+
diff --git a/sysbuild-example/mfg_image/CMakeLists.txt b/sysbuild-example/mfg_image/CMakeLists.txt
@@ -0,0 +1,9 @@
+# Copyright (c) 2025 James Walmsley <james@fullfat-fs.co.uk>
+# SPDX-License-Identifier: Apache-2.0
+
+cmake_minimum_required(VERSION 3.20.0)
+find_package(Zephyr REQUIRED HINTS $ENV{ZPEHYR_BASE})
+
+project(mfg_image)
+target_sources(app PRIVATE src/main.c)
+
diff --git a/sysbuild-example/mfg_image/boards/nucleo_f413zh.overlay b/sysbuild-example/mfg_image/boards/nucleo_f413zh.overlay
@@ -0,0 +1,7 @@
+/ {
+	chosen {
+		zephyr,code-partition = &app_partition;
+	};
+};
+
+
diff --git a/sysbuild-example/mfg_image/prj.conf b/sysbuild-example/mfg_image/prj.conf
@@ -0,0 +1,2 @@
+CONFIG_BOOTLOADER_MCUBOOT=y
+CONFIG_MCUBOOT_SIGNATURE_KEY_FILE="bootloader/mcuboot/root-rsa-2048.pem"
diff --git a/sysbuild-example/mfg_image/src/main.c b/sysbuild-example/mfg_image/src/main.c
@@ -0,0 +1,14 @@
+/*
+ * Copyright (c) 2025 James Walmsley
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <zephyr/sys/printk.h>
+
+int main(void)
+{
+	printk("Manufacturing image on: %s\n", CONFIG_BOARD_TARGET);
+
+	return 0;
+}
+
diff --git a/sysbuild-example/overlays/nucleo_f413zh_partitions.overlay b/sysbuild-example/overlays/nucleo_f413zh_partitions.overlay
@@ -0,0 +1,42 @@
+/delete-node/ &slot0_partition;
+/delete-node/ &slot1_partition;
+/delete-node/ &scratch_partition;
+
+&flash0 {
+	/*
+	 * Setting the erase/write block sizes for stm32f4xx
+	 * Its not defined in the main dts because the devices
+	 * have varying sector sizes.
+	 *
+	 * However we can use 128K as a working size across
+	 * the mcuboot slots.
+	 */
+    erase-block-size = <DT_SIZE_K(128)>;
+    write-block-size = <1>;
+
+	partitions {
+        /*
+         * 
+         */
+        app_partition: app_partition@a {
+            label = "app-max-size";
+            reg = <0x00020000 DT_SIZE_K(512)>;
+        };
+
+		/*
+		 * This paritition layout is for SWAP_WITH_MOVE, 
+		 * Where the primary slot must be 1 sector bigger than the secondary slot!
+		 */
+		slot0_partition: partition@20000 {
+			label = "image-0";
+			reg = <0x00020000 DT_SIZE_K(512 + 128)>;
+
+		};
+
+		slot1_partition: partition@C0000 {
+			label = "image-1";
+			reg = <0x000C0000 DT_SIZE_K(512)>;
+		};
+	};
+};
+
diff --git a/sysbuild-example/prj.conf b/sysbuild-example/prj.conf
@@ -0,0 +1,7 @@
+CONFIG_BOOTLOADER_MCUBOOT=y
+CONFIG_MCUBOOT_SIGNATURE_KEY_FILE="bootloader/mcuboot/root-rsa-2048.pem"
+CONFIG_FLASH=y
+CONFIG_IMG_MANAGER=y
+CONFIG_STREAM_FLASH=y
+CONFIG_FLASH_MAP=y
+
diff --git a/sysbuild-example/sysbuild.cmake b/sysbuild-example/sysbuild.cmake
@@ -0,0 +1,16 @@
+# Copyright (c) 2025 James Walmsley <james@fullfat-fs.co.uk>
+# SPDX-License-Identifier: Apache-2.0
+
+ExternalZephyrProject_Add(
+    APPLICATION mfg_image
+    SOURCE_DIR ${APP_DIR}/mfg_image
+)
+
+ExternalZephyrProject_Add(
+    APPLICATION dfu_app
+    SOURCE_DIR ${APP_DIR}/dfu_app
+)
+
+add_dependencies(${DEFAULT_IMAGE} mfg_image)
+add_dependencies(${DEFAULT_IMAGE} dfu_app)
+
diff --git a/sysbuild-example/sysbuild.conf b/sysbuild-example/sysbuild.conf
@@ -0,0 +1,3 @@
+SB_CONFIG_BOOTLOADER_MCUBOOT=y
+SB_CONFIG_MCUBOOT_MODE_SWAP_USING_MOVE=y
+
diff --git a/sysbuild-example/sysbuild/mcuboot/boards/nucleo_f413zh.overlay b/sysbuild-example/sysbuild/mcuboot/boards/nucleo_f413zh.overlay
@@ -0,0 +1,7 @@
+/ {
+	chosen {
+		zephyr,code-partition = &boot_partition;
+	};
+};
+
+
diff --git a/west.yml b/west.yml
@@ -21,3 +21,4 @@ manifest:
           - hal_nordic # required by the custom_plank board (Nordic based)
           - hal_stm32  # required by the nucleo_f302r8 board (STM32 based)
           - mcuboot
+          - mbedtls

-Original file line number
+Diff line change
@@ @@ -0,0 +1,7 @@ @@
 +/ {
 +	chosen {
 +		zephyr,code-partition = &app_partition;
 +	};
 +};
++
++