本應(yīng)用筆記介紹了 RT-Thread 文件系統(tǒng)的基本知識(shí)和使用方法，幫助開發(fā)者更好地使用 RT-Thread 文件系統(tǒng)。并給出了在正點(diǎn)原子STM32F429-apollo開發(fā)板上驗(yàn)證的代碼示例。

本文的目的和結(jié)構(gòu)

本文的目的和背景

第一次接觸 RT-Thread 文件系統(tǒng)的開發(fā)者可能覺得 RT-Thread 文件系統(tǒng)過于復(fù)雜，不知道該從何入手。想要在項(xiàng)目中使用文件系統(tǒng)，卻不知道該怎么做。產(chǎn)生這種印象的原因是對(duì) RT-Thread DFS 框架沒有足夠的了解，如果理解了 DFS 框架，在使用 RT-Thread 文件系統(tǒng)時(shí)就可以得心應(yīng)手了。

為了能讓開發(fā)者清楚地理解 RT-Thread DFS 框架的概念，學(xué)會(huì)使用 RT-Thread 文件系統(tǒng)。本應(yīng)用筆記將一步步深入介紹 RT-Thread DFS 框架的相關(guān)知識(shí)以及實(shí)現(xiàn)原理。通過演示 shell 命令和使用示例的方式來操作文件系統(tǒng)，讓開發(fā)者能夠?qū)W會(huì) RT-Thread 文件系統(tǒng)的使用方法。

本文的結(jié)構(gòu)

本應(yīng)用筆記將從以下三個(gè)方面來介紹 RT-Thread 文件系統(tǒng)：

RT-Thread DFS 框架

RT-Thread 文件系統(tǒng)的移植

RT-Thread 文件系統(tǒng)的使用

問題闡述

本應(yīng)用筆記將圍繞下面幾個(gè)問題來介紹RT-Thread 文件系統(tǒng)。

如何移植各種類型的文件系統(tǒng)？

如何對(duì)文件系統(tǒng)進(jìn)行操作？

如何在文件系統(tǒng)中對(duì)文件和文件夾進(jìn)行操作？

想要解決這些問題，就要了解 RT-Thread DFS 框架。下面我們就通過 DFS 框架一步一步地將文件系統(tǒng)使用起來。

問題的解決

DFS 框架介紹

RT-Thread 的文件系統(tǒng)采用了三層結(jié)構(gòu)，這種結(jié)構(gòu)就是 RT-Thread DFS 框架。

下圖為RT-Thread 文件系統(tǒng)結(jié)構(gòu)圖：

DFS 框架的最頂層是一套面向嵌入式系統(tǒng)，專門優(yōu)化過的設(shè)備虛擬文件系統(tǒng) POSIX 文件接口，中間層是各種文件系統(tǒng)的實(shí)現(xiàn)，最底層是各類存儲(chǔ)設(shè)備驅(qū)動(dòng)。

DFS 框架的來源

RT-Thread 為了能夠支持各種文件系統(tǒng)，設(shè)計(jì)了這樣一個(gè) DFS 框架，各個(gè)層次獨(dú)立實(shí)現(xiàn)，提高了操作系統(tǒng)的可擴(kuò)展性。使用 DFS 框架可以使得各種文件系統(tǒng)經(jīng)過簡(jiǎn)單的修改即可匹配到這個(gè)框架上，降低了文件系統(tǒng)移植難度，讓 開發(fā)者有更多的文件系統(tǒng)類型可供選擇。

DFS 框架各層次說明

頂層：POSIX 文件接口層

這一層是給開發(fā)者使用的接口函數(shù)層，開發(fā)者使用這一層提供的POSIX文件接口進(jìn)行文件的相關(guān)操作，不用關(guān)心文件系統(tǒng)是如何實(shí)現(xiàn)的，也不用關(guān)心數(shù)據(jù)是存放在哪個(gè)存儲(chǔ)器中。

中間層：文件系統(tǒng)實(shí)現(xiàn)層

