PES4 / Mbed OS Queue_02

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-os/hal/serial_api.h@0:6bf0743ece18, 2020-03-28 (annotated)

Committer:
demayer
Date:
Sat Mar 28 15:28:19 2020 +0000
Revision:
0:6bf0743ece18
IMU Thread with an event-queue running parallel to handle tasks like a 5 times blinking LED. Button with interrupt detected.

Who changed what in which revision?

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