PES4 / Mbed OS Queue_02

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.

mbed-os/platform/LocalFileSystem.h@0:6bf0743ece18, 2020-03-28 (annotated)

Committer:
demayer
Date:
Sat Mar 28 15:28:19 2020 +0000
Revision:
0:6bf0743ece18
IMU Thread with an event-queue running parallel to handle tasks like a 5 times blinking LED. Button with interrupt detected.

Who changed what in which revision?

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