Christopher Haster / mbed-hal

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   target-freescale

Fork of mbed-hal by Morpheus

api/LocalFileSystem.h@0:9c59db1fbc9e, 2016-03-23 (annotated)

Committer:
screamer
Date:
Wed Mar 23 21:36:09 2016 +0000
Revision:
0:9c59db1fbc9e
Initial revision

Who changed what in which revision?

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