X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=bertos%2Ffs%2Ffat.h;h=3e7dc787a1a8da95b1d4ee127640ab4fde373947;hb=f3ab40d385fc904573761ae4ae9d59b3ce898a82;hp=d0da925d75ce113595837ea92513bd0592b2db89;hpb=efcdac5c593b00b2ff79bb6a92849c7ee9358bb3;p=bertos.git

diff --git a/bertos/fs/fat.h b/bertos/fs/fat.h
index d0da925d..3e7dc787 100644
--- a/bertos/fs/fat.h
+++ b/bertos/fs/fat.h
@@ -32,6 +32,9 @@
  *
  * \brief FatFS: kfile interface for FatFS module by ChaN.
  *
+ * This driver needs some low level hardware access functions. An example implementation
+ * is provided in sd.h.
+ *
  * \version $Id$
  *
  * \author Luca Ottaviano <lottaviano@develer.com>
@@ -65,6 +68,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);