bertos/io/kfile.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 2007 Develer S.r.l. (http://www.develer.com/)
  30  * -->
  31  *
  32  * \brief Virtual KFile I/O interface.
  33  *
  34  * This module implements some generic I/O interfaces for kfile.
  35  *
  36  * \author Francesco Sacchi <batt@develer.com>
  37  * \author Daniele Basile <asterix@develer.com>
  38  */
  39
  40 #include "kfile.h"
  41
  42 #include "cfg/cfg_kfile.h"
  43 #include <cfg/debug.h>
  44 #include <cfg/log.h>
  45
  46 #include <drv/timer.h>
  47 #include <mware/formatwr.h>
  48
  49 #include <string.h>
  50
  51 /*
  52  * Sanity check for config parameters required by this module.
  53  */
  54 #if !defined(CONFIG_KFILE_GETS) || ((CONFIG_KFILE_GETS != 0) && CONFIG_KFILE_GETS != 1)
  55         #error CONFIG_KFILE_GETS must be set to either 0 or 1 in appconfig.h
  56 #endif
  57 #if !defined(CONFIG_PRINTF)
  58         #error CONFIG_PRINTF missing in appconfig.h
  59 #endif
  60
  61
  62 /**
  63  * Generic putc() implementation using \a fd->write.
  64  */
  65 int kfile_putc(int _c, struct KFile *fd)
  66 {
  67         unsigned char c = (unsigned char)_c;
  68
  69         if (kfile_write(fd, &c, sizeof(c)) == sizeof(c))
  70                 return (int)((unsigned char)_c);
  71         else
  72                 return EOF;
  73 }
  74
  75 /**
  76  * Generic getc() implementation using \a fd->read.
  77  */
  78 int kfile_getc(struct KFile *fd)
  79 {
  80         unsigned char c;
  81
  82         if (kfile_read(fd, &c, sizeof(c)) == sizeof(c))
  83                 return (int)((unsigned char)c);
  84         else
  85                 return EOF;
  86 }
  87
  88 #if CONFIG_PRINTF
  89 /**
  90  * Formatted write.
  91  */
  92 int kfile_printf(struct KFile *fd, const char *format, ...)
  93 {
  94         va_list ap;
  95         int len;
  96
  97         va_start(ap, format);
  98         len = _formatted_write(format, (void (*)(char, void *))kfile_putc, fd, ap);
  99         va_end(ap);
 100
 101         return len;
 102 }
 103 #endif /* CONFIG_PRINTF */
 104
 105 /**
 106  * Write a string to kfile \a fd.
 107  * \return 0 if OK, EOF in case of error.
 108  */
 109 int kfile_print(struct KFile *fd, const char *s)
 110 {
 111         while (*s)
 112         {
 113                 if (kfile_putc(*s++, fd) == EOF)
 114                         return EOF;
 115         }
 116         return 0;
 117 }
 118
 119 #if CONFIG_KFILE_GETS
 120 /**
 121  * Read a line long at most as size and put it
 122  * in buf.
 123  * \return number of chars read or EOF in case
 124  *         of error.
 125  */
 126 int kfile_gets(struct KFile *fd, char *buf, int size)
 127 {
 128         return kfile_gets_echo(fd, buf, size, false);
 129 }
 130
 131
 132 /**
 133  * Read a line long at most as size and put it
 134  * in buf, with optional echo.
 135  *
 136  * \return number of chars read, or EOF in case
 137  *         of error.
 138  */
 139 int kfile_gets_echo(struct KFile *fd, char *buf, int size, bool echo)
 140 {
 141         int i = 0;
 142         int c;
 143
 144         for (;;)
 145         {
 146                 if ((c = kfile_getc(fd)) == EOF)
 147                 {
 148                         buf[i] = '\0';
 149                         return -1;
 150                 }
 151
 152                 /* FIXME */
 153                 if (c == '\r' || c == '\n' || i >= size-1)
 154                 {
 155                         buf[i] = '\0';
 156                         if (echo)
 157                                 kfile_print(fd, "\r\n");
 158                         break;
 159                 }
 160                 buf[i++] = c;
 161                 if (echo)
 162                         kfile_putc(c, fd);
 163         }
 164
 165         return i;
 166 }
 167 #endif /* !CONFIG_KFILE_GETS */
 168
 169
 170 kfile_off_t kfile_copy(KFile *src, KFile *dst, kfile_off_t size)
 171 {
 172         char buf[32];
 173         kfile_off_t cp_len = 0;
 174
 175         while (size)
 176         {
 177                 size_t len = MIN(sizeof(buf), (size_t)size);
 178                 if (kfile_read(src, buf, len) != len)
 179                         break;
 180
 181                 size_t wr_len = kfile_write(dst, buf, len);
 182                 cp_len += wr_len;
 183                 size -= len;
 184
 185                 if (wr_len != len)
 186                         break;
 187         }
 188
 189         return cp_len;
 190 }
 191
 192
 193 /**
 194  * Move \a fd file seek position of \a offset bytes from \a whence.
 195  *
 196  * This is a generic implementation of seek function, you can redefine
 197  * it in your local module if needed.
 198  */
 199 kfile_off_t kfile_genericSeek(struct KFile *fd, kfile_off_t offset, KSeekMode whence)
 200 {
 201         kfile_off_t seek_pos;
 202
 203         switch (whence)
 204         {
 205
 206         case KSM_SEEK_SET:
 207                 seek_pos = 0;
 208                 break;
 209         case KSM_SEEK_END:
 210                 seek_pos = fd->size;
 211                 break;
 212         case KSM_SEEK_CUR:
 213                 seek_pos = fd->seek_pos;
 214                 break;
 215         default:
 216                 ASSERT(0);
 217                 return EOF;
 218                 break;
 219         }
 220
 221         /* Bound check */
 222         if (seek_pos + offset > fd->size)
 223                 LOG_INFO("seek outside EOF\n");
 224
 225         fd->seek_pos = seek_pos + offset;
 226
 227         return fd->seek_pos;
 228 }
 229
 230 /**
 231  * Reopen file \a fd.
 232  * This is a generic implementation that only flush file
 233  * and reset seek_pos to 0.
 234  */
 235 struct KFile * kfile_genericReopen(struct KFile *fd)
 236 {
 237         kfile_flush(fd);
 238         kfile_seek(fd, 0, KSM_SEEK_SET);
 239         return fd;
 240 }
 241
 242 /**
 243  * Close file \a fd.
 244  * This is a generic implementation that only flush the file.
 245  */
 246 int kfile_genericClose(struct KFile *fd)
 247 {
 248         return kfile_flush(fd);
 249 }
 250
 251
 252 /**
 253  * Discard input to resynchronize with remote end.
 254  *
 255  * Discard incoming data until the kfile_getc stops receiving
 256  * characters for at least \a delay milliseconds.
 257  *
 258  * \note If the timeout occur, we reset the error before to
 259  * quit.
 260  */
 261 void kfile_resync(KFile *fd, mtime_t delay)
 262 {
 263         ticks_t start_time = timer_clock();
 264         for(;;)
 265         {
 266                 if(kfile_getc(fd) != EOF)
 267                         start_time = timer_clock();
 268
 269                 if ((timer_clock() - start_time) > ms_to_ticks(delay))
 270                 {
 271                         kfile_clearerr(fd);
 272                         break;
 273                 }
 274
 275         }
 276 }
 277
 278 /**
 279  * Stub function that does nothing.
 280  * This is a generic implementation that only return 0.
 281  */
 282 static int kfile_generic(UNUSED_ARG(struct KFile *, fd))
 283 {
 284         return 0;
 285 };
 286
 287
 288 /**
 289  * Base class KFile constructor.
 290  */
 291 void kfile_init(struct KFile *fd)
 292 {
 293         ASSERT(fd);
 294         memset(fd, 0, sizeof(*fd));
 295         fd->clearerr = (ClearErrFunc_t)kfile_generic;
 296         fd->close =  kfile_genericClose;
 297         fd->error = kfile_generic;
 298         fd->flush = kfile_generic;
 299         fd->read = (ReadFunc_t)kfile_generic;
 300         fd->reopen = kfile_genericReopen;
 301         fd->seek = kfile_genericSeek;
 302         fd->write = (WriteFunc_t)kfile_generic;
 303 }
 304