adafruit-mirror/zephyr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 9

settings: Remove deprecated SETTINGS_USE_BASE64 support

Browse source 
Remove code and associated tests and Kconfig related to
SETTINGS_USE_BASE64 that was deprecated in Zephyr 2.2

Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
This commit is contained in:
Kumar Gala 2020-06-08 10:41:09 -05:00 committed by Kumar Gala
parent 4800b03e56
commit 55be783c85
37 changed files with 15 additions and 376 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
doc/releases/release-notes-2.5.rst
View file

@ -29,6 +29,9 @@ interface and listing all issues with the `bug label
API Changes
***********
* Removed SETTINGS_USE_BASE64 support as its been deprecated for more than
two releases.
Deprecated in this release
==========================

9
subsys/settings/Kconfig
View file

@ -33,15 +33,6 @@ config SETTINGS_ENCODE_LEN
depends on SETTINGS
bool
config SETTINGS_USE_BASE64
bool "encoding value using base64 (deprecated)"
depends on SETTINGS
select BASE64
help
This option has been deprecated and will not be supported
in future releases.
Enables values encoding using Base64.
choice
prompt "Storage back-end"
default SETTINGS_NVS if NVS

145
subsys/settings/src/settings_line.c
View file

@ -11,10 +11,6 @@
#include "settings/settings.h"
#include "settings_priv.h"
#ifdef CONFIG_SETTINGS_USE_BASE64
#include <sys/base64.h>
#endif
#include <logging/log.h>
LOG_MODULE_DECLARE(settings, CONFIG_SETTINGS_LOG_LEVEL);
@ -32,14 +28,6 @@ int settings_line_write(const char *name, const char *value, size_t val_len,
{
size_t w_size, rem, add;
#ifdef CONFIG_SETTINGS_USE_BASE64
/* minimal buffer for encoding base64 + EOL*/
char enc_buf[MAX_ENC_BLOCK_SIZE + 1];
char *p_enc = enc_buf;
size_t enc_len = 0;
#endif
bool done;
char w_buf[16]; /* write buff, must be aligned either to minimal */
/* base64 encoding size and write-block-size */
@ -99,32 +87,12 @@ int settings_line_write(const char *name, const char *value, size_t val_len,
while (1) {
while (w_size < sizeof(w_buf)) {
#ifdef CONFIG_SETTINGS_USE_BASE64
if (enc_len) {
add = MIN(enc_len, sizeof(w_buf) - w_size);
memcpy(&w_buf[w_size], p_enc, add);
enc_len -= add;
w_size += add;
p_enc += add;
} else {
#endif
if (rem) {
#ifdef CONFIG_SETTINGS_USE_BASE64
add = MIN(rem, MAX_ENC_BLOCK_SIZE/4*3);
rc = base64_encode(enc_buf, sizeof(enc_buf), &enc_len, value, add);
if (rc) {
return -EINVAL;
}
value += add;
rem -= add;
p_enc = enc_buf;
#else
add = MIN(rem, sizeof(w_buf) - w_size);
memcpy(&w_buf[w_size], value, add);
value += add;
rem -= add;
w_size += add;
#endif
} else {
add = (w_size) % wbs;
if (add) {
@ -136,9 +104,6 @@ int settings_line_write(const char *name, const char *value, size_t val_len,
done = true;
break;
}
#ifdef CONFIG_SETTINGS_USE_BASE64
}
#endif
}
rc = settings_io_cb.write_cb(cb_arg, w_loc, w_buf, w_size);
@ -188,13 +153,8 @@ int settings_line_len_calc(const char *name, size_t val_len)
{
int len;
#ifdef CONFIG_SETTINGS_USE_BASE64
/* <enc(value)> */
len = val_len/3*4 + ((val_len%3) ? 4 : 0);
#else
/* <evalue> */
len = val_len;
#endif
/* <name>=<enc(value)> */
len += strlen(name) + 1;
@ -286,78 +246,6 @@ int settings_line_raw_read(off_t seek, char *out, size_t len_req,
NULL, cb_arg);
}
#ifdef CONFIG_SETTINGS_USE_BASE64
/* off from value begin */
int settings_line_val_read(off_t val_off, off_t off, char *out, size_t len_req,
size_t *len_read, void *cb_arg)
{
char enc_buf[16 + 1];
char dec_buf[sizeof(enc_buf)/4 * 3 + 1];
size_t rem_size, read_size, exp_size, clen, olen;
off_t seek_begin, off_begin;
int rc;
rem_size = len_req;
while (rem_size) {
seek_begin = off / 3 * 4;
off_begin = seek_begin / 4 * 3;
read_size = rem_size / 3 * 4;
read_size += (rem_size % 3 != 0 || off_begin != off) ? 4 : 0;
read_size = MIN(read_size, sizeof(enc_buf) - 1);
exp_size = read_size;
rc = settings_line_raw_read(val_off + seek_begin, enc_buf,
read_size, &read_size, cb_arg);
if (rc) {
return rc;
}
enc_buf[read_size] = 0; /* breaking guaranteed */
read_size = strlen(enc_buf);
if (read_size == 0) {
/* a NULL value (deleted entry) */
*len_read = 0;
return 0;
}
if (read_size % 4) {
/* unexpected use case - an encoding problem */
return -EINVAL;
}
rc = base64_decode(dec_buf, sizeof(dec_buf), &olen, enc_buf,
read_size);
if (rc) {
return rc;
}
dec_buf[olen] = 0;
clen = MIN(olen + off_begin - off, rem_size);
memcpy(out, &dec_buf[off - off_begin], clen);
rem_size -= clen;
if (exp_size > read_size || olen < read_size/4*3) {
break;
}
out += clen;
off += clen;
}
*len_read = len_req - rem_size;
return 0;
}
#else
/* off from value begin */
int settings_line_val_read(off_t val_off, off_t off, char *out, size_t len_req,
size_t *len_read, void *cb_arg)
@ -365,47 +253,14 @@ int settings_line_val_read(off_t val_off, off_t off, char *out, size_t len_req,
return settings_line_raw_read(val_off + off, out, len_req, len_read,
cb_arg);
}
#endif
size_t settings_line_val_get_len(off_t val_off, void *read_cb_ctx)
{
size_t len;
len = settings_io_cb.get_len_cb(read_cb_ctx);
#ifdef CONFIG_SETTINGS_USE_BASE64
uint8_t raw[2];
int rc;
size_t len_base64 = len - val_off;
/* don't care about lack of alignmet to 4 B */
/* entire value redout call will return error anyway */
if (len_base64 >= 4) {
/* read last 2 B of base64 */
rc = settings_line_raw_read(len - 2, raw, 2, &len, read_cb_ctx);
if (rc || len != 2) {
/* very unexpected error */
if (rc != 0) {
LOG_ERR("Failed to read the storage (%d)", rc);
}
return 0;
}
len = (len_base64 / 4) * 3;
/* '=' is the padding of Base64 */
if (raw[0] == '=') {
len -= 2;
} else if (raw[1] == '=') {
len--;
}
return len;
} else {
return 0;
}
#else
return len - val_off;
#endif
}
/**

17
tests/subsys/settings/fcb/base64/CMakeLists.txt
View file

@ -1,17 +0,0 @@
# SPDX-License-Identifier: Apache-2.0
cmake_minimum_required(VERSION 3.13.1)
find_package(Zephyr REQUIRED HINTS $ENV{ZEPHYR_BASE})
project(settings_fcb)
add_subdirectory(../src fcb_test_bindir)
target_link_libraries(app PRIVATE settings_fcb_test)
# The code is in the library common to several tests.
target_sources(app PRIVATE placeholder.c)
if(TEST)
target_compile_definitions(app PRIVATE
-DTEST_${TEST}
)
endif()

25
tests/subsys/settings/fcb/base64/native_posix.overlay
View file

@ -1,25 +0,0 @@
/*
* Copyright (c) 2019 Jan Van Winkel <jan.van_winkel@dxplore.eu>
*
* SPDX-License-Identifier: Apache-2.0
*/
/delete-node/ &storage_partition;
/delete-node/ &scratch_partition;
&flash0 {
/*
* For more information, see:
* https://docs.zephyrproject.org/latest/guides/dts/legacy-macros.html#legacy-flash-partitions
*/
partitions {
compatible = "fixed-partitions";
#address-cells = <1>;
#size-cells = <1>;
storage_partition: partition@70000 {
label = "storage";
reg = <0x00070000 0x10000>;
};
};
};

25
tests/subsys/settings/fcb/base64/native_posix_64.overlay
View file

@ -1,25 +0,0 @@
/*
* Copyright (c) 2019 Jan Van Winkel <jan.van_winkel@dxplore.eu>
*
* SPDX-License-Identifier: Apache-2.0
*/
/delete-node/ &storage_partition;
/delete-node/ &scratch_partition;
&flash0 {
/*
* For more information, see:
* https://docs.zephyrproject.org/latest/guides/dts/legacy-macros.html#legacy-flash-partitions
*/
partitions {
compatible = "fixed-partitions";
#address-cells = <1>;
#size-cells = <1>;
storage_partition: partition@70000 {
label = "storage";
reg = <0x00070000 0x10000>;
};
};
};

25
tests/subsys/settings/fcb/base64/nrf52840dk_nrf52840.overlay
View file

@ -1,25 +0,0 @@
/*
* Copyright (c) 2019 Nordic Semiconductor ASA
*
* SPDX-License-Identifier: Apache-2.0
*/
/delete-node/ &storage_partition;
/delete-node/ &scratch_partition;
&flash0 {
/*
* For more information, see:
* https://docs.zephyrproject.org/latest/guides/dts/legacy-macros.html#legacy-flash-partitions
*/
partitions {
compatible = "fixed-partitions";
#address-cells = <1>;
#size-cells = <1>;
storage_partition: partition@de000 {
label = "storage";
reg = <0x000de000 0x00010000>;
};
};
};

25
tests/subsys/settings/fcb/base64/nrf52dk_nrf52832.overlay
View file

@ -1,25 +0,0 @@
/*
* Copyright (c) 2018 Nordic Semiconductor ASA
*
* SPDX-License-Identifier: Apache-2.0
*/
/delete-node/ &storage_partition;
/delete-node/ &scratch_partition;
&flash0 {
/*
* For more information, see:
* https://docs.zephyrproject.org/latest/guides/dts/legacy-macros.html#legacy-flash-partitions
*/
partitions {
compatible = "fixed-partitions";
#address-cells = <1>;
#size-cells = <1>;
storage_partition: partition@70000 {
label = "storage";
reg = <0x00070000 0x10000>;
};
};
};

2
tests/subsys/settings/fcb/base64/placeholder.c
View file

@ -1,2 +0,0 @@
/* SPDX-License-Identifier: Apache-2.0 */
/* Copyright (c) 2019 Intel Corporation */

12
tests/subsys/settings/fcb/base64/prj.conf
View file

@ -1,12 +0,0 @@
CONFIG_ZTEST=y
CONFIG_STDOUT_CONSOLE=y
CONFIG_FLASH=y
CONFIG_FLASH_PAGE_LAYOUT=y
CONFIG_FLASH_MAP=y
CONFIG_ARM_MPU=n
CONFIG_FCB=y
CONFIG_SETTINGS=y
CONFIG_SETTINGS_RUNTIME=y
CONFIG_SETTINGS_FCB=y
CONFIG_SETTINGS_USE_BASE64=y

11
tests/subsys/settings/fcb/base64/prj_native_posix.conf
View file

@ -1,11 +0,0 @@
CONFIG_ZTEST=y
CONFIG_STDOUT_CONSOLE=y
CONFIG_FLASH=y
CONFIG_FLASH_PAGE_LAYOUT=y
CONFIG_FLASH_MAP=y
CONFIG_FCB=y
CONFIG_SETTINGS=y
CONFIG_SETTINGS_RUNTIME=y
CONFIG_SETTINGS_FCB=y
CONFIG_SETTINGS_USE_BASE64=y

11
tests/subsys/settings/fcb/base64/prj_native_posix_64.conf
View file

@ -1,11 +0,0 @@
CONFIG_ZTEST=y
CONFIG_STDOUT_CONSOLE=y
CONFIG_FLASH=y
CONFIG_FLASH_PAGE_LAYOUT=y
CONFIG_FLASH_MAP=y
CONFIG_FCB=y
CONFIG_SETTINGS=y
CONFIG_SETTINGS_RUNTIME=y
CONFIG_SETTINGS_FCB=y
CONFIG_SETTINGS_USE_BASE64=y

4
tests/subsys/settings/fcb/base64/testcase.yaml
View file

@ -1,4 +0,0 @@
tests:
system.settings.fcb.base64:
platform_allow: nrf52840dk_nrf52840 nrf52dk_nrf52832 native_posix native_posix_64
tags: settings_fcb

1
tests/subsys/settings/fcb/raw/prj.conf
View file

@ -9,4 +9,3 @@ CONFIG_FCB=y
CONFIG_SETTINGS=y
CONFIG_SETTINGS_RUNTIME=y
CONFIG_SETTINGS_FCB=y
CONFIG_SETTINGS_USE_BASE64=n

1
tests/subsys/settings/fcb/raw/prj_native_posix.conf
View file

@ -8,4 +8,3 @@ CONFIG_FCB=y
CONFIG_SETTINGS=y
CONFIG_SETTINGS_RUNTIME=y
CONFIG_SETTINGS_FCB=y
CONFIG_SETTINGS_USE_BASE64=n

1
tests/subsys/settings/fcb/raw/prj_native_posix_64.conf
View file

@ -8,4 +8,3 @@ CONFIG_FCB=y
CONFIG_SETTINGS=y
CONFIG_SETTINGS_RUNTIME=y
CONFIG_SETTINGS_FCB=y
CONFIG_SETTINGS_USE_BASE64=n

7
tests/subsys/settings/fcb/src/settings_test_fcb.c
View file

@ -379,13 +379,6 @@ void test_config_save_fcb_unaligned(void);
void test_main(void)
{
#ifdef CONFIG_SETTINGS_USE_BASE64
ztest_test_suite(test_config_fcb_base64,
ztest_unit_test(test_settings_encode),
ztest_unit_test(test_setting_raw_read),
ztest_unit_test(test_setting_val_read));
ztest_run_test_suite(test_config_fcb_base64);
#endif
ztest_test_suite(test_config_fcb,
/* Config tests */
ztest_unit_test(config_empty_lookups),

10
tests/subsys/settings/fs/src/settings_test_compress_file.c
View file

@ -10,15 +10,6 @@
#include "settings_test.h"
#include "settings/settings_file.h"
#ifdef CONFIG_SETTINGS_USE_BASE64
#define EXP_STR_CONTENT_1 "\x12\x00myfoo/mybar16=AAE="\
"\x10\x00myfoo/mybar=FA=="\
"\x1A\x00myfoo/mybar64=JQAAAAAAAAA="
#define EXP_STR_CONTENT_2 "\x10\x00myfoo/mybar=FA=="\
"\x12\x00myfoo/mybar16=AQE="\
"\x1A\x00myfoo/mybar64=EwAAAAAAAAA="
#else
#define EXP_STR_CONTENT_1 "\x10\x00myfoo/mybar16=\x00\x01"\
"\x0d\x00myfoo/mybar=\x14"\
"\x16\x00myfoo/mybar64=\x25\x00\x00\x00\x00\x00\x00\x00"
@ -26,7 +17,6 @@
#define EXP_STR_CONTENT_2 "\x0d\x00myfoo/mybar=\x14"\
"\x10\x00myfoo/mybar16=\x01\x01"\
"\x16\x00myfoo/mybar64=\x13\x00\x00\x00\x00\x00\x00\x00"
#endif
int file_str_cmp(const char *fname, char const *string, size_t pattern_len);

7
tests/subsys/settings/fs/src/settings_test_multiple_in_file.c
View file

@ -8,17 +8,10 @@
#include "settings_test.h"
#include "settings/settings_file.h"
#ifdef CONFIG_SETTINGS_USE_BASE64
#define CF_MFG_TEST1 "\x10\x00myfoo/mybar=AQ=="\
"\x10\x00myfoo/mybar=Dg=="
#define CF_MFG_TEST2 "\x10\x00myfoo/mybar=AQ=="\
"\x10\x00myfoo/mybar=Dw=="
#else
#define CF_MFG_TEST1 "\x0d\x00myfoo/mybar=\x01"\
"\x0d\x00myfoo/mybar=\x0e"
#define CF_MFG_TEST2 "\x0d\x00myfoo/mybar=\x01"\
"\x0d\x00myfoo/mybar=\x0f"
#endif
void test_config_multiple_in_file(void)
{

5
tests/subsys/settings/fs/src/settings_test_save_in_file.c
View file

@ -8,13 +8,8 @@
#include "settings_test.h"
#include "settings/settings_file.h"
#ifdef CONFIG_SETTINGS_USE_BASE64
#define CF_FILE_CONTENT_1 "\x10\x00myfoo/mybar=CA=="
#define CF_FILE_CONTENT_2 "\x10\x00myfoo/mybar=Kw=="
#else
#define CF_FILE_CONTENT_1 "\x0d\x00myfoo/mybar=\x08"
#define CF_FILE_CONTENT_2 "\x0d\x00myfoo/mybar=\x2b"
#endif
void test_config_save_in_file(void)
{

5
tests/subsys/settings/fs/src/settings_test_small_file.c
View file

@ -8,13 +8,8 @@
#include "settings_test.h"
#include "settings/settings_file.h"
#ifdef CONFIG_SETTINGS_USE_BASE64
#define CF_MFG_TEST_STR "\x10\x00myfoo/mybar=AQ=="
#define CF_RUNNING_TEST_STR "\x10\x00myfoo/mybar=CA=="
#else
#define CF_MFG_TEST_STR "\x0D\x00myfoo/mybar=\x01"
#define CF_RUNNING_TEST_STR "\x0D\x00myfoo/mybar=\x08"
#endif
void test_config_small_file(void)
{

1
tests/subsys/settings/functional/fcb/prj.conf
View file

@ -9,4 +9,3 @@ CONFIG_FCB=y
CONFIG_SETTINGS=y
CONFIG_SETTINGS_RUNTIME=y
CONFIG_SETTINGS_FCB=y
CONFIG_SETTINGS_USE_BASE64=n

1
tests/subsys/settings/functional/fcb/prj_native_posix.conf
View file

@ -8,4 +8,3 @@ CONFIG_FCB=y
CONFIG_SETTINGS=y
CONFIG_SETTINGS_RUNTIME=y
CONFIG_SETTINGS_FCB=y
CONFIG_SETTINGS_USE_BASE64=n

1
tests/subsys/settings/functional/fcb/prj_native_posix_64.conf
View file

@ -8,4 +8,3 @@ CONFIG_FCB=y
CONFIG_SETTINGS=y
CONFIG_SETTINGS_RUNTIME=y
CONFIG_SETTINGS_FCB=y
CONFIG_SETTINGS_USE_BASE64=n

1
tests/subsys/settings/functional/fcb/prj_qemu_x86.conf
View file

@ -8,4 +8,3 @@ CONFIG_FCB=y
CONFIG_SETTINGS=y
CONFIG_SETTINGS_RUNTIME=y
CONFIG_SETTINGS_FCB=y
CONFIG_SETTINGS_USE_BASE64=n

1
tests/subsys/settings/functional/file/prj.conf
View file

@ -12,7 +12,6 @@ CONFIG_FILE_SYSTEM_LITTLEFS=y
CONFIG_SETTINGS=y
CONFIG_SETTINGS_RUNTIME=y
CONFIG_SETTINGS_FS=y
CONFIG_SETTINGS_USE_BASE64=n
CONFIG_SETTINGS_FS_DIR="/ff/settings"
CONFIG_SETTINGS_FS_FILE="/ff/settings/run"

1
tests/subsys/settings/functional/file/prj_native_posix.conf
View file

@ -10,7 +10,6 @@ CONFIG_FILE_SYSTEM_LITTLEFS=y
CONFIG_SETTINGS=y
CONFIG_SETTINGS_RUNTIME=y
CONFIG_SETTINGS_FS=y
CONFIG_SETTINGS_USE_BASE64=y
CONFIG_SETTINGS_FS_DIR="/ff/settings"
CONFIG_SETTINGS_FS_FILE="/ff/settings/run"

1
tests/subsys/settings/functional/file/prj_native_posix_64.conf
View file

@ -10,7 +10,6 @@ CONFIG_FILE_SYSTEM_LITTLEFS=y
CONFIG_SETTINGS=y
CONFIG_SETTINGS_RUNTIME=y
CONFIG_SETTINGS_FS=y
CONFIG_SETTINGS_USE_BASE64=n
CONFIG_SETTINGS_FS_DIR="/ff/settings"
CONFIG_SETTINGS_FS_FILE="/ff/settings/run"

1
tests/subsys/settings/functional/file/prj_qemu_x86.conf
View file

@ -10,7 +10,6 @@ CONFIG_FILE_SYSTEM_LITTLEFS=y
CONFIG_SETTINGS=y
CONFIG_SETTINGS_RUNTIME=y
CONFIG_SETTINGS_FS=y
CONFIG_SETTINGS_USE_BASE64=n
CONFIG_SETTINGS_FS_DIR="/ff/settings"
CONFIG_SETTINGS_FS_FILE="/ff/settings/run"

1
tests/subsys/settings/functional/nvs/prj.conf
View file

@ -8,4 +8,3 @@ CONFIG_NVS=y
CONFIG_SETTINGS=y
CONFIG_SETTINGS_RUNTIME=y
CONFIG_SETTINGS_NVS=y
CONFIG_SETTINGS_USE_BASE64=n

1
tests/subsys/settings/littlefs/base64/prj.conf
View file

@ -18,4 +18,3 @@ CONFIG_FILE_SYSTEM_LITTLEFS=y
CONFIG_SETTINGS=y
CONFIG_SETTINGS_RUNTIME=y
CONFIG_SETTINGS_FS=y
CONFIG_SETTINGS_USE_BASE64=y

1
tests/subsys/settings/littlefs/base64/prj_native_posix.conf
View file

@ -17,4 +17,3 @@ CONFIG_FILE_SYSTEM_LITTLEFS=y
CONFIG_SETTINGS=y
CONFIG_SETTINGS_RUNTIME=y
CONFIG_SETTINGS_FS=y
CONFIG_SETTINGS_USE_BASE64=y

1
tests/subsys/settings/littlefs/base64/prj_native_posix_64.conf
View file

@ -17,4 +17,3 @@ CONFIG_FILE_SYSTEM_LITTLEFS=y
CONFIG_SETTINGS=y
CONFIG_SETTINGS_RUNTIME=y
CONFIG_SETTINGS_FS=y
CONFIG_SETTINGS_USE_BASE64=y

1
tests/subsys/settings/littlefs/raw/prj.conf
View file

@ -18,4 +18,3 @@ CONFIG_FILE_SYSTEM_LITTLEFS=y
CONFIG_SETTINGS=y
CONFIG_SETTINGS_RUNTIME=y
CONFIG_SETTINGS_FS=y
CONFIG_SETTINGS_USE_BASE64=n

1
tests/subsys/settings/littlefs/raw/prj_native_posix.conf
View file

@ -17,4 +17,3 @@ CONFIG_FILE_SYSTEM_LITTLEFS=y
CONFIG_SETTINGS=y
CONFIG_SETTINGS_RUNTIME=y
CONFIG_SETTINGS_FS=y
CONFIG_SETTINGS_USE_BASE64=n

1
tests/subsys/settings/littlefs/raw/prj_native_posix_64.conf
View file

@ -17,4 +17,3 @@ CONFIG_FILE_SYSTEM_LITTLEFS=y
CONFIG_SETTINGS=y
CONFIG_SETTINGS_RUNTIME=y
CONFIG_SETTINGS_FS=y
CONFIG_SETTINGS_USE_BASE64=n

1
tests/subsys/settings/nvs/raw/prj.conf
View file

@ -8,4 +8,3 @@ CONFIG_NVS=y
CONFIG_SETTINGS=y
CONFIG_SETTINGS_RUNTIME=y
CONFIG_SETTINGS_NVS=y
CONFIG_SETTINGS_USE_BASE64=n