FatFs模块功能配置选项

r囧r小猫 2022-07-15 13:30 317阅读 0赞

本文使用的FatFs版本为：V0.12b（2016年9月4发布）

Fatfs模块的功能可以裁剪，通过配置宏定义实现，宏定义位于文件ffconf.h中。

### 1.功能配置 ###

#### 1.1 \_FS\_READONLY ####

使能或禁用与写相关函数。

![SouthEast][]

当设置为只读(1)时，API函数f\_write、f\_sync、f\_unlink、f\_mkdir、f\_chmod、f\_rename、f\_truncate、f\_getfree。

#### 1.2 \_FS\_MINIMIZE ####

函数功能裁剪。

![SouthEast 1][]

#### 1.3 \_USE\_STRFUNC ####

用于使能或禁用字符串函数：f\_gets、f\_putc、f\_puts和f\_printf

![SouthEast 2][]

#### 1.4 \_USE\_FIND ####

使能或禁用在指定目录内搜索指定文件函数：f\_findfirst和f\_findnext

![SouthEast 3][]

#### 1.5 \_USE\_MKFS ####

使能或禁用f\_mkfs函数

![SouthEast 4][]

#### 1.6 \_USE\_FASTSEEK ####

使能或禁用快速搜索功能，使能后，可以加快f\_lseek、f\_read和f\_write函数执行。

![SouthEast 5][]

#### 1.7 \_USE\_EXPAND ####

使能或禁用f\_expand函数，该函数可以为文件分配连续数据区域。

![SouthEast 6][]

#### 1.8 \_USE\_CHMOD ####

使能或禁用元数据控制函数：f\_chmod和f\_utime。

![SouthEast 7][]

#### 1.9 \_USE\_LABEL ####

使能或禁用卷标签API函数：f\_getlabel和f\_setlabel。

![SouthEast 8][]

#### 1.10 \_USE\_FORWARD ####

使能或禁用f\_forward函数。

![SouthEast 9][]

### 2.命名空间和本地环境配置 ###

#### 2.1 \_CODE\_PAGE ####

规定目标系统使用的OEM代码。如果该代码设置的不正确，可能会引起文件打开失败。如果没有根本没有使用扩展字符，则使用任何代码都没区别。

![SouthEast 10][]

#### 2.2 \_USE\_LFN ####

使能或禁用长文件名(LFN)。当使能长文件名后，需要向工程添加包含Unicode支持函数的option/unicode.c文件。工作缓冲区增加(\_MAX\_LFN + 1) \* 2个字节，如果使能exFAT，额外多需要608字节缓存。如果工作缓存使用栈内存，需当心栈溢出；如果工作缓冲使用堆内存，需要向工程添加内存管理函数ff\_memalloc和ff\_memfree。

![SouthEast 11][]

#### 2.3 \_MAX\_LFN ####

定义长文件名工作缓冲区大小，可以为12~255字节。当禁用长文件名时，此选项无效。

#### 2.4 \_LFN\_UNICODE ####

使能或禁用Unicode。如果要使用Unicode(UTF16)字符串路径名，需要使能LFN和设置本选项为1。此选项还影响字符串I/O功能函数。如果禁用长文件名，此选项必须为0。

![SouthEast 12][]

#### 2.5 \_STRF\_ENCODE ####

通过设置\_LFN\_UNICODE为1使能Unicode API函数时，这个选项定义通过字符串I/O函数读写的文件字符编码。字符串I/O函数有f\_gets、f\_putc、f\_puts和f\_printf。当\_LFN\_UNICODE等于0时，此选项不起作用。

![SouthEast 13][]

#### 2.6 \_FS\_RPATH ####

配置相对路径函数。

![SouthEast 14][]

### 3.卷/驱动器配置 ###

#### 3.1 \_VOLUMES ####

配置可用卷的数目，可设置为1~10。

#### 3.2 \_STR\_VOLUME\_ID ####

使能或禁用字符串卷标识。要使能字符串卷标识，需要预先定义标识字符串，使用宏\_VOLUME\_STRS定义。

![SouthEast 15][]

#### 3.3 \_VOLUME\_STRS ####

定义每一个逻辑驱动器ID。ID数目不能少于\_VOLUMES。驱动器ID有效字符只能为A-Z和0-9。比如：

#define _VOLUME_STRS	"RAM","NAND","CF","SD","SD2","USB","USB2","USB3"

#### 3.4 \_MULTI\_PARTITION ####

使能或禁止多分区函数。默认禁止，此时每个逻辑驱动器数目一定与物理驱动器数目相同，并且物理驱动器仅能安装FAT卷。如果使能，物理设备上可以有多个逻辑扇区，每个逻辑驱动器一定要预先定义在分区解析表VolToPart\[\]中。同时，f\_disk函数有效。

![SouthEast 16][]

#### 3.5 \_MIN\_SS、\_MAX\_SS ####

定义扇区大小，有效值为512、1024、2048、4096，需要根据硬件配置来定义。\_MIN\_SS定义最小扇区大小，\_MAX\_SS定义最大扇区大小。都设置为512可以兼容所有SD卡和硬盘，但是在某些片上Flash和其它存储设备可能需要更大值。当\_MAX\_SS > \_MIN\_SS，FatFs被配置为扇区大小可变的并且必须在函数disk\_ioctl中实现GET\_SECTOR\_SIZE命令。

#### 3.6 \_USE\_TRIM ####

