jesus antonio lopez / mbed

...

Dependents:   2doejemplo Labo_TRSE_Drone

Fork of mbed by mbed official

LocalFileSystem.h@54:71b101360fb9, 2013-01-08 (annotated)

Committer:
emilmont
Date:
Tue Jan 08 12:46:36 2013 +0000
Revision:
54:71b101360fb9
Parent:
44:24d45a770a51
Child:
55:d722ed6a4237
Support "stream as file" use case

Unify binary libraries

Update copyright

Who changed what in which revision?

UserRevisionLine numberNew contents of line
emilmont 44:24d45a770a51 1 /* mbed Microcontroller Library
emilmont 54:71b101360fb9 2 * Copyright (c) 2006-2013 ARM Limited
emilmont 44:24d45a770a51 3 *
emilmont 44:24d45a770a51 4 * Permission is hereby granted, free of charge, to any person obtaining a copy
emilmont 44:24d45a770a51 5 * of this software and associated documentation files (the "Software"), to deal
emilmont 44:24d45a770a51 6 * in the Software without restriction, including without limitation the rights
emilmont 44:24d45a770a51 7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
emilmont 44:24d45a770a51 8 * copies of the Software, and to permit persons to whom the Software is
emilmont 44:24d45a770a51 9 * furnished to do so, subject to the following conditions:
emilmont 44:24d45a770a51 10 *
emilmont 44:24d45a770a51 11 * The above copyright notice and this permission notice shall be included in
emilmont 44:24d45a770a51 12 * all copies or substantial portions of the Software.
emilmont 44:24d45a770a51 13 *
emilmont 44:24d45a770a51 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
emilmont 44:24d45a770a51 15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
emilmont 44:24d45a770a51 16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
emilmont 44:24d45a770a51 17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
emilmont 44:24d45a770a51 18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
emilmont 44:24d45a770a51 19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
emilmont 44:24d45a770a51 20 * SOFTWARE.
emilmont 44:24d45a770a51 21 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 22 #ifndef MBED_LOCALFILESYSTEM_H
simon.ford@mbed.co.uk 9:cf0d45ce28a6 23 #define MBED_LOCALFILESYSTEM_H
simon.ford@mbed.co.uk 9:cf0d45ce28a6 24
emilmont 44:24d45a770a51 25 #include "platform.h"
emilmont 44:24d45a770a51 26
emilmont 44:24d45a770a51 27 #if DEVICE_LOCALFILESYSTEM
emilmont 44:24d45a770a51 28
simon.ford@mbed.co.uk 9:cf0d45ce28a6 29 #include "FileSystemLike.h"
simon.ford@mbed.co.uk 9:cf0d45ce28a6 30
simon.ford@mbed.co.uk 9:cf0d45ce28a6 31 namespace mbed {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 32
emilmont 32:3b05dd009342 33 FILEHANDLE local_file_open(const char* name, int flags);
emilmont 32:3b05dd009342 34
emilmont 32:3b05dd009342 35 class LocalFileHandle : public FileHandle {
emilmont 32:3b05dd009342 36
emilmont 32:3b05dd009342 37 public:
emilmont 32:3b05dd009342 38 LocalFileHandle(FILEHANDLE fh);
emilmont 32:3b05dd009342 39
emilmont 32:3b05dd009342 40 virtual int close();
emilmont 32:3b05dd009342 41
emilmont 32:3b05dd009342 42 virtual ssize_t write(const void *buffer, size_t length);
emilmont 32:3b05dd009342 43
emilmont 32:3b05dd009342 44 virtual ssize_t read(void *buffer, size_t length);
emilmont 32:3b05dd009342 45
emilmont 32:3b05dd009342 46 virtual int isatty();
emilmont 32:3b05dd009342 47
emilmont 32:3b05dd009342 48 virtual off_t lseek(off_t position, int whence);
emilmont 32:3b05dd009342 49
emilmont 32:3b05dd009342 50 virtual int fsync();
emilmont 32:3b05dd009342 51
emilmont 32:3b05dd009342 52 virtual off_t flen();
emilmont 32:3b05dd009342 53
emilmont 32:3b05dd009342 54 protected:
emilmont 32:3b05dd009342 55 FILEHANDLE _fh;
emilmont 32:3b05dd009342 56 int pos;
emilmont 32:3b05dd009342 57 };
emilmont 32:3b05dd009342 58
emilmont 43:e2ed12d17f06 59 /** A filesystem for accessing the local mbed Microcontroller USB disk drive
simon.ford@mbed.co.uk 9:cf0d45ce28a6 60 *
simon.ford@mbed.co.uk 9:cf0d45ce28a6 61 * This allows programs to read and write files on the same disk drive that is used to program the
simon.ford@mbed.co.uk 9:cf0d45ce28a6 62 * mbed Microcontroller. Once created, the standard C file access functions are used to open,
simon.ford@mbed.co.uk 9:cf0d45ce28a6 63 * read and write files.
simon.ford@mbed.co.uk 9:cf0d45ce28a6 64 *
simon.ford@mbed.co.uk 9:cf0d45ce28a6 65 * Example:
emilmont 43:e2ed12d17f06 66 * @code
emilmont 43:e2ed12d17f06 67 * #include "mbed.h"
emilmont 43:e2ed12d17f06 68 *
emilmont 43:e2ed12d17f06 69 * LocalFileSystem local("local"); // Create the local filesystem under the name "local"
emilmont 43:e2ed12d17f06 70 *
emilmont 43:e2ed12d17f06 71 * int main() {
emilmont 43:e2ed12d17f06 72 * FILE *fp = fopen("/local/out.txt", "w"); // Open "out.txt" on the local file system for writing
emilmont 43:e2ed12d17f06 73 * fprintf(fp, "Hello World!");
emilmont 43:e2ed12d17f06 74 * fclose(fp);
emilmont 43:e2ed12d17f06 75 * remove("/local/out.txt"); // Removes the file "out.txt" from the local file system
simon.ford@mbed.co.uk 9:cf0d45ce28a6 76 *
emilmont 43:e2ed12d17f06 77 * DIR *d = opendir("/local"); // Opens the root directory of the local file system
emilmont 43:e2ed12d17f06 78 * struct dirent *p;
emilmont 43:e2ed12d17f06 79 * while((p = readdir(d)) != NULL) { // Print the names of the files in the local file system
emilmont 43:e2ed12d17f06 80 * printf("%s\n", p->d_name); // to stdout.
emilmont 43:e2ed12d17f06 81 * }
emilmont 43:e2ed12d17f06 82 * closedir(d);
emilmont 43:e2ed12d17f06 83 * }
emilmont 43:e2ed12d17f06 84 * @endcode
emilmont 43:e2ed12d17f06 85 *
emilmont 43:e2ed12d17f06 86 * @note
simon.ford@mbed.co.uk 9:cf0d45ce28a6 87 * If the microcontroller program makes an access to the local drive, it will be marked as "removed"
simon.ford@mbed.co.uk 9:cf0d45ce28a6 88 * on the Host computer. This means it is no longer accessible from the Host Computer.
simon.ford@mbed.co.uk 9:cf0d45ce28a6 89 *
simon.ford@mbed.co.uk 9:cf0d45ce28a6 90 * The drive will only re-appear when the microcontroller program exists. Note that if the program does
simon.ford@mbed.co.uk 9:cf0d45ce28a6 91 * not exit, you will need to hold down reset on the mbed Microcontroller to be able to see the drive again!
simon.ford@mbed.co.uk 9:cf0d45ce28a6 92 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 93 class LocalFileSystem : public FileSystemLike {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 94
simon.ford@mbed.co.uk 9:cf0d45ce28a6 95 public:
simon.ford@mbed.co.uk 9:cf0d45ce28a6 96 LocalFileSystem(const char* n) : FileSystemLike(n) {
emilmont 44:24d45a770a51 97
emilmont 44:24d45a770a51 98 }
simon.ford@mbed.co.uk 9:cf0d45ce28a6 99
simon.ford@mbed.co.uk 9:cf0d45ce28a6 100 virtual FileHandle *open(const char* name, int flags);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 101 virtual int remove(const char *filename);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 102 virtual DirHandle *opendir(const char *name);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 103 };
simon.ford@mbed.co.uk 9:cf0d45ce28a6 104
simon.ford@mbed.co.uk 9:cf0d45ce28a6 105 } // namespace mbed
simon.ford@mbed.co.uk 9:cf0d45ce28a6 106
simon.ford@mbed.co.uk 9:cf0d45ce28a6 107 #endif
emilmont 44:24d45a770a51 108
emilmont 44:24d45a770a51 109 #endif