Zephyr sysbuild / multi image

CODEOWNERS

@@ -725,6 +725,7 @@ scripts/build/gen_image_info.py           @tejlmand
 /scripts/build/uf2conv.py                 @petejohanson
 /scripts/build/user_wordsize.py           @cfriedt
 /scripts/valgrind.supp                    @aescolar @daor-oti
+/share/sysbuild/                          @tejlmand
 /share/zephyr-package/                    @tejlmand
 /share/zephyrunittest-package/            @tejlmand
 /subsys/bluetooth/                        @alwa-nordic @jhedberg @Vudentz

cmake/modules/kconfig.cmake

@@ -17,6 +17,8 @@ set_property(DIRECTORY APPEND PROPERTY CMAKE_CONFIGURE_DEPENDS ${AUTOCONF_H})
 file(MAKE_DIRECTORY ${PROJECT_BINARY_DIR}/kconfig/include/generated)
 file(MAKE_DIRECTORY ${PROJECT_BINARY_DIR}/kconfig/include/config)
 
+set_ifndef(KCONFIG_NAMESPACE "CONFIG")
+
 # Support multiple SOC_ROOT, remove ZEPHYR_BASE as that is always sourced.
 set(kconfig_soc_root ${SOC_ROOT})
 list(REMOVE_ITEM kconfig_soc_root ${ZEPHYR_BASE})
@@ -59,7 +61,7 @@ else()
   set(KCONFIG_ROOT ${ZEPHYR_BASE}/Kconfig)
 endif()
 
-set(BOARD_DEFCONFIG ${BOARD_DIR}/${BOARD}_defconfig)
+set_ifndef(BOARD_DEFCONFIG ${BOARD_DIR}/${BOARD}_defconfig)
 set(DOTCONFIG                  ${PROJECT_BINARY_DIR}/.config)
 set(PARSED_KCONFIG_SOURCES_TXT ${PROJECT_BINARY_DIR}/kconfig/sources.txt)
 
