OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/share/sysbuild/CMakeLists.txt

45 lines
1.8 KiB
CMake
Raw Normal View History

sysbuild: Check for duplicate image names Checks if the IMAGES variable has been updated with a duplicate image name, which would otherwise cause an infinite loop. Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no> Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2023-01-05 17:52:11 +08:00
# Copyright (c) 2021-2023 Nordic Semiconductor
cmake: initial sysbuild / multi image support This is the initial commit with system build, sysbuild. Using CMake as infrastructure together with the Zephyr sysbuild allows us to support a convenient way of building a sample and allow for extra images to be built as part of a larger system. It uses Kconfig for configuration of image builds. This allows for future extension with additional build images. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2022-06-22 17:05:49 +08:00
#
# 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)
get_filename_component(APP_DIR ${APP_DIR} ABSOLUTE)
get_filename_component(app_name ${APP_DIR} NAME)
cmake: create domains.yaml Support creation of domains.yaml to support `west <build|flash|debug> --domain` when working with sysbuild multi image. Each Zephyr based image is added to list of domain that can be handled by the Zephyr west extension commands. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-11-22 20:55:57 +08:00
set(DEFAULT_IMAGE "${app_name}")
cmake: initial sysbuild / multi image support This is the initial commit with system build, sysbuild. Using CMake as infrastructure together with the Zephyr sysbuild allows us to support a convenient way of building a sample and allow for extra images to be built as part of a larger system. It uses Kconfig for configuration of image builds. This allows for future extension with additional build images. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2022-06-22 17:05:49 +08:00
sysbuild: Make the image processing order well-defined Adjust the order in which image-specific `sysbuild.cmake` files are iteratively included by sysbuild. This is motivated by the introduction of `sysbuild_add_dependencies()`. In the following example: sysbuild_add_dependencies(CONFIGURE my_sample sample_a sample_b) the `my_sample` image is expected to be added before this function is called. Success depends not only on the placement of the call, but on the order in which new images are added, which itself is influenced by the order in which `sysbuild.cmake` files are included. This last order can be tweaked to make the "dependencies" feature more user-friendly. This is done by rewriting the internal `sysbuild.cmake` processing loop into a new, general purpose function - `sysbuild_add_subdirectory()` - which is a wrapper for `add_subdirectory(<source_dir>)` that recursively includes `sysbuild.cmake` files for all images found in `<source_dir>`. With the new function, all images that are expected to be found in a given `<source_dir>` are guaranteed to be added around the same time. This wasn't the case with the old processing loop, because the image- specific `sysbuild.cmake` files (where "sub-images" could be defined) were left to be processed at the very end. Below is the initial order in which sysbuild will add all images. Note: the order of Zephyr modules (from 1 to n) is well-defined. 1. Main application (aka DEFAULT_IMAGE) 2. MCUboot (optional) 3. All images added via these directories: 3.1. <module-1>.sysbuild-cmake 3.2. <module-2>.sysbuild-cmake ... 3.n. <module-n>.sysbuild-cmake 4. All images added via these files: 4.1. ${BOARD_DIR}/sysbuild.cmake 4.2. ${APP_DIR}/sysbuild.cmake (aka sub-images of DEFAULT_IMAGE) These images are intended to be sorted for the users' convenience, from most to least important in the build system, or least to most dependent on other images for configuration (potentially). Finally, the use of `sysbuild_add_subdirectory()` requires updating the directory structure in sysbuild: ./images - All images should belong here. The `DEFAULT_IMAGE` should be the first and only image at the top level, so that it gets added first and its sub-images get added last. ./images/bootloader - Moved from ./bootloader. ./images/boards - Adds images from the board-specific `sysbuild.cmake` file. Signed-off-by: Grzegorz Swiderski <grzegorz.swiderski@nordicsemi.no>
2023-08-25 18:45:14 +08:00
# This is where all Zephyr applications are added to the multi-image build.
sysbuild_add_subdirectory(images)
cmake: sysbuild: Add support for recurive target cmake inclusion Adds support for all sysbuild targets to have a sysbuild.cmake file included and processed as part of sysbuild instead of just the main application. Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no> Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2022-10-11 16:40:12 +08:00
sysbuild: Remove IMAGES variable This variable was originally provided for two indended purposes: * Let users manually add a new image in a desired order in the list. * Let users set build-only images, which are excluded from the list. Given the recent additions of the `sysbuild_add_dependencies()` function and the `BUILD_ONLY` parameter, `IMAGES` should be considered obsolete. Furthermore, the list of images added to sysbuild should be updated automatically when calling `ExternalZephyrProject_Add()`. This is now possible by using a GLOBAL property internal to sysbuild. With that, the `IMAGES` variable can be removed. Its existing usage for image ordering is replaced with `sysbuild_add_dependencies()` treewide. Signed-off-by: Grzegorz Swiderski <grzegorz.swiderski@nordicsemi.no>
2023-05-15 17:19:47 +08:00
get_property(IMAGES GLOBAL PROPERTY sysbuild_images)
cmake: sysbuild PRE_CMAKE, POST_CMAKE, PRE_DOMAINS, POST_DOMAINS hooks Provide a uniform way for sysbuild modules to create hooks that are called at specific time during sysbuild CMake configure time. A module can create functions following the scheme: - <module-name>_pre_cmake - <module-name>_post_cmake - <module-name>_pre_domains - <module-name>_post_domains those functions, if defined, will be called by sysbuild CMake at the location indicated by the function name. A new global variable `SYSBUILD_CURRENT_MODULE_NAME` is created, which a module can use to know it's own name when defining those functions during sysbuild module CMake inclusion. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2023-03-08 22:16:01 +08:00
sysbuild_module_call(PRE_CMAKE MODULES ${SYSBUILD_MODULE_NAMES} IMAGES ${IMAGES})
sysbuild: Support relative ordering of images Fixes #53650 The existing solution for image ordering involves the `IMAGES` variable, which sysbuild originally provided to let users manually add a new image in a desired order. This isn't very flexible for the following reasons: * The order in which `IMAGES` is updated across multiple modules and `sysbuild.cmake` files is not well defined. * Having a single variable means that the same order is used for both configuration and flashing. Usually, there is no reason for the flashing order to be the same as the configuration order. Introduce the `sysbuild_add_dependencies()` function for more fine-tuned ordering of images. It makes one image depend on other images in either configuration or flashing order. Its usage is similar to the standard CMake function `add_dependencies()`, but with an extra parameter to distinguish between two types of dependencies: sysbuild_add_dependencies(CONFIGURE my_sample sample_a sample_b) sysbuild_add_dependencies(FLASH my_sample sample_c sample_d) CONFIGURE dependencies determine the order in which sysbuild configures (runs CMake for) the individual images. This is useful if there is some information from one application's build which needs to be available to another application. FLASH dependencies control the sequence of images used by `west flash`. This could be used if a specific flashing order is required by an SoC, a runner, or something else. Note that these dependencies are not valid for images specified as `BUILD_ONLY`. The internal `sysbuild_images_order()` function is responsible for assembling two sorted lists of images based on the added dependencies, with the help of `topological_sort()`. Signed-off-by: Grzegorz Swiderski <grzegorz.swiderski@nordicsemi.no>
2023-05-15 17:19:47 +08:00
sysbuild_images_order(IMAGES_CONFIGURATION_ORDER CONFIGURE IMAGES ${IMAGES})
foreach(image ${IMAGES_CONFIGURATION_ORDER})
sysbuild: split running of CMake from ExternalZephyrProject_add() Split running CMake from ExternalZephyrProject_add(). This will allow systems to define all Zephyr projects and then at later stages run the CMake configure stage. This makes it both cleaner when CMake is invoked as well as prepare for future work where images could be depending on CMake outcome from other projects. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no> Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-02-20 17:55:14 +08:00
ExternalZephyrProject_Cmake(APPLICATION ${image})
endforeach()
cmake: sysbuild PRE_CMAKE, POST_CMAKE, PRE_DOMAINS, POST_DOMAINS hooks Provide a uniform way for sysbuild modules to create hooks that are called at specific time during sysbuild CMake configure time. A module can create functions following the scheme: - <module-name>_pre_cmake - <module-name>_post_cmake - <module-name>_pre_domains - <module-name>_post_domains those functions, if defined, will be called by sysbuild CMake at the location indicated by the function name. A new global variable `SYSBUILD_CURRENT_MODULE_NAME` is created, which a module can use to know it's own name when defining those functions during sysbuild module CMake inclusion. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2023-03-08 22:16:01 +08:00
sysbuild_module_call(POST_CMAKE MODULES ${SYSBUILD_MODULE_NAMES} IMAGES ${IMAGES})
sysbuild_module_call(PRE_DOMAINS MODULES ${SYSBUILD_MODULE_NAMES} IMAGES ${IMAGES})
cmake: create domains.yaml Support creation of domains.yaml to support `west <build|flash|debug> --domain` when working with sysbuild multi image. Each Zephyr based image is added to list of domain that can be handled by the Zephyr west extension commands. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-11-22 20:55:57 +08:00
include(cmake/domains.cmake)
cmake: sysbuild PRE_CMAKE, POST_CMAKE, PRE_DOMAINS, POST_DOMAINS hooks Provide a uniform way for sysbuild modules to create hooks that are called at specific time during sysbuild CMake configure time. A module can create functions following the scheme: - <module-name>_pre_cmake - <module-name>_post_cmake - <module-name>_pre_domains - <module-name>_post_domains those functions, if defined, will be called by sysbuild CMake at the location indicated by the function name. A new global variable `SYSBUILD_CURRENT_MODULE_NAME` is created, which a module can use to know it's own name when defining those functions during sysbuild module CMake inclusion. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2023-03-08 22:16:01 +08:00
sysbuild_module_call(POST_DOMAINS MODULES ${SYSBUILD_MODULE_NAMES} IMAGES ${IMAGES})