【RT-Thread】使用FAL分区管理与easyflash变量管理

sunsili

【RT-Thread】使用FAL分区管理与easyflash变量管理

1. FAL组件

1.1 什么是FAL

FAL （Flash Abstraction Layer） Flash 抽象层，是对 Flash 及基于 Flash 的分区进行管理、操作的抽象层，对上层统一了 Flash 及 分区操作的 API （框架图如下所示），并具有以下特性：

• 支持静态可配置的分区表，并可关联多个 Flash 设备;
  
• 分区表支持 自动装载 。避免在多固件项目，分区表被多次定义的问题；
  
• 代码精简，对操作系统 无依赖 ，可运行于裸机平台，比如对资源有一定要求的 Bootloader;
  
• 统一的操作接口。保证了文件系统、OTA、NVM（例如：EasyFlash https://github.com/armink-rtt-pkgs/EasyFlash） 等对 Flash 有一定依赖的组件，底层 Flash 驱动的可重用性;
  
• 自带基于 Finsh/MSH 的测试命令，可以通过 Shell 按字节寻址的方式操作（读写擦） Flash 或分区，方便开发者进行调试、测试;
  
  

通过上图我们也可以清晰明了了，看到，FAL抽象层向下可以通过Flash硬件进行统一管理，当然也可以使用SFUD框架（串行Flash通用驱动库，这部分RT-Thread已完成官方框架的移植同时提供多个应用历程），而对上也可以使用如DFS、NVM提供的Flash硬件统一访问接口，方便用户更加直接方便对底层Flash硬件的访问操作。

注：非易失性存储器 （NVM）：在芯片电源关闭期间保存存储在其中的数据。因此，它被用于没有磁盘的便携式设备中的内存，以及用于可移动存储卡等用途。主要类型有：非易失性半导体存储器 （Non-volatile semiconductor memory， NVSM） 将数据存储在浮栅存储单元中，每个单元都由一个浮栅（floating-gate） MOSFET 组成。

关于存储，可以用一张图来解释：

来源：ROM、RAM、FLASH、NVM......一文搞定（https://blog.csdn.net/lianyunyouyou/article/details/118277207)

1.2使用ENV配置FAL

在RT-Thread v4.1.0之前，FAL是作为软件包形式对用户开放使用的，而v4.1.0之后，FAL被RT-Thread官方重新定义为RTT组件的一部分，这样也能更加方便用户的开发。

我们下面正式讲解FAL组件的使用：

首先打开ENV工具，根据以下路径打开FAL使能 RT-Thread Components->FAL： flash abstraction layer，由于我们后面会用到SFUD，所以这里把 FAL uses SFUD drivers 一并使能，并修改FAL设备名称为 W25Q128.

完成上述操作后保存退出，并使用 scons --target=mdk5 重新生成MDK5文件并打开

1.3 FAL SFUD 移植

为了提供示例，我们选用 W25Q128 spi flash 作为测试模块，并且使用SFUD框架对spi flash设备进行管理和驱动。

由于目前RT-Thread的SFUD已经对 W25Q128 完成支持，根据官方的使用手册，我们仅需编写 fal_cfg.h 文件完成对 FAL_FLASH_DEV_TABLE 及 FAL_PART_TABLE 的定义即可。文件存放路径：.\rt-thread\bsp\lpc55sxx\lpc55s69_nxp_evk\board\ports\fal_cfg.h

1. // fal.cfg.h
   
2. 
   
3. /*
   
4. * Copyright (c) 2006-2023, RT-Thread Development Team
   
5. *
   
6. * SPDX-License-Identifier: Apache-2.0
   
7. *
   
8. * Change Logs:
   
9. * Date           Author       Notes
   
10. * 2023-04-21     Wangyuqiang  the first version
    
11. */
    
12. #ifndef _FAL_CFG_H_
    
13. #define _FAL_CFG_H_
    
14. 
    
15. #include <rtthread.h>
    
16. #include <board.h>
    
17. 
    
18. #ifndef FAL_USING_NOR_FLASH_DEV_NAME
    
19. #define NOR_FLASH_DEV_NAME             "norflash0"
    
20. #else
    
21. #define NOR_FLASH_DEV_NAME              FAL_USING_NOR_FLASH_DEV_NAME
    
22. #endif
    
23. 
    
24. /* Flash device Configuration */
    
25. 
    
26. extern struct fal_flash_dev nor_flash0;
    
27. 
    
28. /* flash device table */
    
29. 
    
30. #define FAL_FLASH_DEV_TABLE                                          \
    
31. {                                                                    \
    
32.     &nor_flash0,                                                     \
    
33. }
    
34. 
    
35. /* Partition Configuration */
    
36. 
    
37. #ifdef FAL_PART_HAS_TABLE_CFG
    
38. 
    
39. /* partition table */
    
40. 
    
41. #define FAL_PART_TABLE                                                                                                  \
    
