kfile.h File Reference
Virtual KFile I/O interface. More...
#include <cfg/compiler.h>#include <cfg/debug.h>#include <cfg/macros.h>Go to the source code of this file.
Data Structures | |
| struct | KFile |
| Context data for callback functions which operate on pseudo files. More... | |
Typedefs | |
| typedef int32_t | kfile_off_t |
| KFile offset type, used by kfile_seek(). | |
| typedef enum KSeekMode | KSeekMode |
| Costants for repositioning read/write file offset. | |
| typedef struct KFile | KFile |
| Context data for callback functions which operate on pseudo files. | |
| typedef size_t(* | ReadFunc_t )(struct KFile *fd, void *buf, size_t size) |
| Prototypes for KFile access functions. | |
| typedef size_t(* | WriteFunc_t )(struct KFile *fd, const void *buf, size_t size) |
| Write to file. | |
| typedef kfile_off_t(* | SeekFunc_t )(struct KFile *fd, kfile_off_t offset, KSeekMode whence) |
| Seek into file (if seekable). | |
| typedef struct KFile *(* | ReOpenFunc_t )(struct KFile *fd) |
| Close and reopen file fd. | |
| typedef int(* | CloseFunc_t )(struct KFile *fd) |
| Close file. | |
| typedef int(* | FlushFunc_t )(struct KFile *fd) |
| Flush file I/O. | |
| typedef int(* | ErrorFunc_t )(struct KFile *fd) |
| Get file error mask. | |
| typedef void(* | ClearErrFunc_t )(struct KFile *fd) |
| Clear errors. | |
Enumerations | |
| enum | KSeekMode { KSM_SEEK_SET, KSM_SEEK_CUR, KSM_SEEK_END } |
Costants for repositioning read/write file offset. More... | |
Functions | |
| kfile_off_t | kfile_genericSeek (struct KFile *fd, kfile_off_t offset, KSeekMode whence) |
| Generic implementation of kfile_seek. | |
| struct KFile * | kfile_genericReopen (struct KFile *fd) |
| Generic implementation of kfile_reopen. | |
| int | kfile_putc (int c, struct KFile *fd) |
| Generic putc implementation using kfile_write. | |
| int | kfile_getc (struct KFile *fd) |
| Generic getc implementation using kfile_read. | |
| int | kfile_printf (struct KFile *fd, const char *format,...) |
| Formatted write. | |
| int | kfile_print (struct KFile *fd, const char *s) |
| Write a string to kfile fd. | |
| int | kfile_gets (struct KFile *fd, char *buf, int size) |
| Read a line long at most as size and put it in buf. | |
| int | kfile_gets_echo (struct KFile *fd, char *buf, int size, bool echo) |
| Read a line long at most as size and put it in buf, with optional echo. | |
| void | kfile_resync (KFile *fd, mtime_t delay) |
| Discard input to resynchronize with remote end. | |
| void | kfile_init (struct KFile *fd) |
| Base class KFile constructor. | |
| int | kfile_testSetup (void) |
| Kfile test function. | |
| size_t | kfile_read (struct KFile *fd, void *buf, size_t size) |
| Interface functions for KFile access. | |
Detailed Description
Virtual KFile I/O interface.
KFile is a simple, generic interface for file I/O. It uses an object-oriented model to supply a device-neutral interface to communicate with drivers.
This module contains only definitions, the instance structure and the common API. Each KFile subclass can override one or more methods of the interface, and can extend the base KFile structure with its own private data. For instance, a serial driver might implement the KFile interface by declaring a context structure like this:
typedef struct Serial { // base class instance KFile fd; // private instance data FIFOBuffer txfifo, rxfifo; } Serial;
You should also supply a macro for casting KFile to Serial:
INLINE Serial * SERIAL_CAST(KFile *fd) { ASSERT(fd->_type == KFT_SERIAL); return (Serial *)fd; }
Then you can implement as many interface functions as needed and leave the rest to NULL.
Example implementation of the close KFile method for Serial:
static int ser_kfile_close(struct KFile *fd) { Serial *fds = SERIAL_CAST(fd); // [driver specific code here] return 0; }
The SERIAL_CAST() macro helps ensure that the passed object is really of type Serial.
The KFile interface does not supply an open function: this is deliberate, because in embedded systems each device has its own init parameters. For the same reason, specific device settings like, for example, the baudrate, are not part of interface and should be handled by the driver-specific API.
- Version:
- Id
- kfile.h 2975 2009-09-27 13:21:27Z batt
Definition in file kfile.h.
Typedef Documentation
| typedef int(* CloseFunc_t)(struct KFile *fd) |
| typedef int(* ErrorFunc_t)(struct KFile *fd) |
| typedef int(* FlushFunc_t)(struct KFile *fd) |
Context data for callback functions which operate on pseudo files.
- Note:
- Remember to add the corresponding accessor functions when extending this interface.
Costants for repositioning read/write file offset.
These are needed because on some embedded platforms ANSI I/O library may not be present.
| typedef size_t(* ReadFunc_t)(struct KFile *fd, void *buf, size_t size) |
| typedef struct KFile*(* ReOpenFunc_t)(struct KFile *fd) |
| typedef kfile_off_t(* SeekFunc_t)(struct KFile *fd, kfile_off_t offset, KSeekMode whence) |
| typedef size_t(* WriteFunc_t)(struct KFile *fd, const void *buf, size_t size) |
Enumeration Type Documentation
| enum KSeekMode |
Function Documentation
| kfile_off_t kfile_genericSeek | ( | struct KFile * | fd, | |
| kfile_off_t | offset, | |||
| KSeekMode | whence | |||
| ) |
| int kfile_gets | ( | struct KFile * | fd, | |
| char * | buf, | |||
| int | size | |||
| ) |
| int kfile_gets_echo | ( | struct KFile * | fd, | |
| char * | buf, | |||
| int | size, | |||
| bool | echo | |||
| ) |
| int kfile_print | ( | struct KFile * | fd, | |
| const char * | s | |||
| ) |
| size_t kfile_read | ( | struct KFile * | fd, | |
| void * | buf, | |||
| size_t | size | |||
| ) | [inline] |
Join us on Facebook —
Follow us on Twitter
