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 //typedef long off_t;
  30 //typedef long dev_t;
  31 //typedef unsigned long mode_t;
  32
  33
  34 #ifndef NAME_MAX
  35 #define NAME_MAX        256
  36 #endif
  37
  38 #define YAFFS_MAX_FILE_SIZE (0x800000000LL - 1)
  39
  40
  41 struct yaffs_dirent{
  42     long d_ino;                 /* inode number */
  43     off_t d_off;                /* offset to this dirent */
  44     unsigned short d_reclen;    /* length of this dirent */
  45     YUCHAR  d_type;     /* type of this record */
  46     YCHAR d_name [NAME_MAX+1];   /* file name (null-terminated) */
  47     unsigned d_dont_use;        /* debug pointer, not for public consumption */
  48 };
  49
  50 typedef struct yaffs_dirent yaffs_dirent;
  51
  52
  53 typedef struct __opaque yaffs_DIR;
  54
  55
  56
  57 struct yaffs_stat{
  58     int           st_dev;      /* device */
  59     int           st_ino;      /* inode */
  60     unsigned      st_mode;     /* protection */
  61     int           st_nlink;    /* number of hard links */
  62     int           st_uid;      /* user ID of owner */
  63     int           st_gid;      /* group ID of owner */
  64     unsigned      st_rdev;     /* device type (if inode device) */
  65     loff_t         st_size;     /* total size, in bytes */
  66     unsigned long st_blksize;  /* blocksize for filesystem I/O */
  67     unsigned long st_blocks;   /* number of blocks allocated */
  68 #ifdef CONFIG_YAFFS_WINCE
  69         /* Special 64-bit times for WinCE */
  70         unsigned long yst_wince_atime[2];
  71         unsigned long yst_wince_mtime[2];
  72         unsigned long yst_wince_ctime[2];
  73 #else
  74     unsigned long yst_atime;    /* time of last access */
  75     unsigned long yst_mtime;    /* time of last modification */
  76     unsigned long yst_ctime;    /* time of last change */
  77 #endif
  78 };
  79
  80
  81 struct yaffs_utimbuf {
  82         unsigned long actime;
  83         unsigned long modtime;
  84 };
  85
  86
  87 int yaffs_open(const YCHAR *path, int oflag, int mode) ;
  88
  89 int yaffs_close(int fd) ;
  90 int yaffs_fsync(int fd) ;
  91 int yaffs_fdatasync(int fd) ;
  92 int yaffs_flush(int fd) ; /* same as yaffs_fsync() */
  93
  94 int yaffs_access(const YCHAR *path, int amode);
  95
  96 int yaffs_dup(int fd);
  97
  98 int yaffs_read(int fd, void *buf, unsigned int nbyte) ;
  99 int yaffs_write(int fd, const void *buf, unsigned int nbyte) ;
 100
 101 int yaffs_pread(int fd, void *buf, unsigned int nbyte, loff_t offset);
 102 int yaffs_pwrite(int fd, const void *buf, unsigned int nbyte, loff_t offset);
 103
 104 loff_t yaffs_lseek(int fd, loff_t offset, int whence) ;
 105
 106 int yaffs_truncate(const YCHAR *path, loff_t new_size);
 107 int yaffs_ftruncate(int fd, loff_t new_size);
 108
 109 int yaffs_unlink(const YCHAR *path) ;
 110 int yaffs_rename(const YCHAR *oldPath, const YCHAR *newPath) ;
 111
 112 int yaffs_stat(const YCHAR *path, struct yaffs_stat *buf) ;
 113 int yaffs_lstat(const YCHAR *path, struct yaffs_stat *buf) ;
 114 int yaffs_fstat(int fd, struct yaffs_stat *buf) ;
 115
 116 int yaffs_utime(const YCHAR *path, const struct yaffs_utimbuf *buf);
 117 int yaffs_futime(int fd, const struct yaffs_utimbuf *buf);
 118
 119
 120 int yaffs_setxattr(const char *path, const char *name, const void *data, int size, int flags);
 121 int yaffs_lsetxattr(const char *path, const char *name, const void *data, int size, int flags);
 122 int yaffs_fsetxattr(int fd, const char *name, const void *data, int size, int flags);
 123
 124 int yaffs_getxattr(const char *path, const char *name, void *data, int size);
 125 int yaffs_lgetxattr(const char *path, const char *name, void *data, int size);
 126 int yaffs_fgetxattr(int fd, const char *name, void *data, int size);
 127
 128 int yaffs_removexattr(const char *path, const char *name);
 129 int yaffs_lremovexattr(const char *path, const char *name);
 130 int yaffs_fremovexattr(int fd, const char *name);
 131
 132 int yaffs_listxattr(const char *path, char *list, int size);
 133 int yaffs_llistxattr(const char *path, char *list, int size);
 134 int yaffs_flistxattr(int fd, char *list, int size);
 135
 136
 137 #ifdef CONFIG_YAFFS_WINCE
 138
 139 int yaffs_set_wince_times(int fd, const unsigned *wctime, const unsigned *watime, const unsigned *wmtime);
 140 int yaffs_get_wince_times(int fd, unsigned *wctime, unsigned *watime, unsigned *wmtime);
 141
 142 #endif
 143
 144 int yaffs_chmod(const YCHAR *path, mode_t mode);
 145 int yaffs_fchmod(int fd, mode_t mode);
 146
 147 int yaffs_mkdir(const YCHAR *path, mode_t mode) ;
 148 int yaffs_rmdir(const YCHAR *path) ;
 149
 150 yaffs_DIR *yaffs_opendir(const YCHAR *dirname) ;
 151 struct yaffs_dirent *yaffs_readdir(yaffs_DIR *dirp) ;
 152 void yaffs_rewinddir(yaffs_DIR *dirp) ;
 153 int yaffs_closedir(yaffs_DIR *dirp) ;
 154
 155 int yaffs_mount(const YCHAR *path) ;
 156 int yaffs_mount2(const YCHAR *path, int read_only);
 157 int yaffs_mount_common(const YCHAR *path, int read_only, int skip_checkpt);
 158
 159 int yaffs_unmount(const YCHAR *path) ;
 160 int yaffs_unmount2(const YCHAR *path, int force);
 161 int yaffs_remount(const YCHAR *path, int force, int read_only);
 162
 163
 164 int yaffs_sync(const YCHAR *path) ;
 165
 166 int yaffs_symlink(const YCHAR *oldpath, const YCHAR *newpath);
 167 int yaffs_readlink(const YCHAR *path, YCHAR *buf, int bufsiz);
 168
 169 int yaffs_link(const YCHAR *oldpath, const YCHAR *newpath);
 170 int yaffs_mknod(const YCHAR *pathname, mode_t mode, dev_t dev);
 171
 172 loff_t yaffs_freespace(const YCHAR *path);
 173 loff_t yaffs_totalspace(const YCHAR *path);
 174
 175 int yaffs_inodecount(const YCHAR *path);
 176
 177 int yaffs_n_handles(const YCHAR *path);
 178
 179 #define YAFFS_SHARE_READ  1
 180 #define YAFFS_SHARE_WRITE 2
 181 int yaffs_open_sharing(const YCHAR *path, int oflag, int mode, int shareMode) ;
 182
 183
 184 struct yaffs_dev;
 185 void yaffs_add_device(struct yaffs_dev *dev);
 186
 187 int yaffs_start_up(void);
 188 int yaffsfs_GetLastError(void);
 189
 190 /* Function to get the last error */
 191 int yaffs_get_error(void);
 192 const char * yaffs_error_to_str(int err);
 193
 194 /* Function only for debugging */
 195 void * yaffs_getdev(const YCHAR *path);
 196 int yaffs_dump_dev(const YCHAR *path);
 197 int yaffs_set_error(int error);
 198
 199 /* Trace control functions */
 200 unsigned  yaffs_set_trace(unsigned tm);
 201 unsigned  yaffs_get_trace(void);
 202 #endif