mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

platform/LocalFileSystem.h@187:0387e8f68319, 2018-09-06 (annotated)

Committer:
AnnaBridge
Date:
Thu Sep 06 13:40:20 2018 +0100
Revision:
187:0387e8f68319
Parent:
178:79309dc6340a
Child:
189:f392fc9709a3
mbed-dev library. Release version 163

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 167:e84263d55307 1 /* mbed Microcontroller Library
AnnaBridge 167:e84263d55307 2 * Copyright (c) 2006-2013 ARM Limited
AnnaBridge 167:e84263d55307 3 *
AnnaBridge 167:e84263d55307 4 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 167:e84263d55307 5 * you may not use this file except in compliance with the License.
AnnaBridge 167:e84263d55307 6 * You may obtain a copy of the License at
AnnaBridge 167:e84263d55307 7 *
AnnaBridge 167:e84263d55307 8 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 167:e84263d55307 9 *
AnnaBridge 167:e84263d55307 10 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 167:e84263d55307 11 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 167:e84263d55307 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 167:e84263d55307 13 * See the License for the specific language governing permissions and
AnnaBridge 167:e84263d55307 14 * limitations under the License.
AnnaBridge 167:e84263d55307 15 */
AnnaBridge 167:e84263d55307 16 #ifndef MBED_LOCALFILESYSTEM_H
AnnaBridge 167:e84263d55307 17 #define MBED_LOCALFILESYSTEM_H
AnnaBridge 167:e84263d55307 18
AnnaBridge 167:e84263d55307 19 #include "platform/platform.h"
AnnaBridge 167:e84263d55307 20
AnnaBridge 167:e84263d55307 21 #if DEVICE_LOCALFILESYSTEM
AnnaBridge 167:e84263d55307 22
AnnaBridge 167:e84263d55307 23 #include "platform/FileSystemLike.h"
AnnaBridge 167:e84263d55307 24 #include "platform/PlatformMutex.h"
AnnaBridge 168:9672193075cf 25 #include "platform/NonCopyable.h"
AnnaBridge 167:e84263d55307 26
AnnaBridge 167:e84263d55307 27 namespace mbed {
AnnaBridge 167:e84263d55307 28 /** \addtogroup platform */
AnnaBridge 167:e84263d55307 29 /** @{*/
AnnaBridge 178:79309dc6340a 30 /**
AnnaBridge 178:79309dc6340a 31 * \defgroup platform_LocalFileSystem LocalFileSystem functions
AnnaBridge 178:79309dc6340a 32 * @{
AnnaBridge 178:79309dc6340a 33 */
AnnaBridge 167:e84263d55307 34
AnnaBridge 187:0387e8f68319 35 FILEHANDLE local_file_open(const char *name, int flags);
AnnaBridge 167:e84263d55307 36
AnnaBridge 167:e84263d55307 37 /**
AnnaBridge 167:e84263d55307 38 * @class LocalFileHandle
AnnaBridge 167:e84263d55307 39 * @ingroup platform
AnnaBridge 167:e84263d55307 40 */
AnnaBridge 168:9672193075cf 41 class LocalFileHandle : public FileHandle, private NonCopyable<LocalFileHandle> {
AnnaBridge 167:e84263d55307 42
AnnaBridge 167:e84263d55307 43 public:
AnnaBridge 167:e84263d55307 44 LocalFileHandle(FILEHANDLE fh);
AnnaBridge 167:e84263d55307 45
AnnaBridge 167:e84263d55307 46 virtual int close();
AnnaBridge 167:e84263d55307 47
AnnaBridge 167:e84263d55307 48 virtual ssize_t write(const void *buffer, size_t length);
AnnaBridge 167:e84263d55307 49
AnnaBridge 167:e84263d55307 50 virtual ssize_t read(void *buffer, size_t length);
AnnaBridge 167:e84263d55307 51
AnnaBridge 167:e84263d55307 52 virtual int isatty();
AnnaBridge 167:e84263d55307 53
AnnaBridge 167:e84263d55307 54 virtual off_t seek(off_t position, int whence);
AnnaBridge 167:e84263d55307 55
AnnaBridge 167:e84263d55307 56 virtual int sync();
AnnaBridge 167:e84263d55307 57
AnnaBridge 167:e84263d55307 58 virtual off_t size();
AnnaBridge 167:e84263d55307 59
AnnaBridge 167:e84263d55307 60 protected:
AnnaBridge 167:e84263d55307 61 virtual void lock();
AnnaBridge 167:e84263d55307 62 virtual void unlock();
AnnaBridge 167:e84263d55307 63 FILEHANDLE _fh;
AnnaBridge 167:e84263d55307 64 int pos;
AnnaBridge 167:e84263d55307 65 PlatformMutex _mutex;
AnnaBridge 167:e84263d55307 66 };
AnnaBridge 167:e84263d55307 67
AnnaBridge 167:e84263d55307 68 /** A filesystem for accessing the local mbed Microcontroller USB disk drive
AnnaBridge 167:e84263d55307 69 *
AnnaBridge 167:e84263d55307 70 * This allows programs to read and write files on the same disk drive that is used to program the
AnnaBridge 167:e84263d55307 71 * mbed Microcontroller. Once created, the standard C file access functions are used to open,
AnnaBridge 167:e84263d55307 72 * read and write files.
AnnaBridge 167:e84263d55307 73 *
AnnaBridge 167:e84263d55307 74 * @note Synchronization level: Thread safe
AnnaBridge 167:e84263d55307 75 *
AnnaBridge 167:e84263d55307 76 * Example:
AnnaBridge 167:e84263d55307 77 * @code
AnnaBridge 167:e84263d55307 78 * #include "mbed.h"
AnnaBridge 167:e84263d55307 79 *
AnnaBridge 167:e84263d55307 80 * LocalFileSystem local("local"); // Create the local filesystem under the name "local"
AnnaBridge 167:e84263d55307 81 *
AnnaBridge 167:e84263d55307 82 * int main() {
AnnaBridge 167:e84263d55307 83 * FILE *fp = fopen("/local/out.txt", "w"); // Open "out.txt" on the local file system for writing
AnnaBridge 167:e84263d55307 84 * fprintf(fp, "Hello World!");
AnnaBridge 167:e84263d55307 85 * fclose(fp);
AnnaBridge 167:e84263d55307 86 * remove("/local/out.txt"); // Removes the file "out.txt" from the local file system
AnnaBridge 167:e84263d55307 87 *
AnnaBridge 167:e84263d55307 88 * DIR *d = opendir("/local"); // Opens the root directory of the local file system
AnnaBridge 167:e84263d55307 89 * struct dirent *p;
AnnaBridge 167:e84263d55307 90 * while((p = readdir(d)) != NULL) { // Print the names of the files in the local file system
AnnaBridge 167:e84263d55307 91 * printf("%s\n", p->d_name); // to stdout.
AnnaBridge 167:e84263d55307 92 * }
AnnaBridge 167:e84263d55307 93 * closedir(d);
AnnaBridge 167:e84263d55307 94 * }
AnnaBridge 167:e84263d55307 95 * @endcode
AnnaBridge 167:e84263d55307 96 *
AnnaBridge 167:e84263d55307 97 * @note
AnnaBridge 167:e84263d55307 98 * If the microcontroller program makes an access to the local drive, it will be marked as "removed"
AnnaBridge 167:e84263d55307 99 * on the Host computer. This means it is no longer accessible from the Host Computer.
AnnaBridge 167:e84263d55307 100 *
AnnaBridge 167:e84263d55307 101 * The drive will only re-appear when the microcontroller program exists. Note that if the program does
AnnaBridge 167:e84263d55307 102 * not exit, you will need to hold down reset on the mbed Microcontroller to be able to see the drive again!
AnnaBridge 167:e84263d55307 103 * @ingroup platform
AnnaBridge 167:e84263d55307 104 */
AnnaBridge 168:9672193075cf 105 class LocalFileSystem : public FileSystemLike, private NonCopyable<LocalFileSystem> {
AnnaBridge 167:e84263d55307 106 // No modifiable state
AnnaBridge 167:e84263d55307 107
AnnaBridge 167:e84263d55307 108 public:
AnnaBridge 187:0387e8f68319 109 LocalFileSystem(const char *n) : FileSystemLike(n)
AnnaBridge 187:0387e8f68319 110 {
AnnaBridge 167:e84263d55307 111
AnnaBridge 167:e84263d55307 112 }
AnnaBridge 167:e84263d55307 113
AnnaBridge 167:e84263d55307 114 virtual int open(FileHandle **file, const char *path, int flags);
AnnaBridge 167:e84263d55307 115 virtual int open(DirHandle **dir, const char *name);
AnnaBridge 167:e84263d55307 116 virtual int remove(const char *filename);
AnnaBridge 167:e84263d55307 117 };
AnnaBridge 167:e84263d55307 118
AnnaBridge 178:79309dc6340a 119 /**@}*/
AnnaBridge 178:79309dc6340a 120
AnnaBridge 178:79309dc6340a 121 /**@}*/
AnnaBridge 178:79309dc6340a 122
AnnaBridge 167:e84263d55307 123 } // namespace mbed
AnnaBridge 167:e84263d55307 124
AnnaBridge 167:e84263d55307 125 #endif
AnnaBridge 167:e84263d55307 126
AnnaBridge 167:e84263d55307 127 #endif
AnnaBridge 167:e84263d55307 128