Alek Boving / SDFileSystem8

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.

FATFileSystem/FATFileSystem.h@0:83e8ad3d9a65, 2020-11-12 (annotated)

Committer:
alekboving
Date:
Thu Nov 12 15:20:15 2020 +0000
Revision:
0:83e8ad3d9a65
initial commit

Who changed what in which revision?

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