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/SerialBase.h@170:e95d10626187, 2018-09-06 (annotated)

Committer:
AnnaBridge
Date:
Thu Sep 06 13:39:34 2018 +0100
Revision:
170:e95d10626187
Parent:
165:d1b4690b3f8b
Child:
171:3a7713b1edbc
mbed library. Release version 163

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-2013 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 #ifndef MBED_SERIALBASE_H
AnnaBridge 156:ff21514d8981 17 #define MBED_SERIALBASE_H
AnnaBridge 156:ff21514d8981 18
AnnaBridge 156:ff21514d8981 19 #include "platform/platform.h"
AnnaBridge 156:ff21514d8981 20
AnnaBridge 156:ff21514d8981 21 #if defined (DEVICE_SERIAL) || defined(DOXYGEN_ONLY)
AnnaBridge 156:ff21514d8981 22
AnnaBridge 156:ff21514d8981 23 #include "Callback.h"
AnnaBridge 156:ff21514d8981 24 #include "serial_api.h"
AnnaBridge 156:ff21514d8981 25 #include "mbed_toolchain.h"
AnnaBridge 156:ff21514d8981 26 #include "platform/NonCopyable.h"
AnnaBridge 156:ff21514d8981 27
AnnaBridge 156:ff21514d8981 28 #if DEVICE_SERIAL_ASYNCH
AnnaBridge 156:ff21514d8981 29 #include "CThunk.h"
AnnaBridge 156:ff21514d8981 30 #include "dma_api.h"
AnnaBridge 156:ff21514d8981 31 #endif
AnnaBridge 156:ff21514d8981 32
AnnaBridge 156:ff21514d8981 33 namespace mbed {
AnnaBridge 156:ff21514d8981 34 /** \addtogroup drivers */
AnnaBridge 156:ff21514d8981 35
AnnaBridge 156:ff21514d8981 36 /** A base class for serial port implementations
AnnaBridge 156:ff21514d8981 37 * Can't be instantiated directly (use Serial or RawSerial)
AnnaBridge 156:ff21514d8981 38 *
AnnaBridge 156:ff21514d8981 39 * @note Synchronization level: Set by subclass
AnnaBridge 156:ff21514d8981 40 * @ingroup drivers
AnnaBridge 156:ff21514d8981 41 */
AnnaBridge 156:ff21514d8981 42 class SerialBase : private NonCopyable<SerialBase> {
AnnaBridge 156:ff21514d8981 43
AnnaBridge 156:ff21514d8981 44 public:
AnnaBridge 156:ff21514d8981 45 /** Set the baud rate of the serial port
AnnaBridge 156:ff21514d8981 46 *
AnnaBridge 156:ff21514d8981 47 * @param baudrate The baudrate of the serial port (default = 9600).
AnnaBridge 156:ff21514d8981 48 */
AnnaBridge 156:ff21514d8981 49 void baud(int baudrate);
AnnaBridge 156:ff21514d8981 50
AnnaBridge 156:ff21514d8981 51 enum Parity {
AnnaBridge 156:ff21514d8981 52 None = 0,
AnnaBridge 156:ff21514d8981 53 Odd,
AnnaBridge 156:ff21514d8981 54 Even,
AnnaBridge 156:ff21514d8981 55 Forced1,
AnnaBridge 156:ff21514d8981 56 Forced0
AnnaBridge 156:ff21514d8981 57 };
AnnaBridge 156:ff21514d8981 58
AnnaBridge 156:ff21514d8981 59 enum IrqType {
AnnaBridge 156:ff21514d8981 60 RxIrq = 0,
AnnaBridge 156:ff21514d8981 61 TxIrq,
AnnaBridge 156:ff21514d8981 62
AnnaBridge 156:ff21514d8981 63 IrqCnt
AnnaBridge 156:ff21514d8981 64 };
AnnaBridge 156:ff21514d8981 65
AnnaBridge 156:ff21514d8981 66 enum Flow {
AnnaBridge 156:ff21514d8981 67 Disabled = 0,
AnnaBridge 156:ff21514d8981 68 RTS,
AnnaBridge 156:ff21514d8981 69 CTS,
AnnaBridge 156:ff21514d8981 70 RTSCTS
AnnaBridge 156:ff21514d8981 71 };
AnnaBridge 156:ff21514d8981 72
AnnaBridge 156:ff21514d8981 73 /** Set the transmission format used by the serial port
AnnaBridge 156:ff21514d8981 74 *
AnnaBridge 156:ff21514d8981 75 * @param bits The number of bits in a word (5-8; default = 8)
AnnaBridge 156:ff21514d8981 76 * @param parity The parity used (SerialBase::None, SerialBase::Odd, SerialBase::Even, SerialBase::Forced1, SerialBase::Forced0; default = SerialBase::None)
AnnaBridge 156:ff21514d8981 77 * @param stop_bits The number of stop bits (1 or 2; default = 1)
AnnaBridge 156:ff21514d8981 78 */
AnnaBridge 170:e95d10626187 79 void format(int bits = 8, Parity parity = SerialBase::None, int stop_bits = 1);
AnnaBridge 156:ff21514d8981 80
AnnaBridge 156:ff21514d8981 81 /** Determine if there is a character available to read
AnnaBridge 156:ff21514d8981 82 *
AnnaBridge 156:ff21514d8981 83 * @returns
AnnaBridge 156:ff21514d8981 84 * 1 if there is a character available to read,
AnnaBridge 156:ff21514d8981 85 * 0 otherwise
AnnaBridge 156:ff21514d8981 86 */
AnnaBridge 156:ff21514d8981 87 int readable();
AnnaBridge 156:ff21514d8981 88
AnnaBridge 156:ff21514d8981 89 /** Determine if there is space available to write a character
AnnaBridge 156:ff21514d8981 90 *
AnnaBridge 156:ff21514d8981 91 * @returns
AnnaBridge 156:ff21514d8981 92 * 1 if there is space to write a character,
AnnaBridge 156:ff21514d8981 93 * 0 otherwise
AnnaBridge 156:ff21514d8981 94 */
AnnaBridge 156:ff21514d8981 95 int writeable();
AnnaBridge 156:ff21514d8981 96
AnnaBridge 156:ff21514d8981 97 /** Attach a function to call whenever a serial interrupt is generated
AnnaBridge 156:ff21514d8981 98 *
AnnaBridge 156:ff21514d8981 99 * @param func A pointer to a void function, or 0 to set as none
AnnaBridge 156:ff21514d8981 100 * @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
AnnaBridge 156:ff21514d8981 101 */
AnnaBridge 170:e95d10626187 102 void attach(Callback<void()> func, IrqType type = RxIrq);
AnnaBridge 156:ff21514d8981 103
AnnaBridge 156:ff21514d8981 104 /** Attach a member function to call whenever a serial interrupt is generated
AnnaBridge 156:ff21514d8981 105 *
AnnaBridge 156:ff21514d8981 106 * @param obj pointer to the object to call the member function on
AnnaBridge 156:ff21514d8981 107 * @param method pointer to the member function to be called
AnnaBridge 156:ff21514d8981 108 * @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
AnnaBridge 156:ff21514d8981 109 * @deprecated
AnnaBridge 156:ff21514d8981 110 * The attach function does not support cv-qualifiers. Replaced by
AnnaBridge 156:ff21514d8981 111 * attach(callback(obj, method), type).
AnnaBridge 156:ff21514d8981 112 */
AnnaBridge 156:ff21514d8981 113 template<typename T>
AnnaBridge 156:ff21514d8981 114 MBED_DEPRECATED_SINCE("mbed-os-5.1",
AnnaBridge 170:e95d10626187 115 "The attach function does not support cv-qualifiers. Replaced by "
AnnaBridge 170:e95d10626187 116 "attach(callback(obj, method), type).")
AnnaBridge 170:e95d10626187 117 void attach(T *obj, void (T::*method)(), IrqType type = RxIrq)
AnnaBridge 170:e95d10626187 118 {
AnnaBridge 156:ff21514d8981 119 attach(callback(obj, method), type);
AnnaBridge 156:ff21514d8981 120 }
AnnaBridge 156:ff21514d8981 121
AnnaBridge 156:ff21514d8981 122 /** Attach a member function to call whenever a serial interrupt is generated
AnnaBridge 156:ff21514d8981 123 *
AnnaBridge 156:ff21514d8981 124 * @param obj pointer to the object to call the member function on
AnnaBridge 156:ff21514d8981 125 * @param method pointer to the member function to be called
AnnaBridge 156:ff21514d8981 126 * @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
AnnaBridge 156:ff21514d8981 127 * @deprecated
AnnaBridge 156:ff21514d8981 128 * The attach function does not support cv-qualifiers. Replaced by
AnnaBridge 156:ff21514d8981 129 * attach(callback(obj, method), type).
AnnaBridge 156:ff21514d8981 130 */
AnnaBridge 156:ff21514d8981 131 template<typename T>
AnnaBridge 156:ff21514d8981 132 MBED_DEPRECATED_SINCE("mbed-os-5.1",
AnnaBridge 170:e95d10626187 133 "The attach function does not support cv-qualifiers. Replaced by "
AnnaBridge 170:e95d10626187 134 "attach(callback(obj, method), type).")
AnnaBridge 170:e95d10626187 135 void attach(T *obj, void (*method)(T *), IrqType type = RxIrq)
AnnaBridge 170:e95d10626187 136 {
AnnaBridge 156:ff21514d8981 137 attach(callback(obj, method), type);
AnnaBridge 156:ff21514d8981 138 }
AnnaBridge 156:ff21514d8981 139
AnnaBridge 156:ff21514d8981 140 /** Generate a break condition on the serial line
AnnaBridge 156:ff21514d8981 141 */
AnnaBridge 156:ff21514d8981 142 void send_break();
AnnaBridge 156:ff21514d8981 143
AnnaBridge 156:ff21514d8981 144 protected:
AnnaBridge 156:ff21514d8981 145
AnnaBridge 156:ff21514d8981 146 /** Acquire exclusive access to this serial port
AnnaBridge 156:ff21514d8981 147 */
AnnaBridge 156:ff21514d8981 148 virtual void lock(void);
AnnaBridge 156:ff21514d8981 149
AnnaBridge 156:ff21514d8981 150 /** Release exclusive access to this serial port
AnnaBridge 156:ff21514d8981 151 */
AnnaBridge 156:ff21514d8981 152 virtual void unlock(void);
AnnaBridge 156:ff21514d8981 153
AnnaBridge 156:ff21514d8981 154 public:
AnnaBridge 156:ff21514d8981 155
AnnaBridge 156:ff21514d8981 156 #if DEVICE_SERIAL_FC
AnnaBridge 156:ff21514d8981 157 /** Set the flow control type on the serial port
AnnaBridge 156:ff21514d8981 158 *
AnnaBridge 156:ff21514d8981 159 * @param type the flow control type (Disabled, RTS, CTS, RTSCTS)
AnnaBridge 156:ff21514d8981 160 * @param flow1 the first flow control pin (RTS for RTS or RTSCTS, CTS for CTS)
AnnaBridge 156:ff21514d8981 161 * @param flow2 the second flow control pin (CTS for RTSCTS)
AnnaBridge 156:ff21514d8981 162 */
AnnaBridge 170:e95d10626187 163 void set_flow_control(Flow type, PinName flow1 = NC, PinName flow2 = NC);
AnnaBridge 156:ff21514d8981 164 #endif
AnnaBridge 156:ff21514d8981 165
AnnaBridge 156:ff21514d8981 166 static void _irq_handler(uint32_t id, SerialIrq irq_type);
AnnaBridge 156:ff21514d8981 167
AnnaBridge 156:ff21514d8981 168 #if DEVICE_SERIAL_ASYNCH
AnnaBridge 156:ff21514d8981 169
AnnaBridge 156:ff21514d8981 170 /** Begin asynchronous write using 8bit buffer. The completition invokes registered TX event callback
AnnaBridge 156:ff21514d8981 171 *
AnnaBridge 165:d1b4690b3f8b 172 * This function locks the deep sleep until any event has occurred
AnnaBridge 170:e95d10626187 173 *
AnnaBridge 156:ff21514d8981 174 * @param buffer The buffer where received data will be stored
AnnaBridge 156:ff21514d8981 175 * @param length The buffer length in bytes
AnnaBridge 156:ff21514d8981 176 * @param callback The event callback function
AnnaBridge 156:ff21514d8981 177 * @param event The logical OR of TX events
AnnaBridge 156:ff21514d8981 178 */
AnnaBridge 170:e95d10626187 179 int write(const uint8_t *buffer, int length, const event_callback_t &callback, int event = SERIAL_EVENT_TX_COMPLETE);
AnnaBridge 156:ff21514d8981 180
AnnaBridge 156:ff21514d8981 181 /** Begin asynchronous write using 16bit buffer. The completition invokes registered TX event callback
AnnaBridge 156:ff21514d8981 182 *
AnnaBridge 165:d1b4690b3f8b 183 * This function locks the deep sleep until any event has occurred
AnnaBridge 170:e95d10626187 184 *
AnnaBridge 156:ff21514d8981 185 * @param buffer The buffer where received data will be stored
AnnaBridge 156:ff21514d8981 186 * @param length The buffer length in bytes
AnnaBridge 156:ff21514d8981 187 * @param callback The event callback function
AnnaBridge 156:ff21514d8981 188 * @param event The logical OR of TX events
AnnaBridge 156:ff21514d8981 189 */
AnnaBridge 170:e95d10626187 190 int write(const uint16_t *buffer, int length, const event_callback_t &callback, int event = SERIAL_EVENT_TX_COMPLETE);
AnnaBridge 156:ff21514d8981 191
AnnaBridge 156:ff21514d8981 192 /** Abort the on-going write transfer
AnnaBridge 156:ff21514d8981 193 */
AnnaBridge 156:ff21514d8981 194 void abort_write();
AnnaBridge 156:ff21514d8981 195
AnnaBridge 156:ff21514d8981 196 /** Begin asynchronous reading using 8bit buffer. The completition invokes registred RX event callback.
AnnaBridge 156:ff21514d8981 197 *
AnnaBridge 165:d1b4690b3f8b 198 * This function locks the deep sleep until any event has occurred
AnnaBridge 170:e95d10626187 199 *
AnnaBridge 156:ff21514d8981 200 * @param buffer The buffer where received data will be stored
AnnaBridge 156:ff21514d8981 201 * @param length The buffer length in bytes
AnnaBridge 156:ff21514d8981 202 * @param callback The event callback function
AnnaBridge 156:ff21514d8981 203 * @param event The logical OR of RX events
AnnaBridge 156:ff21514d8981 204 * @param char_match The matching character
AnnaBridge 156:ff21514d8981 205 */
AnnaBridge 170:e95d10626187 206 int read(uint8_t *buffer, int length, const event_callback_t &callback, int event = SERIAL_EVENT_RX_COMPLETE, unsigned char char_match = SERIAL_RESERVED_CHAR_MATCH);
AnnaBridge 156:ff21514d8981 207
AnnaBridge 156:ff21514d8981 208 /** Begin asynchronous reading using 16bit buffer. The completition invokes registred RX event callback.
AnnaBridge 156:ff21514d8981 209 *
AnnaBridge 165:d1b4690b3f8b 210 * This function locks the deep sleep until any event has occurred
AnnaBridge 170:e95d10626187 211 *
AnnaBridge 156:ff21514d8981 212 * @param buffer The buffer where received data will be stored
AnnaBridge 156:ff21514d8981 213 * @param length The buffer length in bytes
AnnaBridge 156:ff21514d8981 214 * @param callback The event callback function
AnnaBridge 156:ff21514d8981 215 * @param event The logical OR of RX events
AnnaBridge 156:ff21514d8981 216 * @param char_match The matching character
AnnaBridge 156:ff21514d8981 217 */
AnnaBridge 170:e95d10626187 218 int read(uint16_t *buffer, int length, const event_callback_t &callback, int event = SERIAL_EVENT_RX_COMPLETE, unsigned char char_match = SERIAL_RESERVED_CHAR_MATCH);
AnnaBridge 156:ff21514d8981 219
AnnaBridge 156:ff21514d8981 220 /** Abort the on-going read transfer
AnnaBridge 156:ff21514d8981 221 */
AnnaBridge 156:ff21514d8981 222 void abort_read();
AnnaBridge 156:ff21514d8981 223
AnnaBridge 156:ff21514d8981 224 /** Configure DMA usage suggestion for non-blocking TX transfers
AnnaBridge 156:ff21514d8981 225 *
AnnaBridge 156:ff21514d8981 226 * @param usage The usage DMA hint for peripheral
AnnaBridge 156:ff21514d8981 227 * @return Zero if the usage was set, -1 if a transaction is on-going
AnnaBridge 156:ff21514d8981 228 */
AnnaBridge 156:ff21514d8981 229 int set_dma_usage_tx(DMAUsage usage);
AnnaBridge 156:ff21514d8981 230
AnnaBridge 156:ff21514d8981 231 /** Configure DMA usage suggestion for non-blocking RX transfers
AnnaBridge 156:ff21514d8981 232 *
AnnaBridge 156:ff21514d8981 233 * @param usage The usage DMA hint for peripheral
AnnaBridge 156:ff21514d8981 234 * @return Zero if the usage was set, -1 if a transaction is on-going
AnnaBridge 156:ff21514d8981 235 */
AnnaBridge 156:ff21514d8981 236 int set_dma_usage_rx(DMAUsage usage);
AnnaBridge 156:ff21514d8981 237
AnnaBridge 156:ff21514d8981 238 protected:
AnnaBridge 170:e95d10626187 239 void start_read(void *buffer, int buffer_size, char buffer_width, const event_callback_t &callback, int event, unsigned char char_match);
AnnaBridge 170:e95d10626187 240 void start_write(const void *buffer, int buffer_size, char buffer_width, const event_callback_t &callback, int event);
AnnaBridge 156:ff21514d8981 241 void interrupt_handler_asynch(void);
AnnaBridge 156:ff21514d8981 242 #endif
AnnaBridge 156:ff21514d8981 243
AnnaBridge 156:ff21514d8981 244 protected:
AnnaBridge 156:ff21514d8981 245 SerialBase(PinName tx, PinName rx, int baud);
AnnaBridge 156:ff21514d8981 246 virtual ~SerialBase();
AnnaBridge 156:ff21514d8981 247
AnnaBridge 156:ff21514d8981 248 int _base_getc();
AnnaBridge 156:ff21514d8981 249 int _base_putc(int c);
AnnaBridge 156:ff21514d8981 250
AnnaBridge 156:ff21514d8981 251 #if DEVICE_SERIAL_ASYNCH
AnnaBridge 156:ff21514d8981 252 CThunk<SerialBase> _thunk_irq;
AnnaBridge 156:ff21514d8981 253 DMAUsage _tx_usage;
AnnaBridge 156:ff21514d8981 254 DMAUsage _rx_usage;
AnnaBridge 156:ff21514d8981 255 event_callback_t _tx_callback;
AnnaBridge 156:ff21514d8981 256 event_callback_t _rx_callback;
AnnaBridge 156:ff21514d8981 257 #endif
AnnaBridge 156:ff21514d8981 258
AnnaBridge 156:ff21514d8981 259 serial_t _serial;
AnnaBridge 156:ff21514d8981 260 Callback<void()> _irq[IrqCnt];
AnnaBridge 156:ff21514d8981 261 int _baud;
AnnaBridge 156:ff21514d8981 262
AnnaBridge 156:ff21514d8981 263 };
AnnaBridge 156:ff21514d8981 264
AnnaBridge 156:ff21514d8981 265 } // namespace mbed
AnnaBridge 156:ff21514d8981 266
AnnaBridge 156:ff21514d8981 267 #endif
AnnaBridge 156:ff21514d8981 268
AnnaBridge 156:ff21514d8981 269 #endif