Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

snake-test/mbed/hal/serial_api.h@0:e4c5e6ec922e, 2020-05-25 (annotated)

Committer:
mohamedmoawya
Date:
Mon May 25 19:06:11 2020 +0000
Revision:
0:e4c5e6ec922e
snake game tteest

Who changed what in which revision?

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