Kev Mann / mbed-dev-OS5_10_4

RTC auf true

platform/LocalFileSystem.h@0:38ceb79fef03, 2018-11-28 (annotated)

Committer:
kevman
Date:
Wed Nov 28 15:10:15 2018 +0000
Revision:
0:38ceb79fef03
RTC modified

Who changed what in which revision?

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