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/FileHandle.h@138:093f2bd7b9eb, 2017-03-14 (annotated)

Committer:
<>
Date:
Tue Mar 14 16:20:51 2017 +0000
Revision:
138:093f2bd7b9eb
Parent:
128:9bcdf88f62b0 
Release 138 of the mbed library



Ports for Upcoming Targets





Fixes and Changes



3716: fix for issue #3715: correction in startup files for ARM and IAR, alignment of system_stm32f429xx.c files https://github.com/ARMmbed/mbed-os/pull/3716

3741: STM32 remove warning in hal_tick_32b.c file https://github.com/ARMmbed/mbed-os/pull/3741

3780: STM32L4 : Fix GPIO G port compatibility https://github.com/ARMmbed/mbed-os/pull/3780

3831: NCS36510: SPISLAVE enabled (Conflict resolved) https://github.com/ARMmbed/mbed-os/pull/3831

3836: Allow to redefine nRF's PSTORAGE_NUM_OF_PAGES outside of the mbed-os https://github.com/ARMmbed/mbed-os/pull/3836

3840: STM32: gpio SPEED - always set High Speed by default https://github.com/ARMmbed/mbed-os/pull/3840

3844: STM32 GPIO: Typo correction. Update comment (GPIO_IP_WITHOUT_BRR) https://github.com/ARMmbed/mbed-os/pull/3844

3850: STM32: change spi error to debug warning https://github.com/ARMmbed/mbed-os/pull/3850

3860: Define GPIO_IP_WITHOUT_BRR for xDot platform https://github.com/ARMmbed/mbed-os/pull/3860

3880: DISCO_F469NI: allow the use of CAN2 instance when CAN1 is not activated https://github.com/ARMmbed/mbed-os/pull/3880

3795: Fix pwm period calc https://github.com/ARMmbed/mbed-os/pull/3795

3828: STM32 CAN API: correct format and type https://github.com/ARMmbed/mbed-os/pull/3828

3842: TARGET_NRF: corrected spi_init() to properly handle re-initialization https://github.com/ARMmbed/mbed-os/pull/3842

3843: STM32L476xG: set APB2 clock to 80MHz (instead of 40MHz) https://github.com/ARMmbed/mbed-os/pull/3843

3879: NUCLEO_F446ZE: Add missing AnalogIn pins on PF_3, PF_5 and PF_10. https://github.com/ARMmbed/mbed-os/pull/3879

3902: Fix heap and stack size for NUCLEO_F746ZG https://github.com/ARMmbed/mbed-os/pull/3902

