xf_vfs_ops.h

浏览该文件的文档.

 
/*
 * SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef __XF_VFS_OPS_H__
#define __XF_VFS_OPS_H__
 
/* ==================== [Includes] ========================================== */
 
#include "xf_vfs_config_internal.h"
 
#include "xf_vfs_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ==================== [Defines] =========================================== */
 
/* ==================== [Typedefs] ========================================== */
 
#if XF_VFS_SUPPORT_DIR_IS_ENABLE
/* *INDENT-OFF* */
 
typedef              int (*xf_vfs_stat_ctx_op_t)      (void *ctx, const char *path, xf_vfs_stat_t *st);                 
typedef              int (*xf_vfs_stat_op_t)          (           const char *path, xf_vfs_stat_t *st);                 
typedef              int (*xf_vfs_link_ctx_op_t)      (void *ctx, const char *n1, const char *n2);                      
typedef              int (*xf_vfs_link_op_t)          (           const char *n1, const char *n2);                      
typedef              int (*xf_vfs_unlink_ctx_op_t)    (void *ctx, const char *path);                                    
typedef              int (*xf_vfs_unlink_op_t)        (           const char *path);                                    
typedef              int (*xf_vfs_rename_ctx_op_t)    (void *ctx, const char *src, const char *dst);                    
typedef              int (*xf_vfs_rename_op_t)        (           const char *src, const char *dst);                    
typedef    xf_vfs_dir_t* (*xf_vfs_opendir_ctx_op_t)   (void *ctx, const char *name);                                    
typedef    xf_vfs_dir_t* (*xf_vfs_opendir_op_t)       (           const char *name);                                    
typedef xf_vfs_dirent_t* (*xf_vfs_readdir_ctx_op_t)   (void *ctx, xf_vfs_dir_t *pdir);                                  
typedef xf_vfs_dirent_t* (*xf_vfs_readdir_op_t)       (           xf_vfs_dir_t *pdir);                                  
typedef              int (*xf_vfs_readdir_r_ctx_op_t) (void *ctx, xf_vfs_dir_t *pdir, xf_vfs_dirent_t *entry, xf_vfs_dirent_t **out); 
typedef              int (*xf_vfs_readdir_r_op_t)     (           xf_vfs_dir_t *pdir, xf_vfs_dirent_t *entry, xf_vfs_dirent_t **out); 
typedef             long (*xf_vfs_telldir_ctx_op_t)   (void *ctx, xf_vfs_dir_t *pdir);                                  
typedef             long (*xf_vfs_telldir_op_t)       (           xf_vfs_dir_t *pdir);                                  
typedef             void (*xf_vfs_seekdir_ctx_op_t)   (void *ctx, xf_vfs_dir_t *pdir, long offset);                     
typedef             void (*xf_vfs_seekdir_op_t)       (           xf_vfs_dir_t *pdir, long offset);                     
typedef              int (*xf_vfs_closedir_ctx_op_t)  (void *ctx, xf_vfs_dir_t *pdir);                                  
typedef              int (*xf_vfs_closedir_op_t)      (           xf_vfs_dir_t *pdir);                                  
typedef              int (*xf_vfs_mkdir_ctx_op_t)     (void *ctx, const char *name, xf_vfs_mode_t mode);                
typedef              int (*xf_vfs_mkdir_op_t)         (           const char *name, xf_vfs_mode_t mode);                
typedef              int (*xf_vfs_rmdir_ctx_op_t)     (void *ctx, const char *name);                                    
typedef              int (*xf_vfs_rmdir_op_t)         (           const char *name);                                    
typedef              int (*xf_vfs_access_ctx_op_t)    (void *ctx, const char *path, int amode);                         
typedef              int (*xf_vfs_access_op_t)        (           const char *path, int amode);                         
typedef              int (*xf_vfs_truncate_ctx_op_t)  (void *ctx, const char *path, xf_vfs_off_t length);               
typedef              int (*xf_vfs_truncate_op_t)      (           const char *path, xf_vfs_off_t length);               
typedef              int (*xf_vfs_ftruncate_ctx_op_t) (void *ctx, int fd, xf_vfs_off_t length);                         
typedef              int (*xf_vfs_ftruncate_op_t)     (           int fd, xf_vfs_off_t length);                         
typedef              int (*xf_vfs_utime_ctx_op_t)     (void *ctx, const char *path, const xf_vfs_utimbuf_t *times);     
typedef              int (*xf_vfs_utime_op_t)         (           const char *path, const xf_vfs_utimbuf_t *times);     
typedef struct {
    union {
        const xf_vfs_stat_ctx_op_t      stat_p;      
        const xf_vfs_stat_op_t          stat;        
    };
    union {
        const xf_vfs_link_ctx_op_t      link_p;      
        const xf_vfs_link_op_t          link;        
    };
    union {
        const xf_vfs_unlink_ctx_op_t    unlink_p;    
        const xf_vfs_unlink_op_t        unlink;      
    };
    union {
        const xf_vfs_rename_ctx_op_t    rename_p;    
        const xf_vfs_rename_op_t        rename;      
    };
    union {
        const xf_vfs_opendir_ctx_op_t   opendir_p;   
        const xf_vfs_opendir_op_t       opendir;     
    };
    union {
        const xf_vfs_readdir_ctx_op_t   readdir_p;   
        const xf_vfs_readdir_op_t       readdir;     
    };
    union {
        const xf_vfs_readdir_r_ctx_op_t readdir_r_p; 
        const xf_vfs_readdir_r_op_t     readdir_r;   
    };
    union {
        const xf_vfs_telldir_ctx_op_t   telldir_p;   
        const xf_vfs_telldir_op_t       telldir;     
    };
    union {
        const xf_vfs_seekdir_ctx_op_t   seekdir_p;   
        const xf_vfs_seekdir_op_t       seekdir;     
    };
    union {
        const xf_vfs_closedir_ctx_op_t  closedir_p;  
        const xf_vfs_closedir_op_t      closedir;    
    };
    union {
        const xf_vfs_mkdir_ctx_op_t     mkdir_p;     
        const xf_vfs_mkdir_op_t         mkdir;       
    };
    union {
        const xf_vfs_rmdir_ctx_op_t     rmdir_p;     
        const xf_vfs_rmdir_op_t         rmdir;       
    };
    union {
        const xf_vfs_access_ctx_op_t    access_p;    
        const xf_vfs_access_op_t        access;      
    };
    union {
        const xf_vfs_truncate_ctx_op_t  truncate_p;  
        const xf_vfs_truncate_op_t      truncate;    
    };
    union {
        const xf_vfs_ftruncate_ctx_op_t ftruncate_p; 
        const xf_vfs_ftruncate_op_t     ftruncate;   
    };
    union {
        const xf_vfs_utime_ctx_op_t     utime_p;     
        const xf_vfs_utime_op_t         utime;       
    };
} xf_vfs_dir_ops_t;
 