42. {                                                                                                                       \
    
43.     {FAL_PART_MAGIC_WROD,  "easyflash", NOR_FLASH_DEV_NAME,                                    0,       512 * 1024, 0}, \
    
44.     {FAL_PART_MAGIC_WROD,   "download", NOR_FLASH_DEV_NAME,                           512 * 1024,      1024 * 1024, 0}, \
    
45.     {FAL_PART_MAGIC_WROD, "wifi_image", NOR_FLASH_DEV_NAME,                  (512 + 1024) * 1024,       512 * 1024, 0}, \
    
46.     {FAL_PART_MAGIC_WROD,       "font", NOR_FLASH_DEV_NAME,            (512 + 1024 + 512) * 1024,  7 * 1024 * 1024, 0}, \
    
47.     {FAL_PART_MAGIC_WROD, "filesystem", NOR_FLASH_DEV_NAME, (512 + 1024 + 512 + 7 * 1024) * 1024,  7 * 1024 * 1024, 0}, \
    
48. }
    
49. #endif /* FAL_PART_HAS_TABLE_CFG */
    
50. 
    
51. #endif /* _FAL_CFG_H_ */

复制代码

此时编译的话是找不到该头文件的，需要我们在Keil中设置：

在RTT FAL组件中的SFUD提供的 fal_flash_dev 对象默认的nor_flash0参数中，flash大小默认为8M，而 W25Q128 最大最16M，我们可以选择在 .\rt-thread\components\fal\samples\porting\fal_flash_sfud_port.c文件中对struct fal_flash_dev nor_flash0 进行修改：

1. struct fal_flash_dev nor_flash0 =
   
2. {
   
3.     .name       = FAL_USING_NOR_FLASH_DEV_NAME,
   
4.     .addr       = 0,
   
5.     .len        = 16 * 1024 * 1024,
   
6.     .blk_size   = 4096,
   
7.     .ops        = {init, read, write, erase},
   
8.     .write_gran = 1
   
9. };

复制代码

当然也可以选择不进行修改，根据大佬的原话就是因为在调用初始化接口函数init后，会从flash设备读取正确的参数更新到nor_flash0表项中，我们在使用FAL组件前都需要调用FAL初始化函数fal_init，其内调用flash设备初始化函数fal_flash_init，最后会调用注册到fal_flash_dev设备表项中的初始化函数device_table->ops.init，所以nor_flash0表项参数会在FAL初始化时被更新。

同时我们需要开启SFUD框架支持，打开ENV工具，由于SFUD的使用需要指定一个spi设备，这里我选择使用最近移植好的软件spi，路径 Hardware Drivers Config->On-chip Peripheral Drivers-> Enable soft SPI BUS-> Enable soft SPI1 BUS (software simulation) ，这里我的测试开发板是恩智浦的LPC55S69-EVK，并且这款bsp的软件模拟spi由我本人对接，关于这部分的软件spi引脚定义可以选用默认即可，当然也可以使用自定义引脚，记住不要与其他引脚产生冲突。

此时我们回到ENV主界面，进入 RT-Thread Components->Device Drivers->Using Serial Flash Universal Driver ，此时我们才可以看到SFUD选项出现（如果没有使能spi是没法看到的），使能后保持默认即可

到这里，ENV的配置暂时告一段落！

1.4 FAL SFUD 测试用例

为了验证 W25Q128 及软件模拟spi在SFUD框架上是否能够成功运行，我们在 .\rt-thread\bsp\lpc55sxx\lpc55s69_nxp_evk\board\ports\ 下新建一个 soft_spi_flash_init.c 文件，代码如下

1. /*
   
2. * Copyright (c) 2006-2023, RT-Thread Development Team
   
3. *
   
4. * SPDX-License-Identifier: Apache-2.0
   
5. *
   
6. * Change Logs:
   
7. * Date           Author       Notes
   
8. * 2023-04-21     Wangyuqiang  the first version
   
9. */
   
10. 
    
11. #include <rtthread.h>
    
12. #include "spi_flash.h"
    
13. #include "spi_flash_sfud.h"
    
14. #include "drv_soft_spi.h"
    
15. #include "drv_pin.h"
    
16. #include "rtconfig.h"
    
17. 
    
18. #define cs_pin  GET_PINS(1,9)
    
19. 
    
20. static int rt_soft_spi_flash_init(void)
    
21. {
    
22.   int result = -1;
    
23. 
    
24.     result = rt_hw_softspi_device_attach("sspi1", "sspi10", cs_pin);
    
25.   rt_kprintf("value is %d\n",result);
    
26.   
    
27.   if(result == RT_EOK)
    
28.   {
    
29.     rt_kprintf("rt_hw_softspi_device_attach successful!\n");
    
30.   }
    
31. 
    
32.     if (RT_NULL == rt_sfud_flash_probe("W25Q128", "sspi10"))
    
33.     {
    
34.         return -RT_ERROR;
    
35.     }
    
36. 
    
37.     return RT_EOK;
    
38. }
    
39. INIT_COMPONENT_EXPORT(rt_soft_spi_flash_init);

复制代码

这里我们需要指定一个片选引脚，我暂时使用了 sspi2 的SCK引脚作为片选，这里注意不要同时打开 sspi1 和 sspi2 ，后续我会专门上传一个通用GPIO作为片选引脚，到时候就不会产生问题了。然后软件spi设备的挂载使用的是 sspi1 bus 及 sspi10 device ，并且挂载flash设备到 sspi10 。

