Andrew SaLoutos / mbed-dev-STM-lean

From Ben Katz mbed-dev library. Removed unnecessary target files to reduce the overall size by a factor of 10 to make it easier to import into the online IDE.

Dependents:   motor_driver motor_driver_screaming_fix

hal/serial_api.h@0:083111ae2a11, 2020-11-26 (annotated)

Committer:
saloutos
Date:
Thu Nov 26 04:08:56 2020 +0000
Revision:
0:083111ae2a11
first commit of leaned mbed dev lib

Who changed what in which revision?

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