Lancaster University / mbed-lite-test

test

LocalFileSystem.h@1:a7c51b5e0534, 2016-04-07 (annotated)

Committer:
jamesadevine
Date:
Thu Apr 07 17:50:29 2016 +0000
Revision:
1:a7c51b5e0534
Parent:
0:e1a608bb55e8 
Added correct nrf51.h ; Added scatter file.

Who changed what in which revision?

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