Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

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