Zephyr API Documentation  3.6.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
fs.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2016 Intel Corporation.
3 * Copyright (c) 2020-2024 Nordic Semiconductor ASA
4 *
5 * SPDX-License-Identifier: Apache-2.0
6 */
7
8#ifndef ZEPHYR_INCLUDE_FS_FS_H_
9#define ZEPHYR_INCLUDE_FS_FS_H_
10
11#include <sys/types.h>
12
13#include <zephyr/sys/dlist.h>
15
16#ifdef __cplusplus
17extern "C" {
18#endif
19
28struct fs_file_system_t;
29
38};
39
54enum {
57
60
63
66};
67
69#define FS_MOUNT_FLAG_NO_FORMAT BIT(0)
71#define FS_MOUNT_FLAG_READ_ONLY BIT(1)
77#define FS_MOUNT_FLAG_AUTOMOUNT BIT(2)
86#define FS_MOUNT_FLAG_USE_DISK_ACCESS BIT(3)
87
91struct fs_mount_t {
95 int type;
97 const char *mnt_point;
99 void *fs_data;
102 /* The following fields are filled by file system core */
106 const struct fs_file_system_t *fs;
109};
110
117struct fs_dirent {
125 size_t size;
126};
127
136 unsigned long f_bsize;
138 unsigned long f_frsize;
140 unsigned long f_blocks;
142 unsigned long f_bfree;
143};
144
145
151#define FS_O_READ 0x01
153#define FS_O_WRITE 0x02
155#define FS_O_RDWR (FS_O_READ | FS_O_WRITE)
157#define FS_O_MODE_MASK 0x03
158
160#define FS_O_CREATE 0x10
162#define FS_O_APPEND 0x20
164#define FS_O_FLAGS_MASK 0x30
165
167#define FS_O_MASK (FS_O_MODE_MASK | FS_O_FLAGS_MASK)
176#ifndef FS_SEEK_SET
178#define FS_SEEK_SET 0
179#endif
180#ifndef FS_SEEK_CUR
182#define FS_SEEK_CUR 1
183#endif
184#ifndef FS_SEEK_END
186#define FS_SEEK_END 2
187#endif
200#define FSTAB_ENTRY_DT_MOUNT_FLAGS(node_id) \
201 ((DT_PROP(node_id, automount) ? FS_MOUNT_FLAG_AUTOMOUNT : 0) \
202 | (DT_PROP(node_id, read_only) ? FS_MOUNT_FLAG_READ_ONLY : 0) \
203 | (DT_PROP(node_id, no_format) ? FS_MOUNT_FLAG_NO_FORMAT : 0) \
204 | (DT_PROP(node_id, disk_access) ? FS_MOUNT_FLAG_USE_DISK_ACCESS : 0))
205
212#define FS_FSTAB_ENTRY(node_id) _CONCAT(z_fsmp_, node_id)
213
222#define FS_FSTAB_DECLARE_ENTRY(node_id) \
223 extern struct fs_mount_t FS_FSTAB_ENTRY(node_id)
224
234static inline void fs_file_t_init(struct fs_file_t *zfp)
235{
236 zfp->filep = NULL;
237 zfp->mp = NULL;
238 zfp->flags = 0;
239}
240
250static inline void fs_dir_t_init(struct fs_dir_t *zdp)
251{
252 zdp->dirp = NULL;
253 zdp->mp = NULL;
254}
255
289int fs_open(struct fs_file_t *zfp, const char *file_name, fs_mode_t flags);
290
302int fs_close(struct fs_file_t *zfp);
303
318int fs_unlink(const char *path);
319
345int fs_rename(const char *from, const char *to);
346
363ssize_t fs_read(struct fs_file_t *zfp, void *ptr, size_t size);
364
384ssize_t fs_write(struct fs_file_t *zfp, const void *ptr, size_t size);
385
404int fs_seek(struct fs_file_t *zfp, off_t offset, int whence);
405
421
442int fs_truncate(struct fs_file_t *zfp, off_t length);
443
460int fs_sync(struct fs_file_t *zfp);
461
476int fs_mkdir(const char *path);
477
492int fs_opendir(struct fs_dir_t *zdp, const char *path);
493
513int fs_readdir(struct fs_dir_t *zdp, struct fs_dirent *entry);
514
526int fs_closedir(struct fs_dir_t *zdp);
527
555int fs_mount(struct fs_mount_t *mp);
556
571int fs_unmount(struct fs_mount_t *mp);
572
588int fs_readmount(int *index, const char **name);
589
606int fs_stat(const char *path, struct fs_dirent *entry);
607
622int fs_statvfs(const char *path, struct fs_statvfs *stat);
623
635int fs_mkfs(int fs_type, uintptr_t dev_id, void *cfg, int flags);
636
652int fs_register(int type, const struct fs_file_system_t *fs);
653
665int fs_unregister(int type, const struct fs_file_system_t *fs);
666
672#ifdef __cplusplus
673}
674#endif
675
676#endif /* ZEPHYR_INCLUDE_FS_FS_H_ */
uint8_t fs_mode_t
Definition: fs_interface.h:49
#define MAX_FILE_NAME
Definition: fs_interface.h:42
struct _dnode sys_dnode_t
Doubly-linked list node structure.
Definition: dlist.h:54
int fs_opendir(struct fs_dir_t *zdp, const char *path)
Directory open.
int fs_unregister(int type, const struct fs_file_system_t *fs)
Unregister a file system.
int fs_mkdir(const char *path)
Directory create.
int fs_rename(const char *from, const char *to)
Rename file or directory.
int fs_mount(struct fs_mount_t *mp)
Mount filesystem.
int fs_close(struct fs_file_t *zfp)
Close file.
off_t fs_tell(struct fs_file_t *zfp)
Get current file position.
fs_dir_entry_type
Enumeration for directory entry types.
Definition: fs.h:33
int fs_mkfs(int fs_type, uintptr_t dev_id, void *cfg, int flags)
Create fresh file system.
int fs_seek(struct fs_file_t *zfp, off_t offset, int whence)
Seek file.
int fs_stat(const char *path, struct fs_dirent *entry)
File or directory status.
int fs_register(int type, const struct fs_file_system_t *fs)
Register a file system.
int fs_open(struct fs_file_t *zfp, const char *file_name, fs_mode_t flags)
Open or create file.
ssize_t fs_write(struct fs_file_t *zfp, const void *ptr, size_t size)
Write file.
int fs_closedir(struct fs_dir_t *zdp)
Directory close.
int fs_readmount(int *index, const char **name)
Get path of mount point at index.
int fs_readdir(struct fs_dir_t *zdp, struct fs_dirent *entry)
Directory read entry.
int fs_unlink(const char *path)
Unlink file.
ssize_t fs_read(struct fs_file_t *zfp, void *ptr, size_t size)
Read file.
int fs_unmount(struct fs_mount_t *mp)
Unmount filesystem.
int fs_sync(struct fs_file_t *zfp)
Flush cached write data buffers of an open file.
static void fs_dir_t_init(struct fs_dir_t *zdp)
Initialize fs_dir_t object.
Definition: fs.h:250
static void fs_file_t_init(struct fs_file_t *zfp)
Initialize fs_file_t object.
Definition: fs.h:234
int fs_truncate(struct fs_file_t *zfp, off_t length)
Truncate or extend an open file to a given size.
@ FS_DIR_ENTRY_DIR
Identifier for directory entry.
Definition: fs.h:37
@ FS_DIR_ENTRY_FILE
Identifier for file entry.
Definition: fs.h:35
@ FS_EXT2
Identifier for in-tree Ext2 file system.
Definition: fs.h:62
@ FS_LITTLEFS
Identifier for in-tree LittleFS file system.
Definition: fs.h:59
@ FS_TYPE_EXTERNAL_BASE
Base identifier for external file systems.
Definition: fs.h:65
@ FS_FATFS
Identifier for in-tree FatFS file system.
Definition: fs.h:56
__SIZE_TYPE__ ssize_t
Definition: types.h:28
__INTPTR_TYPE__ off_t
Definition: types.h:36
flags
Definition: parser.h:96
__UINT8_TYPE__ uint8_t
Definition: stdint.h:88
__UINTPTR_TYPE__ uintptr_t
Definition: stdint.h:105
Directory object representing an open directory.
Definition: fs_interface.h:77
const struct fs_mount_t * mp
Pointer to mount point structure.
Definition: fs_interface.h:81
void * dirp
Pointer to directory object structure.
Definition: fs_interface.h:79
Structure to receive file or directory information.
Definition: fs.h:117
enum fs_dir_entry_type type
File/directory type (FS_DIR_ENTRY_FILE or FS_DIR_ENTRY_DIR)
Definition: fs.h:121
size_t size
Size of file (0 if directory).
Definition: fs.h:125
char name[MAX_FILE_NAME+1]
Name of file or directory.
Definition: fs.h:123
File System interface structure.
Definition: fs_sys.h:22
File object representing an open file.
Definition: fs_interface.h:63
fs_mode_t flags
Open/create flags.
Definition: fs_interface.h:69
void * filep
Pointer to file object structure.
Definition: fs_interface.h:65
const struct fs_mount_t * mp
Pointer to mount point structure.
Definition: fs_interface.h:67
File system mount info structure.
Definition: fs.h:91
const struct fs_file_system_t * fs
Pointer to File system interface of the mount point.
Definition: fs.h:106
const char * mnt_point
Mount point directory name (ex: "/fatfs")
Definition: fs.h:97
void * storage_dev
Pointer to backend storage device.
Definition: fs.h:101
void * fs_data
Pointer to file system specific data.
Definition: fs.h:99
int type
File system type.
Definition: fs.h:95
size_t mountp_len
Length of Mount point string.
Definition: fs.h:104
uint8_t flags
Mount flags.
Definition: fs.h:108
sys_dnode_t node
Entry for the fs_mount_list list.
Definition: fs.h:93
Structure to receive volume statistics.
Definition: fs.h:134
unsigned long f_bsize
Optimal transfer block size.
Definition: fs.h:136
unsigned long f_frsize
Allocation unit size.
Definition: fs.h:138
unsigned long f_blocks
Size of FS in f_frsize units.
Definition: fs.h:140
unsigned long f_bfree
Number of free blocks.
Definition: fs.h:142
Definition: stat.h:92