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.

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