spinal cord / PokittoLib_

PokittoLib is the library needed for programming the Pokitto DIY game console (www.pokitto.com)

mbed-pokitto/api/LocalFileSystem.h@5:ea7377f3d1af, 2017-10-11 (annotated)

Committer:
Pokitto
Date:
Wed Oct 11 20:35:27 2017 +0000
Revision:
5:ea7377f3d1af
Fixed PokittoLib. Includes a working custom mbed-src

Who changed what in which revision?

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