3a345682ba
This commit introduces EXTRA_CONF_FILE and deprecates OVERLAY_CONFIG. It has often caused confusion that OVERLAY_CONFIG adds extra configuration fragments to the value of CONF_FILE (default: prj.conf), but the similar named variable DTC_OVERLAY_FILE replaces the default dtc overlay file used by the build system. To remove such confusion, this commit introduces the EXTRA_ prefix in front of CONF_FILE to clearly indicate it's purpose. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
120 lines
5.1 KiB
CMake
120 lines
5.1 KiB
CMake
# SPDX-License-Identifier: Apache-2.0
|
||
#
|
||
# Copyright (c) 2021, Nordic Semiconductor ASA
|
||
|
||
# Zephyr build system configuration files.
|
||
#
|
||
# Locate the Kconfig and DT config files that are to be used.
|
||
# Also, locate the appropriate application config directory.
|
||
#
|
||
# Outcome:
|
||
# The following variables will be defined when this CMake module completes:
|
||
#
|
||
# - CONF_FILE: List of Kconfig fragments
|
||
# - EXTRA_CONF_FILE: List of additional Kconfig fragments
|
||
# - DTC_OVERLAY_FILE: List of devicetree overlay files
|
||
# - APPLICATION_CONFIG_DIR: Root folder for application configuration
|
||
#
|
||
# If any of the above variables are already set when this CMake module is
|
||
# loaded, then no changes to the variable will happen.
|
||
#
|
||
# Variables set by this module and not mentioned above are considered internal
|
||
# use only and may be removed, renamed, or re-purposed without prior notice.
|
||
|
||
include_guard(GLOBAL)
|
||
|
||
include(extensions)
|
||
|
||
zephyr_get(APPLICATION_CONFIG_DIR)
|
||
if(DEFINED APPLICATION_CONFIG_DIR)
|
||
string(CONFIGURE ${APPLICATION_CONFIG_DIR} APPLICATION_CONFIG_DIR)
|
||
if(NOT IS_ABSOLUTE ${APPLICATION_CONFIG_DIR})
|
||
get_filename_component(APPLICATION_CONFIG_DIR ${APPLICATION_CONFIG_DIR} ABSOLUTE)
|
||
endif()
|
||
else()
|
||
# Application config dir is not set, so we default to the application
|
||
# source directory as configuration directory.
|
||
set(APPLICATION_CONFIG_DIR ${APPLICATION_SOURCE_DIR})
|
||
endif()
|
||
|
||
zephyr_get(CONF_FILE SYSBUILD LOCAL)
|
||
if(DEFINED CONF_FILE)
|
||
# This ensures that CACHE{CONF_FILE} will be set correctly to current scope
|
||
# variable CONF_FILE. An already current scope variable will stay the same.
|
||
set(CONF_FILE ${CONF_FILE})
|
||
|
||
# CONF_FILE has either been specified on the cmake CLI or is already
|
||
# in the CMakeCache.txt. This has precedence over the environment
|
||
# variable CONF_FILE and the default prj.conf
|
||
|
||
# In order to support a `prj_<name>.conf pattern for auto inclusion of board
|
||
# overlays, then we must first ensure only a single conf file is provided.
|
||
string(CONFIGURE "${CONF_FILE}" CONF_FILE_EXPANDED)
|
||
string(REPLACE " " ";" CONF_FILE_AS_LIST "${CONF_FILE_EXPANDED}")
|
||
list(LENGTH CONF_FILE_AS_LIST CONF_FILE_LENGTH)
|
||
if(${CONF_FILE_LENGTH} EQUAL 1)
|
||
# Need the file name to look for match.
|
||
# Need path in order to check if it is absolute.
|
||
get_filename_component(CONF_FILE_NAME ${CONF_FILE} NAME)
|
||
if(${CONF_FILE_NAME} MATCHES "prj_(.*).conf")
|
||
set(CONF_FILE_BUILD_TYPE ${CMAKE_MATCH_1})
|
||
set(CONF_FILE_INCLUDE_FRAGMENTS true)
|
||
endif()
|
||
endif()
|
||
elseif(CACHED_CONF_FILE)
|
||
# Cached conf file is present.
|
||
# That value has precedence over anything else than a new
|
||
# `cmake -DCONF_FILE=<file>` invocation.
|
||
set(CONF_FILE ${CACHED_CONF_FILE})
|
||
elseif(EXISTS ${APPLICATION_CONFIG_DIR}/prj_${BOARD}.conf)
|
||
set(CONF_FILE ${APPLICATION_CONFIG_DIR}/prj_${BOARD}.conf)
|
||
find_package(Deprecated COMPONENTS PRJ_BOARD)
|
||
elseif(EXISTS ${APPLICATION_CONFIG_DIR}/prj.conf)
|
||
set(CONF_FILE ${APPLICATION_CONFIG_DIR}/prj.conf)
|
||
set(CONF_FILE_INCLUDE_FRAGMENTS true)
|
||
else()
|
||
message(FATAL_ERROR "No prj.conf file was found in the ${APPLICATION_CONFIG_DIR} folder, "
|
||
"please read the Zephyr documentation on application development.")
|
||
endif()
|
||
|
||
if(CONF_FILE_INCLUDE_FRAGMENTS)
|
||
zephyr_file(CONF_FILES ${APPLICATION_CONFIG_DIR}/boards KCONF CONF_FILE BUILD ${CONF_FILE_BUILD_TYPE})
|
||
endif()
|
||
|
||
set(APPLICATION_CONFIG_DIR ${APPLICATION_CONFIG_DIR} CACHE INTERNAL "The application configuration folder")
|
||
set(CACHED_CONF_FILE ${CONF_FILE} CACHE STRING "If desired, you can build the application using\
|
||
the configuration settings specified in an alternate .conf file using this parameter. \
|
||
These settings will override the settings in the application’s .config file or its default .conf file.\
|
||
Multiple files may be listed, e.g. CONF_FILE=\"prj1.conf;prj2.conf\" \
|
||
The CACHED_CONF_FILE is internal Zephyr variable used between CMake runs. \
|
||
To change CONF_FILE, use the CONF_FILE variable.")
|
||
unset(CONF_FILE CACHE)
|
||
|
||
zephyr_file(CONF_FILES ${APPLICATION_CONFIG_DIR}/boards DTS APP_BOARD_DTS)
|
||
|
||
# The CONF_FILE variable is now set to its final value.
|
||
zephyr_boilerplate_watch(CONF_FILE)
|
||
|
||
zephyr_get(DTC_OVERLAY_FILE SYSBUILD LOCAL)
|
||
if(DTC_OVERLAY_FILE)
|
||
# DTC_OVERLAY_FILE has either been specified on the cmake CLI or is already
|
||
# in the CMakeCache.txt.
|
||
elseif(APP_BOARD_DTS)
|
||
set(DTC_OVERLAY_FILE ${APP_BOARD_DTS})
|
||
elseif(EXISTS ${APPLICATION_CONFIG_DIR}/${BOARD}.overlay)
|
||
set(DTC_OVERLAY_FILE ${APPLICATION_CONFIG_DIR}/${BOARD}.overlay)
|
||
elseif(EXISTS ${APPLICATION_CONFIG_DIR}/app.overlay)
|
||
set(DTC_OVERLAY_FILE ${APPLICATION_CONFIG_DIR}/app.overlay)
|
||
endif()
|
||
|
||
set(DTC_OVERLAY_FILE ${DTC_OVERLAY_FILE} CACHE STRING "If desired, you can \
|
||
build the application using the DT configuration settings specified in an \
|
||
alternate .overlay file using this parameter. These settings will override the \
|
||
settings in the board's .dts file. Multiple files may be listed, e.g. \
|
||
DTC_OVERLAY_FILE=\"dts1.overlay dts2.overlay\"")
|
||
|
||
# The DTC_OVERLAY_FILE variable is now set to its final value.
|
||
zephyr_boilerplate_watch(DTC_OVERLAY_FILE)
|
||
|
||
zephyr_get(EXTRA_CONF_FILE SYSBUILD LOCAL VAR EXTRA_CONF_FILE OVERLAY_CONFIG)
|