/* *INDENT-ON* */
#endif // CONFIG_XF_VFS_SUPPORT_DIR
 
/* *INDENT-OFF* */
 
typedef xf_vfs_ssize_t (*xf_vfs_write_ctx_op_t)  (void *ctx, int fd, const void *data, size_t size);                
typedef xf_vfs_ssize_t (*xf_vfs_write_op_t)      (           int fd, const void *data, size_t size);                
typedef   xf_vfs_off_t (*xf_vfs_lseek_ctx_op_t)  (void *ctx, int fd, xf_vfs_off_t size, int mode);                  
typedef   xf_vfs_off_t (*xf_vfs_lseek_op_t)      (           int fd, xf_vfs_off_t size, int mode);                  
typedef xf_vfs_ssize_t (*xf_vfs_read_ctx_op_t)   (void *ctx, int fd, void *dst, size_t size);                       
typedef xf_vfs_ssize_t (*xf_vfs_read_op_t)       (           int fd, void *dst, size_t size);                       
typedef xf_vfs_ssize_t (*xf_vfs_pread_ctx_op_t)  (void *ctx, int fd, void *dst, size_t size, xf_vfs_off_t offset);       
typedef xf_vfs_ssize_t (*xf_vfs_pread_op_t)      (           int fd, void *dst, size_t size, xf_vfs_off_t offset);       
typedef xf_vfs_ssize_t (*xf_vfs_pwrite_ctx_op_t) (void *ctx, int fd, const void *src, size_t size, xf_vfs_off_t offset); 
typedef xf_vfs_ssize_t (*xf_vfs_pwrite_op_t)     (           int fd, const void *src, size_t size, xf_vfs_off_t offset); 
typedef            int (*xf_vfs_open_ctx_op_t)   (void *ctx, const char *path, int flags, int mode);                
typedef            int (*xf_vfs_open_op_t)       (           const char *path, int flags, int mode);                
typedef            int (*xf_vfs_close_ctx_op_t)  (void *ctx, int fd);                                               
typedef            int (*xf_vfs_close_op_t)      (           int fd);                                               
typedef            int (*xf_vfs_fstat_ctx_op_t)  (void *ctx, int fd, xf_vfs_stat_t *st);                            
typedef            int (*xf_vfs_fstat_op_t)      (           int fd, xf_vfs_stat_t *st);                            
typedef            int (*xf_vfs_fcntl_ctx_op_t)  (void *ctx, int fd, int cmd, int arg);                             
typedef            int (*xf_vfs_fcntl_op_t)      (           int fd, int cmd, int arg);                             
typedef            int (*xf_vfs_ioctl_ctx_op_t)  (void *ctx, int fd, int cmd, va_list args);                        
typedef            int (*xf_vfs_ioctl_op_t)      (           int fd, int cmd, va_list args);                        
typedef            int (*xf_vfs_fsync_ctx_op_t)  (void *ctx, int fd);                                               
typedef            int (*xf_vfs_fsync_op_t)      (           int fd);                                               
typedef struct {
    union {
        const xf_vfs_write_ctx_op_t  write_p;  
        const xf_vfs_write_op_t      write;    
    };
    union {
        const xf_vfs_lseek_ctx_op_t  lseek_p;  
        const xf_vfs_lseek_op_t      lseek;    
    };
    union {
        const xf_vfs_read_ctx_op_t   read_p;   
        const xf_vfs_read_op_t       read;     
    };
    union {
        const xf_vfs_pread_ctx_op_t  pread_p;  
        const xf_vfs_pread_op_t      pread;    
    };
    union {
        const xf_vfs_pwrite_ctx_op_t pwrite_p; 
        const xf_vfs_pwrite_op_t     pwrite;   
    };
    union {
        const xf_vfs_open_ctx_op_t   open_p;   
        const xf_vfs_open_op_t       open;     
    };
    union {
        const xf_vfs_close_ctx_op_t  close_p;  
        const xf_vfs_close_op_t      close;    
    };
    union {
        const xf_vfs_fstat_ctx_op_t  fstat_p;  
        const xf_vfs_fstat_op_t      fstat;    
    };
    union {
        const xf_vfs_fcntl_ctx_op_t  fcntl_p;  
        const xf_vfs_fcntl_op_t      fcntl;    
    };
    union {
        const xf_vfs_ioctl_ctx_op_t  ioctl_p;  
        const xf_vfs_ioctl_op_t      ioctl;    
    };
    union {
        const xf_vfs_fsync_ctx_op_t  fsync_p;  
        const xf_vfs_fsync_op_t      fsync;    
    };
 
#if XF_VFS_SUPPORT_DIR_IS_ENABLE
    const xf_vfs_dir_ops_t *const dir;         
#endif
 
#if XF_VFS_SUPPORT_SELECT_IS_ENABLE || defined __DOXYGEN__
    const xf_vfs_select_ops_t *const select;   
#endif
 
} xf_vfs_fs_ops_t;
 
/* *INDENT-ON* */
 
/* ==================== [Global Prototypes] ================================= */
 
xf_err_t xf_vfs_register_fs(const char *base_path, const xf_vfs_fs_ops_t *vfs, int flags, void *ctx);
 
xf_err_t xf_vfs_register_fs_with_id(const xf_vfs_fs_ops_t *vfs, int flags, void *ctx, xf_vfs_id_t *id);
 
xf_err_t xf_vfs_unregister_fs(const char *base_path);
 
xf_err_t xf_vfs_unregister_fs_with_id(xf_vfs_id_t id);
 
/* ==================== [Macros] ============================================ */
 
#ifdef __cplusplus
} /* extern "C" */
#endif
 
#endif /* __XF_VFS_OPS_H__ */