使能或禁用ATA-TRIM函数。TRIM指令被文件系统用来通知设备哪些逻辑地址不再被占用，可以被设备回收为空闲空间。对于FatFs来说，使用函数f\_unlink移除一个文件时，只是将对应的FAT区域设置为空，文件实际上在扇区中。如果想在移除文件时强制擦除扇区，只需将\_USE\_TRIM设置为1。如果使能TRIM函数，必须在函数disk\_ioctl中实现CTRL\_TRIM命令。

![SouthEast 17][]

#### 3.7 \_FS\_NOFSINFO ####

使能或禁用空闲簇计数和最后分配的簇计数。

### 4.系统配置 ###

#### 4.1 \_FS\_TINY ####

配置FatFs为正常模式或者微型(TINY)模式。配置为微型模式后，对内存需求变小，文件对象数据结构FIL会减少\_MAX\_SS字节。程序复用FATFS数据结构中的缓冲区代替FIL数据结构中去除掉的缓冲区。

![SouthEast 18][]

#### 4.2 \_FS\_EXFAT ####

使能或禁用exFAT文件系统。要使能exFAT文件系统，必须使能长文件名功能并且配置\_LFN\_UNICODE = 1。如果要使用全功能版的exFAT，推荐\_MAX\_LFN = 255。注意，使能exFAT意味着不再兼容C89，因为要用到64位整形数。

![SouthEast 19][]

#### 4.3 \_FS\_NORTC ####

使能或禁用时间戳函数。使能时间戳函数需要硬件RTC，并且需要提供底层函数get\_fattime。如果系统没有硬件RTC或者不需要时间戳功能，设置\_FS\_NORTC为1禁用时间戳函数。此时，如果FatFs修改任何文件，使用固定的时间戳，固定时间戳由宏\_NORTC\_MON、\_NORTC\_MDAY和\_NORTC\_YEAR定义。

![SouthEast 20][]

#### 4.4 \_NORTC\_MON、\_NORTC\_MDAY和\_NORTC\_YEAR ####

如果系统没有RTC，这些宏用来定义固定时间戳。只读或者\_FS\_NORTC=0时，这些宏无意义。  
比如：

#define _NORTC_MON	1
    #define _NORTC_MDAY	1
    #define _NORTC_YEAR	2016

#### 4.5 \_FS\_LOCK ####

使能或禁用文件锁功能。控制重复打开文件和非法打开文件对象。注意：文件锁功能不具有可重入性。只读模式下，这个宏必须为0。

![SouthEast 21][]

#### 4.6 \_FS\_REENTRANT ####

使能或禁用FatFs模块的可重入特性。注意，访问不同卷上的文件/目录总是可重入的，无论是否使能本参数，卷控制函数f\_mount、f\_mkfs和f\_fdisk总是不可重入的。要使能可重入特性，用户必须提供同步处理，要向工程中添加ff\_req\_grant、ff\_rel\_grant、ff\_del\_syncobj和ff\_cre\_syncobj函数。可以在文件option/syscall.c中找到示例。

![SouthEast 22][]

#### 4.7 \_FS\_TIMEOUT ####

设置超时时间，单位为系统时钟滴答周期，当宏\_FS\_REENTRANT=0时，本设置无效。

#### 4.8 \_SYNC\_t ####

定义同步对象类型，取决于O/S。比如HANDLE、ID、OS\_EVENT\*、SemaphoreHandle\_t等等。需要在ff.c中包含O/S相关的头文件。当宏\_FS\_REENTRANT=0时，本设置无效。

[SouthEast]: /images/20220715/05d4c91700af4ca58b94092d2e6eba79.png
[SouthEast 1]: /images/20220715/ff1f5496f119476599cafec599d67298.png
[SouthEast 2]: /images/20220715/8fcdeb44d5df4ecab76e50d7512f631c.png
[SouthEast 3]: /images/20220715/6a0b60b280184f8e9b2c3f212ed74b46.png
[SouthEast 4]: /images/20220715/f002a43467c84112a88db42480bc89d3.png
[SouthEast 5]: /images/20220715/50e40f1c96e24eee97f0282e48879ec9.png
[SouthEast 6]: /images/20220715/57f9c8907fdd47b6b71f88465f698e49.png
[SouthEast 7]: /images/20220715/c441fd3c18d74569b1a124ae97604241.png
[SouthEast 8]: /images/20220715/7be27f4af3c64395b378925fcfa05a14.png
[SouthEast 9]: /images/20220715/6561163b8c9342a7985fdb07326c7047.png
[SouthEast 10]: /images/20220715/5eb0869d7b15495c84e625deb3c7a7b5.png
[SouthEast 11]: /images/20220715/7a816c34cac341da9b7b06d0d875fe7e.png
[SouthEast 12]: /images/20220715/cec6520dd89b435a801529307acdf1c3.png
[SouthEast 13]: /images/20220715/653bc784a4464608bf315f73c936eaa0.png
[SouthEast 14]: /images/20220715/ae160ca772dd4278a9dd0cb889c4b49d.png
[SouthEast 15]: /images/20220715/7d3b0ee4405e465c9bf69a506e1d5902.png
[SouthEast 16]: /images/20220715/8ab0641efc564322bab8fe221e033582.png
[SouthEast 17]: /images/20220715/890d3fbce11b44cba69f80eac18ee3eb.png
[SouthEast 18]: /images/20220715/78710aed5c094c1fbfb5749f02a2d1de.png
[SouthEast 19]: /images/20220715/b63434dc61e243aaa098391167f36d5e.png
[SouthEast 20]: /images/20220715/86cbb69ce2ca4e3b9341a8c13cb4ff1f.png
[SouthEast 21]: /images/20220715/c2c6f4b57ba944d89a2c093e6729e363.png
[SouthEast 22]: /images/20220715/31e45445f86047c886f5bb41e6851686.png