Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

mbed-os/drivers/UARTSerial.h@0:e056ac8fecf8, 2018-03-13 (annotated)

Committer:
valeyev
Date:
Tue Mar 13 07:17:50 2018 +0000
Revision:
0:e056ac8fecf8
looking for...

Who changed what in which revision?

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