4 * This file is part of BeRTOS.
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.
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.
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
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.
29 * Copyright 2010 Develer S.r.l. (http://www.develer.com/)
33 * \author Francesco Sacchi <batt@develer.com>
35 * \brief KBlock interface
41 #define LOG_LEVEL LOG_LVL_ERR
42 #define LOG_FORMAT LOG_FMT_VERBOSE
47 INLINE size_t kblock_readDirect(struct KBlock *b, block_idx_t index, void *buf, size_t offset, size_t size)
49 KB_ASSERT_METHOD(b, readDirect);
50 ASSERT(index < b->blk_cnt);
51 return b->priv.vt->readDirect(b, b->priv.blk_start + index, buf, offset, size);
54 INLINE size_t kblock_writeDirect(struct KBlock *b, block_idx_t index, const void *buf, size_t offset, size_t size)
56 KB_ASSERT_METHOD(b, writeDirect);
57 ASSERT(index < b->blk_cnt);
58 return b->priv.vt->writeDirect(b, b->priv.blk_start + index, buf, offset, size);
61 INLINE size_t kblock_readBuf(struct KBlock *b, void *buf, size_t offset, size_t size)
63 KB_ASSERT_METHOD(b, readBuf);
64 ASSERT(offset + size <= b->blk_size);
66 return b->priv.vt->readBuf(b, buf, offset, size);
69 INLINE size_t kblock_writeBuf(struct KBlock *b, const void *buf, size_t offset, size_t size)
71 KB_ASSERT_METHOD(b, writeBuf);
72 ASSERT(offset + size <= b->blk_size);
73 return b->priv.vt->writeBuf(b, buf, offset, size);
76 INLINE int kblock_load(struct KBlock *b, block_idx_t index)
78 KB_ASSERT_METHOD(b, load);
79 ASSERT(index < b->blk_cnt);
81 LOG_INFO("index %ld\n", index);
82 return b->priv.vt->load(b, b->priv.blk_start + index);
85 INLINE int kblock_store(struct KBlock *b, block_idx_t index)
87 KB_ASSERT_METHOD(b, store);
88 ASSERT(index < b->blk_cnt);
90 LOG_INFO("index %ld\n", index);
91 return b->priv.vt->store(b, b->priv.blk_start + index);
94 INLINE void kblock_setDirty(struct KBlock *b, bool dirty)
97 b->priv.flags |= KB_CACHE_DIRTY;
99 b->priv.flags &= ~KB_CACHE_DIRTY;
103 size_t kblock_read(struct KBlock *b, block_idx_t idx, void *buf, size_t offset, size_t size)
107 ASSERT(offset + size <= b->blk_size);
108 LOG_INFO("blk_idx %ld, offset %u, size %u\n", idx, offset, size);
110 if (kblock_buffered(b) && idx == b->priv.curr_blk)
111 return kblock_readBuf(b, buf, offset, size);
113 return kblock_readDirect(b, idx, buf, offset, size);
117 int kblock_flush(struct KBlock *b)
121 if (!kblock_buffered(b))
124 if (kblock_cacheDirty(b))
126 LOG_INFO("flushing block %ld\n", b->priv.curr_blk);
127 if (kblock_store(b, b->priv.curr_blk) == 0)
128 kblock_setDirty(b, false);
136 static bool kblock_loadPage(struct KBlock *b, block_idx_t idx)
140 if (idx != b->priv.curr_blk)
142 LOG_INFO("loading block %ld\n", idx);
143 if (kblock_flush(b) != 0 || kblock_load(b, idx) != 0)
146 b->priv.curr_blk = idx;
152 int kblock_trim(struct KBlock *b, block_idx_t start, block_idx_t count)
154 ASSERT(start + count <= b->blk_cnt);
156 if (kblock_buffered(b))
158 if (!kblock_loadPage(b, start))
162 b->priv.blk_start += start;
163 b->priv.curr_blk = 0; // adjust logical address
169 size_t kblock_write(struct KBlock *b, block_idx_t idx, const void *buf, size_t offset, size_t size)
173 ASSERT(idx < b->blk_cnt);
174 ASSERT(offset + size <= b->blk_size);
176 LOG_INFO("blk_idx %ld, offset %u, size %u\n", idx, offset, size);
178 if (kblock_buffered(b))
180 if (!kblock_loadPage(b, idx))
183 kblock_setDirty(b, true);
184 return kblock_writeBuf(b, buf, offset, size);
189 if (offset != 0 || size != b->blk_size)
190 ASSERT(kblock_partialWrite(b));
192 return kblock_writeDirect(b, idx, buf, offset, size);
196 int kblock_copy(struct KBlock *b, block_idx_t src, block_idx_t dest)
199 ASSERT(src < b->blk_cnt);
200 ASSERT(dest < b->blk_cnt);
202 if (kblock_buffered(b))
204 if (!kblock_loadPage(b, src))
207 b->priv.curr_blk = dest;
208 kblock_setDirty(b, true);
211 else if (kblock_partialWrite(b))
214 size_t blk_size = b->blk_size;
219 size_t size = MIN(sizeof(buf), blk_size);
220 if (kblock_readDirect(b, src, buf, offset, size) != size)
222 if (kblock_writeDirect(b, dest, buf, offset, size) != size)
237 int kblock_swLoad(struct KBlock *b, block_idx_t index)
240 * Since this is a low level API, the index here is a fisical index.
241 * If we call another low level API, logical to fisical translation
242 * would be applied twice.
243 * In order to avoid this we subtract the start block index.
245 ASSERT(index >= b->priv.blk_start);
246 return (kblock_readDirect(b, index - b->priv.blk_start, b->priv.buf, 0, b->blk_size) == b->blk_size) ? 0 : EOF;
249 int kblock_swStore(struct KBlock *b, block_idx_t index)
252 * Since this is a low level API, the index here is a fisical index.
253 * If we call another low level API, logical to fisical translation
254 * would be applied twice.
255 * In order to avoid this we subtract the start block index.
257 ASSERT(index >= b->priv.blk_start);
258 return (kblock_writeDirect(b, index - b->priv.blk_start, b->priv.buf, 0, b->blk_size) == b->blk_size) ? 0 : EOF;
261 size_t kblock_swReadBuf(struct KBlock *b, void *buf, size_t offset, size_t size)
264 ASSERT(offset + size <= b->blk_size);
266 memcpy(buf, (uint8_t *)b->priv.buf + offset, size);
270 size_t kblock_swWriteBuf(struct KBlock *b, const void *buf, size_t offset, size_t size)
273 ASSERT(offset + size <= b->blk_size);
274 memcpy((uint8_t *)b->priv.buf + offset, buf, size);
278 int kblock_swClose(UNUSED_ARG(struct KBlock, *b))