PHung Tung / SRC_STM32F7

SPKT

Dependents:   WAV

api/SerialBase.h@0:e87aa4c49e95, 2019-06-04 (annotated)

Committer:
phungductung
Date:
Tue Jun 04 21:51:46 2019 +0000
Revision:
0:e87aa4c49e95
libray

Who changed what in which revision?

UserRevisionLine numberNew contents of line
phungductung 0:e87aa4c49e95 1 /* mbed Microcontroller Library
phungductung 0:e87aa4c49e95 2 * Copyright (c) 2006-2013 ARM Limited
phungductung 0:e87aa4c49e95 3 *
phungductung 0:e87aa4c49e95 4 * Licensed under the Apache License, Version 2.0 (the "License");
phungductung 0:e87aa4c49e95 5 * you may not use this file except in compliance with the License.
phungductung 0:e87aa4c49e95 6 * You may obtain a copy of the License at
phungductung 0:e87aa4c49e95 7 *
phungductung 0:e87aa4c49e95 8 * http://www.apache.org/licenses/LICENSE-2.0
phungductung 0:e87aa4c49e95 9 *
phungductung 0:e87aa4c49e95 10 * Unless required by applicable law or agreed to in writing, software
phungductung 0:e87aa4c49e95 11 * distributed under the License is distributed on an "AS IS" BASIS,
phungductung 0:e87aa4c49e95 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
phungductung 0:e87aa4c49e95 13 * See the License for the specific language governing permissions and
phungductung 0:e87aa4c49e95 14 * limitations under the License.
phungductung 0:e87aa4c49e95 15 */
phungductung 0:e87aa4c49e95 16 #ifndef MBED_SERIALBASE_H
phungductung 0:e87aa4c49e95 17 #define MBED_SERIALBASE_H
phungductung 0:e87aa4c49e95 18
phungductung 0:e87aa4c49e95 19 #include "platform.h"
phungductung 0:e87aa4c49e95 20
phungductung 0:e87aa4c49e95 21 #if DEVICE_SERIAL
phungductung 0:e87aa4c49e95 22
phungductung 0:e87aa4c49e95 23 #include "Stream.h"
phungductung 0:e87aa4c49e95 24 #include "FunctionPointer.h"
phungductung 0:e87aa4c49e95 25 #include "serial_api.h"
phungductung 0:e87aa4c49e95 26
phungductung 0:e87aa4c49e95 27 #if DEVICE_SERIAL_ASYNCH
phungductung 0:e87aa4c49e95 28 #include "CThunk.h"
phungductung 0:e87aa4c49e95 29 #include "dma_api.h"
phungductung 0:e87aa4c49e95 30 #endif
phungductung 0:e87aa4c49e95 31
phungductung 0:e87aa4c49e95 32 namespace mbed {
phungductung 0:e87aa4c49e95 33
phungductung 0:e87aa4c49e95 34 /** A base class for serial port implementations
phungductung 0:e87aa4c49e95 35 * Can't be instantiated directly (use Serial or RawSerial)
phungductung 0:e87aa4c49e95 36 */
phungductung 0:e87aa4c49e95 37 class SerialBase {
phungductung 0:e87aa4c49e95 38
phungductung 0:e87aa4c49e95 39 public:
phungductung 0:e87aa4c49e95 40 /** Set the baud rate of the serial port
phungductung 0:e87aa4c49e95 41 *
phungductung 0:e87aa4c49e95 42 * @param baudrate The baudrate of the serial port (default = 9600).
phungductung 0:e87aa4c49e95 43 */
phungductung 0:e87aa4c49e95 44 void baud(int baudrate);
phungductung 0:e87aa4c49e95 45
phungductung 0:e87aa4c49e95 46 enum Parity {
phungductung 0:e87aa4c49e95 47 None = 0,
phungductung 0:e87aa4c49e95 48 Odd,
phungductung 0:e87aa4c49e95 49 Even,
phungductung 0:e87aa4c49e95 50 Forced1,
phungductung 0:e87aa4c49e95 51 Forced0
phungductung 0:e87aa4c49e95 52 };
phungductung 0:e87aa4c49e95 53
phungductung 0:e87aa4c49e95 54 enum IrqType {
phungductung 0:e87aa4c49e95 55 RxIrq = 0,
phungductung 0:e87aa4c49e95 56 TxIrq
phungductung 0:e87aa4c49e95 57 };
phungductung 0:e87aa4c49e95 58
phungductung 0:e87aa4c49e95 59 enum Flow {
phungductung 0:e87aa4c49e95 60 Disabled = 0,
phungductung 0:e87aa4c49e95 61 RTS,
phungductung 0:e87aa4c49e95 62 CTS,
phungductung 0:e87aa4c49e95 63 RTSCTS
phungductung 0:e87aa4c49e95 64 };
phungductung 0:e87aa4c49e95 65
phungductung 0:e87aa4c49e95 66 /** Set the transmission format used by the serial port
phungductung 0:e87aa4c49e95 67 *
phungductung 0:e87aa4c49e95 68 * @param bits The number of bits in a word (5-8; default = 8)
phungductung 0:e87aa4c49e95 69 * @param parity The parity used (SerialBase::None, SerialBase::Odd, SerialBase::Even, SerialBase::Forced1, SerialBase::Forced0; default = SerialBase::None)
phungductung 0:e87aa4c49e95 70 * @param stop The number of stop bits (1 or 2; default = 1)
phungductung 0:e87aa4c49e95 71 */
phungductung 0:e87aa4c49e95 72 void format(int bits=8, Parity parity=SerialBase::None, int stop_bits=1);
phungductung 0:e87aa4c49e95 73
phungductung 0:e87aa4c49e95 74 /** Determine if there is a character available to read
phungductung 0:e87aa4c49e95 75 *
phungductung 0:e87aa4c49e95 76 * @returns
phungductung 0:e87aa4c49e95 77 * 1 if there is a character available to read,
phungductung 0:e87aa4c49e95 78 * 0 otherwise
phungductung 0:e87aa4c49e95 79 */
phungductung 0:e87aa4c49e95 80 int readable();
phungductung 0:e87aa4c49e95 81
phungductung 0:e87aa4c49e95 82 /** Determine if there is space available to write a character
phungductung 0:e87aa4c49e95 83 *
phungductung 0:e87aa4c49e95 84 * @returns
phungductung 0:e87aa4c49e95 85 * 1 if there is space to write a character,
phungductung 0:e87aa4c49e95 86 * 0 otherwise
phungductung 0:e87aa4c49e95 87 */
phungductung 0:e87aa4c49e95 88 int writeable();
phungductung 0:e87aa4c49e95 89
phungductung 0:e87aa4c49e95 90 /** Attach a function to call whenever a serial interrupt is generated
phungductung 0:e87aa4c49e95 91 *
phungductung 0:e87aa4c49e95 92 * @param fptr A pointer to a void function, or 0 to set as none
phungductung 0:e87aa4c49e95 93 * @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
phungductung 0:e87aa4c49e95 94 */
phungductung 0:e87aa4c49e95 95 void attach(void (*fptr)(void), IrqType type=RxIrq);
phungductung 0:e87aa4c49e95 96
phungductung 0:e87aa4c49e95 97 /** Attach a member function to call whenever a serial interrupt is generated
phungductung 0:e87aa4c49e95 98 *
phungductung 0:e87aa4c49e95 99 * @param tptr pointer to the object to call the member function on
phungductung 0:e87aa4c49e95 100 * @param mptr pointer to the member function to be called
phungductung 0:e87aa4c49e95 101 * @param type Which serial interrupt to attach the member function to (Seriall::RxIrq for receive, TxIrq for transmit buffer empty)
phungductung 0:e87aa4c49e95 102 */
phungductung 0:e87aa4c49e95 103 template<typename T>
phungductung 0:e87aa4c49e95 104 void attach(T* tptr, void (T::*mptr)(void), IrqType type=RxIrq) {
phungductung 0:e87aa4c49e95 105 if((mptr != NULL) && (tptr != NULL)) {
phungductung 0:e87aa4c49e95 106 _irq[type].attach(tptr, mptr);
phungductung 0:e87aa4c49e95 107 serial_irq_set(&_serial, (SerialIrq)type, 1);
phungductung 0:e87aa4c49e95 108 } else {
phungductung 0:e87aa4c49e95 109 serial_irq_set(&_serial, (SerialIrq)type, 0);
phungductung 0:e87aa4c49e95 110 }
phungductung 0:e87aa4c49e95 111 }
phungductung 0:e87aa4c49e95 112
phungductung 0:e87aa4c49e95 113 /** Generate a break condition on the serial line
phungductung 0:e87aa4c49e95 114 */
phungductung 0:e87aa4c49e95 115 void send_break();
phungductung 0:e87aa4c49e95 116
phungductung 0:e87aa4c49e95 117 #if DEVICE_SERIAL_FC
phungductung 0:e87aa4c49e95 118 /** Set the flow control type on the serial port
phungductung 0:e87aa4c49e95 119 *
phungductung 0:e87aa4c49e95 120 * @param type the flow control type (Disabled, RTS, CTS, RTSCTS)
phungductung 0:e87aa4c49e95 121 * @param flow1 the first flow control pin (RTS for RTS or RTSCTS, CTS for CTS)
phungductung 0:e87aa4c49e95 122 * @param flow2 the second flow control pin (CTS for RTSCTS)
phungductung 0:e87aa4c49e95 123 */
phungductung 0:e87aa4c49e95 124 void set_flow_control(Flow type, PinName flow1=NC, PinName flow2=NC);
phungductung 0:e87aa4c49e95 125 #endif
phungductung 0:e87aa4c49e95 126
phungductung 0:e87aa4c49e95 127 static void _irq_handler(uint32_t id, SerialIrq irq_type);
phungductung 0:e87aa4c49e95 128
phungductung 0:e87aa4c49e95 129 #if DEVICE_SERIAL_ASYNCH
phungductung 0:e87aa4c49e95 130
phungductung 0:e87aa4c49e95 131 /** Begin asynchronous write using 8bit buffer. The completition invokes registered TX event callback
phungductung 0:e87aa4c49e95 132 *
phungductung 0:e87aa4c49e95 133 * @param buffer The buffer where received data will be stored
phungductung 0:e87aa4c49e95 134 * @param length The buffer length in bytes
phungductung 0:e87aa4c49e95 135 * @param callback The event callback function
phungductung 0:e87aa4c49e95 136 * @param event The logical OR of TX events
phungductung 0:e87aa4c49e95 137 */
phungductung 0:e87aa4c49e95 138 int write(const uint8_t *buffer, int length, const event_callback_t& callback, int event = SERIAL_EVENT_TX_COMPLETE);
phungductung 0:e87aa4c49e95 139
phungductung 0:e87aa4c49e95 140 /** Begin asynchronous write using 16bit buffer. The completition invokes registered TX event callback
phungductung 0:e87aa4c49e95 141 *
phungductung 0:e87aa4c49e95 142 * @param buffer The buffer where received data will be stored
phungductung 0:e87aa4c49e95 143 * @param length The buffer length in bytes
phungductung 0:e87aa4c49e95 144 * @param callback The event callback function
phungductung 0:e87aa4c49e95 145 * @param event The logical OR of TX events
phungductung 0:e87aa4c49e95 146 */
phungductung 0:e87aa4c49e95 147 int write(const uint16_t *buffer, int length, const event_callback_t& callback, int event = SERIAL_EVENT_TX_COMPLETE);
phungductung 0:e87aa4c49e95 148
phungductung 0:e87aa4c49e95 149 /** Abort the on-going write transfer
phungductung 0:e87aa4c49e95 150 */
phungductung 0:e87aa4c49e95 151 void abort_write();
phungductung 0:e87aa4c49e95 152
phungductung 0:e87aa4c49e95 153 /** Begin asynchronous reading using 8bit buffer. The completition invokes registred RX event callback.
phungductung 0:e87aa4c49e95 154 *
phungductung 0:e87aa4c49e95 155 * @param buffer The buffer where received data will be stored
phungductung 0:e87aa4c49e95 156 * @param length The buffer length in bytes
phungductung 0:e87aa4c49e95 157 * @param callback The event callback function
phungductung 0:e87aa4c49e95 158 * @param event The logical OR of RX events
phungductung 0:e87aa4c49e95 159 * @param char_match The matching character
phungductung 0:e87aa4c49e95 160 */
phungductung 0:e87aa4c49e95 161 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);
phungductung 0:e87aa4c49e95 162
phungductung 0:e87aa4c49e95 163 /** Begin asynchronous reading using 16bit buffer. The completition invokes registred RX event callback.
phungductung 0:e87aa4c49e95 164 *
phungductung 0:e87aa4c49e95 165 * @param buffer The buffer where received data will be stored
phungductung 0:e87aa4c49e95 166 * @param length The buffer length in bytes
phungductung 0:e87aa4c49e95 167 * @param callback The event callback function
phungductung 0:e87aa4c49e95 168 * @param event The logical OR of RX events
phungductung 0:e87aa4c49e95 169 * @param char_match The matching character
phungductung 0:e87aa4c49e95 170 */
phungductung 0:e87aa4c49e95 171 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);
phungductung 0:e87aa4c49e95 172
phungductung 0:e87aa4c49e95 173 /** Abort the on-going read transfer
phungductung 0:e87aa4c49e95 174 */
phungductung 0:e87aa4c49e95 175 void abort_read();
phungductung 0:e87aa4c49e95 176
phungductung 0:e87aa4c49e95 177 /** Configure DMA usage suggestion for non-blocking TX transfers
phungductung 0:e87aa4c49e95 178 *
phungductung 0:e87aa4c49e95 179 * @param usage The usage DMA hint for peripheral
phungductung 0:e87aa4c49e95 180 * @return Zero if the usage was set, -1 if a transaction is on-going
phungductung 0:e87aa4c49e95 181 */
phungductung 0:e87aa4c49e95 182 int set_dma_usage_tx(DMAUsage usage);
phungductung 0:e87aa4c49e95 183
phungductung 0:e87aa4c49e95 184 /** Configure DMA usage suggestion for non-blocking RX transfers
phungductung 0:e87aa4c49e95 185 *
phungductung 0:e87aa4c49e95 186 * @param usage The usage DMA hint for peripheral
phungductung 0:e87aa4c49e95 187 * @return Zero if the usage was set, -1 if a transaction is on-going
phungductung 0:e87aa4c49e95 188 */
phungductung 0:e87aa4c49e95 189 int set_dma_usage_rx(DMAUsage usage);
phungductung 0:e87aa4c49e95 190
phungductung 0:e87aa4c49e95 191 protected:
phungductung 0:e87aa4c49e95 192 void start_read(void *buffer, int buffer_size, char buffer_width, const event_callback_t& callback, int event, unsigned char char_match);
phungductung 0:e87aa4c49e95 193 void start_write(const void *buffer, int buffer_size, char buffer_width, const event_callback_t& callback, int event);
phungductung 0:e87aa4c49e95 194 void interrupt_handler_asynch(void);
phungductung 0:e87aa4c49e95 195 #endif
phungductung 0:e87aa4c49e95 196
phungductung 0:e87aa4c49e95 197 protected:
phungductung 0:e87aa4c49e95 198 SerialBase(PinName tx, PinName rx);
phungductung 0:e87aa4c49e95 199 virtual ~SerialBase() {
phungductung 0:e87aa4c49e95 200 }
phungductung 0:e87aa4c49e95 201
phungductung 0:e87aa4c49e95 202 int _base_getc();
phungductung 0:e87aa4c49e95 203 int _base_putc(int c);
phungductung 0:e87aa4c49e95 204
phungductung 0:e87aa4c49e95 205 #if DEVICE_SERIAL_ASYNCH
phungductung 0:e87aa4c49e95 206 CThunk<SerialBase> _thunk_irq;
phungductung 0:e87aa4c49e95 207 event_callback_t _tx_callback;
phungductung 0:e87aa4c49e95 208 event_callback_t _rx_callback;
phungductung 0:e87aa4c49e95 209 DMAUsage _tx_usage;
phungductung 0:e87aa4c49e95 210 DMAUsage _rx_usage;
phungductung 0:e87aa4c49e95 211 #endif
phungductung 0:e87aa4c49e95 212
phungductung 0:e87aa4c49e95 213 serial_t _serial;
phungductung 0:e87aa4c49e95 214 FunctionPointer _irq[2];
phungductung 0:e87aa4c49e95 215 int _baud;
phungductung 0:e87aa4c49e95 216
phungductung 0:e87aa4c49e95 217 };
phungductung 0:e87aa4c49e95 218
phungductung 0:e87aa4c49e95 219 } // namespace mbed
phungductung 0:e87aa4c49e95 220
phungductung 0:e87aa4c49e95 221 #endif
phungductung 0:e87aa4c49e95 222
phungductung 0:e87aa4c49e95 223 #endif