Nathan Yonkee / Mbed 2 deprecated Nucleo_sinewave_output_copy

init

Dependencies:   mbed

mbed-os/drivers/UARTSerial.h@10:46a4cf51ee38, 2018-03-02 (annotated)

Committer:
Nathan Yonkee
Date:
Fri Mar 02 07:16:49 2018 -0700
Revision:
10:46a4cf51ee38
Parent:
9:d58e77ebd769 
remove mbed-os

Who changed what in which revision?

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