README.md
1# Flash 设备及分区移植示例
2
3本示例主要演示 Flash 设备及分区相关的移植。
4
5## 1、Flash 设备
6
7在定义 Flash 设备表前，需要先定义 Flash 设备，参考 [`fal_flash_sfud_port.c`](fal_flash_sfud_port.c) （基于 [SFUD](https://github.com/armink/SFUD) 万能 SPI Flash 驱动的 Flash 设备）与 [`fal_flash_stm32f2_port.c`](fal_flash_stm32f2_port.c) （STM32F2 片内 Flash）这两个文件。这里简介下 `fal_flash_stm32f2_port.c` 里的代码实现。
8
9### 1.1 定义 Flash 设备
10
11针对 Flash 的不同操作，这里定义了如下几个操作函数：
12
13- `static int init(void)`：**可选** 的初始化操作
14
15- `static int read(long offset, rt_uint8_t *buf, rt_size_t size)`：读取操作
16
17|参数 |描述|
18|:----- |:----|
19|offset |读取数据的 Flash 偏移地址|
20|buf |存放待读取数据的缓冲区|
21|size |待读取数据的大小|
22|return |返回实际读取的数据大小|
23
24- `static int write(long offset, const rt_uint8_t *buf, rt_size_t size)` ：写入操作
25
26| 参数 | 描述 |
27| :----- | :------------------------ |
28| offset | 写入数据的 Flash 偏移地址 |
29| buf | 存放待写入数据的缓冲区 |
30| size | 待写入数据的大小 |
31| return | 返回实际写入的数据大小 |
32
33- `static int erase(long offset, rt_size_t size)` ：擦除操作
34
35| 参数 | 描述 |
36| :----- | :------------------------ |
37| offset | 擦除区域的 Flash 偏移地址 |
38| size | 擦除区域的大小 |
39| return | 返回实际擦除的区域大小 |
40
41用户需要根据自己的 Flash 情况分别实现这些操作函数。在文件最底部定义了具体的 Flash 设备对象(stm32f2_onchip_flash)：
42
43`const struct fal_flash_dev stm32f2_onchip_flash = { "stm32_onchip", 0x08000000, 1024*1024, 128*1024, {init, read, write, erase} };`
44
45- `"stm32_onchip"` : Flash 设备的名字
46- 0x08000000: 对 Flash 操作的起始地址
47- 1024*1024：Flash 的总大小（1MB）
48- 128*1024：Flash 块/扇区大小（因为 STM32F2 各块大小不均匀，所以擦除粒度为最大块的大小：128K）
49- {init, read, write, erase} }：Flash 的操作函数。 如果没有 init 初始化过程，第一个操作函数位置可以置空。
50
51### 1.2 定义 Flash 设备表
52
53Flash 设备表定义在 `fal_cfg.h` 头文件中，定义分区表前需 **新建 `fal_cfg.h` 文件** 。
54
55参考 [示例文件 samples/porting/fal_cfg.h](samples/porting/fal_cfg.h) 或如下代码：
56
57```c
58/* ===================== Flash device Configuration ========================= */
59extern const struct fal_flash_dev stm32f2_onchip_flash;
60extern struct fal_flash_dev nor_flash0;
61
62/* flash device table */
63#define FAL_FLASH_DEV_TABLE \
64{ \
65 &stm32f2_onchip_flash, \
66 &nor_flash0, \
67}
68```
69
70Flash 设备表中，有两个 Flash 对象，一个为 STM32F2 的片内 Flash ，一个为片外的 Nor Flash。
71
72## 2、Flash 分区
73
74Flash 分区基于 Flash 设备，每个 Flash 设备又可以有 N 个分区，这些分区的集合就是分区表。在配置分区表前，务必保证已定义好 Flash 设备及设备表。
75
76分区表也定义在 `fal_cfg.h` 头文件中。参考 [示例文件 samples/porting/fal_cfg.h](samples/porting/fal_cfg.h) 或如下代码：
77
78```C
79#define NOR_FLASH_DEV_NAME "norflash0"
80/* ====================== Partition Configuration ========================== */
81#ifdef FAL_PART_HAS_TABLE_CFG
82/* partition table */
83#define FAL_PART_TABLE \
84{ \
85 {FAL_PART_MAGIC_WORD, "bl", "stm32_onchip", 0, 64*1024, 0}, \
86 {FAL_PART_MAGIC_WORD, "app", "stm32_onchip", 64*1024, 704*1024, 0}, \
87 {FAL_PART_MAGIC_WORD, "easyflash", NOR_FLASH_DEV_NAME, 0, 1024*1024, 0}, \
88 {FAL_PART_MAGIC_WORD, "download", NOR_FLASH_DEV_NAME, 1024*1024, 1024*1024, 0}, \
89}
90#endif /* FAL_PART_HAS_TABLE_CFG */
91```
92
93上面这个分区表详细描述信息如下：
94
95| 分区名 | Flash 设备名 | 偏移地址 | 大小 | 说明 |
96| :---------- | :------------- | :-------- | :---- | :----------------- |
97| "bl" | "stm32_onchip" | 0 | 64KB | 引导程序 |
98| "app" | "stm32_onchip" | 64*1024 | 704KB | 应用程序 |
99| "easyflash" | "norflash0" | 0 | 1MB | EasyFlash 参数存储 |
100| "download" | "norflash0" | 1024*1024 | 1MB | OTA 下载区 |
101
102用户需要修改的分区参数包括：分区名称、关联的 Flash 设备名、偏移地址（相对 Flash 设备内部）、大小，需要注意以下几点：
103
104- 分区名保证 **不能重复**
105- 关联的 Flash 设备 **务必已经在 Flash 设备表中定义好** ，并且 **名称一致** ，否则会出现无法找到 Flash 设备的错误
106- 分区的起始地址和大小 **不能超过 Flash 设备的地址范围** ，否则会导致包初始化错误
107
108> 注意：每个分区定义时，除了填写上面介绍的参数属性外，需在前面增加 `FAL_PART_MAGIC_WORD` 属性，末尾增加 `0` （目前用于保留功能）
109## 3、如何实现读写擦除等操作
110我们以fal_norflash_port.c为例，简单介绍一下。
111首先 介绍一下这两个宏定义
112```C
113#define FAL_ALIGN_UP( size, align ) \
114 ( ( ( size ) + ( align ) - 1 ) - ( ( ( size ) + ( align ) - 1 ) % ( align ) ) )
115#define FAL_ALIGN_DOWN( size, align ) ( ( ( size ) / ( align ) ) * ( align ) )
116```
117ALIGN_UP(16,4)=16 ALIGN_UP(15,4)=16 ALIGN_UP(17,4)=20
118ALIGN_DOWN(16,4)=16 ALIGN_DOWN(15,4)=12 ALIGN_DOWN(17,4)=16
119不难看出 ALIGN_UP是一个size向上取整到align的倍数，ALIGN_DOWN则是向下取整到align的倍数。
120然后 介绍FLASH的特性
121 FLASH都是按块擦除 norflash的块大小一般为4K 单片机内部FLASH的块大小为1K,2K,16K不等
122 同时有最少写入数据的限制
123norflash中 是按页写入 一次最少写256个字节数据 超过则覆盖起始数据 如第257个数据会覆盖第1个数据的位置
124单片机内部flash中 一次最少写2个字节数据(STM32F105RC) 且只能将地址2字节对齐写入 只写一个字节时 给后面的字节补成FF
125实现擦除
126```C
127static int32_t get_sector( uint32_t address );//获取当前属于第一个扇区
128extern void norflash_erase_sector( uint32_t saddr );//负责擦除单个扇区的全部数据
129//FLASH都是按块擦除 我们假定在调用擦除函数时 用户知道自己将会擦除扇区内的全部数据
130static int erase( long offset, size_t size )
131{
132 int32_t cur_erase_sector;
133 uint32_t addr = FLASH_START_ADDR + offset;
134 uint32_t addr_down = FAL_ALIGN_DOWN( addr, FLASH_SECTOR_SIZE );
135
136 uint32_t addr_end = addr + size;
137 uint32_t addr_end_up = FAL_ALIGN_UP( addr_end, FLASH_SECTOR_SIZE );
138 uint32_t cur_addr = addr_down;
139
140 while ( cur_addr < addr_end_up ) {
141 cur_erase_sector = get_sector( cur_addr );
142 if ( cur_erase_sector == -1 ) {//获取第几个扇区失败 说明地址超出范围
143 return cur_addr - addr;
144 }
145 norflash_erase_sector( cur_erase_sector );
146 cur_addr += FLASH_SECTOR_SIZE;//这里如果每个扇区的大小不同 需要实现从当前地址获取扇区实际大小的函数
147 }
148 return size;
149}
150```
151实现读取
152```c
153//这个比较简单 直接调用norflash_read即可
154static int read( long offset, uint8_t* buf, size_t size )
155{
156 norflash_read( buf, offset + FLASH_START_ADDR, size );
157 return size;
158}
159```
160最后 也是最关键的一步 实现写入
161```c
162/* 写入任意长数据到NOR Flash函数 */
163static int write( long offset, const uint8_t* buf, size_t size )
164{
165 // 计算实际物理地址（相对于Flash起始地址的偏移）
166 uint32_t addr = FLASH_START_ADDR + offset;
167 // 计算起始地址的扇区向上对齐地址（例如0x1007 -> 0x2000 当扇区大小4K）
168 uint32_t addr_up = FAL_ALIGN_UP( addr, FLASH_SECTOR_SIZE );
169 // 计算起始地址的扇区向下对齐地址（例如0x1007 -> 0x1000）
170 uint32_t addr_down = FAL_ALIGN_DOWN( addr, FLASH_SECTOR_SIZE );
171
172 // 计算写入结束地址
173 uint32_t addr_end = addr + size;
174 // 结束地址的扇区向上对齐地址
175 uint32_t addr_end_up = FAL_ALIGN_UP( addr_end, FLASH_SECTOR_SIZE );
176 // 结束地址的扇区向下对齐地址
177 uint32_t addr_end_down = FAL_ALIGN_DOWN( addr_end, FLASH_SECTOR_SIZE );
178 uint32_t cur_addr = addr_down; // 当前处理的扇区起始地址
179
180 uint32_t max_write_len = 0; // 单次最大可写入长度
181 uint32_t write_len = 0; // 实际写入长度
182
183 // 地址有效性检查：结束地址超过Flash范围 或 起始地址在Flash区域外
184 if ( addr_end_up > FLASH_END_ADDR || ( int )addr_end_down < FLASH_START_ADDR ) return -1;
185
186 // 分配扇区大小的缓冲区（用于处理部分写入时需要保存原始数据的情况）
187 uint8_t* read_sector_buf = FAL_MALLOC( FLASH_SECTOR_SIZE );
188 if ( read_sector_buf == RT_NULL ) {
189 return -2; // 内存分配失败
190 }
191
192 // 按扇区逐个处理（从起始扇区到结束扇区）
193 while ( cur_addr < addr_end_up ) {
194 /* 情况1：处理起始地址不在扇区边界的情况（首扇区部分写入） */
195 if ( cur_addr < addr ) {
196 // 读取整个扇区原始数据到缓冲区
197 read( cur_addr - FLASH_START_ADDR, read_sector_buf, FLASH_SECTOR_SIZE );
198
199 // 计算首扇区可写入的最大长度（从起始地址到扇区末尾）
200 max_write_len = ( addr_up - addr );
201 // 确定实际写入长度（不超过剩余数据大小）
202 write_len = size >= max_write_len ? max_write_len : size;
203
204 // 判断是否需要擦除（检查目标区域是否包含需要从0->1的位）
205 if ( judge_whether_erase( read_sector_buf + addr - cur_addr, write_len ) ){
206 // 需要擦除时：执行擦除->修改缓冲区->写入整个扇区
207 norflash_erase_sector( get_sector( cur_addr ) );
208 // 将新数据合并到缓冲区对应位置
209 FAL_MEMCPY( read_sector_buf + ( addr - cur_addr ), buf, write_len );
210 // 写入整个扇区
211 write_sector( cur_addr, read_sector_buf, FLASH_SECTOR_SIZE );
212 }
213 else {
214 // 无需擦除时直接写入数据（NOR Flash允许直接写入0位）
215 write_sector( addr, buf, write_len );
216 }
217 buf += write_len; // 移动数据指针
218 }
219 /* 情况2：处理结束地址不在扇区边界的情况（末扇区部分写入） */
220 else if ( cur_addr == addr_end_down ) {
221 // 读取整个扇区原始数据
222 read( cur_addr - FLASH_START_ADDR, read_sector_buf, FLASH_SECTOR_SIZE );
223
224 // 计算最大可写入长度（整个扇区）
225 max_write_len = FLASH_SECTOR_SIZE;
226 // 计算实际需要写入的长度（从扇区起始到结束地址）
227 write_len = addr_end - cur_addr;
228 write_len = write_len >= max_write_len ? max_write_len : write_len;
229
230 // 判断是否需要擦除
231 if ( judge_whether_erase( read_sector_buf, write_len ) ) {
232 // 需要擦除时：合并数据->擦除->写入整个扇区
233 FAL_MEMCPY( read_sector_buf, buf, write_len );
234 norflash_erase_sector( get_sector( cur_addr ) );
235 write_sector( cur_addr, read_sector_buf, FLASH_SECTOR_SIZE );
236 }
237 else {
238 // 直接写入数据
239 write_sector( cur_addr, buf, write_len );
240 }
241 }
242 /* 情况3：完整扇区写入（中间扇区） */
243 else {
244 // 直接擦除整个扇区（完整覆盖不需要保留数据）
245 norflash_erase_sector( get_sector( cur_addr ) );
246 // 写入整个扇区数据
247 write_sector( cur_addr, buf, FLASH_SECTOR_SIZE );
248 buf += FLASH_SECTOR_SIZE; // 移动数据指针
249 }
250 cur_addr += FLASH_SECTOR_SIZE; // 移动到下一个扇区
251 }
252 FAL_FREE( read_sector_buf ); // 释放缓冲区内存
253 return size; // 返回成功写入的字节数
254}
255```
256关键逻辑说明：
257地址对齐处理：通过向上/向下对齐计算确定实际需要操作的扇区范围
258三种写入场景：
259 首扇区部分写入：需要读取原始数据，合并新数据后判断擦除必要性
260 中间完整扇区：直接擦除后全量写入，提高效率
261 末扇区部分写入：处理方式类似首扇区，但数据位置不同
262擦除判断：通过judge_whether_erase函数检测是否需要执行擦除操作（基于NOR Flash的特性，只有需要将0变为1时才必须擦除）
263数据合并：使用临时缓冲区保存原始数据，仅修改需要写入的部分，最大限度减少擦除操作
264内存管理：动态分配扇区大小的缓冲区，处理完成后立即释放
265到这里 工作似乎做完了 但是 我们没有写入扇区的函数 只有页写入函数 norflash_write_page
266扇区写入逻辑和任意写入逻辑基本相同
267下面实现扇区写入函数
268```c
269/* 扇区写入函数：处理按页对齐的NOR Flash写入操作 */
270static int write_sector( long offset, const uint8_t* buf, size_t size )
271{
272 // 计算实际物理地址（FLASH起始地址 + 偏移量）
273 uint32_t addr = FLASH_START_ADDR + offset;
274
275 // 计算地址的页对齐上边界和下边界（按FLASH_PAGE_SIZE对齐）
276 uint32_t addr_up = FAL_ALIGN_UP( addr, FLASH_PAGE_SIZE );
277 uint32_t addr_down = FAL_ALIGN_DOWN( addr, FLASH_PAGE_SIZE );
278
279 // 计算写入结束地址及其页对齐边界
280 uint32_t addr_end = addr + size;
281 uint32_t addr_end_up = FAL_ALIGN_UP( addr_end, FLASH_PAGE_SIZE );
282 uint32_t addr_end_down = FAL_ALIGN_DOWN( addr_end, FLASH_PAGE_SIZE );
283
284 // 初始化当前处理地址和长度变量
285 uint32_t cur_addr = addr_down; // 从页对齐起始地址开始处理
286 uint32_t max_write_len = 0; // 单次最大可写入长度
287 uint32_t write_len = 0; // 实际写入长度
288
289 // 循环处理所有需要写入的页
290 while ( cur_addr < addr_end_up ) {
291 // 处理起始未对齐部分（跨页起始边界）
292 if ( cur_addr < addr ) {
293 // 计算当前页剩余可写空间（页结束地址 - 实际起始地址）
294 max_write_len = ( addr_up - addr );
295 // 取实际剩余长度和总长度的最小值
296 write_len = size >= max_write_len ? max_write_len : size;
297
298 // 执行页写入：参数依次是数据指针、物理地址、写入长度
299 norflash_write_page( buf, addr, write_len );
300 buf += write_len; // 移动数据指针
301 }
302 // 处理结束未对齐部分（跨页结束边界）
303 else if ( cur_addr == addr_end_down ) {
304 // 单页最大写入长度
305 max_write_len = FLASH_PAGE_SIZE;
306 // 计算实际需要写入的长度（结束地址 - 当前页起始地址）
307 write_len = addr_end - cur_addr;
308 // 确保不超过页最大长度
309 write_len = write_len >= max_write_len ? max_write_len : write_len;
310
311 // 执行页写入
312 norflash_write_page( buf, cur_addr, write_len );
313 }
314 // 处理完整页写入
315 else {
316 // 整页写入（FLASH_PAGE_SIZE长度）
317 norflash_write_page( buf, cur_addr, FLASH_PAGE_SIZE );
318 buf += FLASH_PAGE_SIZE; // 移动数据指针整页长度
319 }
320
321 // 移动到下一页起始地址
322 cur_addr += FLASH_PAGE_SIZE;
323 }
324 return size; // 返回成功写入的总字节数
325}
326```
327至此 我们就完成了Flash驱动的移植 实现了读写擦除等操作 上面的思路对于大部分flash驱动来说是通用的