sysbuild: full example of sysbuild with mcuboot and multiple images

Author: jameswalmsley

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()
+
+project(hello_world)
+
+target_sources(app PRIVATE mfg_image/src/main.c)
+

sysbuild-example/README.md

@@ -0,0 +1,11 @@
+# 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
+```
+

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{ZPEHYR_BASE})
+
+project(dfu_app)
+target_sources(app PRIVATE src/main.c)
+

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
+

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 %s\n", CONFIG_BOARD_TARGET);
+
+	return 0;
+}
+
+

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)
+

sysbuild-example/mfg_image/prj.conf

@@ -0,0 +1 @@
+CONFIG_BOOTLOADER_MCUBOOT=y

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;
+}
+

sysbuild-example/prj.conf

@@ -0,0 +1,15 @@
+# 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)

sysbuild-example/sysbuild.cmake

@@ -0,0 +1 @@
+SB_CONFIG_BOOTLOADER_MCUBOOT=y

sysbuild-example/sysbuild.conf

@@ -0,0 +1,2 @@
+CONFIG_BOOT_SWAP_USING_SCRATCH=y
+

sysbuild-example/sysbuild/mcuboot.conf

@@ -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