Ben Katz
mbed library sources. Supersedes mbed-src.
Dependents: SPIne CH_Communicatuin_Test CH_Communicatuin_Test2 MCP_SPIne ... more
Fork of
mbed-dev-f303
by 
Ben Katz
platform/LocalFileSystem.h@179:97f825502e2a, 2018-05-02 (annotated)
- Committer:
- benkatz
- Date:
- Wed May 02 18:08:16 2018 +0000
- Revision:
- 179:97f825502e2a
- Parent:
- 168:9672193075cf
Who changed what in which revision?
| User | Revision | Line number | New 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 | 167:e84263d55307 | 30 | |
| AnnaBridge | 167:e84263d55307 | 31 | FILEHANDLE local_file_open(const char* name, int flags); |
| AnnaBridge | 167:e84263d55307 | 32 | /** @}*/ |
| AnnaBridge | 167:e84263d55307 | 33 | |
| AnnaBridge | 167:e84263d55307 | 34 | /** |
| AnnaBridge | 167:e84263d55307 | 35 | * @class LocalFileHandle |
| AnnaBridge | 167:e84263d55307 | 36 | * @ingroup platform |
| AnnaBridge | 167:e84263d55307 | 37 | */ |
| AnnaBridge | 168:9672193075cf | 38 | class LocalFileHandle : public FileHandle, private NonCopyable<LocalFileHandle> { |
| AnnaBridge | 167:e84263d55307 | 39 | |
| AnnaBridge | 167:e84263d55307 | 40 | public: |
| AnnaBridge | 167:e84263d55307 | 41 | LocalFileHandle(FILEHANDLE fh); |
| AnnaBridge | 167:e84263d55307 | 42 | |
| AnnaBridge | 167:e84263d55307 | 43 | virtual int close(); |
| AnnaBridge | 167:e84263d55307 | 44 | |
| AnnaBridge | 167:e84263d55307 | 45 | virtual ssize_t write(const void *buffer, size_t length); |
| AnnaBridge | 167:e84263d55307 | 46 | |
| AnnaBridge | 167:e84263d55307 | 47 | virtual ssize_t read(void *buffer, size_t length); |
| AnnaBridge | 167:e84263d55307 | 48 | |
| AnnaBridge | 167:e84263d55307 | 49 | virtual int isatty(); |
| AnnaBridge | 167:e84263d55307 | 50 | |
| AnnaBridge | 167:e84263d55307 | 51 | virtual off_t seek(off_t position, int whence); |
| AnnaBridge | 167:e84263d55307 | 52 | |
| AnnaBridge | 167:e84263d55307 | 53 | virtual int sync(); |
| AnnaBridge | 167:e84263d55307 | 54 | |
| AnnaBridge | 167:e84263d55307 | 55 | virtual off_t size(); |
| AnnaBridge | 167:e84263d55307 | 56 | |
| AnnaBridge | 167:e84263d55307 | 57 | protected: |
| AnnaBridge | 167:e84263d55307 | 58 | virtual void lock(); |
| AnnaBridge | 167:e84263d55307 | 59 | virtual void unlock(); |
| AnnaBridge | 167:e84263d55307 | 60 | FILEHANDLE _fh; |
| AnnaBridge | 167:e84263d55307 | 61 | int pos; |
| AnnaBridge | 167:e84263d55307 | 62 | PlatformMutex _mutex; |
| AnnaBridge | 167:e84263d55307 | 63 | }; |
| AnnaBridge | 167:e84263d55307 | 64 | |
| AnnaBridge | 167:e84263d55307 | 65 | /** A filesystem for accessing the local mbed Microcontroller USB disk drive |
| AnnaBridge | 167:e84263d55307 | 66 | * |
| AnnaBridge | 167:e84263d55307 | 67 | * This allows programs to read and write files on the same disk drive that is used to program the |
| AnnaBridge | 167:e84263d55307 | 68 | * mbed Microcontroller. Once created, the standard C file access functions are used to open, |
| AnnaBridge | 167:e84263d55307 | 69 | * read and write files. |
| AnnaBridge | 167:e84263d55307 | 70 | * |
| AnnaBridge | 167:e84263d55307 | 71 | * @note Synchronization level: Thread safe |
| AnnaBridge | 167:e84263d55307 | 72 | * |
| AnnaBridge | 167:e84263d55307 | 73 | * Example: |
| AnnaBridge | 167:e84263d55307 | 74 | * @code |
| AnnaBridge | 167:e84263d55307 | 75 | * #include "mbed.h" |
| AnnaBridge | 167:e84263d55307 | 76 | * |
| AnnaBridge | 167:e84263d55307 | 77 | * LocalFileSystem local("local"); // Create the local filesystem under the name "local" |
| AnnaBridge | 167:e84263d55307 | 78 | * |
| AnnaBridge | 167:e84263d55307 | 79 | * int main() { |
| AnnaBridge | 167:e84263d55307 | 80 | * FILE *fp = fopen("/local/out.txt", "w"); // Open "out.txt" on the local file system for writing |
| AnnaBridge | 167:e84263d55307 | 81 | * fprintf(fp, "Hello World!"); |
| AnnaBridge | 167:e84263d55307 | 82 | * fclose(fp); |
| AnnaBridge | 167:e84263d55307 | 83 | * remove("/local/out.txt"); // Removes the file "out.txt" from the local file system |
| AnnaBridge | 167:e84263d55307 | 84 | * |
| AnnaBridge | 167:e84263d55307 | 85 | * DIR *d = opendir("/local"); // Opens the root directory of the local file system |
| AnnaBridge | 167:e84263d55307 | 86 | * struct dirent *p; |
| AnnaBridge | 167:e84263d55307 | 87 | * while((p = readdir(d)) != NULL) { // Print the names of the files in the local file system |
| AnnaBridge | 167:e84263d55307 | 88 | * printf("%s\n", p->d_name); // to stdout. |
| AnnaBridge | 167:e84263d55307 | 89 | * } |
| AnnaBridge | 167:e84263d55307 | 90 | * closedir(d); |
| AnnaBridge | 167:e84263d55307 | 91 | * } |
| AnnaBridge | 167:e84263d55307 | 92 | * @endcode |
| AnnaBridge | 167:e84263d55307 | 93 | * |
| AnnaBridge | 167:e84263d55307 | 94 | * @note |
| AnnaBridge | 167:e84263d55307 | 95 | * If the microcontroller program makes an access to the local drive, it will be marked as "removed" |
| AnnaBridge | 167:e84263d55307 | 96 | * on the Host computer. This means it is no longer accessible from the Host Computer. |
| AnnaBridge | 167:e84263d55307 | 97 | * |
| AnnaBridge | 167:e84263d55307 | 98 | * The drive will only re-appear when the microcontroller program exists. Note that if the program does |
| AnnaBridge | 167:e84263d55307 | 99 | * not exit, you will need to hold down reset on the mbed Microcontroller to be able to see the drive again! |
| AnnaBridge | 167:e84263d55307 | 100 | * @ingroup platform |
| AnnaBridge | 167:e84263d55307 | 101 | */ |
| AnnaBridge | 168:9672193075cf | 102 | class LocalFileSystem : public FileSystemLike, private NonCopyable<LocalFileSystem> { |
| AnnaBridge | 167:e84263d55307 | 103 | // No modifiable state |
| AnnaBridge | 167:e84263d55307 | 104 | |
| AnnaBridge | 167:e84263d55307 | 105 | public: |
| AnnaBridge | 167:e84263d55307 | 106 | LocalFileSystem(const char* n) : FileSystemLike(n) { |
| AnnaBridge | 167:e84263d55307 | 107 | |
| AnnaBridge | 167:e84263d55307 | 108 | } |
| AnnaBridge | 167:e84263d55307 | 109 | |
| AnnaBridge | 167:e84263d55307 | 110 | virtual int open(FileHandle **file, const char *path, int flags); |
| AnnaBridge | 167:e84263d55307 | 111 | virtual int open(DirHandle **dir, const char *name); |
| AnnaBridge | 167:e84263d55307 | 112 | virtual int remove(const char *filename); |
| AnnaBridge | 167:e84263d55307 | 113 | }; |
| AnnaBridge | 167:e84263d55307 | 114 | |
| AnnaBridge | 167:e84263d55307 | 115 | } // namespace mbed |
| AnnaBridge | 167:e84263d55307 | 116 | |
| AnnaBridge | 167:e84263d55307 | 117 | #endif |
| AnnaBridge | 167:e84263d55307 | 118 | |
| AnnaBridge | 167:e84263d55307 | 119 | #endif |
| AnnaBridge | 167:e84263d55307 | 120 |