另外我们在 .\rt-thread\bsp\lpc55sxx\lpc55s69_nxp_evk\board\ports\ 下新建 fal_sample.c 文件，并编写测试代码：

1. //fal_sample.c
   
2. 
   
3. /*
   
4. * Copyright (c) 2006-2023, RT-Thread Development Team
   
5. *
   
6. * SPDX-License-Identifier: Apache-2.0
   
7. *
   
8. * Change Logs:
   
9. * Date           Author       Notes
   
10. * 2023-04-21     Wangyuqiang  the first version
    
11. */
    
12. #include "rtthread.h"
    
13. #include "rtdevice.h"
    
14. #include "board.h"
    
15. #include "fal.h"
    
16. 
    
17. #define BUF_SIZE 1024
    
18. 
    
19. static int fal_test(const char *partiton_name)
    
20. {
    
21.     int ret;
    
22.     int i, j, len;
    
23.     uint8_t buf[BUF_SIZE];
    
24.     const struct fal_flash_dev *flash_dev = RT_NULL;
    
25.     const struct fal_partition *partition = RT_NULL;
    
26. 
    
27.     if (!partiton_name)
    
28.     {
    
29.         rt_kprintf("Input param partition name is null!\n");
    
30.         return -1;
    
31.     }
    
32. 
    
33.     partition = fal_partition_find(partiton_name);
    
34.     if (partition == RT_NULL)
    
35.     {
    
36.         rt_kprintf("Find partition (%s) failed!\n", partiton_name);
    
37.         ret = -1;
    
38.         return ret;
    
39.     }
    
40. 
    
41.     flash_dev = fal_flash_device_find(partition->flash_name);
    
42.     if (flash_dev == RT_NULL)
    
43.     {
    
44.         rt_kprintf("Find flash device (%s) failed!\n", partition->flash_name);
    
45.         ret = -1;
    
46.         return ret;
    
47.     }
    
48. 
    
49.     rt_kprintf("Flash device : %s   "
    
50.                "Flash size : %dK   \n"
    
51.                "Partition : %s   "
    
52.                "Partition size: %dK\n",
    
53.                 partition->flash_name,
    
54.                 flash_dev->len/1024,
    
55.                 partition->name,
    
56.                 partition->len/1024);
    
57. 
    
58.     /* erase all partition */
    
59.     ret = fal_partition_erase_all(partition);
    
60.     if (ret < 0)
    
61.     {
    
62.         rt_kprintf("Partition (%s) erase failed!\n", partition->name);
    
63.         ret = -1;
    
64.         return ret;
    
65.     }
    
66.     rt_kprintf("Erase (%s) partition finish!\n", partiton_name);
    
67. 
    
68.     /* read the specified partition and check data */
    
69.     for (i = 0; i < partition->len;)
    
70.     {
    
71.         rt_memset(buf, 0x00, BUF_SIZE);
    
72. 
    
73.         len = (partition->len - i) > BUF_SIZE ? BUF_SIZE : (partition->len - i);
    
74. 
    
75.         ret = fal_partition_read(partition, i, buf, len);
    
76.         if (ret < 0)
    
77.         {
    
78.             rt_kprintf("Partition (%s) read failed!\n", partition->name);
    
79.             ret = -1;
    
80.             return ret;
    
81.         }
    
82. 
    
83.         for(j = 0; j < len; j++)
    
84.         {
    
85.             if (buf[j] != 0xFF)
    
86.             {
    
87.                 rt_kprintf("The erase operation did not really succeed!\n");
    
88.                 ret = -1;
    
89.                 return ret;
    
90.             }
    
91.         }
    
92.         i += len;
    
93.     }
    
94. 
    
95.     /* write 0x00 to the specified partition */
    
96.     for (i = 0; i < partition->len;)
    
97.     {
    
98.         rt_memset(buf, 0x00, BUF_SIZE);
    
99. 
    
100.         len = (partition->len - i) > BUF_SIZE ? BUF_SIZE : (partition->len - i);
     
101. 
     
102.         ret = fal_partition_write(partition, i, buf, len);
     
103.         if (ret < 0)
     
104.         {
     
105.             rt_kprintf("Partition (%s) write failed!\n", partition->name);
     
106.             ret = -1;
     
107.             return ret;
     
108.         }
     
109. 
     
110.         i += len;
     
111.     }
     
112.     rt_kprintf("Write (%s) partition finish! Write size %d(%dK).\n", partiton_name, i, i/1024);
     
113. 
     
114.     /* read the specified partition and check data */
     
115.     for (i = 0; i < partition->len;)
     
116.     {
     
117.         rt_memset(buf, 0xFF, BUF_SIZE);
     
118. 
     
119.         len = (partition->len - i) > BUF_SIZE ? BUF_SIZE : (partition->len - i);
     
120. 
     
121.         ret = fal_partition_read(partition, i, buf, len);
     
122.         if (ret < 0)
     
123.         {
     
124.             rt_kprintf("Partition (%s) read failed!\n", partition->name);
     
125.             ret = -1;
     
126.             return ret;
     
127.         }
     
128. 
     
129.         for(j = 0; j < len; j++)
     
130.         {
     
131.             if (buf[j] != 0x00)
     
132.             {
     
133.                 rt_kprintf("The write operation did not really succeed!\n");
     
134.                 ret = -1;
     
135.                 return ret;
     
136.             }
     
137.         }
     
138. 
     
139.         i += len;
     
140.     }
     
141. 
     
142.     ret = 0;
     
143.     return ret;
     
144. }
     
