Einstein Filho / Mbed 2 deprecated MANGUEBAJA2019_BOX

Mangue Baja Box

Dependencies:   mbed

mbed/LocalFileSystem.h@0:0dee8840a1c0, 2019-07-29 (annotated)

Committer:
einsteingustavo
Date:
Mon Jul 29 20:38:00 2019 +0000
Revision:
0:0dee8840a1c0
Mangue Baja Box

Who changed what in which revision?

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