bertos/fs/fat.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2009 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief FatFS: kfile interface for FatFS module by ChaN.
  34  *
  35  * This driver needs some low level hardware access functions. An example implementation
  36  * is provided in sd.h.
  37  *
  38  *
  39  * \author Luca Ottaviano <lottaviano@develer.com>
  40  *
  41  * $WIZ$ module_name = "fat"
  42  * $WIZ$ module_configuration = "bertos/cfg/cfg_fat.h"
  43  * $WIZ$ module_depends = "kfile", "ff", "diskio"
  44  *
  45  */
  46
  47 #ifndef FS_FAT_H
  48 #define FS_FAT_H
  49
  50 #include <io/kfile.h>
  51 #include "fatfs/ff.h"
  52
  53 typedef struct FatFile
  54 {
  55         KFile fd;
  56         FIL fat_file;
  57         FRESULT error_code;       ///< error code for calls like kfile_read
  58 } FatFile;
  59
  60 #define KFT_FATFILE MAKE_ID('F', 'A', 'T', 'F')
  61
  62 INLINE FatFile * FATFILE_CAST(KFile *fd)
  63 {
  64         ASSERT(fd->_type == KFT_FATFILE);
  65         return (FatFile *)fd;
  66 }
  67
  68 /**
  69  * Initialize \a file and open \a file_path for reading.
  70  *
  71  * \a mode is a OR combination of various flags, you can use \a FA_READ for
  72  * read access or \a FA_WRITE for write access.
  73  * The function returns \a FR_OK if success, other values (defined in ff.h) in case
  74  * of failure.
  75  *
  76  * \param file A pointer to a FatFile structure.
  77  * \param file_path The file path on the filesystem.
  78  * \param mode Open mode for the file, which can be OR'ed together
  79  * \sa ff.h for return code meaning and \a mode flags.
  80  */
  81 FRESULT fatfile_open(FatFile *file, const char *file_path, BYTE mode);
  82
  83 #endif /* FS_FAT_H */
  84