tool/mbed/mbed-sdk/libraries/fs/fat/FATFileSystem.h

   1 /* mbed Microcontroller Library
   2  * Copyright (c) 2006-2012 ARM Limited
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a copy
   5  * of this software and associated documentation files (the "Software"), to deal
   6  * in the Software without restriction, including without limitation the rights
   7  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   8  * copies of the Software, and to permit persons to whom the Software is
   9  * furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice shall be included in
  12  * all copies or substantial portions of the Software.
  13  *
  14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  20  * SOFTWARE.
  21  */
  22 #ifndef MBED_FATFILESYSTEM_H
  23 #define MBED_FATFILESYSTEM_H
  24
  25 #include "FileSystemLike.h"
  26 #include "FileHandle.h"
  27 #include "ff.h"
  28 #include <stdint.h>
  29
  30 using namespace mbed;
  31
  32 /**
  33  * FATFileSystem based on ChaN's Fat Filesystem library v0.8
  34  */
  35 class FATFileSystem : public FileSystemLike {
  36 public:
  37
  38     FATFileSystem(const char* n);
  39     virtual ~FATFileSystem();
  40
  41     static FATFileSystem * _ffs[_VOLUMES];   // FATFileSystem objects, as parallel to FatFs drives array
  42     FATFS _fs;                               // Work area (file system object) for logical drive
  43     int _fsid;
  44
  45     /**
  46      * Opens a file on the filesystem
  47      */
  48     virtual FileHandle *open(const char* name, int flags);
  49
  50     /**
  51      * Removes a file path
  52      */
  53     virtual int remove(const char *filename);
  54
  55     /**
  56      * Renames a file
  57      */
  58     virtual int rename(const char *oldname, const char *newname);
  59
  60     /**
  61      * Formats a logical drive, FDISK artitioning rule, 512 bytes per cluster
  62      */
  63     virtual int format();
  64
  65     /**
  66      * Opens a directory on the filesystem
  67      */
  68     virtual DirHandle *opendir(const char *name);
  69
  70     /**
  71      * Creates a directory path
  72      */
  73     virtual int mkdir(const char *name, mode_t mode);
  74
  75     /**
  76      * Mounts the filesystem
  77      */
  78     virtual int mount();
  79
  80     /**
  81      * Unmounts the filesystem
  82      */
  83     virtual int unmount();
  84
  85     virtual int disk_initialize() { return 0; }
  86     virtual int disk_status() { return 0; }
  87     virtual int disk_read(uint8_t * buffer, uint64_t sector, uint8_t count) = 0;
  88     virtual int disk_write(const uint8_t * buffer, uint64_t sector, uint8_t count) = 0;
  89     virtual int disk_sync() { return 0; }
  90     virtual uint64_t disk_sectors() = 0;
  91
  92 };
  93
  94 #endif