bertos/io/kfile_block.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 2010 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief KFile interface over a KBlock.
  34  *
  35  * With this module, you can access a KBlock device
  36  * with the handy KFile interface.
  37  * In order to achieve this, the block device must support partial block write.
  38  *
  39  * \author Francesco Sacchi <batt@develer.com>
  40  * \author Daniele Basile <asterix@develer.com>
  41  *
  42  * $WIZ$ module_name = "kfile_block"
  43  * $WIZ$ module_depends = "kfile", "kblock"
  44  */
  45
  46 #ifndef IO_KFILE_BLOCK_H
  47 #define IO_KFILE_BLOCK_H
  48
  49 #include <cfg/compiler.h>
  50 #include <io/kblock.h>
  51 #include <io/kfile.h>
  52
  53 /**
  54  * KFileBlock context.
  55  */
  56 typedef struct KFileBlock
  57 {
  58         KFile fd;    ///< KFile context
  59         KBlock *blk; ///< KBlock device
  60 } KFileBlock;
  61
  62 /**
  63  * Init a KFile over KBlock.
  64  * After this you can access your KBlock device with a handy KFile interface.
  65  *
  66  * \note The block device must support partial block write in order to support
  67  *       random write access.
  68  *
  69  * \param fb KFileBlock context.
  70  * \param blk block device to be accessed with a KFile interface.
  71  */
  72 void kfileblock_init(KFileBlock *fb, KBlock *blk);
  73
  74 #endif /* IO_KFILE_KBLOCK_H */