Vladimir Vana / mbed

pro vyuku PSS v Jecne

serial_api.h@0:23d1f73bf130, 2017-09-24 (annotated)

Committer:
vladvana
Date:
Sun Sep 24 12:31:52 2017 +0000
Revision:
0:23d1f73bf130
podklady pro cviceni z PSS

Who changed what in which revision?

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