145. 
     
146. static void fal_sample(void)
     
147. {
     
148.     /* 1- init */
     
149.     fal_init();
     
150. 
     
151.     if (fal_test("font") == 0)
     
152.     {
     
153.         rt_kprintf("Fal partition (%s) test success!\n", "font");
     
154.     }
     
155.     else
     
156.     {
     
157.         rt_kprintf("Fal partition (%s) test failed!\n", "font");
     
158.     }
     
159. 
     
160.     if (fal_test("download") == 0)
     
161.     {
     
162.         rt_kprintf("Fal partition (%s) test success!\n", "download");
     
163.     }
     
164.     else
     
165.     {
     
166.         rt_kprintf("Fal partition (%s) test failed!\n", "download");
     
167.     }
     
168. }
     
169. MSH_CMD_EXPORT(fal_sample, fal sample);

复制代码

1.5

测试结果

到这里就可以进行编译下载了，成功后的截图如下：

2.

DFS文件系统

2.1

什么是DFS

DFS 是 RT-Thread 提供的虚拟文件系统组件，全称为 Device File System，即设备虚拟文件系统，文件系统的名称使用类似 UNIX 文件、文件夹的风格，目录结构如下图所示：

在 RT-Thread DFS 中，文件系统有统一的根目录，使用 / 来表示。而在根目录下的 f1.bin 文件则使用 /f1.bin 来表示，2018 目录下的 f1.bin 目录则使用 /data/2018/f1.bin 来表示。即目录的分割符号是 /，这与 UNIX/Linux 完全相同，与 Windows 则不相同（Windows 操作系统上使用 \ 来作为目录的分割符）。

2.2

DFS架构

RT-Thread DFS 组件的主要功能特点有：

• 为应用程序提供统一的 POSIX 文件和目录操作接口：read、write、poll/select 等。
• 支持多种类型的文件系统，如 FatFS、RomFS、DevFS 等，并提供普通文件、设备文件、网络文件描述符的管理。
• 支持多种类型的存储设备，如 SD Card、SPI Flash、Nand Flash 等。
  
  

DFS 的层次架构如下图所示，主要分为 POSIX 接口层、虚拟文件系统层和设备抽象层。

2.3

使用ENV配置DFS

打开ENV，进入路径 RT-Thread Components → DFS: device virtual file system ，使能 DFS: device virtual file system

由于DFS使用的是POSIX接口，而dfs_posix.h已经在新版本中被移除了，如果想要兼容老版本，可以在menuconfig中使能 RT-Thread Components-> Support legacy version for compatibility

由于elmfat文件系统默认最大扇区大小为512，但我们使用的flash模块 W25Q128 的Flash扇区大小为4096，为了将elmfat文件系统挂载到W25Q128上，这里的 Maximum sector size 需要和W25Q128扇区大小保持一致，修改为4096，路径：RT-Thread Components → DFS: device virtual file system → Enable elm-chan fatfs / elm-chan's FatFs, Generic FAT Filesystem Module

保存退出后使用 scons --target=mdk5 生成MDK5工程。

2.4 DFS挂载到FAL分区测试

这里增加FAL flash抽象层，我们将elmfat文件系统挂载到W25Q128 flash设备的filesystem分区上，由于FAL管理的filesystem分区不是块设备，需要先使用FAL分区转BLK设备接口函数将filesystem分区转换为块设备，然后再将DFS elmfat文件系统挂载到filesystem块设备上。

我们接着修改fal_sample.c文件，修改后代码：

1. /*
   
2. * Copyright (c) 2006-2023, RT-Thread Development Team
   
3. *
   
4. * SPDX-License-Identifier: Apache-2.0
   
5. *
   
6. * Change Logs:
   
7. * Date           Author       Notes
   
8. * 2023-04-21     Wangyuqiang  the first version
   
9. */
   
10. #include "rtthread.h"
    
11. #include "rtdevice.h"
    
12. #include "board.h"
    
13. #include "fal.h"
    
14. 
    
15. #include <dfs_posix.h>
    
16. 
    
17. #define FS_PARTITION_NAME  "filesystem"
    
18. 
    
19. #define BUF_SIZE 1024
    
20. 
    
21. static int fal_test(const char *partiton_name)
    
