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.

drivers/DirHandle.h@129:0ab6a29f35bf, 2016-11-08 (annotated)

Committer:
<>
Date:
Tue Nov 08 17:28:34 2016 +0000
Revision:
129:0ab6a29f35bf
Parent:
128:9bcdf88f62b0
Child:
138:093f2bd7b9eb
Release 129 of the mbed library



Ports for Upcoming Targets



3011: Add u-blox Sara-N target. https://github.com/ARMmbed/mbed-os/pull/3011

3099: MAX32625 https://github.com/ARMmbed/mbed-os/pull/3099

3151: Add support for FRDM-K82F https://github.com/ARMmbed/mbed-os/pull/3151

3177: New mcu k22512 fixing pr 3136 https://github.com/ARMmbed/mbed-os/pull/3177



Fixes and Changes



3008: NUCLEO_F072RB: Fix wrong timer channel number on pwm PB_5 pin https://github.com/ARMmbed/mbed-os/pull/3008

3013: STM32xx - Change how the ADC internal pins are checked before pinmap_ https://github.com/ARMmbed/mbed-os/pull/3013

3041: [nRF5] - added implementation of API of serial port flow control configuration. https://github.com/ARMmbed/mbed-os/pull/3041

3084: [nrf5] fix in Digital I/O : a gpioe pin was uninitialized badly https://github.com/ARMmbed/mbed-os/pull/3084

3009: TRNG enabled. TRNG APIs implemented. REV A/B/C/D flags removed. Warnings removed https://github.com/ARMmbed/mbed-os/pull/3009

3074: Target stm init gcc alignement https://github.com/ARMmbed/mbed-os/pull/3074

2988: Update of can_api.c fixing #2987 https://github.com/ARMmbed/mbed-os/pull/2988

3173: [Exporters] Add a device_name to microbit entry in targets.json https://github.com/ARMmbed/mbed-os/pull/3173

2969: [nRF52] - switch irq priorities of driver handlers to the lowest level https://github.com/ARMmbed/mbed-os/pull/2969

3184: #3183 Compiler warning in trng_api.c with K64F  https://github.com/ARMmbed/mbed-os/pull/3184

3104: [NuMaker] Support CAN and fix PWM CLK error https://github.com/ARMmbed/mbed-os/pull/3104

3186: MultiTech mDot - add back SPI3 pins https://github.com/ARMmbed/mbed-os/pull/3186

3075: nsapi - Add standardized return types for size and errors https://github.com/ARMmbed/mbed-os/pull/3075

3221: u-blox odin w2 drivers update https://github.com/ARMmbed/mbed-os/pull/3221

Who changed what in which revision?

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