雄介 太田 / mbed

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.

Fork of mbed by mbed official

LocalFileSystem.h@43:e2ed12d17f06, 2012-10-26 (annotated)

Committer:
emilmont
Date:
Fri Oct 26 17:40:46 2012 +0100
Revision:
43:e2ed12d17f06
Parent:
32:3b05dd009342
Child:
44:24d45a770a51
Update documentation

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
emilmont 43:e2ed12d17f06 38 /** A filesystem for accessing the local mbed Microcontroller USB disk drive
simon.ford@mbed.co.uk 9:cf0d45ce28a6 39 *
simon.ford@mbed.co.uk 9:cf0d45ce28a6 40 * 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 41 * mbed Microcontroller. Once created, the standard C file access functions are used to open,
simon.ford@mbed.co.uk 9:cf0d45ce28a6 42 * read and write files.
simon.ford@mbed.co.uk 9:cf0d45ce28a6 43 *
simon.ford@mbed.co.uk 9:cf0d45ce28a6 44 * Example:
emilmont 43:e2ed12d17f06 45 * @code
emilmont 43:e2ed12d17f06 46 * #include "mbed.h"
emilmont 43:e2ed12d17f06 47 *
emilmont 43:e2ed12d17f06 48 * LocalFileSystem local("local"); // Create the local filesystem under the name "local"
emilmont 43:e2ed12d17f06 49 *
emilmont 43:e2ed12d17f06 50 * int main() {
emilmont 43:e2ed12d17f06 51 * FILE *fp = fopen("/local/out.txt", "w"); // Open "out.txt" on the local file system for writing
emilmont 43:e2ed12d17f06 52 * fprintf(fp, "Hello World!");
emilmont 43:e2ed12d17f06 53 * fclose(fp);
emilmont 43:e2ed12d17f06 54 * remove("/local/out.txt"); // Removes the file "out.txt" from the local file system
simon.ford@mbed.co.uk 9:cf0d45ce28a6 55 *
emilmont 43:e2ed12d17f06 56 * DIR *d = opendir("/local"); // Opens the root directory of the local file system
emilmont 43:e2ed12d17f06 57 * struct dirent *p;
emilmont 43:e2ed12d17f06 58 * while((p = readdir(d)) != NULL) { // Print the names of the files in the local file system
emilmont 43:e2ed12d17f06 59 * printf("%s\n", p->d_name); // to stdout.
emilmont 43:e2ed12d17f06 60 * }
emilmont 43:e2ed12d17f06 61 * closedir(d);
emilmont 43:e2ed12d17f06 62 * }
emilmont 43:e2ed12d17f06 63 * @endcode
emilmont 43:e2ed12d17f06 64 *
emilmont 43:e2ed12d17f06 65 * @note
simon.ford@mbed.co.uk 9:cf0d45ce28a6 66 * If the microcontroller program makes an access to the local drive, it will be marked as "removed"
simon.ford@mbed.co.uk 9:cf0d45ce28a6 67 * on the Host computer. This means it is no longer accessible from the Host Computer.
simon.ford@mbed.co.uk 9:cf0d45ce28a6 68 *
simon.ford@mbed.co.uk 9:cf0d45ce28a6 69 * The drive will only re-appear when the microcontroller program exists. Note that if the program does
simon.ford@mbed.co.uk 9:cf0d45ce28a6 70 * 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 71 */
simon.ford@mbed.co.uk 9:cf0d45ce28a6 72 class LocalFileSystem : public FileSystemLike {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 73
simon.ford@mbed.co.uk 9:cf0d45ce28a6 74 public:
simon.ford@mbed.co.uk 9:cf0d45ce28a6 75
simon.ford@mbed.co.uk 9:cf0d45ce28a6 76 LocalFileSystem(const char* n) : FileSystemLike(n) {
simon.ford@mbed.co.uk 9:cf0d45ce28a6 77
simon.ford@mbed.co.uk 9:cf0d45ce28a6 78 }
emilmont 43:e2ed12d17f06 79
simon.ford@mbed.co.uk 9:cf0d45ce28a6 80 virtual FileHandle *open(const char* name, int flags);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 81 virtual int remove(const char *filename);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 82 virtual DirHandle *opendir(const char *name);
simon.ford@mbed.co.uk 9:cf0d45ce28a6 83 };
simon.ford@mbed.co.uk 9:cf0d45ce28a6 84
simon.ford@mbed.co.uk 9:cf0d45ce28a6 85 } // namespace mbed
simon.ford@mbed.co.uk 9:cf0d45ce28a6 86
simon.ford@mbed.co.uk 9:cf0d45ce28a6 87 #endif