22. {
    
23.     int ret;
    
24.     int i, j, len;
    
25.     uint8_t buf[BUF_SIZE];
    
26.     const struct fal_flash_dev *flash_dev = RT_NULL;
    
27.     const struct fal_partition *partition = RT_NULL;
    
28. 
    
29.     if (!partiton_name)
    
30.     {
    
31.         rt_kprintf("Input param partition name is null!\n");
    
32.         return -1;
    
33.     }
    
34. 
    
35.     partition = fal_partition_find(partiton_name);
    
36.     if (partition == RT_NULL)
    
37.     {
    
38.         rt_kprintf("Find partition (%s) failed!\n", partiton_name);
    
39.         ret = -1;
    
40.         return ret;
    
41.     }
    
42. 
    
43.     flash_dev = fal_flash_device_find(partition->flash_name);
    
44.     if (flash_dev == RT_NULL)
    
45.     {
    
46.         rt_kprintf("Find flash device (%s) failed!\n", partition->flash_name);
    
47.         ret = -1;
    
48.         return ret;
    
49.     }
    
50. 
    
51.     rt_kprintf("Flash device : %s   "
    
52.                "Flash size : %dK   \n"
    
53.                "Partition : %s   "
    
54.                "Partition size: %dK\n",
    
55.                 partition->flash_name,
    
56.                 flash_dev->len/1024,
    
57.                 partition->name,
    
58.                 partition->len/1024);
    
59. 
    
60.     /* erase all partition */
    
61.     ret = fal_partition_erase_all(partition);
    
62.     if (ret < 0)
    
63.     {
    
64.         rt_kprintf("Partition (%s) erase failed!\n", partition->name);
    
65.         ret = -1;
    
66.         return ret;
    
67.     }
    
68.     rt_kprintf("Erase (%s) partition finish!\n", partiton_name);
    
69. 
    
70.     /* read the specified partition and check data */
    
71.     for (i = 0; i < partition->len;)
    
72.     {
    
73.         rt_memset(buf, 0x00, BUF_SIZE);
    
74. 
    
75.         len = (partition->len - i) > BUF_SIZE ? BUF_SIZE : (partition->len - i);
    
76. 
    
77.         ret = fal_partition_read(partition, i, buf, len);
    
78.         if (ret < 0)
    
79.         {
    
80.             rt_kprintf("Partition (%s) read failed!\n", partition->name);
    
81.             ret = -1;
    
82.             return ret;
    
83.         }
    
84. 
    
85.         for(j = 0; j < len; j++)
    
86.         {
    
87.             if (buf[j] != 0xFF)
    
88.             {
    
89.                 rt_kprintf("The erase operation did not really succeed!\n");
    
90.                 ret = -1;
    
91.                 return ret;
    
92.             }
    
93.         }
    
94.         i += len;
    
95.     }
    
96. 
    
97.     /* write 0x00 to the specified partition */
    
98.     for (i = 0; i < partition->len;)
    
99.     {
    
100.         rt_memset(buf, 0x00, BUF_SIZE);
     
101. 
     
102.         len = (partition->len - i) > BUF_SIZE ? BUF_SIZE : (partition->len - i);
     
103. 
     
104.         ret = fal_partition_write(partition, i, buf, len);
     
105.         if (ret < 0)
     
106.         {
     
107.             rt_kprintf("Partition (%s) write failed!\n", partition->name);
     
108.             ret = -1;
     
109.             return ret;
     
110.         }
     
111. 
     
112.         i += len;
     
113.     }
     
114.     rt_kprintf("Write (%s) partition finish! Write size %d(%dK).\n", partiton_name, i, i/1024);
     
115. 
     
116.     /* read the specified partition and check data */
     
117.     for (i = 0; i < partition->len;)
     
118.     {
     
119.         rt_memset(buf, 0xFF, BUF_SIZE);
     
120. 
     
121.         len = (partition->len - i) > BUF_SIZE ? BUF_SIZE : (partition->len - i);
     
122. 
     
123.         ret = fal_partition_read(partition, i, buf, len);
     
124.         if (ret < 0)
     
125.         {
     
126.             rt_kprintf("Partition (%s) read failed!\n", partition->name);
     
127.             ret = -1;
     
128.             return ret;
     
129.         }
     
130. 
     
131.         for(j = 0; j < len; j++)
     
132.         {
     
133.             if (buf[j] != 0x00)
     
134.             {
     
135.                 rt_kprintf("The write operation did not really succeed!\n");
     
136.                 ret = -1;
     
137.                 return ret;
     
138.             }
     
139.         }
     
140. 
     
141.         i += len;
     
142.     }
     
143. 
     
144.     ret = 0;
     
145.     return ret;
     
146. }
     
147. 
     
148. static void fal_sample(void)
     
149. {
     
150.     /* 1- init */
     
151.     fal_init();
     
152. 
     
153.     if (fal_test("font") == 0)
     
154.     {
     
155.         rt_kprintf("Fal partition (%s) test success!\n", "font");
     
156.     }
     
157.     else
     
158.     {
     
159.         rt_kprintf("Fal partition (%s) test failed!\n", "font");
     
160.     }
     
161. 
     
162.     if (fal_test("download") == 0)
     
163.     {
     
164.         rt_kprintf("Fal partition (%s) test success!\n", "download");
     
165.     }
     
166.     else
     
167.     {
     
168.         rt_kprintf("Fal partition (%s) test failed!\n", "download");
     
169.     }
     
170. }
     
171. MSH_CMD_EXPORT(fal_sample, fal sample);
     
172. 
     
173. static void fal_elmfat_sample(void)
     
