Maxim nexpaq / nexpaq_dev

Preliminary main mbed library for nexpaq development

hal/api/LocalFileSystem.h@1:d96dbedaebdb, 2016-11-04 (annotated)

Committer:
nexpaq
Date:
Fri Nov 04 20:54:50 2016 +0000
Revision:
1:d96dbedaebdb
Parent:
0:6c56fb4bc5f0 
Removed extra directories for other platforms

Who changed what in which revision?

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