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