You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

9.3 KiB

Raw Blame History Unescape Escape

EasyFlash API 说明

所有支持的API接口都在 \flash\inc\flash.h 中声明。以下内容较多，建议使用 CTRL+F 搜索。

名词介绍：

备份区 ：是EasyFlash定义的一个存放环境变量及已下载程序的Flash区域，详细存储架构可以参考 \flash\src\flash.c 文件头位置的注释说明。

环境变量表 ：负责存放所有的环境变量，该表在Flash及RAM中均存在，上电后需从Flash加载到RAM中，修改后，则需要保存其至Flash中。。

1、用户使用接口

1.1 初始化

初始化EasyFlash。在初始化的过程中会使用 \flash\port\flash_port.c 中的用户自定义参数。

FlashErrCode flash_init(void)

1.2 环境变量

1.2.1 加载环境变量

加载Flash中的所有环境变量到系统内存中。

void flash_load_env(void)

1.2.2 打印环境变量

通过在移植接口( \flash\port\flash_port.c )中定义的 flash_print 打印方法，来将Flash中的所有环境变量输出出来。

void flash_print_env(void)

1.2.3 获取环境变量

通过环境变量的名字来获取其对应的值。（注意：此处的环境变量指代的已加载到内存中的环境变量）

char *flash_get_env(const char *key)

参数	描述
key	环境变量名称

1.2.4 设置环境变量

使用此方法可以实现对环境变量的增加、修改及删除功能。（注意：此处的环境变量指代的已加载到内存中的环境变量）

增加：当环境变量表中不存在该名称的环境变量时，则会执行新增操作；

修改：入参中的环境变量名称在当前环境变量表中存在，则把该环境变量值修改为入参中的值；

删除：当入参中的value为空时，则会删除入参名对应的环境变量。

FlashErrCode flash_set_env(const char *key, const char *value)

参数	描述
key	环境变量名称
value	环境变量值

1.2.5 保存环境变量

保存内存中的环境变量表到Flash中。

FlashErrCode flash_save_env(void)

1.2.6 恢复环境变量

将内存中的环境变量表恢复为默认值。

FlashErrCode flash_env_set_default(void)

1.2.7 获取环境变量分区的总容量

uint32_t flash_get_env_total_size(void)

1.2.8 获取当前已使用环境变量的大小

uint32_t flash_get_env_used_size(void)

1.3 在线升级

1.3.1 擦除备份区中的应用程序

FlashErrCode flash_erase_bak_app(size_t app_size)

1.3.2 擦除用户的应用程序

注意：请不要在应用程序中调用该方法

FlashErrCode flash_erase_user_app(uint32_t user_app_addr, size_t user_app_size)

参数	描述
user_app_addr	用户应用程序入口地址
user_app_size	用户应用程序大小

1.3.3 擦除Bootloader

注意：请不要在Bootloader中调用该方法

FlashErrCode flash_erase_bl(uint32_t bl_addr, size_t bl_size)

参数	描述
bl_addr	Bootloader入口地址
bl_size	Bootloader大小

1.3.4 写数据到备份区

为下载程序到备份区定制的Flash连续写方法。注意：写之前请先确认Flash已进行擦除。

FlashErrCode flash_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.3.5 从备份拷贝应用程序

将备份区已下载好的应用程序拷贝至用户应用程序起始地址。注意： 1、拷贝前必须对原有的应用程序进行擦除 2、不要在应用程序中调用该方法

FlashErrCode flash_copy_app_from_bak(uint32_t user_app_addr, size_t app_size)

参数	描述
user_app_addr	用户应用程序入口地址
user_app_size	用户应用程序大小

1.3.5 从备份拷贝Bootloader

将备份区已下载好的Bootloader拷贝至Bootloader起始地址。注意： 1、拷贝前必须对原有的Bootloader进行擦除 2、不要在Bootloader中调用该方法

FlashErrCode flash_copy_bl_from_bak(uint32_t bl_addr, size_t bl_size)

参数	描述
bl_addr	Bootloader入口地址
bl_size	Bootloader大小

2 移植接口

2.1 读取Flash

最小单位为4个字节

FlashErrCode flash_read(uint32_t addr, uint32_t *buf, size_t size)

参数	描述
addr	读取起始地址
buf	存放读取数据的缓冲区
size	读取数据的大小（字节）

2.2 擦除Flash

FlashErrCode flash_erase(uint32_t addr, size_t size)

参数	描述
addr	擦除起始地址
size	擦除数据的大小（字节）

2.3 写入Flash