一种嵌入式项目的参数保存方案

news2024/11/18 11:35:20

设计背景

嵌入式项目中，为了保证系统的正常运转，通常需要保存一部分数据至非易失存储设备如flash中。此处提供了一种通用的方案用于快速在项目中集成参数保存功能，该方案有以下几点特征：
- 接口简便，方便快速集成以及使用；
- 参数类型包含常见的数据类型，同时预留了自定义数据类型的接口；
- 拥有校验机制，提供了范围校验/相等校验的接口，同时预留了自定义校验的接口；
- 参数区拥有版本号概念，同时预留了参数区版本号变更的操作接口；

相关举例

为了添加参数时尽可能的方便，统一用一个结构体对参数进行描述
```
typedef struct {
    CONFIG_VALUE_TYPE_e     val_type;
    uint16_t                length;
    uint32_t                offset;
    CONFIG_VAL_CHECK_TYPE_e check_type;
    void                    *check_val;
    int32_t                 check_len;
    int32_t                 (*check_fun)(void*, void*);
} CONFIG_UNIT_VALUE_DESCRIBE_t;
```
- CONFIG_VALUE_TYPE_e枚举表示该参数的数据类型，比如uint8_t为CONFIG_VALUE_TYPE_UINT8；
- length表示该参数的数据长度，以字节为单位；
- offset表示该参数相对于整个参数区的偏移量，以字节为单位；
- CONFIG_VAL_CHECK_TYPE_e枚举表示该参数的校验方式，比如范围校验为CONFIG_VAL_CHECK_TYPE_RANGE；
- check_val和check_len分别表示校验使用到的数据以及数据长度；
- check_fun则是具体的校验方法；
当需要添加一个参数时，只要添加上对该参数的描述即可，以加入版本号为例子：
- 先在CONFIG_TYPE_e枚举中加入参数枚举
```
typedef enum {
    CONFIG_TYPE_VERSION = 0,
    CONFIG_TYPE_NUM,
} CONFIG_TYPE_e;
```
- 在参数区默认值表中加入版本号默认值，该表为跟随固件的全局变量；
```
config_val_t g_config_default_val = {
    .version        = (uint32_t)1,
};
```
- 接着在参数描述表中添加对版本号参数的描述；从下表可知该参数的数据类型为uint32_t，参数数据长度为4字节，相较于参数区文件的偏移量为0，参数校验方式为自定义校验，不需要使用校验数据，校验函数为Version_CustomCheck_Fun；
```
CONFIG_UNIT_VALUE_DESCRIBE_t g_config_val_describe_table[] = {
    [CONFIG_TYPE_VERSION] = {CONFIG_VALUE_TYPE_UINT32, 4, 0, CONFIG_VAL_CHECK_TYPE_CUSTOM_VERSION, NULL, 0, Version_CustomCheck_Fun}, 
};
```
- 使用如下的方法，对该参数进行读写
```
uint32_t val;
Unit_Config_Read_Val(CONFIG_TYPE_VERSION, &val);
val ++;
Unit_Config_Write_Val(CONFIG_TYPE_VERSION, &val);
```
整体流程