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.
Fork of mbed by
drivers/FileSystemLike.h@128:9bcdf88f62b0, 2016-10-27 (annotated)
- Committer:
- <>
- Date:
- Thu Oct 27 16:45:56 2016 +0100
- Revision:
- 128:9bcdf88f62b0
Release 128 of the mbed library
Ports for Upcoming Targets
Fixes and Changes
2966: Add kw24 support https://github.com/ARMmbed/mbed-os/pull/2966
3068: MultiTech mDot - clean up PeripheralPins.c and add new pin names https://github.com/ARMmbed/mbed-os/pull/3068
3089: Kinetis HAL: Remove clock initialization code from serial and ticker https://github.com/ARMmbed/mbed-os/pull/3089
2943: [NRF5] NVIC_SetVector functionality https://github.com/ARMmbed/mbed-os/pull/2943
2938: InterruptIn changes in NCS36510 HAL. https://github.com/ARMmbed/mbed-os/pull/2938
3108: Fix sleep function for NRF52. https://github.com/ARMmbed/mbed-os/pull/3108
3076: STM32F1: Correct timer master value reading https://github.com/ARMmbed/mbed-os/pull/3076
3085: Add LOWPOWERTIMER capability for NUCLEO_F303ZE https://github.com/ARMmbed/mbed-os/pull/3085
3046: [BEETLE] Update BLE stack on Beetle board https://github.com/ARMmbed/mbed-os/pull/3046
3122: [Silicon Labs] Update of Silicon Labs HAL https://github.com/ARMmbed/mbed-os/pull/3122
3022: OnSemi RAM usage fix https://github.com/ARMmbed/mbed-os/pull/3022
3121: STM32F3: Correct UART4 and UART5 defines when using DEVICE_SERIAL_ASYNCH https://github.com/ARMmbed/mbed-os/pull/3121
3142: Targets- NUMAKER_PFM_NUC47216 remove mbed 2 https://github.com/ARMmbed/mbed-os/pull/3142
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| <> | 128:9bcdf88f62b0 | 1 | /* mbed Microcontroller Library |
| <> | 128:9bcdf88f62b0 | 2 | * Copyright (c) 2006-2013 ARM Limited |
| <> | 128:9bcdf88f62b0 | 3 | * |
| <> | 128:9bcdf88f62b0 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| <> | 128:9bcdf88f62b0 | 5 | * you may not use this file except in compliance with the License. |
| <> | 128:9bcdf88f62b0 | 6 | * You may obtain a copy of the License at |
| <> | 128:9bcdf88f62b0 | 7 | * |
| <> | 128:9bcdf88f62b0 | 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| <> | 128:9bcdf88f62b0 | 9 | * |
| <> | 128:9bcdf88f62b0 | 10 | * Unless required by applicable law or agreed to in writing, software |
| <> | 128:9bcdf88f62b0 | 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| <> | 128:9bcdf88f62b0 | 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| <> | 128:9bcdf88f62b0 | 13 | * See the License for the specific language governing permissions and |
| <> | 128:9bcdf88f62b0 | 14 | * limitations under the License. |
| <> | 128:9bcdf88f62b0 | 15 | */ |
| <> | 128:9bcdf88f62b0 | 16 | #ifndef MBED_FILESYSTEMLIKE_H |
| <> | 128:9bcdf88f62b0 | 17 | #define MBED_FILESYSTEMLIKE_H |
| <> | 128:9bcdf88f62b0 | 18 | |
| <> | 128:9bcdf88f62b0 | 19 | #include "platform/platform.h" |
| <> | 128:9bcdf88f62b0 | 20 | |
| <> | 128:9bcdf88f62b0 | 21 | #include "drivers/FileBase.h" |
| <> | 128:9bcdf88f62b0 | 22 | #include "drivers/FileHandle.h" |
| <> | 128:9bcdf88f62b0 | 23 | #include "drivers/DirHandle.h" |
| <> | 128:9bcdf88f62b0 | 24 | |
| <> | 128:9bcdf88f62b0 | 25 | namespace mbed { |
| <> | 128:9bcdf88f62b0 | 26 | /** \addtogroup drivers */ |
| <> | 128:9bcdf88f62b0 | 27 | /** @{*/ |
| <> | 128:9bcdf88f62b0 | 28 | |
| <> | 128:9bcdf88f62b0 | 29 | /** A filesystem-like object is one that can be used to open files |
| <> | 128:9bcdf88f62b0 | 30 | * though it by fopen("/name/filename", mode) |
| <> | 128:9bcdf88f62b0 | 31 | * |
| <> | 128:9bcdf88f62b0 | 32 | * Implementations must define at least open (the default definitions |
| <> | 128:9bcdf88f62b0 | 33 | * of the rest of the functions just return error values). |
| <> | 128:9bcdf88f62b0 | 34 | * |
| <> | 128:9bcdf88f62b0 | 35 | * @Note Synchronization level: Set by subclass |
| <> | 128:9bcdf88f62b0 | 36 | */ |
| <> | 128:9bcdf88f62b0 | 37 | class FileSystemLike : public FileBase { |
| <> | 128:9bcdf88f62b0 | 38 | |
| <> | 128:9bcdf88f62b0 | 39 | public: |
| <> | 128:9bcdf88f62b0 | 40 | /** FileSystemLike constructor |
| <> | 128:9bcdf88f62b0 | 41 | * |
| <> | 128:9bcdf88f62b0 | 42 | * @param name The name to use for the filesystem. |
| <> | 128:9bcdf88f62b0 | 43 | */ |
| <> | 128:9bcdf88f62b0 | 44 | FileSystemLike(const char *name); |
| <> | 128:9bcdf88f62b0 | 45 | |
| <> | 128:9bcdf88f62b0 | 46 | virtual ~FileSystemLike(); |
| <> | 128:9bcdf88f62b0 | 47 | |
| <> | 128:9bcdf88f62b0 | 48 | static DirHandle *opendir(); |
| <> | 128:9bcdf88f62b0 | 49 | friend class BaseDirHandle; |
| <> | 128:9bcdf88f62b0 | 50 | |
| <> | 128:9bcdf88f62b0 | 51 | /** Opens a file from the filesystem |
| <> | 128:9bcdf88f62b0 | 52 | * |
| <> | 128:9bcdf88f62b0 | 53 | * @param filename The name of the file to open. |
| <> | 128:9bcdf88f62b0 | 54 | * @param flags One of O_RDONLY, O_WRONLY, or O_RDWR, OR'd with |
| <> | 128:9bcdf88f62b0 | 55 | * zero or more of O_CREAT, O_TRUNC, or O_APPEND. |
| <> | 128:9bcdf88f62b0 | 56 | * |
| <> | 128:9bcdf88f62b0 | 57 | * @returns |
| <> | 128:9bcdf88f62b0 | 58 | * A pointer to a FileHandle object representing the |
| <> | 128:9bcdf88f62b0 | 59 | * file on success, or NULL on failure. |
| <> | 128:9bcdf88f62b0 | 60 | */ |
| <> | 128:9bcdf88f62b0 | 61 | virtual FileHandle *open(const char *filename, int flags) = 0; |
| <> | 128:9bcdf88f62b0 | 62 | |
| <> | 128:9bcdf88f62b0 | 63 | /** Remove a file from the filesystem. |
| <> | 128:9bcdf88f62b0 | 64 | * |
| <> | 128:9bcdf88f62b0 | 65 | * @param filename the name of the file to remove. |
| <> | 128:9bcdf88f62b0 | 66 | * @param returns 0 on success, -1 on failure. |
| <> | 128:9bcdf88f62b0 | 67 | */ |
| <> | 128:9bcdf88f62b0 | 68 | virtual int remove(const char *filename) { (void) filename; return -1; }; |
| <> | 128:9bcdf88f62b0 | 69 | |
| <> | 128:9bcdf88f62b0 | 70 | /** Rename a file in the filesystem. |
| <> | 128:9bcdf88f62b0 | 71 | * |
| <> | 128:9bcdf88f62b0 | 72 | * @param oldname the name of the file to rename. |
| <> | 128:9bcdf88f62b0 | 73 | * @param newname the name to rename it to. |
| <> | 128:9bcdf88f62b0 | 74 | * |
| <> | 128:9bcdf88f62b0 | 75 | * @returns |
| <> | 128:9bcdf88f62b0 | 76 | * 0 on success, |
| <> | 128:9bcdf88f62b0 | 77 | * -1 on failure. |
| <> | 128:9bcdf88f62b0 | 78 | */ |
| <> | 128:9bcdf88f62b0 | 79 | virtual int rename(const char *oldname, const char *newname) { (void) oldname, (void) newname; return -1; }; |
| <> | 128:9bcdf88f62b0 | 80 | |
| <> | 128:9bcdf88f62b0 | 81 | /** Opens a directory in the filesystem and returns a DirHandle |
| <> | 128:9bcdf88f62b0 | 82 | * representing the directory stream. |
| <> | 128:9bcdf88f62b0 | 83 | * |
| <> | 128:9bcdf88f62b0 | 84 | * @param name The name of the directory to open. |
| <> | 128:9bcdf88f62b0 | 85 | * |
| <> | 128:9bcdf88f62b0 | 86 | * @returns |
| <> | 128:9bcdf88f62b0 | 87 | * A DirHandle representing the directory stream, or |
| <> | 128:9bcdf88f62b0 | 88 | * NULL on failure. |
| <> | 128:9bcdf88f62b0 | 89 | */ |
| <> | 128:9bcdf88f62b0 | 90 | virtual DirHandle *opendir(const char *name) { (void) name; return NULL; }; |
| <> | 128:9bcdf88f62b0 | 91 | |
| <> | 128:9bcdf88f62b0 | 92 | /** Creates a directory in the filesystem. |
| <> | 128:9bcdf88f62b0 | 93 | * |
| <> | 128:9bcdf88f62b0 | 94 | * @param name The name of the directory to create. |
| <> | 128:9bcdf88f62b0 | 95 | * @param mode The permissions to create the directory with. |
| <> | 128:9bcdf88f62b0 | 96 | * |
| <> | 128:9bcdf88f62b0 | 97 | * @returns |
| <> | 128:9bcdf88f62b0 | 98 | * 0 on success, |
| <> | 128:9bcdf88f62b0 | 99 | * -1 on failure. |
| <> | 128:9bcdf88f62b0 | 100 | */ |
| <> | 128:9bcdf88f62b0 | 101 | virtual int mkdir(const char *name, mode_t mode) { (void) name, (void) mode; return -1; } |
| <> | 128:9bcdf88f62b0 | 102 | |
| <> | 128:9bcdf88f62b0 | 103 | // TODO other filesystem functions (mkdir, rm, rn, ls etc) |
| <> | 128:9bcdf88f62b0 | 104 | }; |
| <> | 128:9bcdf88f62b0 | 105 | |
| <> | 128:9bcdf88f62b0 | 106 | } // namespace mbed |
| <> | 128:9bcdf88f62b0 | 107 | |
| <> | 128:9bcdf88f62b0 | 108 | #endif |
| <> | 128:9bcdf88f62b0 | 109 | |
| <> | 128:9bcdf88f62b0 | 110 | /** @}*/ |
