michaelh/zephyr
1
0
Fork 0
Code Releases Activity
zephyr/cmake/zephyr_module.cmake

55 lines
1.6 KiB
CMake
Raw Permalink 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 15:08:09 +02:00
# SPDX-License-Identifier: Apache-2.0
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 10:36:22 +01:00
# This cmake file provides functionality to import additional out-of-tree, OoT
# CMakeLists.txt and Kconfig files into Zephyr build system.
# It uses -DZEPHYR_MODULES=<oot-path-to-module>[;<additional-oot-module(s)>]
# given to CMake for a list of folders to search.
# It looks for: <oot-module>/zephyr/module.yml or
# <oot-module>/zephyr/CMakeLists.txt
# to load the oot-module into Zephyr build system.
# If west is available, it uses `west list` to obtain a list of projects to
# search for zephyr/module.yml
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 10:38:18 +01: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 10:36:22 +01: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 10:38:18 +01: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 10:36:22 +01: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 07:35:12 +01:00
set(KCONFIG_MODULES_FILE ${CMAKE_BINARY_DIR}/Kconfig.modules)
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 12:27:17 +02: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-08 21:09:15 +02: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 12:27:17 +02: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 10:38:18 +01: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 12:27:17 +02: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 10:38:18 +01: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 07:35:12 +01: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 10:38:18 +01:00
--cmake-out ${CMAKE_BINARY_DIR}/zephyr_modules.txt
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 10:36:22 +01: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 10:38:18 +01:00
if(${zephyr_module_return})
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 10:36:22 +01: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 07:35:12 +01:00
else()
file(WRITE ${KCONFIG_MODULES_FILE}
"# No west and no modules\n"
)
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 10:38:18 +01:00
endif()
Copy permalink