Update preset.

[bertos.git] / bertos / fs / fat.h

diff --git a/bertos/fs/fat.h b/bertos/fs/fat.h
index e407c1ba6890b8612e15c8d2787809a6a3e1e02f..df748d5b0147928cb3a8417443bf0269dd883fa6 100644 (file)
--- a/bertos/fs/fat.h
+++ b/bertos/fs/fat.h
@@ -32,21 +32,23 @@
  *
  * \brief FatFS: kfile interface for FatFS module by ChaN.
  *
- * \version $Id$
+ * This driver needs some low level hardware access functions. An example implementation
+ * is provided in sd.h.
+ *
  *
  * \author Luca Ottaviano <lottaviano@develer.com>
  *
  * $WIZ$ module_name = "fat"
  * $WIZ$ module_configuration = "bertos/cfg/cfg_fat.h"
- * $WIZ$ module_depends = "kfile", "ff"
+ * $WIZ$ module_depends = "kfile", "ff", "diskio"
  *
  */
 
 #ifndef FS_FAT_H
 #define FS_FAT_H
 
-#include <kern/kfile.h>
-#include "fatfs/src/ff.h"
+#include <io/kfile.h>
+#include "fatfs/ff.h"
 
 typedef struct FatFile
 {
@@ -65,6 +67,16 @@ INLINE FatFile * FATFILE_CAST(KFile *fd)
 
 /**
  * Initialize \a file and open \a file_path for reading.
+ *
+ * \a mode is a OR combination of various flags, you can use \a FA_READ for
+ * read access or \a FA_WRITE for write access.
+ * The function returns \a FR_OK if success, other values (defined in ff.h) in case
+ * of failure.
+ *
+ * \param file A pointer to a FatFile structure.
+ * \param file_path The file path on the filesystem.
+ * \param mode Open mode for the file, which can be OR'ed together
+ * \sa ff.h for return code meaning and \a mode flags.
  */
 FRESULT fatfile_open(FatFile *file, const char *file_path, BYTE mode);