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@134:ad3be0349dc5, 2017-01-16 (annotated)

Committer:
<>
Date:
Mon Jan 16 12:05:23 2017 +0000
Revision:
134:ad3be0349dc5
Parent:
128:9bcdf88f62b0
Child:
138:093f2bd7b9eb
Release 134 of the mbed library



Ports for Upcoming Targets





Fixes and Changes



3488: Dev stm i2c v2 unitary functions https://github.com/ARMmbed/mbed-os/pull/3488

3492: Fix #3463 CAN read() return value https://github.com/ARMmbed/mbed-os/pull/3492

3503: [LPC15xx] Ensure that PWM=1 is resolved correctly https://github.com/ARMmbed/mbed-os/pull/3503

3504: [LPC15xx] CAN implementation improvements https://github.com/ARMmbed/mbed-os/pull/3504

3539: NUCLEO_F412ZG - Add support of TRNG peripheral https://github.com/ARMmbed/mbed-os/pull/3539

3540: STM: SPI: Initialize Rx in spi_master_write https://github.com/ARMmbed/mbed-os/pull/3540

3438: K64F: Add support for SERIAL ASYNCH API https://github.com/ARMmbed/mbed-os/pull/3438

3519: MCUXpresso: Fix ENET driver to enable interrupts after interrupt handler is set https://github.com/ARMmbed/mbed-os/pull/3519

3544: STM32L4 deepsleep improvement https://github.com/ARMmbed/mbed-os/pull/3544

3546: NUCLEO-F412ZG - Add CAN peripheral https://github.com/ARMmbed/mbed-os/pull/3546

3551: Fix I2C driver for RZ/A1H https://github.com/ARMmbed/mbed-os/pull/3551

3558: K64F UART Asynch API: Fix synchronization issue https://github.com/ARMmbed/mbed-os/pull/3558

3563: LPC4088 - Fix vector checksum https://github.com/ARMmbed/mbed-os/pull/3563

3567: Dev stm32 F0 v1.7.0 https://github.com/ARMmbed/mbed-os/pull/3567

3577: Fixes linking errors when building with debug profile https://github.com/ARMmbed/mbed-os/pull/3577

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