中間層是各種具體文件系統(tǒng)的實(shí)現(xiàn)，這里所說文件系統(tǒng)指各種不同類型的文件系統(tǒng)，比如ELM FatFS、RomFS、devfs、Yaffs2、Uffs2等。需要知道的是，不同的文件系統(tǒng)類型是獨(dú)立于存儲(chǔ)設(shè)備驅(qū)動(dòng)而實(shí)現(xiàn)的。因此，想要正確地使用這些文件系統(tǒng)，需要把底層存儲(chǔ)設(shè)備的驅(qū)動(dòng)接口和文件系統(tǒng)對(duì)接起來。

底層：存儲(chǔ)設(shè)備驅(qū)動(dòng)層

這一層是存儲(chǔ)設(shè)備驅(qū)動(dòng)層，具體的功能是初始化存儲(chǔ)設(shè)備并向上層提供存儲(chǔ)設(shè)備的驅(qū)動(dòng)接口。存儲(chǔ)設(shè)備的類型可能是SPI Flash，SD卡等。

文件系統(tǒng)的移植

本次演示使用正點(diǎn)原子開發(fā)板STM32F429-Apollo，選擇的文件系統(tǒng)類型是 elm FatFS。由于 RT-Thread 自帶了這個(gè)文件系統(tǒng)，所以移植工作較為簡(jiǎn)單，只需要通過 env 工具對(duì)系統(tǒng)進(jìn)行合適的配置既可。其他 RT-Thread 支持的文件系統(tǒng)，移植過程也是類似的，只需要對(duì)系統(tǒng)進(jìn)行合適的配置即可使用。

準(zhǔn)備工程

下載 RT-Thread 源碼 。

env 工具

移植過程介紹

文件系統(tǒng)的移植主要包括下面幾個(gè)方面：

開啟/配置 DFS 框架

開啟/配置 指定的文件系統(tǒng)

確保開發(fā)板上的存儲(chǔ)設(shè)備驅(qū)動(dòng)正常工作

通過 env 工具可以方便地開啟文件系統(tǒng)，將所需的文件系統(tǒng)類型添加到工程中。

對(duì)存儲(chǔ)設(shè)備進(jìn)行功能測(cè)試，可以確保存儲(chǔ)設(shè)備驅(qū)動(dòng)是正常工作的。驅(qū)動(dòng)程序的穩(wěn)定工作是文件系統(tǒng)正常使用的基礎(chǔ)。

文件系統(tǒng)的配置

使用 env 工具進(jìn)入rt-threadspstm32f429-apollo目錄，在命令行中輸入menuconfig命令進(jìn)入配置界面。

在menuconfig配置界面依次選擇RT-Thread Components → Device virtual file system，如下圖所示：

下面介紹 DFS 的配置項(xiàng)：

Using device virtual file system ： 使用設(shè)備虛擬文件系統(tǒng)，即 RT-Thread 文件系統(tǒng)。

Using working directory : 打開這個(gè)選項(xiàng)，在finsh/msh中就可以使用基于當(dāng)前工作目錄的相對(duì)路徑。

The maximal number of mounted file system ： 最大掛載文件系統(tǒng)的數(shù)量。

The maximal number of file system type ： 最大支持文件系統(tǒng)類型的數(shù)量。

The maximal number of opened files ： 打開文件的最大數(shù)量。

Enable elm-chan fatfs ： 使用 elm-chan FatFs。

elm-chan’s FatFs, Generic FAT Filesystem Module : elm-chan 文件系統(tǒng)的配置項(xiàng)。

Using devfs for device objects ： 開啟 devfs 文件系統(tǒng)。

Enable BSD socket operated by file system API ： 使 BSD socket 可以使用文件系統(tǒng)的 API 來管理，比如讀寫操作和 select/poll 的 POSIX API 調(diào)用。

Enable ReadOnly file system on flash ： 在 Flash 上使用只讀文件系統(tǒng)。

Enable RAM file system ： 使用 RAM 文件系統(tǒng)。

Enable UFFS file system: Ultra-low-cost Flash File System ：使用 UFFS。

Enable JFFS2 file system : 使用 JFFS2 文件系統(tǒng)。

Using NFS v3 client file system ：使用 NFS 文件系統(tǒng)。

