@armink
2017-08-22T05:51:15.000000Z
字数 3335
阅读 1962
EasyFlash
所有支持的API接口都在\easyflash\inc\easyflash.h
中声明。以下内容较多,建议使用 CTRL+F 搜索。
名词介绍:
备份区 :是EasyFlash定义的一个存放环境变量、已下载程序及日志的Flash区域,详细存储架构可以参考\easyflash\src\easyflash.c
文件头位置的注释说明或移植文档中关于备份区参数配置。
环境变量表 :负责存放所有的环境变量,该表在Flash及RAM中均存在,上电后需从Flash加载到RAM中,修改后,则需要保存其至Flash中。。
初始化的EasyFlash的各个组件,初始化后才可以使用下面的API。
EfErrCode easyflash_init(void)
加载Flash中的所有环境变量到系统内存中。
void ef_load_env(void)
通过在移植接口(\easyflash\port\ef_port.c
)中定义的ef_print
打印方法,来将Flash中的所有环境变量输出出来。
void ef_print_env(void)
通过环境变量的名字来获取其对应的值。(注意:此处的环境变量指代的已加载到内存中的环境变量)
char *ef_get_env(const char *key)
参数 | 描述 |
---|---|
key | 环境变量名称 |
使用此方法可以实现对环境变量的增加、修改及删除功能。(注意:此处的环境变量指代的已加载到内存中的环境变量)
增加 :当环境变量表中不存在该名称的环境变量时,则会执行新增操作;
修改 :入参中的环境变量名称在当前环境变量表中存在,则把该环境变量值修改为入参中的值;
删除 :当入参中的value为空时,则会删除入参名对应的环境变量。
EfErrCode ef_set_env(const char *key, const char *value)
参数 | 描述 |
---|---|
key | 环境变量名称 |
value | 环境变量值 |
保存内存中的环境变量表到Flash中。
EfErrCode ef_save_env(void)
将内存中的环境变量表重置为默认值。
EfErrCode ef_env_set_default(void)
size_t ef_get_env_write_bytes(void)
设置环境变量成功后立刻保存。设置功能参考ef_set_env
方法。
EfErrCode ef_set_and_save_env(const char *key, const char *value)
参数 | 描述 |
---|---|
key | 环境变量名称 |
value | 环境变量值 |
EfErrCode ef_erase_bak_app(size_t app_size)
注意:请不要在应用程序中调用该方法
EfErrCode ef_erase_user_app(uint32_t user_app_addr, size_t user_app_size)
参数 | 描述 |
---|---|
user_app_addr | 用户应用程序入口地址 |
user_app_size | 用户应用程序大小 |
当用户的应用程序与备份区 不在同一个 Flash 时,则需要用户额外指定擦除应用程序的方法。而 ef_erase_user_app
会使用移植文件中的 ef_port_erase
方法进行擦除,除此之外的其余功能,两个方法均一致。
注意:请不要在应用程序中调用该方法
EfErrCode ef_erase_spec_user_app(uint32_t user_app_addr, size_t app_size,
EfErrCode (*app_erase)(uint32_t addr, size_t size));
参数 | 描述 |
---|---|
user_app_addr | 用户应用程序入口地址 |
user_app_size | 用户应用程序大小 |
app_erase | 用户指定应用程序擦写方法 |
注意:请不要在Bootloader中调用该方法
EfErrCode ef_erase_bl(uint32_t bl_addr, size_t bl_size)
参数 | 描述 |
---|---|
bl_addr | Bootloader入口地址 |
bl_size | Bootloader大小 |
为下载程序到备份区定制的Flash连续写方法。
注意:写之前请先确认Flash已进行擦除。
EfErrCode ef_write_data_to_bak(uint8_t *data,
size_t size,
size_t *cur_size,
size_t total_size)
参数 | 描述 |
---|---|
data | 需要写入到备份区中的数据存储地址 |
size | 此次写入数据的大小(字节) |
cur_size | 之前已写入到备份区中的数据大小(字节) |
total_size | 需要写入到备份区的数据总大小(字节) |
将备份区已下载好的应用程序拷贝至用户应用程序起始地址。
注意:
1、拷贝前必须对原有的应用程序进行擦除
2、不要在应用程序中调用该方法
EfErrCode ef_copy_app_from_bak(uint32_t user_app_addr, size_t app_size)
参数 | 描述 |
---|---|
user_app_addr | 用户应用程序入口地址 |
user_app_size | 用户应用程序大小 |
当用户的应用程序与备份区 不在同一个 Flash 时,则需要用户额外指定写应用程序的方法。而 ef_copy_app_from_bak
会使用移植文件中的 ef_port_write
方法进行写操作,除此之外的其余功能,两个方法均一致。
EfErrCode ef_copy_spec_app_from_bak(uint32_t user_app_addr, size_t app_size,
EfErrCode (*app_write)(uint32_t addr, const uint32_t *buf, size_t size))
参数 | 描述 |
---|---|
user_app_addr | 用户应用程序入口地址 |
user_app_size | 用户应用程序大小 |
app_write | 用户指定应用程序写操作方法 |
将备份区已下载好的Bootloader拷贝至Bootloader起始地址。
注意:
1、拷贝前必须对原有的Bootloader进行擦除
2、不要在Bootloader中调用该方法
EfErrCode ef_copy_bl_from_bak(uint32_t bl_addr, size_t bl_size)
参数 | 描述 |
---|---|
bl_addr | Bootloader入口地址 |
bl_size | Bootloader大小 |
EfErrCode ef_log_read(size_t index, uint32_t *log, size_t size);
参数 | 描述 |
---|---|
index | 日志读取的索引顺序 |
log | 存储待读取日志的缓冲区 |
size | 读取日志的大小 |
EfErrCode ef_log_write(const uint32_t *log, size_t size);
参数 | 描述 |
---|---|
log | 存储待保存的日志 |
size | 待保存日志的大小 |
EfErrCode ef_log_clean(void);
size_t ef_log_get_used_size(void);
参照EasyFlash 移植说明(\docs\zh\port.md
)中的 设置参数
章节
ef_save_env
才会保存在Flash中,否则开机会丢失修改的内容