michaelh/zephyr
1
0
Fork 0
Code Releases Activity
zephyr/subsys/dfu/Kconfig

67 lines
1.7 KiB
Plaintext
Raw Permalink 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
# DFU support configuration options
DFU: add module for interact with mcuboot read, update status trigger flashing erase image bank Module is intended to be use by a higher-level image management protocol module. Signed-off-by: Fabio Utzig <utzig@apache.org> Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2017-07-04 11:54:11 +02:00
# Copyright (c) 2017 Nordic Semiconductor ASA
# SPDX-License-Identifier: Apache-2.0
#
# DFU
#
dfu: kconfig: Remove 'DFU Options' menu This menu contains just the IMG_MANAGER symbol and its children. Remove one menu level by making IMG_MANAGER a top-level 'menuconfig' symbol instead. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-05-13 23:54:36 +02:00
menuconfig IMG_MANAGER
subsys: kconfig: Remove 'default n' properties and clean up a bit Bool symbols implicitly default to 'n'. A 'default n' can make sense e.g. in a Kconfig.defconfig file, if you want to override a 'default y' on the base definition of the symbol. It isn't used like that on any of these symbols though. Remove some 'default ""' properties on string symbols too. Also make definitions more consistent by converting some config FOO <type> prompt "foo" definitions to a shorter form: config FOO <type> "foo" This shorthand works for int/hex/string symbols too, not just for bool symbols. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-07-12 13:26:29 +02:00
bool "DFU image manager"
dfu: use stream_flash in flash_img Leverage strem_flash in flash_img.c to reduce code size. Signed-off-by: Håkon Øye Amundsen <haakon.amundsen@nordicsemi.no>
2020-03-05 13:46:39 +01:00
select STREAM_FLASH
DFU: add module for interact with mcuboot read, update status trigger flashing erase image bank Module is intended to be use by a higher-level image management protocol module. Signed-off-by: Fabio Utzig <utzig@apache.org> Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2017-07-04 11:54:11 +02:00
help
Enable support for managing DFU image.
dfu: image_mgr: make Kconfigs depend on IMG_MANAGER Add an if statement around IMG_MANAGER options. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-10-19 14:27:39 +02:00
if IMG_MANAGER
DFU: add module for interact with mcuboot read, update status trigger flashing erase image bank Module is intended to be use by a higher-level image management protocol module. Signed-off-by: Fabio Utzig <utzig@apache.org> Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2017-07-04 11:54:11 +02:00
choice
prompt "Image manager"
default MCUBOOT_IMG_MANAGER
help
Choice support for managing DFU image.
So far only mcuboot support is available.
config MCUBOOT_IMG_MANAGER
bool "Image manager for mcuboot"
dfu/mcuboot: use flash_map instead of flash API Patch introduces flash_map subsystem to operate on flash footprint instead of direct operation using flash_driver API. Flash area ID is used in API instead of direct flash-bank-offsets. Changes allows to support operation on the partition in any flash device. flash_map was not available when this subsystem was introduced. Signed-off-by: Findlay Feng <i@fengch.me>
2018-08-01 08:50:48 +02:00
select FLASH_MAP
DFU: add module for interact with mcuboot read, update status trigger flashing erase image bank Module is intended to be use by a higher-level image management protocol module. Signed-off-by: Fabio Utzig <utzig@apache.org> Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2017-07-04 11:54:11 +02:00
help
Enable support for managing DFU image downloaded using mcuboot.
kconfig: subsys: dfu: Remove redundant IMG_MANAGER dep. Appears within an 'if IMG_MANAGER'. 'if FOO' is just shorthand for adding 'depends on FOO' to each item within the 'if'. Dependencies on menus work similarly. There are no "conditional includes" in Kconfig, so 'if FOO' has no special meaning around a source. Conditional includes wouldn't be possible, because an if condition could include (directly or indirectly) forward references to symbols not defined yet. Tip: When adding a symbol, check its dependencies in the menuconfig ('ninja menuconfig', then / to jump to the symbol). The menuconfig also shows how the file with the symbol got included, so if you see duplicated dependencies, it's easy to hunt down where they come from. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-03-07 04:42:37 +01:00
DFU: add module for interact with mcuboot read, update status trigger flashing erase image bank Module is intended to be use by a higher-level image management protocol module. Signed-off-by: Fabio Utzig <utzig@apache.org> Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2017-07-04 11:54:11 +02:00
endchoice
dfu/boot: make swap_type optional Swap_type field implementation is the new mcuboot's trailer field. This patch makes using of it optional which keeps possibility of being compatible with older versions of MCUBoot. Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2019-06-13 14:51:24 +02:00
config MCUBOOT_TRAILER_SWAP_TYPE
bool "use trailer's swap_type field"
default y
kconfig: Replace some single-symbol 'if's with 'depends on' I think people might be reading differences into 'if' and 'depends on' that aren't there, like maybe 'if' being needed to "hide" a symbol, while 'depends on' just adds a dependency. There are no differences between 'if' and 'depends on'. 'if' is just a shorthand for 'depends on'. They work the same when it comes to creating implicit menus too. The way symbols get "hidden" is through their dependencies not being satisfied ('if'/'depends on' get copied up as a dependency on the prompt). Since 'if' and 'depends on' are the same, an 'if' with just a single symbol in it can be replaced with a 'depends on'. IMO, it's best to avoid 'if' there as a style choice too, because it confuses people into thinking there's deep Kconfig magic going on that requires 'if'. Going for 'depends on' can also remove some nested 'if's, which generates nicer symbol information and docs, because nested 'if's really are so simple/dumb that they just add the dependencies from both 'if's to all symbols within. Replace a bunch of single-symbol 'if's with 'depends on' to despam the Kconfig files a bit and make it clearer how things work. Also do some other minor related dependency refactoring. The replacement isn't complete. Will fix up the rest later. Splitting it a bit to make it more manageable. (Everything above is true for choices, menus, and comments as well.) Detected by tweaking the Kconfiglib parsing code. It's impossible to detect after parsing, because 'if' turns into 'depends on'. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2020-02-08 03:45:50 +01:00
depends on MCUBOOT_IMG_MANAGER
dfu/boot: make swap_type optional Swap_type field implementation is the new mcuboot's trailer field. This patch makes using of it optional which keeps possibility of being compatible with older versions of MCUBoot. Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2019-06-13 14:51:24 +02:00
help
Enables usage swap type field which is required after
"Fix double swap on interrupted revert" mcuboot patch
(https://github.com/JuulLabs-OSS/mcuboot/pull/485)
Disable this option if need to be compatible with earlier version
of MCUBoot.
DFU: add module for store the image Store image in sequence of certain blocks. Module is intended to be use by a higher-level image management protocol module Signed-off-by: Michael Scott <michael.scott@linaro.org> Signed-off-by: Marti Bolivar <marti.bolivar@linaro.org> Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2017-07-04 11:55:06 +02:00
config IMG_BLOCK_BUF_SIZE
Kconfig: Use a short, consistent style for prompts Consistently use config FOO bool/int/hex/string "Prompt text" instead of config FOO bool/int/hex/string prompt "Prompt text" (...and a bunch of other variations that e.g. swapped the order of the type and the 'prompt', or put other properties between them). The shorthand is fully equivalent to using 'prompt'. It saves lines and avoids tricking people into thinking there is some semantic difference. Most of the grunt work was done by a modified version of https://unix.stackexchange.com/questions/26284/ how-can-i-use-sed-to-replace-a-multi-line-string/26290#26290, but some of the rarer variations had to be converted manually. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2018-08-14 16:19:20 +02:00
int "Image writer buffer size"
DFU: add module for store the image Store image in sequence of certain blocks. Module is intended to be use by a higher-level image management protocol module Signed-off-by: Michael Scott <michael.scott@linaro.org> Signed-off-by: Marti Bolivar <marti.bolivar@linaro.org> Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2017-07-04 11:55:06 +02:00
depends on MCUBOOT_IMG_MANAGER
default 512
help
Size (in Bytes) of buffer for image writer. Must be a multiple of
the access alignment required by used flash driver.
dfu: use stream_flash in flash_img Leverage strem_flash in flash_img.c to reduce code size. Signed-off-by: Håkon Øye Amundsen <haakon.amundsen@nordicsemi.no>
2020-03-05 13:46:39 +01:00
config IMG_ERASE_PROGRESSIVELY
dfu: introduce progressive erasing Patch adds option for progressive erase of firmware image. When using this, flash is erased as necessary when receiving new firmware, instead of erasing the whole image slot at once. This is useful on some hardware (like nRF52840) that has long erase times, to prevent long wait times at the beginning of the DFU process. Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2019-03-15 17:17:16 +01:00
bool "Erase flash progressively when receiving new firmware"
depends on MCUBOOT_IMG_MANAGER
dfu: use stream_flash in flash_img Leverage strem_flash in flash_img.c to reduce code size. Signed-off-by: Håkon Øye Amundsen <haakon.amundsen@nordicsemi.no>
2020-03-05 13:46:39 +01:00
select STREAM_FLASH_ERASE
dfu: introduce progressive erasing Patch adds option for progressive erase of firmware image. When using this, flash is erased as necessary when receiving new firmware, instead of erasing the whole image slot at once. This is useful on some hardware (like nRF52840) that has long erase times, to prevent long wait times at the beginning of the DFU process. Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2019-03-15 17:17:16 +01:00
help
kconfig: Global whitespace/consistency cleanup Clean up space errors and use a consistent style throughout the Kconfig files. This makes reading the Kconfig files more distraction-free, helps with grepping, and encourages the same style getting copied around everywhere (meaning another pass hopefully won't be needed). Go for the most common style: - Indent properties with a single tab, including for choices. Properties on choices work exactly the same syntactically as properties on symbols, so not sure how the no-indentation thing happened. - Indent help texts with a tab followed by two spaces - Put a space between 'config' and the symbol name, not a tab. This also helps when grepping for definitions. - Do '# A comment' instead of '#A comment' I tweaked Kconfiglib a bit to find most of the stuff. Some help texts were reflowed to 79 columns with 'gq' in Vim as well, though not all, because I was afraid I'd accidentally mess up formatting. Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-11-01 10:24:07 +01:00
If enabled, flash is erased as necessary when receiving new firmware,
instead of erasing the whole image slot at once. This is necessary
on some hardware that has long erase times, to prevent long wait
times at the beginning of the DFU process.
dfu: introduce progressive erasing Patch adds option for progressive erase of firmware image. When using this, flash is erased as necessary when receiving new firmware, instead of erasing the whole image slot at once. This is useful on some hardware (like nRF52840) that has long erase times, to prevent long wait times at the beginning of the DFU process. Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2019-03-15 17:17:16 +01:00
dfu: log: rename level variable Rename log level variable: CONFIG_LOG_IMG_MANAGER_LEVEL to CONFIG_IMG_MANAGER_LOG_LEVEL Use template for log levels. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-10-08 20:04:34 +02:00
module = IMG_MANAGER
module-str = image manager
source "subsys/logging/Kconfig.template.log_config"
DFU: add module for store the image Store image in sequence of certain blocks. Module is intended to be use by a higher-level image management protocol module Signed-off-by: Michael Scott <michael.scott@linaro.org> Signed-off-by: Marti Bolivar <marti.bolivar@linaro.org> Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2017-07-04 11:55:06 +02:00
dfu: image_mgr: make Kconfigs depend on IMG_MANAGER Add an if statement around IMG_MANAGER options. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2018-10-19 14:27:39 +02:00
endif # IMG_MANAGER
Copy permalink