進(jìn)入到 DFS 的配置界面，開啟下圖所示的選項(xiàng)，就可以將FatFS添加到系統(tǒng)中。如圖所示：

這里需要注意的是還需要進(jìn)入到elm-chan's FatFs, Generic FAT Filesystem Module選項(xiàng)中修改關(guān)于長(zhǎng)文件名支持的選項(xiàng)，否則在后面使用文件系統(tǒng)的過程中，創(chuàng)建的文件或者文件夾的名稱不能超過 8 個(gè)字符。修改方式如下圖所示：

因?yàn)橐褂靡恍?C 庫函數(shù)，所以需要打開libc功能：

保存選項(xiàng)后即可退出，此時(shí)elm FatFS已經(jīng)添加到項(xiàng)目中 。

存儲(chǔ)設(shè)備初始化

開啟 SPI 設(shè)備驅(qū)動(dòng)

DFS 框架的文件系統(tǒng)實(shí)現(xiàn)層需要存儲(chǔ)設(shè)備驅(qū)動(dòng)層提供驅(qū)動(dòng)接口用于對(duì)接，本次使用的存儲(chǔ)設(shè)備為SPI Flash，底層設(shè)備初始化過程可以參考 《SPI 設(shè)備應(yīng)用筆記》 。

重新打開 menuconfig 配置界面，在RT-Thread Components → Device Drivers界面中選中Using SPI Bus/Device device drivers以及Using Serial Flash Universal Driver選項(xiàng)，如下圖所示：

為了方便地使用 shell 命令，我們?cè)赗T-Thread Components → Command shell選項(xiàng)中開啟Using module shell選項(xiàng)，如下圖所示：

保存選項(xiàng)并退出，在 env 中輸入命令scons --target=mdk5 -s生成 mdk5 工程，編譯并下載程序。

檢查存儲(chǔ)設(shè)備驅(qū)動(dòng)

在 stm32f429-apollo 開發(fā)板上SPI Flash掛在了 SPI5 總線上，對(duì)應(yīng)的SPI Device的設(shè)備名為spi50。在終端輸入list_device命令可以看到名為spi50的設(shè)備類型為SPI Device，就說明 SPI 設(shè)備添加成功。如果沒有出現(xiàn)相應(yīng)的設(shè)備，則需要檢查驅(qū)動(dòng)程序，查找錯(cuò)誤。

為了確保該驅(qū)動(dòng)工作正常，可以使用sf命令對(duì)該設(shè)備做benchmark測(cè)試。該功能由sfud組件提供，可以通過檢查存儲(chǔ)設(shè)備的讀、寫和擦除功能來判斷存儲(chǔ)設(shè)備的驅(qū)動(dòng)程序是否正常。 如果像下圖一樣提示成功，所示則認(rèn)為該驅(qū)動(dòng)工作正常。如果無法通過測(cè)試，則需要檢查驅(qū)動(dòng)程序，使用邏輯分析儀對(duì)存儲(chǔ)設(shè)備的接口波形進(jìn)行分析。測(cè)試過程如下圖：

創(chuàng)建存儲(chǔ)設(shè)備

由于只有塊設(shè)備類型的設(shè)備才能和文件系統(tǒng)對(duì)接，所以需要根據(jù)SPI Device找到SPI Flash設(shè)備，并創(chuàng)建與其對(duì)應(yīng)的Block Device。

這里需要使用到萬能 SPI Flash 驅(qū)動(dòng)庫：SFUD ，RT-Thread 已經(jīng)集成了該組件，在上面的配置過程中我們已經(jīng)開啟這個(gè)功能。此時(shí)只需要使用 SFUD 提供的rt_sfud_flash_probe函數(shù)即可。該函數(shù)將執(zhí)行如下操作：

根據(jù)名為spi50的SPI Device設(shè)備找到對(duì)應(yīng)的Flash存儲(chǔ)設(shè)備。

初始化Flash設(shè)備。

在 Flash 存儲(chǔ)設(shè)備上創(chuàng)建名為W25Q256的 Block Device。

如果開啟了組件自動(dòng)初始化功能，該函數(shù)會(huì)被自動(dòng)執(zhí)行，否則需要手動(dòng)調(diào)用運(yùn)行。

