mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

drivers/UARTSerial.h@188:bcfe06ba3d64, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:46:34 2018 +0000
Revision:
188:bcfe06ba3d64
Parent:
187:0387e8f68319
Child:
189:f392fc9709a3
mbed-dev library. Release version 164

Who changed what in which revision?

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