X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=bertos%2Ffs%2Ffat.h;h=26d0d1c08a037eeb1ad425f5bb04003dd6346f09;hb=911d2706a86d326786bfe721dcc3d63aeade7f28;hp=0dd1529f752568e36df92fedbae4a0a07cbd0853;hpb=ef02c60278e6425cd2bcc2b30598924bf53f402d;p=bertos.git diff --git a/bertos/fs/fat.h b/bertos/fs/fat.h index 0dd1529f..26d0d1c0 100644 --- a/bertos/fs/fat.h +++ b/bertos/fs/fat.h @@ -48,7 +48,7 @@ #ifndef FS_FAT_H #define FS_FAT_H -#include +#include #include "fatfs/ff.h" typedef struct FatFile @@ -68,9 +68,15 @@ 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. + * \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);