megan gimple / SDFileSystem

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   gimple_A4_3_Temp_Light

FATFileSystem/FATFileSystem.h@0:07ff9ae5339f, 2021-11-13 (annotated)

Committer:
mgimple
Date:
Sat Nov 13 20:10:05 2021 +0000
Revision:
0:07ff9ae5339f
SD

Who changed what in which revision?

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