static int rt_hw_spi_flash_with_sfud_init(void) { if (RT_NULL == rt_sfud_flash_probe("W25Q256", "spi50")) { return RT_ERROR; }; return RT_EOK; } INIT_COMPONENT_EXPORT(rt_hw_spi_flash_with_sfud_init)

在終端輸入list_device命令如果看到名為W25Q256的設(shè)備類型為Block Device，這說明塊設(shè)備已經(jīng)創(chuàng)建成功，如果失敗則需要對(duì)spi50設(shè)備進(jìn)行檢查。

如下圖所示：

獲得可以用于掛載的塊類型設(shè)備，那么移植的工作就算完成了。

文件系統(tǒng)的使用

文件系統(tǒng)的初始化

RT-Thread 文件系統(tǒng)初始化過程一般按以下流程來進(jìn)行：

初始化 DFS 框架

初始化具體文件系統(tǒng)

初始化存儲(chǔ)設(shè)備

下面我們按照這樣的順序來逐步講解文件系統(tǒng)的初始化過程：

DFS 框架的初始化

DFS 框架的初始化主要是對(duì)內(nèi)部數(shù)據(jù)結(jié)構(gòu)以及資源的初始化。這一過程包括初始化文件系統(tǒng)必須的數(shù)據(jù)表，以及互斥鎖。該功能由如下函數(shù)完成。如果開啟了組件自動(dòng)初始化功能，該函數(shù)會(huì)被自動(dòng)執(zhí)行，否則需要手動(dòng)調(diào)用運(yùn)行。

中間層文件系統(tǒng)的初始化

這一步的初始化主要是將elm FatFS的操作函數(shù)注冊(cè)到 DFS 框架中。該功能由如下函數(shù)完成。如果開啟了組件自動(dòng)初始化功能，該函數(shù)會(huì)被自動(dòng)執(zhí)行，否則需要手動(dòng)調(diào)用運(yùn)行。

存儲(chǔ)設(shè)備的初始化

存儲(chǔ)設(shè)備的初始化可以參考 《創(chuàng)建存儲(chǔ)設(shè)備》章節(jié)。

創(chuàng)建文件系統(tǒng)

第一次使用SPI Flash作為文件系統(tǒng)地存儲(chǔ)設(shè)備時(shí)，如果我們直接重啟開發(fā)板來掛載文件系統(tǒng)，就會(huì)看到spi flash mount to /spi failed!的提示。這是因?yàn)榇藭r(shí)在 SPI Flash 中還沒有創(chuàng)建相應(yīng)類型的文件系統(tǒng)，這就用到了創(chuàng)建文件系統(tǒng) shell 命令：mkfs。

mkfs命令的功能是在指定的存儲(chǔ)設(shè)備上創(chuàng)建指定類型的文件系統(tǒng)。使用格式為：mkfs [-t type] device。第一次掛載文件系統(tǒng)前需要使用mkfs命令在存儲(chǔ)設(shè)備上創(chuàng)建相應(yīng)的文件系統(tǒng)，否則就會(huì)掛載失敗。如果要在W25Q256設(shè)備上創(chuàng)建elm類型的文件系統(tǒng)，就可以使用mkfs -t elm W25Q256命令，使用方法如下圖：

文件系統(tǒng)創(chuàng)建完成后需要重啟設(shè)備。

文件系統(tǒng)的掛載

文件系統(tǒng)的掛載指的是將文件系統(tǒng)和具體的存儲(chǔ)設(shè)備關(guān)聯(lián)起來，并掛載到某個(gè)掛載點(diǎn)，這個(gè)掛載點(diǎn)即為這個(gè)文件系統(tǒng)的根目錄。在下面的示例中，我們將elm FatFS文件系統(tǒng)和名為W25Q256的存儲(chǔ)設(shè)備關(guān)聯(lián)起來，并且掛載到/spi文件夾中。（這里可以掛載到/spi文件夾的原因是stm32f429-apollo BSP的文件系統(tǒng)根目錄已經(jīng)掛載了RomFS，并且已經(jīng)創(chuàng)建了/spi文件夾。如果沒有特殊情況，文件系統(tǒng)可以直接掛載到根目錄/上。）

