Ricardo Benitez / mbed

meh

Fork of mbed by mbed official

LocalFileSystem.h@118:16969dd821af, 2016-04-05 (annotated)

Committer:
ricardobtez
Date:
Tue Apr 05 23:51:21 2016 +0000
Revision:
118:16969dd821af
Parent:
65:5798e58a58b1 
dgdgr

Who changed what in which revision?

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