3829: can_write(): return error code when no tx mailboxes are available https://github.com/ARMmbed/mbed-os/pull/3829

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_FILEHANDLE_H
<> 128:9bcdf88f62b0 17 #define MBED_FILEHANDLE_H
<> 128:9bcdf88f62b0 18
<> 128:9bcdf88f62b0 19 typedef int FILEHANDLE;
<> 128:9bcdf88f62b0 20
<> 128:9bcdf88f62b0 21 #include <stdio.h>
<> 138:093f2bd7b9eb 22 #include "platform/platform.h"
<> 128:9bcdf88f62b0 23
<> 128:9bcdf88f62b0 24 namespace mbed {
<> 128:9bcdf88f62b0 25 /** \addtogroup drivers */
<> 128:9bcdf88f62b0 26 /** @{*/
<> 128:9bcdf88f62b0 27
<> 128:9bcdf88f62b0 28 /** An OO equivalent of the internal FILEHANDLE variable
<> 128:9bcdf88f62b0 29 * and associated _sys_* functions.
<> 128:9bcdf88f62b0 30 *
<> 128:9bcdf88f62b0 31 * FileHandle is an abstract class, needing at least sys_write and
<> 128:9bcdf88f62b0 32 * sys_read to be implmented for a simple interactive device.
<> 128:9bcdf88f62b0 33 *
<> 128:9bcdf88f62b0 34 * No one ever directly tals to/instanciates a FileHandle - it gets
<> 128:9bcdf88f62b0 35 * created by FileSystem, and wrapped up by stdio.
<> 128:9bcdf88f62b0 36 *
<> 128:9bcdf88f62b0 37 * @Note Synchronization level: Set by subclass
<> 128:9bcdf88f62b0 38 */
<> 128:9bcdf88f62b0 39 class FileHandle {
<> 128:9bcdf88f62b0 40
<> 128:9bcdf88f62b0 41 public:
<> 138:093f2bd7b9eb 42 MBED_DEPRECATED_SINCE("mbed-os-5.4",
<> 138:093f2bd7b9eb 43 "The mbed 2 filesystem classes have been superseeded by the FileSystem api, "
<> 138:093f2bd7b9eb 44 "Replaced by File")
<> 138:093f2bd7b9eb 45 FileHandle() {}
<> 138:093f2bd7b9eb 46
<> 128:9bcdf88f62b0 47 /** Write the contents of a buffer to the file
<> 128:9bcdf88f62b0 48 *
<> 128:9bcdf88f62b0 49 * @param buffer the buffer to write from
<> 128:9bcdf88f62b0 50 * @param length the number of characters to write
<> 128:9bcdf88f62b0 51 *
<> 128:9bcdf88f62b0 52 * @returns
<> 128:9bcdf88f62b0 53 * The number of characters written (possibly 0) on success, -1 on error.
<> 128:9bcdf88f62b0 54 */
<> 128:9bcdf88f62b0 55 virtual ssize_t write(const void* buffer, size_t length) = 0;
<> 128:9bcdf88f62b0 56
<> 128:9bcdf88f62b0 57 /** Close the file
<> 128:9bcdf88f62b0 58 *
<> 128:9bcdf88f62b0 59 * @returns
<> 128:9bcdf88f62b0 60 * Zero on success, -1 on error.
<> 128:9bcdf88f62b0 61 */
<> 128:9bcdf88f62b0 62 virtual int close() = 0;
<> 128:9bcdf88f62b0 63
<> 128:9bcdf88f62b0 64 /** Function read
<> 128:9bcdf88f62b0 65 * Reads the contents of the file into a buffer
<> 128:9bcdf88f62b0 66 *
<> 128:9bcdf88f62b0 67 * @param buffer the buffer to read in to
<> 128:9bcdf88f62b0 68 * @param length the number of characters to read
<> 128:9bcdf88f62b0 69 *
<> 128:9bcdf88f62b0 70 * @returns
<> 128:9bcdf88f62b0 71 * The number of characters read (zero at end of file) on success, -1 on error.
<> 128:9bcdf88f62b0 72 */
<> 128:9bcdf88f62b0 73 virtual ssize_t read(void* buffer, size_t length) = 0;
<> 128:9bcdf88f62b0 74
<> 128:9bcdf88f62b0 75 /** Check if the handle is for a interactive terminal device.
<> 128:9bcdf88f62b0 76 * If so, line buffered behaviour is used by default
<> 128:9bcdf88f62b0 77 *
<> 128:9bcdf88f62b0 78 * @returns
<> 128:9bcdf88f62b0 79 * 1 if it is a terminal,
<> 128:9bcdf88f62b0 80 * 0 otherwise
<> 128:9bcdf88f62b0 81 */
<> 128:9bcdf88f62b0 82 virtual int isatty() = 0;
<> 128:9bcdf88f62b0 83
<> 128:9bcdf88f62b0 84 /** Move the file position to a given offset from a given location.
<> 128:9bcdf88f62b0 85 *
<> 128:9bcdf88f62b0 86 * @param offset The offset from whence to move to
<> 128:9bcdf88f62b0 87 * @param whence SEEK_SET for the start of the file, SEEK_CUR for the
<> 128:9bcdf88f62b0 88 * current file position, or SEEK_END for the end of the file.
<> 128:9bcdf88f62b0 89 *
<> 128:9bcdf88f62b0 90 * @returns
<> 128:9bcdf88f62b0 91 * new file position on success,
<> 128:9bcdf88f62b0 92 * -1 on failure or unsupported
<> 128:9bcdf88f62b0 93 */
<> 128:9bcdf88f62b0 94 virtual off_t lseek(off_t offset, int whence) = 0;
<> 128:9bcdf88f62b0 95
<> 128:9bcdf88f62b0 96 /** Flush any buffers associated with the FileHandle, ensuring it
<> 128:9bcdf88f62b0 97 * is up to date on disk
<> 128:9bcdf88f62b0 98 *
<> 128:9bcdf88f62b0 99 * @returns
<> 128:9bcdf88f62b0 100 * 0 on success or un-needed,
<> 128:9bcdf88f62b0 101 * -1 on error
<> 128:9bcdf88f62b0 102 */
<> 128:9bcdf88f62b0 103 virtual int fsync() = 0;
<> 128:9bcdf88f62b0 104
<> 128:9bcdf88f62b0 105 virtual off_t flen() {
<> 128:9bcdf88f62b0 106 lock();
<> 128:9bcdf88f62b0 107 /* remember our current position */
<> 128:9bcdf88f62b0 108 off_t pos = lseek(0, SEEK_CUR);
<> 128:9bcdf88f62b0 109 if(pos == -1) {
<> 128:9bcdf88f62b0 110 unlock();
<> 128:9bcdf88f62b0 111 return -1;
<> 128:9bcdf88f62b0 112 }
<> 128:9bcdf88f62b0 113 /* seek to the end to get the file length */
<> 128:9bcdf88f62b0 114 off_t res = lseek(0, SEEK_END);
<> 128:9bcdf88f62b0 115 /* return to our old position */
<> 128:9bcdf88f62b0 116 lseek(pos, SEEK_SET);
<> 128:9bcdf88f62b0 117 unlock();
<> 128:9bcdf88f62b0 118 return res;
<> 128:9bcdf88f62b0 119 }
<> 128:9bcdf88f62b0 120
<> 138:093f2bd7b9eb 121 virtual ~FileHandle() {};
<> 128:9bcdf88f62b0 122
<> 128:9bcdf88f62b0 123 protected:
<> 128:9bcdf88f62b0 124
<> 128:9bcdf88f62b0 125 /** Acquire exclusive access to this object.
<> 128:9bcdf88f62b0 126 */
<> 128:9bcdf88f62b0 127 virtual void lock() {
<> 128:9bcdf88f62b0 128 // Stub
<> 128:9bcdf88f62b0 129 }
<> 128:9bcdf88f62b0 130
<> 128:9bcdf88f62b0 131 /** Release exclusive access to this object.
<> 128:9bcdf88f62b0 132 */
<> 128:9bcdf88f62b0 133 virtual void unlock() {
<> 128:9bcdf88f62b0 134 // Stub
<> 128:9bcdf88f62b0 135 }
<> 128:9bcdf88f62b0 136 };
<> 128:9bcdf88f62b0 137
<> 128:9bcdf88f62b0 138 } // namespace mbed
<> 128:9bcdf88f62b0 139
<> 128:9bcdf88f62b0 140 #endif
<> 128:9bcdf88f62b0 141
<> 128:9bcdf88f62b0 142 /** @}*/