X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;ds=sidebyside;f=bertos%2Ffs%2Ffat.h;h=0dd1529f752568e36df92fedbae4a0a07cbd0853;hb=232780b46084a667879b2fdec3feb23a8ae9b5a3;hp=e407c1ba6890b8612e15c8d2787809a6a3e1e02f;hpb=4dd546b5af72301784b05bd2ea7e6ffeb4475c87;p=bertos.git diff --git a/bertos/fs/fat.h b/bertos/fs/fat.h index e407c1ba..0dd1529f 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 @@ -46,7 +49,7 @@ #define FS_FAT_H #include -#include "fatfs/src/ff.h" +#include "fatfs/ff.h" typedef struct FatFile { @@ -65,6 +68,10 @@ INLINE FatFile * FATFILE_CAST(KFile *fd) /** * Initialize \a file and open \a file_path for reading. + * \param file A pointer to a FatFile structure. + * \param file_path The file path on the filesystem. + * \param mode Open mode for the file. + * \sa ff.h for return code meaning and \a mode flags. */ FRESULT fatfile_open(FatFile *file, const char *file_path, BYTE mode);