Sertel_Srinath Gopalan / USB_SERTEL_LOG

Soundharrajan

Fork of mbed by mbed official

LocalFileSystem.h@92:f7fcbaa5f1b5, 2016-06-12 (annotated)

Committer:
mrsoundhar
Date:
Sun Jun 12 16:45:04 2016 +0000
Revision:
92:f7fcbaa5f1b5
Parent:
32:3b05dd009342
Child:
43:e2ed12d17f06
Soundharrajan

Who changed what in which revision?

UserRevisionLine numberNew contents of line
rolf.meyer@arm.com 11:1c1ebd0324fa 1 /* mbed Microcontroller Library - LocalFileSystem
rolf.meyer@arm.com 11:1c1ebd0324fa 2 * Copyright (c) 2008-2009 ARM Limited. All rights reserved.
rolf.meyer@arm.com 11:1c1ebd0324fa 3 */
rolf.meyer@arm.com 11:1c1ebd0324fa 4
simon.ford@mbed.co.uk 9:cf0d45ce28a6 5 #ifndef MBED_LOCALFILESYSTEM_H
simon.ford@mbed.co.uk 9:cf0d45ce28a6 6 #define MBED_LOCALFILESYSTEM_H
simon.ford@mbed.co.uk 9:cf0d45ce28a6 7
simon.ford@mbed.co.uk 9:cf0d45ce28a6 8 #include "FileSystemLike.h"
simon.ford@mbed.co.uk 9:cf0d45ce28a6 9
simon.ford@mbed.co.uk 9:cf0d45ce28a6 10 namespace mbed {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 11
emilmont 32:3b05dd009342 12 FILEHANDLE local_file_open(const char* name, int flags);
emilmont 32:3b05dd009342 13
emilmont 32:3b05dd009342 14 class LocalFileHandle : public FileHandle {
emilmont 32:3b05dd009342 15
emilmont 32:3b05dd009342 16 public:
emilmont 32:3b05dd009342 17 LocalFileHandle(FILEHANDLE fh);
emilmont 32:3b05dd009342 18
emilmont 32:3b05dd009342 19 virtual int close();
emilmont 32:3b05dd009342 20
emilmont 32:3b05dd009342 21 virtual ssize_t write(const void *buffer, size_t length);
emilmont 32:3b05dd009342 22
emilmont 32:3b05dd009342 23 virtual ssize_t read(void *buffer, size_t length);
emilmont 32:3b05dd009342 24
emilmont 32:3b05dd009342 25 virtual int isatty();
emilmont 32:3b05dd009342 26
emilmont 32:3b05dd009342 27 virtual off_t lseek(off_t position, int whence);
emilmont 32:3b05dd009342 28
emilmont 32:3b05dd009342 29 virtual int fsync();
emilmont 32:3b05dd009342 30
emilmont 32:3b05dd009342 31 virtual off_t flen();
emilmont 32:3b05dd009342 32
emilmont 32:3b05dd009342 33 protected:
emilmont 32:3b05dd009342 34 FILEHANDLE _fh;
emilmont 32:3b05dd009342 35 int pos;
emilmont 32:3b05dd009342 36 };
emilmont 32:3b05dd009342 37
simon.ford@mbed.co.uk 9:cf0d45ce28a6 38 /* Class: LocalFileSystem
rolf.meyer@arm.com 11:1c1ebd0324fa 39 * A filesystem for accessing the local mbed Microcontroller USB disk drive
simon.ford@mbed.co.uk 9:cf0d45ce28a6 40 *
simon.ford@mbed.co.uk 9:cf0d45ce28a6 41 * 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 42 * mbed Microcontroller. Once created, the standard C file access functions are used to open,
simon.ford@mbed.co.uk 9:cf0d45ce28a6 43 * read and write files.
simon.ford@mbed.co.uk 9:cf0d45ce28a6 44 *
simon.ford@mbed.co.uk 9:cf0d45ce28a6 45 * Example:
simon.ford@mbed.co.uk 9:cf0d45ce28a6 46 * > #include "mbed.h"
simon.ford@mbed.co.uk 9:cf0d45ce28a6 47 * >
simon.ford@mbed.co.uk 9:cf0d45ce28a6 48 * > LocalFileSystem local("local"); // Create the local filesystem under the name "local"
simon.ford@mbed.co.uk 9:cf0d45ce28a6 49 * >
simon.ford@mbed.co.uk 9:cf0d45ce28a6 50 * > int main() {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 51 * > FILE *fp = fopen("/local/out.txt", "w"); // Open "out.txt" on the local file system for writing
simon.ford@mbed.co.uk 9:cf0d45ce28a6 52 * > fprintf(fp, "Hello World!");
simon.ford@mbed.co.uk 9:cf0d45ce28a6 53 * > fclose(fp);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 54 * > remove("/local/out.txt"); // Removes the file "out.txt" from the local file system
simon.ford@mbed.co.uk 9:cf0d45ce28a6 55 * >
simon.ford@mbed.co.uk 9:cf0d45ce28a6 56 * > DIR *d = opendir("/local"); // Opens the root directory of the local file system
simon.ford@mbed.co.uk 9:cf0d45ce28a6 57 * > struct dirent *p;
simon.ford@mbed.co.uk 9:cf0d45ce28a6 58 * > while((p = readdir(d)) != NULL) { // Print the names of the files in the local file system
simon.ford@mbed.co.uk 9:cf0d45ce28a6 59 * > printf("%s\n", p->d_name); // to stdout.
simon.ford@mbed.co.uk 9:cf0d45ce28a6 60 * > }
simon.ford@mbed.co.uk 9:cf0d45ce28a6 61 * > closedir(d);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 62 * > }
simon.ford@mbed.co.uk 9:cf0d45ce28a6 63 *
simon.ford@mbed.co.uk 9:cf0d45ce28a6 64 * Implementation Notes:
simon.ford@mbed.co.uk 9:cf0d45ce28a6 65 * If the microcontroller program makes an access to the local drive, it will be marked as "removed"
simon.ford@mbed.co.uk 9:cf0d45ce28a6 66 * on the Host computer. This means it is no longer accessible from the Host Computer.
simon.ford@mbed.co.uk 9:cf0d45ce28a6 67 *
simon.ford@mbed.co.uk 9:cf0d45ce28a6 68 * The drive will only re-appear when the microcontroller program exists. Note that if the program does
simon.ford@mbed.co.uk 9:cf0d45ce28a6 69 * 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 70 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 71 class LocalFileSystem : public FileSystemLike {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 72
simon.ford@mbed.co.uk 9:cf0d45ce28a6 73 public:
simon.ford@mbed.co.uk 9:cf0d45ce28a6 74
simon.ford@mbed.co.uk 9:cf0d45ce28a6 75 LocalFileSystem(const char* n) : FileSystemLike(n) {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 76
simon.ford@mbed.co.uk 9:cf0d45ce28a6 77 }
simon.ford@mbed.co.uk 9:cf0d45ce28a6 78
simon.ford@mbed.co.uk 9:cf0d45ce28a6 79 virtual FileHandle *open(const char* name, int flags);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 80 virtual int remove(const char *filename);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 81 virtual DirHandle *opendir(const char *name);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 82 };
simon.ford@mbed.co.uk 9:cf0d45ce28a6 83
simon.ford@mbed.co.uk 9:cf0d45ce28a6 84 } // namespace mbed
simon.ford@mbed.co.uk 9:cf0d45ce28a6 85
simon.ford@mbed.co.uk 9:cf0d45ce28a6 86 #endif