掛載文件系統(tǒng)的操作由dfs_mount()函數(shù)完成，dfs_mount()函數(shù)的參數(shù)分別為：塊設(shè)備名、文件系統(tǒng)掛載點(diǎn)路徑、掛載文件系統(tǒng)類型、讀寫標(biāo)志位以及文件系統(tǒng)的私有數(shù)據(jù)，使用方法如下圖所示：

經(jīng)過了上面的創(chuàng)建文件系統(tǒng)操作，我們重啟開發(fā)板（會(huì)自動(dòng)重新執(zhí)行掛載函數(shù)），就可以成功地掛載文件系統(tǒng)了?？梢钥吹教崾緎pi flash mount to /spi !。這時(shí)再次使用list_device命令可以看到W25Q256設(shè)備已經(jīng)被掛載成功。如下圖所示：

到這一步為止，文件系統(tǒng)已經(jīng)初始化完成，接下來可以對(duì)文件和目錄進(jìn)行操作了。

文件與目錄操作 shell 命令

在這一小節(jié)介紹關(guān)于文件和目錄操作常用的 shell 命令：

ls功能：顯示文件和目錄的信息，示例如下圖：

cd功能：切換到指定工作目錄，示例如下圖：

cp功能：copy 文件，示例如下圖：

rm功能：刪除文件或目錄，示例如下圖：

mv功能：將文件移動(dòng)位置或者改名，示例如下圖：

echo功能：將指定內(nèi)容寫入文件：

cat功能：展示文件的內(nèi)容，示例如下圖：

pwd功能：打印出當(dāng)前目錄地址，示例如下圖：

mkdir功能：創(chuàng)建文件夾，示例如下圖：

文件操作示例

本節(jié)以創(chuàng)建文件夾操作為例，介紹如何使用 RT-Thread 文件系統(tǒng) Sample 來對(duì)文件系統(tǒng)進(jìn)行操作。

在menuconfig配置界面依次選擇RT-Thread online packages → miscellaneous packages → filesystem sample options，選中 [filesystem] mkdir選項(xiàng)，如下圖所示：

保存并退出后，使用pkgs --update命令更新軟件包，然后使用scons --target=mdk5 -s命令重新生成工程?？梢钥吹皆?Sample 已經(jīng)添加到工程中：

這里需要注意的是由于我們文件系統(tǒng)的根目錄掛載了RomFS，不可修改，所以我們不能直接在根目錄創(chuàng)建文件夾。因此，我們需要對(duì)程序進(jìn)行簡(jiǎn)單的修改，如下圖所示：

重新編譯后下載運(yùn)行，在 msh 中可以使用mkdir_sample_init命令來創(chuàng)建 web 文件夾，效果如下圖所示：

此時(shí)切換到/spi文件夾中可以看到 web 文件夾已經(jīng)被創(chuàng)建。

文件系統(tǒng)提供的 Sample 還有openfile、readwrite、stat、rename、opendir、readdir、tell_seek_dir，大家可以用上面的方法來使用這些功能。

常見問題

（1）發(fā)現(xiàn)文件名或者文件夾名稱顯示不正常怎么辦？

檢查是否開啟了長(zhǎng)文件名支持，可以參考本應(yīng)用筆記《文件系統(tǒng)的配置》章節(jié)。

（2）文件系統(tǒng)初始化失敗怎么辦？

檢查文件系統(tǒng)配置項(xiàng)目中的允許掛載的文件系統(tǒng)類型和數(shù)量是否充足。

（3）創(chuàng)建文件系統(tǒng)mkfs命令失敗怎么辦？

檢查存儲(chǔ)設(shè)備是否存在，如果存在檢查設(shè)備驅(qū)動(dòng)是否可以通過功能測(cè)試，如果不能通過，則檢查驅(qū)動(dòng)錯(cuò)誤。

檢查 libc 功能是否開啟，參見 《文件系統(tǒng)的配置》章節(jié)。

（4）文件系統(tǒng)掛載失敗怎么辦？