174. {
     
175.     int fd, size;
     
176.     struct statfs elm_stat;
     
177.     struct fal_blk_device *blk_dev;
     
178.     char str[] = "elmfat mount to W25Q flash.", buf[80];
     
179. 
     
180.     /* fal init */
     
181.     fal_init();
     
182. 
     
183.     /* create block device */
     
184.     blk_dev = (struct fal_blk_device *)fal_blk_device_create(FS_PARTITION_NAME);
     
185.     if(blk_dev == RT_NULL)
     
186.         rt_kprintf("Can't create a block device on '%s' partition.\n", FS_PARTITION_NAME);
     
187.     else
     
188.         rt_kprintf("Create a block device on the %s partition of flash successful.\n", FS_PARTITION_NAME);
     
189. 
     
190.     /* make a elmfat format filesystem */
     
191.     if(dfs_mkfs("elm", FS_PARTITION_NAME) == 0)
     
192.         rt_kprintf("make elmfat filesystem success.\n");
     
193. 
     
194.     /* mount elmfat file system to FS_PARTITION_NAME */
     
195.     if(dfs_mount(FS_PARTITION_NAME, "/", "elm", 0, 0) == 0)
     
196.         rt_kprintf("elmfat filesystem mount success.\n");
     
197. 
     
198.     /* Get elmfat file system statistics */
     
199.     if(statfs("/", &elm_stat) == 0)
     
200.         rt_kprintf("elmfat filesystem block size: %d, total blocks: %d, free blocks: %d.\n",
     
201.                     elm_stat.f_bsize, elm_stat.f_blocks, elm_stat.f_bfree);
     
202. 
     
203.     if(mkdir("/user", 0x777) == 0)
     
204.         rt_kprintf("make a directory: '/user'.\n");
     
205. 
     
206.     rt_kprintf("Write string '%s' to /user/test.txt.\n", str);
     
207. 
     
208.     /* Open the file in create and read-write mode, create the file if it does not exist*/
     
209.     fd = open("/user/test.txt", O_WRONLY | O_CREAT);
     
210.     if (fd >= 0)
     
211.     {
     
212.         if(write(fd, str, sizeof(str)) == sizeof(str))
     
213.             rt_kprintf("Write data done.\n");
     
214. 
     
215.         close(fd);   
     
216.     }
     
217. 
     
218.     /* Open file in read-only mode */
     
219.     fd = open("/user/test.txt", O_RDONLY);
     
220.     if (fd >= 0)
     
221.     {
     
222.         size = read(fd, buf, sizeof(buf));
     
223. 
     
224.         close(fd);
     
225. 
     
226.         if(size == sizeof(str))
     
227.             rt_kprintf("Read data from file test.txt(size: %d): %s \n", size, buf);
     
228.     }
     
229. }
     
230. MSH_CMD_EXPORT_ALIAS(fal_elmfat_sample, fal_elmfat,fal elmfat sample);

复制代码

2.5 测试结果

测试结果如下：

3. Easyflash移植到FAL分区

3.1 简述EasyFlash

