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 2007 Develer S.r.l. (http://www.develer.com/)
33 * \brief Virtual KFile I/O interface.
34 * This module implement a standard fd.seek and a kfile
38 * \author Francesco Sacchi <batt@develer.com>
39 * \author Daniele Basile <asterix@develer.com>
43 #include <kern/kfile.h>
44 #include <cfg/debug.h>
48 #include <appconfig.h>
51 * Move \a fd file seek position of \a offset bytes
52 * from current position.
53 * This is a generic implementation of seek function, you should redefine
54 * it in your local module.
56 kfile_off_t kfile_seek(struct _KFile *fd, kfile_off_t offset, KSeekMode whence)
67 seek_pos = fd->size - 1;
70 seek_pos = fd->seek_pos;
80 if (seek_pos + offset > fd->size)
86 fd->seek_pos = seek_pos + offset;
87 kprintf("Flash seek to [%lu]\n", fd->seek_pos);
95 * Program memory read/write subtest.
96 * Try to write/read in the same \a f file location \a _size bytes.
97 * \return true if all is ok, false otherwise
98 * \note Restore file position at exit (if no error)
99 * \note Test buffer \a buf must be filled with
100 * the following statement:
105 static bool kfile_rwTest(KFile *f, uint8_t *buf, size_t _size)
107 int32_t size = _size;
110 if (f->write(f, buf, size) != size)
112 f->seek(f, -size, KSM_SEEK_CUR);
115 memset(buf, 0, size);
117 // Read flash in test buffer
118 if (f->read(f, buf, size) != size)
120 f->seek(f, -size, KSM_SEEK_CUR);
123 for (size_t i = 0; i < size; i++)
124 if (buf[i] != (i & 0xff))
131 * Test for program memory read/write.
132 * This function write and read \p test_buf long \p _size
133 * on \p fd handler. If you want not overwrite exist data
134 * you should pass an \p save_buf where test store exist data,
135 * otherwise su must pass NULL.
137 bool kfile_test(KFile *fd, uint8_t *test_buf, size_t _size , uint8_t *save_buf, size_t save_buf_size)
139 int32_t size = _size;
142 * Part of test buf size that you would write.
143 * This var is useded in test 3 to check fd.write
144 * when write outside size limit. Normaly we want
145 * perform a write until is space to write, otherwise
148 int32_t len = size/2;
151 /* Fill test buffer */
152 for (size_t i = 0; i < size; i++)
153 test_buf[i] = (i & 0xff);
158 fd->open(fd, NULL, 0);
159 kprintf("Opened fd handler..\n");
162 * If necessary, user could save content,
165 if (save_buf != NULL)
167 fd->read(fd, save_buf, save_buf_size);
168 kprintf("Saved content..form [%lu] to [%lu]\n", fd->seek_pos, fd->seek_pos + save_buf_size);
172 kprintf("Test 1: write from pos 0 to [%lu]\n", size);
177 if (fd->seek(fd, 0, KSM_SEEK_SET) != 0)
181 * Test flash read/write to address 0..size
183 if (!kfile_rwTest(fd, test_buf, size))
186 kprintf("Test 1: ok!\n");
189 * Restore previous read content
191 if (save_buf != NULL)
193 fd->seek(fd, 0, KSM_SEEK_SET);
195 if (fd->write(fd, save_buf, save_buf_size) != size)
198 kprintf("Restore content..form [%lu] to [%lu]\n", fd->seek_pos, fd->seek_pos + save_buf_size);
203 kprintf("Test 2: write from pos [%lu] to [%lu]\n", fd->size/2 , size);
206 * Go to half test size.
208 fd->seek(fd, (fd->size/ 2), KSM_SEEK_SET);
211 * If necessary, user could save content,
214 if (save_buf != NULL)
216 fd->read(fd, save_buf, save_buf_size);
217 fd->seek(fd, -size, KSM_SEEK_CUR);
218 kprintf("Saved content..form [%lu] to [%lu]\n", fd->seek_pos, fd->seek_pos + save_buf_size);
222 * Test flash read/write to address FLASHEND/2 ... FLASHEND/2 + size
224 if (!kfile_rwTest(fd, test_buf, size))
227 kprintf("Test 2: ok!\n");
230 * Restore previous read content
232 if (save_buf != NULL)
234 fd->seek(fd, -size, KSM_SEEK_CUR);
236 if (fd->write(fd, save_buf, save_buf_size) != size)
239 kprintf("Restore content..form [%lu] to [%lu]\n", fd->seek_pos, fd->seek_pos + save_buf_size);
245 kprintf("Test 3: write outside of fd->size limit [%lu]\n", fd->size);
248 * Go to the Flash end
250 fd->seek(fd, -len, KSM_SEEK_END);
253 * If necessary, user could save content,
256 if (save_buf != NULL)
258 ASSERT(len > save_buf_size);
260 fd->read(fd, save_buf, len);
261 fd->seek(fd, -len, KSM_SEEK_CUR);
262 kprintf("Saved content..form [%lu] to [%lu]\n", fd->seek_pos, fd->seek_pos + len);
266 * Test flash read/write to address (FLASHEND - size) ... FLASHEND
268 if (kfile_rwTest(fd, test_buf, size))
271 kprintf("Test 3: ok !\n");
274 * Restore previous read content
276 if (save_buf != NULL)
278 fd->seek(fd, -len, KSM_SEEK_END);
280 if (fd->write(fd, save_buf, len) != len)
283 kprintf("Restore content..form [%lu] to [%lu]\n", fd->seek_pos, fd->seek_pos + len);
296 #endif /* CONFIG_TEST */