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/UARTSerial.h@145:64910690c574, 2017-06-21 (annotated)

Committer:
AnnaBridge
Date:
Wed Jun 21 17:31:38 2017 +0100
Revision:
145:64910690c574
Child:
146:22da6e220af6
Release 145 of the mbed library.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 145:64910690c574 1 /* mbed Microcontroller Library
AnnaBridge 145:64910690c574 2 * Copyright (c) 2006-2017 ARM Limited
AnnaBridge 145:64910690c574 3 *
AnnaBridge 145:64910690c574 4 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 145:64910690c574 5 * you may not use this file except in compliance with the License.
AnnaBridge 145:64910690c574 6 * You may obtain a copy of the License at
AnnaBridge 145:64910690c574 7 *
AnnaBridge 145:64910690c574 8 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 145:64910690c574 9 *
AnnaBridge 145:64910690c574 10 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 145:64910690c574 11 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 145:64910690c574 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 145:64910690c574 13 * See the License for the specific language governing permissions and
AnnaBridge 145:64910690c574 14 * limitations under the License.
AnnaBridge 145:64910690c574 15 */
AnnaBridge 145:64910690c574 16
AnnaBridge 145:64910690c574 17 #ifndef MBED_UARTSERIAL_H
AnnaBridge 145:64910690c574 18 #define MBED_UARTSERIAL_H
AnnaBridge 145:64910690c574 19
AnnaBridge 145:64910690c574 20 #include "platform/platform.h"
AnnaBridge 145:64910690c574 21
AnnaBridge 145:64910690c574 22 #if DEVICE_SERIAL
AnnaBridge 145:64910690c574 23
AnnaBridge 145:64910690c574 24 #include "FileHandle.h"
AnnaBridge 145:64910690c574 25 #include "SerialBase.h"
AnnaBridge 145:64910690c574 26 #include "InterruptIn.h"
AnnaBridge 145:64910690c574 27 #include "PlatformMutex.h"
AnnaBridge 145:64910690c574 28 #include "serial_api.h"
AnnaBridge 145:64910690c574 29 #include "CircularBuffer.h"
AnnaBridge 145:64910690c574 30
AnnaBridge 145:64910690c574 31 #ifndef MBED_CONF_DRIVERS_UART_SERIAL_RXBUF_SIZE
AnnaBridge 145:64910690c574 32 #define MBED_CONF_DRIVERS_UART_SERIAL_RXBUF_SIZE 256
AnnaBridge 145:64910690c574 33 #endif
AnnaBridge 145:64910690c574 34
AnnaBridge 145:64910690c574 35 #ifndef MBED_CONF_DRIVERS_UART_SERIAL_TXBUF_SIZE
AnnaBridge 145:64910690c574 36 #define MBED_CONF_DRIVERS_UART_SERIAL_TXBUF_SIZE 256
AnnaBridge 145:64910690c574 37 #endif
AnnaBridge 145:64910690c574 38
AnnaBridge 145:64910690c574 39 namespace mbed {
AnnaBridge 145:64910690c574 40
AnnaBridge 145:64910690c574 41 class UARTSerial : private SerialBase, public FileHandle {
AnnaBridge 145:64910690c574 42
AnnaBridge 145:64910690c574 43 public:
AnnaBridge 145:64910690c574 44
AnnaBridge 145:64910690c574 45 /** Create a UARTSerial port, connected to the specified transmit and receive pins, with a particular baud rate.
AnnaBridge 145:64910690c574 46 * @param tx Transmit pin
AnnaBridge 145:64910690c574 47 * @param rx Receive pin
AnnaBridge 145:64910690c574 48 * @param baud The baud rate of the serial port (optional, defaults to MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE)
AnnaBridge 145:64910690c574 49 */
AnnaBridge 145:64910690c574 50 UARTSerial(PinName tx, PinName rx, int baud = MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE);
AnnaBridge 145:64910690c574 51 virtual ~UARTSerial();
AnnaBridge 145:64910690c574 52
AnnaBridge 145:64910690c574 53 /** Equivalent to POSIX poll(). Derived from FileHandle.
AnnaBridge 145:64910690c574 54 * Provides a mechanism to multiplex input/output over a set of file handles.
AnnaBridge 145:64910690c574 55 */
AnnaBridge 145:64910690c574 56 virtual short poll(short events) const;
AnnaBridge 145:64910690c574 57
AnnaBridge 145:64910690c574 58 /** Write the contents of a buffer to a file
AnnaBridge 145:64910690c574 59 *
AnnaBridge 145:64910690c574 60 * @param buffer The buffer to write from
AnnaBridge 145:64910690c574 61 * @param size The number of bytes to write
AnnaBridge 145:64910690c574 62 * @return The number of bytes written, negative error on failure
AnnaBridge 145:64910690c574 63 */
AnnaBridge 145:64910690c574 64 virtual ssize_t write(const void* buffer, size_t length);
AnnaBridge 145:64910690c574 65
AnnaBridge 145:64910690c574 66 /** Read the contents of a file into a buffer
AnnaBridge 145:64910690c574 67 *
AnnaBridge 145:64910690c574 68 * Follows POSIX semantics:
AnnaBridge 145:64910690c574 69 *
AnnaBridge 145:64910690c574 70 * * if no data is available, and non-blocking set return -EAGAIN
AnnaBridge 145:64910690c574 71 * * if no data is available, and blocking set, wait until data is available
AnnaBridge 145:64910690c574 72 * * If any data is available, call returns immediately
AnnaBridge 145:64910690c574 73 *
AnnaBridge 145:64910690c574 74 * @param buffer The buffer to read in to
AnnaBridge 145:64910690c574 75 * @param size The number of bytes to read
AnnaBridge 145:64910690c574 76 * @return The number of bytes read, 0 at end of file, negative error on failure
AnnaBridge 145:64910690c574 77 */
AnnaBridge 145:64910690c574 78 virtual ssize_t read(void* buffer, size_t length);
AnnaBridge 145:64910690c574 79
AnnaBridge 145:64910690c574 80 /** Acquire mutex */
AnnaBridge 145:64910690c574 81 virtual void lock(void);
AnnaBridge 145:64910690c574 82
AnnaBridge 145:64910690c574 83 /** Release mutex */
AnnaBridge 145:64910690c574 84 virtual void unlock(void);
AnnaBridge 145:64910690c574 85
AnnaBridge 145:64910690c574 86 /** Close a file
AnnaBridge 145:64910690c574 87 *
AnnaBridge 145:64910690c574 88 * @return 0 on success, negative error code on failure
AnnaBridge 145:64910690c574 89 */
AnnaBridge 145:64910690c574 90 virtual int close();
AnnaBridge 145:64910690c574 91
AnnaBridge 145:64910690c574 92 /** Check if the file in an interactive terminal device
AnnaBridge 145:64910690c574 93 *
AnnaBridge 145:64910690c574 94 * @return True if the file is a terminal
AnnaBridge 145:64910690c574 95 * @return False if the file is not a terminal
AnnaBridge 145:64910690c574 96 * @return Negative error code on failure
AnnaBridge 145:64910690c574 97 */
AnnaBridge 145:64910690c574 98 virtual int isatty();
AnnaBridge 145:64910690c574 99
AnnaBridge 145:64910690c574 100 /** Move the file position to a given offset from from a given location
AnnaBridge 145:64910690c574 101 *
AnnaBridge 145:64910690c574 102 * Not valid for a device type FileHandle like UARTSerial.
AnnaBridge 145:64910690c574 103 * In case of UARTSerial, returns ESPIPE
AnnaBridge 145:64910690c574 104 *
AnnaBridge 145:64910690c574 105 * @param offset The offset from whence to move to
AnnaBridge 145:64910690c574 106 * @param whence The start of where to seek
AnnaBridge 145:64910690c574 107 * SEEK_SET to start from beginning of file,
AnnaBridge 145:64910690c574 108 * SEEK_CUR to start from current position in file,
AnnaBridge 145:64910690c574 109 * SEEK_END to start from end of file
AnnaBridge 145:64910690c574 110 * @return The new offset of the file, negative error code on failure
AnnaBridge 145:64910690c574 111 */
AnnaBridge 145:64910690c574 112 virtual off_t seek(off_t offset, int whence);
AnnaBridge 145:64910690c574 113
AnnaBridge 145:64910690c574 114 /** Flush any buffers associated with the file
AnnaBridge 145:64910690c574 115 *
AnnaBridge 145:64910690c574 116 * @return 0 on success, negative error code on failure
AnnaBridge 145:64910690c574 117 */
AnnaBridge 145:64910690c574 118 virtual int sync();
AnnaBridge 145:64910690c574 119
AnnaBridge 145:64910690c574 120 /** Set blocking or non-blocking mode
AnnaBridge 145:64910690c574 121 * The default is blocking.
AnnaBridge 145:64910690c574 122 *
AnnaBridge 145:64910690c574 123 * @param blocking true for blocking mode, false for non-blocking mode.
AnnaBridge 145:64910690c574 124 */
AnnaBridge 145:64910690c574 125 virtual int set_blocking(bool blocking)
AnnaBridge 145:64910690c574 126 {
AnnaBridge 145:64910690c574 127 _blocking = blocking;
AnnaBridge 145:64910690c574 128 return 0;
AnnaBridge 145:64910690c574 129 }
AnnaBridge 145:64910690c574 130
AnnaBridge 145:64910690c574 131 /** Register a callback on state change of the file.
AnnaBridge 145:64910690c574 132 *
AnnaBridge 145:64910690c574 133 * The specified callback will be called on state changes such as when
AnnaBridge 145:64910690c574 134 * the file can be written to or read from.
AnnaBridge 145:64910690c574 135 *
AnnaBridge 145:64910690c574 136 * The callback may be called in an interrupt context and should not
AnnaBridge 145:64910690c574 137 * perform expensive operations.
AnnaBridge 145:64910690c574 138 *
AnnaBridge 145:64910690c574 139 * Note! This is not intended as an attach-like asynchronous api, but rather
AnnaBridge 145:64910690c574 140 * as a building block for constructing such functionality.
AnnaBridge 145:64910690c574 141 *
AnnaBridge 145:64910690c574 142 * The exact timing of when the registered function
AnnaBridge 145:64910690c574 143 * is called is not guaranteed and susceptible to change. It should be used
AnnaBridge 145:64910690c574 144 * as a cue to make read/write/poll calls to find the current state.
AnnaBridge 145:64910690c574 145 *
AnnaBridge 145:64910690c574 146 * @param func Function to call on state change
AnnaBridge 145:64910690c574 147 */
AnnaBridge 145:64910690c574 148 virtual void sigio(Callback<void()> func);
AnnaBridge 145:64910690c574 149
AnnaBridge 145:64910690c574 150 /** Setup interrupt handler for DCD line
AnnaBridge 145:64910690c574 151 *
AnnaBridge 145:64910690c574 152 * If DCD line is connected, an IRQ handler will be setup.
AnnaBridge 145:64910690c574 153 * Does nothing if DCD is NC, i.e., not connected.
AnnaBridge 145:64910690c574 154 *
AnnaBridge 145:64910690c574 155 * @param dcd_pin Pin-name for DCD
AnnaBridge 145:64910690c574 156 * @param active_high a boolean set to true if DCD polarity is active low
AnnaBridge 145:64910690c574 157 */
AnnaBridge 145:64910690c574 158 void set_data_carrier_detect(PinName dcd_pin, bool active_high = false);
AnnaBridge 145:64910690c574 159
AnnaBridge 145:64910690c574 160 private:
AnnaBridge 145:64910690c574 161
AnnaBridge 145:64910690c574 162 /** Software serial buffers
AnnaBridge 145:64910690c574 163 * By default buffer size is 256 for TX and 256 for RX. Configurable through mbed_app.json
AnnaBridge 145:64910690c574 164 */
AnnaBridge 145:64910690c574 165 CircularBuffer<char, MBED_CONF_DRIVERS_UART_SERIAL_RXBUF_SIZE> _rxbuf;
AnnaBridge 145:64910690c574 166 CircularBuffer<char, MBED_CONF_DRIVERS_UART_SERIAL_TXBUF_SIZE> _txbuf;
AnnaBridge 145:64910690c574 167
AnnaBridge 145:64910690c574 168 PlatformMutex _mutex;
AnnaBridge 145:64910690c574 169
AnnaBridge 145:64910690c574 170 Callback<void()> _sigio_cb;
AnnaBridge 145:64910690c574 171
AnnaBridge 145:64910690c574 172 bool _blocking;
AnnaBridge 145:64910690c574 173 bool _tx_irq_enabled;
AnnaBridge 145:64910690c574 174 InterruptIn *_dcd_irq;
AnnaBridge 145:64910690c574 175
AnnaBridge 145:64910690c574 176 /** Device Hanged up
AnnaBridge 145:64910690c574 177 * Determines if the device hanged up on us.
AnnaBridge 145:64910690c574 178 *
AnnaBridge 145:64910690c574 179 * @return True, if hanged up
AnnaBridge 145:64910690c574 180 */
AnnaBridge 145:64910690c574 181 bool hup() const;
AnnaBridge 145:64910690c574 182
AnnaBridge 145:64910690c574 183 /** ISRs for serial
AnnaBridge 145:64910690c574 184 * Routines to handle interrupts on serial pins.
AnnaBridge 145:64910690c574 185 * Copies data into Circular Buffer.
AnnaBridge 145:64910690c574 186 * Reports the state change to File handle.
AnnaBridge 145:64910690c574 187 */
AnnaBridge 145:64910690c574 188 void tx_irq(void);
AnnaBridge 145:64910690c574 189 void rx_irq(void);
AnnaBridge 145:64910690c574 190
AnnaBridge 145:64910690c574 191 void wake(void);
AnnaBridge 145:64910690c574 192
AnnaBridge 145:64910690c574 193 void dcd_irq(void);
AnnaBridge 145:64910690c574 194 };
AnnaBridge 145:64910690c574 195 } //namespace mbed
AnnaBridge 145:64910690c574 196
AnnaBridge 145:64910690c574 197 #endif //DEVICE_SERIAL
AnnaBridge 145:64910690c574 198 #endif //MBED_UARTSERIAL_H