Руслан Бредун / Mbed 2 deprecated stm32-sensor-base2

test

Dependencies:   mbed Watchdog

Dependents:   STM32-MC_node

mbed/hal/serial_api.h@0:d383e2dee0f7, 2020-07-06 (annotated)

Committer:
ommpy
Date:
Mon Jul 06 17:18:59 2020 +0530
Revision:
0:d383e2dee0f7
first commit

Who changed what in which revision?

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