direct/yaffsfs.h

   1 /*
   2  * YAFFS: Yet another Flash File System . A NAND-flash specific file system.
   3  *
   4  * Copyright (C) 2002-2011 Aleph One Ltd.
   5  *   for Toby Churchill Ltd and Brightstar Engineering
   6  *
   7  * Created by Charles Manning <charles@aleph1.co.uk>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU Lesser General Public License version 2.1 as
  11  * published by the Free Software Foundation.
  12  *
  13  * Note: Only YAFFS headers are LGPL, YAFFS C code is covered by GPL.
  14  */
  15
  16 /*
  17  * Header file for using yaffs in an application via
  18  * a direct interface.
  19  */
  20
  21
  22 #ifndef __YAFFSFS_H__
  23 #define __YAFFSFS_H__
  24
  25 #include "yaffscfg.h"
  26 #include "yportenv.h"
  27
  28
  29 #ifndef NAME_MAX
  30 #define NAME_MAX        256
  31 #endif
  32
  33 #define YAFFS_MAX_FILE_SIZE \
  34         ( (sizeof(Y_LOFF_T) < 8) ? YAFFS_MAX_FILE_SIZE_32 : (0x800000000LL - 1) )
  35
  36
  37 #ifdef __cplusplus
  38 extern "C"
  39 {
  40 #endif
  41
  42
  43 struct yaffs_dirent {
  44         long d_ino;                     /* inode number */
  45         off_t d_off;                    /* offset to this dirent */
  46         unsigned short d_reclen;        /* length of this dirent */
  47         YUCHAR d_type;                  /* type of this record */
  48         YCHAR d_name[NAME_MAX+1];       /* file name (null-terminated) */
  49         unsigned d_dont_use;            /* debug: not for public consumption */
  50 };
  51
  52 typedef struct opaque_structure yaffs_DIR;
  53
  54
  55
  56 struct yaffs_stat {
  57         int             st_dev;         /* device */
  58         int             st_ino;         /* inode */
  59         unsigned        st_mode;        /* protection */
  60         int             st_nlink;       /* number of hard links */
  61         int             st_uid;         /* user ID of owner */
  62         int             st_gid;         /* group ID of owner */
  63         unsigned        st_rdev;        /* device type (if inode device) */
  64         Y_LOFF_T                st_size;        /* total size, in bytes */
  65         unsigned long   st_blksize;     /* blocksize for filesystem I/O */
  66         unsigned long   st_blocks;      /* number of blocks allocated */
  67 #ifdef CONFIG_YAFFS_WINCE
  68         /* Special 64-bit times for WinCE */
  69         unsigned long   yst_wince_atime[2];
  70         unsigned long   yst_wince_mtime[2];
  71         unsigned long   yst_wince_ctime[2];
  72 #else
  73         unsigned long   yst_atime;      /* time of last access */
  74         unsigned long   yst_mtime;      /* time of last modification */
  75         unsigned long   yst_ctime;      /* time of last change */
  76 #endif
  77 };
  78
  79
  80 struct yaffs_utimbuf {
  81         unsigned long actime;
  82         unsigned long modtime;
  83 };
  84
  85
  86 int yaffs_open(const YCHAR *path, int oflag, int mode) ;
  87
  88 int yaffs_close(int fd) ;
  89 int yaffs_fsync(int fd) ;
  90 int yaffs_fdatasync(int fd) ;
  91 int yaffs_flush(int fd) ; /* same as yaffs_fsync() */
  92
  93 int yaffs_access(const YCHAR *path, int amode);
  94
  95 int yaffs_dup(int fd);
  96
  97 int yaffs_read(int fd, void *buf, unsigned int nbyte) ;
  98 int yaffs_write(int fd, const void *buf, unsigned int nbyte) ;
  99
 100 int yaffs_pread(int fd, void *buf, unsigned int nbyte, Y_LOFF_T offset);
 101 int yaffs_pwrite(int fd, const void *buf, unsigned int nbyte, Y_LOFF_T offset);
 102
 103 Y_LOFF_T yaffs_lseek(int fd, Y_LOFF_T offset, int whence) ;
 104
 105 int yaffs_truncate(const YCHAR *path, Y_LOFF_T new_size);
 106 int yaffs_ftruncate(int fd, Y_LOFF_T new_size);
 107
 108 int yaffs_unlink(const YCHAR *path) ;
 109 int yaffs_rename(const YCHAR *oldPath, const YCHAR *newPath) ;
 110
 111 int yaffs_stat(const YCHAR *path, struct yaffs_stat *buf) ;
 112 int yaffs_lstat(const YCHAR *path, struct yaffs_stat *buf) ;
 113 int yaffs_fstat(int fd, struct yaffs_stat *buf) ;
 114
 115 int yaffs_utime(const YCHAR *path, const struct yaffs_utimbuf *buf);
 116 int yaffs_futime(int fd, const struct yaffs_utimbuf *buf);
 117
 118
 119 int yaffs_setxattr(const char *path, const char *name,
 120                         const void *data, int size, int flags);
 121 int yaffs_lsetxattr(const char *path, const char *name,
 122                         const void *data, int size, int flags);
 123 int yaffs_fsetxattr(int fd, const char *name,
 124                         const void *data, int size, int flags);
 125
 126 int yaffs_getxattr(const char *path, const char *name,
 127                         void *data, int size);
 128 int yaffs_lgetxattr(const char *path, const char *name,
 129                         void *data, int size);
 130 int yaffs_fgetxattr(int fd, const char *name,
 131                         void *data, int size);
 132
 133 int yaffs_removexattr(const char *path, const char *name);
 134 int yaffs_lremovexattr(const char *path, const char *name);
 135 int yaffs_fremovexattr(int fd, const char *name);
 136
 137 int yaffs_listxattr(const char *path, char *list, int size);
 138 int yaffs_llistxattr(const char *path, char *list, int size);
 139 int yaffs_flistxattr(int fd, char *list, int size);
 140
 141
 142 #ifdef CONFIG_YAFFS_WINCE
 143
 144 int yaffs_set_wince_times(int fd,
 145                         const unsigned *wctime,
 146                         const unsigned *watime,
 147                         const unsigned *wmtime);
 148 int yaffs_get_wince_times(int fd,
 149                         unsigned *wctime,
 150                         unsigned *watime,
 151                         unsigned *wmtime);
 152
 153 #endif
 154
 155 int yaffs_chmod(const YCHAR *path, mode_t mode);
 156 int yaffs_fchmod(int fd, mode_t mode);
 157
 158 int yaffs_mkdir(const YCHAR *path, mode_t mode) ;
 159 int yaffs_rmdir(const YCHAR *path) ;
 160
 161 yaffs_DIR *yaffs_opendir(const YCHAR *dirname) ;
 162 struct yaffs_dirent *yaffs_readdir(yaffs_DIR *dirp) ;
 163 void yaffs_rewinddir(yaffs_DIR *dirp) ;
 164 int yaffs_closedir(yaffs_DIR *dirp) ;
 165
 166 int yaffs_mount(const YCHAR *path) ;
 167 int yaffs_mount2(const YCHAR *path, int read_only);
 168 int yaffs_mount_common(const YCHAR *path, int read_only, int skip_checkpt);
 169
 170 int yaffs_unmount(const YCHAR *path) ;
 171 int yaffs_unmount2(const YCHAR *path, int force);
 172 int yaffs_remount(const YCHAR *path, int force, int read_only);
 173
 174
 175 int yaffs_sync(const YCHAR *path) ;
 176
 177 int yaffs_symlink(const YCHAR *oldpath, const YCHAR *newpath);
 178 int yaffs_readlink(const YCHAR *path, YCHAR *buf, int bufsiz);
 179
 180 int yaffs_link(const YCHAR *oldpath, const YCHAR *newpath);
 181 int yaffs_mknod(const YCHAR *pathname, mode_t mode, dev_t dev);
 182
 183 Y_LOFF_T yaffs_freespace(const YCHAR *path);
 184 Y_LOFF_T yaffs_totalspace(const YCHAR *path);
 185
 186 int yaffs_inodecount(const YCHAR *path);
 187
 188 int yaffs_n_handles(const YCHAR *path);
 189
 190 #define YAFFS_SHARE_READ  1
 191 #define YAFFS_SHARE_WRITE 2
 192 int yaffs_open_sharing(const YCHAR *path, int oflag, int mode, int shareMode);
 193
 194 struct yaffs_dev;
 195 void yaffs_add_device(struct yaffs_dev *dev);
 196
 197 int yaffs_start_up(void);
 198 int yaffsfs_GetLastError(void);
 199
 200 /* Functions to iterate through devices. NB Use with extreme care! */
 201 void yaffs_dev_rewind(void);
 202 struct yaffs_dev *yaffs_next_dev(void);
 203
 204 /* Function to get the last error */
 205 int yaffs_get_error(void);
 206 const char *yaffs_error_to_str(int err);
 207
 208 /* Function only for debugging */
 209 void *yaffs_getdev(const YCHAR *path);
 210 int yaffs_dump_dev(const YCHAR *path);
 211 int yaffs_set_error(int error);
 212
 213 /* Trace control functions */
 214 unsigned  yaffs_set_trace(unsigned tm);
 215 unsigned  yaffs_get_trace(void);
 216
 217
 218 #ifdef __cplusplus
 219 }
 220 #endif
 221
 222
 223 #endif