projects
/
bertos.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
USB: coding style fixes (structure naming)
[bertos.git]
/
bertos
/
fs
/
fat.h
diff --git
a/bertos/fs/fat.h
b/bertos/fs/fat.h
index 34b20bbac1a7e2725fd562264984857384509ae0..df748d5b0147928cb3a8417443bf0269dd883fa6 100644
(file)
--- a/
bertos/fs/fat.h
+++ b/
bertos/fs/fat.h
@@
-32,20
+32,22
@@
*
* \brief FatFS: kfile interface for FatFS module by ChaN.
*
*
* \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"
*
* \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
*
*/
#ifndef FS_FAT_H
#define FS_FAT_H
-#include <
kern
/kfile.h>
+#include <
io
/kfile.h>
#include "fatfs/ff.h"
typedef struct FatFile
#include "fatfs/ff.h"
typedef struct FatFile
@@
-65,9
+67,15
@@
INLINE FatFile * FATFILE_CAST(KFile *fd)
/**
* Initialize \a file and open \a file_path for reading.
/**
* 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 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);
* \sa ff.h for return code meaning and \a mode flags.
*/
FRESULT fatfile_open(FatFile *file, const char *file_path, BYTE mode);