ESP-IDF
Select one of the symbols to view example projects that use it.
 
Outline
#include "sdkconfig.h"
#include "esp_vfs.h"
#include "esp_vfs_common.h"
#define VFS_MALLOC_FLAGS
#define VFS_MALLOC_FLAGS
vfs_entry_
esp_vfs_register_common(const char *, size_t, const esp_vfs_t *, void *, int *);
get_vfs_for_path(const char *);
get_vfs_for_index(int);
Files
loading...
SourceVuESP-IDF Framework and ExamplesESP-IDFcomponents/vfs/private_include/esp_vfs_private.h
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/* * SPDX-FileCopyrightText: 2015-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 *//* ... */ #include "sdkconfig.h" #include "esp_vfs.h" #include "esp_vfs_common.h" #ifdef __cplusplus extern "C" { #endif #if CONFIG_VFS_SELECT_IN_RAM #define VFS_MALLOC_FLAGS (MALLOC_CAP_INTERNAL | MALLOC_CAP_8BIT) #else #define VFS_MALLOC_FLAGS MALLOC_CAP_DEFAULT #endif typedef struct vfs_entry_ { int flags; /*!< ESP_VFS_FLAG_CONTEXT_PTR and/or ESP_VFS_FLAG_READONLY_FS or ESP_VFS_FLAG_DEFAULT */ const esp_vfs_fs_ops_t *vfs; // contains pointers to VFS functions char path_prefix[ESP_VFS_PATH_MAX]; // path prefix mapped to this VFS size_t path_prefix_len; // micro-optimization to avoid doing extra strlen void* ctx; // optional pointer which can be passed to VFS int offset; // index of this structure in s_vfs array }{ ... } vfs_entry_t; /** * Register a virtual filesystem. * * @param base_path file path prefix associated with the filesystem. * Must be a zero-terminated C string, may be empty. * If not empty, must be up to ESP_VFS_PATH_MAX * characters long, and at least 2 characters long. * Name must start with a "/" and must not end with "/". * For example, "/data" or "/dev/spi" are valid. * These VFSes would then be called to handle file paths such as * "/data/myfile.txt" or "/dev/spi/0". * In the special case of an empty base_path, a "fallback" * VFS is registered. Such VFS will handle paths which are not * matched by any other registered VFS. * @param len Length of the base_path. * @param vfs Pointer to esp_vfs_t, a structure which maps syscalls to * the filesystem driver functions. VFS component doesn't * assume ownership of this pointer. * @param ctx If vfs->flags has ESP_VFS_FLAG_CONTEXT_PTR set, a pointer * which should be passed to VFS functions. Otherwise, NULL. * @param vfs_index Index for getting the vfs content. * * @return ESP_OK if successful. * ESP_ERR_NO_MEM if too many VFSes are registered. * ESP_ERR_INVALID_ARG if given an invalid parameter. *//* ... */ esp_err_t esp_vfs_register_common(const char *base_path, size_t len, const esp_vfs_t* vfs, void* ctx, int *vfs_index); /** * Get vfs fd with given path. * * @param path file path prefix associated with the filesystem. * * @return Pointer to the `vfs_entry_t` corresponding to the given path, which cannot be NULL. *//* ... */ const vfs_entry_t *get_vfs_for_path(const char *path); /** * Get vfs fd with given vfs index. * * @param index VFS index. * * @return Pointer to the `vfs_entry_t` corresponding to the given path, which cannot be NULL. *//* ... */ const vfs_entry_t *get_vfs_for_index(int index); #ifdef __cplusplus }{...} #endif
Details
Show:
from
Types: Columns: