mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

FileSystemLike.h@122:f9eeca106725, 2016-07-07 (annotated)

Committer:
Kojto
Date:
Thu Jul 07 14:34:11 2016 +0100
Revision:
122:f9eeca106725
Parent:
65:5798e58a58b1 
Release 122 of the mbed library



Changes:

- new targets - Nucleo L432KC, Beetle, Nucleo F446ZE, Nucleo L011K4

- Thread safety addition - mbed API should contain a statement about thread safety

- critical section API addition

- CAS API (core_util_atomic_incr/decr)

- DEVICE_ are generated from targets.json file, device.h deprecated

- Callback replaces FunctionPointer to provide std like interface

- mbed HAL API docs improvements

- toolchain - prexif attributes with MBED_

            - add new attributes - packed, weak, forcedinline, align

- target.json - contains targets definitions

- ST - L1XX - Cube update to 1.5

     - SPI clock selection fix (clock from APB domain)

     - F7 - Cube update v1.4.0

     - L0 -  baudrate init fix

     - L1 - Cube update v1.5

     - F3 - baudrate init fix, 3 targets CAN support

     - F4 - Cube update v1.12.0, 3 targets CAN support

     - L4XX - Cube update v1.5.1

     - F0 - update Cube to v1.5.0

     - L4 - 2 targets (L476RG/VG) CAN support

- NXP - pwm clock fix for KSDK2 MCU

      - LPC2368 - remove ARM toolchain support - due to regression

      - KSDK2 - fix SPI , I2C address and repeat start

- Silabs - some fixes backported from mbed 3

- Renesas - RZ_A1H - SystemCoreClockUpdate addition

Who changed what in which revision?

