mware/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  * This file is part of DevLib - See README.devlib for information.
  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.7  2007/06/08 14:25:43  batt
  43  *#* Merge from project_ks.
  44  *#*
  45  *#* Revision 1.6  2006/07/19 12:56:28  bernie
  46  *#* Convert to new Doxygen style.
  47  *#*
  48  *#* Revision 1.5  2005/11/04 16:20:02  bernie
  49  *#* Fix reference to README.devlib in header.
  50  *#*
  51  *#* Revision 1.4  2005/04/11 19:10:28  bernie
  52  *#* Include top-level headers from cfg/ subdir.
  53  *#*
  54  *#* Revision 1.3  2004/12/31 16:43:23  bernie
  55  *#* Move seek function last in VT.
  56  *#*
  57  *#* Revision 1.2  2004/08/25 14:12:09  rasky
  58  *#* Aggiornato il comment block dei log RCS
  59  *#*
  60  *#* Revision 1.1  2004/08/04 02:40:25  bernie
  61  *#* Add virtual file I/O interface.
  62  *#*
  63  *#*/
  64 #ifndef MWARE_KFILE_H
  65 #define MWARE_KFILE_H
  66
  67 #include <cfg/compiler.h>
  68
  69 /* fwd decl */
  70 struct _KFile;
  71
  72 typedef size_t  (*ReadFunc_t)   (struct _KFile *fd, char *buf, size_t size);
  73 typedef size_t  (*WriteFunc_t)  (struct _KFile *fd, const char *buf, size_t size);
  74 typedef bool    (*SeekFunc_t)   (struct _KFile *fd, int32_t offset);
  75 typedef bool    (*OpenFunc_t)   (struct _KFile *fd, const char *name, int mode);
  76 typedef bool    (*CloseFunc_t)  (struct _KFile *fd);
  77
  78
  79 /* Context data for callback functions which operate on
  80  * pseudo files.
  81  */
  82 typedef struct _KFile
  83 {
  84         ReadFunc_t              read;
  85         WriteFunc_t             write;
  86         OpenFunc_t              open;
  87         CloseFunc_t             close;
  88         SeekFunc_t              seek;
  89
  90         /* NOTE: these must _NOT_ be size_t on 16bit CPUs! */
  91         uint32_t                seek_pos;
  92         uint32_t                size;
  93 } KFile;
  94
  95 #endif /* MWARE_KFILE_H */