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 Test suite for virtual KFile I/O interface.
34 * This module implements a test for some generic I/O interfaces for kfile.
37 * \author Francesco Sacchi <batt@develer.com>
38 * \author Daniele Basile <asterix@develer.com>
45 #include "cfg/cfg_kfile.h"
46 #include <cfg/debug.h>
47 #include <cfg/module.h>
49 // Define logging setting (for cfg/log.h module).
50 #define LOG_LEVEL KFILE_LOG_LEVEL
51 #define LOG_VERBOSITY KFILE_LOG_VERBOSITY
54 #include <mware/formatwr.h>
60 MOD_DEFINE(kfile_test);
64 * KFile read/write subtest.
65 * Try to write/read in the same \a f file location \a size bytes.
66 * \return true if all is ok, false otherwise
67 * \note Restore file position at exit (if no error)
68 * \note Test buffer \a buf must be filled with
69 * the following statement:
74 static bool kfile_rwTest(KFile *f, uint8_t *buf, size_t size)
79 if (kfile_write(f, buf, size) != size)
82 kfile_seek(f, -(kfile_off_t)size, KSM_SEEK_CUR);
90 * Read file in test buffer
92 if (kfile_read(f, buf, size) != size)
94 kfile_seek(f, -(kfile_off_t)size, KSM_SEEK_CUR);
99 for (size_t i = 0; i < size; i++)
100 if (buf[i] != (i & 0xff))
107 * Setup all needed for kfile test
109 int kfile_testSetUp(void)
111 MOD_INIT(kfile_test);
112 LOG_INFO("Mod init..ok\n");
119 * KFile read/write test.
120 * This function write and read \a test_buf long \a size
122 * \a save_buf can be NULL or a buffer where to save previous file content.
124 int kfile_testRun(KFile *fd, uint8_t *test_buf, uint8_t *save_buf, size_t size)
128 * Part of test buf size that you would write.
129 * This var is used in test 3 to check kfile_write
130 * when writing beyond filesize limit.
132 kfile_off_t len = size / 2;
135 /* Fill test buffer */
136 for (size_t i = 0; i < size; i++)
137 test_buf[i] = (i & 0xff);
140 * If necessary, user can save content,
145 kfile_read(fd, save_buf, size);
146 LOG_INFO("Saved content..form [%lu] to [%lu]\n", fd->seek_pos, fd->seek_pos + size);
150 LOG_INFO("Test 1: write from pos 0 to [%lu]\n", size);
155 if (kfile_seek(fd, 0, KSM_SEEK_SET) != 0)
159 * Test read/write to address 0..size
161 if (!kfile_rwTest(fd, test_buf, size))
164 LOG_INFO("Test 1: ok!\n");
167 * Restore previous read content.
171 kfile_seek(fd, 0, KSM_SEEK_SET);
173 if (kfile_write(fd, save_buf, size) != size)
176 LOG_INFO("Restore content..form [%lu] to [%lu]\n", fd->seek_pos, fd->seek_pos + size);
181 LOG_INFO("Test 2: write from pos [%lu] to [%lu]\n", fd->size/2 , fd->size/2 + size);
184 * Go to half test size.
186 kfile_seek(fd, (fd->size / 2), KSM_SEEK_SET);
189 * If necessary, user can save content
194 kfile_read(fd, save_buf, size);
195 kfile_seek(fd, -(kfile_off_t)size, KSM_SEEK_CUR);
196 LOG_INFO("Saved content..form [%lu] to [%lu]\n", fd->seek_pos, fd->seek_pos + size);
200 * Test read/write to address filesize/2 ... filesize/2 + size
202 if (!kfile_rwTest(fd, test_buf, size))
205 LOG_INFO("Test 2: ok!\n");
208 * Restore previous content.
212 kfile_seek(fd, -(kfile_off_t)size, KSM_SEEK_CUR);
214 if (kfile_write(fd, save_buf, size) != size)
217 LOG_INFO("Restore content..form [%lu] to [%lu]\n", fd->seek_pos, fd->seek_pos + size);
223 LOG_INFO("Test 3: write outside of fd->size limit [%lu]\n", fd->size);
224 LOG_INFO("This test should FAIL!, you must see an assertion fail message.\n");
227 * Go to the Flash end
229 kfile_seek(fd, -len, KSM_SEEK_END);
232 * If necessary, user can save content,
237 kfile_read(fd, save_buf, len);
238 kfile_seek(fd, -len, KSM_SEEK_CUR);
239 LOG_INFO("Saved content..form [%lu] to [%lu]\n", fd->seek_pos, fd->seek_pos + len);
243 * Test read/write to address (filesize - size) ... filesize
245 if (kfile_rwTest(fd, test_buf, size))
248 kprintf("Test 3: ok!\n");
251 * Restore previous read content
255 kfile_seek(fd, -len, KSM_SEEK_END);
257 if ((kfile_off_t)kfile_write(fd, save_buf, len) != len)
260 LOG_INFO("Restore content..form [%lu] to [%lu]\n", fd->seek_pos, fd->seek_pos + len);
270 LOG_ERR("One kfile_test fail!\n");
275 * End a dataflash Test.
278 int kfile_testTearDown(void)