esp_vfs_fat_spiflash_mount_ro() function

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

Syntax

Show:

Summary

Declaration

Definition

from esp_vfs_fat.h:375

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);

Implemented in vfs_fat_spiflash.c:324

Arguments

Argument

Declared as

Description

base_path

const char*

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

partition_label

const char*

label of the partition which should be used

mount_config

const esp_vfs_fat_mount_config_t*

pointer to structure with extra parameters for mounting FATFS

Return value

- 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

Notes

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

Examples

esp_vfs_fat_spiflash_mount_ro() is referenced by 1 libraries and example projects:

References

from examples

esp_vfs_fat_spiflash_mount_ro() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle