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  * \defgroup kfile_block KFile interface over KBlock
  34  * \ingroup core
  35  * \{
  36  *
  37  * \brief KFile interface over a KBlock.
  38  *
  39  * With this module, you can access a KBlock device
  40  * with the handy KFile interface.
  41  * In order to achieve this, the block device must support partial block write.
  42  *
  43  * Error codes returned by kfile_error() are specific of the underlying
  44  * KBlock implementation.
  45  *
  46  * Make sure you have trimmed the KBlock to avoid overwriting something.
  47  * Example:
  48  * \code
  49  * // init a derived instance of KBlock
  50  * // any will do.
  51  * Flash flash;
  52  * flash_init(&flash, 0);
  53  * kblock_trim(&flash.blk, trim_start, internal_flash.blk.blk_cnt - trim_start);
  54  *
  55  * // now create and initialize the kfile_block instance
  56  * KFileBlock kfb;
  57  * kfileblock_init(&kfb, &flash.blk);
  58  *
  59  * // now you can access the Flash in a file like fashion
  60  * kfile_read(&kfb.fd, buf, 20);
  61  * \endcode
  62  *
  63  * \author Francesco Sacchi <batt@develer.com>
  64  * \author Daniele Basile <asterix@develer.com>
  65  *
  66  * $WIZ$ module_name = "kfile_block"
  67  * $WIZ$ module_depends = "kfile", "kblock"
  68  */
  69
  70 #ifndef IO_KFILE_BLOCK_H
  71 #define IO_KFILE_BLOCK_H
  72
  73 #include <cfg/compiler.h>
  74 #include <io/kblock.h>
  75 #include <io/kfile.h>
  76
  77 /**
  78  * KFileBlock context.
  79  */
  80 typedef struct KFileBlock
  81 {
  82         KFile fd;    ///< KFile context
  83         KBlock *blk; ///< KBlock device
  84 } KFileBlock;
  85
  86 /**
  87  * Init a KFile over KBlock.
  88  * After this you can access your KBlock device with a handy KFile interface.
  89  *
  90  * \note The block device must support partial block write in order to support
  91  *       random write access.
  92  *
  93  * \param fb KFileBlock context.
  94  * \param blk block device to be accessed with a KFile interface.
  95  */
  96 void kfileblock_init(KFileBlock *fb, KBlock *blk);
  97
  98 /** \} */ //defgroup kfile_block
  99
 100 #endif /* IO_KFILE_KBLOCK_H */