檢查指定的掛載路徑是否存在。文件系統(tǒng)可以直接掛載到根目錄（“/”），但是如果想要掛載到其他路徑上，如 （“/sdcard”）。需要確保（“/sdcard”）路徑是存在的，否則需要先在根目錄創(chuàng)建sdcard文件夾才能掛載成功。

檢查是否在存儲(chǔ)設(shè)備上創(chuàng)建了文件系統(tǒng)，如果存儲(chǔ)設(shè)備上沒有文件系統(tǒng)，需要使用mkfs命令在存儲(chǔ)器上創(chuàng)建文件系統(tǒng)。

（5）SFUD 探測(cè)不到 Flash 所使用的具體型號(hào)怎么辦？

檢查硬件引腳設(shè)置錯(cuò)誤

SPI 設(shè)備是否已經(jīng)注冊(cè)

SPI 設(shè)備是否已經(jīng)掛載到總線

檢查在RT-Thread Components → Device Drivers -> Using SPI Bus/Device device drivers -> Using Serial Flash Universal Driver菜單下的Using auto probe flash JEDEC SFDP parameter和Using defined supported flash chip information table配置項(xiàng)是否選中，如果沒有選中那么需要開啟這兩個(gè)選項(xiàng)。配置圖可參考 《開啟 SPI 設(shè)備驅(qū)動(dòng)》 章節(jié)。

如果開啟了上面的選項(xiàng)仍然無法識(shí)別存儲(chǔ)設(shè)備，那么可以在 SFUD 項(xiàng)目中提出 issues。

（6）elm FatFS 的最大扇區(qū)大小該如何設(shè)置？

根據(jù)所使用的存儲(chǔ)設(shè)備的不同，也會(huì)有些不一樣，一般根據(jù) Flash 設(shè)備的要求可以設(shè)置為 4K，也就是填寫 4096。

一般常見的 TF 卡和 SD 卡的扇區(qū)大小設(shè)置為 512。

（7）存儲(chǔ)設(shè)備的benchmark測(cè)試耗時(shí)過長(zhǎng)是怎么回事？

可對(duì)比system tick為 1000 時(shí)的 benchmark 測(cè)試數(shù)據(jù) 和本次測(cè)試所需的時(shí)長(zhǎng)，如果耗時(shí)差距過大，則可以認(rèn)為測(cè)試工作運(yùn)行不正常。

檢查系統(tǒng) tick 的設(shè)置，因?yàn)橐恍┭訒r(shí)操作會(huì)根據(jù) tick 時(shí)間來決定，所以需要根據(jù)系統(tǒng)情況來設(shè)置合適的system tick值。如果系統(tǒng)的system tick值不低于 1000，則需要使用邏輯分析儀檢查波形確定通信速率正常。

（8）SPI Flash 實(shí)現(xiàn) elmfat 文件系統(tǒng)，如何保留部分扇區(qū)不被文件系統(tǒng)使用？

可以使用 RT-Thread 提供的 partition 工具軟件包為整個(gè)存儲(chǔ)設(shè)備創(chuàng)建多個(gè)塊設(shè)備，為創(chuàng)建的多個(gè)塊設(shè)備分配不同的功能即可。

（9）測(cè)試文件系統(tǒng)過程中程序卡住了怎么辦？

嘗試使用調(diào)試器或者打印一些必要的調(diào)試信息，確定程序卡住的位置再提出問題。

（10）如何一步步檢查文件系統(tǒng)出現(xiàn)的問題？

可以采用從底層到上層的方法來逐步排查問題。

首先檢查存儲(chǔ)設(shè)備是否注冊(cè)成功，功能是否正常。

檢查存儲(chǔ)設(shè)備中是否創(chuàng)建了文件系統(tǒng)。

檢查指定文件系統(tǒng)類型是否注冊(cè)到 DFS 框架，經(jīng)常要檢查允許的文件系統(tǒng)類型和數(shù)量是否足夠。

檢查 DFS 是否初始化成功，這一步的初始化操作是純軟件的，因此出錯(cuò)的可能性不高。需要注意的是如果開啟了組件自動(dòng)初始化，就無需再次手動(dòng)初始化。