kern/kfile.h

   1 /**
   2  * \file
   3  * <!--
   4  * Copyright 2004 Develer S.r.l. (http://www.develer.com/)
   5  * Copyright 1999, 2000, 2001, 2003 Bernardo Innocenti <bernie@develer.com>
   6  * This file is part of DevLib - See README.devlib for information.
   7  * -->
   8  *
   9  * \brief Virtual KFile I/O interface.
  10  *
  11  * \version $Id$
  12  * \author Bernardo Innocenti <bernie@develer.com>
  13  */
  14
  15 /*#*
  16  *#* $Log$
  17  *#* Revision 1.1  2007/06/14 14:42:48  batt
  18  *#* Move kfile to kern/ directory; remove duplicate file.h.
  19  *#*
  20  *#* Revision 1.7  2007/06/08 14:25:43  batt
  21  *#* Merge from project_ks.
  22  *#*
  23  *#* Revision 1.6  2006/07/19 12:56:28  bernie
  24  *#* Convert to new Doxygen style.
  25  *#*
  26  *#* Revision 1.5  2005/11/04 16:20:02  bernie
  27  *#* Fix reference to README.devlib in header.
  28  *#*
  29  *#* Revision 1.4  2005/04/11 19:10:28  bernie
  30  *#* Include top-level headers from cfg/ subdir.
  31  *#*
  32  *#* Revision 1.3  2004/12/31 16:43:23  bernie
  33  *#* Move seek function last in VT.
  34  *#*
  35  *#* Revision 1.2  2004/08/25 14:12:09  rasky
  36  *#* Aggiornato il comment block dei log RCS
  37  *#*
  38  *#* Revision 1.1  2004/08/04 02:40:25  bernie
  39  *#* Add virtual file I/O interface.
  40  *#*
  41  *#*/
  42 #ifndef MWARE_KFILE_H
  43 #define MWARE_KFILE_H
  44
  45 #include <cfg/compiler.h>
  46
  47 /* fwd decl */
  48 struct _KFile;
  49
  50 typedef size_t  (*ReadFunc_t)   (struct _KFile *fd, char *buf, size_t size);
  51 typedef size_t  (*WriteFunc_t)  (struct _KFile *fd, const char *buf, size_t size);
  52 typedef bool    (*SeekFunc_t)   (struct _KFile *fd, int32_t offset);
  53 typedef bool    (*OpenFunc_t)   (struct _KFile *fd, const char *name, int mode);
  54 typedef bool    (*CloseFunc_t)  (struct _KFile *fd);
  55
  56
  57 /* Context data for callback functions which operate on
  58  * pseudo files.
  59  */
  60 typedef struct _KFile
  61 {
  62         ReadFunc_t              read;
  63         WriteFunc_t             write;
  64         OpenFunc_t              open;
  65         CloseFunc_t             close;
  66         SeekFunc_t              seek;
  67
  68         /* NOTE: these must _NOT_ be size_t on 16bit CPUs! */
  69         uint32_t                seek_pos;
  70         uint32_t                size;
  71 } KFile;
  72
  73 #endif /* MWARE_KFILE_H */