kern/kfile.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2004 Develer S.r.l. (http://www.develer.com/)
  30  * Copyright 1999, 2000, 2001, 2003 Bernardo Innocenti <bernie@develer.com>
  31  *
  32  * -->
  33  *
  34  * \brief Virtual KFile I/O interface.
  35  *
  36  * \version $Id$
  37  * \author Bernardo Innocenti <bernie@develer.com>
  38  */
  39
  40 /*#*
  41  *#* $Log$
  42  *#* Revision 1.3  2007/10/04 19:39:25  batt
  43  *#* Add seek constants.
  44  *#*
  45  *#* Revision 1.1  2007/06/14 14:42:48  batt
  46  *#* Move kfile to kern/ directory; remove duplicate file.h.
  47  *#*
  48  *#* Revision 1.7  2007/06/08 14:25:43  batt
  49  *#* Merge from project_ks.
  50  *#*
  51  *#* Revision 1.6  2006/07/19 12:56:28  bernie
  52  *#* Convert to new Doxygen style.
  53  *#*
  54  *#* Revision 1.5  2005/11/04 16:20:02  bernie
  55  *#* Fix reference to README.devlib in header.
  56  *#*
  57  *#* Revision 1.4  2005/04/11 19:10:28  bernie
  58  *#* Include top-level headers from cfg/ subdir.
  59  *#*
  60  *#* Revision 1.3  2004/12/31 16:43:23  bernie
  61  *#* Move seek function last in VT.
  62  *#*
  63  *#* Revision 1.2  2004/08/25 14:12:09  rasky
  64  *#* Aggiornato il comment block dei log RCS
  65  *#*
  66  *#* Revision 1.1  2004/08/04 02:40:25  bernie
  67  *#* Add virtual file I/O interface.
  68  *#*
  69  *#*/
  70 #ifndef MWARE_KFILE_H
  71 #define MWARE_KFILE_H
  72
  73 #include <cfg/compiler.h>
  74
  75 /* fwd decl */
  76 struct _KFile;
  77
  78 /**
  79  * Costants for repositioning read/write file offset.
  80  * These are needed because on some embedded platforms
  81  * ANSI I/O library may not be present.
  82  */
  83 typedef enum KSeekMode
  84 {
  85         KSM_SEEK_SET, ///< Seek from file beginning.
  86         KSM_SEEK_CUR, ///< Seek from file current position.
  87         KSM_SEEK_END, ///< Seek from file end.
  88 } KSeekMode;
  89
  90
  91 typedef size_t  (*ReadFunc_t)  (struct _KFile *fd, void *buf, size_t size);
  92 typedef size_t  (*WriteFunc_t) (struct _KFile *fd, const void *buf, size_t size);
  93 typedef int32_t (*SeekFunc_t)  (struct _KFile *fd, int32_t offset, KSeekMode whence);
  94 typedef bool    (*OpenFunc_t)  (struct _KFile *fd, const char *name, int mode);
  95 typedef bool    (*CloseFunc_t) (struct _KFile *fd);
  96
  97 /**
  98  * Context data for callback functions which operate on
  99  * pseudo files.
 100  */
 101 typedef struct _KFile
 102 {
 103         ReadFunc_t              read;
 104         WriteFunc_t             write;
 105         OpenFunc_t              open;
 106         CloseFunc_t             close;
 107         SeekFunc_t              seek;
 108
 109         /* NOTE: these must _NOT_ be size_t on 16bit CPUs! */
 110         uint32_t                seek_pos;
 111         uint32_t                size;
 112 } KFile;
 113
 114 #endif /* MWARE_KFILE_H */