Denislam Valeev / Mbed OS Nucleo_rtos_basic

1

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