bertos/io/kblock_ram.c

   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  * \author Francesco Sacchi <batt@develer.com>
  34  *
  35  * \brief KBlock interface on RAM memory
  36  *
  37  * \author Francesco Sacchi <batt@develer.com>
  38  *
  39  * $WIZ$ module_name = "kfile_ram"
  40  * $WIZ$ module_depends = "kblock"
  41  */
  42
  43
  44 #include "kblock_ram.h"
  45 #include <string.h>
  46
  47
  48 static int kblockram_load(KBlock *b, block_idx_t index)
  49 {
  50         KBlockRam *r = KBLOCKRAM_CAST(b);
  51         memcpy(r->b.priv.buf, r->membuf + index * r->b.blk_size, r->b.blk_size);
  52         return 0;
  53 }
  54
  55 static int kblockram_store(struct KBlock *b, block_idx_t index)
  56 {
  57         KBlockRam *r = KBLOCKRAM_CAST(b);
  58         memcpy(r->membuf + index * r->b.blk_size, r->b.priv.buf, r->b.blk_size);
  59         return 0;
  60 }
  61
  62 static size_t kblockram_readBuf(struct KBlock *b, void *buf, size_t offset, size_t size)
  63 {
  64         KBlockRam *r = KBLOCKRAM_CAST(b);
  65         memcpy(buf, (uint8_t *)r->b.priv.buf + offset, size);
  66         return size;
  67 }
  68
  69 static size_t kblockram_readDirect(struct KBlock *b, block_idx_t index, void *buf, size_t offset, size_t size)
  70 {
  71         KBlockRam *r = KBLOCKRAM_CAST(b);
  72         memcpy(buf, r->membuf + index * r->b.blk_size + offset, size);
  73         return size;
  74 }
  75
  76 static size_t kblockram_writeBuf(struct KBlock *b, const void *buf, size_t offset, size_t size)
  77 {
  78         KBlockRam *r = KBLOCKRAM_CAST(b);
  79         memcpy((uint8_t *)r->b.priv.buf + offset, buf, size);
  80         return size;
  81 }
  82
  83 static size_t kblockram_writeDirect(struct KBlock *b, block_idx_t index, const void *buf, size_t offset, size_t size)
  84 {
  85         KBlockRam *r = KBLOCKRAM_CAST(b);
  86         ASSERT(buf);
  87         ASSERT(index < b->blk_cnt);
  88
  89         memcpy(r->membuf + index * r->b.blk_size + offset, buf, size);
  90         return size;
  91 }
  92
  93 static int kblockram_dummy(UNUSED_ARG(struct KBlock *,b))
  94 {
  95         return 0;
  96 }
  97
  98 static const KBlockVTable kblockram_hwbuffered_vt =
  99 {
 100         .readDirect = kblockram_readDirect,
 101
 102         .readBuf = kblockram_readBuf,
 103         .writeBuf = kblockram_writeBuf,
 104         .load = kblockram_load,
 105         .store = kblockram_store,
 106
 107         .error = kblockram_dummy,
 108         .clearerr = (kblock_clearerr_t)kblockram_dummy,
 109         .close = kblockram_dummy,
 110 };
 111
 112
 113 static const KBlockVTable kblockram_swbuffered_vt =
 114 {
 115         .readDirect = kblockram_readDirect,
 116         .writeDirect = kblockram_writeDirect,
 117
 118         .readBuf = kblock_swReadBuf,
 119         .writeBuf = kblock_swWriteBuf,
 120         .load = kblock_swLoad,
 121         .store = kblock_swStore,
 122
 123         .error = kblockram_dummy,
 124         .clearerr = (kblock_clearerr_t)kblockram_dummy,
 125         .close = kblockram_dummy,
 126 };
 127
 128 static const KBlockVTable kblockram_unbuffered_vt =
 129 {
 130         .readDirect = kblockram_readDirect,
 131         .writeDirect = kblockram_writeDirect,
 132
 133         .error = kblockram_dummy,
 134         .clearerr = (kblock_clearerr_t)kblockram_dummy,
 135         .close = kblockram_dummy,
 136 };
 137
 138 void kblockram_init(KBlockRam *ram, void *buf, size_t size, size_t block_size, bool buffered, bool hwbuffered)
 139 {
 140         ASSERT(buf);
 141         ASSERT(size);
 142         ASSERT(block_size);
 143
 144         memset(ram, 0, sizeof(*ram));
 145
 146         DB(ram->b.priv.type = KBT_KBLOCKRAM);
 147         ram->b.blk_size = block_size;
 148         ram->b.priv.flags |= KB_PARTIAL_WRITE;
 149
 150         if (buffered)
 151         {
 152                 ram->b.priv.flags |= KB_BUFFERED;
 153                 ram->b.blk_cnt = (size / block_size) - 1;
 154                 ram->b.priv.buf = buf;
 155                 // First page used as page buffer
 156                 ram->membuf = (uint8_t *)buf + block_size;
 157
 158                 if (hwbuffered)
 159                         ram->b.priv.vt = &kblockram_hwbuffered_vt;
 160                 else
 161                         ram->b.priv.vt = &kblockram_swbuffered_vt;
 162
 163                 kblockram_load(&ram->b, 0);
 164         }
 165         else
 166         {
 167                 ram->b.blk_cnt = (size / block_size);
 168                 ram->membuf = (uint8_t *)buf;
 169                 ram->b.priv.vt = &kblockram_unbuffered_vt;
 170         }
 171 }