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 #ifndef MWARE_KFILE_H
  41 #define MWARE_KFILE_H
  42
  43 #include <cfg/compiler.h>
  44
  45 /* fwd decl */
  46 struct _KFile;
  47
  48 /**
  49  * Costants for repositioning read/write file offset.
  50  * These are needed because on some embedded platforms
  51  * ANSI I/O library may not be present.
  52  */
  53 typedef enum KSeekMode
  54 {
  55         KSM_SEEK_SET, ///< Seek from file beginning.
  56         KSM_SEEK_CUR, ///< Seek from file current position.
  57         KSM_SEEK_END, ///< Seek from file end.
  58 } KSeekMode;
  59
  60
  61 typedef size_t  (*ReadFunc_t)  (struct _KFile *fd, void *buf, size_t size);
  62 typedef size_t  (*WriteFunc_t) (struct _KFile *fd, const void *buf, size_t size);
  63 typedef int32_t (*SeekFunc_t)  (struct _KFile *fd, int32_t offset, KSeekMode whence);
  64 typedef bool    (*OpenFunc_t)  (struct _KFile *fd, const char *name, int mode);
  65 typedef bool    (*CloseFunc_t) (struct _KFile *fd);
  66
  67 /**
  68  * Context data for callback functions which operate on
  69  * pseudo files.
  70  */
  71 typedef struct _KFile
  72 {
  73         ReadFunc_t              read;
  74         WriteFunc_t             write;
  75         OpenFunc_t              open;
  76         CloseFunc_t             close;
  77         SeekFunc_t              seek;
  78
  79         /* NOTE: these must _NOT_ be size_t on 16bit CPUs! */
  80         uint32_t                seek_pos;
  81         uint32_t                size;
  82 } KFile;
  83
  84 #endif /* MWARE_KFILE_H */