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@169:a7c7b631e539, 2018-06-22 (annotated)

Committer:
Anna Bridge
Date:
Fri Jun 22 15:38:59 2018 +0100
Revision:
169:a7c7b631e539
Parent:
160:5571c4ff569f
Child:
170:e95d10626187
mbed library. Release version 162

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 156:ff21514d8981 1 /* mbed Microcontroller Library
AnnaBridge 156:ff21514d8981 2 * Copyright (c) 2006-2017 ARM Limited
AnnaBridge 156:ff21514d8981 3 *
AnnaBridge 156:ff21514d8981 4 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 156:ff21514d8981 5 * you may not use this file except in compliance with the License.
AnnaBridge 156:ff21514d8981 6 * You may obtain a copy of the License at
AnnaBridge 156:ff21514d8981 7 *
AnnaBridge 156:ff21514d8981 8 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 156:ff21514d8981 9 *
AnnaBridge 156:ff21514d8981 10 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 156:ff21514d8981 11 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 156:ff21514d8981 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 156:ff21514d8981 13 * See the License for the specific language governing permissions and
AnnaBridge 156:ff21514d8981 14 * limitations under the License.
AnnaBridge 156:ff21514d8981 15 */
AnnaBridge 156:ff21514d8981 16
AnnaBridge 156:ff21514d8981 17 #ifndef MBED_UARTSERIAL_H
AnnaBridge 156:ff21514d8981 18 #define MBED_UARTSERIAL_H
AnnaBridge 156:ff21514d8981 19
AnnaBridge 156:ff21514d8981 20 #include "platform/platform.h"
AnnaBridge 156:ff21514d8981 21
AnnaBridge 156:ff21514d8981 22 #if (DEVICE_SERIAL && DEVICE_INTERRUPTIN) || defined(DOXYGEN_ONLY)
AnnaBridge 156:ff21514d8981 23
AnnaBridge 156:ff21514d8981 24 #include "FileHandle.h"
AnnaBridge 156:ff21514d8981 25 #include "SerialBase.h"
AnnaBridge 156:ff21514d8981 26 #include "InterruptIn.h"
AnnaBridge 156:ff21514d8981 27 #include "PlatformMutex.h"
AnnaBridge 156:ff21514d8981 28 #include "serial_api.h"
AnnaBridge 156:ff21514d8981 29 #include "CircularBuffer.h"
AnnaBridge 156:ff21514d8981 30 #include "platform/NonCopyable.h"
AnnaBridge 156:ff21514d8981 31
AnnaBridge 156:ff21514d8981 32 #ifndef MBED_CONF_DRIVERS_UART_SERIAL_RXBUF_SIZE
AnnaBridge 156:ff21514d8981 33 #define MBED_CONF_DRIVERS_UART_SERIAL_RXBUF_SIZE 256
AnnaBridge 156:ff21514d8981 34 #endif
AnnaBridge 156:ff21514d8981 35
AnnaBridge 156:ff21514d8981 36 #ifndef MBED_CONF_DRIVERS_UART_SERIAL_TXBUF_SIZE
AnnaBridge 156:ff21514d8981 37 #define MBED_CONF_DRIVERS_UART_SERIAL_TXBUF_SIZE 256
AnnaBridge 156:ff21514d8981 38 #endif
AnnaBridge 156:ff21514d8981 39
AnnaBridge 156:ff21514d8981 40 namespace mbed {
AnnaBridge 156:ff21514d8981 41
AnnaBridge 158:1c57384330a6 42 /** \addtogroup drivers */
AnnaBridge 158:1c57384330a6 43
AnnaBridge 158:1c57384330a6 44 /** Class providing buffered UART communication functionality using separate circular buffer for send and receive channels
AnnaBridge 158:1c57384330a6 45 *
AnnaBridge 158:1c57384330a6 46 * @ingroup drivers
AnnaBridge 158:1c57384330a6 47 */
AnnaBridge 158:1c57384330a6 48
AnnaBridge 156:ff21514d8981 49 class UARTSerial : private SerialBase, public FileHandle, private NonCopyable<UARTSerial> {
AnnaBridge 156:ff21514d8981 50
AnnaBridge 156:ff21514d8981 51 public:
AnnaBridge 156:ff21514d8981 52
AnnaBridge 156:ff21514d8981 53 /** Create a UARTSerial port, connected to the specified transmit and receive pins, with a particular baud rate.
AnnaBridge 156:ff21514d8981 54 * @param tx Transmit pin
AnnaBridge 156:ff21514d8981 55 * @param rx Receive pin
AnnaBridge 156:ff21514d8981 56 * @param baud The baud rate of the serial port (optional, defaults to MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE)
AnnaBridge 156:ff21514d8981 57 */
AnnaBridge 156:ff21514d8981 58 UARTSerial(PinName tx, PinName rx, int baud = MBED_CONF_PLATFORM_DEFAULT_SERIAL_BAUD_RATE);
AnnaBridge 156:ff21514d8981 59 virtual ~UARTSerial();
AnnaBridge 156:ff21514d8981 60
AnnaBridge 156:ff21514d8981 61 /** Equivalent to POSIX poll(). Derived from FileHandle.
AnnaBridge 156:ff21514d8981 62 * Provides a mechanism to multiplex input/output over a set of file handles.
AnnaBridge 156:ff21514d8981 63 */
AnnaBridge 156:ff21514d8981 64 virtual short poll(short events) const;
AnnaBridge 156:ff21514d8981 65
AnnaBridge 156:ff21514d8981 66 /* Resolve ambiguities versus our private SerialBase
AnnaBridge 156:ff21514d8981 67 * (for writable, spelling differs, but just in case)
AnnaBridge 156:ff21514d8981 68 */
AnnaBridge 156:ff21514d8981 69 using FileHandle::readable;
AnnaBridge 156:ff21514d8981 70 using FileHandle::writable;
AnnaBridge 156:ff21514d8981 71
AnnaBridge 156:ff21514d8981 72 /** Write the contents of a buffer to a file
AnnaBridge 156:ff21514d8981 73 *
Anna Bridge 160:5571c4ff569f 74 * Follows POSIX semantics:
Anna Bridge 160:5571c4ff569f 75 *
Anna Bridge 160:5571c4ff569f 76 * * if blocking, block until all data is written
Anna Bridge 160:5571c4ff569f 77 * * if no data can be written, and non-blocking set, return -EAGAIN
Anna Bridge 160:5571c4ff569f 78 * * if some data can be written, and non-blocking set, write partial
Anna Bridge 160:5571c4ff569f 79 *
AnnaBridge 156:ff21514d8981 80 * @param buffer The buffer to write from
AnnaBridge 156:ff21514d8981 81 * @param length The number of bytes to write
AnnaBridge 156:ff21514d8981 82 * @return The number of bytes written, negative error on failure
AnnaBridge 156:ff21514d8981 83 */
AnnaBridge 156:ff21514d8981 84 virtual ssize_t write(const void* buffer, size_t length);
AnnaBridge 156:ff21514d8981 85
AnnaBridge 156:ff21514d8981 86 /** Read the contents of a file into a buffer
AnnaBridge 156:ff21514d8981 87 *
AnnaBridge 156:ff21514d8981 88 * Follows POSIX semantics:
AnnaBridge 156:ff21514d8981 89 *
AnnaBridge 156:ff21514d8981 90 * * if no data is available, and non-blocking set return -EAGAIN
AnnaBridge 156:ff21514d8981 91 * * if no data is available, and blocking set, wait until data is available
AnnaBridge 156:ff21514d8981 92 * * If any data is available, call returns immediately
AnnaBridge 156:ff21514d8981 93 *
AnnaBridge 156:ff21514d8981 94 * @param buffer The buffer to read in to
AnnaBridge 156:ff21514d8981 95 * @param length The number of bytes to read
AnnaBridge 156:ff21514d8981 96 * @return The number of bytes read, 0 at end of file, negative error on failure
AnnaBridge 156:ff21514d8981 97 */
AnnaBridge 156:ff21514d8981 98 virtual ssize_t read(void* buffer, size_t length);
AnnaBridge 156:ff21514d8981 99
AnnaBridge 156:ff21514d8981 100 /** Close a file
AnnaBridge 156:ff21514d8981 101 *
AnnaBridge 156:ff21514d8981 102 * @return 0 on success, negative error code on failure
AnnaBridge 156:ff21514d8981 103 */
AnnaBridge 156:ff21514d8981 104 virtual int close();
AnnaBridge 156:ff21514d8981 105
AnnaBridge 156:ff21514d8981 106 /** Check if the file in an interactive terminal device
AnnaBridge 156:ff21514d8981 107 *
AnnaBridge 156:ff21514d8981 108 * @return True if the file is a terminal
AnnaBridge 156:ff21514d8981 109 * @return False if the file is not a terminal
AnnaBridge 156:ff21514d8981 110 * @return Negative error code on failure
AnnaBridge 156:ff21514d8981 111 */
AnnaBridge 156:ff21514d8981 112 virtual int isatty();
AnnaBridge 156:ff21514d8981 113
AnnaBridge 156:ff21514d8981 114 /** Move the file position to a given offset from from a given location
AnnaBridge 156:ff21514d8981 115 *
AnnaBridge 156:ff21514d8981 116 * Not valid for a device type FileHandle like UARTSerial.
AnnaBridge 156:ff21514d8981 117 * In case of UARTSerial, returns ESPIPE
AnnaBridge 156:ff21514d8981 118 *
AnnaBridge 156:ff21514d8981 119 * @param offset The offset from whence to move to
AnnaBridge 156:ff21514d8981 120 * @param whence The start of where to seek
AnnaBridge 156:ff21514d8981 121 * SEEK_SET to start from beginning of file,
AnnaBridge 156:ff21514d8981 122 * SEEK_CUR to start from current position in file,
AnnaBridge 156:ff21514d8981 123 * SEEK_END to start from end of file
AnnaBridge 156:ff21514d8981 124 * @return The new offset of the file, negative error code on failure
AnnaBridge 156:ff21514d8981 125 */
AnnaBridge 156:ff21514d8981 126 virtual off_t seek(off_t offset, int whence);
AnnaBridge 156:ff21514d8981 127
AnnaBridge 156:ff21514d8981 128 /** Flush any buffers associated with the file
AnnaBridge 156:ff21514d8981 129 *
AnnaBridge 156:ff21514d8981 130 * @return 0 on success, negative error code on failure
AnnaBridge 156:ff21514d8981 131 */
AnnaBridge 156:ff21514d8981 132 virtual int sync();
AnnaBridge 156:ff21514d8981 133
AnnaBridge 156:ff21514d8981 134 /** Set blocking or non-blocking mode
AnnaBridge 156:ff21514d8981 135 * The default is blocking.
AnnaBridge 156:ff21514d8981 136 *
AnnaBridge 156:ff21514d8981 137 * @param blocking true for blocking mode, false for non-blocking mode.
AnnaBridge 156:ff21514d8981 138 */
AnnaBridge 156:ff21514d8981 139 virtual int set_blocking(bool blocking)
AnnaBridge 156:ff21514d8981 140 {
AnnaBridge 156:ff21514d8981 141 _blocking = blocking;
AnnaBridge 156:ff21514d8981 142 return 0;
AnnaBridge 156:ff21514d8981 143 }
AnnaBridge 156:ff21514d8981 144
Anna Bridge 169:a7c7b631e539 145 /** Check current blocking or non-blocking mode for file operations.
Anna Bridge 169:a7c7b631e539 146 *
Anna Bridge 169:a7c7b631e539 147 * @return true for blocking mode, false for non-blocking mode.
Anna Bridge 169:a7c7b631e539 148 */
Anna Bridge 169:a7c7b631e539 149 virtual bool is_blocking() const
Anna Bridge 169:a7c7b631e539 150 {
Anna Bridge 169:a7c7b631e539 151 return _blocking;
Anna Bridge 169:a7c7b631e539 152 }
Anna Bridge 169:a7c7b631e539 153
AnnaBridge 156:ff21514d8981 154 /** Register a callback on state change of the file.
AnnaBridge 156:ff21514d8981 155 *
AnnaBridge 156:ff21514d8981 156 * The specified callback will be called on state changes such as when
AnnaBridge 156:ff21514d8981 157 * the file can be written to or read from.
AnnaBridge 156:ff21514d8981 158 *
AnnaBridge 156:ff21514d8981 159 * The callback may be called in an interrupt context and should not
AnnaBridge 156:ff21514d8981 160 * perform expensive operations.
AnnaBridge 156:ff21514d8981 161 *
AnnaBridge 156:ff21514d8981 162 * Note! This is not intended as an attach-like asynchronous api, but rather
AnnaBridge 156:ff21514d8981 163 * as a building block for constructing such functionality.
AnnaBridge 156:ff21514d8981 164 *
AnnaBridge 156:ff21514d8981 165 * The exact timing of when the registered function
AnnaBridge 156:ff21514d8981 166 * is called is not guaranteed and susceptible to change. It should be used
AnnaBridge 156:ff21514d8981 167 * as a cue to make read/write/poll calls to find the current state.
AnnaBridge 156:ff21514d8981 168 *
AnnaBridge 156:ff21514d8981 169 * @param func Function to call on state change
AnnaBridge 156:ff21514d8981 170 */
AnnaBridge 156:ff21514d8981 171 virtual void sigio(Callback<void()> func);
AnnaBridge 156:ff21514d8981 172
AnnaBridge 156:ff21514d8981 173 /** Setup interrupt handler for DCD line
AnnaBridge 156:ff21514d8981 174 *
AnnaBridge 156:ff21514d8981 175 * If DCD line is connected, an IRQ handler will be setup.
AnnaBridge 156:ff21514d8981 176 * Does nothing if DCD is NC, i.e., not connected.
AnnaBridge 156:ff21514d8981 177 *
AnnaBridge 156:ff21514d8981 178 * @param dcd_pin Pin-name for DCD
AnnaBridge 156:ff21514d8981 179 * @param active_high a boolean set to true if DCD polarity is active low
AnnaBridge 156:ff21514d8981 180 */
AnnaBridge 156:ff21514d8981 181 void set_data_carrier_detect(PinName dcd_pin, bool active_high = false);
AnnaBridge 156:ff21514d8981 182
AnnaBridge 156:ff21514d8981 183 /** Set the baud rate
AnnaBridge 156:ff21514d8981 184 *
AnnaBridge 156:ff21514d8981 185 * @param baud The baud rate
AnnaBridge 156:ff21514d8981 186 */
AnnaBridge 156:ff21514d8981 187 void set_baud(int baud);
AnnaBridge 156:ff21514d8981 188
Anna Bridge 160:5571c4ff569f 189 // Expose private SerialBase::Parity as UARTSerial::Parity
Anna Bridge 160:5571c4ff569f 190 using SerialBase::Parity;
Anna Bridge 160:5571c4ff569f 191 // In C++11, we wouldn't need to also have using directives for each value
Anna Bridge 160:5571c4ff569f 192 using SerialBase::None;
Anna Bridge 160:5571c4ff569f 193 using SerialBase::Odd;
Anna Bridge 160:5571c4ff569f 194 using SerialBase::Even;
Anna Bridge 160:5571c4ff569f 195 using SerialBase::Forced1;
Anna Bridge 160:5571c4ff569f 196 using SerialBase::Forced0;
Anna Bridge 160:5571c4ff569f 197
Anna Bridge 160:5571c4ff569f 198 /** Set the transmission format used by the serial port
Anna Bridge 160:5571c4ff569f 199 *
Anna Bridge 160:5571c4ff569f 200 * @param bits The number of bits in a word (5-8; default = 8)
Anna Bridge 160:5571c4ff569f 201 * @param parity The parity used (None, Odd, Even, Forced1, Forced0; default = None)
Anna Bridge 160:5571c4ff569f 202 * @param stop_bits The number of stop bits (1 or 2; default = 1)
Anna Bridge 160:5571c4ff569f 203 */
Anna Bridge 160:5571c4ff569f 204 void set_format(int bits=8, Parity parity=UARTSerial::None, int stop_bits=1);
Anna Bridge 160:5571c4ff569f 205
Anna Bridge 160:5571c4ff569f 206 #if DEVICE_SERIAL_FC
Anna Bridge 160:5571c4ff569f 207 // For now use the base enum - but in future we may have extra options
Anna Bridge 160:5571c4ff569f 208 // such as XON/XOFF or manual GPIO RTSCTS.
Anna Bridge 160:5571c4ff569f 209 using SerialBase::Flow;
Anna Bridge 160:5571c4ff569f 210 // In C++11, we wouldn't need to also have using directives for each value
Anna Bridge 160:5571c4ff569f 211 using SerialBase::Disabled;
Anna Bridge 160:5571c4ff569f 212 using SerialBase::RTS;
Anna Bridge 160:5571c4ff569f 213 using SerialBase::CTS;
Anna Bridge 160:5571c4ff569f 214 using SerialBase::RTSCTS;
Anna Bridge 160:5571c4ff569f 215
Anna Bridge 160:5571c4ff569f 216 /** Set the flow control type on the serial port
Anna Bridge 160:5571c4ff569f 217 *
Anna Bridge 160:5571c4ff569f 218 * @param type the flow control type (Disabled, RTS, CTS, RTSCTS)
Anna Bridge 160:5571c4ff569f 219 * @param flow1 the first flow control pin (RTS for RTS or RTSCTS, CTS for CTS)
Anna Bridge 160:5571c4ff569f 220 * @param flow2 the second flow control pin (CTS for RTSCTS)
Anna Bridge 160:5571c4ff569f 221 */
Anna Bridge 160:5571c4ff569f 222 void set_flow_control(Flow type, PinName flow1=NC, PinName flow2=NC);
Anna Bridge 160:5571c4ff569f 223 #endif
Anna Bridge 160:5571c4ff569f 224
AnnaBridge 156:ff21514d8981 225 private:
AnnaBridge 156:ff21514d8981 226
AnnaBridge 156:ff21514d8981 227 void wait_ms(uint32_t millisec);
AnnaBridge 156:ff21514d8981 228
AnnaBridge 156:ff21514d8981 229 /** SerialBase lock override */
AnnaBridge 156:ff21514d8981 230 virtual void lock(void);
AnnaBridge 156:ff21514d8981 231
AnnaBridge 156:ff21514d8981 232 /** SerialBase unlock override */
AnnaBridge 156:ff21514d8981 233 virtual void unlock(void);
AnnaBridge 156:ff21514d8981 234
AnnaBridge 156:ff21514d8981 235 /** Acquire mutex */
AnnaBridge 156:ff21514d8981 236 virtual void api_lock(void);
AnnaBridge 156:ff21514d8981 237
AnnaBridge 156:ff21514d8981 238 /** Release mutex */
AnnaBridge 156:ff21514d8981 239 virtual void api_unlock(void);
AnnaBridge 156:ff21514d8981 240
AnnaBridge 156:ff21514d8981 241 /** Software serial buffers
AnnaBridge 156:ff21514d8981 242 * By default buffer size is 256 for TX and 256 for RX. Configurable through mbed_app.json
AnnaBridge 156:ff21514d8981 243 */
AnnaBridge 156:ff21514d8981 244 CircularBuffer<char, MBED_CONF_DRIVERS_UART_SERIAL_RXBUF_SIZE> _rxbuf;
AnnaBridge 156:ff21514d8981 245 CircularBuffer<char, MBED_CONF_DRIVERS_UART_SERIAL_TXBUF_SIZE> _txbuf;
AnnaBridge 156:ff21514d8981 246
AnnaBridge 156:ff21514d8981 247 PlatformMutex _mutex;
AnnaBridge 156:ff21514d8981 248
AnnaBridge 156:ff21514d8981 249 Callback<void()> _sigio_cb;
AnnaBridge 156:ff21514d8981 250
AnnaBridge 156:ff21514d8981 251 bool _blocking;
AnnaBridge 156:ff21514d8981 252 bool _tx_irq_enabled;
Anna Bridge 160:5571c4ff569f 253 bool _rx_irq_enabled;
AnnaBridge 156:ff21514d8981 254 InterruptIn *_dcd_irq;
AnnaBridge 156:ff21514d8981 255
AnnaBridge 156:ff21514d8981 256 /** Device Hanged up
AnnaBridge 156:ff21514d8981 257 * Determines if the device hanged up on us.
AnnaBridge 156:ff21514d8981 258 *
AnnaBridge 156:ff21514d8981 259 * @return True, if hanged up
AnnaBridge 156:ff21514d8981 260 */
AnnaBridge 156:ff21514d8981 261 bool hup() const;
AnnaBridge 156:ff21514d8981 262
AnnaBridge 156:ff21514d8981 263 /** ISRs for serial
AnnaBridge 156:ff21514d8981 264 * Routines to handle interrupts on serial pins.
AnnaBridge 156:ff21514d8981 265 * Copies data into Circular Buffer.
AnnaBridge 156:ff21514d8981 266 * Reports the state change to File handle.
AnnaBridge 156:ff21514d8981 267 */
AnnaBridge 156:ff21514d8981 268 void tx_irq(void);
AnnaBridge 156:ff21514d8981 269 void rx_irq(void);
AnnaBridge 156:ff21514d8981 270
AnnaBridge 156:ff21514d8981 271 void wake(void);
AnnaBridge 156:ff21514d8981 272
AnnaBridge 156:ff21514d8981 273 void dcd_irq(void);
AnnaBridge 156:ff21514d8981 274
AnnaBridge 156:ff21514d8981 275 };
AnnaBridge 156:ff21514d8981 276 } //namespace mbed
AnnaBridge 156:ff21514d8981 277
AnnaBridge 156:ff21514d8981 278 #endif //(DEVICE_SERIAL && DEVICE_INTERRUPTIN) || defined(DOXYGEN_ONLY)
AnnaBridge 156:ff21514d8981 279 #endif //MBED_UARTSERIAL_H