io/kfile.h

Go to the documentation of this file.

#ifndef KERN_KFILE_H
#define KERN_KFILE_H

#include <cfg/compiler.h>
#include <cfg/debug.h>
#include <cfg/macros.h>

/* fwd decl */
struct KFile;

typedef int32_t kfile_off_t;     

typedef enum KSeekMode
{
    KSM_SEEK_SET, 
    KSM_SEEK_CUR, 
    KSM_SEEK_END, 
} KSeekMode;

/*
 * Prototypes for KFile access functions.
 * I/O file functions must be ANSI compliant.
 * \note A KFile user can choose which function subset to implement,
 *       but has to set to NULL unimplemented features.
 */

/*
 * Read from file.
 * \return the number of bytes read.
 */
typedef size_t (*ReadFunc_t) (struct KFile *fd, void *buf, size_t size);

/*
 * Write to file.
 * \return the number of bytes written.
 */
typedef size_t (*WriteFunc_t) (struct KFile *fd, const void *buf, size_t size);

/*
 * Seek into file (if seekable).
 * \return the new file offset or EOF on errors.
 */
typedef kfile_off_t (*SeekFunc_t) (struct KFile *fd, kfile_off_t offset, KSeekMode whence);

/*
 * Close and reopen file \a fd.
 * The reopening is done with the former file parameters and access modes.
 */
typedef struct KFile * (*ReOpenFunc_t) (struct KFile *fd);

/*
 * Close file.
 * \return 0 on success, EOF on errors.
 */
typedef int (*CloseFunc_t) (struct KFile *fd);

/*
 * Flush file I/O.
 * \return 0 on success, EOF on errors.
 */
typedef int (*FlushFunc_t) (struct KFile *fd);

/*
 * Get file error mask.
 * \return 0 on success or file error code, device specific.
 */
typedef int (*ErrorFunc_t) (struct KFile *fd);

/*
 * Clear errors.
 */
typedef void (*ClearErrFunc_t) (struct KFile *fd);

typedef struct KFile
{
    ReadFunc_t     read;
    WriteFunc_t    write;
    ReOpenFunc_t   reopen;
    CloseFunc_t    close;
    SeekFunc_t     seek;
    FlushFunc_t    flush;
    ErrorFunc_t    error;
    ClearErrFunc_t clearerr;
    DB(id_t _type); // Used to keep track, at runtime, of the class type.

    /* NOTE: these must _NOT_ be size_t on 16bit CPUs! */
    kfile_off_t    seek_pos;
    kfile_off_t    size;
} KFile;

/*
 * Generic implementation of kfile_seek.
 */
kfile_off_t kfile_genericSeek(struct KFile *fd, kfile_off_t offset, KSeekMode whence);

/*
 * Generic implementation of kfile_reopen.
 */
struct KFile * kfile_genericReopen(struct KFile *fd);

int kfile_genericClose(struct KFile *fd);

INLINE size_t kfile_read(struct KFile *fd, void *buf, size_t size)
{
    ASSERT(fd->read);
    return fd->read(fd, buf, size);
}
int kfile_gets(struct KFile *fd, char *buf, int size);
int kfile_gets_echo(struct KFile *fd, char *buf, int size, bool echo);

kfile_off_t kfile_copy(KFile *src, KFile *dst, kfile_off_t size);

INLINE size_t kfile_write(struct KFile *fd, const void *buf, size_t size)
{
    ASSERT(fd->write);
    return fd->write(fd, buf, size);
}

int kfile_printf(struct KFile *fd, const char *format, ...);
int kfile_print(struct KFile *fd, const char *s);

INLINE kfile_off_t kfile_seek(struct KFile *fd, kfile_off_t offset, KSeekMode whence)
{
    ASSERT(fd->seek);
    return fd->seek(fd, offset, whence);
}

INLINE KFile * kfile_reopen(struct KFile *fd)
{
    ASSERT(fd->reopen);
    return fd->reopen(fd);
}

INLINE int kfile_close(struct KFile *fd)
{
    ASSERT(fd->close);
    return fd->close(fd);
}

INLINE int kfile_flush(struct KFile *fd)
{
    ASSERT(fd->flush);
    return fd->flush(fd);
}

INLINE int kfile_error(struct KFile *fd)
{
    ASSERT(fd->error);
    return fd->error(fd);
}

INLINE void kfile_clearerr(struct KFile *fd)
{
    ASSERT(fd->clearerr);
    fd->clearerr(fd);
}

int kfile_putc(int c, struct KFile *fd); 
int kfile_getc(struct KFile *fd);  
void kfile_resync(KFile *fd, mtime_t delay);
void kfile_init(struct KFile *fd);
/* @} */
 //Defgroup io_kfile

/*
 * Kfile test function.
 */
int kfile_testSetup(void);
int kfile_testRun(void);
int kfile_testRunGeneric(KFile *fd, uint8_t *test_buf, uint8_t *save_buf, size_t size);
int kfile_testTearDown(void);


#endif /* KERN_KFILE_H */