zain aftab / mbed-src

mbed library sources

Fork of mbed-src by mbed official

api/LocalFileSystem.h@636:a11c0372f0ba, 2015-09-30 (annotated)

Committer:
mbed_official
Date:
Wed Sep 30 17:00:09 2015 +0100
Revision:
636:a11c0372f0ba
Parent:
13:0645d8841f51 
Synchronized with git revision d29c98dae61be0946ddf3a3c641c7726056f9452



Full URL: https://github.com/mbedmicro/mbed/commit/d29c98dae61be0946ddf3a3c641c7726056f9452/



Added support for SAMW25

Who changed what in which revision?

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