patrick/zephyr
1
0
Fork 0
Code Issues Pull requests Actions 8 Packages Projects Releases Wiki Activity
zephyr/Kconfig.zephyr

958 lines
30 KiB
Plaintext
Raw Normal View History

kconfig: Clean up header comments and make them consistent Use this short header style in all Kconfig files: # <description> # <copyright> # <license> ... Also change all <description>s from # Kconfig[.extension] - Foo-related options to just # Foo-related options It's clear enough that it's about Kconfig. The <description> cleanup was done with this command, along with some manual cleanup (big letter at the start, etc.) git ls-files '*Kconfig*' | \ xargs sed -i -E '1 s/#\s*Kconfig[\w.-]*\s*-\s*/# /' Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-01 13:45:29 +01:00
# General configuration options
Split main Kconfig to allow application specific Kconfig This will allow adding an application level Kconfig, for example mainmenu "Zephyr Application" config ZEPHYR_BASE string option env="ZEPHYR_BASE" config APPLICATION_BASE string option env="PROJECT_BASE" source "$ZEPHYR_BASE/Kconfig.zephyr" config TESTME bool "Test me" default y config BLAH bool "blah" default y source "$APPLICATION_BASE/src/Kconfig" In the application file, add the following for example: KBUILD_KCONFIG := $(PWD)/Kconfig export KBUILD_KCONFIG Change-Id: I7b7a6daace5f589ddadab0f0de54b5adc1b8dc86 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-08-22 20:43:07 +02:00
# Copyright (c) 2014-2015 Wind River Systems, Inc.
kconfig: untangle ordering and dependencies There are two major issues with the kconfig: () Some of the config options have incorrect dependencies inside help under menuconfig. For example, CONFIG_GPIO depends on BOARD_GALILEO. () Since the SoC and board specific kconfig files are parsed first, the help screen would say, for example, CONFIG_SPI is defined at arch/arm/soc/fsl_frdm_k64f/Kconfig. This is incorrect because the actual config is defined in drivers/spi/Kconfig. These cause great confusion to users of menuconfig/xconfig. To fix these, the SoC and board defaults are now to be parsed last. Note that the position swapping of defaults in this patch is due to the fact the the default parsed last will be used. And, spi_test is broken due to the fact that it requires CONFIG_SPI_INTEL_PORT_1, but never enables it anywhere. This is bypassed for now. Origin: refactored and edited from existing files Change-Id: I2a4b1ae5be4d27e68c960aa47d91ef350f2d500f Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2016-03-25 22:30:50 +01:00
# Copyright (c) 2016 Intel Corporation
kconfig: Separate MCUboot options to Kconfig.mcuboot Move Kconfig options related to MCUboot to Kconfig.mcuboot Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2023-05-11 13:47:21 +02:00
# Copyright (c) 2023 Nordic Semiconductor ASA
license: Replace Apache boilerplate with SPDX tag Replace the existing Apache 2.0 boilerplate header with an SPDX tag throughout the zephyr code tree. This patch was generated via a script run over the master branch. Also updated doc/porting/application.rst that had a dependency on line numbers in a literal include. Manually updated subsys/logging/sys_log.c that had a malformed header in the original file. Also cleanup several cases that already had a SPDX tag and we either got a duplicate or missed updating. Jira: ZEP-1457 Change-Id: I6131a1d4ee0e58f5b938300c2d2fc77d2e69572c Signed-off-by: David B. Kinder <david.b.kinder@intel.com> Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2017-01-19 02:01:01 +01:00
# SPDX-License-Identifier: Apache-2.0
kconfig: Prune kconfig files that don't match the ARCH or BOARD When Kconfiglib was introduced it caused a significant performance issue. This patch uses pruning to mitigate the performance issue. The pruning exploits the fact that before the Kconfig database is parsed we already know what ARCH and BOARD has been selected. So in theory we could prune away all Kconfig sources that are not related to the current ARCH or BOARD. In practice, it is only the Kconfig sources in zephyr/arch/$ARCH and zephyr/board/$ARCH/ that are easy to prune. Still, that is quite a few Kconfig sources. For qemu_x86 this patch reduced the number of parsed Kconfig source files from 632 to 272. This pruning resulted in a incremental reconfiguration (time cmake ..) speedup of 21% (0.56s to 0.46) and a clean build speedup of 4% (Using board qemu_x86 and sample hello_world). Furthermore, it should be easier to maintain ARCH's and BOARD's out-of-tree since the user now has a mechanism to redirect where Kconfig sources are found. But this has not been explored. Signed-off-by: Sebastian Bøe <sebastian.boe@nordicsemi.no>
2018-01-09 14:12:07 +01:00
west: sign: Add Kconfig with application version Adds a Kconfig option which controls the version of the application to use when the image is signed using imgtool. When an application VERSION file is present, the default value will be identical to the application version, else it will be 0.0.0+0, but a project may still decide another value, if it so prefers. Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no> Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2023-03-23 11:02:49 +01:00
osource "${APPLICATION_SOURCE_DIR}/VERSION"
kconfig: enclose module Kconfigs into a menu Solve the issue of having all module Kconfig land in the top level Kconfig menu when viewed in menuconfig. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-05-28 20:22:51 +02:00
kconfig: Clarify Kconfig.defconfig explanation in Kconfig.zephyr Group the 'source's of Kconfig.defconfig files together to make it clearer what the comment is talking about. Remove blank lines between the other 'source's too, splitting the 'source's into two groups. Also touch up the comment to make it more concrete and shorten it a bit. Mention that it applies to 'choice's as well. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2020-01-26 23:47:41 +01:00
# Include Kconfig.defconfig files first so that they can override defaults and
# other symbol/choice properties by adding extra symbol/choice definitions.
# After merging all definitions for a symbol/choice, Kconfig picks the first
# property (e.g. the first default) with a satisfied condition.
Kconfig: Use the first default with a satisfied condition Up until now, Zephyr has patched Kconfig to use the last 'default' with a satisfied condition, instead of the first one. I'm not sure why the patch was added (it predates Kconfiglib), but I suspect it's related to Kconfig.defconfig files. There are at least three problems with the patch: 1. It's inconsistent with how Kconfig works in other projects, which might confuse newcomers. 2. Due to oversights, earlier 'range' properties are still preferred, as well as earlier 'default' properties on choices. In addition to being inconsistent, this makes it impossible to override 'range' properties and choice 'default' properties if the base definition of the symbol/choice already has 'range'/'default' properties. I've seen errors caused by the inconsistency, and I suspect there are more. 3. A fork of Kconfiglib that adds the patch needs to be maintained. Get rid of the patch and go back to standard Kconfig behavior, as follows: 1. Include the Kconfig.defconfig files first instead of last in Kconfig.zephyr. 2. Include boards/Kconfig and arch/<arch>/Kconfig first instead of last in arch/Kconfig. 3. Include arch/<arch>/soc/*/Kconfig first instead of last in arch/<arch>/Kconfig. 4. Swap a few other 'source's to preserve behavior for some scattered symbols with multiple definitions. Swap 'source's in some no-op cases too, where it might match the intent. 5. Reverse the defaults on symbol definitions that have more than one default. Skip defaults that are mutually exclusive, e.g. where each default has an 'if <some board>' condition. They are already safe. 6. Remove the prefer-later-defaults patch from Kconfiglib. Testing was done with a Python script that lists all Kconfig symbols/choices with multiple defaults, along with a whitelist of fixed symbols. The script also verifies that there are no "unreachable" defaults hidden by defaults without conditions As an additional test, zephyr/.config was generated before and after the change for several samples and checked to be identical (after sorting). This commit includes some default-related cleanups as well: - Simplify some symbol definitions, e.g. where a default has 'if FOO' when the symbol already has 'depends on FOO'. - Remove some redundant 'default ""' for string symbols. This is the implicit default. Piggyback fixes for swapped ranges on BT_L2CAP_RX_MTU and BT_L2CAP_TX_MTU (caused by confusing inconsistency). Piggyback some fixes for style nits too, e.g. unindented help texts. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-07-30 10:57:47 +02:00
#
kconfig: Clarify Kconfig.defconfig explanation in Kconfig.zephyr Group the 'source's of Kconfig.defconfig files together to make it clearer what the comment is talking about. Remove blank lines between the other 'source's too, splitting the 'source's into two groups. Also touch up the comment to make it more concrete and shorten it a bit. Mention that it applies to 'choice's as well. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2020-01-26 23:47:41 +01:00
# Shield defaults should have precedence over board defaults, which should have
# precedence over SoC defaults, so include them in that order.
Kconfig: Use the first default with a satisfied condition Up until now, Zephyr has patched Kconfig to use the last 'default' with a satisfied condition, instead of the first one. I'm not sure why the patch was added (it predates Kconfiglib), but I suspect it's related to Kconfig.defconfig files. There are at least three problems with the patch: 1. It's inconsistent with how Kconfig works in other projects, which might confuse newcomers. 2. Due to oversights, earlier 'range' properties are still preferred, as well as earlier 'default' properties on choices. In addition to being inconsistent, this makes it impossible to override 'range' properties and choice 'default' properties if the base definition of the symbol/choice already has 'range'/'default' properties. I've seen errors caused by the inconsistency, and I suspect there are more. 3. A fork of Kconfiglib that adds the patch needs to be maintained. Get rid of the patch and go back to standard Kconfig behavior, as follows: 1. Include the Kconfig.defconfig files first instead of last in Kconfig.zephyr. 2. Include boards/Kconfig and arch/<arch>/Kconfig first instead of last in arch/Kconfig. 3. Include arch/<arch>/soc/*/Kconfig first instead of last in arch/<arch>/Kconfig. 4. Swap a few other 'source's to preserve behavior for some scattered symbols with multiple definitions. Swap 'source's in some no-op cases too, where it might match the intent. 5. Reverse the defaults on symbol definitions that have more than one default. Skip defaults that are mutually exclusive, e.g. where each default has an 'if <some board>' condition. They are already safe. 6. Remove the prefer-later-defaults patch from Kconfiglib. Testing was done with a Python script that lists all Kconfig symbols/choices with multiple defaults, along with a whitelist of fixed symbols. The script also verifies that there are no "unreachable" defaults hidden by defaults without conditions As an additional test, zephyr/.config was generated before and after the change for several samples and checked to be identical (after sorting). This commit includes some default-related cleanups as well: - Simplify some symbol definitions, e.g. where a default has 'if FOO' when the symbol already has 'depends on FOO'. - Remove some redundant 'default ""' for string symbols. This is the implicit default. Piggyback fixes for swapped ranges on BT_L2CAP_RX_MTU and BT_L2CAP_TX_MTU (caused by confusing inconsistency). Piggyback some fixes for style nits too, e.g. unindented help texts. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-07-30 10:57:47 +02:00
#
kconfig: Clarify Kconfig.defconfig explanation in Kconfig.zephyr Group the 'source's of Kconfig.defconfig files together to make it clearer what the comment is talking about. Remove blank lines between the other 'source's too, splitting the 'source's into two groups. Also touch up the comment to make it more concrete and shorten it a bit. Mention that it applies to 'choice's as well. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2020-01-26 23:47:41 +01:00
# $ARCH and $BOARD_DIR will be glob patterns when building documentation.
kconfig: soc and shield cleanup Always source the Zephyr base soc and shield (board root) Kconfigs directly from Kconfig instead of generated Kconfig files. This has the benefit that it is no longer necessary to generate Kconfig files to source SoC root and shield (board root) when no custom roots are provided. Also this cleans up the doc/CMakeLists.txt and ensures that the doc/CMakeLists.txt is not getting out of sync with the Kconfig.cmake. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-06-02 08:47:21 +02:00
# This loads custom shields defconfigs (from BOARD_ROOT)
osource "$(KCONFIG_BINARY_DIR)/Kconfig.shield.defconfig"
# This loads Zephyr base shield defconfigs
source "boards/shields/*/Kconfig.defconfig"
Kconfig: Use new preprocessor syntax for env. variables With the new Kconfig preprocessor (described in https://github.com/torvalds/linux/blob/master/Documentation/kbuild/ kconfig-macro-language.txt), the syntax for expanding environment variables is $(FOO) rather than $FOO. $(FOO) is a general preprocessor variable expansion, which falls back to environment variables if the variable isn't set (like in Make). It can also be used in prompts, 'comment's, etc. The old syntax will probably be supported forever in Kconfiglib for backwards compatibility, but might as well make it consistent now that people might start using the preprocessor more. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-09-05 13:10:19 +02:00
source "$(BOARD_DIR)/Kconfig.defconfig"
kconfig: soc and shield cleanup Always source the Zephyr base soc and shield (board root) Kconfigs directly from Kconfig instead of generated Kconfig files. This has the benefit that it is no longer necessary to generate Kconfig files to source SoC root and shield (board root) when no custom roots are provided. Also this cleans up the doc/CMakeLists.txt and ensures that the doc/CMakeLists.txt is not getting out of sync with the Kconfig.cmake. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-06-02 08:47:21 +02:00
# This loads custom SoC root defconfigs
osource "$(KCONFIG_BINARY_DIR)/Kconfig.soc.defconfig"
# This loads Zephyr base SoC root defconfigs
osource "soc/$(ARCH)/*/Kconfig.defconfig"
armclang: ARM Compiler C library support Support for ARM Compiler C library. This commit add support for the ARM Compiler C libary in: - Kconfig - libc/armstdc A new Kconfig symbol is added to allow a toolchain to specify if they support linking with the minimal C library. Also the CMake variable `TOOLCHAIN_HAS_NEWLIB` is exported to Kconfig so that CONFIG_NEWLIB_LIBS can only be enabled if the toolchain has newlib. The armclang toolchain selects the CMake scatter file generator and disables support for the LD linker template which is not supported by armlink. For the ARM Compiler C library, a corresponding lib/libc/armstc/ folder with a minimal implementation to work with the ARM Compiler C library is added. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-08-15 23:14:21 +02:00
# This loads the toolchain defconfigs
osource "$(TOOLCHAIN_KCONFIG_DIR)/Kconfig.defconfig"
testsuite: ztress: Use XOSHIRO generator when ztress is used Use XOSHIRO random number generator if target has entropy generator. Some entropy generators may have limitations (e.g. only thread context) which would conflict with ztress usage. Added Kconfig.defconfig for testsuite. Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2022-09-06 12:50:10 +02:00
# This loads the testsuite defconfig
source "subsys/testsuite/Kconfig.defconfig"
Kconfig: Use the first default with a satisfied condition Up until now, Zephyr has patched Kconfig to use the last 'default' with a satisfied condition, instead of the first one. I'm not sure why the patch was added (it predates Kconfiglib), but I suspect it's related to Kconfig.defconfig files. There are at least three problems with the patch: 1. It's inconsistent with how Kconfig works in other projects, which might confuse newcomers. 2. Due to oversights, earlier 'range' properties are still preferred, as well as earlier 'default' properties on choices. In addition to being inconsistent, this makes it impossible to override 'range' properties and choice 'default' properties if the base definition of the symbol/choice already has 'range'/'default' properties. I've seen errors caused by the inconsistency, and I suspect there are more. 3. A fork of Kconfiglib that adds the patch needs to be maintained. Get rid of the patch and go back to standard Kconfig behavior, as follows: 1. Include the Kconfig.defconfig files first instead of last in Kconfig.zephyr. 2. Include boards/Kconfig and arch/<arch>/Kconfig first instead of last in arch/Kconfig. 3. Include arch/<arch>/soc/*/Kconfig first instead of last in arch/<arch>/Kconfig. 4. Swap a few other 'source's to preserve behavior for some scattered symbols with multiple definitions. Swap 'source's in some no-op cases too, where it might match the intent. 5. Reverse the defaults on symbol definitions that have more than one default. Skip defaults that are mutually exclusive, e.g. where each default has an 'if <some board>' condition. They are already safe. 6. Remove the prefer-later-defaults patch from Kconfiglib. Testing was done with a Python script that lists all Kconfig symbols/choices with multiple defaults, along with a whitelist of fixed symbols. The script also verifies that there are no "unreachable" defaults hidden by defaults without conditions As an additional test, zephyr/.config was generated before and after the change for several samples and checked to be identical (after sorting). This commit includes some default-related cleanups as well: - Simplify some symbol definitions, e.g. where a default has 'if FOO' when the symbol already has 'depends on FOO'. - Remove some redundant 'default ""' for string symbols. This is the implicit default. Piggyback fixes for swapped ranges on BT_L2CAP_RX_MTU and BT_L2CAP_TX_MTU (caused by confusing inconsistency). Piggyback some fixes for style nits too, e.g. unindented help texts. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-07-30 10:57:47 +02:00
kconfig: Move Kconfig.dts sourcing earlier Move Kconfig.dts before modules so that any of the auto generated symbols will be available to module Kconfigs. Signed-off-by: Kumar Gala <galak@kernel.org>
2022-08-12 17:00:38 +02:00
# This should be early since the autogen Kconfig.dts symbols may get
# used by modules
source "dts/Kconfig"
Kconfig.zephyr: allow override default values in module Kconfig files Allow Kconfig to override default values of Kconfig symbols defined in modules' Kconfig files. For that, the .defonfig files need to be source'd before the modules' Kconfig files. Signed-off-by: Ioannis Glaropoulos <Ioannis.Glaropoulos@nordicsemi.no>
2020-12-07 18:42:52 +01:00
menu "Modules"
source "modules/Kconfig"
endmenu
kconfig: move soc selection to ZEPHYR_BASE/soc/ Rather than do that for each architecture, source SoC Kconfigs where the code is maintained, under ZEPHYR_BASE/soc. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-09-04 15:32:07 +02:00
source "boards/Kconfig"
cmake: kconfig: support for multiple SOC_ROOT This commit introduces support for multiple SOC_ROOT. This means that additional SOC_ROOTs specified using -DSOC_ROOT as argument to CMake will be forming a list together with ${ZEPHYR_BASE}. This allows for greater flexibility, as developers can now specify multiple out-of-tree SoCs and not worry about the SoC used for the board they compile for. Also it avoid code, such as: if(BOARD STREQUAL my_board_using_out_of_tree_soc) set(SOC_ROOT some/out/of/tree/soc/path) endif() in application CMakeLists.txt. Finally, allowing multiple SOC_ROOTs prepares for specifying SOC_ROOTs in Zephyr modules. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2020-07-06 12:53:39 +02:00
source "soc/Kconfig"
kconfig: define architecture as a kconfig variable Do not depend on environment variables and use a kconfig variable for defining the architecture. In addition, remove the X86_32 variable, it just duplicates X86 for not good reason, at least until start supporting MCUs with 64bit. Change-Id: Ia001db81ed007e6a43f34506fed9be1345b88a4b Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2015-10-09 12:20:52 +02:00
source "arch/Kconfig"
source "kernel/Kconfig"
source "drivers/Kconfig"
tinycrypt: move from lib to regular objects tinycrypt was built using the lib- scripts without any real benefit. We also had a wrong placement of the Kconfig files under misc/ and a Kconfig file for Crypto that was never used before. Change-Id: I82d5902d92e7c06e10a95f418d9ead3cbcabcce4 Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-05-15 05:10:51 +02:00
source "lib/Kconfig"
fs: Move file system code to subsys/ Subsystems code will reside in subsys/ folder. This patch creates the folder and moves FS code there. Jira: ZEP-1120 Change-Id: If3b1bcb996c5fbd4056cd5d1920d41d29810d6b2 Signed-off-by: Ramesh Thomas <ramesh.thomas@intel.com>
2016-10-29 13:10:36 +02:00
source "subsys/Kconfig"
ext: plumb out Kconfig support for external source code Add missing Kconfig files and connections to expose Kconfig options in ext/ directories. Fixup QMSI to only be exposed on platforms that utilize it. Change-Id: I6c6c5011b2bf2966f65aa8279dc594a244821956 Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2016-05-24 21:23:26 +02:00
cmake: Introduce optional Kconfig for toolchains Allow a given toolchain to specify Kconfig options that might be relevant to a feature available in that toolchain. For example, the ARM embedded GNU toolchain supports two variants of newlib and you select the smaller one via a spec file. We can use a Kconfig option like HAS_NEWLIB_LIBC_NANO to convey that this feature is supported by that toolchain. We look for the toolchain Kconfig in ${TOOLCHAIN_KCONFIG_DIR}/Kconfig, and default TOOLCHAIN_KCONFIG_DIR to: ${TOOLCHAIN_ROOT}/cmake/toolchain/${ZEPHYR_TOOLCHAIN_VARIANT}) toolchain specific cmake files can override the default if needed. Additionally tweaked the zephyr/generic.cmake to use ${CMAKE_CURRENT_LIST_DIR} to reduce some duplication. Signed-off-by: Kumar Gala <kumar.gala@linaro.org> Signed-off-by: Sebastian Bøe <sebastian.boe@nordicsemi.no> Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2020-01-24 16:39:40 +01:00
osource "$(TOOLCHAIN_KCONFIG_DIR)/Kconfig"
modules: move module kconfig to main tree Due to in-tree dependencies on Kconfig options defined in modules we end up having warnings and errors when those modules are not part of the manifest. Users should be able to remove unwanted modules from their downstream manifest and still build any board configurations. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-05-23 23:19:41 +02:00
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
menu "Build and Link Features"
menu "Linker Options"
Kconfig: Provide name to orphan configuration choice symbol Kconfig choice section for LINKER_ORPHAN configuration has no name. This prevents configuring a default value in .defconfig files and constrain to set in _defconfig /.prj files. Then it is not possible to generalize this setting to a whole set of boards (soc series for instance) or make it dependent on another symbol. Provide it a name to add this flexibility. Signed-off-by: Erwan Gouriou <erwan.gouriou@st.com>
2023-03-22 15:09:48 +01:00
choice LINKER_ORPHAN_CONFIGURATION
linker: warn about orphan sections (Previous patch set was reverted due to issue with priv_stack. Resubmitting after fixing the faults caused by priv_stack.noinit not at the end of RAM.) This adds a linker flag and necessary changes to linker scripts so that linker will warn about orphan sections. Relates to #5534. Fixes #10473, #10474, #10515. Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2018-10-19 19:15:19 +02:00
prompt "Linker Orphan Section Handling"
default LINKER_ORPHAN_SECTION_WARN
config LINKER_ORPHAN_SECTION_PLACE
bool "Place"
help
Linker puts orphan sections in place without warnings
or errors.
config LINKER_ORPHAN_SECTION_WARN
bool "Warn"
help
docs: fix misspelling across the tree Found a few annoying typos and figured I better run script and fix anything it can find, here are the results... Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-06-18 20:45:40 +02:00
Linker places the orphan sections in output and issues
linker: warn about orphan sections (Previous patch set was reverted due to issue with priv_stack. Resubmitting after fixing the faults caused by priv_stack.noinit not at the end of RAM.) This adds a linker flag and necessary changes to linker scripts so that linker will warn about orphan sections. Relates to #5534. Fixes #10473, #10474, #10515. Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2018-10-19 19:15:19 +02:00
warning about those sections.
config LINKER_ORPHAN_SECTION_ERROR
bool "Error"
help
Linker exits with error when an orphan section is found.
endchoice
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
config HAS_FLASH_LOAD_OFFSET
bool
help
This option is selected by targets having a FLASH_LOAD_OFFSET
and FLASH_LOAD_SIZE.
kconfig: Factor out HAS_FLASH_LOAD_OFFSET dependency Use a top-level 'if' instead of three separate 'depends on'. They're exactly equivalent (top-level 'if's are just a shorthand for adding 'depends on' to each item within the 'if'). Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-16 01:33:09 +01:00
if HAS_FLASH_LOAD_OFFSET
kconfig: Rename USE_CODE_PARTITION to USE_DT_CODE_PARTITION USE_CODE_PARTITION is a bit vague as a symbol name ("use code partition how?"). Rename it to USE_DT_CODE_PARTITION to make it clearer that it's about devicetree. This would break any third-party configuration files that set it, but it'll generate an error since kconfig.py promotes warnings to errors, so it's probably not a big deal. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-16 01:22:16 +01:00
config USE_DT_CODE_PARTITION
kconfig: Improve USE_CODE_PARTITION prompt and help string The prompt and help string for USE_CODE_PARTITION were too terse and didn't make it clear that it's related to devicetree, which confused me. Spell things out in more detail. Unless the meaning of a symbol is completely obvious from context, aim for at least a few sentences of help text. Think about what would be confusing for someone coming at it without much context. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-16 01:16:57 +01:00
bool "Link application into /chosen/zephyr,code-partition from devicetree"
zephyr: fix mcuboot can't link into boot-partition Objective of the path is to allow to select by the application to link into the chosen code-partition. Introduced USE_CODE_PARTITION will be set by bootloader project. fixes #14566 Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2019-03-18 14:02:11 +01:00
help
kconfig: Improve USE_CODE_PARTITION prompt and help string The prompt and help string for USE_CODE_PARTITION were too terse and didn't make it clear that it's related to devicetree, which confused me. Spell things out in more detail. Unless the meaning of a symbol is completely obvious from context, aim for at least a few sentences of help text. Think about what would be confusing for someone coming at it without much context. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-16 01:16:57 +01:00
When enabled, the application will be linked into the flash partition
selected by the zephyr,code-partition property in /chosen in devicetree.
When this is disabled, the flash load offset and size can be set manually
below.
zephyr: fix mcuboot can't link into boot-partition Objective of the path is to allow to select by the application to link into the chosen code-partition. Introduced USE_CODE_PARTITION will be set by bootloader project. fixes #14566 Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2019-03-18 14:02:11 +01:00
kconfig: Convert device tree chosen properties to new kconfigfunctions Convert how we get the various chosen properties like "zephyr,console" to use the new kconfig functions like dt_chosen_to_label. Because of how kconfig parses things we define a set of variables of the form DT_CHOSEN_Z_<PROP> since comma's are parsed as field seperators in macros. This conversion allows us to remove code in gen_defines.py for the following chosen properties: zephyr,console zephyr,shell-uart zephyr,bt-uart zephyr,uart-pipe zephyr,bt-mon-uart zephyr,uart-mcumgr zephyr,bt-c2h-uart Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
2019-08-28 16:29:26 +02:00
# Workaround for not being able to have commas in macro arguments
DT_CHOSEN_Z_CODE_PARTITION := zephyr,code-partition
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
config FLASH_LOAD_OFFSET
kconfig: Rename USE_CODE_PARTITION to USE_DT_CODE_PARTITION USE_CODE_PARTITION is a bit vague as a symbol name ("use code partition how?"). Rename it to USE_DT_CODE_PARTITION to make it clearer that it's about devicetree. This would break any third-party configuration files that set it, but it'll generate an error since kconfig.py promotes warnings to errors, so it's probably not a big deal. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-16 01:22:16 +01:00
# Only user-configurable when USE_DT_CODE_PARTITION is disabled
hex "Kernel load offset" if !USE_DT_CODE_PARTITION
default $(dt_chosen_reg_addr_hex,$(DT_CHOSEN_Z_CODE_PARTITION)) if USE_DT_CODE_PARTITION
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
default 0
help
This option specifies the byte offset from the beginning of flash that
the kernel should be loaded into. Changing this value from zero will
affect the Zephyr image's link, and will decrease the total amount of
flash available for use by application code.
If unsure, leave at the default value 0.
config FLASH_LOAD_SIZE
kconfig: Rename USE_CODE_PARTITION to USE_DT_CODE_PARTITION USE_CODE_PARTITION is a bit vague as a symbol name ("use code partition how?"). Rename it to USE_DT_CODE_PARTITION to make it clearer that it's about devicetree. This would break any third-party configuration files that set it, but it'll generate an error since kconfig.py promotes warnings to errors, so it's probably not a big deal. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-16 01:22:16 +01:00
# Only user-configurable when USE_DT_CODE_PARTITION is disabled
hex "Kernel load size" if !USE_DT_CODE_PARTITION
default $(dt_chosen_reg_size_hex,$(DT_CHOSEN_Z_CODE_PARTITION)) if USE_DT_CODE_PARTITION
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
default 0
help
If non-zero, this option specifies the size, in bytes, of the flash
area that the Zephyr image will be allowed to occupy. If zero, the
image will be able to occupy from the FLASH_LOAD_OFFSET to the end of
the device.
If unsure, leave at the default value 0.
kconfig: Factor out HAS_FLASH_LOAD_OFFSET dependency Use a top-level 'if' instead of three separate 'depends on'. They're exactly equivalent (top-level 'if's are just a shorthand for adding 'depends on' to each item within the 'if'). Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-16 01:33:09 +01:00
endif # HAS_FLASH_LOAD_OFFSET
config: Rename TEXT_SECTION_OFFSET to ROM_START_OFFSET The `TEXT_SECTION_OFFSET` symbol is used to specify the offset between the beginning of the ROM area and the address of the first ROM section. This commit renames `TEXT_SECTION_OFFSET` to `ROM_START_OFFSET` because the first ROM section is not always the `.text` section. Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2020-02-10 08:37:24 +01:00
config ROM_START_OFFSET
kconfig: Removed prompt for TEXT_SECTION_OFFSET when MCUboot is used When this syntax is used for the type definition: hex "TEXT section offset" Kconfig expect the user to enter the value for TEXT_SECTION_OFFSET and the defaut value for BOOTLOADER_MCUBOOT is not used. Changing the syntax to this: hex prompt "TEXT section offset" if !BOOTLOADER_MCUBOOT will tell Kconfig that TEXT_SECTION_OFFSET will not be set by the user when BOOTLOADER_MCUBOOT is set and then Kconfig will use the default value. Signed-off-by: Ole Sæther <ole.saether@nordicsemi.no>
2019-01-23 14:13:03 +01:00
hex
config: Rename TEXT_SECTION_OFFSET to ROM_START_OFFSET The `TEXT_SECTION_OFFSET` symbol is used to specify the offset between the beginning of the ROM area and the address of the first ROM section. This commit renames `TEXT_SECTION_OFFSET` to `ROM_START_OFFSET` because the first ROM section is not always the `.text` section. Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2020-02-10 08:37:24 +01:00
prompt "ROM start offset" if !BOOTLOADER_MCUBOOT
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
default 0x200 if BOOTLOADER_MCUBOOT
default 0
help
If the application is built for chain-loading by a bootloader this
variable is required to be set to value that leaves sufficient
config: Rename TEXT_SECTION_OFFSET to ROM_START_OFFSET The `TEXT_SECTION_OFFSET` symbol is used to specify the offset between the beginning of the ROM area and the address of the first ROM section. This commit renames `TEXT_SECTION_OFFSET` to `ROM_START_OFFSET` because the first ROM section is not always the `.text` section. Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2020-02-10 08:37:24 +01:00
space between the beginning of the image and the start of the first
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
section to store an image header or any other metadata.
In the particular case of the MCUboot bootloader this reserves enough
space to store the image header, which should also meet vector table
alignment requirements on most ARM targets, although some targets
may require smaller or larger values.
kconfig: Add image size reduction option Adds a Kconfig option that can be used to reduce the available slot size of an application, this is useful for things like bootloaders whereby the bootloader or bootloader configuration reduces the available flash size that the image can occupy Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-10-30 18:16:31 +01:00
config ROM_END_OFFSET
hex "ROM end offset"
default 0
help
If non-zero, this option reduces the maximum size that the Zephyr image is allowed to
occupy, this is to allow for additional image storage which can be created and used by
other systems such as bootloaders (for MCUboot, this would include the image swap
fields and TLV storage at the end of the image).
If unsure, leave at the default value 0.
kconfig: cmake: CMake linker script generator symbol added A "Linker script" choice group has been added to the linker options menu. The existing HAVE_CUSTOM_LINKER_SCRIPT config has been relocated inside the linker script menu. Two new entries has been created: - LD template, for using the old ld template files together with the C pre-processor to create the final linker script. - CMake linker generator, used for ARMClang / armlink toolchain. The CMake linker generator is also supported for LD linker scripts for the ARM architecture. In CMake, the file cmake/linker/ld/target.cmake has been updated to support the CMake LD linker generator. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-06-09 11:22:07 +02:00
config LD_LINKER_SCRIPT_SUPPORTED
bool
default y
choice LINKER_SCRIPT
prompt "Linker script"
default LD_LINKER_TEMPLATE if LD_LINKER_SCRIPT_SUPPORTED
config LD_LINKER_TEMPLATE
bool "LD template"
depends on LD_LINKER_SCRIPT_SUPPORTED
help
Select this option to use the LD linker script templates.
The templates are pre-processed by the C pre-processor to create the
final LD linker script.
config CMAKE_LINKER_GENERATOR
bool "CMake generator"
depends on ARM
help
Select this option to use the Zephyr CMake linker script generator.
The linker configuration is written in CMake and the final linker
script will be generated by the toolchain specific linker generator.
For LD based linkers, this will be the ld generator, for ARMClang /
armlink based linkers it will be the scatter generator.
endchoice
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
config HAVE_CUSTOM_LINKER_SCRIPT
kconfig: cmake: CMake linker script generator symbol added A "Linker script" choice group has been added to the linker options menu. The existing HAVE_CUSTOM_LINKER_SCRIPT config has been relocated inside the linker script menu. Two new entries has been created: - LD template, for using the old ld template files together with the C pre-processor to create the final linker script. - CMake linker generator, used for ARMClang / armlink toolchain. The CMake linker generator is also supported for LD linker scripts for the ARM architecture. In CMake, the file cmake/linker/ld/target.cmake has been updated to support the CMake LD linker generator. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-06-09 11:22:07 +02:00
bool "Custom linker script provided"
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
help
Set this option if you have a custom linker script which needed to
be define in CUSTOM_LINKER_SCRIPT.
config CUSTOM_LINKER_SCRIPT
string "Path to custom linker script"
depends on HAVE_CUSTOM_LINKER_SCRIPT
help
Path to the linker script to be used instead of the one define by the
board.
The linker script must be based on a version provided by Zephyr since
the kernel can expect a certain layout/certain regions.
This is useful when an application needs to add sections into the
linker script and avoid having to change the script provided by
Zephyr.
config KERNEL_ENTRY
string "Kernel entry symbol"
default "__start"
help
Code entry symbol, to be set at linking phase.
cmake: LD: Allow input sections to remain unsorted We have users that have problems in their linker scripts where the order of input sections matters. To allow users to use the latest Zephyr while working on a fix to their linker scripts we add an option to allow leaving the sections unsorted. See discussion here for more details https://github.com/zephyrproject-rtos/zephyr/pull/14183 Signed-off-by: Sebastian Bøe <sebastian.boe@nordicsemi.no>
2019-03-15 14:05:09 +01:00
config LINKER_SORT_BY_ALIGNMENT
bool "Sort input sections by alignment"
default y
help
This turns on the linker flag to sort sections by alignment
in decreasing size of symbols. This helps to minimize
padding between symbols.
boards: stm32f0: explicit RAM vector table control Add a new Kconfig symbol that explicitly controls whether the vector table should be placed in RAM. This eliminates the side effect of `IS_BOOTLOADER` controlling vector table location. Making the condition a positive assertion also allows the config to be used in CMakeLists conditions (`zephyr_linker_sources_ifdef()`, etc). Signed-off-by: Jordan Yates <jordan.yates@data61.csiro.au>
2021-04-17 12:04:33 +02:00
config SRAM_VECTOR_TABLE
bool "Place the vector table in SRAM instead of flash"
help
The option specifies that the vector table should be placed at the
start of SRAM instead of the start of flash.
kernel: add CONFIG_SRAM_OFFSET This adds a new kconfig CONFIG_SRAM_OFFSET to specify the offset from beginning of SRAM where the kernel begins. On x86 and PC compatible platforms, the first 1MB of RAM is reserved and Zephyr should not link anything there. However, this 1MB still needs to be mapped by the MMU to access various platform related information. CONFIG_SRAM_OFFSET serves similar function as CONFIG_KERNEL_VM_OFFSET and is needed for proper phys/virt address translations. Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2021-02-20 20:02:17 +01:00
config HAS_SRAM_OFFSET
bool
help
This option is selected by targets that require SRAM_OFFSET.
config SRAM_OFFSET
hex "Kernel SRAM offset" if HAS_SRAM_OFFSET
default 0
help
This option specifies the byte offset from the beginning of SRAM
where the kernel begins. Changing this value from zero will affect
the Zephyr image's link, and will decrease the total amount of
SRAM available for use by application code.
If unsure, leave at the default value 0.
linker: add bits for boot regions This adds the necessary bits for linker scripts and source code to specify which symbols are needed for boot process so they can be grouped together. One use of this is to group boot related code and data so these won't interval with other kernel and application for better caching. This is a must for demand paging as some functions and data must be available during the boot process and before the memory manager is initialized. During this time, paging cannot be used so symbols linked in virtual memory space are unavailable. This is up to the arch/SoC/board to define the sections in their linker scripts as section may need special alignment which cannot be done in common script snippets. Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2021-02-24 19:18:34 +01:00
menu "Linker Sections"
config LINKER_USE_BOOT_SECTION
kconfig: tweak Kconfig prompts Tweak some Kconfig prompts after the removal of "Enable...". Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-03-09 12:31:16 +01:00
bool "Use Boot Linker Section"
linker: add bits for boot regions This adds the necessary bits for linker scripts and source code to specify which symbols are needed for boot process so they can be grouped together. One use of this is to group boot related code and data so these won't interval with other kernel and application for better caching. This is a must for demand paging as some functions and data must be available during the boot process and before the memory manager is initialized. During this time, paging cannot be used so symbols linked in virtual memory space are unavailable. This is up to the arch/SoC/board to define the sections in their linker scripts as section may need special alignment which cannot be done in common script snippets. Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2021-02-24 19:18:34 +01:00
help
If enabled, the symbols which are needed for the boot process
will be put into another linker section reserved for these
symbols.
Requires that boot sections exist in the architecture, SoC,
board or custom linker script.
linker: add bits for pinned regions This adds the necessary bits for linker scripts and source code to specify which symbols need to be pinned in memory. This is needed for demand paging as some functions and data must reside in memory all the time and cannot be paged out (e.g. paging, scheduler, and interrupt routines for functionality). This is up to the arch/SoC/board to define the sections in their linker scripts as the pinned section may need special alignment which cannot be done in common script snippets. Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2021-02-23 22:33:38 +01:00
config LINKER_USE_PINNED_SECTION
kconfig: tweak Kconfig prompts Tweak some Kconfig prompts after the removal of "Enable...". Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-03-09 12:31:16 +01:00
bool "Use Pinned Linker Section"
linker: add bits for pinned regions This adds the necessary bits for linker scripts and source code to specify which symbols need to be pinned in memory. This is needed for demand paging as some functions and data must reside in memory all the time and cannot be paged out (e.g. paging, scheduler, and interrupt routines for functionality). This is up to the arch/SoC/board to define the sections in their linker scripts as the pinned section may need special alignment which cannot be done in common script snippets. Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2021-02-23 22:33:38 +01:00
help
If enabled, the symbols which need to be pinned in memory
will be put into another linker section reserved for pinned
symbols. During boot, the corresponding memory will be marked
as pinned.
Requires that pinned sections exist in the architecture, SoC,
board or custom linker script.
kernel: add kconfig to say not all code/data is present at boot With demand paging and pinned sections enabled, it is possible for data to be brought into physical memory as required by current execution context. However, the kernel still assumes that all data pages are present at boot which may not be desirable for certain scenarios. This introduces a new kconfig to specify that those data pages other than the boot and pinned sections are not present, and they would be paged in on demand. Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2021-07-12 19:58:45 +02:00
config LINKER_GENERIC_SECTIONS_PRESENT_AT_BOOT
bool "Generic sections are present at boot" if DEMAND_PAGING && LINKER_USE_PINNED_SECTION
default y
help
When disabled, the linker sections other than the boot and
pinned sections will be marked as not present in the page
tables. This allows kernel to pull in data pages on demand
as required by current execution context when demand paging
is enabled. There is no need to load all code and data into
memory at once.
If unsure, say Y.
linker: correct linker script _flash_used calculation Linker scripts contains a `.last_section` section that is placed in rom region as NOLOAD for the purpose of retrieve the actual number of bytes contained in the image. See d85efe0b10f1f8ed4b854717f994062a4bbffe26 However, a previous section may cause the location counter to be incremented for alignment purposes. This can result in the size of the image to be 0x10FA but location counter to be 0x1100 because it has been aligned for next section placement. Therefore, two new Kconfig settings are introduced. Those settings request the linker to will write a pattern in `.last_section`. Together with removing NOLOAD and writing a patten to the section then we ensure that data is written after alignment of location counter, and thereby forces the image size to be in sync with the location counter. The default pattern used will be 0xE015 (end of last section). Some systems may fill up the flash completely, or simply write data at the end of the flash, which in both cases can result in overflow. Therefore, the new settings can be disabled. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2022-09-27 12:34:36 +02:00
config LINKER_LAST_SECTION_ID
bool "Last section identifier"
default y
depends on ARM || ARM64 || RISCV
help
If enabled, the last section will contain an identifier.
This ensures that the '_flash_used' linker symbol will always be
correctly calculated, even in cases where the location counter may
have been incremented for alignment purposes but no data is placed
after alignment.
Note: in cases where the flash is fully used, for example application
specific data is written at the end of the flash area, then writing a
last section identifier may cause rom region overflow.
In such cases this setting should be disabled.
config LINKER_LAST_SECTION_ID_PATTERN
hex "Last section identifier pattern"
default "0xE015E015"
depends on LINKER_LAST_SECTION_ID
help
Pattern to fill into last section as identifier.
Default pattern is 0xE015 (end of last section), but any pattern can
be used.
The size of the pattern must not exceed 4 bytes.
kconfig: linker: Add --no-relax build option In some architectures the linker performs global optimization relaxing address modes and changing intructions in the output object file. This is a problem when userspace is enabled since it assumes that addresses won't change after certain build stage. In no supported architectures this option is ignored. Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2022-12-20 19:36:34 +01:00
config LINKER_USE_NO_RELAX
bool
help
Hidden symbol to allow features to force the use of no relax.
config LINKER_USE_RELAX
bool "Linker optimization of call addressing"
depends on !LINKER_USE_NO_RELAX
default y
help
This option performs global optimizations that become possible when the linker resolves
addressing in the program, such as relaxing address modes and synthesizing new
instructions in the output object file. For ld and lld, this enables `--relax`.
On platforms where this is not supported, `--relax' is accepted, but ignored.
Disabling it can reduce performance, as the linker is no longer able to substiture long /
in-effective jump calls to shorter / more effective instructions.
linker: add bits for boot regions This adds the necessary bits for linker scripts and source code to specify which symbols are needed for boot process so they can be grouped together. One use of this is to group boot related code and data so these won't interval with other kernel and application for better caching. This is a must for demand paging as some functions and data must be available during the boot process and before the memory manager is initialized. During this time, paging cannot be used so symbols linked in virtual memory space are unavailable. This is up to the arch/SoC/board to define the sections in their linker scripts as section may need special alignment which cannot be done in common script snippets. Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2021-02-24 19:18:34 +01:00
endmenu # "Linker Sections"
linker: Add devnull memory for cortex_m and riscv32 Added memory region which is intended to be removed from the final binary but may be using in byproduct to extract data used by the host tools (e.g. strings used by logging). Add devnull region to Cortex-M and RISCV linker scripts. Signed-off-by: Krzysztof Chruściński <krzysztof.chruscinski@nordicsemi.no>
2022-04-22 11:36:05 +02:00
config LINKER_DEVNULL_SUPPORT
bool
default y if CPU_CORTEX_M || (RISCV && !64BIT)
config LINKER_DEVNULL_MEMORY
bool "Devnull region"
depends on LINKER_DEVNULL_SUPPORT
help
Devnull region is created. It is stripped from final binary but remains
in byproduct elf file.
config LINKER_DEVNULL_MEMORY_SIZE
int "Devnull region size"
depends on LINKER_DEVNULL_MEMORY
default 262144
help
Size can be adjusted so it fits all data placed in that region.
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
endmenu
menu "Compiler Options"
coding_guideline: Add an option to enforce rules Add a Kconfig option to enable compiler flags that help to enforce some code guideline rules. Note: As the current code base is not in compliance with the adopted code guideline, some rules will generate warnings during the build. This is intended to help to spot violations. Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2020-08-26 18:48:33 +02:00
config CODING_GUIDELINE_CHECK
bool "Enforce coding guideline rules"
help
Use available compiler flags to check coding guideline rules during
the build.
Kconfig.zephyr: Add NATIVE_LIBC and NATIVE_LIBCPP These are set when building against the host C or C++ libraries. This allows filtering tests that require use of a C library that sits atop Zephyr OS APIs. Signed-off-by: Keith Packard <keithp@keithp.com>
2023-10-12 20:55:04 +02:00
config NATIVE_LIBC
Kconfig: Add new NATIVE_LIBRARY and NATIVE_BUILD options To differentiate builds which will produce a native executable as direct output from the Zephyr build, or a library which can be used later. Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
2023-05-26 13:15:09 +02:00
bool
lib/libc: Add FULL_LIBC_SUPPORTED helper Kconfig symbol This symbol is selected when the target has any full libc available. This allows tests to filter on this condition. It doesn't depend on whether the application actually selects that library, only whether requesting a full C library would work. Signed-off-by: Keith Packard <keithp@keithp.com>
2023-02-08 22:44:39 +01:00
select FULL_LIBC_SUPPORTED
Kconfig.zephyr: Add NATIVE_LIBC and NATIVE_LIBCPP These are set when building against the host C or C++ libraries. This allows filtering tests that require use of a C library that sits atop Zephyr OS APIs. Signed-off-by: Keith Packard <keithp@keithp.com>
2023-10-12 20:55:04 +02:00
help
Zephyr will use the host system C library.
config NATIVE_LIBCPP
bool
select FULL_LIBCPP_SUPPORTED
help
Zephyr will use the host system C++ library
config NATIVE_BUILD
bool
select NATIVE_LIBC if EXTERNAL_LIBC
select NATIVE_LIBCPP if EXTERNAL_LIBCPP
Kconfig: Add new NATIVE_LIBRARY and NATIVE_BUILD options To differentiate builds which will produce a native executable as direct output from the Zephyr build, or a library which can be used later. Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
2023-05-26 13:15:09 +02:00
help
Zephyr will be built targeting the host system for debug and
development purposes.
config NATIVE_APPLICATION
bool
default y if ARCH_POSIX
depends on !NATIVE_LIBRARY
select NATIVE_BUILD
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
help
Build as a native application that can run on the host and using
resources and libraries provided by the host.
Kconfig: Add new NATIVE_LIBRARY and NATIVE_BUILD options To differentiate builds which will produce a native executable as direct output from the Zephyr build, or a library which can be used later. Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
2023-05-26 13:15:09 +02:00
config NATIVE_LIBRARY
bool
select NATIVE_BUILD
help
Build as a prelinked library for the native host target.
This library can later be built into an executable for the host.
toolchain: Add COMPILER_FREESTANDING to control use of -ffreestanding Add an explicit compiler configuration, COMPILER_FREESTANDING, which controls whether the compiler should operate in freestanding or hosted mode (according to the C and C++ language specifications. This depends on having a C library which conforms with the language specification, and the minimal C library does not. Have the minimal C library select COMPILER_FREESTANDING to continue using freestanding mode with that library. For other C libraries, leave this disabled by default while allowing users to enable it if they want to go back to the previous configuration. Signed-off-by: Keith Packard <keithp@keithp.com>
2023-02-08 23:56:50 +01:00
config COMPILER_FREESTANDING
bool "Build in a freestanding compiler mode"
help
Configure the compiler to operate in freestanding mode according to
the C and C++ language specifications. Freestanding mode reduces the
requirements of the compiler and language environment, which can
negatively impact the ability for the compiler to detect errors and
perform optimizations.
kconfig: add names to some choices In order to be able to make a "choice" from any other Kconfig.defconfig (-ish) file, the choice needs to be named. This commit names a few choices. Signed-off-by: Emil Lindqvist <emil@lindq.gr>
2021-09-03 13:52:33 +02:00
choice COMPILER_OPTIMIZATIONS
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
prompt "Optimization level"
default NO_OPTIMIZATIONS if COVERAGE
default DEBUG_OPTIMIZATIONS if DEBUG
default SIZE_OPTIMIZATIONS
help
Note that these flags shall only control the compiler
optimization level, and that no extra debug code shall be
conditionally compiled based on them.
config SIZE_OPTIMIZATIONS
bool "Optimize for size"
help
Compiler optimizations will be set to -Os independently of other
options.
config SPEED_OPTIMIZATIONS
bool "Optimize for speed"
help
Compiler optimizations will be set to -O2 independently of other
options.
config DEBUG_OPTIMIZATIONS
bool "Optimize debugging experience"
help
Compiler optimizations will be set to -Og independently of other
options.
config NO_OPTIMIZATIONS
bool "Optimize nothing"
help
Compiler optimizations will be set to -O0 independently of other
options.
kconfig: add note about increasing default stack sizes for -O0 Add a note about increasing default stack sizes to the CONFIG_NO_OPTIMIZATIONS help text. Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2023-03-22 10:19:40 +01:00
Selecting this option will likely require manual tuning of the
default stack sizes in order to avoid stack overflows.
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
endchoice
buildsystem: Add an option to enable LTO This commit adds option to enable Link Time Optimization. Signed-off-by: Radosław Koppel <radoslaw.koppel@nordicsemi.no>
2024-01-30 12:32:32 +01:00
config LTO
bool "Link Time Optimization [EXPERIMENTAL]"
depends on !(GEN_ISR_TABLES || GEN_IRQ_VECTOR_TABLE) || ISR_TABLES_LOCAL_DECLARATION
select EXPERIMENTAL
help
This option enables Link Time Optimization.
toolchain: Move extra warning options to toolchain abstraction Move extra warning option from generic twister script into compiler-dependent config files. ARCMWDT compiler doesn't support extra warning options ex. "-Wl,--fatal-warnings". To avoid build fails flag "disable_warnings_as_errors" should be passed to twister. This allows all warning messages and make atomatic test useles. Signed-off-by: Nikolay Agishev <agishev@synopsys.com>
2022-12-22 12:46:04 +01:00
config COMPILER_WARNINGS_AS_ERRORS
bool "Treat warnings as errors"
help
Turn on "warning as error" toolchain flags
kconfig,toolchain: add an option for compiler save-temps Add a Kconfig option to set the compiler save-temps flag and set the GCC implementation. This is very useful for troubleshooting macro expansion issues, having an option allows a user to set it like any other config option. Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2023-03-29 11:11:46 +02:00
config COMPILER_SAVE_TEMPS
bool "Save temporary object files"
help
Instruct the compiler to save the temporary intermediate files
permanently. These can be useful for troubleshooting build issues.
compiler: add CONFIG_COMPILER_TRACK_MACRO_EXPANSION Add a new compiler option to control tracking locations of tokens across macro expansions. It may be useful to disable it when debugging long macro expansion chains. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2023-05-05 09:58:12 +02:00
config COMPILER_TRACK_MACRO_EXPANSION
bool "Track macro expansion"
default y
help
When enabled, locations of tokens across macro expansions will be
tracked. Disabling this option may be useful to debug long macro
expansion chains.
cmake: gcc/clang: enable colour diagnostics in terminal output When compiler results are piped through a non-terminal (e.g. ninja) the compiler disables colour diagnostics. Using `-fdiagnostics-color` forces the compiler to enable colour output. This flag is always enabled for clang and gcc. Setting `CONFIG_COMPILER_COLOR_DIAGNOSTICS=n` disables this feature and reverts to plain diagnostic messages with no formatting. Signed-off-by: Arvin Farahmand <arvinf@ip-logix.com>
2021-04-15 17:20:10 +02:00
config COMPILER_COLOR_DIAGNOSTICS
kconfig: remove Enable from boolean prompts According to Kconfig guidelines, boolean prompts must not start with "Enable...". The following command has been used to automate the changes in this patch: sed -i "s/bool \"[Ee]nables\? \(\w\)/bool \"\U\1/g" **/Kconfig* Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-03-09 12:05:12 +01:00
bool "Colored diagnostics"
cmake: gcc/clang: enable colour diagnostics in terminal output When compiler results are piped through a non-terminal (e.g. ninja) the compiler disables colour diagnostics. Using `-fdiagnostics-color` forces the compiler to enable colour output. This flag is always enabled for clang and gcc. Setting `CONFIG_COMPILER_COLOR_DIAGNOSTICS=n` disables this feature and reverts to plain diagnostic messages with no formatting. Signed-off-by: Arvin Farahmand <arvinf@ip-logix.com>
2021-04-15 17:20:10 +02:00
default y
help
Compiler diagnostic messages are colorized.
cmake: Allow selection of libc API overflow detection mode This adds a choice of three different libc API buffer overflow detection modes: * None * Compile-time * Compile-time and Run-time These correspond with the clang/gcc _FORTIFY_SOURCE modes (0/1/2). _FORTIFY_SOURCE depends on compiler optimizations and require libc support which the minimal C library doesn't include, so _FORTIFY_SOURCE is disabled by default in those cases. Native tooling might also enable _FORTIFY_SOURCE, so don't enable it by default in that case either. Signed-off-by: Keith Packard <keithp@keithp.com>
2022-04-27 04:24:11 +02:00
choice COMPILER_SECURITY_FORTIFY
prompt "Detect buffer overflows in libc calls"
Kconfig: Tidy up dependants of NATIVE_APPLICATION So they depend or select on the right NATIVE_BUILD instead of NATIVE_APPLICATION. Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
2023-05-26 13:23:43 +02:00
default FORTIFY_SOURCE_NONE if NO_OPTIMIZATIONS || MINIMAL_LIBC || NATIVE_BUILD
cmake: Allow selection of libc API overflow detection mode This adds a choice of three different libc API buffer overflow detection modes: * None * Compile-time * Compile-time and Run-time These correspond with the clang/gcc _FORTIFY_SOURCE modes (0/1/2). _FORTIFY_SOURCE depends on compiler optimizations and require libc support which the minimal C library doesn't include, so _FORTIFY_SOURCE is disabled by default in those cases. Native tooling might also enable _FORTIFY_SOURCE, so don't enable it by default in that case either. Signed-off-by: Keith Packard <keithp@keithp.com>
2022-04-27 04:24:11 +02:00
default FORTIFY_SOURCE_COMPILE_TIME
help
Buffer overflow checking in libc calls. Supported by Clang and
GCC when using Picolibc or Newlib. Requires compiler optimization
to be enabled.
config FORTIFY_SOURCE_NONE
bool "No detection"
help
Disables both compile-time and run-time checking.
config FORTIFY_SOURCE_COMPILE_TIME
bool "Compile-time detection"
help
Enables only compile-time checking. Compile-time checking
doesn't increase executable size or reduce performance, it
limits checking to what can be done with information available
at compile time.
config FORTIFY_SOURCE_RUN_TIME
bool "Compile-time and run-time detection"
help
Enables both compile-time and run-time checking. Run-time
checking increases coverage at the expense of additional code,
and means that applications will raise a runtime exception
when buffer overflow is detected.
endchoice
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
config COMPILER_OPT
string "Custom compiler options"
help
This option is a free-form string that is passed to the compiler
when building all parts of a project (i.e. kernel).
The compiler options specified by this string supplement the
predefined set of compiler supplied by the build system,
and can be used to change compiler optimization, warning and error
messages, and so on.
Kconfig.zephyr: fix MISRA_SANE location This belongs under "Compiler Options", not "Boot Options" where it currently is. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2021-05-21 19:56:23 +02:00
config MISRA_SANE
bool "MISRA standards compliance features"
help
Causes the source code to build in "MISRA" mode, which
disallows some otherwise-permitted features of the C
standard for safety reasons. Specifically variable length
arrays are not permitted (and gcc will enforce this).
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
endmenu
base: add error checking macros Define there options for runtime error handling: - assert on all errors (ASSERT_ON_ERRORS) - no runtime checks (no asserts, no runtime error handling) (NO_RUNTIME_CHECKS) - full runtime error handling (the default) (RUNTIME_ERROR_CHECKS) Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-11-24 17:28:38 +01:00
choice
prompt "Error checking behavior for CHECK macro"
default RUNTIME_ERROR_CHECKS
config ASSERT_ON_ERRORS
bool "Assert on all errors"
help
Assert on errors covered with the CHECK macro.
config NO_RUNTIME_CHECKS
bool "No runtime error checks"
help
Do not do any runtime checks or asserts when using the CHECK macro.
config RUNTIME_ERROR_CHECKS
kconfig: remove Enable from boolean prompts According to Kconfig guidelines, boolean prompts must not start with "Enable...". The following command has been used to automate the changes in this patch: sed -i "s/bool \"[Ee]nables\? \(\w\)/bool \"\U\1/g" **/Kconfig* Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-03-09 12:05:12 +01:00
bool "Runtime error checks"
base: add error checking macros Define there options for runtime error handling: - assert on all errors (ASSERT_ON_ERRORS) - no runtime checks (no asserts, no runtime error handling) (NO_RUNTIME_CHECKS) - full runtime error handling (the default) (RUNTIME_ERROR_CHECKS) Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-11-24 17:28:38 +01:00
help
Always perform runtime checks covered with the CHECK macro. This
option is the default and the only option used during testing.
endchoice
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
menu "Build Options"
config KERNEL_BIN_NAME
string "The kernel binary name"
default "zephyr"
help
This option sets the name of the generated kernel binary.
config OUTPUT_STAT
bool "Create a statistics file"
default y
help
Create a stat file using readelf -e <elf>
build: generate symbols file Optional way for generating symbols file using binutils. This file will be generated on demand for tests which will then be parsed by twister to create an accurate test plan from the listed testcase/suites. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-06-27 16:08:37 +02:00
config OUTPUT_SYMBOLS
bool "Create a symbol file"
help
Create a symbol file using nm <elf>
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
config OUTPUT_DISASSEMBLY
bool "Create a disassembly file"
help
Create an .lst file with the assembly listing of the firmware.
cmake: Assembly listing containing all sections Added support for creating an assembly listing containing all sections like rodata, data and debug sections, not just those expected to contain instructions. Signed-off-by: Rohit Gujarathi <gujju.rohit@gmail.com>
2020-05-07 06:38:37 +02:00
config OUTPUT_DISASSEMBLE_ALL
bool "Disassemble all sections with source. Fill zeros."
default n
depends on OUTPUT_DISASSEMBLY
help
The .lst file will contain complete disassembly of the firmware
not just those expected to contain instructions including zeros
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
config OUTPUT_PRINT_MEMORY_USAGE
bool "Print memory usage to stdout"
default y
help
If the toolchain supports it, this option will pass
--print-memory-region to the linker when it is doing it's first
linker pass. Note that the memory regions are symbolic concepts
defined by the linker scripts and do not necessarily map
directly to the real physical address space. Take also note that
some platforms do two passes of the linker so the results do not
match exactly to the final elf file. See also rom_report,
ram_report and
https://sourceware.org/binutils/docs/ld/MEMORY.html
build: add option to delete intermediate files Add option to remove intermediate files to save space and remove clutter. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-10-20 20:31:56 +02:00
config CLEANUP_INTERMEDIATE_FILES
bool "Remove all intermediate files"
help
Delete intermediate files to save space and cleanup clutter resulting
kconfig: expand the CLEANUP_INTERMEDIATE_FILES symbol description Y-selecting CLEANUP_INTERMEDIATE_FILES negatively impacts tools/commands that depend on the build artifacts being present. One such case is the `west spdx` command used for Software Bill of Material generation. If CLEANUP_INTERMEDIATE_FILES is y-selected, build files are removed from the `cfgTarget.target.artifacts` list. This in turn causes the `addBuildFile` function to nod add them to `pkg`, so `pkg.targetBuildFile` is `None` in `scripts/west_commands/zspdx/walker.py`. This commit expands the help message for the CLEANUP_INTERMEDIATE_FILES symbol to inform the user of the possible negative impact of selecting this symbol. Signed-off-by: Filip Kokosinski <fkokosinski@antmicro.com>
2023-07-19 15:40:55 +02:00
from the build process. Note this breaks incremental builds, west spdx
(Software Bill of Material generation), and maybe others.
build: add option to delete intermediate files Add option to remove intermediate files to save space and remove clutter. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2020-10-20 20:31:56 +02:00
Kconfig.zephyr: help text fixes The text "need by some platforms" in various CONFIG_BUILD_OUTPUT_FOO help is grammatically incorrect. Fix this by rewording. Move 'config BUILD_NO_GAP_FILL' to before the list of 'config BUILD_OUTPUT_FOO' definitions instead of sandwiching it inside. Fix the extension of the stripped binary. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-08-06 23:57:17 +02:00
config BUILD_NO_GAP_FILL
bool "Don't fill gaps in generated hex/bin/s19 files."
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
config BUILD_OUTPUT_HEX
bool "Build a binary in HEX format"
help
Kconfig.zephyr: help text fixes The text "need by some platforms" in various CONFIG_BUILD_OUTPUT_FOO help is grammatically incorrect. Fix this by rewording. Move 'config BUILD_NO_GAP_FILL' to before the list of 'config BUILD_OUTPUT_FOO' definitions instead of sandwiching it inside. Fix the extension of the stripped binary. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-08-06 23:57:17 +02:00
Build an Intel HEX binary zephyr/zephyr.hex in the build directory.
The name of this file can be customized with CONFIG_KERNEL_BIN_NAME.
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
config BUILD_OUTPUT_BIN
bool "Build a binary in BIN format"
default y
help
Kconfig.zephyr: help text fixes The text "need by some platforms" in various CONFIG_BUILD_OUTPUT_FOO help is grammatically incorrect. Fix this by rewording. Move 'config BUILD_NO_GAP_FILL' to before the list of 'config BUILD_OUTPUT_FOO' definitions instead of sandwiching it inside. Fix the extension of the stripped binary. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-08-06 23:57:17 +02:00
Build a "raw" binary zephyr/zephyr.bin in the build directory.
The name of this file can be customized with CONFIG_KERNEL_BIN_NAME.
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
boards: x86: depend on CONFIG_BUILD_OUTPUT_EFI Add a new Kconfig CONFIG_BUILD_OUTPUT_EFI and select that for boards that want to generate an EFI application. Make qemu_x86_64 also generate an EFI file, however do not enable this by default yet. Goal is to boot qemu using EFI to be able to test this path in the future. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2021-01-26 12:58:30 +01:00
config BUILD_OUTPUT_EFI
bool "Build as an EFI application"
default n
depends on X86_64
help
Build as an EFI application.
This works by creating a "zephyr.efi" EFI binary containing a zephyr
image extracted from a built zephyr.elf file. EFI applications are
relocatable, and cannot be placed at specific locations in memory.
Instead, the stub code will copy the embedded zephyr sections to the
appropriate locations at startup, clear any zero-filled (BSS, etc...)
areas, then jump into the 64 bit entry point.
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
config BUILD_OUTPUT_EXE
bool "Build a binary in ELF format with .exe extension"
help
Kconfig.zephyr: help text fixes The text "need by some platforms" in various CONFIG_BUILD_OUTPUT_FOO help is grammatically incorrect. Fix this by rewording. Move 'config BUILD_NO_GAP_FILL' to before the list of 'config BUILD_OUTPUT_FOO' definitions instead of sandwiching it inside. Fix the extension of the stripped binary. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-08-06 23:57:17 +02:00
Build an ELF binary that can run in the host system at
zephyr/zephyr.exe in the build directory.
The name of this file can be customized with CONFIG_KERNEL_BIN_NAME.
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
config BUILD_OUTPUT_S19
bool "Build a binary in S19 format"
help
Kconfig.zephyr: help text fixes The text "need by some platforms" in various CONFIG_BUILD_OUTPUT_FOO help is grammatically incorrect. Fix this by rewording. Move 'config BUILD_NO_GAP_FILL' to before the list of 'config BUILD_OUTPUT_FOO' definitions instead of sandwiching it inside. Fix the extension of the stripped binary. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-08-06 23:57:17 +02:00
Build an S19 binary zephyr/zephyr.s19 in the build directory.
The name of this file can be customized with CONFIG_KERNEL_BIN_NAME.
kconfig: cmake: Support for images without gaps. Defines a Kconfig variable which allows the user to specify that any generated hex/bin/s19 file should not have filled gaps. This is done to support building in a multi image context, where several image files will be merged together. Signed-off-by: Håkon Øye Amundsen <haakon.amundsen@nordicsemi.no>
2018-11-26 10:47:16 +01:00
cmake: Add UF2 as an additional build output option. Add ability to build a UF2 (https://github.com/Microsoft/uf2) image as an additional output type. This leverages the code partition offset for the UF2 base address, and a configurable UF2 family ID. Includes an unmodified (except for headers for licensing, pylit disabling) version of the uf2conv.py script copied the UF2 format specification repository, used to convert the bin to UF2. Origin: UF2 file format specification reference utilies License: MIT URL: https://github.com/microsoft/uf2/blob/master/utils/uf2conv.py commit: 587abb8b909266e9b468d6284f2fbd425235d1b5 Signed-off-by: Pete Johanson <peter@peterjohanson.com>
2020-12-31 22:51:52 +01:00
config BUILD_OUTPUT_UF2
bool "Build a binary in UF2 format"
depends on BUILD_OUTPUT_BIN
help
Build a UF2 binary zephyr/zephyr.uf2 in the build directory.
The name of this file can be customized with CONFIG_KERNEL_BIN_NAME.
if BUILD_OUTPUT_UF2
config BUILD_OUTPUT_UF2_FAMILY_ID
soc: Add standard UF2 family IDs for supported SoCs. Defaults from https://github.com/Microsoft/uf2#family-list Signed-off-by: Pete Johanson <peter@peterjohanson.com>
2021-02-16 15:35:11 +01:00
string "UF2 device family ID"
soc: xtensa,riscv: esp32xx: refactor folder structure Refactor the ESP32 target SOCs together with all related boards. Most braking changes includes: - changing the CONFIG_SOC_ESP32* to refer to the actual soc line (esp32,esp32s2,esp32s3,esp32c3) - replacing CONFIG_SOC with the CONFIG_SOC_SERIES - creating CONFIG_SOC_FAMILY_ESP32 to embrace all the ESP32 across all used architectures - introducing CONFIG_SOC_PART_NUMBER_* to provide a SOC model config - introducing the 'common' folder to hide all commonly used configs and files. - updating west.yml to reflect previous changes in hal Signed-off-by: Marek Matej <marek.matej@espressif.com>
2023-07-20 18:24:09 +02:00
default "0x1c5f21b0" if SOC_SERIES_ESP32
soc: Add UF2 family ID for nRF52833 ID from https://github.com/Microsoft/uf2#family-list Signed-off-by: Xudong Zheng <7pkvm5aw@slicealias.com>
2022-03-22 17:15:50 +01:00
default "0x621e937a" if SOC_NRF52833_QIAA
soc: Add standard UF2 family IDs for supported SoCs. Defaults from https://github.com/Microsoft/uf2#family-list Signed-off-by: Pete Johanson <peter@peterjohanson.com>
2021-02-16 15:35:11 +01:00
default "0xada52840" if SOC_NRF52840_QIAA
default "0x4fb2d5bd" if SOC_SERIES_IMX_RT
default "0x2abc77ec" if SOC_SERIES_LPC55XXX
soc: rp2040: Added UF2 output file support Added support for the UF2 file format for the RP2040 SoC Signed-off-by: Yonatan Schachter <yonatan.schachter@gmail.com>
2022-02-01 22:05:04 +01:00
default "0xe48bff56" if SOC_SERIES_RP2XXX
soc: Add standard UF2 family IDs for supported SoCs. Defaults from https://github.com/Microsoft/uf2#family-list Signed-off-by: Pete Johanson <peter@peterjohanson.com>
2021-02-16 15:35:11 +01:00
default "0x68ed2b88" if SOC_SERIES_SAMD21
default "0x55114460" if SOC_SERIES_SAMD51
default "0x647824b6" if SOC_SERIES_STM32F0X
default "0x5d1a0a2e" if SOC_SERIES_STM32F2X
default "0x6b846188" if SOC_SERIES_STM32F3X
default "0x53b80f00" if SOC_SERIES_STM32F7X
default "0x300f5633" if SOC_SERIES_STM32G0X
default "0x4c71240a" if SOC_SERIES_STM32G4X
default "0x6db66082" if SOC_SERIES_STM32H7X
default "0x202e3a91" if SOC_SERIES_STM32L0X
default "0x1e1f432d" if SOC_SERIES_STM32L1X
default "0x00ff6919" if SOC_SERIES_STM32L4X
default "0x04240bdf" if SOC_SERIES_STM32L5X
default "0x70d16653" if SOC_SERIES_STM32WBX
default "0x5ee21072" if SOC_STM32F103XE
Kconfig.zephyr: Update UF2 ID for STM32F4 series Update UF2 family ID for the entire STM32F4 series, except STM32F407xx which have their own dedicated IDs. Signed-off-by: Guillaume Gautier <guillaume.gautier-ext@st.com>
2022-12-21 14:44:45 +01:00
default "0x57755a57" if SOC_SERIES_STM32F4X && (!SOC_STM32F407XE) && (!SOC_STM32F407XG)
soc: Add standard UF2 family IDs for supported SoCs. Defaults from https://github.com/Microsoft/uf2#family-list Signed-off-by: Pete Johanson <peter@peterjohanson.com>
2021-02-16 15:35:11 +01:00
default "0x6d0922fa" if SOC_STM32F407XE
default "0x8fb060fe" if SOC_STM32F407XG
cmake: Add UF2 as an additional build output option. Add ability to build a UF2 (https://github.com/Microsoft/uf2) image as an additional output type. This leverages the code partition offset for the UF2 base address, and a configurable UF2 family ID. Includes an unmodified (except for headers for licensing, pylit disabling) version of the uf2conv.py script copied the UF2 format specification repository, used to convert the bin to UF2. Origin: UF2 file format specification reference utilies License: MIT URL: https://github.com/microsoft/uf2/blob/master/utils/uf2conv.py commit: 587abb8b909266e9b468d6284f2fbd425235d1b5 Signed-off-by: Pete Johanson <peter@peterjohanson.com>
2020-12-31 22:51:52 +01:00
help
UF2 bootloaders only accept UF2 files with a matching family ID.
This can be either a hex, e.g. 0x68ed2b88, or well-known family
soc: Add standard UF2 family IDs for supported SoCs. Defaults from https://github.com/Microsoft/uf2#family-list Signed-off-by: Pete Johanson <peter@peterjohanson.com>
2021-02-16 15:35:11 +01:00
name string. If the SoC in use is known by UF2, the Family ID will
be pre-filled with the known value.
cmake: Add UF2 as an additional build output option. Add ability to build a UF2 (https://github.com/Microsoft/uf2) image as an additional output type. This leverages the code partition offset for the UF2 base address, and a configurable UF2 family ID. Includes an unmodified (except for headers for licensing, pylit disabling) version of the uf2conv.py script copied the UF2 format specification repository, used to convert the bin to UF2. Origin: UF2 file format specification reference utilies License: MIT URL: https://github.com/microsoft/uf2/blob/master/utils/uf2conv.py commit: 587abb8b909266e9b468d6284f2fbd425235d1b5 Signed-off-by: Pete Johanson <peter@peterjohanson.com>
2020-12-31 22:51:52 +01:00
build: uf2: Flexible UF2 offset selection. UF2 offset configurable to be either flash base reg + offset, or simply the flash bare reg if the offset is configured to be ignored. Signed-off-by: Peter Johanson <peter@peterjohanson.com>
2022-01-27 06:45:27 +01:00
config BUILD_OUTPUT_UF2_USE_FLASH_BASE
bool
default n
config BUILD_OUTPUT_UF2_USE_FLASH_OFFSET
bool
default n
cmake: Add UF2 as an additional build output option. Add ability to build a UF2 (https://github.com/Microsoft/uf2) image as an additional output type. This leverages the code partition offset for the UF2 base address, and a configurable UF2 family ID. Includes an unmodified (except for headers for licensing, pylit disabling) version of the uf2conv.py script copied the UF2 format specification repository, used to convert the bin to UF2. Origin: UF2 file format specification reference utilies License: MIT URL: https://github.com/microsoft/uf2/blob/master/utils/uf2conv.py commit: 587abb8b909266e9b468d6284f2fbd425235d1b5 Signed-off-by: Pete Johanson <peter@peterjohanson.com>
2020-12-31 22:51:52 +01:00
endif # BUILD_OUTPUT_UF2
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
config BUILD_OUTPUT_STRIPPED
bool "Build a stripped binary"
help
Kconfig.zephyr: help text fixes The text "need by some platforms" in various CONFIG_BUILD_OUTPUT_FOO help is grammatically incorrect. Fix this by rewording. Move 'config BUILD_NO_GAP_FILL' to before the list of 'config BUILD_OUTPUT_FOO' definitions instead of sandwiching it inside. Fix the extension of the stripped binary. Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2020-08-06 23:57:17 +02:00
Build a stripped binary zephyr/zephyr.strip in the build directory.
The name of this file can be customized with CONFIG_KERNEL_BIN_NAME.
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
cmake: support ELF image adjustment This commit adds support for adjust the addresses of the final image. This is useful when the image is to be flashed at a location different from the LMA address encoded in the ELF file by the linker. An example use-case is multicore systems where core A might load image from a flash partition into RAM in order for core B to execute and load, but where the image itself is build with the RAM addresses as LMA. It updates the zephyr_image_info.h header with information of adjustment value. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2022-01-12 14:21:07 +01:00
config BUILD_OUTPUT_ADJUST_LMA
string
help
This will adjust the LMA address in the final ELF and hex files with
the value provided.
This will not affect the internal address symbols inside the image but
can be useful when adjusting the LMA address for flash tools or multi
stage loaders where a pre-loader may copy image to a second location
before booting a second core.
The value will be evaluated as a math expression, this means that
following are valid expression
- 1024
- 0x1000
- -0x1000
- 0x20000000 - 0x10000000
Note: negative numbers are valid.
To adjust according to a chosen flash partition one can specify a
default as:
DT_CHOSEN_IMAGE_<name> := <name>,<name>-partition
DT_CHOSEN_Z_FLASH := zephyr,flash
config BUILD_OUTPUT_ADJUST_LMA
default "$(dt_chosen_reg_addr_hex,$(DT_CHOSEN_IMAGE_M4))-\
$(dt_chosen_reg_addr_hex,$(DT_CHOSEN_Z_FLASH))"
scripts: generate image info header file This commit adds the `gen_image_info.py` script which supports creation of a header file with image information from the EFL file. This version populates the header file with: - Number of segments in the image - LMA address of each segment - VMA address of each segment - Size of each segment The header file can be used by a secondary build system which needs this information. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2022-01-10 11:02:26 +01:00
config BUILD_OUTPUT_INFO_HEADER
bool "Create a image information header"
help
Create an image information header which will contain image
information from the Zephyr binary.
Example of information contained in the header file:
- Number of segments in the image
- LMA address of each segment
- VMA address of each segment
- Size of each segment
arch: arm: aarch32: introduce CONFIG_BUILD_ALIGN_LMA Introduce CONFIG_BUILD_ALIGN_LMA. When enabled, this symbol will add a padding section after the final read only data section in the image. This padding section will ensure that the LMA of the data sections follows the same alignment restrictions as the VMA does. This LMA alignment is needed for objcopy to adjust the LMA address of the output ELF file. Signed-off-by: Daniel DeGrasse <daniel.degrasse@nxp.com>
2023-07-28 21:47:45 +02:00
config BUILD_ALIGN_LMA
bool "Align LMA in output image"
default y if BUILD_OUTPUT_ADJUST_LMA!=""
help
Ensure that the LMA for each section in the output image respects
the alignment requirements of that section. This is required for
some tooling, such as objcopy, to be able to adjust the LMA of the
ELF file.
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
config APPLICATION_DEFINED_SYSCALL
bool "Scan application folder for any syscall definition"
help
Scan additional folders inside application source folder
for application defined syscalls.
cmake: Add option for exporting build metadata to Make Add an opt-in feature that will generate a Makefile with build variables like CC, and KBUILD_CFLAGS for consumption by third-party Make-based build systems. This emulates the 'outputexports' target that KBuild supported and is supported for the same reasons that KBuild supported it. Easier integration with third-party build systems. Signed-off-by: Sebastian Bøe <sebastian.boe@nordicsemi.no>
2019-10-17 14:25:34 +02:00
config MAKEFILE_EXPORTS
bool "Generate build metadata files named Makefile.exports"
help
Generates a file with build information that can be read by
third party Makefile-based build systems.
scripts: support for build meta file creation This commit is motivated by the west discussion in: https://github.com/zephyrproject-rtos/west/issues/548 The commit provides the ability to generate a build meta info file containing lists of: - Zephyr: path and revision - Zephyr modules: name, path, and revision - West: manifest path path and revision for each project For Zephyr or Zephyr modules the revision will be `null` if it is not under git version control. If Zephyr, a modules, or a project has uncommitted changes, the revision will be marked dirty. If west is not installed or used for the build process, the west-projects list will be empty. If a project is both a Zephyr module and a west project it will show up in both lists. Similar to Zephyr, which is independently referred as the Zephyr in use but also listed as west project when west is used. This is important in case ZEPHYR_BASE was manually set and pointing to a different Zephyr repository. The build meta file is not created per default but can be enabled with the BUILD_OUTPUT_META Kconfig setting. A project using west and having an extra Zephyr module loaded not controlled using git can look like: zephyr: path: /.../zephyr revision: 863600cd0e3c0a271e86629c5089821e5e4380cc-dirty modules: - name: mcuboot path: /.../bootloader/mcuboot revision: c61538748ead773ea75a551a7beee299228bdcaf - name: local_module path: /.../local_module revision: null west: manifest: /.../zephyr/west.yml projects: - path: /.../zephyr revision: 863600cd0e3c0a271e86629c5089821e5e4380cc-dirty - path: /.../bootloader/mcuboot revision: c61538748ead773ea75a551a7beee299228bdcaf - path: /.../tools/net-tools revision: f49bd1354616fae4093bf36e5eaee43c51a55127 And without west: zephyr: path: /.../zephyr revision: 863600cd0e3c0a271e86629c5089821e5e4380cc-dirty modules: - name: hal_nordic path: /.../modules/hal/nordic revision: a6e5299041f152da5ae0ab17b2e44e088bb96d6d west: null Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-10-12 23:08:36 +02:00
config BUILD_OUTPUT_META
bool "Create a build meta file"
help
Create a build meta file in the build directory containing lists of:
- Zephyr: path and revision (if git repo)
- Zephyr modules: name, path, and revision (if git repo)
scripts: build meta file workspace status extension The PR #39382 raised a discussion on build reproducibility and knowledge of west projects being out of sync with the west manifest. Similar to how `git submodules` will report the working tree dirty if any of the submodules HEAD points to a SHA different than the one recorded in the super project. Based on this discussion this commit extends the Zephyr build meta file with overall workspace status included in the meta file. It adds the following meta info to the build meta file: > workspace: > dirty: false / true > extra: false / true > off: false / true A project using west and having an extra Zephyr module loaded not controlled using git and a west project at a SHA different than the SHA referenced by the manifest can look like: zephyr: path: /.../zephyr revision: 863600cd0e3c0a271e86629c5089821e5e4380cc modules: - name: mcuboot path: /.../bootloader/mcuboot revision: c61538748ead773ea75a551a7beee299228bdcaf - name: local_module path: /.../local_module revision: null west: manifest: /.../zephyr/west.yml projects: - path: /.../zephyr revision: 863600cd0e3c0a271e86629c5089821e5e4380cc - path: /.../bootloader/mcuboot revision: c61538748ead773ea75a551a7beee299228bdcaf-off - path: /.../tools/net-tools revision: f49bd1354616fae4093bf36e5eaee43c51a55127 workspace: dirty: false extra: true 'off': true And without west: zephyr: path: /.../zephyr revision: 863600cd0e3c0a271e86629c5089821e5e4380cc modules: - name: hal_nordic path: /.../modules/hal/nordic revision: a6e5299041f152da5ae0ab17b2e44e088bb96d6d - name: local_module path: /.../local_module revision: null workspace: dirty: false extra: true Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-11-04 14:28:21 +01:00
- West:
- manifest: path and revision
- projects: path and revision
- Workspace:
- dirty: one or more repositories are marked dirty
- extra: extra Zephyr modules are manually included in the build
- off: the SHA of one or more west projects are not what the manifest
defined when `west update` was run the last time (`manifest-rev`).
The off state is only present if a west workspace is found.
scripts: support for build meta file creation This commit is motivated by the west discussion in: https://github.com/zephyrproject-rtos/west/issues/548 The commit provides the ability to generate a build meta info file containing lists of: - Zephyr: path and revision - Zephyr modules: name, path, and revision - West: manifest path path and revision for each project For Zephyr or Zephyr modules the revision will be `null` if it is not under git version control. If Zephyr, a modules, or a project has uncommitted changes, the revision will be marked dirty. If west is not installed or used for the build process, the west-projects list will be empty. If a project is both a Zephyr module and a west project it will show up in both lists. Similar to Zephyr, which is independently referred as the Zephyr in use but also listed as west project when west is used. This is important in case ZEPHYR_BASE was manually set and pointing to a different Zephyr repository. The build meta file is not created per default but can be enabled with the BUILD_OUTPUT_META Kconfig setting. A project using west and having an extra Zephyr module loaded not controlled using git can look like: zephyr: path: /.../zephyr revision: 863600cd0e3c0a271e86629c5089821e5e4380cc-dirty modules: - name: mcuboot path: /.../bootloader/mcuboot revision: c61538748ead773ea75a551a7beee299228bdcaf - name: local_module path: /.../local_module revision: null west: manifest: /.../zephyr/west.yml projects: - path: /.../zephyr revision: 863600cd0e3c0a271e86629c5089821e5e4380cc-dirty - path: /.../bootloader/mcuboot revision: c61538748ead773ea75a551a7beee299228bdcaf - path: /.../tools/net-tools revision: f49bd1354616fae4093bf36e5eaee43c51a55127 And without west: zephyr: path: /.../zephyr revision: 863600cd0e3c0a271e86629c5089821e5e4380cc-dirty modules: - name: hal_nordic path: /.../modules/hal/nordic revision: a6e5299041f152da5ae0ab17b2e44e088bb96d6d west: null Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-10-12 23:08:36 +02:00
File extension is .meta
scripts: support propagating workspace status to zephyr revision The PR #39382 raised a discussion on build reproducibility and knowledge of west projects being out of sync with the west manifest. Similar to how `git submodules` will report the working tree dirty if any of the submodules HEAD points to a SHA different than the one recorded in the super project. Based on this discussion this commit extends the Zephyr and manifest repo (when `west` is used) revisions to include the concatenated states of the workspace. The workspace states are: > dirty: false / true > extra: false / true > off: false / true the final revision will become: <SHA>-<state1>-<state2>-<state3> For example: > zephyr: > path: /.../zephyr > revision: <SHA>-dirty-extra-off or > zephyr: > path: /.../zephyr > revision: <SHA>-extra The `BUILD_OUTPUT_META_STATE_PROPAGATE` Kconfig setting is introduced to provide user control of this behavior. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-11-04 18:35:50 +01:00
config BUILD_OUTPUT_META_STATE_PROPAGATE
bool "Propagate module and project state"
depends on BUILD_OUTPUT_META
help
Propagate to state of each module to the Zephyr revision field.
If west is used the state of each west project is also propagated to
the Zephyr revision field.
West manifest repo revision field will also
be marked with the same state as the Zephyr revision.
The final revision will become: <SHA>-<state1>-<state2>-<state3>...
If no states are appended to the SHA it means the build is of a clean
tree.
- dirty: one or more repositories are marked dirty
- extra: extra Zephyr modules are manually included in the build
- off: the SHA of one or more west projects are not what the manifest
defined when `west update` was run the last time (`manifest-rev`).
The off state is only present if a west workspace is found.
cmake: strip paths in build output based on Kconfig option Add CONFIG_BUILD_OUTPUT_STRIP_PATHS to allow keeping absolute paths in the build output. This can be helpful for IDEs to detect links in a console output and jump to the code location (e.g. when running tests in native_posix locally). Debuggers usually have a path mapping feature to ensure the files are still found. Signed-off-by: Martin Jäger <martin@libre.solar>
2023-03-29 16:06:30 +02:00
config BUILD_OUTPUT_STRIP_PATHS
bool "Strip absolute paths from binaries"
default y
help
If the compiler supports it, strip the ${ZEPHYR_BASE} prefix from the
__FILE__ macro used in __ASSERT*, in the
.noinit."/home/joe/zephyr/fu/bar.c" section names and in any
application code.
This saves some memory, stops leaking user locations in binaries, makes
failure logs more deterministic and most importantly makes builds more
deterministic.
Debuggers usually have a path mapping feature to ensure the files are
still found.
Kconfig.zephyr: add an option for checking build time init priority Add an option for running the build time initialization priority check as part of the build. By default the build is going to fail if any error is reported (dependent devices, inverted priority), optionally it can also be failed on warnings (dependent devices, same priority). Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2023-03-09 18:29:54 +01:00
config CHECK_INIT_PRIORITIES
bool "Build time initialization priorities check"
Kconfig.zephyr: check priorities by default Enable build time initialization priority check by default. Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2023-03-10 18:26:35 +01:00
default y
init_priorities: Fix for native_simulator based targets Fix the init_prioties related cmake targets so they also work with native_simulator based build targets. Mostly this consists of pointing to the right file (final build result instead of intermediate elf library) and setting the dependency to that final build result. Note that for the native_simulator based targets the init priorities check can only be run on build if we are building the final image (not just a partial prelinked library), and we are not assembling several images together into one executable. Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
2023-11-23 15:27:09 +01:00
# If we are building a native_simulator target, we can only check the init priorities
# if we are building the final output but we are not assembling several images together
depends on !(NATIVE_LIBRARY && (!BUILD_OUTPUT_EXE || NATIVE_SIMULATOR_EXTRA_IMAGE_PATHS != ""))
cmake: skip build time priority checking with armclang The script does not play well with armclang binariest at the moment. Disable the automatic invocation when running with armclang, at least until this is investigated and fixed. Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2023-09-18 13:35:35 +02:00
depends on "$(ZEPHYR_TOOLCHAIN_VARIANT)" != "armclang"
Kconfig.zephyr: add an option for checking build time init priority Add an option for running the build time initialization priority check as part of the build. By default the build is going to fail if any error is reported (dependent devices, inverted priority), optionally it can also be failed on warnings (dependent devices, same priority). Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2023-03-09 18:29:54 +01:00
help
Check the build for initialization priority issues by comparing the
initialization priority in the build with the device dependency
derived from the devicetree definition.
Fails the build on priority errors (dependent devices, inverted
scripts: check_init_priorities: drop the same priority check Since bb590b5b6e introduced ordinals in the priority sequence, the "same priority" case cannot happen anymore, furthermore the priority value in the script is now the position of the function in the init sequence, so if two devices have the same priority there's something real bad going on. Drop all the "same priority" handling code and tests, convert the case into ane exception instead. Drop the init stubs as well from the test, they are not required anymore. Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2023-10-27 11:27:48 +02:00
priority).
Kconfig.zephyr: add an option for checking build time init priority Add an option for running the build time initialization priority check as part of the build. By default the build is going to fail if any error is reported (dependent devices, inverted priority), optionally it can also be failed on warnings (dependent devices, same priority). Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2023-03-09 18:29:54 +01:00
kernel: syscalls: no need to include all syscalls in binary The syscall generation phase parses all header files to look for potential syscalls, and emits all the relevant files to enable syscalls. However, this results in all the syscall marshalling functions being included in the final binary. This is due to these functions being referred to inside the dispatch list, resulting in ineffective garbage collection during linking. Previous commits allows each drivers and subsystems to specify which header files containing syscalls are relevant. So this commit changes the syscall generation to only include the syscalls needed for the build in the syscall dispatch list and removing various bits related to that. This allows the linker to garbage collect unused syscall related function, and thus reducing final binary size. Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2023-05-25 20:41:48 +02:00
config EMIT_ALL_SYSCALLS
bool "Emit all possible syscalls in the tree"
help
This tells the build system to emit all possible syscalls found
in the tree, instead of only those syscalls associated with enabled
drivers and subsystems.
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
endmenu
kconfig: add support for warnings when using experimental features This adds two new Kconfig settings. The first setting `EXPERIMENTAL` which is a promptless symbol. This symbol must be selected by any setting which is used to enable an experimental feature. The second setting is `WARN_EXPERIMENTAL` which is a user controlled setting that configures the build system to print a warning when experimental features are enabled. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-03-22 14:29:38 +01:00
kconfig: add support for warnings when enabling deprecated features This adds two new Kconfig settings. The first setting `DEPRECATED` which is a promptless symbol. This symbol must be selected by any deprecated setting when enabled. The second setting is `WARN_DEPRECATED` which is a user controlled setting that configures the build system to print a warning when a deprecated feature is enabled. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2022-07-15 12:05:04 +02:00
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.
kconfig: add support for warnings when using experimental features This adds two new Kconfig settings. The first setting `EXPERIMENTAL` which is a promptless symbol. This symbol must be selected by any setting which is used to enable an experimental feature. The second setting is `WARN_EXPERIMENTAL` which is a user controlled setting that configures the build system to print a warning when experimental features are enabled. Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2021-03-22 14:29:38 +01:00
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.
blobs: Introduce TAINT and TAINT_BLOBS Kconfig options In order to ensure that builds properly reflect the use of binary blobs, it is important to markt the build as tainted. For that purpose introduce two new Kconfig options that ultimately will be reflected in the build image itself. Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2022-08-22 18:38:16 +02:00
config TAINT
bool
help
Symbol that must be selected by a feature or module if the Zephyr
build is considered tainted.
build: make Zephyr stdint convention enforcing configurable There are few cases where removing this enforcement is desirable: - linking against binary C++ libs with incompatible type mangling - linking against system provided headers i.e. native_posix - compiling with legacy code that assumes a different convention So let's create a Kconfig symbol for it. This is IMHO a good compromize compared to using the %"PRId32" abomination everywhere otherwise. Signed-off-by: Nicolas Pitre <npitre@baylibre.com>
2022-06-20 19:18:14 +02:00
config ENFORCE_ZEPHYR_STDINT
bool
prompt "Enforce Zephyr convention for stdint"
depends on !ARCH_POSIX
default y
help
This enforces the Zephyr stdint convention where int32_t = int,
int64_t = long long, and intptr_t = long so that short string
format length modifiers can be used universally across ILP32
and LP64 architectures. Sometimes this is not possible e.g. when
linking against a binary-only C++ library whose type mangling
is incompatible with the Zephyr convention, or if the build
environment doesn't allow such enforcement, in which case this
should be turned off with the caveat that argument type validation
on Zephyr code will be skipped.
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
endmenu
menu "Boot Options"
config IS_BOOTLOADER
bool "Act as a bootloader"
depends on XIP
depends on ARM
help
This option indicates that Zephyr will act as a bootloader to execute
a separate Zephyr image payload.
config BOOTLOADER_SRAM_SIZE
kconfig: Deprecate BOOTLOADER_SRAM_SIZE This Kconfig is seemingly unused with exception to a single board, whose maintainers have been unresponsive for a long time. It is not useful to any other board and can be set in dts, therefore deprecate it and schedule removal after the Zephyr 3.7 release Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-11-14 08:50:48 +01:00
int "SRAM reserved for bootloader [DEPRECATED]"
kconfig: Set `BOOTLOADER_SRAM_SIZE` default to 0 The current default value for `BOOTLOADER_SRAM_SIZE` is set to an arbitrary-seeming value of `16`, which feels like a random magic number. Given that adding an offset in SRAM for a bootloader should always be a conscious choice for a specific platform, this PR sets the default to `0`. An appropriate value can be set at the SoC or board level, overriding this default. Signed-off-by: Kevin Townsend <kevin.townsend@linaro.org>
2023-07-14 00:47:55 +02:00
default 0
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
depends on !XIP || IS_BOOTLOADER
dts: intel_s1000: Exclude sram space dedicated for mcubootloader The starting 192kB SRAM is reserved for the mcubootloader. Exclude this region while building an application to be loaded by mcubootloader. Signed-off-by: Rajavardhan Gundi <rajavardhan.gundi@intel.com>
2018-12-14 12:25:43 +01:00
depends on ARM || XTENSA
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
help
This option specifies the amount of SRAM (measure in kB) reserved for
a bootloader image, when either:
- the Zephyr image itself is to act as the bootloader, or
- Zephyr is a !XIP image, which implicitly assumes existence of a
bootloader that loads the Zephyr !XIP image onto SRAM.
kconfig: Deprecate BOOTLOADER_SRAM_SIZE This Kconfig is seemingly unused with exception to a single board, whose maintainers have been unresponsive for a long time. It is not useful to any other board and can be set in dts, therefore deprecate it and schedule removal after the Zephyr 3.7 release Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-11-14 08:50:48 +01:00
This option is deprecated, users should transition to using DTS to set this, if needed.
To be removed after Zephyr 3.7 release.
config BOOTLOADER_SRAM_SIZE_DEPRECATED
bool
default y
select DEPRECATED
depends on BOOTLOADER_SRAM_SIZE != 0
depends on !XIP || IS_BOOTLOADER
depends on ARM || XTENSA
help
Non-prompt symbol to indicate that the deprecated BOOTLOADER_SRAM_SIZE Kconfig has a
non-0 value. Please transition to using devicetree.
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
config BOOTLOADER_ESP_IDF
bool "ESP-IDF bootloader support"
soc: esp32: MCUboot support This make MCUboot build as Zephyr application. Providing optinal 2nd stage bootloader to the IDF bootloader, which is used by default. This provides more flexibility when building and loading multiple images and aims to brings better DX to users by using the sysbuild. MCUboot and applications has now separate linker scripts. Signed-off-by: Marek Matej <marek.matej@espressif.com>
2023-05-09 11:10:05 +02:00
depends on SOC_FAMILY_ESP32 && !BOOTLOADER_MCUBOOT && !MCUBOOT
default y
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
help
This option will trigger the compilation of the ESP-IDF bootloader
inside the build folder.
At flash time, the bootloader will be flashed with the zephyr image
soc: sam0: add support for the BOSSA bootloader This adds a new config option for SAM0 targets that use the BOSSA bootloader. If the CDC ACM driver is also enabled, then the programmer can automatically reset the board into the bootloader for programming. Signed-off-by: Michael Hope <mlhx@google.com>
2020-06-13 21:32:11 +02:00
config BOOTLOADER_BOSSA
bool "BOSSA bootloader support"
select USE_DT_CODE_PARTITION
help
Signifies that the target uses a BOSSA compatible bootloader. If CDC
ACM USB support is also enabled then the board will reboot into the
bootloader automatically when bossac is run.
config BOOTLOADER_BOSSA_DEVICE_NAME
string "BOSSA CDC ACM device name"
depends on BOOTLOADER_BOSSA && CDC_ACM_DTE_RATE_CALLBACK_SUPPORT
default "CDC_ACM_0"
help
Sets the CDC ACM port to watch for reboot commands.
choice
prompt "BOSSA bootloader variant"
depends on BOOTLOADER_BOSSA
scripts: runners: bossac: Add legacy mode Add compatibility mode with old sam-ba flash bootloaders that don't have offset capabilities. These bootloaders flash to a pre-defined flash region. At end, bossac will suppress --offset parameter. Signed-off-by: Gerson Fernando Budke <nandojve@gmail.com>
2021-05-07 02:20:11 +02:00
config BOOTLOADER_BOSSA_LEGACY
bool "Legacy"
help
Select the Legacy variant of the BOSSA bootloader. This is defined
for compatibility mode only. The recommendation is use newer
versions like Arduino or Adafruit UF2.
soc: sam0: add support for the BOSSA bootloader This adds a new config option for SAM0 targets that use the BOSSA bootloader. If the CDC ACM driver is also enabled, then the programmer can automatically reset the board into the bootloader for programming. Signed-off-by: Michael Hope <mlhx@google.com>
2020-06-13 21:32:11 +02:00
config BOOTLOADER_BOSSA_ARDUINO
bool "Arduino"
help
Select the Arduino variant of the BOSSA bootloader. Uses 0x07738135
as the magic value to enter the bootloader.
config BOOTLOADER_BOSSA_ADAFRUIT_UF2
bool "Adafruit UF2"
help
Select the Adafruit UF2 variant of the BOSSA bootloader. Uses
0xf01669ef as the magic value to enter the bootloader.
endchoice
kconfig: distribute misc/Kconfig option where they belong Move misc/Kconfig options to where they belong. misc/Kconfig was used as a catch-all, but we are now able to put things in a better place. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-11-02 12:12:07 +01:00
endmenu
Reference in a new issue Copy permalink