FAT 文件系统

ESP-IDF 使用 FatFs 库来实现 FAT 文件系统。FatFs 库位于 fatfs 组件中，支持直接使用，也可以借助 C 标准库和 POSIX API 通过 VFS（虚拟文件系统）使用 FatFs 库的大多数功能。

此外，我们对 FatFs 库进行了扩展，新增了支持可插拔磁盘 I/O 调度层，从而允许在运行时将 FatFs 驱动映射到物理磁盘。

FatFs 与 VFS 配合使用

头文件 fatfs/vfs/esp_vfs_fat.h 定义了连接 FatFs 和 VFS 的函数。

函数 esp_vfs_fat_register() 分配一个 FATFS 结构，并在 VFS 中注册特定路径前缀。如果文件路径以此前缀开头，则对此文件的后续操作将转至 FatFs API。

函数 esp_vfs_fat_unregister_path() 删除在 VFS 中的注册，并释放 FATFS 结构。

多数应用程序在使用 esp_vfs_fat_ 函数时，采用如下步骤：

1. 调用 esp_vfs_fat_register()，指定：

   • 挂载文件系统的路径前缀（例如，"/sdcard" 或 "/spiflash"）

   • FatFs 驱动编号

   • 一个用于接收指向 FATFS 结构指针的变量

2. 调用 ff_diskio_register()，为步骤 1 中的驱动编号注册磁盘 I/O 驱动；

3. 调用 FatFs 函数 f_mount()，随后调用 f_fdisk() 或 f_mkfs()，并使用与传递到 esp_vfs_fat_register() 相同的驱动编号挂载文件系统。请参考 FatFs 文档，查看更多信息；

4. 调用 C 标准库和 POSIX API 对路径中带有步骤 1 中所述前缀的文件（例如，"/sdcard/hello.txt"）执行打开、读取、写入、擦除、复制等操作。文件系统默认使用 8.3 文件名 格式 (SFN)。如需使用长文件名 (LFN)，启用 CONFIG_FATFS_LONG_FILENAMES 选项。请参考 here，查看更多信息；

5. 可以启用 CONFIG_FATFS_USE_FASTSEEK 选项，可以使用 POSIX lseek 实现快速执行。快速查找不适用于编辑模式下的文件，所以，使用快速查找时，应在只读模式下打开（或者关闭然后重新打开）文件；

6. 可以启用 CONFIG_FATFS_IMMEDIATE_FSYNC 选项，在每次调用 vfs_fat_write()、vfs_fat_pwrite()、vfs_fat_link()、vfs_fat_truncate() 和 vfs_fat_ftruncate() 函数之后，自动调用 f_sync() 以同步最近的文件改动。该功能可提高文件系统中文件的一致性和文件大小报告的准确性，但是由于需要频繁进行磁盘操作，性能将会受到影响；

7. 可以直接调用 FatFs 库函数，但需要使用没有 VFS 前缀的路径，如 "/hello.txt"；

8. 关闭所有打开的文件；

9. 调用 FatFs 函数 f_mount() 并使用 NULL FATFS* 参数，为与上述编号相同的驱动卸载文件系统；

10. 调用 FatFs 函数 ff_diskio_register() 并使用 NULL ff_diskio_impl_t* 参数和相同的驱动编号，来释放注册的磁盘 I/O 驱动；

11. 调用 esp_vfs_fat_unregister_path() 并使用文件系统挂载的路径将 FatFs 从 VFS 中移除，并释放步骤 1 中分配的 FATFS 结构。

便捷函数 esp_vfs_fat_sdmmc_mount()、esp_vfs_fat_sdspi_mount() 和 esp_vfs_fat_sdcard_unmount() 对上述步骤进行了封装，并加入了对 SD 卡初始化的处理。我们将在下一章节详细介绍以上函数。

FatFs 与 VFS 和 SD 卡配合使用

