bertos/struct/kfile_mem.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 2009 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief KFile interface over a memory buffer.
  34  *
  35  * Convenient way to access a memory region using the KFile interface.
  36  *
  37  *
  38  * \author Francesco Sacchi <batt@develer.com>
  39  *
  40  * $WIZ$ module_name = "kfilemem"
  41  * $WIZ$ module_depends = "kfile"
  42  */
  43
  44 #ifndef STRUCT_KFILE_MEM
  45 #define STRUCT_KFILE_MEM
  46
  47 #include <io/kfile.h>
  48
  49 /**
  50  * Context for KFile over memory buffer.
  51  */
  52 typedef struct KFileMem
  53 {
  54         KFile fd;  ///< KFile base class
  55         void *mem; ///< Pointer to the memory buffer used.
  56 } KFileMem;
  57
  58 /**
  59  * ID for KFile Mem.
  60  */
  61 #define KFT_KFILEMEM MAKE_ID('M', 'E', 'M', '0')
  62
  63 /**
  64  * Convert + ASSERT from generic KFile to KFileMem.
  65  */
  66 INLINE KFileMem * KFILEMEM_CAST(KFile *fd)
  67 {
  68         ASSERT(fd->_type == KFT_KFILEMEM);
  69         return (KFileMem *)fd;
  70 }
  71
  72 /**
  73  * Initialize KFileMem struct.
  74  *
  75  * \param km Interface to initialize.
  76  * \param mem Pointer to the memory buffer to operate on.
  77  * \param len Size of the buffer
  78  */
  79 void kfilemem_init(KFileMem *km, void *mem, size_t len);
  80
  81 #endif /* STRUCT_KFILE_MEM */