mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

platform/LocalFileSystem.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
170:e95d10626187 
mbed library release version 165

Who changed what in which revision?

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