头文件 fatfs/vfs/esp_vfs_fat.h 定义了便捷函数 esp_vfs_fat_sdmmc_mount()、 esp_vfs_fat_sdspi_mount() 和 esp_vfs_fat_sdcard_unmount()。这些函数分别执行上一章节的步骤 1-3 和步骤 7-9，并初始化 SD 卡，但仅提供有限的错误处理功能。我们鼓励开发人员查看源代码，将更多高级功能集成到产品应用中。

便捷函数 esp_vfs_fat_sdmmc_unmount() 用于卸载文件系统并释放从 esp_vfs_fat_sdmmc_mount() 函数获取的资源。

FatFs 与 VFS 配合使用（只读模式下）

头文件 fatfs/vfs/esp_vfs_fat.h 也定义了两个便捷函数 esp_vfs_fat_spiflash_mount_ro() 和 esp_vfs_fat_spiflash_unmount_ro()。上述两个函数分别对 FAT 只读分区执行步骤 1-3 和步骤 7-9。有些数据分区仅在工厂配置时写入一次，之后在整个硬件生命周期内都不会再有任何改动。利用上述两个函数处理这种数据分区非常方便。

FatFs 磁盘 I/O 层

我们对 FatFs API 函数进行了扩展，实现了运行期间注册磁盘 I/O 驱动。

上述 API 为 SD/MMC 卡提供了磁盘 I/O 函数实现方式，可使用 ff_diskio_register_sdmmc() 函数注册指定的 FatFs 驱动编号。

void ff_diskio_register(BYTE pdrv, const ff_diskio_impl_t *discio_impl)

Register or unregister diskio driver for given drive number.

When FATFS library calls one of disk_xxx functions for driver number pdrv, corresponding function in discio_impl for given pdrv will be called.

参数

• pdrv -- drive number

• discio_impl -- pointer to ff_diskio_impl_t structure with diskio functions or NULL to unregister and free previously registered drive

struct ff_diskio_impl_t

Structure of pointers to disk IO driver functions.

See FatFs documentation for details about these functions

Public Members

DSTATUS (*init)(unsigned char pdrv)

disk initialization function

DSTATUS (*status)(unsigned char pdrv)

disk status check function

DRESULT (*read)(unsigned char pdrv, unsigned char *buff, uint32_t sector, unsigned count)

sector read function

DRESULT (*write)(unsigned char pdrv, const unsigned char *buff, uint32_t sector, unsigned count)

sector write function

DRESULT (*ioctl)(unsigned char pdrv, unsigned char cmd, void *buff)

function to get info about disk and do some misc operations

void ff_diskio_register_sdmmc(unsigned char pdrv, sdmmc_card_t *card)

Register SD/MMC diskio driver

参数

• pdrv -- drive number

• card -- pointer to sdmmc_card_t structure describing a card; card should be initialized before calling f_mount.

esp_err_t ff_diskio_register_wl_partition(unsigned char pdrv, wl_handle_t flash_handle)

Register spi flash partition

参数

• pdrv -- drive number

• flash_handle -- handle of the wear levelling partition.

esp_err_t ff_diskio_register_raw_partition(unsigned char pdrv, const esp_partition_t *part_handle)

Register spi flash partition

参数

• pdrv -- drive number

• part_handle -- pointer to raw flash partition.

FatFs 分区生成器

我们为 FatFs (wl_fatfsgen.py) 提供了分区生成器，该生成器集成在构建系统中，方便用户在自己的项目中使用。

该生成器可以在主机上创建文件系统镜像，并用指定的主机文件夹内容对其进行填充。

该脚本是建立在分区生成器的基础上 (fatfsgen.py)，目前除了可以生成分区外，也可以初始化磨损均衡。

目前的最新版本支持短文件名、长文件名、FAT12 和 FAT16。长文件名的上限是 255 个字符，文件名中可以包含多个 . 字符以及其他字符，如 +、,、;、=、[ and ] 等。

如需进一步了解 FatFs 分区生成器或分区分析器，请查看 Generating and parsing FAT partition on host。