关于EasyFlash的来源我们已经讲过了，此处不再赘述。EasyFlash(https://gitee.com/link?target=ht ... Farmink%2FEasyFlash)是一款开源的轻量级嵌入式Flash存储器库，方便开发者更加轻松的实现基于Flash存储器的常见应用开发。非常适合智能家居、可穿戴、工控、医疗、物联网等需要断电存储功能的产品，资源占用极低，支持各种 MCU 片上存储器。

EasyFlash不仅能够实现对产品的 设定参数 或 运行日志 等信息的掉电保存功能，还封装了简洁的 增加、删除、修改及查询 方法， 降低了开发者对产品参数的处理难度，也保证了产品在后期升级时拥有更好的扩展性。让Flash变为NoSQL（非关系型数据库）模型的小型键值（Key-Value）存储数据库。

3.2 EasyFlash软件包使用

打开ENV进入路径：RT-Thread online packages → tools packages → EasyFlash: Lightweight embedded flash memory library. ，选择软件包版本为最新版。

配置后退出ENV，同时使用 pkgs --update 下载软件包，然后再使用 scons --target=mdk5 重新生成MDK5文件

3.3 移植easyflash

下载完easyflash软件包后，我们复制 .\rt-thread\bsp\lpc55sxx\lpc55s69_nxp_evk\packages\EasyFlash-latest\ports\ef_fal_port.c 到目录 .\rt-thread\bsp\lpc55sxx\lpc55s69_nxp_evk\board\ports\easyflash\ef_fal_port.c ，双击打开该文件，完成以下修改：

1. // 修改 FAL_EF_PART_NAME 为 easyflash
   
2. #define FAL_EF_PART_NAME               "easyflash"
   
3. // 修改环境变量内容为 {"boot_times", "0"}，这里我们先只设置一个开机次数
   
4. static const ef_env default_env_set[] = {
   
5.         {"boot_times", "0"},
   
6. };

复制代码

3.4 编写Easyflash测试用例

1. /*
   
2. * Copyright (c) 2006-2023, RT-Thread Development Team
   
3. *
   
4. * SPDX-License-Identifier: Apache-2.0
   
5. *
   
6. * Change Logs:
   
7. * Date           Author       Notes
   
8. * 2023-04-21     Wangyuqiang  the first version
   
9. */
   
10. #include "rtthread.h"
    
11. #include "rtdevice.h"
    
12. #include "board.h"
    
13. #include "fal.h"
    
14. 
    
15. #include <dfs_posix.h>
    
16. 
    
17. #include "easyflash.h"
    
18. #include <stdlib.h>
    
19. 
    
20. #define FS_PARTITION_NAME  "filesystem"
    
21. 
    
22. #define BUF_SIZE 1024
    
23. 
    
24. static int fal_test(const char *partiton_name)
    
25. {
    
26.     int ret;
    
27.     int i, j, len;
    
28.     uint8_t buf[BUF_SIZE];
    
29.     const struct fal_flash_dev *flash_dev = RT_NULL;
    
30.     const struct fal_partition *partition = RT_NULL;
    
31. 
    
32.     if (!partiton_name)
    
33.     {
    
34.         rt_kprintf("Input param partition name is null!\n");
    
35.         return -1;
    
36.     }
    
37. 
    
38.     partition = fal_partition_find(partiton_name);
    
39.     if (partition == RT_NULL)
    
40.     {
    
41.         rt_kprintf("Find partition (%s) failed!\n", partiton_name);
    
42.         ret = -1;
    
43.         return ret;
    
44.     }
    
45. 
    
46.     flash_dev = fal_flash_device_find(partition->flash_name);
    
47.     if (flash_dev == RT_NULL)
    
48.     {
    
49.         rt_kprintf("Find flash device (%s) failed!\n", partition->flash_name);
    
50.         ret = -1;
    
51.         return ret;
    
52.     }
    
53. 
    
54.     rt_kprintf("Flash device : %s   "
    
55.                "Flash size : %dK   \n"
    
56.                "Partition : %s   "
    
57.                "Partition size: %dK\n",
    
58.                 partition->flash_name,
    
59.                 flash_dev->len/1024,
    
60.                 partition->name,
    
61.                 partition->len/1024);
    
62. 
    
63.     /* erase all partition */
    
64.     ret = fal_partition_erase_all(partition);
    
65.     if (ret < 0)
    
66.     {
    
67.         rt_kprintf("Partition (%s) erase failed!\n", partition->name);
    
68.         ret = -1;
    
69.         return ret;
    
70.     }
    
71.     rt_kprintf("Erase (%s) partition finish!\n", partiton_name);
    
72. 
    
73.     /* read the specified partition and check data */
    
74.     for (i = 0; i < partition->len;)
    
75.     {
    
76.         rt_memset(buf, 0x00, BUF_SIZE);
    
77. 
    
78.         len = (partition->len - i) > BUF_SIZE ? BUF_SIZE : (partition->len - i);
    
79. 
    
80.         ret = fal_partition_read(partition, i, buf, len);
    
81.         if (ret < 0)
    
82.         {
    
83.             rt_kprintf("Partition (%s) read failed!\n", partition->name);
    
84.             ret = -1;
    
85.             return ret;
    
86.         }
    
87. 
    
88.         for(j = 0; j < len; j++)
    
89.         {
    
90.             if (buf[j] != 0xFF)
    
91.             {
    
92.                 rt_kprintf("The erase operation did not really succeed!\n");
    
93.                 ret = -1;
    
94.                 return ret;
    
95.             }
    
96.         }
    
97.         i += len;
    
98.     }
    
99. 
    
100.     /* write 0x00 to the specified partition */
     
101.     for (i = 0; i < partition->len;)
     
102.     {
     
103.         rt_memset(buf, 0x00, BUF_SIZE);
     
104. 
     
105.         len = (partition->len - i) > BUF_SIZE ? BUF_SIZE : (partition->len - i);
     
106. 
     
107.         ret = fal_partition_write(partition, i, buf, len);
     
108.         if (ret < 0)
     
109.         {
     
110.             rt_kprintf("Partition (%s) write failed!\n", partition->name);
     
111.             ret = -1;
     
112.             return ret;
     
113.         }
     
114. 
     
115.         i += len;
     
116.     }
     
117.     rt_kprintf("Write (%s) partition finish! Write size %d(%dK).\n", partiton_name, i, i/1024);
     
118. 
     
119.     /* read the specified partition and check data */
     
120.     for (i = 0; i < partition->len;)
     
121.     {
     
122.         rt_memset(buf, 0xFF, BUF_SIZE);
     
123. 
     
124.         len = (partition->len - i) > BUF_SIZE ? BUF_SIZE : (partition->len - i);
     
125. 
     
126.         ret = fal_partition_read(partition, i, buf, len);
     
127.         if (ret < 0)
     
128.         {
     
129.             rt_kprintf("Partition (%s) read failed!\n", partition->name);
     
130.             ret = -1;
     
131.             return ret;
     
132.         }
     
133. 
     
134.         for(j = 0; j < len; j++)
     
135.         {
     
136.             if (buf[j] != 0x00)
     
137.             {
     
138.                 rt_kprintf("The write operation did not really succeed!\n");
     
139.                 ret = -1;
     
140.                 return ret;
     
141.             }
     
142.         }
     
143. 
     
144.         i += len;
     
145.     }
     
146. 
     
147.     ret = 0;
     
148.     return ret;
     
149. }
     
150. 
     
151. static void fal_sample(void)
     
152. {
     
153.     /* 1- init */
     
154.     fal_init();
     
155. 
     
156.     if (fal_test("font") == 0)
     
157.     {
     
158.         rt_kprintf("Fal partition (%s) test success!\n", "font");
     
159.     }
     
160.     else
     
161.     {
     
162.         rt_kprintf("Fal partition (%s) test failed!\n", "font");
     
163.     }
     
164. 
     
165.     if (fal_test("download") == 0)
     
166.     {
     
167.         rt_kprintf("Fal partition (%s) test success!\n", "download");
     
168.     }
     
169.     else
     
170.     {
     
171.         rt_kprintf("Fal partition (%s) test failed!\n", "download");
     
172.     }
     
173. }
     
174. MSH_CMD_EXPORT(fal_sample, fal sample);
     
175. 
     
176. static void fal_elmfat_sample(void)
     
177. {
     
178.     int fd, size;
     
179.     struct statfs elm_stat;
     
180.     struct fal_blk_device *blk_dev;
     
181.     char str[] = "elmfat mount to W25Q flash.", buf[80];
     
182. 
     
183.     /* fal init */
     
184.     fal_init();
     
185. 
     
186.     /* create block device */
     
187.     blk_dev = (struct fal_blk_device *)fal_blk_device_create(FS_PARTITION_NAME);
     
188.     if(blk_dev == RT_NULL)
     
189.         rt_kprintf("Can't create a block device on '%s' partition.\n", FS_PARTITION_NAME);
     
190.     else
     
191.         rt_kprintf("Create a block device on the %s partition of flash successful.\n", FS_PARTITION_NAME);
     
192. 
     
193.     /* make a elmfat format filesystem */
     
194.     if(dfs_mkfs("elm", FS_PARTITION_NAME) == 0)
     
195.         rt_kprintf("make elmfat filesystem success.\n");
     
196. 
     
197.     /* mount elmfat file system to FS_PARTITION_NAME */
     
198.     if(dfs_mount(FS_PARTITION_NAME, "/", "elm", 0, 0) == 0)
     
199.         rt_kprintf("elmfat filesystem mount success.\n");
     
200. 
     
201.     /* Get elmfat file system statistics */
     
202.     if(statfs("/", &elm_stat) == 0)
     
203.         rt_kprintf("elmfat filesystem block size: %d, total blocks: %d, free blocks: %d.\n",
     
204.                     elm_stat.f_bsize, elm_stat.f_blocks, elm_stat.f_bfree);
     
205. 
     
206.     if(mkdir("/user", 0x777) == 0)
     
207.         rt_kprintf("make a directory: '/user'.\n");
     
208. 
     
209.     rt_kprintf("Write string '%s' to /user/test.txt.\n", str);
     
210. 
     
211.     /* Open the file in create and read-write mode, create the file if it does not exist*/
     
212.     fd = open("/user/test.txt", O_WRONLY | O_CREAT);
     
213.     if (fd >= 0)
     
214.     {
     
215.         if(write(fd, str, sizeof(str)) == sizeof(str))
     
216.             rt_kprintf("Write data done.\n");
     
217. 
     
218.         close(fd);   
     
219.     }
     
220. 
     
221.     /* Open file in read-only mode */
     
222.     fd = open("/user/test.txt", O_RDONLY);
     
223.     if (fd >= 0)
     
224.     {
     
225.         size = read(fd, buf, sizeof(buf));
     
226. 
     
227.         close(fd);
     
228. 
     
229.         if(size == sizeof(str))
     
230.             rt_kprintf("Read data from file test.txt(size: %d): %s \n", size, buf);
     
231.     }
     
232. }
     
233. MSH_CMD_EXPORT_ALIAS(fal_elmfat_sample, fal_elmfat,fal elmfat sample);
     
234. 
     
235. static void easyflash_sample(void)
     
236. {
     
237.     /* fal init */
     
238.     fal_init();
     
239. 
     
240.     /* easyflash init */
     
241.     if(easyflash_init() == EF_NO_ERR)
     
242.     {
     
243.         uint32_t i_boot_times = NULL;
     
244.         char *c_old_boot_times, c_new_boot_times[11] = {0};
     
245. 
     
246.         /* get the boot count number from Env */
     
247.         c_old_boot_times = ef_get_env("boot_times");
     
248.         /* get the boot count number failed */
     
249.         if (c_old_boot_times == RT_NULL)
     
250.             c_old_boot_times[0] = '0';
     
251. 
     
252.         i_boot_times = atol(c_old_boot_times);
     
253.         /* boot count +1 */
     
254.         i_boot_times ++;
     
255.         rt_kprintf("===============================================\n");
     
256.         rt_kprintf("The system now boot %d times\n", i_boot_times);
     
257.         rt_kprintf("===============================================\n");
     
258.         /* interger to string */
     
259.         sprintf(c_new_boot_times, "%d", i_boot_times);
     
260.         /* set and store the boot count number to Env */
     
261.         ef_set_env("boot_times", c_new_boot_times);
     
262.         ef_save_env();
     
263.     }
     
264. }
     
265. MSH_CMD_EXPORT(easyflash_sample, easyflash sample);

复制代码

3.5 测试结果

打开串口助手，输入命令：

1. msh />easyflash_sample

复制代码

第一次命令调用：

第二次RESET开发板后调用：