PHung Tung / WAV2

SPKT

Dependencies:   F746_GUI SD_PlayerSkeleton F746_SAI_IO

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

Committer:
phungductung
Date:
Tue Jun 04 09:08:29 2019 +0000
Revision:
0:aa3fc5ad02f7
SPKT

Who changed what in which revision?

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