构建系统中使用 FatFs 分区生成器

通过调用 fatfs_create_partition_image 可以直接从 CMake 构建系统中调用 FatFs 分区生成器:

fatfs_create_spiflash_image(<partition> <base_dir> [FLASH_IN_PROJECT])

如果不希望在生成分区时使用磨损均衡，可以使用 fatfs_create_rawflash_image:

fatfs_create_rawflash_image(<partition> <base_dir> [FLASH_IN_PROJECT])

fatfs_create_spiflash_image 以及 fatfs_create_rawflash_image 必须从项目的 CMakeLists.txt 中调用。

如果决定使用 fatfs_create_rawflash_image （不支持磨损均衡），请注意它仅支持在设备中以只读模式安装。

该函数的参数如下：

1. partition - 分区的名称，需要在分区表中定义（如 storage/fatfsgen/partitions_example.csv）。

2. base_dir - 目录名称，该目录会被编码为 FatFs 分区，也可以选择将其被烧录进设备。但注意必须在分区表中指定合适的分区大小。

3. FLASH_IN_PROJECT 标志 - 可选参数，用户可以通过指定 FLASH_IN_PROJECT，选择在执行 idf.py flash -p <PORT> 时让分区镜像自动与应用程序二进制文件、分区表等一同烧录进设备。

4. PRESERVE_TIME 标志 - 可选参数，用户可强制让目标镜像保留源文件夹的时间戳。如果不保留，每个目标镜像的时间戳都将设置为 FATFS 默认初始时间（1980 年 1 月 1 日）。

例如:

fatfs_create_partition_image(my_fatfs_partition my_folder FLASH_IN_PROJECT)

没有指定 FLASH_IN_PROJECT 时也可以生成分区镜像，但是用户需要使用 esptool.py 或自定义的构建系统目标对其手动烧录。

相关示例请查看 storage/fatfsgen。

FatFs 分区分析器

我们为 FatFs 提供分区分析器 (fatfsparse.py)。

该分析器为 FatFs 分区生成器 (fatfsgen.py) 的逆向工具，可以根据 FatFs 镜像在主机上生成文件夹结构。

可以使用:

./fatfsparse.py [-h] [--wl-layer {detect,enabled,disabled}] fatfs_image.img

高级 API 参考

Header File

• components/fatfs/vfs/esp_vfs_fat.h

• This header file can be included with:

#include "esp_vfs_fat.h"

• This header file is a part of the API provided by the fatfs component. To declare that your component depends on fatfs, add the following to your CMakeLists.txt:

REQUIRES fatfs

or

>     PRIV_REQUIRES fatfs

Functions

esp_err_t esp_vfs_fat_register(const char *base_path, const char *fat_drive, size_t max_files, FATFS **out_fs)

Register FATFS with VFS component.

This function registers given FAT drive in VFS, at the specified base path. If only one drive is used, fat_drive argument can be an empty string. Refer to FATFS library documentation on how to specify FAT drive. This function also allocates FATFS structure which should be used for f_mount call.

备注

This function doesn't mount the drive into FATFS, it just connects POSIX and C standard library IO function with FATFS. You need to mount desired drive into FATFS separately.

参数

• base_path -- path prefix where FATFS should be registered

• fat_drive -- FATFS drive specification; if only one drive is used, can be an empty string

• max_files -- maximum number of files which can be open at the same time

• out_fs -- [out] pointer to FATFS structure which can be used for FATFS f_mount call is returned via this argument.

返回

• ESP_OK on success

• ESP_ERR_INVALID_STATE if esp_vfs_fat_register was already called

• ESP_ERR_NO_MEM if not enough memory or too many VFSes already registered

esp_err_t esp_vfs_fat_unregister_path(const char *base_path)

Un-register FATFS from VFS.

备注

FATFS structure returned by esp_vfs_fat_register is destroyed after this call. Make sure to call f_mount function to unmount it before calling esp_vfs_fat_unregister_ctx. Difference between this function and the one above is that this one will release the correct drive, while the one above will release the last registered one

