PHung Tung / SRC_STM32F7

SPKT

Dependents:   WAV

hal/serial_api.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_SERIAL_API_H
phungductung 0:e87aa4c49e95 17 #define MBED_SERIAL_API_H
phungductung 0:e87aa4c49e95 18
phungductung 0:e87aa4c49e95 19 #include "device.h"
phungductung 0:e87aa4c49e95 20 #include "buffer.h"
phungductung 0:e87aa4c49e95 21 #include "dma_api.h"
phungductung 0:e87aa4c49e95 22
phungductung 0:e87aa4c49e95 23 #if DEVICE_SERIAL
phungductung 0:e87aa4c49e95 24
phungductung 0:e87aa4c49e95 25 #define SERIAL_EVENT_TX_SHIFT (2)
phungductung 0:e87aa4c49e95 26 #define SERIAL_EVENT_RX_SHIFT (8)
phungductung 0:e87aa4c49e95 27
phungductung 0:e87aa4c49e95 28 #define SERIAL_EVENT_TX_MASK (0x00FC)
phungductung 0:e87aa4c49e95 29 #define SERIAL_EVENT_RX_MASK (0x3F00)
phungductung 0:e87aa4c49e95 30
phungductung 0:e87aa4c49e95 31 #define SERIAL_EVENT_ERROR (1 << 1)
phungductung 0:e87aa4c49e95 32
phungductung 0:e87aa4c49e95 33 /**
phungductung 0:e87aa4c49e95 34 * @defgroup SerialTXEvents Serial TX Events Macros
phungductung 0:e87aa4c49e95 35 *
phungductung 0:e87aa4c49e95 36 * @{
phungductung 0:e87aa4c49e95 37 */
phungductung 0:e87aa4c49e95 38 #define SERIAL_EVENT_TX_COMPLETE (1 << (SERIAL_EVENT_TX_SHIFT + 0))
phungductung 0:e87aa4c49e95 39 #define SERIAL_EVENT_TX_ALL (SERIAL_EVENT_TX_COMPLETE)
phungductung 0:e87aa4c49e95 40 /**@}*/
phungductung 0:e87aa4c49e95 41
phungductung 0:e87aa4c49e95 42 /**
phungductung 0:e87aa4c49e95 43 * @defgroup SerialRXEvents Serial RX Events Macros
phungductung 0:e87aa4c49e95 44 *
phungductung 0:e87aa4c49e95 45 * @{
phungductung 0:e87aa4c49e95 46 */
phungductung 0:e87aa4c49e95 47 #define SERIAL_EVENT_RX_COMPLETE (1 << (SERIAL_EVENT_RX_SHIFT + 0))
phungductung 0:e87aa4c49e95 48 #define SERIAL_EVENT_RX_OVERRUN_ERROR (1 << (SERIAL_EVENT_RX_SHIFT + 1))
phungductung 0:e87aa4c49e95 49 #define SERIAL_EVENT_RX_FRAMING_ERROR (1 << (SERIAL_EVENT_RX_SHIFT + 2))
phungductung 0:e87aa4c49e95 50 #define SERIAL_EVENT_RX_PARITY_ERROR (1 << (SERIAL_EVENT_RX_SHIFT + 3))
phungductung 0:e87aa4c49e95 51 #define SERIAL_EVENT_RX_OVERFLOW (1 << (SERIAL_EVENT_RX_SHIFT + 4))
phungductung 0:e87aa4c49e95 52 #define SERIAL_EVENT_RX_CHARACTER_MATCH (1 << (SERIAL_EVENT_RX_SHIFT + 5))
phungductung 0:e87aa4c49e95 53 #define SERIAL_EVENT_RX_ALL (SERIAL_EVENT_RX_OVERFLOW | SERIAL_EVENT_RX_PARITY_ERROR | \
phungductung 0:e87aa4c49e95 54 SERIAL_EVENT_RX_FRAMING_ERROR | SERIAL_EVENT_RX_OVERRUN_ERROR | \
phungductung 0:e87aa4c49e95 55 SERIAL_EVENT_RX_COMPLETE | SERIAL_EVENT_RX_CHARACTER_MATCH)
phungductung 0:e87aa4c49e95 56 /**@}*/
phungductung 0:e87aa4c49e95 57
phungductung 0:e87aa4c49e95 58 #define SERIAL_RESERVED_CHAR_MATCH (255)
phungductung 0:e87aa4c49e95 59
phungductung 0:e87aa4c49e95 60 typedef enum {
phungductung 0:e87aa4c49e95 61 ParityNone = 0,
phungductung 0:e87aa4c49e95 62 ParityOdd = 1,
phungductung 0:e87aa4c49e95 63 ParityEven = 2,
phungductung 0:e87aa4c49e95 64 ParityForced1 = 3,
phungductung 0:e87aa4c49e95 65 ParityForced0 = 4
phungductung 0:e87aa4c49e95 66 } SerialParity;
phungductung 0:e87aa4c49e95 67
phungductung 0:e87aa4c49e95 68 typedef enum {
phungductung 0:e87aa4c49e95 69 RxIrq,
phungductung 0:e87aa4c49e95 70 TxIrq
phungductung 0:e87aa4c49e95 71 } SerialIrq;
phungductung 0:e87aa4c49e95 72
phungductung 0:e87aa4c49e95 73 typedef enum {
phungductung 0:e87aa4c49e95 74 FlowControlNone,
phungductung 0:e87aa4c49e95 75 FlowControlRTS,
phungductung 0:e87aa4c49e95 76 FlowControlCTS,
phungductung 0:e87aa4c49e95 77 FlowControlRTSCTS
phungductung 0:e87aa4c49e95 78 } FlowControl;
phungductung 0:e87aa4c49e95 79
phungductung 0:e87aa4c49e95 80 typedef void (*uart_irq_handler)(uint32_t id, SerialIrq event);
phungductung 0:e87aa4c49e95 81
phungductung 0:e87aa4c49e95 82 #if DEVICE_SERIAL_ASYNCH
phungductung 0:e87aa4c49e95 83 /** Asynch serial hal structure
phungductung 0:e87aa4c49e95 84 */
phungductung 0:e87aa4c49e95 85 typedef struct {
phungductung 0:e87aa4c49e95 86 struct serial_s serial; /**< Target specific serial structure */
phungductung 0:e87aa4c49e95 87 struct buffer_s tx_buff; /**< Tx buffer */
phungductung 0:e87aa4c49e95 88 struct buffer_s rx_buff; /**< Rx buffer */
phungductung 0:e87aa4c49e95 89 uint8_t char_match; /**< Character to be matched */
phungductung 0:e87aa4c49e95 90 uint8_t char_found; /**< State of the matched character */
phungductung 0:e87aa4c49e95 91 } serial_t;
phungductung 0:e87aa4c49e95 92
phungductung 0:e87aa4c49e95 93 #else
phungductung 0:e87aa4c49e95 94 /** Non-asynch serial hal structure
phungductung 0:e87aa4c49e95 95 */
phungductung 0:e87aa4c49e95 96 typedef struct serial_s serial_t;
phungductung 0:e87aa4c49e95 97
phungductung 0:e87aa4c49e95 98 #endif
phungductung 0:e87aa4c49e95 99
phungductung 0:e87aa4c49e95 100 #ifdef __cplusplus
phungductung 0:e87aa4c49e95 101 extern "C" {
phungductung 0:e87aa4c49e95 102 #endif
phungductung 0:e87aa4c49e95 103
phungductung 0:e87aa4c49e95 104 /**
phungductung 0:e87aa4c49e95 105 * \defgroup GeneralSerial Serial Configuration Functions
phungductung 0:e87aa4c49e95 106 * @{
phungductung 0:e87aa4c49e95 107 */
phungductung 0:e87aa4c49e95 108
phungductung 0:e87aa4c49e95 109 /** Initialize the serial peripheral. It sets the default parameters for serial
phungductung 0:e87aa4c49e95 110 * peripheral, and configure its specifieds pins.
phungductung 0:e87aa4c49e95 111 *
phungductung 0:e87aa4c49e95 112 * @param obj The serial object
phungductung 0:e87aa4c49e95 113 * @param tx The TX pin
phungductung 0:e87aa4c49e95 114 * @param rx The RX pin
phungductung 0:e87aa4c49e95 115 */
phungductung 0:e87aa4c49e95 116 void serial_init(serial_t *obj, PinName tx, PinName rx);
phungductung 0:e87aa4c49e95 117
phungductung 0:e87aa4c49e95 118 /** Release the serial peripheral, not currently invoked. It requires further
phungductung 0:e87aa4c49e95 119 * resource management.
phungductung 0:e87aa4c49e95 120 *
phungductung 0:e87aa4c49e95 121 * @param obj The serial object
phungductung 0:e87aa4c49e95 122 */
phungductung 0:e87aa4c49e95 123 void serial_free(serial_t *obj);
phungductung 0:e87aa4c49e95 124
phungductung 0:e87aa4c49e95 125 /** Configure the baud rate
phungductung 0:e87aa4c49e95 126 *
phungductung 0:e87aa4c49e95 127 * @param obj The serial object
phungductung 0:e87aa4c49e95 128 * @param baudrate The baud rate to be configured
phungductung 0:e87aa4c49e95 129 */
phungductung 0:e87aa4c49e95 130 void serial_baud(serial_t *obj, int baudrate);
phungductung 0:e87aa4c49e95 131
phungductung 0:e87aa4c49e95 132 /** Configure the format. Set the number of bits, parity and the number of stop bits
phungductung 0:e87aa4c49e95 133 *
phungductung 0:e87aa4c49e95 134 * @param obj The serial object
phungductung 0:e87aa4c49e95 135 * @param data_bits The number of data bits
phungductung 0:e87aa4c49e95 136 * @param parity The parity
phungductung 0:e87aa4c49e95 137 * @param stop_bits The number of stop bits
phungductung 0:e87aa4c49e95 138 */
phungductung 0:e87aa4c49e95 139 void serial_format(serial_t *obj, int data_bits, SerialParity parity, int stop_bits);
phungductung 0:e87aa4c49e95 140
phungductung 0:e87aa4c49e95 141 /** The serial interrupt handler registration.
phungductung 0:e87aa4c49e95 142 *
phungductung 0:e87aa4c49e95 143 * @param obj The serial object
phungductung 0:e87aa4c49e95 144 * @param handler The interrupt handler which will be invoked when interrupt fires.
phungductung 0:e87aa4c49e95 145 * @param id The SerialBase object
phungductung 0:e87aa4c49e95 146 */
phungductung 0:e87aa4c49e95 147 void serial_irq_handler(serial_t *obj, uart_irq_handler handler, uint32_t id);
phungductung 0:e87aa4c49e95 148
phungductung 0:e87aa4c49e95 149 /** Configure serial interrupt. This function is used for word-approach
phungductung 0:e87aa4c49e95 150 *
phungductung 0:e87aa4c49e95 151 * @param obj The serial object
phungductung 0:e87aa4c49e95 152 * @param irq The serial IRQ type (RX or TX)
phungductung 0:e87aa4c49e95 153 * @param enable Set to non-zero to enable events, or zero to disable them
phungductung 0:e87aa4c49e95 154 */
phungductung 0:e87aa4c49e95 155 void serial_irq_set(serial_t *obj, SerialIrq irq, uint32_t enable);
phungductung 0:e87aa4c49e95 156
phungductung 0:e87aa4c49e95 157 /** Get character. This is a blocking call, waiting for a character
phungductung 0:e87aa4c49e95 158 *
phungductung 0:e87aa4c49e95 159 * @param obj The serial object
phungductung 0:e87aa4c49e95 160 */
phungductung 0:e87aa4c49e95 161 int serial_getc(serial_t *obj);
phungductung 0:e87aa4c49e95 162
phungductung 0:e87aa4c49e95 163 /** Put a character. This is a blocking call, waiting for a peripheral to be available
phungductung 0:e87aa4c49e95 164 * for writing
phungductung 0:e87aa4c49e95 165 *
phungductung 0:e87aa4c49e95 166 * @param obj The serial object
phungductung 0:e87aa4c49e95 167 * @param c The character to be sent
phungductung 0:e87aa4c49e95 168 */
phungductung 0:e87aa4c49e95 169 void serial_putc(serial_t *obj, int c);
phungductung 0:e87aa4c49e95 170
phungductung 0:e87aa4c49e95 171 /** Check if the serial peripheral is readable
phungductung 0:e87aa4c49e95 172 *
phungductung 0:e87aa4c49e95 173 * @param obj The serial object
phungductung 0:e87aa4c49e95 174 * @return Non-zero value if a character can be read, 0 if nothing to read.
phungductung 0:e87aa4c49e95 175 */
phungductung 0:e87aa4c49e95 176 int serial_readable(serial_t *obj);
phungductung 0:e87aa4c49e95 177
phungductung 0:e87aa4c49e95 178 /** Check if the serial peripheral is writable
phungductung 0:e87aa4c49e95 179 *
phungductung 0:e87aa4c49e95 180 * @param obj The serial object
phungductung 0:e87aa4c49e95 181 * @return Non-zero value if a character can be written, 0 otherwise.
phungductung 0:e87aa4c49e95 182 */
phungductung 0:e87aa4c49e95 183 int serial_writable(serial_t *obj);
phungductung 0:e87aa4c49e95 184
phungductung 0:e87aa4c49e95 185 /** Clear the serial peripheral
phungductung 0:e87aa4c49e95 186 *
phungductung 0:e87aa4c49e95 187 * @param obj The serial object
phungductung 0:e87aa4c49e95 188 */
phungductung 0:e87aa4c49e95 189 void serial_clear(serial_t *obj);
phungductung 0:e87aa4c49e95 190
phungductung 0:e87aa4c49e95 191 /** Set the break
phungductung 0:e87aa4c49e95 192 *
phungductung 0:e87aa4c49e95 193 * @param obj The serial object
phungductung 0:e87aa4c49e95 194 */
phungductung 0:e87aa4c49e95 195 void serial_break_set(serial_t *obj);
phungductung 0:e87aa4c49e95 196
phungductung 0:e87aa4c49e95 197 /** Clear the break
phungductung 0:e87aa4c49e95 198 *
phungductung 0:e87aa4c49e95 199 * @param obj The serial object
phungductung 0:e87aa4c49e95 200 */
phungductung 0:e87aa4c49e95 201 void serial_break_clear(serial_t *obj);
phungductung 0:e87aa4c49e95 202
phungductung 0:e87aa4c49e95 203 /** Configure the TX pin for UART function.
phungductung 0:e87aa4c49e95 204 *
phungductung 0:e87aa4c49e95 205 * @param tx The pin used for TX
phungductung 0:e87aa4c49e95 206 */
phungductung 0:e87aa4c49e95 207 void serial_pinout_tx(PinName tx);
phungductung 0:e87aa4c49e95 208
phungductung 0:e87aa4c49e95 209 /** Configure the serial for the flow control. It sets flow control in the hardware
phungductung 0:e87aa4c49e95 210 * if a serial peripheral supports it, otherwise software emulation is used.
phungductung 0:e87aa4c49e95 211 *
phungductung 0:e87aa4c49e95 212 * @param obj The serial object
phungductung 0:e87aa4c49e95 213 * @param type The type of the flow control. Look at the available FlowControl types.
phungductung 0:e87aa4c49e95 214 * @param rxflow The tx pin
phungductung 0:e87aa4c49e95 215 * @param txflow The rx pin
phungductung 0:e87aa4c49e95 216 */
phungductung 0:e87aa4c49e95 217 void serial_set_flow_control(serial_t *obj, FlowControl type, PinName rxflow, PinName txflow);
phungductung 0:e87aa4c49e95 218
phungductung 0:e87aa4c49e95 219 #if DEVICE_SERIAL_ASYNCH
phungductung 0:e87aa4c49e95 220
phungductung 0:e87aa4c49e95 221 /**@}*/
phungductung 0:e87aa4c49e95 222
phungductung 0:e87aa4c49e95 223 /**
phungductung 0:e87aa4c49e95 224 * \defgroup AsynchSerial Asynchronous Serial Hardware Abstraction Layer
phungductung 0:e87aa4c49e95 225 * @{
phungductung 0:e87aa4c49e95 226 */
phungductung 0:e87aa4c49e95 227
phungductung 0:e87aa4c49e95 228 /** Begin asynchronous TX transfer. The used buffer is specified in the serial object,
phungductung 0:e87aa4c49e95 229 * tx_buff
phungductung 0:e87aa4c49e95 230 *
phungductung 0:e87aa4c49e95 231 * @param obj The serial object
phungductung 0:e87aa4c49e95 232 * @param tx The buffer for sending
phungductung 0:e87aa4c49e95 233 * @param tx_length The number of words to transmit
phungductung 0:e87aa4c49e95 234 * @param tx_width The bit width of buffer word
phungductung 0:e87aa4c49e95 235 * @param handler The serial handler
phungductung 0:e87aa4c49e95 236 * @param event The logical OR of events to be registered
phungductung 0:e87aa4c49e95 237 * @param hint A suggestion for how to use DMA with this transfer
phungductung 0:e87aa4c49e95 238 * @return Returns number of data transfered, or 0 otherwise
phungductung 0:e87aa4c49e95 239 */
phungductung 0:e87aa4c49e95 240 int serial_tx_asynch(serial_t *obj, const void *tx, size_t tx_length, uint8_t tx_width, uint32_t handler, uint32_t event, DMAUsage hint);
phungductung 0:e87aa4c49e95 241
phungductung 0:e87aa4c49e95 242 /** Begin asynchronous RX transfer (enable interrupt for data collecting)
phungductung 0:e87aa4c49e95 243 * The used buffer is specified in the serial object - rx_buff
phungductung 0:e87aa4c49e95 244 *
phungductung 0:e87aa4c49e95 245 * @param obj The serial object
phungductung 0:e87aa4c49e95 246 * @param rx The buffer for sending
phungductung 0:e87aa4c49e95 247 * @param rx_length The number of words to transmit
phungductung 0:e87aa4c49e95 248 * @param rx_width The bit width of buffer word
phungductung 0:e87aa4c49e95 249 * @param handler The serial handler
phungductung 0:e87aa4c49e95 250 * @param event The logical OR of events to be registered
phungductung 0:e87aa4c49e95 251 * @param handler The serial handler
phungductung 0:e87aa4c49e95 252 * @param char_match A character in range 0-254 to be matched
phungductung 0:e87aa4c49e95 253 * @param hint A suggestion for how to use DMA with this transfer
phungductung 0:e87aa4c49e95 254 */
phungductung 0:e87aa4c49e95 255 void serial_rx_asynch(serial_t *obj, void *rx, size_t rx_length, uint8_t rx_width, uint32_t handler, uint32_t event, uint8_t char_match, DMAUsage hint);
phungductung 0:e87aa4c49e95 256
phungductung 0:e87aa4c49e95 257 /** Attempts to determine if the serial peripheral is already in use for TX
phungductung 0:e87aa4c49e95 258 *
phungductung 0:e87aa4c49e95 259 * @param obj The serial object
phungductung 0:e87aa4c49e95 260 * @return Non-zero if the RX transaction is ongoing, 0 otherwise
phungductung 0:e87aa4c49e95 261 */
phungductung 0:e87aa4c49e95 262 uint8_t serial_tx_active(serial_t *obj);
phungductung 0:e87aa4c49e95 263
phungductung 0:e87aa4c49e95 264 /** Attempts to determine if the serial peripheral is already in use for RX
phungductung 0:e87aa4c49e95 265 *
phungductung 0:e87aa4c49e95 266 * @param obj The serial object
phungductung 0:e87aa4c49e95 267 * @return Non-zero if the RX transaction is ongoing, 0 otherwise
phungductung 0:e87aa4c49e95 268 */
phungductung 0:e87aa4c49e95 269 uint8_t serial_rx_active(serial_t *obj);
phungductung 0:e87aa4c49e95 270
phungductung 0:e87aa4c49e95 271 /** The asynchronous TX and RX handler.
phungductung 0:e87aa4c49e95 272 *
phungductung 0:e87aa4c49e95 273 * @param obj The serial object
phungductung 0:e87aa4c49e95 274 * @return Returns event flags if a RX transfer termination condition was met or 0 otherwise
phungductung 0:e87aa4c49e95 275 */
phungductung 0:e87aa4c49e95 276 int serial_irq_handler_asynch(serial_t *obj);
phungductung 0:e87aa4c49e95 277
phungductung 0:e87aa4c49e95 278 /** Abort the ongoing TX transaction. It disables the enabled interupt for TX and
phungductung 0:e87aa4c49e95 279 * flush TX hardware buffer if TX FIFO is used
phungductung 0:e87aa4c49e95 280 *
phungductung 0:e87aa4c49e95 281 * @param obj The serial object
phungductung 0:e87aa4c49e95 282 */
phungductung 0:e87aa4c49e95 283 void serial_tx_abort_asynch(serial_t *obj);
phungductung 0:e87aa4c49e95 284
phungductung 0:e87aa4c49e95 285 /** Abort the ongoing RX transaction It disables the enabled interrupt for RX and
phungductung 0:e87aa4c49e95 286 * flush RX hardware buffer if RX FIFO is used
phungductung 0:e87aa4c49e95 287 *
phungductung 0:e87aa4c49e95 288 * @param obj The serial object
phungductung 0:e87aa4c49e95 289 */
phungductung 0:e87aa4c49e95 290 void serial_rx_abort_asynch(serial_t *obj);
phungductung 0:e87aa4c49e95 291
phungductung 0:e87aa4c49e95 292 /**@}*/
phungductung 0:e87aa4c49e95 293
phungductung 0:e87aa4c49e95 294 #endif
phungductung 0:e87aa4c49e95 295
phungductung 0:e87aa4c49e95 296 #ifdef __cplusplus
phungductung 0:e87aa4c49e95 297 }
phungductung 0:e87aa4c49e95 298 #endif
phungductung 0:e87aa4c49e95 299
phungductung 0:e87aa4c49e95 300 #endif
phungductung 0:e87aa4c49e95 301
phungductung 0:e87aa4c49e95 302 #endif