4f1d8fc85f9b70ce367fea015b5786aee72be246
[bertos.git] / 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
97 #ifndef KERN_KFILE_H
98 #define KERN_KFILE_H
99
100 #include <cfg/compiler.h>
101 #include <cfg/debug.h>
102 #include <cfg/macros.h>
103
104 /* fwd decl */
105 struct KFile;
106
107 typedef int32_t kfile_off_t;     ///< KFile offset type, used by kfile_seek().
108 typedef uint32_t kfile_size_t;   ///< KFile size type, used in struct KFile.
109
110 /**
111  * Costants for repositioning read/write file offset.
112  * These are needed because on some embedded platforms
113  * ANSI I/O library may not be present.
114  */
115 typedef enum KSeekMode
116 {
117         KSM_SEEK_SET, ///< Seek from file beginning.
118         KSM_SEEK_CUR, ///< Seek from file current position.
119         KSM_SEEK_END, ///< Seek from file end.
120 } KSeekMode;
121
122 /**
123  * Prototypes for KFile access functions.
124  * I/O file functions must be ANSI compliant.
125  * \note A KFile user can choose which function subset to implement,
126  *       but has to set to NULL unimplemented features.
127  * \{
128  */
129
130 /**
131  * Read from file.
132  * \return the number of bytes read.
133  */
134 typedef size_t (*ReadFunc_t) (struct KFile *fd, void *buf, size_t size);
135
136 /**
137  * Write to file.
138  * \return the number of bytes written.
139  */
140 typedef size_t (*WriteFunc_t) (struct KFile *fd, const void *buf, size_t size);
141
142 /**
143  * Seek into file (if seekable).
144  * \return the new file offset or EOF on errors.
145  */
146 typedef kfile_off_t (*SeekFunc_t) (struct KFile *fd, kfile_off_t offset, KSeekMode whence);
147
148 /**
149  * Close and reopen file \a fd.
150  * The reopening is done with the former file parameters and access modes.
151  */
152 typedef struct KFile * (*ReOpenFunc_t) (struct KFile *fd);
153
154 /**
155  * Close file.
156  * \return 0 on success, EOF on errors.
157  */
158 typedef int (*CloseFunc_t) (struct KFile *fd);
159
160 /**
161  * Flush file I/O.
162  * \return 0 on success, EOF on errors.
163  */
164 typedef int (*FlushFunc_t) (struct KFile *fd);
165
166 /**
167  * Get file error mask.
168  * \return 0 on success or file error code, device specific.
169  */
170 typedef int (*ErrorFunc_t) (struct KFile *fd);
171
172 /**
173  * Clear errors.
174  */
175 typedef void (*ClearErrFunc_t) (struct KFile *fd);
176 /* \} */
177
178 /**
179  * Context data for callback functions which operate on
180  * pseudo files.
181  *
182  * \note Remember to add the corresponding accessor functions
183  *       when extending this interface.
184  */
185 typedef struct KFile
186 {
187         ReadFunc_t     read;
188         WriteFunc_t    write;
189         ReOpenFunc_t   reopen;
190         CloseFunc_t    close;
191         SeekFunc_t     seek;
192         FlushFunc_t    flush;
193         ErrorFunc_t    error;
194         ClearErrFunc_t clearerr;
195         DB(id_t _type); ///< Used to keep track, at runtime, of the class type.
196
197         /* NOTE: these must _NOT_ be size_t on 16bit CPUs! */
198         kfile_off_t  seek_pos;
199         kfile_size_t size; // FIXME: should be kfile_off_t
200 } KFile;
201
202 /**
203  * Generic implementation of kfile_seek.
204  */
205 kfile_off_t kfile_genericSeek(struct KFile *fd, kfile_off_t offset, KSeekMode whence);
206
207 /**
208  * Generic implementation of kfile_reopen.
209  */
210 struct KFile * kfile_genericReopen(struct KFile *fd);
211
212 int kfile_putc(int c, struct KFile *fd); ///< Generic putc implementation using kfile_write.
213 int kfile_getc(struct KFile *fd);  ///< Generic getc implementation using kfile_read.
214 int kfile_printf(struct KFile *fd, const char *format, ...);
215 int kfile_print(struct KFile *fd, const char *s);
216 int kfile_gets(struct KFile *fd, char *buf, int size);
217 int kfile_gets_echo(struct KFile *fd, char *buf, int size, bool echo);
218
219 /**
220  * Interface functions for KFile access.
221  * \note Remember to change following functions if KFile interface changes.
222  * \{
223  */
224 INLINE size_t kfile_read(struct KFile *fd, void *buf, size_t size)
225 {
226         ASSERT(fd->read);
227         return fd->read(fd, buf, size);
228 }
229
230 INLINE size_t kfile_write(struct KFile *fd, const void *buf, size_t size)
231 {
232         ASSERT(fd->write);
233         return fd->write(fd, buf, size);
234 }
235
236 INLINE KFile * kfile_reopen(struct KFile *fd)
237 {
238         ASSERT(fd->reopen);
239         return fd->reopen(fd);
240 }
241
242 INLINE int kfile_close(struct KFile *fd)
243 {
244         ASSERT(fd->close);
245         return fd->close(fd);
246 }
247
248 INLINE kfile_off_t kfile_seek(struct KFile *fd, kfile_off_t offset, KSeekMode whence)
249 {
250         ASSERT(fd->seek);
251         return fd->seek(fd, offset, whence);
252 }
253
254 INLINE int kfile_flush(struct KFile *fd)
255 {
256         ASSERT(fd->flush);
257         return fd->flush(fd);
258 }
259
260 INLINE int kfile_error(struct KFile *fd)
261 {
262         ASSERT(fd->error);
263         return fd->error(fd);
264 }
265
266 INLINE void kfile_clearerr(struct KFile *fd)
267 {
268         ASSERT(fd->clearerr);
269         fd->clearerr(fd);
270 }
271 /* \} */
272
273 /**
274  * Kfile test function.
275  */
276 int kfile_testSetUp(void);
277 int kfile_testRun(KFile *fd, uint8_t *test_buf, uint8_t *save_buf, size_t size);
278 int kfile_testTearDown(void);
279
280 #endif /* KERN_KFILE_H */