参数

base_path -- path prefix where FATFS is registered. This is the same used when esp_vfs_fat_register was called

返回

• ESP_OK on success

• ESP_ERR_INVALID_STATE if FATFS is not registered in VFS

esp_err_t esp_vfs_fat_sdmmc_mount(const char *base_path, const sdmmc_host_t *host_config, const void *slot_config, const esp_vfs_fat_mount_config_t *mount_config, sdmmc_card_t **out_card)

Convenience function to get FAT filesystem on SD card registered in VFS.

This is an all-in-one function which does the following:

• initializes SDMMC driver or SPI driver with configuration in host_config

• initializes SD card with configuration in slot_config

• mounts FAT partition on SD card using FATFS library, with configuration in mount_config

• registers FATFS library with VFS, with prefix given by base_prefix variable

This function is intended to make example code more compact. For real world applications, developers should implement the logic of probing SD card, locating and mounting partition, and registering FATFS in VFS, with proper error checking and handling of exceptional conditions.

备注

Use this API to mount a card through SDSPI is deprecated. Please call esp_vfs_fat_sdspi_mount() instead for that case.

参数

• base_path -- path where partition should be registered (e.g. "/sdcard")

• host_config -- Pointer to structure describing SDMMC host. When using SDMMC peripheral, this structure can be initialized using SDMMC_HOST_DEFAULT() macro. When using SPI peripheral, this structure can be initialized using SDSPI_HOST_DEFAULT() macro.

• slot_config -- Pointer to structure with slot configuration. For SDMMC peripheral, pass a pointer to sdmmc_slot_config_t structure initialized using SDMMC_SLOT_CONFIG_DEFAULT.

• mount_config -- pointer to structure with extra parameters for mounting FATFS

• out_card -- [out] if not NULL, pointer to the card information structure will be returned via this argument

返回

• ESP_OK on success

• ESP_ERR_INVALID_STATE if esp_vfs_fat_sdmmc_mount was already called

• ESP_ERR_NO_MEM if memory can not be allocated

• ESP_FAIL if partition can not be mounted

• other error codes from SDMMC or SPI drivers, SDMMC protocol, or FATFS drivers

esp_err_t esp_vfs_fat_sdspi_mount(const char *base_path, const sdmmc_host_t *host_config_input, const sdspi_device_config_t *slot_config, const esp_vfs_fat_mount_config_t *mount_config, sdmmc_card_t **out_card)

Convenience function to get FAT filesystem on SD card registered in VFS.

This is an all-in-one function which does the following:

• initializes an SPI Master device based on the SPI Master driver with configuration in slot_config, and attach it to an initialized SPI bus.

• initializes SD card with configuration in host_config_input

• mounts FAT partition on SD card using FATFS library, with configuration in mount_config

• registers FATFS library with VFS, with prefix given by base_prefix variable

This function is intended to make example code more compact. For real world applications, developers should implement the logic of probing SD card, locating and mounting partition, and registering FATFS in VFS, with proper error checking and handling of exceptional conditions.

备注

This function try to attach the new SD SPI device to the bus specified in host_config. Make sure the SPI bus specified in host_config->slot have been initialized by spi_bus_initialize() before.

参数

• base_path -- path where partition should be registered (e.g. "/sdcard")

• host_config_input -- Pointer to structure describing SDMMC host. This structure can be initialized using SDSPI_HOST_DEFAULT() macro.

• slot_config -- Pointer to structure with slot configuration. For SPI peripheral, pass a pointer to sdspi_device_config_t structure initialized using SDSPI_DEVICE_CONFIG_DEFAULT().

• mount_config -- pointer to structure with extra parameters for mounting FATFS

• out_card -- [out] If not NULL, pointer to the card information structure will be returned via this argument. It is suggested to hold this handle and use it to unmount the card later if needed. Otherwise it's not suggested to use more than one card at the same time and unmount one of them in your application.