UserRevisionLine numberNew contents of line
bogdanm 65:5798e58a58b1 1 /* mbed Microcontroller Library
bogdanm 65:5798e58a58b1 2 * Copyright (c) 2006-2013 ARM Limited
bogdanm 65:5798e58a58b1 3 *
bogdanm 65:5798e58a58b1 4 * Licensed under the Apache License, Version 2.0 (the "License");
bogdanm 65:5798e58a58b1 5 * you may not use this file except in compliance with the License.
bogdanm 65:5798e58a58b1 6 * You may obtain a copy of the License at
bogdanm 65:5798e58a58b1 7 *
bogdanm 65:5798e58a58b1 8 * http://www.apache.org/licenses/LICENSE-2.0
bogdanm 65:5798e58a58b1 9 *
bogdanm 65:5798e58a58b1 10 * Unless required by applicable law or agreed to in writing, software
bogdanm 65:5798e58a58b1 11 * distributed under the License is distributed on an "AS IS" BASIS,
bogdanm 65:5798e58a58b1 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
bogdanm 65:5798e58a58b1 13 * See the License for the specific language governing permissions and
bogdanm 65:5798e58a58b1 14 * limitations under the License.
bogdanm 65:5798e58a58b1 15 */
bogdanm 65:5798e58a58b1 16 #ifndef MBED_FILESYSTEMLIKE_H
bogdanm 65:5798e58a58b1 17 #define MBED_FILESYSTEMLIKE_H
bogdanm 65:5798e58a58b1 18
bogdanm 65:5798e58a58b1 19 #include "platform.h"
bogdanm 65:5798e58a58b1 20
bogdanm 65:5798e58a58b1 21 #include "FileBase.h"
bogdanm 65:5798e58a58b1 22 #include "FileHandle.h"
bogdanm 65:5798e58a58b1 23 #include "DirHandle.h"
bogdanm 65:5798e58a58b1 24
bogdanm 65:5798e58a58b1 25 namespace mbed {
bogdanm 65:5798e58a58b1 26
bogdanm 65:5798e58a58b1 27 /** A filesystem-like object is one that can be used to open files
bogdanm 65:5798e58a58b1 28 * though it by fopen("/name/filename", mode)
bogdanm 65:5798e58a58b1 29 *
bogdanm 65:5798e58a58b1 30 * Implementations must define at least open (the default definitions
bogdanm 65:5798e58a58b1 31 * of the rest of the functions just return error values).
Kojto 122:f9eeca106725 32 *
Kojto 122:f9eeca106725 33 * @Note Synchronization level: Set by subclass
bogdanm 65:5798e58a58b1 34 */
bogdanm 65:5798e58a58b1 35 class FileSystemLike : public FileBase {
bogdanm 65:5798e58a58b1 36
bogdanm 65:5798e58a58b1 37 public:
bogdanm 65:5798e58a58b1 38 /** FileSystemLike constructor
bogdanm 65:5798e58a58b1 39 *
bogdanm 65:5798e58a58b1 40 * @param name The name to use for the filesystem.
bogdanm 65:5798e58a58b1 41 */
bogdanm 65:5798e58a58b1 42 FileSystemLike(const char *name);
bogdanm 65:5798e58a58b1 43
bogdanm 65:5798e58a58b1 44 virtual ~FileSystemLike();
bogdanm 65:5798e58a58b1 45
bogdanm 65:5798e58a58b1 46 static DirHandle *opendir();
bogdanm 65:5798e58a58b1 47 friend class BaseDirHandle;
bogdanm 65:5798e58a58b1 48
bogdanm 65:5798e58a58b1 49 /** Opens a file from the filesystem
bogdanm 65:5798e58a58b1 50 *
bogdanm 65:5798e58a58b1 51 * @param filename The name of the file to open.
bogdanm 65:5798e58a58b1 52 * @param flags One of O_RDONLY, O_WRONLY, or O_RDWR, OR'd with
bogdanm 65:5798e58a58b1 53 * zero or more of O_CREAT, O_TRUNC, or O_APPEND.
bogdanm 65:5798e58a58b1 54 *
bogdanm 65:5798e58a58b1 55 * @returns
bogdanm 65:5798e58a58b1 56 * A pointer to a FileHandle object representing the
bogdanm 65:5798e58a58b1 57 * file on success, or NULL on failure.
bogdanm 65:5798e58a58b1 58 */
bogdanm 65:5798e58a58b1 59 virtual FileHandle *open(const char *filename, int flags) = 0;
bogdanm 65:5798e58a58b1 60
bogdanm 65:5798e58a58b1 61 /** Remove a file from the filesystem.
bogdanm 65:5798e58a58b1 62 *
bogdanm 65:5798e58a58b1 63 * @param filename the name of the file to remove.
bogdanm 65:5798e58a58b1 64 * @param returns 0 on success, -1 on failure.
bogdanm 65:5798e58a58b1 65 */
Kojto 122:f9eeca106725 66 virtual int remove(const char *filename) { (void) filename; return -1; };
bogdanm 65:5798e58a58b1 67
bogdanm 65:5798e58a58b1 68 /** Rename a file in the filesystem.
bogdanm 65:5798e58a58b1 69 *
bogdanm 65:5798e58a58b1 70 * @param oldname the name of the file to rename.
bogdanm 65:5798e58a58b1 71 * @param newname the name to rename it to.
bogdanm 65:5798e58a58b1 72 *
bogdanm 65:5798e58a58b1 73 * @returns
bogdanm 65:5798e58a58b1 74 * 0 on success,
bogdanm 65:5798e58a58b1 75 * -1 on failure.
bogdanm 65:5798e58a58b1 76 */
Kojto 122:f9eeca106725 77 virtual int rename(const char *oldname, const char *newname) { (void) oldname, (void) newname; return -1; };
bogdanm 65:5798e58a58b1 78
bogdanm 65:5798e58a58b1 79 /** Opens a directory in the filesystem and returns a DirHandle
bogdanm 65:5798e58a58b1 80 * representing the directory stream.
bogdanm 65:5798e58a58b1 81 *
bogdanm 65:5798e58a58b1 82 * @param name The name of the directory to open.
bogdanm 65:5798e58a58b1 83 *
bogdanm 65:5798e58a58b1 84 * @returns
bogdanm 65:5798e58a58b1 85 * A DirHandle representing the directory stream, or
bogdanm 65:5798e58a58b1 86 * NULL on failure.
bogdanm 65:5798e58a58b1 87 */
Kojto 122:f9eeca106725 88 virtual DirHandle *opendir(const char *name) { (void) name; return NULL; };
bogdanm 65:5798e58a58b1 89
bogdanm 65:5798e58a58b1 90 /** Creates a directory in the filesystem.
bogdanm 65:5798e58a58b1 91 *
bogdanm 65:5798e58a58b1 92 * @param name The name of the directory to create.
bogdanm 65:5798e58a58b1 93 * @param mode The permissions to create the directory with.
bogdanm 65:5798e58a58b1 94 *
bogdanm 65:5798e58a58b1 95 * @returns
bogdanm 65:5798e58a58b1 96 * 0 on success,
bogdanm 65:5798e58a58b1 97 * -1 on failure.
bogdanm 65:5798e58a58b1 98 */
Kojto 122:f9eeca106725 99 virtual int mkdir(const char *name, mode_t mode) { (void) name, (void) mode; return -1; }
bogdanm 65:5798e58a58b1 100
bogdanm 65:5798e58a58b1 101 // TODO other filesystem functions (mkdir, rm, rn, ls etc)
bogdanm 65:5798e58a58b1 102 };
bogdanm 65:5798e58a58b1 103
bogdanm 65:5798e58a58b1 104 } // namespace mbed
bogdanm 65:5798e58a58b1 105
bogdanm 65:5798e58a58b1 106 #endif