direct/yaffsfs.h

   1 /*
   2  * YAFFS: Yet another Flash File System . A NAND-flash specific file system.
   3  *
   4  * Copyright (C) 2002-2010 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 (0x7FFFFFFF)
  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 d_name */
  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     off_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 int yaffs_open(const YCHAR *path, int oflag, int mode) ;
  81
  82 int yaffs_close(int fd) ;
  83 int yaffs_fsync(int fd) ;
  84 int yaffs_fdatasync(int fd) ;
  85 int yaffs_flush(int fd) ; /* same as yaffs_fsync() */
  86
  87 int yaffs_access(const YCHAR *path, int amode);
  88
  89 int yaffs_dup(int fd);
  90
  91 int yaffs_read(int fd, void *buf, unsigned int nbyte) ;
  92 int yaffs_write(int fd, const void *buf, unsigned int nbyte) ;
  93
  94 int yaffs_pread(int fd, void *buf, unsigned int nbyte, unsigned int offset);
  95 int yaffs_pwrite(int fd, const void *buf, unsigned int nbyte, unsigned int offset);
  96
  97 off_t yaffs_lseek(int fd, off_t offset, int whence) ;
  98
  99 int yaffs_truncate(const YCHAR *path, off_t new_size);
 100 int yaffs_ftruncate(int fd, off_t new_size);
 101
 102 int yaffs_unlink(const YCHAR *path) ;
 103 int yaffs_rename(const YCHAR *oldPath, const YCHAR *newPath) ;
 104
 105 int yaffs_stat(const YCHAR *path, struct yaffs_stat *buf) ;
 106 int yaffs_lstat(const YCHAR *path, struct yaffs_stat *buf) ;
 107 int yaffs_fstat(int fd, struct yaffs_stat *buf) ;
 108
 109 int yaffs_setxattr(const char *path, const char *name, const void *data, int size, int flags);
 110 int yaffs_lsetxattr(const char *path, const char *name, const void *data, int size, int flags);
 111 int yaffs_fsetxattr(int fd, const char *name, const void *data, int size, int flags);
 112
 113 int yaffs_getxattr(const char *path, const char *name, void *data, int size);
 114 int yaffs_lgetxattr(const char *path, const char *name, void *data, int size);
 115 int yaffs_fgetxattr(int fd, const char *name, void *data, int size);
 116
 117 int yaffs_removexattr(const char *path, const char *name);
 118 int yaffs_lremovexattr(const char *path, const char *name);
 119 int yaffs_fremovexattr(int fd, const char *name);
 120
 121 int yaffs_listxattr(const char *path, char *list, int size);
 122 int yaffs_llistxattr(const char *path, char *list, int size);
 123 int yaffs_flistxattr(int fd, char *list, int size);
 124
 125
 126 #ifdef CONFIG_YAFFS_WINCE
 127
 128 int yaffs_set_wince_times(int fd, const unsigned *wctime, const unsigned *watime, const unsigned *wmtime);
 129 int yaffs_get_wince_times(int fd, unsigned *wctime, unsigned *watime, unsigned *wmtime);
 130
 131 #endif
 132
 133 int yaffs_chmod(const YCHAR *path, mode_t mode);
 134 int yaffs_fchmod(int fd, mode_t mode);
 135
 136 int yaffs_mkdir(const YCHAR *path, mode_t mode) ;
 137 int yaffs_rmdir(const YCHAR *path) ;
 138
 139 yaffs_DIR *yaffs_opendir(const YCHAR *dirname) ;
 140 struct yaffs_dirent *yaffs_readdir(yaffs_DIR *dirp) ;
 141 void yaffs_rewinddir(yaffs_DIR *dirp) ;
 142 int yaffs_closedir(yaffs_DIR *dirp) ;
 143
 144 int yaffs_mount(const YCHAR *path) ;
 145 int yaffs_mount2(const YCHAR *path, int read_only);
 146 int yaffs_unmount(const YCHAR *path) ;
 147 int yaffs_unmount2(const YCHAR *path, int force);
 148 int yaffs_remount(const YCHAR *path, int force, int read_only);
 149
 150
 151 int yaffs_sync(const YCHAR *path) ;
 152
 153 int yaffs_symlink(const YCHAR *oldpath, const YCHAR *newpath);
 154 int yaffs_readlink(const YCHAR *path, YCHAR *buf, int bufsiz);
 155
 156 int yaffs_link(const YCHAR *oldpath, const YCHAR *newpath);
 157 int yaffs_mknod(const YCHAR *pathname, mode_t mode, dev_t dev);
 158
 159 loff_t yaffs_freespace(const YCHAR *path);
 160 loff_t yaffs_totalspace(const YCHAR *path);
 161
 162 int yaffs_inodecount(const YCHAR *path);
 163
 164 int yaffs_n_handles(const YCHAR *path);
 165
 166 #define YAFFS_SHARE_READ  1
 167 #define YAFFS_SHARE_WRITE 2
 168 int yaffs_open_sharing(const YCHAR *path, int oflag, int mode, int shareMode) ;
 169
 170
 171 struct yaffs_dev;
 172 void yaffs_add_device(struct yaffs_dev *dev);
 173
 174 int yaffs_start_up(void);
 175 int yaffsfs_GetLastError(void);
 176 int yaffs_set_error(int error);
 177 /* Function to get the last error */
 178 int yaffs_get_error(void);
 179
 180 /* Function only for debugging */
 181 void * yaffs_getdev(const YCHAR *path);
 182 int yaffs_dump_dev(const YCHAR *path);
 183
 184 /* Trace control functions */
 185 unsigned  yaffs_set_trace(unsigned tm);
 186 unsigned  yaffs_get_trace(void);
 187 #endif
 188
 189