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@158:1c57384330a6, 2017-11-23 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 23 11:44:04 2017 +0000
Revision:
158:1c57384330a6
Parent:
156:ff21514d8981
Child:
160:5571c4ff569f
mbed library. Release version 156

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 *
AnnaBridge 156:ff21514d8981 74 * @param buffer The buffer to write from
AnnaBridge 156:ff21514d8981 75 * @param length The number of bytes to write
AnnaBridge 156:ff21514d8981 76 * @return The number of bytes written, negative error on failure
AnnaBridge 156:ff21514d8981 77 */
AnnaBridge 156:ff21514d8981 78 virtual ssize_t write(const void* buffer, size_t length);
AnnaBridge 156:ff21514d8981 79
AnnaBridge 156:ff21514d8981 80 /** Read the contents of a file into a buffer
AnnaBridge 156:ff21514d8981 81 *
AnnaBridge 156:ff21514d8981 82 * Follows POSIX semantics:
AnnaBridge 156:ff21514d8981 83 *
AnnaBridge 156:ff21514d8981 84 * * if no data is available, and non-blocking set return -EAGAIN
AnnaBridge 156:ff21514d8981 85 * * if no data is available, and blocking set, wait until data is available
AnnaBridge 156:ff21514d8981 86 * * If any data is available, call returns immediately
AnnaBridge 156:ff21514d8981 87 *
AnnaBridge 156:ff21514d8981 88 * @param buffer The buffer to read in to
AnnaBridge 156:ff21514d8981 89 * @param length The number of bytes to read
AnnaBridge 156:ff21514d8981 90 * @return The number of bytes read, 0 at end of file, negative error on failure
AnnaBridge 156:ff21514d8981 91 */
AnnaBridge 156:ff21514d8981 92 virtual ssize_t read(void* buffer, size_t length);
AnnaBridge 156:ff21514d8981 93
AnnaBridge 156:ff21514d8981 94 /** Close a file
AnnaBridge 156:ff21514d8981 95 *
AnnaBridge 156:ff21514d8981 96 * @return 0 on success, negative error code on failure
AnnaBridge 156:ff21514d8981 97 */
AnnaBridge 156:ff21514d8981 98 virtual int close();
AnnaBridge 156:ff21514d8981 99
AnnaBridge 156:ff21514d8981 100 /** Check if the file in an interactive terminal device
AnnaBridge 156:ff21514d8981 101 *
AnnaBridge 156:ff21514d8981 102 * @return True if the file is a terminal
AnnaBridge 156:ff21514d8981 103 * @return False if the file is not a terminal
AnnaBridge 156:ff21514d8981 104 * @return Negative error code on failure
AnnaBridge 156:ff21514d8981 105 */
AnnaBridge 156:ff21514d8981 106 virtual int isatty();
AnnaBridge 156:ff21514d8981 107
AnnaBridge 156:ff21514d8981 108 /** Move the file position to a given offset from from a given location
AnnaBridge 156:ff21514d8981 109 *
AnnaBridge 156:ff21514d8981 110 * Not valid for a device type FileHandle like UARTSerial.
AnnaBridge 156:ff21514d8981 111 * In case of UARTSerial, returns ESPIPE
AnnaBridge 156:ff21514d8981 112 *
AnnaBridge 156:ff21514d8981 113 * @param offset The offset from whence to move to
AnnaBridge 156:ff21514d8981 114 * @param whence The start of where to seek
AnnaBridge 156:ff21514d8981 115 * SEEK_SET to start from beginning of file,
AnnaBridge 156:ff21514d8981 116 * SEEK_CUR to start from current position in file,
AnnaBridge 156:ff21514d8981 117 * SEEK_END to start from end of file
AnnaBridge 156:ff21514d8981 118 * @return The new offset of the file, negative error code on failure
AnnaBridge 156:ff21514d8981 119 */
AnnaBridge 156:ff21514d8981 120 virtual off_t seek(off_t offset, int whence);
AnnaBridge 156:ff21514d8981 121
AnnaBridge 156:ff21514d8981 122 /** Flush any buffers associated with the file
AnnaBridge 156:ff21514d8981 123 *
AnnaBridge 156:ff21514d8981 124 * @return 0 on success, negative error code on failure
AnnaBridge 156:ff21514d8981 125 */
AnnaBridge 156:ff21514d8981 126 virtual int sync();
AnnaBridge 156:ff21514d8981 127
AnnaBridge 156:ff21514d8981 128 /** Set blocking or non-blocking mode
AnnaBridge 156:ff21514d8981 129 * The default is blocking.
AnnaBridge 156:ff21514d8981 130 *
AnnaBridge 156:ff21514d8981 131 * @param blocking true for blocking mode, false for non-blocking mode.
AnnaBridge 156:ff21514d8981 132 */
AnnaBridge 156:ff21514d8981 133 virtual int set_blocking(bool blocking)
AnnaBridge 156:ff21514d8981 134 {
AnnaBridge 156:ff21514d8981 135 _blocking = blocking;
AnnaBridge 156:ff21514d8981 136 return 0;
AnnaBridge 156:ff21514d8981 137 }
AnnaBridge 156:ff21514d8981 138
AnnaBridge 156:ff21514d8981 139 /** Register a callback on state change of the file.
AnnaBridge 156:ff21514d8981 140 *
AnnaBridge 156:ff21514d8981 141 * The specified callback will be called on state changes such as when
AnnaBridge 156:ff21514d8981 142 * the file can be written to or read from.
AnnaBridge 156:ff21514d8981 143 *
AnnaBridge 156:ff21514d8981 144 * The callback may be called in an interrupt context and should not
AnnaBridge 156:ff21514d8981 145 * perform expensive operations.
AnnaBridge 156:ff21514d8981 146 *
AnnaBridge 156:ff21514d8981 147 * Note! This is not intended as an attach-like asynchronous api, but rather
AnnaBridge 156:ff21514d8981 148 * as a building block for constructing such functionality.
AnnaBridge 156:ff21514d8981 149 *
AnnaBridge 156:ff21514d8981 150 * The exact timing of when the registered function
AnnaBridge 156:ff21514d8981 151 * is called is not guaranteed and susceptible to change. It should be used
AnnaBridge 156:ff21514d8981 152 * as a cue to make read/write/poll calls to find the current state.
AnnaBridge 156:ff21514d8981 153 *
AnnaBridge 156:ff21514d8981 154 * @param func Function to call on state change
AnnaBridge 156:ff21514d8981 155 */
AnnaBridge 156:ff21514d8981 156 virtual void sigio(Callback<void()> func);
AnnaBridge 156:ff21514d8981 157
AnnaBridge 156:ff21514d8981 158 /** Setup interrupt handler for DCD line
AnnaBridge 156:ff21514d8981 159 *
AnnaBridge 156:ff21514d8981 160 * If DCD line is connected, an IRQ handler will be setup.
AnnaBridge 156:ff21514d8981 161 * Does nothing if DCD is NC, i.e., not connected.
AnnaBridge 156:ff21514d8981 162 *
AnnaBridge 156:ff21514d8981 163 * @param dcd_pin Pin-name for DCD
AnnaBridge 156:ff21514d8981 164 * @param active_high a boolean set to true if DCD polarity is active low
AnnaBridge 156:ff21514d8981 165 */
AnnaBridge 156:ff21514d8981 166 void set_data_carrier_detect(PinName dcd_pin, bool active_high = false);
AnnaBridge 156:ff21514d8981 167
AnnaBridge 156:ff21514d8981 168 /** Set the baud rate
AnnaBridge 156:ff21514d8981 169 *
AnnaBridge 156:ff21514d8981 170 * @param baud The baud rate
AnnaBridge 156:ff21514d8981 171 */
AnnaBridge 156:ff21514d8981 172 void set_baud(int baud);
AnnaBridge 156:ff21514d8981 173
AnnaBridge 156:ff21514d8981 174 private:
AnnaBridge 156:ff21514d8981 175
AnnaBridge 156:ff21514d8981 176 void wait_ms(uint32_t millisec);
AnnaBridge 156:ff21514d8981 177
AnnaBridge 156:ff21514d8981 178 /** SerialBase lock override */
AnnaBridge 156:ff21514d8981 179 virtual void lock(void);
AnnaBridge 156:ff21514d8981 180
AnnaBridge 156:ff21514d8981 181 /** SerialBase unlock override */
AnnaBridge 156:ff21514d8981 182 virtual void unlock(void);
AnnaBridge 156:ff21514d8981 183
AnnaBridge 156:ff21514d8981 184 /** Acquire mutex */
AnnaBridge 156:ff21514d8981 185 virtual void api_lock(void);
AnnaBridge 156:ff21514d8981 186
AnnaBridge 156:ff21514d8981 187 /** Release mutex */
AnnaBridge 156:ff21514d8981 188 virtual void api_unlock(void);
AnnaBridge 156:ff21514d8981 189
AnnaBridge 156:ff21514d8981 190 /** Software serial buffers
AnnaBridge 156:ff21514d8981 191 * By default buffer size is 256 for TX and 256 for RX. Configurable through mbed_app.json
AnnaBridge 156:ff21514d8981 192 */
AnnaBridge 156:ff21514d8981 193 CircularBuffer<char, MBED_CONF_DRIVERS_UART_SERIAL_RXBUF_SIZE> _rxbuf;
AnnaBridge 156:ff21514d8981 194 CircularBuffer<char, MBED_CONF_DRIVERS_UART_SERIAL_TXBUF_SIZE> _txbuf;
AnnaBridge 156:ff21514d8981 195
AnnaBridge 156:ff21514d8981 196 PlatformMutex _mutex;
AnnaBridge 156:ff21514d8981 197
AnnaBridge 156:ff21514d8981 198 Callback<void()> _sigio_cb;
AnnaBridge 156:ff21514d8981 199
AnnaBridge 156:ff21514d8981 200 bool _blocking;
AnnaBridge 156:ff21514d8981 201 bool _tx_irq_enabled;
AnnaBridge 156:ff21514d8981 202 InterruptIn *_dcd_irq;
AnnaBridge 156:ff21514d8981 203
AnnaBridge 156:ff21514d8981 204 /** Device Hanged up
AnnaBridge 156:ff21514d8981 205 * Determines if the device hanged up on us.
AnnaBridge 156:ff21514d8981 206 *
AnnaBridge 156:ff21514d8981 207 * @return True, if hanged up
AnnaBridge 156:ff21514d8981 208 */
AnnaBridge 156:ff21514d8981 209 bool hup() const;
AnnaBridge 156:ff21514d8981 210
AnnaBridge 156:ff21514d8981 211 /** ISRs for serial
AnnaBridge 156:ff21514d8981 212 * Routines to handle interrupts on serial pins.
AnnaBridge 156:ff21514d8981 213 * Copies data into Circular Buffer.
AnnaBridge 156:ff21514d8981 214 * Reports the state change to File handle.
AnnaBridge 156:ff21514d8981 215 */
AnnaBridge 156:ff21514d8981 216 void tx_irq(void);
AnnaBridge 156:ff21514d8981 217 void rx_irq(void);
AnnaBridge 156:ff21514d8981 218
AnnaBridge 156:ff21514d8981 219 void wake(void);
AnnaBridge 156:ff21514d8981 220
AnnaBridge 156:ff21514d8981 221 void dcd_irq(void);
AnnaBridge 156:ff21514d8981 222
AnnaBridge 156:ff21514d8981 223 };
AnnaBridge 156:ff21514d8981 224 } //namespace mbed
AnnaBridge 156:ff21514d8981 225
AnnaBridge 156:ff21514d8981 226 #endif //(DEVICE_SERIAL && DEVICE_INTERRUPTIN) || defined(DOXYGEN_ONLY)
AnnaBridge 156:ff21514d8981 227 #endif //MBED_UARTSERIAL_H