提交 afc40a82 编写于 作者: armink_ztl's avatar armink_ztl

1、【更新】API文档及Demo说明文档。

Signed-off-by: armink_ztl's avatararmink <armink.ztl@gmail.com>
上级 aca19f79
......@@ -4,10 +4,19 @@
## 1、简介
通过 `\demo\stm32f10x\app\src\app_task.c``test_env()` 方法来演示环境变量的读取及修改功能,每次系统启动并且初始化EasyFlash成功后会调用该方法。
通过 `app\src\app_task.c``test_env()` 方法来演示环境变量的读取及修改功能,每次系统启动并且初始化EasyFlash成功后会调用该方法。
`test_env()` 方法中,会先读取系统的启动次数,读取后对启动次数加一,再存入到环境变量中,实现记录系统启动(开机)次数的功能。
### 1.1、使用方法
- 1、打开电脑的终端与Demo的串口1进行连接,串口配置 115200 8 1 N,此时在终端中就可以输入《EasyFlash 使用说明》中提到的常用命令(目前只有环境变量操作命令)。
- 2、在终端输入 `printenv` 查看当前的系统启动次数,即 `boot_times` 的value。
- 3、输入 `reboot` 命令,或者直接重启Demo平台
- 4、等待系统重启完成后,再次输入 `printenv` ,即可查看到启动次数有所增加
> 注意:对于无法连接终端的用户,也可以使用仿真器与Demo平台进行连接,来观察启动次数的变化
## 2、文件说明
`\demo\stm32f10x\components\flash\port\flash_port.c` 移植参考文件
......
......@@ -4,10 +4,19 @@
## 1、简介
通过 `\demo\stm32f10x\app\src\app_task.c``test_env()` 方法来演示环境变量的读取及修改功能,每次系统启动并且初始化EasyFlash成功后会调用该方法。
通过 `app\src\app_task.c``test_env()` 方法来演示环境变量的读取及修改功能,每次系统启动并且初始化EasyFlash成功后会调用该方法。
`test_env()` 方法中,会先读取系统的启动次数,读取后对启动次数加一,再存入到环境变量中,实现记录系统启动(开机)次数的功能。
### 1.1、使用方法
- 1、打开电脑的终端与Demo的串口1进行连接,串口配置 115200 8 1 N,此时在终端中就可以输入《EasyFlash 使用说明》中提到的常用命令(目前只有环境变量操作命令)。
- 2、在终端输入 `printenv` 查看当前的系统启动次数,即 `boot_times` 的value。
- 3、输入 `reboot` 命令,或者直接重启Demo平台
- 4、等待系统重启完成后,再次输入 `printenv` ,即可查看到启动次数有所增加
> 注意:对于无法连接终端的用户,也可以使用仿真器与Demo平台进行连接,来观察启动次数的变化
## 2、文件说明
`\demo\stm32f4xx\components\flash\port\flash_port.c` 移植参考文件
......
......@@ -87,13 +87,13 @@ FlashErrCode flash_env_set_default(void)
#### 1.2.7 获取环境变量分区的总容量
```C
uint32_t flash_get_env_total_size(void)
size_t flash_get_env_total_size(void)
```
#### 1.2.8 获取当前已使用环境变量的大小
#### 1.2.8 获取当前环境变量写入到Flash的字节大小
```C
uint32_t flash_get_env_used_size(void)
size_t flash_get_env_write_bytes(void)
```
### 1.3 在线升级
......@@ -165,7 +165,7 @@ 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
#### 1.3.6 从备份拷贝Bootloader
将备份区已下载好的Bootloader拷贝至Bootloader起始地址。
注意:
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册