OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/cmake/modules/zephyr_module.cmake

149 lines
5.5 KiB
CMake
Raw Normal View History

license: cleanup: add SPDX Apache-2.0 license identifier Update the files which contain no license information with the 'Apache-2.0' SPDX license identifier. Many source files in the tree are missing licensing information, which makes it harder for compliance tools to determine the correct license. By default all files without license information are under the default license of Zephyr, which is Apache version 2. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-04-06 21:08:09 +08:00
# SPDX-License-Identifier: Apache-2.0
cmake: Zephyr CMake package and CMake modules Create a cmake/modules folder containing all Zephyr CMake modules. All Zephyr cmake files that are included from boilerplate are now converted into CMake modules which can be individually loaded. The Zephyr CMake package is updated to support loading of individual CMake modules using the COMPONENTS argument to `find_package(Zephyr)`. If the COMPONENTS argument is not specified, the default Zephyr build system will load. If COMPONENTS is specified then, only those components and the dependencies will be loaded. If a Zephyr CMake module depends on another CMake module which has not been loaded, it will automatically be loaded. This allows us to modularize and reuse individual parts of the Zephyr CMake build system in a more flexible way in future. Such usage could be: - Higher livel multi image build system - Invocation of individual components, for example dts processing by twister without loading all build code - Doc build - Unittesting With this new CMake package and CMake module scheme then direct sourcing of boilerplate.cmake has been deprecated. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-12-17 00:13:54 +08:00
include_guard(GLOBAL)
include(extensions)
include(python)
modules: introducing MODULE_EXT_ROOT to allow glue code in Zephyr repo This commit introduces MODULE_EXT_ROOT which allows CMake and Kconfig glue code to be placed outside of the Zephyr module repository. This allows for placing glue code in Zephyr, but also allows users to specify custom MODULE_EXT_ROOTs for glue code using either `-DMODULE_EXT_ROOT` or `zephyr/module.yml` with `build:settings:module_ext_root` settings. MODULE_EXT_ROOT' is a list of directories, similar to other roots such as BOARD_ROOT, DTS_ROOT, etc. The Zephyr repo folder ${ZEPHYR_BASE} is always to the MODULE_EXT_ROOT list as lowest priority. For each MODULE_EXT_ROOT, the file `<module_ext_root>/modules/modules.cmake` will be processed. In Zephyr repo, the folder `modules/<module>/` contains CMakeLists.txt and Kconfig glue code for the Zephyr module. A Zephyr module can specify that CMakeLists.txt and Kconfig glue code is placed in an external module root by specifying: ``` build: cmake-ext: True kconfig-ext: True ``` It is still possible to place the CMakeLists.txt and Kconfig files directly in the Zephyr module using the existing: ``` build: cmake: <path> kconfig: <file> ```. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-12-17 18:27:42 +08:00
# This cmake file provides functionality to import CMakeLists.txt and Kconfig
# files for Zephyr modules into Zephyr build system.
#
cmake: create a root.cmake CMake module The root.cmake CMake module remove boilerplate code and place it inside a dedicated root.cmake CMake module. This is part of a general CMake overhaul to allow better modularization and reuse of the Zephyr build system. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-12-16 22:52:28 +08:00
# CMakeLists.txt and Kconfig files can reside directly in the Zephyr module or
# in a MODULE_EXT_ROOT.
modules: introducing MODULE_EXT_ROOT to allow glue code in Zephyr repo This commit introduces MODULE_EXT_ROOT which allows CMake and Kconfig glue code to be placed outside of the Zephyr module repository. This allows for placing glue code in Zephyr, but also allows users to specify custom MODULE_EXT_ROOTs for glue code using either `-DMODULE_EXT_ROOT` or `zephyr/module.yml` with `build:settings:module_ext_root` settings. MODULE_EXT_ROOT' is a list of directories, similar to other roots such as BOARD_ROOT, DTS_ROOT, etc. The Zephyr repo folder ${ZEPHYR_BASE} is always to the MODULE_EXT_ROOT list as lowest priority. For each MODULE_EXT_ROOT, the file `<module_ext_root>/modules/modules.cmake` will be processed. In Zephyr repo, the folder `modules/<module>/` contains CMakeLists.txt and Kconfig glue code for the Zephyr module. A Zephyr module can specify that CMakeLists.txt and Kconfig glue code is placed in an external module root by specifying: ``` build: cmake-ext: True kconfig-ext: True ``` It is still possible to place the CMakeLists.txt and Kconfig files directly in the Zephyr module using the existing: ``` build: cmake: <path> kconfig: <file> ```. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-12-17 18:27:42 +08:00
# The `<module>/zephyr/module.yml` file specifies whether the build files are
cmake: create a root.cmake CMake module The root.cmake CMake module remove boilerplate code and place it inside a dedicated root.cmake CMake module. This is part of a general CMake overhaul to allow better modularization and reuse of the Zephyr build system. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-12-16 22:52:28 +08:00
# located in the Zephyr module or in a MODULE_EXT_ROOT.
modules: introducing MODULE_EXT_ROOT to allow glue code in Zephyr repo This commit introduces MODULE_EXT_ROOT which allows CMake and Kconfig glue code to be placed outside of the Zephyr module repository. This allows for placing glue code in Zephyr, but also allows users to specify custom MODULE_EXT_ROOTs for glue code using either `-DMODULE_EXT_ROOT` or `zephyr/module.yml` with `build:settings:module_ext_root` settings. MODULE_EXT_ROOT' is a list of directories, similar to other roots such as BOARD_ROOT, DTS_ROOT, etc. The Zephyr repo folder ${ZEPHYR_BASE} is always to the MODULE_EXT_ROOT list as lowest priority. For each MODULE_EXT_ROOT, the file `<module_ext_root>/modules/modules.cmake` will be processed. In Zephyr repo, the folder `modules/<module>/` contains CMakeLists.txt and Kconfig glue code for the Zephyr module. A Zephyr module can specify that CMakeLists.txt and Kconfig glue code is placed in an external module root by specifying: ``` build: cmake-ext: True kconfig-ext: True ``` It is still possible to place the CMakeLists.txt and Kconfig files directly in the Zephyr module using the existing: ``` build: cmake: <path> kconfig: <file> ```. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-12-17 18:27:42 +08:00
#
# A list of Zephyr modules can be provided to the build system using:
# -DZEPHYR_MODULES=<module-path>[;<additional-module(s)-path>]
#
# It looks for: <module>/zephyr/module.yml or
# <module>/zephyr/CMakeLists.txt
cmake: create a root.cmake CMake module The root.cmake CMake module remove boilerplate code and place it inside a dedicated root.cmake CMake module. This is part of a general CMake overhaul to allow better modularization and reuse of the Zephyr build system. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-12-16 22:52:28 +08:00
# to load the Zephyr module into Zephyr build system.
CMake/Kconfig: CMake and Kconfig build integration This commit allows for Zephyr modules to be natively integrated into the build system with CMakeLists.txt and Kconfig files. The sourcing of module files are done in following order: - If <module>/zephyr/module.yml exists, use cmake and kconfig settings for sourcing of additional file - Else if <module>/zephyr/CMakeLists.txt exists, source this file into CMake build tree and add <module>/zephyr/Kconfig as osource If none of the above files are present, the project is considered to not be a Zephyr module Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
2019-02-05 17:36:22 +08:00
# If west is available, it uses `west list` to obtain a list of projects to
# search for zephyr/module.yml
modules: introducing MODULE_EXT_ROOT to allow glue code in Zephyr repo This commit introduces MODULE_EXT_ROOT which allows CMake and Kconfig glue code to be placed outside of the Zephyr module repository. This allows for placing glue code in Zephyr, but also allows users to specify custom MODULE_EXT_ROOTs for glue code using either `-DMODULE_EXT_ROOT` or `zephyr/module.yml` with `build:settings:module_ext_root` settings. MODULE_EXT_ROOT' is a list of directories, similar to other roots such as BOARD_ROOT, DTS_ROOT, etc. The Zephyr repo folder ${ZEPHYR_BASE} is always to the MODULE_EXT_ROOT list as lowest priority. For each MODULE_EXT_ROOT, the file `<module_ext_root>/modules/modules.cmake` will be processed. In Zephyr repo, the folder `modules/<module>/` contains CMakeLists.txt and Kconfig glue code for the Zephyr module. A Zephyr module can specify that CMakeLists.txt and Kconfig glue code is placed in an external module root by specifying: ``` build: cmake-ext: True kconfig-ext: True ``` It is still possible to place the CMakeLists.txt and Kconfig files directly in the Zephyr module using the existing: ``` build: cmake: <path> kconfig: <file> ```. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-12-17 18:27:42 +08:00
#
# If the module.yml file specifies that build files are located in a
# MODULE_EXT_ROOT then the variables:
# - `ZEPHYR_<MODULE_NAME>_CMAKE_DIR` is used for inclusion of the CMakeLists.txt
# - `ZEPHYR_<MODULE_NAME>_KCONFIG` is used for inclusion of the Kconfig
# files into the build system.
CMake/Kconfig: CMake and Kconfig build integration This commit allows for Zephyr modules to be natively integrated into the build system with CMakeLists.txt and Kconfig files. The sourcing of module files are done in following order: - If <module>/zephyr/module.yml exists, use cmake and kconfig settings for sourcing of additional file - Else if <module>/zephyr/CMakeLists.txt exists, source this file into CMake build tree and add <module>/zephyr/Kconfig as osource If none of the above files are present, the project is considered to not be a Zephyr module Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
2019-02-05 17:36:22 +08:00
cmake: default value for KCONFIG_BINARY_DIR moved to zephyr_modules This is a cleanup commit moves the default setting of KCONFIG_BINARY_DIR from boilerplate.cmake to zephyr_modules.cmake to prepare for better re-usability. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-12-15 22:22:39 +08:00
# Settings used by Zephyr module but where systems may define an alternative value.
set_ifndef(KCONFIG_BINARY_DIR ${CMAKE_BINARY_DIR}/Kconfig)
if(ZEPHYR_EXTRA_MODULES)
# ZEPHYR_EXTRA_MODULES has either been specified on the cmake CLI or is
# already in the CMakeCache.txt. This has precedence over the environment
# variable ZEPHYR_EXTRA_MODULES
elseif(DEFINED ENV{ZEPHYR_EXTRA_MODULES})
set(ZEPHYR_EXTRA_MODULES $ENV{ZEPHYR_EXTRA_MODULES})
endif()
CMake/Kconfig: CMake and Kconfig build integration This commit allows for Zephyr modules to be natively integrated into the build system with CMakeLists.txt and Kconfig files. The sourcing of module files are done in following order: - If <module>/zephyr/module.yml exists, use cmake and kconfig settings for sourcing of additional file - Else if <module>/zephyr/CMakeLists.txt exists, source this file into CMake build tree and add <module>/zephyr/Kconfig as osource If none of the above files are present, the project is considered to not be a Zephyr module Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
2019-02-05 17:36:22 +08:00
if(ZEPHYR_MODULES)
cmake: Extracted Zephyr module processing into python script Fixes: #14513 This commit move the functionality of extracting zephyr modules into generated CMake and Kconfig include files from CMake into python. This allows other tools, especially CI to re-use the zephyr module functionality. Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
2019-03-19 17:38:18 +08:00
set(ZEPHYR_MODULES_ARG "--modules" ${ZEPHYR_MODULES})
CMake/Kconfig: CMake and Kconfig build integration This commit allows for Zephyr modules to be natively integrated into the build system with CMakeLists.txt and Kconfig files. The sourcing of module files are done in following order: - If <module>/zephyr/module.yml exists, use cmake and kconfig settings for sourcing of additional file - Else if <module>/zephyr/CMakeLists.txt exists, source this file into CMake build tree and add <module>/zephyr/Kconfig as osource If none of the above files are present, the project is considered to not be a Zephyr module Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
2019-02-05 17:36:22 +08:00
endif()
if(ZEPHYR_EXTRA_MODULES)
cmake: Extracted Zephyr module processing into python script Fixes: #14513 This commit move the functionality of extracting zephyr modules into generated CMake and Kconfig include files from CMake into python. This allows other tools, especially CI to re-use the zephyr module functionality. Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
2019-03-19 17:38:18 +08:00
set(ZEPHYR_EXTRA_MODULES_ARG "--extra-modules" ${ZEPHYR_EXTRA_MODULES})
CMake/Kconfig: CMake and Kconfig build integration This commit allows for Zephyr modules to be natively integrated into the build system with CMakeLists.txt and Kconfig files. The sourcing of module files are done in following order: - If <module>/zephyr/module.yml exists, use cmake and kconfig settings for sourcing of additional file - Else if <module>/zephyr/CMakeLists.txt exists, source this file into CMake build tree and add <module>/zephyr/Kconfig as osource If none of the above files are present, the project is considered to not be a Zephyr module Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
2019-02-05 17:36:22 +08:00
endif()
cmake: default value for KCONFIG_BINARY_DIR moved to zephyr_modules This is a cleanup commit moves the default setting of KCONFIG_BINARY_DIR from boilerplate.cmake to zephyr_modules.cmake to prepare for better re-usability. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-12-15 22:22:39 +08:00
file(MAKE_DIRECTORY ${KCONFIG_BINARY_DIR})
cmake: relocation of generated Kconfig file for Zephyr modules This commit relocates the generated Kconfig.modules file from ${CMAKE_BINARY_DIR} into ${CMAKE_BINARY_DIR}/Kconfig. This is done as preparation of multiple SOC and ARCH root support. A single Kconfig folder inside ${CMAKE_BINARY_DIR} helps to keep the build folder tidy. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-07-07 03:39:31 +08:00
set(KCONFIG_MODULES_FILE ${KCONFIG_BINARY_DIR}/Kconfig.modules)
modules: adding support for ROOTs definitions in zephyr/module.yml Fixes: #25215 This commit introduces the possibility of defining ROOTs in a Zephyr module and have it automatically appended to list of other ROOTs. Supported with this commit: - BOARD_ROOT - SOC_ROOT - DTS_ROOT - ARCH_ROOT In order to support this in Zephyr module files, the detection of west has been moved to dedicated west.cmake file and included immediately after python.cmake. Also the inclusion of zephyr_modules.cmake has moved before first use of BOARD_ROOT. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-07-07 23:29:56 +08:00
set(ZEPHYR_SETTINGS_FILE ${CMAKE_BINARY_DIR}/zephyr_settings.txt)
zephyr_module.cmake: restore ability to build without modules Kconfig.modules used to be an empty file when no modules. PR #14667 / commit bd7569f27288 "cmake: Extracted Zephyr module processing into python script" unintentionally changed that to no Kconfig.modules file at all when no west and no modules. kconfig.py doesn't like that and crashes. Restore the empty file. Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2019-03-30 14:35:12 +08:00
cmake: zephyr_modules: Add west executable argument On some systems where you don't have access to `PATH` and you can't set the `ENV{PATH}` variable. You need to be able to pass the path to the west executable down to the python script so it is better for it to be set explicitly than assuming that it exsists as a part of the PATH/executables in the shell being called. Signed-off-by: Sigvart M. Hovland <sigvart.hovland@nordicsemi.no>
2019-04-25 18:27:17 +08:00
if(WEST)
cmake: west: invoke west using same python as rest of build system When running CMake, then Python3 will be used. This is detected through FindPython3, with a preference for using the python or python3 in path, if any of those matches the required Python minimal version in Zephyr. It is also possible for users to specify a different Python, as example by using: `cmake -DPYTHON_PREFER=/usr/bin/python3.x` However, when running `west` as native command, then west will be invoked on linux based on the python defined in: `west` launcher, which could be: `#!/usr/bin/python3.y` Thus there could be mismatch in Pythons used for `west` and the python used for other scripts. This is even worse on windows, where a user might experience: ``` >.\opt\bin\Scripts\west.exe --version Traceback (most recent call last): File "C:\Python37\lib\runpy.py", line 193, in _run_module_as_main "__main__", mod_spec) ... File "C:\Python37\lib\socket.py", line 49, in <module> import _socket ImportError: Module use of python38.dll conflicts with this version of Python. ``` when testing out a newer Python, but the python in path is still a 3.7. By importing `west` into zephyr_module.py and by using, as example `python -c "from west.util import west_topdir; print(topdir())"` we ensure the same python is used in all python scripts. Also it allows the user to control the python to use for west. It also ensures that the west version being tested, is also the version being used, where old code would test the version imported by python, but using the west in path (which could be a different version) If the west version installed in the current Python, and west invocation is using a different Python interpreter, then an additional help text is printed, to easier assist users with debugging. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-06-09 03:09:15 +08:00
set(WEST_ARG "--zephyr-base" ${ZEPHYR_BASE})
cmake: zephyr_modules: Add west executable argument On some systems where you don't have access to `PATH` and you can't set the `ENV{PATH}` variable. You need to be able to pass the path to the west executable down to the python script so it is better for it to be set explicitly than assuming that it exsists as a part of the PATH/executables in the shell being called. Signed-off-by: Sigvart M. Hovland <sigvart.hovland@nordicsemi.no>
2019-04-25 18:27:17 +08:00
endif()
cmake: Extracted Zephyr module processing into python script Fixes: #14513 This commit move the functionality of extracting zephyr modules into generated CMake and Kconfig include files from CMake into python. This allows other tools, especially CI to re-use the zephyr module functionality. Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
2019-03-19 17:38:18 +08:00
if(WEST OR ZEPHYR_MODULES)
# Zephyr module uses west, so only call it if west is installed or
# ZEPHYR_MODULES was provided as argument to CMake.
execute_process(
COMMAND
${PYTHON_EXECUTABLE} ${ZEPHYR_BASE}/scripts/zephyr_module.py
cmake: zephyr_modules: Add west executable argument On some systems where you don't have access to `PATH` and you can't set the `ENV{PATH}` variable. You need to be able to pass the path to the west executable down to the python script so it is better for it to be set explicitly than assuming that it exsists as a part of the PATH/executables in the shell being called. Signed-off-by: Sigvart M. Hovland <sigvart.hovland@nordicsemi.no>
2019-04-25 18:27:17 +08:00
${WEST_ARG}
cmake: Extracted Zephyr module processing into python script Fixes: #14513 This commit move the functionality of extracting zephyr modules into generated CMake and Kconfig include files from CMake into python. This allows other tools, especially CI to re-use the zephyr module functionality. Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
2019-03-19 17:38:18 +08:00
${ZEPHYR_MODULES_ARG}
${ZEPHYR_EXTRA_MODULES_ARG}
zephyr_module.cmake: restore ability to build without modules Kconfig.modules used to be an empty file when no modules. PR #14667 / commit bd7569f27288 "cmake: Extracted Zephyr module processing into python script" unintentionally changed that to no Kconfig.modules file at all when no west and no modules. kconfig.py doesn't like that and crashes. Restore the empty file. Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2019-03-30 14:35:12 +08:00
--kconfig-out ${KCONFIG_MODULES_FILE}
cmake: Extracted Zephyr module processing into python script Fixes: #14513 This commit move the functionality of extracting zephyr modules into generated CMake and Kconfig include files from CMake into python. This allows other tools, especially CI to re-use the zephyr module functionality. Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
2019-03-19 17:38:18 +08:00
--cmake-out ${CMAKE_BINARY_DIR}/zephyr_modules.txt
modules: adding support for ROOTs definitions in zephyr/module.yml Fixes: #25215 This commit introduces the possibility of defining ROOTs in a Zephyr module and have it automatically appended to list of other ROOTs. Supported with this commit: - BOARD_ROOT - SOC_ROOT - DTS_ROOT - ARCH_ROOT In order to support this in Zephyr module files, the detection of west has been moved to dedicated west.cmake file and included immediately after python.cmake. Also the inclusion of zephyr_modules.cmake has moved before first use of BOARD_ROOT. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-07-07 23:29:56 +08:00
--settings-out ${ZEPHYR_SETTINGS_FILE}
cmake: zephyr_module.py working directory when listing modules Fixes: #27237 This commit fixes an issue when `zephyr_module.py` was executed outside a west workspace. This would happen when build an out-of-tree (out-of-workspace) application, in which case the current west workspace would be unknown. This is now changed, so that execution of `zephyr_module.py` will be done in the current Zephyr base. This ensures that the west workspace that holds the current Zephyr will be the same workspace used for west list, and hence solve fix the issue. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-08-26 18:09:43 +08:00
WORKING_DIRECTORY ${ZEPHYR_BASE}
cmake: Extracted Zephyr module processing into python script Fixes: #14513 This commit move the functionality of extracting zephyr modules into generated CMake and Kconfig include files from CMake into python. This allows other tools, especially CI to re-use the zephyr module functionality. Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
2019-03-19 17:38:18 +08:00
ERROR_VARIABLE
zephyr_module_error_text
RESULT_VARIABLE
zephyr_module_return
CMake/Kconfig: CMake and Kconfig build integration This commit allows for Zephyr modules to be natively integrated into the build system with CMakeLists.txt and Kconfig files. The sourcing of module files are done in following order: - If <module>/zephyr/module.yml exists, use cmake and kconfig settings for sourcing of additional file - Else if <module>/zephyr/CMakeLists.txt exists, source this file into CMake build tree and add <module>/zephyr/Kconfig as osource If none of the above files are present, the project is considered to not be a Zephyr module Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
2019-02-05 17:36:22 +08:00
)
modules: adding support for ROOTs definitions in zephyr/module.yml Fixes: #25215 This commit introduces the possibility of defining ROOTs in a Zephyr module and have it automatically appended to list of other ROOTs. Supported with this commit: - BOARD_ROOT - SOC_ROOT - DTS_ROOT - ARCH_ROOT In order to support this in Zephyr module files, the detection of west has been moved to dedicated west.cmake file and included immediately after python.cmake. Also the inclusion of zephyr_modules.cmake has moved before first use of BOARD_ROOT. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-07-07 23:29:56 +08:00
if(${zephyr_module_return})
cmake: Extracted Zephyr module processing into python script Fixes: #14513 This commit move the functionality of extracting zephyr modules into generated CMake and Kconfig include files from CMake into python. This allows other tools, especially CI to re-use the zephyr module functionality. Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
2019-03-19 17:38:18 +08:00
message(FATAL_ERROR "${zephyr_module_error_text}")
CMake/Kconfig: CMake and Kconfig build integration This commit allows for Zephyr modules to be natively integrated into the build system with CMakeLists.txt and Kconfig files. The sourcing of module files are done in following order: - If <module>/zephyr/module.yml exists, use cmake and kconfig settings for sourcing of additional file - Else if <module>/zephyr/CMakeLists.txt exists, source this file into CMake build tree and add <module>/zephyr/Kconfig as osource If none of the above files are present, the project is considered to not be a Zephyr module Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
2019-02-05 17:36:22 +08:00
endif()
zephyr_module.cmake: restore ability to build without modules Kconfig.modules used to be an empty file when no modules. PR #14667 / commit bd7569f27288 "cmake: Extracted Zephyr module processing into python script" unintentionally changed that to no Kconfig.modules file at all when no west and no modules. kconfig.py doesn't like that and crashes. Restore the empty file. Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2019-03-30 14:35:12 +08:00
modules: adding support for ROOTs definitions in zephyr/module.yml Fixes: #25215 This commit introduces the possibility of defining ROOTs in a Zephyr module and have it automatically appended to list of other ROOTs. Supported with this commit: - BOARD_ROOT - SOC_ROOT - DTS_ROOT - ARCH_ROOT In order to support this in Zephyr module files, the detection of west has been moved to dedicated west.cmake file and included immediately after python.cmake. Also the inclusion of zephyr_modules.cmake has moved before first use of BOARD_ROOT. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-07-07 23:29:56 +08:00
if(EXISTS ${ZEPHYR_SETTINGS_FILE})
cmake: add a comment header to zephyr_settings.txt I saw a user wondering what this is for and and where it comes from. Provide a comment header with some explanation and a pointer to where to find out more. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-08-10 01:46:17 +08:00
file(STRINGS ${ZEPHYR_SETTINGS_FILE} ZEPHYR_SETTINGS_TXT ENCODING UTF-8 REGEX "^[^#]")
modules: adding support for ROOTs definitions in zephyr/module.yml Fixes: #25215 This commit introduces the possibility of defining ROOTs in a Zephyr module and have it automatically appended to list of other ROOTs. Supported with this commit: - BOARD_ROOT - SOC_ROOT - DTS_ROOT - ARCH_ROOT In order to support this in Zephyr module files, the detection of west has been moved to dedicated west.cmake file and included immediately after python.cmake. Also the inclusion of zephyr_modules.cmake has moved before first use of BOARD_ROOT. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-07-07 23:29:56 +08:00
foreach(setting ${ZEPHYR_SETTINGS_TXT})
# Match <key>:<value> for each line of file, each corresponding to
# a setting. The use of quotes is required due to CMake not supporting
# lazy regexes (it supports greedy only).
string(REGEX REPLACE "\"(.*)\":\".*\"" "\\1" key ${setting})
string(REGEX REPLACE "\".*\":\"(.*)\"" "\\1" value ${setting})
cmake: create a root.cmake CMake module The root.cmake CMake module remove boilerplate code and place it inside a dedicated root.cmake CMake module. This is part of a general CMake overhaul to allow better modularization and reuse of the Zephyr build system. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-12-16 22:52:28 +08:00
list(APPEND ${key} ${value})
modules: adding support for ROOTs definitions in zephyr/module.yml Fixes: #25215 This commit introduces the possibility of defining ROOTs in a Zephyr module and have it automatically appended to list of other ROOTs. Supported with this commit: - BOARD_ROOT - SOC_ROOT - DTS_ROOT - ARCH_ROOT In order to support this in Zephyr module files, the detection of west has been moved to dedicated west.cmake file and included immediately after python.cmake. Also the inclusion of zephyr_modules.cmake has moved before first use of BOARD_ROOT. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-07-07 23:29:56 +08:00
endforeach()
endif()
cmake: create a root.cmake CMake module The root.cmake CMake module remove boilerplate code and place it inside a dedicated root.cmake CMake module. This is part of a general CMake overhaul to allow better modularization and reuse of the Zephyr build system. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-12-16 22:52:28 +08:00
# Append ZEPHYR_BASE as a default ext root at lowest priority
list(APPEND MODULE_EXT_ROOT ${ZEPHYR_BASE})
cmake: ZEPHYR_MODULES_NAMES list created before ext-root Create the ZEPHYR_MODULES_NAMES list of zephyr modules present in the system before calling roots defined in `MODULE_EXT_ROOT`. This will allow external module roots to process based on Zephyr modules available in the system. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-11-26 17:11:00 +08:00
if(EXISTS ${CMAKE_BINARY_DIR}/zephyr_modules.txt)
file(STRINGS ${CMAKE_BINARY_DIR}/zephyr_modules.txt ZEPHYR_MODULES_TXT
ENCODING UTF-8)
set(ZEPHYR_MODULE_NAMES)
foreach(module ${ZEPHYR_MODULES_TXT})
# Match "<name>":"<path>" for each line of file, each corresponding to
# one module. The use of quotes is required due to CMake not supporting
# lazy regexes (it supports greedy only).
string(REGEX REPLACE "\"(.*)\":\".*\":\".*\"" "\\1" module_name ${module})
list(APPEND ZEPHYR_MODULE_NAMES ${module_name})
endforeach()
endif()
cmake: create a root.cmake CMake module The root.cmake CMake module remove boilerplate code and place it inside a dedicated root.cmake CMake module. This is part of a general CMake overhaul to allow better modularization and reuse of the Zephyr build system. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-12-16 22:52:28 +08:00
# MODULE_EXT_ROOT is process order which means Zephyr module roots processed
# later wins. therefore we reverse the list before processing.
list(REVERSE MODULE_EXT_ROOT)
modules: introducing MODULE_EXT_ROOT to allow glue code in Zephyr repo This commit introduces MODULE_EXT_ROOT which allows CMake and Kconfig glue code to be placed outside of the Zephyr module repository. This allows for placing glue code in Zephyr, but also allows users to specify custom MODULE_EXT_ROOTs for glue code using either `-DMODULE_EXT_ROOT` or `zephyr/module.yml` with `build:settings:module_ext_root` settings. MODULE_EXT_ROOT' is a list of directories, similar to other roots such as BOARD_ROOT, DTS_ROOT, etc. The Zephyr repo folder ${ZEPHYR_BASE} is always to the MODULE_EXT_ROOT list as lowest priority. For each MODULE_EXT_ROOT, the file `<module_ext_root>/modules/modules.cmake` will be processed. In Zephyr repo, the folder `modules/<module>/` contains CMakeLists.txt and Kconfig glue code for the Zephyr module. A Zephyr module can specify that CMakeLists.txt and Kconfig glue code is placed in an external module root by specifying: ``` build: cmake-ext: True kconfig-ext: True ``` It is still possible to place the CMakeLists.txt and Kconfig files directly in the Zephyr module using the existing: ``` build: cmake: <path> kconfig: <file> ```. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-12-17 18:27:42 +08:00
foreach(root ${MODULE_EXT_ROOT})
if(NOT EXISTS ${root})
message(FATAL_ERROR "No `modules.cmake` found in module root `${root}`.")
endif()
include(${root}/modules/modules.cmake)
endforeach()
cmake: ZEPHYR_MODULES_NAMES list created before ext-root Create the ZEPHYR_MODULES_NAMES list of zephyr modules present in the system before calling roots defined in `MODULE_EXT_ROOT`. This will allow external module roots to process based on Zephyr modules available in the system. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-11-26 17:11:00 +08:00
if(DEFINED ZEPHYR_MODULES_TXT)
cmake: zephyr modules variable names. This commit refactors processing of Zephyr modules. The Zephyr module name processing has been moved to zephyr_modules.cmake to ensure that all `ZEPHYR_<MODULE_NAME>_MODULE_DIR` are defined early in the build system. No changes to inclusion of Zephyr module CMake code. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-08-24 17:01:04 +08:00
foreach(module ${ZEPHYR_MODULES_TXT})
# Match "<name>":"<path>" for each line of file, each corresponding to
cmake: create a root.cmake CMake module The root.cmake CMake module remove boilerplate code and place it inside a dedicated root.cmake CMake module. This is part of a general CMake overhaul to allow better modularization and reuse of the Zephyr build system. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-12-16 22:52:28 +08:00
# one Zephyr module. The use of quotes is required due to CMake not
# supporting lazy regexes (it supports greedy only).
modules: introducing MODULE_EXT_ROOT to allow glue code in Zephyr repo This commit introduces MODULE_EXT_ROOT which allows CMake and Kconfig glue code to be placed outside of the Zephyr module repository. This allows for placing glue code in Zephyr, but also allows users to specify custom MODULE_EXT_ROOTs for glue code using either `-DMODULE_EXT_ROOT` or `zephyr/module.yml` with `build:settings:module_ext_root` settings. MODULE_EXT_ROOT' is a list of directories, similar to other roots such as BOARD_ROOT, DTS_ROOT, etc. The Zephyr repo folder ${ZEPHYR_BASE} is always to the MODULE_EXT_ROOT list as lowest priority. For each MODULE_EXT_ROOT, the file `<module_ext_root>/modules/modules.cmake` will be processed. In Zephyr repo, the folder `modules/<module>/` contains CMakeLists.txt and Kconfig glue code for the Zephyr module. A Zephyr module can specify that CMakeLists.txt and Kconfig glue code is placed in an external module root by specifying: ``` build: cmake-ext: True kconfig-ext: True ``` It is still possible to place the CMakeLists.txt and Kconfig files directly in the Zephyr module using the existing: ``` build: cmake: <path> kconfig: <file> ```. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-12-17 18:27:42 +08:00
string(CONFIGURE ${module} module)
cmake: zephyr module processing improvements. This commit improves Zephyr modules support in CMake. All Zephyr modules will now have a corresponding `ZEPHYR_${module_name}_MODULE_DIR` set, regardless of whether they define a cmake folder in module.yml. This results in: `ZEPHYR_${module_name}_MODULE_DIR` defined for all modules and refers to the root of the modle. `ZEPHYR_${module_name}_CMAKE_DIR` defined for modules that specifies cmake in module.yml, or is having both a CMakeLists.txt and Kconfig file in the zephyr folder. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-08-25 19:32:33 +08:00
string(REGEX REPLACE "\"(.*)\":\".*\":\".*\"" "\\1" module_name ${module})
string(REGEX REPLACE "\".*\":\"(.*)\":\".*\"" "\\1" module_path ${module})
string(REGEX REPLACE "\".*\":\".*\":\"(.*)\"" "\\1" cmake_path ${module})
cmake: zephyr modules variable names. This commit refactors processing of Zephyr modules. The Zephyr module name processing has been moved to zephyr_modules.cmake to ensure that all `ZEPHYR_<MODULE_NAME>_MODULE_DIR` are defined early in the build system. No changes to inclusion of Zephyr module CMake code. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-08-24 17:01:04 +08:00
cmake: zephyr modules: sanitize all module name when used as variable The introduction of Zephyr module glue code in the Zephyr repository introduces a Kconfig variable in the form of: `config ZEPHYR_<MODULE_NAME>_MODULE`. All Kconfig variables go into `autoconf.h`, therefore it is necessary to sanitize the Kconfig variable, so that it does not contain special characters. To ensure consistent variable name, then the module name will be sanitized in all variable use in both Kconfig and CMake. The sanitization is done be replacing all special characters with an underscore, `_`. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-01-19 19:01:38 +08:00
zephyr_string(SANITIZE TOUPPER MODULE_NAME_UPPER ${module_name})
cmake: Zephyr module error on module name current In CMake, ZEPHYR_CURRENT_MODULE_DIR is used during processing of module CMakeLists.txt files. If a module is named `current` then it's corresponding `ZEPHYR_<module_name>_MODULE_DIR` would become ZEPHYR_CURRENT_MODULE_DIR and thus colliding with internal Zephyr CMake variable. Using module name `current` is therefore forbidden. Print an error to users when a module named `current` is used in Zephyr. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-08-26 15:45:08 +08:00
if(NOT ${MODULE_NAME_UPPER} STREQUAL CURRENT)
set(ZEPHYR_${MODULE_NAME_UPPER}_MODULE_DIR ${module_path})
set(ZEPHYR_${MODULE_NAME_UPPER}_CMAKE_DIR ${cmake_path})
else()
message(FATAL_ERROR "Found Zephyr module named: ${module_name}\n\
${MODULE_NAME_UPPER} is a restricted name for Zephyr modules as it is used for \
\${ZEPHYR_${MODULE_NAME_UPPER}_MODULE_DIR} CMake variable.")
endif()
cmake: zephyr modules variable names. This commit refactors processing of Zephyr modules. The Zephyr module name processing has been moved to zephyr_modules.cmake to ensure that all `ZEPHYR_<MODULE_NAME>_MODULE_DIR` are defined early in the build system. No changes to inclusion of Zephyr module CMake code. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-08-24 17:01:04 +08:00
endforeach()
endif()
zephyr_module.cmake: restore ability to build without modules Kconfig.modules used to be an empty file when no modules. PR #14667 / commit bd7569f27288 "cmake: Extracted Zephyr module processing into python script" unintentionally changed that to no Kconfig.modules file at all when no west and no modules. kconfig.py doesn't like that and crashes. Restore the empty file. Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2019-03-30 14:35:12 +08:00
else()
file(WRITE ${KCONFIG_MODULES_FILE}
cmake: create a root.cmake CMake module The root.cmake CMake module remove boilerplate code and place it inside a dedicated root.cmake CMake module. This is part of a general CMake overhaul to allow better modularization and reuse of the Zephyr build system. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-12-16 22:52:28 +08:00
"# No west and no Zephyr modules\n"
zephyr_module.cmake: restore ability to build without modules Kconfig.modules used to be an empty file when no modules. PR #14667 / commit bd7569f27288 "cmake: Extracted Zephyr module processing into python script" unintentionally changed that to no Kconfig.modules file at all when no west and no modules. kconfig.py doesn't like that and crashes. Restore the empty file. Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2019-03-30 14:35:12 +08:00
)
cmake: Extracted Zephyr module processing into python script Fixes: #14513 This commit move the functionality of extracting zephyr modules into generated CMake and Kconfig include files from CMake into python. This allows other tools, especially CI to re-use the zephyr module functionality. Signed-off-by: Torsten Rasmussen <torsten.rasmussen@nordicsemi.no>
2019-03-19 17:38:18 +08:00
endif()