Aditya Mehrotra / mbed-dev

Biomimetics MBED Library w/ Added Support for CAN3

Dependents:   CAN_TEST SPIne_Plus_DYNO_SENSORS SPIne_Plus_v2 SPIne_Plus_Dyno_v2

platform/LocalFileSystem.h@3:993b4d6ff61e, 2021-03-09 (annotated)

Committer:
adimmit
Date:
Tue Mar 09 20:33:24 2021 +0000
Revision:
3:993b4d6ff61e
Parent:
0:083111ae2a11 
added CAN3

Who changed what in which revision?

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