README.md 8.6 KB
Newer Older
A
armink 已提交
1
# EasyFlash 
A
armink 已提交
2 3 4

---

A
armink 已提交
5 6
[![GitHub release](https://img.shields.io/github/release/armink/EasyFlash.svg)](https://github.com/armink/EasyFlash/releases/latest) [![GitHub commits](https://img.shields.io/github/commits-since/armink/EasyFlash/3.0.0.svg)](https://github.com/armink/EasyFlash/compare/3.0.0...master) [![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/armink/EasyFlash/master/LICENSE)

A
armink 已提交
7
## 1、介绍([English](#1-introduction))
A
armink 已提交
8

A
armink 已提交
9
[EasyFlash](https://github.com/armink/EasyFlash)是一款开源的轻量级嵌入式Flash存储器库,主要为MCU(Micro Control Unit)提供便捷、通用的上层应用接口,使得开发者更加高效实现基于的Flash存储器常见应用开发。该库目前提供 **三大实用功能**
A
armink 已提交
10

A
armink 已提交
11
- **Env** 快速保存产品参数,支持 **写平衡(磨损平衡)****掉电保护** 模式
A
armink 已提交
12
 
A
armink 已提交
13
EasyFlash不仅能够实现对产品的 **设定参数****运行日志** 等信息的掉电保存功能,还封装了简洁的 **增加、删除、修改及查询** 方法, 降低了开发者对产品参数的处理难度,也保证了产品在后期升级时拥有更好的扩展性。让Flash变为NoSQL(非关系型数据库)模型的小型键值(Key-Value)存储数据库。
14 15

- **IAP** 在线升级再也不是难事儿
A
armink 已提交
16
 
17 18 19 20
该库封装了IAP(In-Application Programming)功能常用的接口,支持CRC32校验,同时支持Bootloader及Application的升级。

- **Log** 无需文件系统,日志可直接存储在Flash上

A
armink 已提交
21
非常适合应用在小型的不带文件系统的产品中,方便开发人员快速定位、查找系统发生崩溃或死机的原因。同时配合[EasyLogger](https://github.com/armink/EasyLogger)(我开源的超轻量级、高性能C日志库,它提供与EasyFlash的无缝接口)一起使用,轻松实现C日志的Flash存储功能。
A
armink 已提交
22

A
armink 已提交
23
### 1.1、资源占用
A
armink 已提交
24 25

```
26
最低要求: ROM: 6K bytes     RAM: 0.5K bytes + (Env大小)
A
armink 已提交
27

28 29
Demo平台:STM32F103RET6 + RT-Thread 1.2.2 + Env(2K bytes)
实际占用: ROM: 6K bytes     RAM: 2.6K bytes
A
armink 已提交
30 31
```

A
armink 已提交
32
### 1.2、支持平台
A
armink 已提交
33

A
armink 已提交
34
目前已移植硬件平台有 `stm32f10x``stm32f4xx` 系列的片内Flash,SPI Flash,这些也是笔者产品使用的平台。其余平台的移植难度不大,在项目的设计之初就有考虑针对所有平台的适配性问题(64位除外),所以对所有移植接口都有做预留。移植只需修改 [`\easyflash\port\ef_port.c`](https://github.com/armink/EasyFlash/blob/master/easyflash/port/ef_port.c) 一个文件,实现里面的擦、写、读及打印功能即可。
A
armink 已提交
35

A
armink 已提交
36
欢迎大家 **fork and pull request**([Github](https://github.com/armink/EasyFlash)|[OSChina](http://git.oschina.net/armink/EasyFlash)|[Coding](https://coding.net/u/armink/p/EasyFlash/git)) 。如果觉得这个开源项目很赞,可以点击[项目主页](https://github.com/armink/EasyFlash) 右上角的 **Star**,同时把它推荐给更多有需要的朋友。
A
armink 已提交
37

38
## 2、流程
A
armink 已提交
39

40
### 2.1、Env:环境变量(KV数据库)
41

42 43 44 45 46 47 48 49
下图为通过控制台(终端)来调用环境变量的常用接口,演示了以下过程,这些接口都支持被应用层直接调用。

- 1、创建“温度”的环境变量,名为 `temp`,并且赋值为 `123`
- 2、保存“温度”到Flash中并重启;
- 3、检查“温度”是否被成功保存;
- 4、修改“温度”值为 `456` 并保存、重启;
- 5、检查“温度”是否被成功修改;
- 6、删除“温度”的环境变量。
50

A
armink 已提交
51
![easy_flash_env](https://raw.githubusercontent.com/armink/EasyFlash/master/docs/zh/images/EnvDemo.gif)
A
armink 已提交
52

53
### 2.2、IAP:在线升级
54

55
下图演示了通过控制台来进行IAP升级软件的过程,使用的是库中自带的IAP功能接口,演示采用的是串口+Ymodem协议的方式。你还也可以实现通过CAN、485、以太网等总线,来实现远程网络更新。
56

A
armink 已提交
57
![easy_flash_iap](https://raw.githubusercontent.com/armink/EasyFlash/master/docs/zh/images/IapDemo.gif)
58

59
### 2.3、Log:日志存储
60 61 62

下图过程为通过控制台输出日志,并将输出的日志存储到Flash中。重启再读取上次保存的日志,最后清空Flash日志。

A
armink 已提交
63
![easy_flash_log](https://raw.githubusercontent.com/armink/EasyFlash/master/docs/zh/images/LogDemo.gif)
A
armink 已提交
64

65
## 3、文档
A
armink 已提交
66

A
armink 已提交
67
具体内容参考[`\docs\zh\`](https://github.com/armink/EasyFlash/tree/master/docs/zh)下的文件。务必保证在 **阅读文档** 后再移植使用。
A
armink 已提交
68

A
armink 已提交
69
## 4、许可
A
armink 已提交
70

71
采用 MIT 开源协议,细节请阅读项目中的 LICENSE 文件内容。
A
armink 已提交
72

A
armink 已提交
73 74 75 76
---

## 1 Introduction

77
[EasyFlash](https://github.com/armink/EasyFlash) is an open source lightweight embedded flash memory library. It provides convenient application interface for MCU (Micro Control Unit). The developers can achieve more efficient and common application development based on Flash memory. The library currently provides **three useful features**
A
armink 已提交
78

A
armink 已提交
79
- **Env(environment variables)** Fast Saves product parameters. Support **write balance mode(wear leveling)** and **power fail safeguard**. 
A
armink 已提交
80

81
EasyFlash can store **setting parameters** or **running logs** and other information which you want to keep after power down. It contains add, delete, modify and query methods. It helps developer to process the product parameters, and makes sure the product has better scalability after upgrade. Turns the Flash into a small NoSQL (non-relational databases) model and Key-Value stores database.
82 83

- **IAP** : online upgrade is no longer a difficult thing.
A
armink 已提交
84
 
85 86 87 88
The library encapsulates the IAP (In-Application Programming) feature common interface. Support CRC32 checksum. While supporting the bootloader and application upgrade.

- **Log** : The logs can store to product's flash which has no file-system.

A
armink 已提交
89
It's very suitable for small without a file system products. The developer can easy to locate and query problem when system crashes or freezes. You can use [EasyLogger](https://github.com/armink/EasyLogger)( A super-lightweight, high-performance C log library which open source by me. It provides a seamless interface with EasyFlash) at the same time. So, it's so easy to store the logs to flash.
A
armink 已提交
90

A
armink 已提交
91
### 1.1 Resource consumption
A
armink 已提交
92 93 94 95 96 97 98 99

```
Minimum : ROM: 6K bytes     RAM: 0.5K bytes + (Env size)

Demo    :STM32F103RET6 + RT-Thread 1.2.2 + Env(2K bytes)
Actual  : ROM: 6K bytes     RAM: 2.6K bytes
```

A
armink 已提交
100
### 1.2 Supported platforms
A
armink 已提交
101

102
Hardware platform has been ported SPI Flash, `stm32f10x` and `stm32f4xx` series of on-chip Flash. These are my product platforms. Remaining platform porting difficulty is little. To port it just modify [`\easyflash\port\ef_port.c`](https://github.com/armink/EasyFlash/blob/master/easyflash/port/ef_port.c) file. Implement erase, write, read, print feature.
A
armink 已提交
103

A
armink 已提交
104
Welcome everyone to **fork and pull request**([Github](https://github.com/armink/EasyFlash)|[OSChina](http://git.oschina.net/armink/EasyFlash)|[Coding](https://coding.net/u/armink/p/EasyFlash/git)). If you think this open source project is awesome. You can press the **Star** on the top right corner of [project home page](https://github.com/armink/EasyFlash), and recommend it to more friends.
A
armink 已提交
105 106 107

## 2 Flow

108 109
### 2.1 Env(KV database)

110
The figure below shows an ENV's common interface be called by the console (terminal). These interfaces are supported by the application layer called.
A
armink 已提交
111

112 113 114 115 116 117
- 1.Create temperature environment variable. It's name is `temp` and value is `123`;
- 2.Save temperature to flash and reboot;
- 3.Check the temperature has saved successfully;
- 4.Change the temperature value to `456` and save, reboot;
- 5.Check the temperature has changed successfully;
- 6.Delete temperature environment variable.
A
armink 已提交
118

119
![easy_flash_env](https://raw.githubusercontent.com/armink/EasyFlash/master/docs/en/images/EnvDemo.gif)
A
armink 已提交
120 121 122

### 2.2 IAP

123
The figure below shows the process of upgrading software through the console by IAP. It use this library comes with IAP function interface. It uses a serial port + Ymodem protocol mode. You can also be achieved through CAN, 485, Ethernet bus to online upgrade.
A
armink 已提交
124

125 126 127 128
![easy_flash_iap](https://raw.githubusercontent.com/armink/EasyFlash/master/docs/en/images/IapDemo.gif)

### 2.3 Log

129
The following figure is the output of the log process through the console. The logs are saved to flash at real time. Then the board is rebooted and the logs back are read back from flash. At last logs will be erased.
130 131

![easy_flash_log](https://raw.githubusercontent.com/armink/EasyFlash/master/docs/en/images/LogDemo.gif)
A
armink 已提交
132 133 134

## 3 Documents

135
All documents are in the [`\docs\en\`](https://github.com/armink/EasyFlash/tree/master/docs/en) folder. Please **read the documents** before porting it and using it.
A
armink 已提交
136 137

## 4 License
A
armink 已提交
138

139
Using MIT open source license, please read the project LICENSE file.