Jordan Beason / FATDirHandle1

Final

FATFileSystem.h@0:e126ae11d20b, 2019-11-06 (annotated)

Committer:
jbeason3
Date:
Wed Nov 06 04:53:44 2019 +0000
Revision:
0:e126ae11d20b
Final

Who changed what in which revision?

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