輕量級嵌入式資料庫FlashDB的介紹與使用

一、FlashDB的介紹
FlashDB 是一款超輕量級的嵌入式資料庫，專注于提供嵌入式產品的資料存盤方案，與傳統的基于檔案系統的資料庫不同，FlashDB 結合了 Flash 的特性，具有較強的性能及可靠性，并在保證極低的資源占用前提下，盡可能延長 Flash 使用壽命， FlashDB 提供兩種資料庫模式： 鍵值資料庫 和 時序資料庫，
二、移植
定義 flash 設備
在定義 Flash 設備表前，需要先定義 Flash 設備，可以是片內 flash, 也可以是片外基于 SFUD 的 spi flash：
定義片內 flash 設備可以參考 fal_flash_stm32f2_port.c ，
定義片外 spi flash 設備可以參考 fal_flash_sfud_port.c ，
定義具體的 Flash 設備物件，用戶需要根據自己的 Flash 情況分別實作 init、 read、 write、 erase 這些操作函式：
static int init(void)：可選 的初始化操作，
static int read(long offset, uint8_t *buf, size_t size)：讀取操作，
offset 讀取資料的 Flash 偏移地址
buf 存放待讀取資料的緩沖區
size 待讀取資料的大小
return 回傳實際讀取的資料大小
static int write(long offset, const uint8_t *buf, size_t size) ：寫入操作，
offset 寫入資料的 Flash 偏移地址
buf 存放待寫入資料的緩沖區
size 待寫入資料的大小
return 回傳實際寫入的資料大小
static int erase(long offset, size_t size) ：擦除操作
offset 擦除區域的 Flash 偏移地址
size 擦除區域的大小
return 回傳實際擦除的區域大小
用戶需要根據自己的 Flash 情況分別實作這些操作函式，在檔案最底部定義了具體的 Flash 設備物件 ，如下示例定義了 stm32f2 片上 flash：stm32f2_onchip_flash

const struct fal_flash_dev stm32f2_onchip_flash =
{
    .name       = "stm32_onchip",
    .addr       = 0x08000000,
    .len        = 1024*1024,
    .blk_size   = 128*1024,
    .ops        = {init, read, write, erase},
    .write_gran = 8
};
/*
"stm32_onchip" : Flash 設備的名字，

0x08000000: 對 Flash 操作的起始地址，

1024*1024：Flash 的總大小（1MB），

128*1024：Flash 塊/扇區大小（因為 STM32F2 各塊大小不均勻，所以擦除粒度為最大塊的大小：128K），

{init, read, write, erase} ：Flash 的操作函式， 如果沒有 init 初始化程序，第一個操作函式位置可以置空，

8 : 設定寫粒度，單位 bit， 0 表示未生效（默認值為 0 ），該成員是 fal 版本大于 0.4.0 的新增成員，各個 flash 寫入粒度不盡相同，可通過該成員進行設定，以下列舉幾種常見 Flash 寫粒度：

nor flash: 1 bit
stm32f2/f4: 8 bit
stm32f1: 32 bit
stm32l4: 64 bit
*/

定義 flash 設備表
Flash 設備表定義在 fal_cfg.h 頭檔案中，定義磁區表前需 新建 fal_cfg.h 檔案 ，請將該檔案統一放在對應 BSP 或工程目錄的 port 檔案夾下，并將該頭檔案路徑加入到工程，
設備表示例：

/* ===================== Flash device Configuration ========================= */
extern const struct fal_flash_dev stm32f2_onchip_flash;
extern struct fal_flash_dev nor_flash0;

/* flash device table */
#define FAL_FLASH_DEV_TABLE                                          \
{                                                                    \
    &stm32f2_onchip_flash,                                           \
    &nor_flash0,                                                     \
}

Flash 設備表中，有兩個 Flash 物件，一個為 STM32F2 的片內 Flash ，一個為片外的 Nor Flash，
定義 flash 磁區表
磁區表也定義在 fal_cfg.h 頭檔案中，Flash 磁區基于 Flash 設備，每個 Flash 設備又可以有 N 個磁區，這些磁區的集合就是磁區表，在配置磁區表前，務必保證已定義好 Flash 設備 及 設備表，
磁區表示例：

#define NOR_FLASH_DEV_NAME             "norflash0"
/* ====================== Partition Configuration ========================== */
#ifdef FAL_PART_HAS_TABLE_CFG
/* partition table */
#define FAL_PART_TABLE                                                               \
{                                                                                    \
    {FAL_PART_MAGIC_WORD,        "bl",     "stm32_onchip",         0,   64*1024, 0}, \
    {FAL_PART_MAGIC_WORD,       "app",     "stm32_onchip",   64*1024,  704*1024, 0}, \
    {FAL_PART_MAGIC_WORD, "easyflash", NOR_FLASH_DEV_NAME,         0, 1024*1024, 0}, \
    {FAL_PART_MAGIC_WORD,  "download", NOR_FLASH_DEV_NAME, 1024*1024, 1024*1024, 0}, \
}
#endif /* FAL_PART_HAS_TABLE_CFG */

上面這個磁區表詳細描述資訊如下：

用戶需要修改的磁區引數包括：磁區名稱、關聯的 Flash 設備名、偏移地址（相對 Flash 設備內部）、大小，需要注意以下幾點：
1.磁區名保證 不能重復；
2.關聯的 Flash 設備 務必已經在 Flash 設備表中定義好 ，并且 名稱一致 ，否則會出現無法找到 Flash 設備的錯誤；
3.磁區的起始地址和大小 不能超過 Flash 設備的地址范圍 ，否則會導致包初始化錯誤；
注意：每個磁區定義時，除了填寫上面介紹的引數屬性外，需在前面增加 FAL_PART_MAGIC_WORD 屬性，末尾增加 0 （目前用于保留功能）

二、原始碼下載
完整原始碼下載