OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/subsys/settings/Kconfig

137 lines
3.2 KiB
Plaintext
Raw Normal View History

subsys: Add a new settings subsystem Adapt the MyNewt non-volatile configuration system to become a settings system in Zephyr. The original code was modifed in the following ways: * Renamed from config to settings * Use the zephyr FCB, FS API, and base64 subsystems * lltoa like function was added to sources as it was required but not included in Zephyr itself. * The original code was modified to use Zephyr's slist.h as single linked list implementation. * Reworked code which was using strtok_r, added function for decoding a string to a s64_t value. * Thank to the above the settings subsys doesn't require newlibc anymore. Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no> Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-02-02 21:30:56 +08:00
#
# Copyright (c) 2018 Nordic Semiconductor ASA
#
# SPDX-License-Identifier: Apache-2.0
#
menuconfig SETTINGS
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 19:26:29 +08:00
bool "Enable settings subsystem with non-volatile storage"
subsys: Add a new settings subsystem Adapt the MyNewt non-volatile configuration system to become a settings system in Zephyr. The original code was modifed in the following ways: * Renamed from config to settings * Use the zephyr FCB, FS API, and base64 subsystems * lltoa like function was added to sources as it was required but not included in Zephyr itself. * The original code was modified to use Zephyr's slist.h as single linked list implementation. * Reworked code which was using strtok_r, added function for decoding a string to a s64_t value. * Thank to the above the settings subsys doesn't require newlibc anymore. Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no> Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-02-02 21:30:56 +08:00
help
The settings subsystem allows its users to serialize and
deserialize state in memory into and from non-volatile memory.
It supports several back-ends to store and load serialized data from
and it can do so atomically for all involved modules.
settings: enable logging This patch introduce logging to settings. Error in stored data record might occurred in runtime, so better to switch assertion to error logging. Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2019-03-06 22:25:00 +08:00
if SETTINGS
module = SETTINGS
module-str = settings
source "subsys/logging/Kconfig.template.log_config"
endif
subsys/settings: Allow to register custom backends in settings subsystem Major changes are: - Expose settings backend API to enable custom backend support. - Add a new CONFIG_SETTINGS_CUSTOM backend to allow registering a custom backend. - Change api of the handlers h_set() routines to allow for backend-specific read callbacks. - Provide a customizable settings_backend_init() routine for custom backends. - Move runtime settings support to be its own backend. Signed-off-by: François Delawarde <fnde@oticon.com>
2019-04-02 17:06:05 +08:00
config SETTINGS_RUNTIME
bool "runtime storage back-end"
depends on SETTINGS
help
Enables runtime storage back-end.
subsys/settings: Enable handler ROM registration Add the possibility to register handles to ROM using a new macro SETTINGS_REGISTER_STATIC(handler), the handler is of type settings_handler_stat and has to be declared as const: ``` const struct settings_handler_stat test_handler = { .name = "test", /* this can also be "ps/data" .h_get = get, .h_set = set, .h_commit = NULL, /* NULL defines can be ommited */ .h_export = NULL /* NULL defines can be ommited */ }; SETTINGS_REGISTER_STATIC(test_handler); ``` To maintain support for handlers stored in RAM (dynamic handlers) `CONFIG_SETTINGS_DYNAMIC_HANDLERS`must be enabled, which is by default. When registering static handlers there is no check if this handler has been registered earlier, the latest registered static handler will be considered valid for any set/get routine, while the commit and export routines will be executed for both registered handlers. When a dynamic handler is registered a check is done to see if there was an earlier registration of the name as a static or dynamic handler registration will fail. To get to the lowest possible RAM usage it is advised to set `CONFIG_SETTINGS_DYNAMIC_HANDLERS=n`. Updates: a. Changed usage of RAM to DYNAMIC/dynamic, ROM to STATIC/static b. Updated settings.h to remove added #if defined() c. Make static handlers always enabled d. Corrected error introduced in common-rom.ld. e. Changed return value of settings_parse_and_lookup to settings_handler_stat type to reduce stack usage. f. Updated the name generated to store a handler item in ROM. It now uses the name used to register in combination with the line where SETTINGS_REGISTER_STATIC() is called. g. renamed settings_handler_stat type to settings_handler_static h. renamed SETTINGS_REGISTER_STATIC to SETTINGS_STATIC_HANDLER_DEFINE() Signed-off-by: Laczen JMS <laczenjms@gmail.com>
2019-06-18 21:16:26 +08:00
config SETTINGS_DYNAMIC_HANDLERS
bool "dynamic settings handlers"
depends on SETTINGS
default y
help
Enables the use of dynamic settings handlers
subsys/settings: stream-style encoding and decoding to/from storage This patch reworks routines used to store and read the settings data. Provide stream-style encoding and decoding to/from flash, so the the API only requires a pointer to binary data, and the settings implementation takes care of encoding/decoding to/from base64 and writing/reading to/from flash on the fly. This would eliminate the need of a separate base64 value buffer on the application-side, thereby further contributing to the stack footprint reduction. Above changes allows to remove: 256-byte value length limitation. removing enum settings_type usage so all settings data are treated now as a byte array (i.e. what's previously SETTINGS_BYTES) Introduced routine settings_val_read_cb for read and decode the settings data from storage inside h_set handler implementations. h_set settings handler now provide persistent value's context used along with read routine instead of immediately value. Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2018-05-15 20:25:29 +08:00
# Hidden option to enable encoding length into settings entry
config SETTINGS_ENCODE_LEN
depends on SETTINGS
bool
settings: make base64 encoding optional Thanks to previous commit base64 encoding of the settings value is not required anymore for NFFS and FCB back-end. This patch makes encoding an option in case it will be required in the future. Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2018-11-21 21:55:47 +08:00
config SETTINGS_USE_BASE64
bool "encoding value using base64"
depends on SETTINGS
select BASE64
help
Enables values encoding using Base64.
subsys: Add a new settings subsystem Adapt the MyNewt non-volatile configuration system to become a settings system in Zephyr. The original code was modifed in the following ways: * Renamed from config to settings * Use the zephyr FCB, FS API, and base64 subsystems * lltoa like function was added to sources as it was required but not included in Zephyr itself. * The original code was modified to use Zephyr's slist.h as single linked list implementation. * Reworked code which was using strtok_r, added function for decoding a string to a s64_t value. * Thank to the above the settings subsys doesn't require newlibc anymore. Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no> Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-02-02 21:30:56 +08:00
choice
prompt "Storage back-end"
settings: addding NVS & FS to default settings backend config Added default backends in the Settings Kconfig for NVS and FS. Signed-off-by: Kamil Piszczek <Kamil.Piszczek@nordicsemi.no>
2019-10-08 18:18:46 +08:00
default SETTINGS_NVS if NVS
subsys: Add a new settings subsystem Adapt the MyNewt non-volatile configuration system to become a settings system in Zephyr. The original code was modifed in the following ways: * Renamed from config to settings * Use the zephyr FCB, FS API, and base64 subsystems * lltoa like function was added to sources as it was required but not included in Zephyr itself. * The original code was modified to use Zephyr's slist.h as single linked list implementation. * Reworked code which was using strtok_r, added function for decoding a string to a s64_t value. * Thank to the above the settings subsys doesn't require newlibc anymore. Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no> Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-02-02 21:30:56 +08:00
default SETTINGS_FCB if FCB
settings: addding NVS & FS to default settings backend config Added default backends in the Settings Kconfig for NVS and FS. Signed-off-by: Kamil Piszczek <Kamil.Piszczek@nordicsemi.no>
2019-10-08 18:18:46 +08:00
default SETTINGS_FS if FILE_SYSTEM
subsys/settings: Allow to register custom backends in settings subsystem Major changes are: - Expose settings backend API to enable custom backend support. - Add a new CONFIG_SETTINGS_CUSTOM backend to allow registering a custom backend. - Change api of the handlers h_set() routines to allow for backend-specific read callbacks. - Provide a customizable settings_backend_init() routine for custom backends. - Move runtime settings support to be its own backend. Signed-off-by: François Delawarde <fnde@oticon.com>
2019-04-02 17:06:05 +08:00
default SETTINGS_NONE
subsys: Add a new settings subsystem Adapt the MyNewt non-volatile configuration system to become a settings system in Zephyr. The original code was modifed in the following ways: * Renamed from config to settings * Use the zephyr FCB, FS API, and base64 subsystems * lltoa like function was added to sources as it was required but not included in Zephyr itself. * The original code was modified to use Zephyr's slist.h as single linked list implementation. * Reworked code which was using strtok_r, added function for decoding a string to a s64_t value. * Thank to the above the settings subsys doesn't require newlibc anymore. Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no> Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-02-02 21:30:56 +08:00
depends on SETTINGS
help
Storage back-end to be used by the settings subsystem.
config SETTINGS_FCB
bool "FCB"
depends on FCB
help
Use FCB as a settings storage back-end.
config SETTINGS_FS
bool "File System"
depends on FILE_SYSTEM
subsys/settings: stream-style encoding and decoding to/from storage This patch reworks routines used to store and read the settings data. Provide stream-style encoding and decoding to/from flash, so the the API only requires a pointer to binary data, and the settings implementation takes care of encoding/decoding to/from base64 and writing/reading to/from flash on the fly. This would eliminate the need of a separate base64 value buffer on the application-side, thereby further contributing to the stack footprint reduction. Above changes allows to remove: 256-byte value length limitation. removing enum settings_type usage so all settings data are treated now as a byte array (i.e. what's previously SETTINGS_BYTES) Introduced routine settings_val_read_cb for read and decode the settings data from storage inside h_set handler implementations. h_set settings handler now provide persistent value's context used along with read routine instead of immediately value. Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2018-05-15 20:25:29 +08:00
select SETTINGS_ENCODE_LEN
subsys: Add a new settings subsystem Adapt the MyNewt non-volatile configuration system to become a settings system in Zephyr. The original code was modifed in the following ways: * Renamed from config to settings * Use the zephyr FCB, FS API, and base64 subsystems * lltoa like function was added to sources as it was required but not included in Zephyr itself. * The original code was modified to use Zephyr's slist.h as single linked list implementation. * Reworked code which was using strtok_r, added function for decoding a string to a s64_t value. * Thank to the above the settings subsys doesn't require newlibc anymore. Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no> Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-02-02 21:30:56 +08:00
help
Use a file system as a settings storage back-end.
subsys/settings: Allow to register custom backends in settings subsystem Major changes are: - Expose settings backend API to enable custom backend support. - Add a new CONFIG_SETTINGS_CUSTOM backend to allow registering a custom backend. - Change api of the handlers h_set() routines to allow for backend-specific read callbacks. - Provide a customizable settings_backend_init() routine for custom backends. - Move runtime settings support to be its own backend. Signed-off-by: François Delawarde <fnde@oticon.com>
2019-04-02 17:06:05 +08:00
settings: adding new nvs backend Added NVS backend to the Settings subsystem. Signed-off-by: Kamil Piszczek <Kamil.Piszczek@nordicsemi.no>
2019-06-24 17:10:18 +08:00
config SETTINGS_NVS
bool "NVS non-volatile storage support"
settings: fix Kconfig SETTINGS_NVS dependency The SETTINGS_NVS now depend on the NVS and FLASH_MAP as it was intended. Signed-off-by: Kamil Piszczek <Kamil.Piszczek@nordicsemi.no>
2019-10-10 18:17:46 +08:00
depends on NVS
depends on FLASH_MAP
settings: adding new nvs backend Added NVS backend to the Settings subsystem. Signed-off-by: Kamil Piszczek <Kamil.Piszczek@nordicsemi.no>
2019-06-24 17:10:18 +08:00
help
Enables NVS storage support
subsys/settings: Allow to register custom backends in settings subsystem Major changes are: - Expose settings backend API to enable custom backend support. - Add a new CONFIG_SETTINGS_CUSTOM backend to allow registering a custom backend. - Change api of the handlers h_set() routines to allow for backend-specific read callbacks. - Provide a customizable settings_backend_init() routine for custom backends. - Move runtime settings support to be its own backend. Signed-off-by: François Delawarde <fnde@oticon.com>
2019-04-02 17:06:05 +08:00
config SETTINGS_CUSTOM
bool "CUSTOM"
help
Use a custom settings storage back-end.
config SETTINGS_NONE
bool "NONE"
help
No storage back-end.
subsys: Add a new settings subsystem Adapt the MyNewt non-volatile configuration system to become a settings system in Zephyr. The original code was modifed in the following ways: * Renamed from config to settings * Use the zephyr FCB, FS API, and base64 subsystems * lltoa like function was added to sources as it was required but not included in Zephyr itself. * The original code was modified to use Zephyr's slist.h as single linked list implementation. * Reworked code which was using strtok_r, added function for decoding a string to a s64_t value. * Thank to the above the settings subsys doesn't require newlibc anymore. Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no> Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-02-02 21:30:56 +08:00
endchoice
config SETTINGS_FCB_NUM_AREAS
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 19:26:29 +08:00
int "Number of flash areas used by the settings subsystem"
subsys: Add a new settings subsystem Adapt the MyNewt non-volatile configuration system to become a settings system in Zephyr. The original code was modifed in the following ways: * Renamed from config to settings * Use the zephyr FCB, FS API, and base64 subsystems * lltoa like function was added to sources as it was required but not included in Zephyr itself. * The original code was modified to use Zephyr's slist.h as single linked list implementation. * Reworked code which was using strtok_r, added function for decoding a string to a s64_t value. * Thank to the above the settings subsys doesn't require newlibc anymore. Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no> Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-02-02 21:30:56 +08:00
default 8
depends on SETTINGS && SETTINGS_FCB
help
Number of areas to allocate in the settings FCB. A smaller number is
used if the flash hardware cannot support this value.
config SETTINGS_FCB_MAGIC
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 19:26:29 +08:00
hex "FCB magic for the settings subsystem"
subsys: Add a new settings subsystem Adapt the MyNewt non-volatile configuration system to become a settings system in Zephyr. The original code was modifed in the following ways: * Renamed from config to settings * Use the zephyr FCB, FS API, and base64 subsystems * lltoa like function was added to sources as it was required but not included in Zephyr itself. * The original code was modified to use Zephyr's slist.h as single linked list implementation. * Reworked code which was using strtok_r, added function for decoding a string to a s64_t value. * Thank to the above the settings subsys doesn't require newlibc anymore. Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no> Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-02-02 21:30:56 +08:00
default 0xc0ffeeee
depends on SETTINGS && SETTINGS_FCB
help
Magic 32-bit word for to identify valid settings area
config SETTINGS_FS_DIR
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 19:26:29 +08:00
string "Serialization directory"
subsys: Add a new settings subsystem Adapt the MyNewt non-volatile configuration system to become a settings system in Zephyr. The original code was modifed in the following ways: * Renamed from config to settings * Use the zephyr FCB, FS API, and base64 subsystems * lltoa like function was added to sources as it was required but not included in Zephyr itself. * The original code was modified to use Zephyr's slist.h as single linked list implementation. * Reworked code which was using strtok_r, added function for decoding a string to a s64_t value. * Thank to the above the settings subsys doesn't require newlibc anymore. Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no> Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-02-02 21:30:56 +08:00
default "/settings"
depends on SETTINGS && SETTINGS_FS
help
Directory where the settings data is stored
config SETTINGS_FS_FILE
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 19:26:29 +08:00
string "Default settings file"
subsys: Add a new settings subsystem Adapt the MyNewt non-volatile configuration system to become a settings system in Zephyr. The original code was modifed in the following ways: * Renamed from config to settings * Use the zephyr FCB, FS API, and base64 subsystems * lltoa like function was added to sources as it was required but not included in Zephyr itself. * The original code was modified to use Zephyr's slist.h as single linked list implementation. * Reworked code which was using strtok_r, added function for decoding a string to a s64_t value. * Thank to the above the settings subsys doesn't require newlibc anymore. Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no> Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-02-02 21:30:56 +08:00
default "/settings/run"
depends on SETTINGS && SETTINGS_FS
help
Full path to the default settings file.
config SETTINGS_FS_MAX_LINES
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 19:26:29 +08:00
int "Compression threshold"
subsys: Add a new settings subsystem Adapt the MyNewt non-volatile configuration system to become a settings system in Zephyr. The original code was modifed in the following ways: * Renamed from config to settings * Use the zephyr FCB, FS API, and base64 subsystems * lltoa like function was added to sources as it was required but not included in Zephyr itself. * The original code was modified to use Zephyr's slist.h as single linked list implementation. * Reworked code which was using strtok_r, added function for decoding a string to a s64_t value. * Thank to the above the settings subsys doesn't require newlibc anymore. Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no> Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2018-02-02 21:30:56 +08:00
default 32
depends on SETTINGS && SETTINGS_FS
help
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 19:26:29 +08:00
Limit how many items stored in a file before compressing
settings: adding new nvs backend Added NVS backend to the Settings subsystem. Signed-off-by: Kamil Piszczek <Kamil.Piszczek@nordicsemi.no>
2019-06-24 17:10:18 +08:00
config SETTINGS_NVS_SECTOR_SIZE_MULT
int "Sector size of the NVS settings area"
default 1
depends on SETTINGS && SETTINGS_NVS
help
The sector size to use for the NVS settings area as a multiple of
FLASH_ERASE_BLOCK_SIZE.
config SETTINGS_NVS_SECTOR_COUNT
int "Sector count of the NVS settings area"
default 8
depends on SETTINGS && SETTINGS_NVS
help
Number of sectors used for the NVS settings area