Skip to content

Zephyr sysbuild / multi image #40555

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Aug 3, 2022
Merged

Zephyr sysbuild / multi image #40555

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
b1d1c24
cmake: kconfig: allow build systems to decide defconfig
tejlmand Nov 18, 2021
32a28ef
cmake: kconfig: allow for Kconfig CONFIG namespace
tejlmand Nov 27, 2021
a0665bf
cmake: kconfig: allow to set Kconfig targets externally
tejlmand Nov 27, 2021
1a71ce8
cmake: initial sysbuild / multi image support
tejlmand Jun 22, 2022
f655493
cmake: support MCUBoot bootloader natively with SYSBuild
tejlmand Jun 22, 2022
86dda45
cmake: create domains.yaml
tejlmand Nov 22, 2021
4ec16a3
scripts: extend west build command to support sysbuild CMake project
tejlmand Nov 22, 2021
b719e15
scripts: west commands to support --domain
tejlmand Nov 22, 2021
70e05e2
cmake: sysbuild: signing support
tejlmand Nov 22, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions share/sysbuild/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@ ExternalZephyrProject_Add(
MAIN_APP
)

add_subdirectory(bootloader)

# This allows for board and app specific images to be included.
include(${BOARD_DIR}/sysbuild.cmake OPTIONAL)
include(${APP_DIR}/sysbuild.cmake OPTIONAL)
2 changes: 2 additions & 0 deletions share/sysbuild/Kconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,5 @@ config WARN_DEPRECATED
help
Print a warning when the Kconfig tree is parsed if any deprecated
features are enabled.

rsource "bootloader/Kconfig"
11 changes: 11 additions & 0 deletions share/sysbuild/bootloader/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Copyright (c) 2022 Nordic Semiconductor
#
# SPDX-License-Identifier: Apache-2.0

# Include MCUboot if enabled.
if(SB_CONFIG_BOOTLOADER_MCUBOOT)
ExternalZephyrProject_Add(
APPLICATION mcuboot
SOURCE_DIR ${ZEPHYR_MCUBOOT_MODULE_DIR}/boot/zephyr/
)
endif()
29 changes: 29 additions & 0 deletions share/sysbuild/bootloader/Kconfig
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Copyright (c) 2022 Nordic Semiconductor
#
# SPDX-License-Identifier: Apache-2.0

config SUPPORT_BOOTLOADER
bool
default y

config SUPPORT_BOOTLOADER_MCUBOOT_ZEPHYR
bool
default y

choice BOOTLOADER
prompt "Bootloader support"
default BOOTLOADER_NONE
depends on SUPPORT_BOOTLOADER

config BOOTLOADER_NONE
bool "None"
help
Do not Include a bootloader in the build

config BOOTLOADER_MCUBOOT
Copy link
Contributor

@nvlsianpu nvlsianpu Aug 3, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As I understand there is dedicated namespace for these Kconfig properties (and will never merge to with the application properties).
For instance this property does something else than CONFIG_BOOTLOADER_MCUBOOT of zephyr-rtos app.
I want to avoid confusion.

Copy link
Contributor Author

@tejlmand tejlmand Aug 3, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe the help text can definitely be improved.

But whether we should invent two different setting names or have them identical as now depends a lot on how you look at this.

The Zephyr setting states:

zephyr/Kconfig.zephyr

Lines 682 to 686 in 83d73f6

This option signifies that the target uses MCUboot as a bootloader,
or in other words that the image is to be chain-loaded by MCUboot.
This sets several required build system and Device Tree options in
order for the image generated to be bootable using the MCUboot open
source bootloader. Currently this includes:

and my view on this is that this is also true for the sysbuild BOOTLOADER_MCUBOOT because it propagates this setting to the application so that the app is chain loaded by MCUboot, as well as devicetree is setup accordingly.
Not inside sysbuild itself, but in the images built by sysbuild.
Ref:

zephyr/share/sysbuild/CMakeLists.txt

Lines 33 to 37 in 70e05e2

# Propagate bootloader and signing settings from this system to the MCUboot and
# application image build systems.
if(SB_CONFIG_BOOTLOADER_MCUBOOT)
set(${app_name}_CONFIG_BOOTLOADER_MCUBOOT y CACHE STRING
"MCUBOOT is enabled as bootloader" FORCE

Of course sysbuild itself does one more thing which the application itself cannot do, and that is building and flashing of MCUboot in addition.

I believe having identical name for BOOTLOADER_MCUBOOT makes it easier for users to transition to sysbuild and understand how to build a sample with MCUboot, and that the small addition that sysbuild provides is not sufficient to justify two different names.

bool "MCUboot"
depends on SUPPORT_BOOTLOADER_MCUBOOT_ZEPHYR
help
Include MCUboot (Zephyr port) as the bootloader to use

endchoice