bertos/kern/kfile.h

   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 2004 Develer S.r.l. (http://www.develer.com/)
  30  * Copyright 1999, 2000, 2001, 2003 Bernie Innocenti <bernie@codewiz.org>
  31  *
  32  * -->
  33  *
  34  * \brief Virtual KFile I/O interface.
  35  *
  36  * KFile is a simple, generic interface for file I/O.  It uses an
  37  * object-oriented model to supply a device-neutral interface to
  38  * communicate with drivers.
  39  *
  40  * This module contains only definitions, the instance structure
  41  * and the common API.
  42  * Each KFile subclass can override one or more methods of the interface,
  43  * and can extend the base KFile structure with its own private data.
  44  * For instance, a serial driver might implement the KFile interface by
  45  * declaring a context structure like this:
  46  *
  47  * \code
  48  * typedef struct Serial
  49  * {
  50  *      // base class instance
  51  *      KFile fd;
  52  *
  53  *      // private instance data
  54  *      FIFOBuffer txfifo, rxfifo;
  55  * } Serial;
  56  * \endcode
  57  *
  58  * You should also supply a macro for casting KFile to Serial:
  59  *
  60  * \code
  61  * INLINE Serial * SERIAL_CAST(KFile *fd)
  62  * {
  63  *              ASSERT(fd->_type == KFT_SERIAL);
  64  *              return (Serial *)fd;
  65  * }
  66  * \endcode
  67  *
  68  * Then you can implement as many interface functions as needed
  69  * and leave the rest to NULL.
  70  *
  71  * Example implementation of the close KFile method for Serial:
  72  *
  73  * \code
  74  * static int ser_kfile_close(struct KFile *fd)
  75  * {
  76  *              Serial *fds = SERIAL_CAST(fd);
  77  *      // [driver specific code here]
  78  *              return 0;
  79  * }
  80  * \endcode
  81  *
  82  * The SERIAL_CAST() macro helps ensure that the passed object is
  83  * really of type Serial.
  84  *
  85  * The KFile interface does not supply an open function: this is deliberate,
  86  * because in embedded systems each device has its own init parameters.
  87  * For the same reason, specific device settings like, for example,
  88  * the baudrate, are not part of interface and should be handled by the
  89  * driver-specific API.
  90  *
  91  * \version $Id$
  92  * \author Bernie Innocenti <bernie@codewiz.org>
  93  * \author Francesco Sacchi <batt@develer.com>
  94  * \author Daniele Basile <asterix@develer.com>
  95  *
  96  * $WIZARD_MODULE = {
  97  * "name" : "kfile",
  98  * "depends" : [],
  99  * "configuration" : "bertos/cfg/cfg_kfile.h"
 100  * }
 101  */
 102
 103 #ifndef KERN_KFILE_H
 104 #define KERN_KFILE_H
 105
 106 #include <cfg/compiler.h>
 107 #include <cfg/debug.h>
 108 #include <cfg/macros.h>
 109
 110 /* fwd decl */
 111 struct KFile;
 112
 113 typedef int32_t kfile_off_t;     ///< KFile offset type, used by kfile_seek().
 114
 115 /**
 116  * Costants for repositioning read/write file offset.
 117  * These are needed because on some embedded platforms
 118  * ANSI I/O library may not be present.
 119  */
 120 typedef enum KSeekMode
 121 {
 122         KSM_SEEK_SET, ///< Seek from file beginning.
 123         KSM_SEEK_CUR, ///< Seek from file current position.
 124         KSM_SEEK_END, ///< Seek from file end.
 125 } KSeekMode;
 126
 127 /**
 128  * Prototypes for KFile access functions.
 129  * I/O file functions must be ANSI compliant.
 130  * \note A KFile user can choose which function subset to implement,
 131  *       but has to set to NULL unimplemented features.
 132  * \{
 133  */
 134
 135 /**
 136  * Read from file.
 137  * \return the number of bytes read.
 138  */
 139 typedef size_t (*ReadFunc_t) (struct KFile *fd, void *buf, size_t size);
 140
 141 /**
 142  * Write to file.
 143  * \return the number of bytes written.
 144  */
 145 typedef size_t (*WriteFunc_t) (struct KFile *fd, const void *buf, size_t size);
 146
 147 /**
 148  * Seek into file (if seekable).
 149  * \return the new file offset or EOF on errors.
 150  */
 151 typedef kfile_off_t (*SeekFunc_t) (struct KFile *fd, kfile_off_t offset, KSeekMode whence);
 152
 153 /**
 154  * Close and reopen file \a fd.
 155  * The reopening is done with the former file parameters and access modes.
 156  */
 157 typedef struct KFile * (*ReOpenFunc_t) (struct KFile *fd);
 158
 159 /**
 160  * Close file.
 161  * \return 0 on success, EOF on errors.
 162  */
 163 typedef int (*CloseFunc_t) (struct KFile *fd);
 164
 165 /**
 166  * Flush file I/O.
 167  * \return 0 on success, EOF on errors.
 168  */
 169 typedef int (*FlushFunc_t) (struct KFile *fd);
 170
 171 /**
 172  * Get file error mask.
 173  * \return 0 on success or file error code, device specific.
 174  */
 175 typedef int (*ErrorFunc_t) (struct KFile *fd);
 176
 177 /**
 178  * Clear errors.
 179  */
 180 typedef void (*ClearErrFunc_t) (struct KFile *fd);
 181 /* \} */
 182
 183 /**
 184  * Context data for callback functions which operate on
 185  * pseudo files.
 186  *
 187  * \note Remember to add the corresponding accessor functions
 188  *       when extending this interface.
 189  */
 190 typedef struct KFile
 191 {
 192         ReadFunc_t     read;
 193         WriteFunc_t    write;
 194         ReOpenFunc_t   reopen;
 195         CloseFunc_t    close;
 196         SeekFunc_t     seek;
 197         FlushFunc_t    flush;
 198         ErrorFunc_t    error;
 199         ClearErrFunc_t clearerr;
 200         DB(id_t _type); ///< Used to keep track, at runtime, of the class type.
 201
 202         /* NOTE: these must _NOT_ be size_t on 16bit CPUs! */
 203         kfile_off_t    seek_pos;
 204         kfile_off_t    size;
 205 } KFile;
 206
 207 /**
 208  * Generic implementation of kfile_seek.
 209  */
 210 kfile_off_t kfile_genericSeek(struct KFile *fd, kfile_off_t offset, KSeekMode whence);
 211
 212 /**
 213  * Generic implementation of kfile_reopen.
 214  */
 215 struct KFile * kfile_genericReopen(struct KFile *fd);
 216
 217 int kfile_genericClose(struct KFile *fd);
 218
 219 int kfile_putc(int c, struct KFile *fd); ///< Generic putc implementation using kfile_write.
 220 int kfile_getc(struct KFile *fd);  ///< Generic getc implementation using kfile_read.
 221 int kfile_printf(struct KFile *fd, const char *format, ...);
 222 int kfile_print(struct KFile *fd, const char *s);
 223 int kfile_gets(struct KFile *fd, char *buf, int size);
 224 int kfile_gets_echo(struct KFile *fd, char *buf, int size, bool echo);
 225 void kfile_resync(KFile *fd, mtime_t delay);
 226
 227 /**
 228  * Interface functions for KFile access.
 229  * \note Remember to change following functions if KFile interface changes.
 230  * \{
 231  */
 232 INLINE size_t kfile_read(struct KFile *fd, void *buf, size_t size)
 233 {
 234         ASSERT(fd->read);
 235         return fd->read(fd, buf, size);
 236 }
 237
 238 INLINE size_t kfile_write(struct KFile *fd, const void *buf, size_t size)
 239 {
 240         ASSERT(fd->write);
 241         return fd->write(fd, buf, size);
 242 }
 243
 244 INLINE KFile * kfile_reopen(struct KFile *fd)
 245 {
 246         ASSERT(fd->reopen);
 247         return fd->reopen(fd);
 248 }
 249
 250 INLINE int kfile_close(struct KFile *fd)
 251 {
 252         ASSERT(fd->close);
 253         return fd->close(fd);
 254 }
 255
 256 INLINE kfile_off_t kfile_seek(struct KFile *fd, kfile_off_t offset, KSeekMode whence)
 257 {
 258         ASSERT(fd->seek);
 259         return fd->seek(fd, offset, whence);
 260 }
 261
 262 INLINE int kfile_flush(struct KFile *fd)
 263 {
 264         ASSERT(fd->flush);
 265         return fd->flush(fd);
 266 }
 267
 268 INLINE int kfile_error(struct KFile *fd)
 269 {
 270         ASSERT(fd->error);
 271         return fd->error(fd);
 272 }
 273
 274 INLINE void kfile_clearerr(struct KFile *fd)
 275 {
 276         ASSERT(fd->clearerr);
 277         fd->clearerr(fd);
 278 }
 279 /* \} */
 280
 281 /**
 282  * Kfile test function.
 283  */
 284 int kfile_testSetup(void);
 285 int kfile_testRunGeneric(KFile *fd, uint8_t *test_buf, uint8_t *save_buf, size_t size);
 286 int kfile_testTearDown(void);
 287
 288 #endif /* KERN_KFILE_H */