README.md 2.3 KB
Newer Older
armink_ztl's avatar
armink_ztl 已提交
1 2 3 4 5 6 7 8 9
# EasyFlash 使用说明

---

## 1、介绍

EasyFlash是一款开源的轻量级嵌入式Flash库,主要为MCU(Micro Control Unit)提供便捷、通用的上层应用接口,使得开发者更加高效实现基于的Flash常见应用开发。该库目前提供 **两大实用功能**

 - **Env** 让变量轻轻松松实现掉电保存,无需担心变量长度、对其等问题
armink_ztl's avatar
armink_ztl 已提交
10
 
armink_ztl's avatar
armink_ztl 已提交
11 12
 使用 **键值对(key-value)** 方式将变量存储到Flash中,类似U-Boot的 `环境变量` ,使用方式与U-Boot一致。
 - **IAP** 在线升级再也不是难事儿
armink_ztl's avatar
armink_ztl 已提交
13
 
armink_ztl's avatar
armink_ztl 已提交
14 15 16 17 18 19 20 21 22 23 24
 该库封装了IAP(In-Application Programming)功能常用的接口,支持CRC32校验,同时支持Bootloader及Application的升级。

### 1.1、文件结构

|源文件                                 |描述   |
|:------------------------------        |:----- |
|\flash\src\flash_env.c                 |Env(环境变量)相关操作接口及实现源码|
|\flash\src\flash_iap.c                 |IAP(在线升级)相关操作接口及实现源码|
|\flash\src\flash_utils.c               |EasyFlash常用小工具,例如:CRC32|
|\flash\src\flash.c                     |目前只包含EasyFlash初始化方法|
|\flash\port\flash_port.c               |不同平台下的EasyFlash移植接口及配置参数|
armink_ztl's avatar
armink_ztl 已提交
25
|\demo\stm32f10x                        |stm32f10x平台下的demo|
armink_ztl's avatar
armink_ztl 已提交
26 27 28 29 30 31 32 33 34 35 36 37

### 1.2、资源占用

```
最低要求: ROM: 6K bytes     RAM: 0.5K bytes + (Env大小)

Demo平台:STM32F103RET6 + RT-Thread 1.2.2 + Env(2K bytes)
实际占用: ROM: 6K bytes     RAM: 2.6K bytes
```

### 1.3、支持平台

armink_ztl's avatar
armink_ztl 已提交
38
目前已移植平台只有 `STM32F10X` 系列的片内Flash,这个也是笔者产品使用的平台。其余平台的移植难度不大,在项目的设计之初就有考虑针对所有平台的适配性问题(64位除外),所以对所有移植接口都有做预留。移植只需修改 `\flash\port\flash_port.c` 一个文件,实现里面的擦、写、读及打印功能即可。
armink_ztl's avatar
armink_ztl 已提交
39

armink_ztl's avatar
armink_ztl 已提交
40
欢迎大家 **fork and pull request** 。开源软件的成功离不开所有人的努力,也希望该项目能够帮助大家降低开发周期,让产品更早的获得成功。
armink_ztl's avatar
armink_ztl 已提交
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60

## 2、流程

### 2.1、环境变量
下图为人工通过控制台来调用环境变量的常用接口,演示了环境变量 `"temp"` 从创建到保存,再修改,最后删除的过程。这些接口都支持被应用层直接调用。
![easy_flash_env](https://cloud.githubusercontent.com/assets/1734686/5886463/46ad7efa-a3db-11e4-8401-75c00a4c35ba.gif)

### 2.2、在线升级
下图演示了通过控制台来进行IAP升级软件的过程,使用的是库中自带的IAP功能接口,演示采用的是串口+Ymodem协议的方式。你还也可以实现通过CAN、485、以太网等总线,来实现远程网络更新。
![easy_flash_iap](https://cloud.githubusercontent.com/assets/1734686/5886462/40f7d62c-a3db-11e4-866a-ba827c809370.gif)

## 3、API

马上就来...

## 4、注意