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

2020-10-21 17:01:06

一、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 裝置名偏移地址大小說明
「bl」「stm32_onchip」064KB載入程式
「app」「stm32_onchip」64*1024704KB應用程式
「easyflash」「norflash0」01MBEasyFlash 引數儲存
「download」「norflash0」1024*10241MBOTA 下載區

使用者需要修改的分割區引數包括:分割區名稱、關聯的 Flash 裝置名、偏移地址(相對 Flash 裝置內部)、大小,需要注意以下幾點:
1.分割區名保證 不能重複;
2.關聯的 Flash 裝置 務必已經在 Flash 裝置表中定義好 ,並且 名稱一致 ,否則會出現無法找到 Flash 裝置的錯誤;
3.分割區的起始地址和大小 不能超過 Flash 裝置的地址範圍 ,否則會導致包初始化錯誤;
注意:每個分割區定義時,除了填寫上面介紹的引數屬性外,需在前面增加 FAL_PART_MAGIC_WORD 屬性,末尾增加 0 (目前用於保留功能)

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