FATFileSystem.h

00001 /* mbed Microcontroller Library
00002  * Copyright (c) 2006-2012 ARM Limited
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a copy
00005  * of this software and associated documentation files (the "Software"), to deal
00006  * in the Software without restriction, including without limitation the rights
00007  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00008  * copies of the Software, and to permit persons to whom the Software is
00009  * furnished to do so, subject to the following conditions:
00010  *
00011  * The above copyright notice and this permission notice shall be included in
00012  * all copies or substantial portions of the Software.
00013  *
00014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00015  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00016  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
00017  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
00018  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00019  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
00020  * SOFTWARE.
00021  */
00022 #ifndef MBED_FATFILESYSTEM_H
00023 #define MBED_FATFILESYSTEM_H
00024 
00025 #include "FileSystemLike.h"
00026 #include "FileHandle.h"
00027 #include "ff.h"
00028 #include <stdint.h>
00029 
00030 using namespace mbed;
00031 
00032 /**
00033  * FATFileSystem based on ChaN's Fat Filesystem library v0.8 
00034  */
00035 class FATFileSystem : public FileSystemLike {
00036 public:
00037 
00038     FATFileSystem(const char* n);
00039     virtual ~FATFileSystem();
00040 
00041     static FATFileSystem * _ffs[_VOLUMES];   // FATFileSystem objects, as parallel to FatFs drives array
00042     FATFS _fs;                               // Work area (file system object) for logical drive
00043     char _fsid[2];
00044 
00045     /**
00046      * Opens a file on the filesystem
00047      */
00048     virtual FileHandle *open(const char* name, int flags);
00049     
00050     /**
00051      * Removes a file path
00052      */
00053     virtual int remove(const char *filename);
00054     
00055     /**
00056      * Renames a file
00057      */
00058     virtual int rename(const char *oldname, const char *newname);
00059     
00060     /**
00061      * Formats a logical drive, FDISK artitioning rule, 512 bytes per cluster
00062      */
00063     virtual int format();
00064     
00065     /**
00066      * Opens a directory on the filesystem
00067      */
00068     virtual DirHandle *opendir(const char *name);
00069     
00070     /**
00071      * Creates a directory path
00072      */
00073     virtual int mkdir(const char *name, mode_t mode);
00074     
00075     /**
00076      * Mounts the filesystem
00077      */
00078     virtual int mount();
00079     
00080     /**
00081      * Unmounts the filesystem
00082      */
00083     virtual int unmount();
00084 
00085     virtual int disk_initialize() { return 0; }
00086     virtual int disk_status() { return 0; }
00087     virtual int disk_read(uint8_t *buffer, uint32_t sector, uint32_t count) = 0;
00088     virtual int disk_write(const uint8_t *buffer, uint32_t sector, uint32_t count) = 0;
00089     virtual int disk_sync() { return 0; }
00090     virtual uint32_t disk_sectors() = 0;
00091 
00092 };
00093 
00094 #endif