Zephyr Project API 4.2.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
39
54enum {
57
60
63
66
69};
70
72#define FS_MOUNT_FLAG_NO_FORMAT BIT(0)
74#define FS_MOUNT_FLAG_READ_ONLY BIT(1)
80#define FS_MOUNT_FLAG_AUTOMOUNT BIT(2)
89#define FS_MOUNT_FLAG_USE_DISK_ACCESS BIT(3)
90
94struct fs_mount_t {
98 int type;
100 const char *mnt_point;
102 void *fs_data;
105 /* The following fields are filled by file system core */
109 const struct fs_file_system_t *fs;
112};
113
120struct fs_dirent {
128 size_t size;
129};
130
139 unsigned long f_bsize;
141 unsigned long f_frsize;
143 unsigned long f_blocks;
145 unsigned long f_bfree;
146};
147
148
154#define FS_O_READ 0x01
156#define FS_O_WRITE 0x02
158#define FS_O_RDWR (FS_O_READ | FS_O_WRITE)
160#define FS_O_MODE_MASK 0x03
161
163#define FS_O_CREATE 0x10
165#define FS_O_APPEND 0x20
167#define FS_O_TRUNC 0x40
169#define FS_O_FLAGS_MASK 0x70
170
171
173#define FS_O_MASK (FS_O_MODE_MASK | FS_O_FLAGS_MASK)
182#ifndef FS_SEEK_SET
184#define FS_SEEK_SET 0
185#endif
186#ifndef FS_SEEK_CUR
188#define FS_SEEK_CUR 1
189#endif
190#ifndef FS_SEEK_END
192#define FS_SEEK_END 2
193#endif
206#define FSTAB_ENTRY_DT_MOUNT_FLAGS(node_id) \
207 ((DT_PROP(node_id, automount) ? FS_MOUNT_FLAG_AUTOMOUNT : 0) \
208 | (DT_PROP(node_id, read_only) ? FS_MOUNT_FLAG_READ_ONLY : 0) \
209 | (DT_PROP(node_id, no_format) ? FS_MOUNT_FLAG_NO_FORMAT : 0) \
210 | (DT_PROP(node_id, disk_access) ? FS_MOUNT_FLAG_USE_DISK_ACCESS : 0))
211
218#define FS_FSTAB_ENTRY(node_id) _CONCAT(z_fsmp_, node_id)
219
228#define FS_FSTAB_DECLARE_ENTRY(node_id) \
229 extern struct fs_mount_t FS_FSTAB_ENTRY(node_id)
230
240static inline void fs_file_t_init(struct fs_file_t *zfp)
241{
242 zfp->filep = NULL;
243 zfp->mp = NULL;
244 zfp->flags = 0;
245}
246
256static inline void fs_dir_t_init(struct fs_dir_t *zdp)
257{
258 zdp->dirp = NULL;
259 zdp->mp = NULL;
260}
261
297int fs_open(struct fs_file_t *zfp, const char *file_name, fs_mode_t flags);
298
310int fs_close(struct fs_file_t *zfp);
311
326int fs_unlink(const char *path);
327
353int fs_rename(const char *from, const char *to);
354
371ssize_t fs_read(struct fs_file_t *zfp, void *ptr, size_t size);
372
392ssize_t fs_write(struct fs_file_t *zfp, const void *ptr, size_t size);
393
412int fs_seek(struct fs_file_t *zfp, off_t offset, int whence);
413
429
450int fs_truncate(struct fs_file_t *zfp, off_t length);
451
468int fs_sync(struct fs_file_t *zfp);
469
484int fs_mkdir(const char *path);
485
500int fs_opendir(struct fs_dir_t *zdp, const char *path);
501
521int fs_readdir(struct fs_dir_t *zdp, struct fs_dirent *entry);
522
534int fs_closedir(struct fs_dir_t *zdp);
535
563int fs_mount(struct fs_mount_t *mp);
564
579int fs_unmount(struct fs_mount_t *mp);
580
596int fs_readmount(int *index, const char **name);
597
614int fs_stat(const char *path, struct fs_dirent *entry);
615
630int fs_statvfs(const char *path, struct fs_statvfs *stat);
631
643int fs_mkfs(int fs_type, uintptr_t dev_id, void *cfg, int flags);
644
660int fs_register(int type, const struct fs_file_system_t *fs);
661
673int fs_unregister(int type, const struct fs_file_system_t *fs);
674
680#ifdef __cplusplus
681}
682#endif
683
684#endif /* ZEPHYR_INCLUDE_FS_FS_H_ */
uint8_t fs_mode_t
Definition fs_interface.h:66
#define MAX_FILE_NAME
Definition fs_interface.h:59
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:256
static void fs_file_t_init(struct fs_file_t *zfp)
Initialize fs_file_t object.
Definition fs.h:240
int fs_truncate(struct fs_file_t *zfp, off_t length)
Truncate or extend an open file to a given size.
@ 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_VIRTIOFS
Identifier for in-tree Virtiofs file system.
Definition fs.h:65
@ FS_TYPE_EXTERNAL_BASE
Base identifier for external file systems.
Definition fs.h:68
@ FS_FATFS
Identifier for in-tree FatFS file system.
Definition fs.h:56
@ FS_DIR_ENTRY_DIR
Identifier for directory entry.
Definition fs.h:37
@ FS_DIR_ENTRY_FILE
Identifier for file entry.
Definition fs.h:35
#define NULL
Definition iar_missing_defs.h:20
__SIZE_TYPE__ ssize_t
Definition types.h:28
__INTPTR_TYPE__ off_t
Definition types.h:36
flags
Definition parser.h:97
__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:94
const struct fs_mount_t * mp
Pointer to mount point structure.
Definition fs_interface.h:98
void * dirp
Pointer to directory object structure.
Definition fs_interface.h:96
Structure to receive file or directory information.
Definition fs.h:120
enum fs_dir_entry_type type
File/directory type (FS_DIR_ENTRY_FILE or FS_DIR_ENTRY_DIR)
Definition fs.h:124
size_t size
Size of file (0 if directory).
Definition fs.h:128
char name[MAX_FILE_NAME+1]
Name of file or directory.
Definition fs.h:126
File System interface structure.
Definition fs_sys.h:22
File object representing an open file.
Definition fs_interface.h:80
fs_mode_t flags
Open/create flags.
Definition fs_interface.h:86
void * filep
Pointer to file object structure.
Definition fs_interface.h:82
const struct fs_mount_t * mp
Pointer to mount point structure.
Definition fs_interface.h:84
File system mount info structure.
Definition fs.h:94
const struct fs_file_system_t * fs
Pointer to File system interface of the mount point.
Definition fs.h:109
const char * mnt_point
Mount point directory name (ex: "/fatfs")
Definition fs.h:100
void * storage_dev
Pointer to backend storage device.
Definition fs.h:104
void * fs_data
Pointer to file system specific data.
Definition fs.h:102
int type
File system type.
Definition fs.h:98
size_t mountp_len
Length of Mount point string.
Definition fs.h:107
uint8_t flags
Mount flags.
Definition fs.h:111
sys_dnode_t node
Entry for the fs_mount_list list.
Definition fs.h:96
Structure to receive volume statistics.
Definition fs.h:137
unsigned long f_bsize
Optimal transfer block size.
Definition fs.h:139
unsigned long f_frsize
Allocation unit size.
Definition fs.h:141
unsigned long f_blocks
Size of FS in f_frsize units.
Definition fs.h:143
unsigned long f_bfree
Number of free blocks.
Definition fs.h:145
Definition stat.h:57