mware/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.5  2005/11/04 16:20:02  bernie
  18  *#* Fix reference to README.devlib in header.
  19  *#*
  20  *#* Revision 1.4  2005/04/11 19:10:28  bernie
  21  *#* Include top-level headers from cfg/ subdir.
  22  *#*
  23  *#* Revision 1.3  2004/12/31 16:43:23  bernie
  24  *#* Move seek function last in VT.
  25  *#*
  26  *#* Revision 1.2  2004/08/25 14:12:09  rasky
  27  *#* Aggiornato il comment block dei log RCS
  28  *#*
  29  *#* Revision 1.1  2004/08/04 02:40:25  bernie
  30  *#* Add virtual file I/O interface.
  31  *#*
  32  *#*/
  33 #ifndef MWARE_KFILE_H
  34 #define MWARE_KFILE_H
  35
  36 #include <cfg/compiler.h>
  37
  38 /* fwd decl */
  39 struct _KFile;
  40
  41 typedef size_t  (*ReadFunc_t)   (struct _KFile *fd, char *buf, size_t size);
  42 typedef size_t  (*WriteFunc_t)  (struct _KFile *fd, const char *buf, size_t size);
  43 typedef bool    (*SeekFunc_t)   (struct _KFile *fd, int32_t offset);
  44 typedef bool    (*OpenFunc_t)   (struct _KFile *fd, const char *name, int mode);
  45 typedef bool    (*CloseFunc_t)  (struct _KFile *fd);
  46
  47
  48 /* Context data for callback functions which operate on
  49  * pseudo files.
  50  */
  51 typedef struct _KFile
  52 {
  53         ReadFunc_t              read;
  54         WriteFunc_t             write;
  55         OpenFunc_t              open;
  56         CloseFunc_t             close;
  57         SeekFunc_t              seek;
  58
  59         /* NOTE: these must _NOT_ be size_t on 16bit CPUs! */
  60         uint32_t                SeekPos;
  61         uint32_t                Size;
  62 } KFile;
  63
  64 #endif /* MWARE_KFILE_H */