返回

• ESP_OK on success

• ESP_ERR_INVALID_STATE if esp_vfs_fat_sdmmc_mount was already called

• ESP_ERR_NO_MEM if memory can not be allocated

• ESP_FAIL if partition can not be mounted

• other error codes from SDMMC or SPI drivers, SDMMC protocol, or FATFS drivers

esp_err_t esp_vfs_fat_sdmmc_unmount(void)

Unmount FAT filesystem and release resources acquired using esp_vfs_fat_sdmmc_mount.

Deprecated:

Use esp_vfs_fat_sdcard_unmount() instead.

返回

• ESP_OK on success

• ESP_ERR_INVALID_STATE if esp_vfs_fat_sdmmc_mount hasn't been called

esp_err_t esp_vfs_fat_sdcard_unmount(const char *base_path, sdmmc_card_t *card)

Unmount an SD card from the FAT filesystem and release resources acquired using esp_vfs_fat_sdmmc_mount() or esp_vfs_fat_sdspi_mount()

返回

• ESP_OK on success

• ESP_ERR_INVALID_ARG if the card argument is unregistered

• ESP_ERR_INVALID_STATE if esp_vfs_fat_sdmmc_mount hasn't been called

esp_err_t esp_vfs_fat_sdcard_format(const char *base_path, sdmmc_card_t *card)

Format FAT filesystem.

备注

This API should be only called when the FAT is already mounted.

参数

• base_path -- Path where partition should be registered (e.g. "/sdcard")

• card -- Pointer to the card handle, which should be initialised by calling esp_vfs_fat_sdspi_mount first

返回

• ESP_OK

• ESP_ERR_INVALID_STATE: FAT partition isn't mounted, call esp_vfs_fat_sdmmc_mount or esp_vfs_fat_sdspi_mount first

• ESP_ERR_NO_MEM: if memory can not be allocated

• ESP_FAIL: fail to format it, or fail to mount back

esp_err_t esp_vfs_fat_spiflash_mount_rw_wl(const char *base_path, const char *partition_label, const esp_vfs_fat_mount_config_t *mount_config, wl_handle_t *wl_handle)

Convenience function to initialize FAT filesystem in SPI flash and register it in VFS.

This is an all-in-one function which does the following:

• finds the partition with defined partition_label. Partition label should be configured in the partition table.

• initializes flash wear levelling library on top of the given partition

• mounts FAT partition using FATFS library on top of flash wear levelling library

• registers FATFS library with VFS, with prefix given by base_prefix variable

This function is intended to make example code more compact.

参数

• base_path -- path where FATFS partition should be mounted (e.g. "/spiflash")

• partition_label -- label of the partition which should be used

• mount_config -- pointer to structure with extra parameters for mounting FATFS

• wl_handle -- [out] wear levelling driver handle

返回

• ESP_OK on success

• ESP_ERR_NOT_FOUND if the partition table does not contain FATFS partition with given label

• ESP_ERR_INVALID_STATE if esp_vfs_fat_spiflash_mount_rw_wl was already called

• ESP_ERR_NO_MEM if memory can not be allocated

• ESP_FAIL if partition can not be mounted

• other error codes from wear levelling library, SPI flash driver, or FATFS drivers

esp_err_t esp_vfs_fat_spiflash_unmount_rw_wl(const char *base_path, wl_handle_t wl_handle)

Unmount FAT filesystem and release resources acquired using esp_vfs_fat_spiflash_mount_rw_wl.

参数

• base_path -- path where partition should be registered (e.g. "/spiflash")

• wl_handle -- wear levelling driver handle returned by esp_vfs_fat_spiflash_mount_rw_wl

返回

• ESP_OK on success

• ESP_ERR_INVALID_STATE if esp_vfs_fat_spiflash_mount_rw_wl hasn't been called

esp_err_t esp_vfs_fat_spiflash_format_rw_wl(const char *base_path, const char *partition_label)

