takashi kadono / Mbed OS Nucleo446_SSD1331

Color Oled(SSD1331) connect to STMicroelectronics Nucleo-F466

Dependencies:   ssd1331

mbed-os/platform/LocalFileSystem.h@3:f3764f852aa8, 2018-10-11 (annotated)

Committer:
kadonotakashi
Date:
Thu Oct 11 02:27:46 2018 +0000
Revision:
3:f3764f852aa8
Parent:
0:8fdf9a60065b 
Nucreo 446 + SSD1331 test version;

Who changed what in which revision?

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