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.

DirHandle.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_DIRHANDLE_H
bogdanm 65:5798e58a58b1 17 #define MBED_DIRHANDLE_H
bogdanm 65:5798e58a58b1 18
bogdanm 65:5798e58a58b1 19 #if defined(__ARMCC_VERSION) || defined(__ICCARM__)
bogdanm 65:5798e58a58b1 20 # define NAME_MAX 255
bogdanm 65:5798e58a58b1 21 typedef int mode_t;
bogdanm 65:5798e58a58b1 22
bogdanm 65:5798e58a58b1 23 #else
bogdanm 65:5798e58a58b1 24 # include <sys/syslimits.h>
bogdanm 65:5798e58a58b1 25 #endif
bogdanm 65:5798e58a58b1 26
bogdanm 65:5798e58a58b1 27 #include "FileHandle.h"
bogdanm 65:5798e58a58b1 28
bogdanm 65:5798e58a58b1 29 struct dirent {
bogdanm 65:5798e58a58b1 30 char d_name[NAME_MAX+1];
bogdanm 65:5798e58a58b1 31 };
bogdanm 65:5798e58a58b1 32
bogdanm 65:5798e58a58b1 33 namespace mbed {
bogdanm 65:5798e58a58b1 34
bogdanm 65:5798e58a58b1 35 /** Represents a directory stream. Objects of this type are returned
bogdanm 65:5798e58a58b1 36 * by a FileSystemLike's opendir method. Implementations must define
bogdanm 65:5798e58a58b1 37 * at least closedir, readdir and rewinddir.
bogdanm 65:5798e58a58b1 38 *
bogdanm 65:5798e58a58b1 39 * If a FileSystemLike class defines the opendir method, then the
bogdanm 65:5798e58a58b1 40 * directories of an object of that type can be accessed by
bogdanm 65:5798e58a58b1 41 * DIR *d = opendir("/example/directory") (or opendir("/example")
bogdanm 65:5798e58a58b1 42 * to open the root of the filesystem), and then using readdir(d) etc.
bogdanm 65:5798e58a58b1 43 *
bogdanm 65:5798e58a58b1 44 * The root directory is considered to contain all FileLike and
bogdanm 65:5798e58a58b1 45 * FileSystemLike objects, so the DIR* returned by opendir("/") will
bogdanm 65:5798e58a58b1 46 * reflect this.
Kojto 122:f9eeca106725 47 *
Kojto 122:f9eeca106725 48 * @Note Synchronization level: Set by subclass
bogdanm 65:5798e58a58b1 49 */
bogdanm 65:5798e58a58b1 50 class DirHandle {
bogdanm 65:5798e58a58b1 51
bogdanm 65:5798e58a58b1 52 public:
bogdanm 65:5798e58a58b1 53 /** Closes the directory.
bogdanm 65:5798e58a58b1 54 *
bogdanm 65:5798e58a58b1 55 * @returns
bogdanm 65:5798e58a58b1 56 * 0 on success,
bogdanm 65:5798e58a58b1 57 * -1 on error.
bogdanm 65:5798e58a58b1 58 */
bogdanm 65:5798e58a58b1 59 virtual int closedir()=0;
bogdanm 65:5798e58a58b1 60
bogdanm 65:5798e58a58b1 61 /** Return the directory entry at the current position, and
bogdanm 65:5798e58a58b1 62 * advances the position to the next entry.
bogdanm 65:5798e58a58b1 63 *
bogdanm 65:5798e58a58b1 64 * @returns
bogdanm 65:5798e58a58b1 65 * A pointer to a dirent structure representing the
bogdanm 65:5798e58a58b1 66 * directory entry at the current position, or NULL on reaching
bogdanm 65:5798e58a58b1 67 * end of directory or error.
bogdanm 65:5798e58a58b1 68 */
bogdanm 65:5798e58a58b1 69 virtual struct dirent *readdir()=0;
bogdanm 65:5798e58a58b1 70
bogdanm 65:5798e58a58b1 71 /** Resets the position to the beginning of the directory.
bogdanm 65:5798e58a58b1 72 */
bogdanm 65:5798e58a58b1 73 virtual void rewinddir()=0;
bogdanm 65:5798e58a58b1 74
bogdanm 65:5798e58a58b1 75 /** Returns the current position of the DirHandle.
bogdanm 65:5798e58a58b1 76 *
bogdanm 65:5798e58a58b1 77 * @returns
bogdanm 65:5798e58a58b1 78 * the current position,
bogdanm 65:5798e58a58b1 79 * -1 on error.
bogdanm 65:5798e58a58b1 80 */
bogdanm 65:5798e58a58b1 81 virtual off_t telldir() { return -1; }
bogdanm 65:5798e58a58b1 82
bogdanm 65:5798e58a58b1 83 /** Sets the position of the DirHandle.
bogdanm 65:5798e58a58b1 84 *
bogdanm 65:5798e58a58b1 85 * @param location The location to seek to. Must be a value returned by telldir.
bogdanm 65:5798e58a58b1 86 */
Kojto 122:f9eeca106725 87 virtual void seekdir(off_t location) { (void)location;}
bogdanm 65:5798e58a58b1 88
bogdanm 65:5798e58a58b1 89 virtual ~DirHandle() {}
Kojto 122:f9eeca106725 90
Kojto 122:f9eeca106725 91 protected:
Kojto 122:f9eeca106725 92
Kojto 122:f9eeca106725 93 /** Acquire exclusive access to this object.
Kojto 122:f9eeca106725 94 */
Kojto 122:f9eeca106725 95 virtual void lock() {
Kojto 122:f9eeca106725 96 // Stub
Kojto 122:f9eeca106725 97 }
Kojto 122:f9eeca106725 98
Kojto 122:f9eeca106725 99 /** Release exclusive access to this object.
Kojto 122:f9eeca106725 100 */
Kojto 122:f9eeca106725 101 virtual void unlock() {
Kojto 122:f9eeca106725 102 // Stub
Kojto 122:f9eeca106725 103 }
bogdanm 65:5798e58a58b1 104 };
bogdanm 65:5798e58a58b1 105
bogdanm 65:5798e58a58b1 106 } // namespace mbed
bogdanm 65:5798e58a58b1 107
bogdanm 65:5798e58a58b1 108 typedef mbed::DirHandle DIR;
bogdanm 65:5798e58a58b1 109
bogdanm 65:5798e58a58b1 110 extern "C" {
bogdanm 65:5798e58a58b1 111 DIR *opendir(const char*);
bogdanm 65:5798e58a58b1 112 struct dirent *readdir(DIR *);
bogdanm 65:5798e58a58b1 113 int closedir(DIR*);
bogdanm 65:5798e58a58b1 114 void rewinddir(DIR*);
bogdanm 65:5798e58a58b1 115 long telldir(DIR*);
bogdanm 65:5798e58a58b1 116 void seekdir(DIR*, long);
bogdanm 65:5798e58a58b1 117 int mkdir(const char *name, mode_t n);
bogdanm 65:5798e58a58b1 118 };
bogdanm 65:5798e58a58b1 119
bogdanm 65:5798e58a58b1 120 #endif /* MBED_DIRHANDLE_H */