xf_vfs.h

浏览该文件的文档.

 
/*
 * SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef __XF_VFS_H__
#define __XF_VFS_H__
 
/* ==================== [Includes] ========================================== */
 
#include <stdarg.h>
#include <errno.h>
 
#include "xf_vfs_ops.h"
#include "xf_vfs_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ==================== [Defines] =========================================== */
 
/* ==================== [Typedefs] ========================================== */
 
/* ==================== [Global Prototypes] ================================= */
 
xf_err_t xf_vfs_register(const char *base_path, const xf_vfs_t *vfs, void *ctx);
 
xf_err_t xf_vfs_register_fd_range(const xf_vfs_t *vfs, void *ctx, int min_fd, int max_fd);
 
xf_err_t xf_vfs_register_with_id(const xf_vfs_t *vfs, void *ctx, xf_vfs_id_t *vfs_id);
 
xf_err_t xf_vfs_unregister(const char *base_path);
 
xf_err_t xf_vfs_unregister_with_id(xf_vfs_id_t vfs_id);
 
xf_err_t xf_vfs_register_fd(xf_vfs_id_t vfs_id, int *fd);
 
xf_err_t xf_vfs_register_fd_with_local_fd(xf_vfs_id_t vfs_id, int local_fd, bool permanent, int *fd);
 
xf_err_t xf_vfs_unregister_fd(xf_vfs_id_t vfs_id, int fd);
 
/* 
    这些函数原本是系统调用，为了最大跨平台兼容性，现在直接调用。
 */
xf_vfs_ssize_t xf_vfs_write(int fd, const void *data, size_t size);
xf_vfs_off_t xf_vfs_lseek(int fd, xf_vfs_off_t size, int mode);
xf_vfs_ssize_t xf_vfs_read(int fd, void *dst, size_t size);
int xf_vfs_open(const char *path, int flags, int mode);
int xf_vfs_close(int fd);
int xf_vfs_fstat(int fd, xf_vfs_stat_t *st);
#define xf_vfs_fcntl(fd, cmd, arg) xf_vfs_fcntl_r((fd), (cmd), (arg))
int xf_vfs_fcntl_r(int fd, int cmd, int arg);
int xf_vfs_ioctl(int fd, int cmd, ...);
int xf_vfs_fsync(int fd);
 
#if XF_VFS_SUPPORT_DIR_IS_ENABLE
int xf_vfs_stat(const char *path, xf_vfs_stat_t *st);
int xf_vfs_link(const char *n1, const char *n2);
int xf_vfs_unlink(const char *path);
int xf_vfs_rename(const char *src, const char *dst);
int xf_vfs_utime(const char *path, const xf_vfs_utimbuf_t *times);
xf_vfs_dir_t *xf_vfs_opendir(const char *name);
xf_vfs_dirent_t *xf_vfs_readdir(xf_vfs_dir_t *pdir);
int xf_vfs_readdir_r(xf_vfs_dir_t *pdir, xf_vfs_dirent_t *entry, xf_vfs_dirent_t **out_dirent);
long xf_vfs_telldir(xf_vfs_dir_t *pdir);
void xf_vfs_seekdir(xf_vfs_dir_t *pdir, long loc);
void xf_vfs_rewinddir(xf_vfs_dir_t *pdir);
int xf_vfs_closedir(xf_vfs_dir_t *pdir);
int xf_vfs_mkdir(const char *name, xf_vfs_mode_t mode);
int xf_vfs_rmdir(const char *name);
int xf_vfs_access(const char *path, int amode);
int xf_vfs_truncate(const char *path, xf_vfs_off_t length);
int xf_vfs_ftruncate(int fd, xf_vfs_off_t length);
#endif
xf_vfs_ssize_t xf_vfs_pread(int fd, void *dst, size_t size, xf_vfs_off_t offset);
 
xf_vfs_ssize_t xf_vfs_pwrite(int fd, const void *src, size_t size, xf_vfs_off_t offset);
 
void xf_vfs_dump_fds(void);
 
void xf_vfs_dump_registered_paths(void);
 
#if XF_VFS_SUPPORT_SELECT_IS_ENABLE
 
int xf_vfs_select(int nfds, xf_fd_set *readfds, xf_fd_set *writefds, xf_fd_set *errorfds, xf_vfs_timeval_t *timeout);
 
void xf_vfs_select_triggered(xf_vfs_select_sem_t sem);
 
void xf_vfs_select_triggered_isr(xf_vfs_select_sem_t sem, int *woken);
 
#endif /* XF_VFS_SUPPORT_SELECT_IS_ENABLE */
 
/* ==================== [Macros] ============================================ */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* __XF_VFS_H__ */