RYUICHI NAKAYAMA / mbed-dev

OK

Fork of mbed-dev by mbed official

api/LocalFileSystem.h@0:9b334a45a8ff, 2015-10-01 (annotated)

Committer:
bogdanm
Date:
Thu Oct 01 15:25:22 2015 +0300
Revision:
0:9b334a45a8ff
Initial commit on mbed-dev



Replaces mbed-src (now inactive)

Who changed what in which revision?

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