@@ -109,6 +111,7 @@ set(COMMON_KCONFIG_ENV_SETTINGS
   PYTHON_EXECUTABLE=${PYTHON_EXECUTABLE}
   srctree=${ZEPHYR_BASE}
   KERNELVERSION=${KERNELVERSION}
+  CONFIG_=${KCONFIG_NAMESPACE}_
   KCONFIG_CONFIG=${DOTCONFIG}
   # Set environment variables so that Kconfig can prune Kconfig source
   # files for other architectures
@@ -146,10 +149,10 @@ set(EXTRA_KCONFIG_TARGET_COMMAND_FOR_hardenconfig
   ${ZEPHYR_BASE}/scripts/kconfig/hardenconfig.py
   )
 
+set_ifndef(KCONFIG_TARGETS menuconfig guiconfig hardenconfig)
+
 foreach(kconfig_target
-    menuconfig
-    guiconfig
-    hardenconfig
+    ${KCONFIG_TARGETS}
     ${EXTRA_KCONFIG_TARGETS}
     )
   add_custom_target(
@@ -170,15 +173,15 @@ foreach(kconfig_target
 endforeach()
 
 # Support assigning Kconfig symbols on the command-line with CMake
-# cache variables prefixed with 'CONFIG_'. This feature is
-# experimental and undocumented until it has undergone more
+# cache variables prefixed according to the Kconfig namespace.
+# This feature is experimental and undocumented until it has undergone more
 # user-testing.
 unset(EXTRA_KCONFIG_OPTIONS)
 get_cmake_property(cache_variable_names CACHE_VARIABLES)
 foreach (name ${cache_variable_names})
-  if("${name}" MATCHES "^CONFIG_")
-    # When a cache variable starts with 'CONFIG_', it is assumed to be
-    # a Kconfig symbol assignment from the CMake command line.
+  if("${name}" MATCHES "^${KCONFIG_NAMESPACE}_")
+    # When a cache variable starts with the 'KCONFIG_NAMESPACE' value, it is
+    # assumed to be a Kconfig symbol assignment from the CMake command line.
     set(EXTRA_KCONFIG_OPTIONS
       "${EXTRA_KCONFIG_OPTIONS}\n${name}=${${name}}"
       )
@@ -316,18 +319,18 @@ add_custom_target(config-twister DEPENDS ${DOTCONFIG})
 # CMakeCache.txt. If the symbols end up in DOTCONFIG they will be
 # re-introduced to the namespace through 'import_kconfig'.
 foreach (name ${cache_variable_names})
-  if("${name}" MATCHES "^CONFIG_")
+  if("${name}" MATCHES "^${KCONFIG_NAMESPACE}_")
     unset(${name})
     unset(${name} CACHE)
   endif()
 endforeach()
 
-# Parse the lines prefixed with CONFIG_ in the .config file from Kconfig
-import_kconfig(CONFIG_ ${DOTCONFIG})
+# Import the .config file and make all settings available in CMake processing.
+import_kconfig(${KCONFIG_NAMESPACE} ${DOTCONFIG})
 
 # Re-introduce the CLI Kconfig symbols that survived
 foreach (name ${cache_variable_names})
-  if("${name}" MATCHES "^CONFIG_")
+  if("${name}" MATCHES "^${KCONFIG_NAMESPACE}_")
     if(DEFINED ${name})
       set(${name} ${${name}} CACHE STRING "")
     endif()

share/sysbuild/CMakeLists.txt

@@ -0,0 +1,44 @@
+# Copyright (c) 2021 Nordic Semiconductor
+#
+# SPDX-License-Identifier: Apache-2.0
+
+cmake_minimum_required(VERSION 3.20)
+
+if(NOT DEFINED APP_DIR)
+  message(FATAL_ERROR "No main application specified")
+endif()
+
+# This will update the APP_DIR cache variable to PATH type and apply a comment.
+# If APP_DIR is a relative path, then CMake will adjust to absolute path based
+# on current working dir.
+set(APP_DIR ${APP_DIR} CACHE PATH "Main Application Source Directory")
+
+# Add sysbuild/cmake/modules to CMAKE_MODULE_PATH which allows us to integrate
+# sysbuild CMake modules with general Zephyr CMake modules.
+list(APPEND CMAKE_MODULE_PATH ${CMAKE_CURRENT_LIST_DIR}/cmake/modules)
+# List of Zephyr and sysbuild CMake modules we need for sysbuild.
+# Note: sysbuild_kconfig will internally load kconfig CMake module.
+set(zephyr_modules extensions sysbuild_extensions python west root zephyr_module boards shields sysbuild_kconfig)
+
+find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE} COMPONENTS ${zephyr_modules})
+
+project(sysbuild LANGUAGES)
+
+# Global list of images enabled in this multi image build system.
+set(IMAGES)
+
+get_filename_component(APP_DIR  ${APP_DIR} ABSOLUTE)
+get_filename_component(app_name ${APP_DIR} NAME)
+
+# This adds the primary application to the build.
+ExternalZephyrProject_Add(
+  APPLICATION ${app_name}
+  SOURCE_DIR ${APP_DIR}
+  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)

share/sysbuild/Kconfig

@@ -0,0 +1,36 @@
+# Copyright (c) 2021 Nordic Semiconductor
+#
+# SPDX-License-Identifier: Apache-2.0
+
+comment "Sysbuild image configuration"
+
+osource "$(BOARD_DIR)/Kconfig.sysbuild"
+
+config EXPERIMENTAL
+	bool
+	help
+	  Symbol that must be selected by a feature if it is considered to be
+	  at an experimental implementation stage.
+
+config WARN_EXPERIMENTAL
+	bool
+	prompt "Warn on experimental usage"
+	help
+	  Print a warning when the Kconfig tree is parsed if any experimental
+	  features are enabled.
+
+config DEPRECATED
+	bool
+	help
+	  Symbol that must be selected by a feature or module if it is
+	  considered to be deprecated.
+
+config WARN_DEPRECATED
+	bool
+	default y
+	prompt "Warn on deprecated usage"
+	help
+	  Print a warning when the Kconfig tree is parsed if any deprecated
+	  features are enabled.
+
+rsource "bootloader/Kconfig"

share/sysbuild/bootloader/CMakeLists.txt

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

share/sysbuild/bootloader/Kconfig

@@ -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
+	bool "MCUboot"
+	depends on SUPPORT_BOOTLOADER_MCUBOOT_ZEPHYR
+	help
+	  Include MCUboot (Zephyr port) as the bootloader to use
+
+endchoice