Add missing dependencies.
[bertos.git] / bertos / kern / kfile.h
index 609c8d635030edc777a12160ff9e364c66fe6f09..10f98ef157376bf442ab2130f19b99b33df7f7b7 100644 (file)
  * \author Bernie Innocenti <bernie@codewiz.org>
  * \author Francesco Sacchi <batt@develer.com>
  * \author Daniele Basile <asterix@develer.com>
+ *
+ * $WIZ$ module_name = "kfile"
+ * $WIZ$ module_configuration = "bertos/cfg/cfg_kfile.h"
+ * $WIZ$ module_depends = "timer", "formatwr"
  */
 
 #ifndef KERN_KFILE_H
 struct KFile;
 
 typedef int32_t kfile_off_t;     ///< KFile offset type, used by kfile_seek().
-typedef uint32_t kfile_size_t;   ///< KFile size type, used in struct KFile.
 
 /**
  * Costants for repositioning read/write file offset.
@@ -178,7 +181,9 @@ typedef void (*ClearErrFunc_t) (struct KFile *fd);
 /**
  * Context data for callback functions which operate on
  * pseudo files.
- * \note If you change interface, remember to add corresponding access function.
+ *
+ * \note Remember to add the corresponding accessor functions
+ *       when extending this interface.
  */
 typedef struct KFile
 {
@@ -190,11 +195,11 @@ typedef struct KFile
        FlushFunc_t    flush;
        ErrorFunc_t    error;
        ClearErrFunc_t clearerr;
-       DB(id_t _type); ///< Used to keep trace, at runtime, of obj type.
+       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_size_t size;
+       kfile_off_t    seek_pos;
+       kfile_off_t    size;
 } KFile;
 
 /**
@@ -207,12 +212,15 @@ kfile_off_t kfile_genericSeek(struct KFile *fd, kfile_off_t offset, KSeekMode wh
  */
 struct KFile * kfile_genericReopen(struct KFile *fd);
 
+int kfile_genericClose(struct KFile *fd);
+
 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, ...);
 int kfile_print(struct KFile *fd, const char *s);
 int kfile_gets(struct KFile *fd, char *buf, int size);
 int kfile_gets_echo(struct KFile *fd, char *buf, int size, bool echo);
+void kfile_resync(KFile *fd, mtime_t delay);
 
 /**
  * Interface functions for KFile access.
@@ -271,8 +279,9 @@ INLINE void kfile_clearerr(struct KFile *fd)
 /**
  * Kfile test function.
  */
-int kfile_testSetUp(void);
-int kfile_testRun(KFile *fd, uint8_t *test_buf, uint8_t *save_buf, size_t size);
+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 */