X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=kern%2Fkfile.c;h=22da2a70f3f3fdf76c41f3218ec1ba1df9f560bb;hb=HEAD;hp=1e542a333a66e2a44060a9491f6640aa9fb4278b;hpb=4ce821445da18cea824dc2b6ef69a68f2e53e341;p=bertos.git diff --git a/kern/kfile.c b/kern/kfile.c deleted file mode 100644 index 1e542a33..00000000 --- a/kern/kfile.c +++ /dev/null @@ -1,420 +0,0 @@ -/** - * \file - * - * - * \brief Virtual KFile I/O interface. - * This module implements some generic I/O interfaces for kfile. - * - * \version $Id$ - * \author Francesco Sacchi - * \author Daniele Basile - * - */ - - -#include "kfile.h" -#include - -#include -#include -#include - -/* - * Sanity check for config parameters required by this module. - */ -#if !defined(CONFIG_KFILE_GETS) || ((CONFIG_KFILE_GETS != 0) && CONFIG_KFILE_GETS != 1) - #error CONFIG_KFILE_GETS must be set to either 0 or 1 in appconfig.h -#endif -#if !defined(CONFIG_PRINTF) - #error CONFIG_PRINTF missing in appconfig.h -#endif - - -/** - * Generic putc implementation using \a fd->write. - */ -int kfile_putc(int _c, struct KFile *fd) -{ - unsigned char c = (unsigned char)_c; - - if (kfile_write(fd, &c, sizeof(c)) == sizeof(c)) - return (int)((unsigned char)_c); - else - return EOF; -} - -/** - * Generic getc implementation using \a fd->read. - */ -int kfile_getc(struct KFile *fd) -{ - unsigned char c; - - if (kfile_read(fd, &c, sizeof(c)) == sizeof(c)) - return (int)((unsigned char)c); - else - return EOF; -} - -#if CONFIG_PRINTF -/** - * Formatted write. - */ -int kfile_printf(struct KFile *fd, const char *format, ...) -{ - va_list ap; - int len; - - va_start(ap, format); - len = _formatted_write(format, (void (*)(char, void *))kfile_putc, fd, ap); - va_end(ap); - - return len; -} -#endif /* CONFIG_PRINTF */ - -/** - * Write a string to kfile \a fd. - * \return 0 if OK, EOF in case of error. - */ -int kfile_print(struct KFile *fd, const char *s) -{ - while (*s) - { - if (kfile_putc(*s++, fd) == EOF) - return EOF; - } - return 0; -} - -#if CONFIG_KFILE_GETS -/** - * Read a line long at most as size and put it - * in buf. - * \return number of chars read or EOF in case - * of error. - */ -int kfile_gets(struct KFile *fd, char *buf, int size) -{ - return kfile_gets_echo(fd, buf, size, false); -} - - -/** - * Read a line long at most as size and put it - * in buf, with optional echo. - * - * \return number of chars read, or EOF in case - * of error. - */ -int kfile_gets_echo(struct KFile *fd, char *buf, int size, bool echo) -{ - int i = 0; - int c; - - for (;;) - { - if ((c = kfile_getc(fd)) == EOF) - { - buf[i] = '\0'; - return -1; - } - - /* FIXME */ - if (c == '\r' || c == '\n' || i >= size-1) - { - buf[i] = '\0'; - if (echo) - kfile_print(fd, "\r\n"); - break; - } - buf[i++] = c; - if (echo) - kfile_putc(c, fd); - } - - return i; -} -#endif /* !CONFIG_KFILE_GETS */ - - -/** - * Move \a fd file seek position of \a offset bytes from \a whence. - * - * This is a generic implementation of seek function, you can redefine - * it in your local module if needed. - */ -kfile_off_t kfile_genericSeek(struct KFile *fd, kfile_off_t offset, KSeekMode whence) -{ - uint32_t seek_pos; - - switch (whence) - { - - case KSM_SEEK_SET: - seek_pos = 0; - break; - case KSM_SEEK_END: - seek_pos = fd->size - 1; - break; - case KSM_SEEK_CUR: - seek_pos = fd->seek_pos; - break; - default: - ASSERT(0); - return EOF; - break; - } - - /* Bound check */ - if (seek_pos + offset > fd->size) - { - ASSERT(0); - return EOF; - } - - fd->seek_pos = seek_pos + offset; - - return fd->seek_pos; -} - -/** - * Reopen file \a fd. - * This is a generic implementation that only flush file - * and reset seek_pos to 0. - */ -struct KFile * kfile_genericReopen(struct KFile *fd) -{ - kfile_flush(fd); - kfile_seek(fd, 0, KSM_SEEK_SET); - return fd; -} - -#if CONFIG_TEST - -/** - * KFile read/write subtest. - * Try to write/read in the same \a f file location \a size bytes. - * \return true if all is ok, false otherwise - * \note Restore file position at exit (if no error) - * \note Test buffer \a buf must be filled with - * the following statement: - * 
- * buf[i] = i & 0xff
- *
- */ -static bool kfile_rwTest(KFile *f, uint8_t *buf, size_t size) -{ - /* - * Write test buffer - */ - if (kfile_write(f, buf, size) != size) - return false; - - kfile_seek(f, -(kfile_off_t)size, KSM_SEEK_CUR); - - /* - * Reset test buffer - */ - memset(buf, 0, size); - - /* - * Read file in test buffer - */ - if (kfile_read(f, buf, size) != size) - return false; - kfile_seek(f, -(kfile_off_t)size, KSM_SEEK_CUR); - - /* - * Check test result - */ - for (size_t i = 0; i < size; i++) - if (buf[i] != (i & 0xff)) - return false; - - return true; -} - -/** - * KFile read/write test. - * This function write and read \a test_buf long \a size - * on \a fd handler. - * \a save_buf can be NULL or a buffer where to save previous file content. - */ -bool kfile_test(KFile *fd, uint8_t *test_buf, uint8_t *save_buf, size_t size) -{ - /* - * Part of test buf size that you would write. - * This var is used in test 3 to check kfile_write - * when writing beyond filesize limit. - */ - kfile_off_t len = size / 2; - - - /* Fill test buffer */ - for (size_t i = 0; i < size; i++) - test_buf[i] = (i & 0xff); - - /* - * If necessary, user can save content, - * for later restore. - */ - if (save_buf) - { - kfile_read(fd, save_buf, size); - kprintf("Saved content..form [%lu] to [%lu]\n", fd->seek_pos, fd->seek_pos + size); - } - - /* TEST 1 BEGIN. */ - kprintf("Test 1: write from pos 0 to [%lu]\n", size); - - /* - * Seek to addr 0. - */ - if (kfile_seek(fd, 0, KSM_SEEK_SET) != 0) - goto kfile_test_end; - - /* - * Test read/write to address 0..size - */ - if (!kfile_rwTest(fd, test_buf, size)) - goto kfile_test_end; - - kprintf("Test 1: ok!\n"); - - /* - * Restore previous read content. - */ - if (save_buf) - { - kfile_seek(fd, 0, KSM_SEEK_SET); - - if (kfile_write(fd, save_buf, size) != size) - goto kfile_test_end; - - kprintf("Restore content..form [%lu] to [%lu]\n", fd->seek_pos, fd->seek_pos + size); - } - /* TEST 1 END. */ - - /* TEST 2 BEGIN. */ - kprintf("Test 2: write from pos [%lu] to [%lu]\n", fd->size/2 , fd->size/2 + size); - - /* - * Go to half test size. - */ - kfile_seek(fd, (fd->size / 2), KSM_SEEK_SET); - - /* - * If necessary, user can save content - * for later restore. - */ - if (save_buf) - { - kfile_read(fd, save_buf, size); - kfile_seek(fd, -(kfile_off_t)size, KSM_SEEK_CUR); - kprintf("Saved content..form [%lu] to [%lu]\n", fd->seek_pos, fd->seek_pos + size); - } - - /* - * Test read/write to address filesize/2 ... filesize/2 + size - */ - if (!kfile_rwTest(fd, test_buf, size)) - goto kfile_test_end; - - kprintf("Test 2: ok!\n"); - - /* - * Restore previous content. - */ - if (save_buf) - { - kfile_seek(fd, -(kfile_off_t)size, KSM_SEEK_CUR); - - if (kfile_write(fd, save_buf, size) != size) - goto kfile_test_end; - - kprintf("Restore content..form [%lu] to [%lu]\n", fd->seek_pos, fd->seek_pos + size); - } - - /* TEST 2 END. */ - - /* TEST 3 BEGIN. */ - kprintf("Test 3: write outside of fd->size limit [%lu]\n", fd->size); - kprintf("This test should FAIL!, you must see an assertion fail message.\n"); - - /* - * Go to the Flash end - */ - kfile_seek(fd, -len, KSM_SEEK_END); - - /* - * If necessary, user can save content, - * for later restore. - */ - if (save_buf) - { - kfile_read(fd, save_buf, len); - kfile_seek(fd, -len, KSM_SEEK_CUR); - kprintf("Saved content..form [%lu] to [%lu]\n", fd->seek_pos, fd->seek_pos + len); - } - - /* - * Test read/write to address (filesize - size) ... filesize - */ - if (kfile_rwTest(fd, test_buf, size)) - goto kfile_test_end; - - kprintf("Test 3: ok!\n"); - - /* - * Restore previous read content - */ - if (save_buf) - { - kfile_seek(fd, -len, KSM_SEEK_END); - - if (kfile_write(fd, save_buf, len) != len) - goto kfile_test_end; - - kprintf("Restore content..form [%lu] to [%lu]\n", fd->seek_pos, fd->seek_pos + len); - } - - /* TEST 3 END. */ - - kfile_close(fd); - return true; - -kfile_test_end: - kfile_close(fd); - return false; -} - -#endif /* CONFIG_TEST */