filesys.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2004, Dennis Kuschel.
 *  All rights reserved. 
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *   3. The name of the author may not be used to endorse or promote
 *      products derived from this software without specific prior written
 *      permission. 
 *
 *  THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
 *  OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 *  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
 *  INDIRECT,  INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 *  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 *  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 *  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 *  STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
 *  OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef _FILESYS_H
#define _FILESYS_H
#define HAVE_EMBEDDED_FILESYSTEM  1

#include "sys.h"

#ifndef FS_MAXFILES

#define FS_MAXFILES             10
#endif

#ifndef FS_STANDARD_API

#define FS_STANDARD_API         0
#endif

#ifndef FS_SUBDIRECTORIES

#define FS_SUBDIRECTORIES       1
#endif

#ifndef FS_MAXFNAMELEN

#define FS_MAXFNAMELEN          256
#endif

/* Flags used with fsys_open */
#define FSO_RDWR        0x000  
#define FSO_RDONLY      0x001  
#define FSO_WRONLY      0x002  
#define FSO_CREAT       0x004  
#define FSO_TRUNC       0x008  
#define FSO_SEQUENTIAL  0x000  
#define FSO_RANDOM      0x010  
#define FSO_BINARY      0x000  
#define FSO_TEXT        0x020  
#define FSO_EXCL        0x040  
#define FSO_APPEND      0x080  
/* Flags used with fsys_stat */
#define FSS_IFMT        0x00170000  
#define FSS_IFDIR       0x00040000  
#define FSS_IFCHR       0x00020000  
#define FSS_IFIFO       0x00010000  
#define FSS_IFREG       0x00100000  
#define FSS_IREAD       0x00000400  
#define FSS_IWRITE      0x00000200  
#define FSS_IEXEC       0x00000100  
/* Attributes used with by the structure struct fsys_finddata */
#define FSA_NORMAL      0x00  
#define FSA_RDONLY      0x01  
#define FSA_HIDDEN      0x02  
#define FSA_SYSTEM      0x04  
#define FSA_SUBDIR      0x08  
#define FSA_ARCH        0x10  
/* Flags used with fsys_seek */
#define FSSEEK_SET      0  
#define FSSEEK_CUR      1  
#define FSSEEK_END      2  
/* Define macros to match the standard I/O API */
#if FS_STANDARD_API

#define O_RDWR          FSO_RDWR
#define O_RDONLY        FSO_RDONLY
#define O_WRONLY        FSO_WRONLY
#define O_CREAT         FSO_CREAT
#define O_TRUNC         FSO_TRUNC
#define O_SEQUENTIAL    FSO_SEQUENTIAL
#define O_RANDOM        FSO_RANDOM
#define O_BINARY        FSO_BINARY
#define O_TEXT          FSO_TEXT
#define O_EXCL          FSO_EXCL
#define O_APPEND        FSO_APPEND

#define S_IFMT          FSS_IFMT
#define S_IFDIR         FSS_IFDIR
#define S_IFCHR         FSS_IFCHR
#define S_IFIFO         FSS_IFIFO
#define S_IFREG         FSS_IFREG
#define S_IREAD         FSS_IREAD
#define S_IWRITE        FSS_IWRITE
#define S_IEXEC         FSS_IEXEC

#define A_NORMAL        FSA_NORMAL
#define A_RDONLY        FSA_RDONLY
#define A_HIDDEN        FSA_HIDDEN
#define A_SYSTEM        FSA_SYSTEM
#define A_SUBDIR        FSA_SUBDIR
#define A_ARCH          FSA_ARCH

#define open(a,b)       fsys_open(a,b)
#define close(a)        fsys_close(a)
#define read(a,b,c)     fsys_read(a,b,c)
#define write(a,b,c)    fsys_write(a,b,c)
#define eof(a)          fsys_eof(a)
#define seek(a,b,c)     fsys_seek(a,b,c)
#define tell(a)         fsys_tell(a)
#define stat            fsys_stat
#define findfirst(a,b)  fsys_findfirst(a,b)
#define findnext(a,b)   fsys_findnext(a,b)
#define findclose(a)    fsys_findclose(a)
#define rename(a,b)     fsys_rename(a,b)
#define remove(a)       fsys_remove(a)

#endif


/* file time */
struct fsys_time
{
  u16_t  year;   
  u8_t   month;  
  u8_t   day;    
  u8_t   hour;   
  u8_t   min;    
  u8_t   sec;    
  u8_t   spare;  /* not used  */
};

/* file status */
struct fsys_stat
{
  u32_t             st_mode;  
  sint_t            st_size;  
  struct fsys_time  st_time;  
};

/* file find data */
struct fsys_finddata
{
  u32_t             attrib; 
  struct fsys_time  time;   
  u32_t             size;   
  char              name[(FS_MAXFNAMELEN+3)&~3]; 
};


sint_t  fsys_open(const char *filename, const sint_t mode);


sint_t  fsys_opent(char *filename, const sint_t mode);


void    fsys_close(const sint_t file);


sint_t  fsys_write(const sint_t file, const char *buf, const sint_t count);


sint_t  fsys_read(const sint_t file, const char *buf, const sint_t count);


sint_t  fsys_eof(const sint_t file);


sint_t  fsys_seek(const sint_t file, const sint_t position,
                  const sint_t origin);


/* Get current file pointer position.
 * This function is equivalent to the one from the runtime library.
 * @param file      Handle to an open file.
 * @return The current file pointer position on success or -1 when the
 *         function failed.
 */
sint_t  fsys_tell(const sint_t file);


sint_t  fsys_stat(const char *fname, struct fsys_stat *stat);


sint_t  fsys_findfirst(char *filespec, struct fsys_finddata *fileinfo);


sint_t  fsys_findnext(sint_t handle, struct fsys_finddata *fileinfo);


sint_t  fsys_findclose(sint_t handle);


sint_t  fsys_remove(const char *filename);


sint_t  fsys_rename(const char *from, const char *to);


sint_t  fsys_replace(const char *oldfile, const char *newfile);


#if FS_SUBDIRECTORIES

sint_t  fsys_mkdir(const char *pathname);


sint_t  fsys_rmdir(const char *pathname);


sint_t  fsys_buildPathName(char *outbuf, const char *pathname,
                           const char *filename);

#endif /* FS_SUBDIRECTORIES */


sint_t  fsys_format(u32_t blocksize, u32_t maxFilenameLength);


u32_t   fsys_free(void);


u32_t   fsys_shrinkImage(void *image);


sint_t  fsys_addDriveImage(void *img, sint_t readonly);


sint_t  fsys_init(u32_t size, u32_t blocksize, u32_t maxFilenameLength);


sint_t  fsys_term(void);


void*  fsys_lockAndGetImage(u32_t *size);


void   fsys_unlockImage(void);


#endif

---