Format FAT filesystem.

备注

This API can be called when the FAT is mounted / not mounted. If this API is called when the FAT isn't mounted (by calling esp_vfs_fat_spiflash_mount_rw_wl), this API will first mount the FAT then format it, then restore back to the original state.

参数

• base_path -- Path where partition should be registered (e.g. "/spiflash")

• partition_label -- Label of the partition which should be used

返回

• ESP_OK

• ESP_ERR_NO_MEM: if memory can not be allocated

• Other errors from esp_vfs_fat_spiflash_mount_rw_wl

esp_err_t esp_vfs_fat_spiflash_mount_ro(const char *base_path, const char *partition_label, const esp_vfs_fat_mount_config_t *mount_config)

Convenience function to initialize read-only FAT filesystem and register it in VFS.

This is an all-in-one function which does the following:

• finds the partition with defined partition_label. Partition label should be configured in the partition table.

• mounts FAT partition using FATFS library

• registers FATFS library with VFS, with prefix given by base_prefix variable

备注

Wear levelling is not used when FAT is mounted in read-only mode using this function.

参数

• base_path -- path where FATFS partition should be mounted (e.g. "/spiflash")

• partition_label -- label of the partition which should be used

• mount_config -- pointer to structure with extra parameters for mounting FATFS

返回

• ESP_OK on success

• ESP_ERR_NOT_FOUND if the partition table does not contain FATFS partition with given label

• ESP_ERR_INVALID_STATE if esp_vfs_fat_spiflash_mount_ro was already called for the same partition

• ESP_ERR_NO_MEM if memory can not be allocated

• ESP_FAIL if partition can not be mounted

• other error codes from SPI flash driver, or FATFS drivers

esp_err_t esp_vfs_fat_spiflash_unmount_ro(const char *base_path, const char *partition_label)

Unmount FAT filesystem and release resources acquired using esp_vfs_fat_spiflash_mount_ro.

参数

• base_path -- path where partition should be registered (e.g. "/spiflash")

• partition_label -- label of partition to be unmounted

返回

• ESP_OK on success

• ESP_ERR_INVALID_STATE if esp_vfs_fat_spiflash_mount_ro hasn't been called

esp_err_t esp_vfs_fat_info(const char *base_path, uint64_t *out_total_bytes, uint64_t *out_free_bytes)

Get information for FATFS partition.

参数

• base_path -- Base path of the partition examined (e.g. "/spiflash")

• out_total_bytes -- [out] Size of the file system

• out_free_bytes -- [out] Free bytes available in the file system

返回

• ESP_OK on success

• ESP_ERR_INVALID_STATE if partition not found

• ESP_FAIL if another FRESULT error (saved in errno)

Structures

struct esp_vfs_fat_mount_config_t

Configuration arguments for esp_vfs_fat_sdmmc_mount and esp_vfs_fat_spiflash_mount_rw_wl functions.

Public Members

bool format_if_mount_failed

If FAT partition can not be mounted, and this parameter is true, create partition table and format the filesystem.

int max_files

Max number of open files.

size_t allocation_unit_size

If format_if_mount_failed is set, and mount fails, format the card with given allocation unit size. Must be a power of 2, between sector size and 128 * sector size. For SD cards, sector size is always 512 bytes. For wear_levelling, sector size is determined by CONFIG_WL_SECTOR_SIZE option.

Using larger allocation unit size will result in higher read/write performance and higher overhead when storing small files.

Setting this field to 0 will result in allocation unit set to the sector size.

bool disk_status_check_enable

Enables real ff_disk_status function implementation for SD cards (ff_sdmmc_status). Possibly slows down IO performance.

Try to enable if you need to handle situations when SD cards are not unmounted properly before physical removal or you are experiencing issues with SD cards.

Doesn't do anything for other memory storage media.

Type Definitions

typedef esp_vfs_fat_mount_config_t esp_vfs_fat_sdmmc_mount_config_t