Kev Mann / mbed-dev-OS5_10_4

RTC auf true

hal/serial_api.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

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