mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_KL27Z/TOOLCHAIN_ARM_STD/fsl_flexio_uart.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 171:3a7713b1edbc 1 /*
AnnaBridge 171:3a7713b1edbc 2 * Copyright (c) 2015, Freescale Semiconductor, Inc.
AnnaBridge 171:3a7713b1edbc 3 * All rights reserved.
AnnaBridge 171:3a7713b1edbc 4 *
AnnaBridge 171:3a7713b1edbc 5 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 171:3a7713b1edbc 6 * are permitted provided that the following conditions are met:
AnnaBridge 171:3a7713b1edbc 7 *
AnnaBridge 171:3a7713b1edbc 8 * o Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 171:3a7713b1edbc 9 * of conditions and the following disclaimer.
AnnaBridge 171:3a7713b1edbc 10 *
AnnaBridge 171:3a7713b1edbc 11 * o Redistributions in binary form must reproduce the above copyright notice, this
AnnaBridge 171:3a7713b1edbc 12 * list of conditions and the following disclaimer in the documentation and/or
AnnaBridge 171:3a7713b1edbc 13 * other materials provided with the distribution.
AnnaBridge 171:3a7713b1edbc 14 *
AnnaBridge 171:3a7713b1edbc 15 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
AnnaBridge 171:3a7713b1edbc 16 * contributors may be used to endorse or promote products derived from this
AnnaBridge 171:3a7713b1edbc 17 * software without specific prior written permission.
AnnaBridge 171:3a7713b1edbc 18 *
AnnaBridge 171:3a7713b1edbc 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 171:3a7713b1edbc 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 171:3a7713b1edbc 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 171:3a7713b1edbc 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 171:3a7713b1edbc 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 171:3a7713b1edbc 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 171:3a7713b1edbc 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 171:3a7713b1edbc 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 171:3a7713b1edbc 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 171:3a7713b1edbc 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 171:3a7713b1edbc 29 */
AnnaBridge 171:3a7713b1edbc 30
AnnaBridge 171:3a7713b1edbc 31 #ifndef _FSL_FLEXIO_UART_H_
AnnaBridge 171:3a7713b1edbc 32 #define _FSL_FLEXIO_UART_H_
AnnaBridge 171:3a7713b1edbc 33
AnnaBridge 171:3a7713b1edbc 34 #include "fsl_common.h"
AnnaBridge 171:3a7713b1edbc 35 #include "fsl_flexio.h"
AnnaBridge 171:3a7713b1edbc 36
AnnaBridge 171:3a7713b1edbc 37 /*!
AnnaBridge 171:3a7713b1edbc 38 * @addtogroup flexio_uart
AnnaBridge 171:3a7713b1edbc 39 * @{
AnnaBridge 171:3a7713b1edbc 40 */
AnnaBridge 171:3a7713b1edbc 41
AnnaBridge 171:3a7713b1edbc 42 /*! @file */
AnnaBridge 171:3a7713b1edbc 43
AnnaBridge 171:3a7713b1edbc 44 /*******************************************************************************
AnnaBridge 171:3a7713b1edbc 45 * Definitions
AnnaBridge 171:3a7713b1edbc 46 ******************************************************************************/
AnnaBridge 171:3a7713b1edbc 47
AnnaBridge 171:3a7713b1edbc 48 /*! @name Driver version */
AnnaBridge 171:3a7713b1edbc 49 /*@{*/
AnnaBridge 171:3a7713b1edbc 50 /*! @brief FlexIO UART driver version 2.1.0. */
AnnaBridge 171:3a7713b1edbc 51 #define FSL_FLEXIO_UART_DRIVER_VERSION (MAKE_VERSION(2, 1, 0))
AnnaBridge 171:3a7713b1edbc 52 /*@}*/
AnnaBridge 171:3a7713b1edbc 53
AnnaBridge 171:3a7713b1edbc 54 /*! @brief Error codes for the UART driver. */
AnnaBridge 171:3a7713b1edbc 55 enum _flexio_uart_status
AnnaBridge 171:3a7713b1edbc 56 {
AnnaBridge 171:3a7713b1edbc 57 kStatus_FLEXIO_UART_TxBusy = MAKE_STATUS(kStatusGroup_FLEXIO_UART, 0), /*!< Transmitter is busy. */
AnnaBridge 171:3a7713b1edbc 58 kStatus_FLEXIO_UART_RxBusy = MAKE_STATUS(kStatusGroup_FLEXIO_UART, 1), /*!< Receiver is busy. */
AnnaBridge 171:3a7713b1edbc 59 kStatus_FLEXIO_UART_TxIdle = MAKE_STATUS(kStatusGroup_FLEXIO_UART, 2), /*!< UART transmitter is idle. */
AnnaBridge 171:3a7713b1edbc 60 kStatus_FLEXIO_UART_RxIdle = MAKE_STATUS(kStatusGroup_FLEXIO_UART, 3), /*!< UART receiver is idle. */
AnnaBridge 171:3a7713b1edbc 61 kStatus_FLEXIO_UART_ERROR = MAKE_STATUS(kStatusGroup_FLEXIO_UART, 4), /*!< ERROR happens on UART. */
AnnaBridge 171:3a7713b1edbc 62 kStatus_FLEXIO_UART_RxRingBufferOverrun =
AnnaBridge 171:3a7713b1edbc 63 MAKE_STATUS(kStatusGroup_FLEXIO_UART, 5), /*!< UART RX software ring buffer overrun. */
AnnaBridge 171:3a7713b1edbc 64 kStatus_FLEXIO_UART_RxHardwareOverrun = MAKE_STATUS(kStatusGroup_FLEXIO_UART, 6) /*!< UART RX receiver overrun. */
AnnaBridge 171:3a7713b1edbc 65 };
AnnaBridge 171:3a7713b1edbc 66
AnnaBridge 171:3a7713b1edbc 67 /*! @brief FlexIO UART bit count per char. */
AnnaBridge 171:3a7713b1edbc 68 typedef enum _flexio_uart_bit_count_per_char
AnnaBridge 171:3a7713b1edbc 69 {
AnnaBridge 171:3a7713b1edbc 70 kFLEXIO_UART_7BitsPerChar = 7U, /*!< 7-bit data characters */
AnnaBridge 171:3a7713b1edbc 71 kFLEXIO_UART_8BitsPerChar = 8U, /*!< 8-bit data characters */
AnnaBridge 171:3a7713b1edbc 72 kFLEXIO_UART_9BitsPerChar = 9U, /*!< 9-bit data characters */
AnnaBridge 171:3a7713b1edbc 73 } flexio_uart_bit_count_per_char_t;
AnnaBridge 171:3a7713b1edbc 74
AnnaBridge 171:3a7713b1edbc 75 /*! @brief Define FlexIO UART interrupt mask. */
AnnaBridge 171:3a7713b1edbc 76 enum _flexio_uart_interrupt_enable
AnnaBridge 171:3a7713b1edbc 77 {
AnnaBridge 171:3a7713b1edbc 78 kFLEXIO_UART_TxDataRegEmptyInterruptEnable = 0x1U, /*!< Transmit buffer empty interrupt enable. */
AnnaBridge 171:3a7713b1edbc 79 kFLEXIO_UART_RxDataRegFullInterruptEnable = 0x2U, /*!< Receive buffer full interrupt enable. */
AnnaBridge 171:3a7713b1edbc 80 };
AnnaBridge 171:3a7713b1edbc 81
AnnaBridge 171:3a7713b1edbc 82 /*! @brief Define FlexIO UART status mask. */
AnnaBridge 171:3a7713b1edbc 83 enum _flexio_uart_status_flags
AnnaBridge 171:3a7713b1edbc 84 {
AnnaBridge 171:3a7713b1edbc 85 kFLEXIO_UART_TxDataRegEmptyFlag = 0x1U, /*!< Transmit buffer empty flag. */
AnnaBridge 171:3a7713b1edbc 86 kFLEXIO_UART_RxDataRegFullFlag = 0x2U, /*!< Receive buffer full flag. */
AnnaBridge 171:3a7713b1edbc 87 kFLEXIO_UART_RxOverRunFlag = 0x4U, /*!< Receive buffer over run flag. */
AnnaBridge 171:3a7713b1edbc 88 };
AnnaBridge 171:3a7713b1edbc 89
AnnaBridge 171:3a7713b1edbc 90 /*! @brief Define FlexIO UART access structure typedef. */
AnnaBridge 171:3a7713b1edbc 91 typedef struct _flexio_uart_type
AnnaBridge 171:3a7713b1edbc 92 {
AnnaBridge 171:3a7713b1edbc 93 FLEXIO_Type *flexioBase; /*!< FlexIO base pointer. */
AnnaBridge 171:3a7713b1edbc 94 uint8_t TxPinIndex; /*!< Pin select for UART_Tx. */
AnnaBridge 171:3a7713b1edbc 95 uint8_t RxPinIndex; /*!< Pin select for UART_Rx. */
AnnaBridge 171:3a7713b1edbc 96 uint8_t shifterIndex[2]; /*!< Shifter index used in FlexIO UART. */
AnnaBridge 171:3a7713b1edbc 97 uint8_t timerIndex[2]; /*!< Timer index used in FlexIO UART. */
AnnaBridge 171:3a7713b1edbc 98 } FLEXIO_UART_Type;
AnnaBridge 171:3a7713b1edbc 99
AnnaBridge 171:3a7713b1edbc 100 /*! @brief Define FlexIO UART user configuration structure. */
AnnaBridge 171:3a7713b1edbc 101 typedef struct _flexio_uart_config
AnnaBridge 171:3a7713b1edbc 102 {
AnnaBridge 171:3a7713b1edbc 103 bool enableUart; /*!< Enable/disable FlexIO UART TX & RX. */
AnnaBridge 171:3a7713b1edbc 104 bool enableInDoze; /*!< Enable/disable FlexIO operation in doze mode*/
AnnaBridge 171:3a7713b1edbc 105 bool enableInDebug; /*!< Enable/disable FlexIO operation in debug mode*/
AnnaBridge 171:3a7713b1edbc 106 bool enableFastAccess; /*!< Enable/disable fast access to FlexIO registers,
AnnaBridge 171:3a7713b1edbc 107 fast access requires the FlexIO clock to be at least
AnnaBridge 171:3a7713b1edbc 108 twice the frequency of the bus clock. */
AnnaBridge 171:3a7713b1edbc 109 uint32_t baudRate_Bps; /*!< Baud rate in Bps. */
AnnaBridge 171:3a7713b1edbc 110 flexio_uart_bit_count_per_char_t bitCountPerChar; /*!< number of bits, 7/8/9 -bit */
AnnaBridge 171:3a7713b1edbc 111 } flexio_uart_config_t;
AnnaBridge 171:3a7713b1edbc 112
AnnaBridge 171:3a7713b1edbc 113 /*! @brief Define FlexIO UART transfer structure. */
AnnaBridge 171:3a7713b1edbc 114 typedef struct _flexio_uart_transfer
AnnaBridge 171:3a7713b1edbc 115 {
AnnaBridge 171:3a7713b1edbc 116 uint8_t *data; /*!< Transfer buffer*/
AnnaBridge 171:3a7713b1edbc 117 size_t dataSize; /*!< Transfer size*/
AnnaBridge 171:3a7713b1edbc 118 } flexio_uart_transfer_t;
AnnaBridge 171:3a7713b1edbc 119
AnnaBridge 171:3a7713b1edbc 120 /* Forward declaration of the handle typedef. */
AnnaBridge 171:3a7713b1edbc 121 typedef struct _flexio_uart_handle flexio_uart_handle_t;
AnnaBridge 171:3a7713b1edbc 122
AnnaBridge 171:3a7713b1edbc 123 /*! @brief FlexIO UART transfer callback function. */
AnnaBridge 171:3a7713b1edbc 124 typedef void (*flexio_uart_transfer_callback_t)(FLEXIO_UART_Type *base,
AnnaBridge 171:3a7713b1edbc 125 flexio_uart_handle_t *handle,
AnnaBridge 171:3a7713b1edbc 126 status_t status,
AnnaBridge 171:3a7713b1edbc 127 void *userData);
AnnaBridge 171:3a7713b1edbc 128
AnnaBridge 171:3a7713b1edbc 129 /*! @brief Define FLEXIO UART handle structure*/
AnnaBridge 171:3a7713b1edbc 130 struct _flexio_uart_handle
AnnaBridge 171:3a7713b1edbc 131 {
AnnaBridge 171:3a7713b1edbc 132 uint8_t *volatile txData; /*!< Address of remaining data to send. */
AnnaBridge 171:3a7713b1edbc 133 volatile size_t txDataSize; /*!< Size of the remaining data to send. */
AnnaBridge 171:3a7713b1edbc 134 uint8_t *volatile rxData; /*!< Address of remaining data to receive. */
AnnaBridge 171:3a7713b1edbc 135 volatile size_t rxDataSize; /*!< Size of the remaining data to receive. */
AnnaBridge 171:3a7713b1edbc 136 size_t txSize; /*!< Total bytes to be sent. */
AnnaBridge 171:3a7713b1edbc 137 size_t rxSize; /*!< Total bytes to be received. */
AnnaBridge 171:3a7713b1edbc 138
AnnaBridge 171:3a7713b1edbc 139 uint8_t *rxRingBuffer; /*!< Start address of the receiver ring buffer. */
AnnaBridge 171:3a7713b1edbc 140 size_t rxRingBufferSize; /*!< Size of the ring buffer. */
AnnaBridge 171:3a7713b1edbc 141 volatile uint16_t rxRingBufferHead; /*!< Index for the driver to store received data into ring buffer. */
AnnaBridge 171:3a7713b1edbc 142 volatile uint16_t rxRingBufferTail; /*!< Index for the user to get data from the ring buffer. */
AnnaBridge 171:3a7713b1edbc 143
AnnaBridge 171:3a7713b1edbc 144 flexio_uart_transfer_callback_t callback; /*!< Callback function. */
AnnaBridge 171:3a7713b1edbc 145 void *userData; /*!< UART callback function parameter.*/
AnnaBridge 171:3a7713b1edbc 146
AnnaBridge 171:3a7713b1edbc 147 volatile uint8_t txState; /*!< TX transfer state. */
AnnaBridge 171:3a7713b1edbc 148 volatile uint8_t rxState; /*!< RX transfer state */
AnnaBridge 171:3a7713b1edbc 149 };
AnnaBridge 171:3a7713b1edbc 150
AnnaBridge 171:3a7713b1edbc 151 /*******************************************************************************
AnnaBridge 171:3a7713b1edbc 152 * API
AnnaBridge 171:3a7713b1edbc 153 ******************************************************************************/
AnnaBridge 171:3a7713b1edbc 154
AnnaBridge 171:3a7713b1edbc 155 #if defined(__cplusplus)
AnnaBridge 171:3a7713b1edbc 156 extern "C" {
AnnaBridge 171:3a7713b1edbc 157 #endif /*_cplusplus*/
AnnaBridge 171:3a7713b1edbc 158
AnnaBridge 171:3a7713b1edbc 159 /*!
AnnaBridge 171:3a7713b1edbc 160 * @name Initialization and deinitialization
AnnaBridge 171:3a7713b1edbc 161 * @{
AnnaBridge 171:3a7713b1edbc 162 */
AnnaBridge 171:3a7713b1edbc 163
AnnaBridge 171:3a7713b1edbc 164 /*!
AnnaBridge 171:3a7713b1edbc 165 * @brief Ungates the FlexIO clock, resets the FlexIO module, configures FlexIO UART
AnnaBridge 171:3a7713b1edbc 166 * hardware, and configures the FlexIO UART with FlexIO UART configuration.
AnnaBridge 171:3a7713b1edbc 167 * The configuration structure can be filled by the user, or be set with
AnnaBridge 171:3a7713b1edbc 168 * default values by FLEXIO_UART_GetDefaultConfig().
AnnaBridge 171:3a7713b1edbc 169 *
AnnaBridge 171:3a7713b1edbc 170 * Example
AnnaBridge 171:3a7713b1edbc 171 @code
AnnaBridge 171:3a7713b1edbc 172 FLEXIO_UART_Type base = {
AnnaBridge 171:3a7713b1edbc 173 .flexioBase = FLEXIO,
AnnaBridge 171:3a7713b1edbc 174 .TxPinIndex = 0,
AnnaBridge 171:3a7713b1edbc 175 .RxPinIndex = 1,
AnnaBridge 171:3a7713b1edbc 176 .shifterIndex = {0,1},
AnnaBridge 171:3a7713b1edbc 177 .timerIndex = {0,1}
AnnaBridge 171:3a7713b1edbc 178 };
AnnaBridge 171:3a7713b1edbc 179 flexio_uart_config_t config = {
AnnaBridge 171:3a7713b1edbc 180 .enableInDoze = false,
AnnaBridge 171:3a7713b1edbc 181 .enableInDebug = true,
AnnaBridge 171:3a7713b1edbc 182 .enableFastAccess = false,
AnnaBridge 171:3a7713b1edbc 183 .baudRate_Bps = 115200U,
AnnaBridge 171:3a7713b1edbc 184 .bitCountPerChar = 8
AnnaBridge 171:3a7713b1edbc 185 };
AnnaBridge 171:3a7713b1edbc 186 FLEXIO_UART_Init(base, &config, srcClock_Hz);
AnnaBridge 171:3a7713b1edbc 187 @endcode
AnnaBridge 171:3a7713b1edbc 188 *
AnnaBridge 171:3a7713b1edbc 189 * @param base Pointer to the FLEXIO_UART_Type structure.
AnnaBridge 171:3a7713b1edbc 190 * @param userConfig Pointer to the flexio_uart_config_t structure.
AnnaBridge 171:3a7713b1edbc 191 * @param srcClock_Hz FlexIO source clock in Hz.
AnnaBridge 171:3a7713b1edbc 192 */
AnnaBridge 171:3a7713b1edbc 193 void FLEXIO_UART_Init(FLEXIO_UART_Type *base, const flexio_uart_config_t *userConfig, uint32_t srcClock_Hz);
AnnaBridge 171:3a7713b1edbc 194
AnnaBridge 171:3a7713b1edbc 195 /*!
AnnaBridge 171:3a7713b1edbc 196 * @brief Disables the FlexIO UART and gates the FlexIO clock.
AnnaBridge 171:3a7713b1edbc 197 *
AnnaBridge 171:3a7713b1edbc 198 * @note After calling this API, call the FLEXO_UART_Init to use the FlexIO UART module.
AnnaBridge 171:3a7713b1edbc 199 *
AnnaBridge 171:3a7713b1edbc 200 * @param base pointer to FLEXIO_UART_Type structure
AnnaBridge 171:3a7713b1edbc 201 */
AnnaBridge 171:3a7713b1edbc 202 void FLEXIO_UART_Deinit(FLEXIO_UART_Type *base);
AnnaBridge 171:3a7713b1edbc 203
AnnaBridge 171:3a7713b1edbc 204 /*!
AnnaBridge 171:3a7713b1edbc 205 * @brief Gets the default configuration to configure the FlexIO UART. The configuration
AnnaBridge 171:3a7713b1edbc 206 * can be used directly for calling the FLEXIO_UART_Init().
AnnaBridge 171:3a7713b1edbc 207 * Example:
AnnaBridge 171:3a7713b1edbc 208 @code
AnnaBridge 171:3a7713b1edbc 209 flexio_uart_config_t config;
AnnaBridge 171:3a7713b1edbc 210 FLEXIO_UART_GetDefaultConfig(&userConfig);
AnnaBridge 171:3a7713b1edbc 211 @endcode
AnnaBridge 171:3a7713b1edbc 212 * @param userConfig Pointer to the flexio_uart_config_t structure.
AnnaBridge 171:3a7713b1edbc 213 */
AnnaBridge 171:3a7713b1edbc 214 void FLEXIO_UART_GetDefaultConfig(flexio_uart_config_t *userConfig);
AnnaBridge 171:3a7713b1edbc 215
AnnaBridge 171:3a7713b1edbc 216 /* @} */
AnnaBridge 171:3a7713b1edbc 217
AnnaBridge 171:3a7713b1edbc 218 /*!
AnnaBridge 171:3a7713b1edbc 219 * @name Status
AnnaBridge 171:3a7713b1edbc 220 * @{
AnnaBridge 171:3a7713b1edbc 221 */
AnnaBridge 171:3a7713b1edbc 222
AnnaBridge 171:3a7713b1edbc 223 /*!
AnnaBridge 171:3a7713b1edbc 224 * @brief Gets the FlexIO UART status flags.
AnnaBridge 171:3a7713b1edbc 225 *
AnnaBridge 171:3a7713b1edbc 226 * @param base Pointer to the FLEXIO_UART_Type structure.
AnnaBridge 171:3a7713b1edbc 227 * @return FlexIO UART status flags.
AnnaBridge 171:3a7713b1edbc 228 */
AnnaBridge 171:3a7713b1edbc 229
AnnaBridge 171:3a7713b1edbc 230 uint32_t FLEXIO_UART_GetStatusFlags(FLEXIO_UART_Type *base);
AnnaBridge 171:3a7713b1edbc 231
AnnaBridge 171:3a7713b1edbc 232 /*!
AnnaBridge 171:3a7713b1edbc 233 * @brief Gets the FlexIO UART status flags.
AnnaBridge 171:3a7713b1edbc 234 *
AnnaBridge 171:3a7713b1edbc 235 * @param base Pointer to the FLEXIO_UART_Type structure.
AnnaBridge 171:3a7713b1edbc 236 * @param mask Status flag.
AnnaBridge 171:3a7713b1edbc 237 * The parameter can be any combination of the following values:
AnnaBridge 171:3a7713b1edbc 238 * @arg kFLEXIO_UART_TxDataRegEmptyFlag
AnnaBridge 171:3a7713b1edbc 239 * @arg kFLEXIO_UART_RxEmptyFlag
AnnaBridge 171:3a7713b1edbc 240 * @arg kFLEXIO_UART_RxOverRunFlag
AnnaBridge 171:3a7713b1edbc 241 */
AnnaBridge 171:3a7713b1edbc 242
AnnaBridge 171:3a7713b1edbc 243 void FLEXIO_UART_ClearStatusFlags(FLEXIO_UART_Type *base, uint32_t mask);
AnnaBridge 171:3a7713b1edbc 244
AnnaBridge 171:3a7713b1edbc 245 /* @} */
AnnaBridge 171:3a7713b1edbc 246
AnnaBridge 171:3a7713b1edbc 247 /*!
AnnaBridge 171:3a7713b1edbc 248 * @name Interrupts
AnnaBridge 171:3a7713b1edbc 249 * @{
AnnaBridge 171:3a7713b1edbc 250 */
AnnaBridge 171:3a7713b1edbc 251
AnnaBridge 171:3a7713b1edbc 252 /*!
AnnaBridge 171:3a7713b1edbc 253 * @brief Enables the FlexIO UART interrupt.
AnnaBridge 171:3a7713b1edbc 254 *
AnnaBridge 171:3a7713b1edbc 255 * This function enables the FlexIO UART interrupt.
AnnaBridge 171:3a7713b1edbc 256 *
AnnaBridge 171:3a7713b1edbc 257 * @param base Pointer to the FLEXIO_UART_Type structure.
AnnaBridge 171:3a7713b1edbc 258 * @param mask Interrupt source.
AnnaBridge 171:3a7713b1edbc 259 */
AnnaBridge 171:3a7713b1edbc 260 void FLEXIO_UART_EnableInterrupts(FLEXIO_UART_Type *base, uint32_t mask);
AnnaBridge 171:3a7713b1edbc 261
AnnaBridge 171:3a7713b1edbc 262 /*!
AnnaBridge 171:3a7713b1edbc 263 * @brief Disables the FlexIO UART interrupt.
AnnaBridge 171:3a7713b1edbc 264 *
AnnaBridge 171:3a7713b1edbc 265 * This function disables the FlexIO UART interrupt.
AnnaBridge 171:3a7713b1edbc 266 *
AnnaBridge 171:3a7713b1edbc 267 * @param base Pointer to the FLEXIO_UART_Type structure.
AnnaBridge 171:3a7713b1edbc 268 * @param mask Interrupt source.
AnnaBridge 171:3a7713b1edbc 269 */
AnnaBridge 171:3a7713b1edbc 270 void FLEXIO_UART_DisableInterrupts(FLEXIO_UART_Type *base, uint32_t mask);
AnnaBridge 171:3a7713b1edbc 271
AnnaBridge 171:3a7713b1edbc 272 /* @} */
AnnaBridge 171:3a7713b1edbc 273
AnnaBridge 171:3a7713b1edbc 274 /*!
AnnaBridge 171:3a7713b1edbc 275 * @name DMA Control
AnnaBridge 171:3a7713b1edbc 276 * @{
AnnaBridge 171:3a7713b1edbc 277 */
AnnaBridge 171:3a7713b1edbc 278
AnnaBridge 171:3a7713b1edbc 279 /*!
AnnaBridge 171:3a7713b1edbc 280 * @brief Gets the FlexIO UARt transmit data register address.
AnnaBridge 171:3a7713b1edbc 281 *
AnnaBridge 171:3a7713b1edbc 282 * This function returns the UART data register address, which is mainly used by DMA/eDMA.
AnnaBridge 171:3a7713b1edbc 283 *
AnnaBridge 171:3a7713b1edbc 284 * @param base Pointer to the FLEXIO_UART_Type structure.
AnnaBridge 171:3a7713b1edbc 285 * @return FlexIO UART transmit data register address.
AnnaBridge 171:3a7713b1edbc 286 */
AnnaBridge 171:3a7713b1edbc 287 static inline uint32_t FLEXIO_UART_GetTxDataRegisterAddress(FLEXIO_UART_Type *base)
AnnaBridge 171:3a7713b1edbc 288 {
AnnaBridge 171:3a7713b1edbc 289 return FLEXIO_GetShifterBufferAddress(base->flexioBase, kFLEXIO_ShifterBuffer, base->shifterIndex[0]);
AnnaBridge 171:3a7713b1edbc 290 }
AnnaBridge 171:3a7713b1edbc 291
AnnaBridge 171:3a7713b1edbc 292 /*!
AnnaBridge 171:3a7713b1edbc 293 * @brief Gets the FlexIO UART receive data register address.
AnnaBridge 171:3a7713b1edbc 294 *
AnnaBridge 171:3a7713b1edbc 295 * This function returns the UART data register address, which is mainly used by DMA/eDMA.
AnnaBridge 171:3a7713b1edbc 296 *
AnnaBridge 171:3a7713b1edbc 297 * @param base Pointer to the FLEXIO_UART_Type structure.
AnnaBridge 171:3a7713b1edbc 298 * @return FlexIO UART receive data register address.
AnnaBridge 171:3a7713b1edbc 299 */
AnnaBridge 171:3a7713b1edbc 300 static inline uint32_t FLEXIO_UART_GetRxDataRegisterAddress(FLEXIO_UART_Type *base)
AnnaBridge 171:3a7713b1edbc 301 {
AnnaBridge 171:3a7713b1edbc 302 return FLEXIO_GetShifterBufferAddress(base->flexioBase, kFLEXIO_ShifterBufferByteSwapped, base->shifterIndex[1]);
AnnaBridge 171:3a7713b1edbc 303 }
AnnaBridge 171:3a7713b1edbc 304
AnnaBridge 171:3a7713b1edbc 305 /*!
AnnaBridge 171:3a7713b1edbc 306 * @brief Enables/disables the FlexIO UART transmit DMA.
AnnaBridge 171:3a7713b1edbc 307 * This function enables/disables the FlexIO UART Tx DMA,
AnnaBridge 171:3a7713b1edbc 308 * which means asserting the kFLEXIO_UART_TxDataRegEmptyFlag does/doesn't trigger the DMA request.
AnnaBridge 171:3a7713b1edbc 309 *
AnnaBridge 171:3a7713b1edbc 310 * @param base Pointer to the FLEXIO_UART_Type structure.
AnnaBridge 171:3a7713b1edbc 311 * @param enable True to enable, false to disable.
AnnaBridge 171:3a7713b1edbc 312 */
AnnaBridge 171:3a7713b1edbc 313 static inline void FLEXIO_UART_EnableTxDMA(FLEXIO_UART_Type *base, bool enable)
AnnaBridge 171:3a7713b1edbc 314 {
AnnaBridge 171:3a7713b1edbc 315 FLEXIO_EnableShifterStatusDMA(base->flexioBase, 1 << base->shifterIndex[0], enable);
AnnaBridge 171:3a7713b1edbc 316 }
AnnaBridge 171:3a7713b1edbc 317
AnnaBridge 171:3a7713b1edbc 318 /*!
AnnaBridge 171:3a7713b1edbc 319 * @brief Enables/disables the FlexIO UART receive DMA.
AnnaBridge 171:3a7713b1edbc 320 * This function enables/disables the FlexIO UART Rx DMA,
AnnaBridge 171:3a7713b1edbc 321 * which means asserting kFLEXIO_UART_RxDataRegFullFlag does/doesn't trigger the DMA request.
AnnaBridge 171:3a7713b1edbc 322 *
AnnaBridge 171:3a7713b1edbc 323 * @param base Pointer to the FLEXIO_UART_Type structure.
AnnaBridge 171:3a7713b1edbc 324 * @param enable True to enable, false to disable.
AnnaBridge 171:3a7713b1edbc 325 */
AnnaBridge 171:3a7713b1edbc 326 static inline void FLEXIO_UART_EnableRxDMA(FLEXIO_UART_Type *base, bool enable)
AnnaBridge 171:3a7713b1edbc 327 {
AnnaBridge 171:3a7713b1edbc 328 FLEXIO_EnableShifterStatusDMA(base->flexioBase, 1 << base->shifterIndex[1], enable);
AnnaBridge 171:3a7713b1edbc 329 }
AnnaBridge 171:3a7713b1edbc 330
AnnaBridge 171:3a7713b1edbc 331 /* @} */
AnnaBridge 171:3a7713b1edbc 332
AnnaBridge 171:3a7713b1edbc 333 /*!
AnnaBridge 171:3a7713b1edbc 334 * @name Bus Operations
AnnaBridge 171:3a7713b1edbc 335 * @{
AnnaBridge 171:3a7713b1edbc 336 */
AnnaBridge 171:3a7713b1edbc 337
AnnaBridge 171:3a7713b1edbc 338 /*!
AnnaBridge 171:3a7713b1edbc 339 * @brief Enables/disables the FlexIO UART module operation.
AnnaBridge 171:3a7713b1edbc 340 *
AnnaBridge 171:3a7713b1edbc 341 * @param base Pointer to the FLEXIO_UART_Type.
AnnaBridge 171:3a7713b1edbc 342 * @param enable True to enable, false to disable.
AnnaBridge 171:3a7713b1edbc 343 */
AnnaBridge 171:3a7713b1edbc 344 static inline void FLEXIO_UART_Enable(FLEXIO_UART_Type *base, bool enable)
AnnaBridge 171:3a7713b1edbc 345 {
AnnaBridge 171:3a7713b1edbc 346 if (enable)
AnnaBridge 171:3a7713b1edbc 347 {
AnnaBridge 171:3a7713b1edbc 348 base->flexioBase->CTRL |= FLEXIO_CTRL_FLEXEN_MASK;
AnnaBridge 171:3a7713b1edbc 349 }
AnnaBridge 171:3a7713b1edbc 350 else
AnnaBridge 171:3a7713b1edbc 351 {
AnnaBridge 171:3a7713b1edbc 352 base->flexioBase->CTRL &= ~FLEXIO_CTRL_FLEXEN_MASK;
AnnaBridge 171:3a7713b1edbc 353 }
AnnaBridge 171:3a7713b1edbc 354 }
AnnaBridge 171:3a7713b1edbc 355
AnnaBridge 171:3a7713b1edbc 356 /*!
AnnaBridge 171:3a7713b1edbc 357 * @brief Writes one byte of data.
AnnaBridge 171:3a7713b1edbc 358 *
AnnaBridge 171:3a7713b1edbc 359 * @note This is a non-blocking API, which returns directly after the data is put into the
AnnaBridge 171:3a7713b1edbc 360 * data register. Ensure that the TxEmptyFlag is asserted before calling
AnnaBridge 171:3a7713b1edbc 361 * this API.
AnnaBridge 171:3a7713b1edbc 362 *
AnnaBridge 171:3a7713b1edbc 363 * @param base Pointer to the FLEXIO_UART_Type structure.
AnnaBridge 171:3a7713b1edbc 364 * @param buffer The data bytes to send.
AnnaBridge 171:3a7713b1edbc 365 */
AnnaBridge 171:3a7713b1edbc 366 static inline void FLEXIO_UART_WriteByte(FLEXIO_UART_Type *base, const uint8_t *buffer)
AnnaBridge 171:3a7713b1edbc 367 {
AnnaBridge 171:3a7713b1edbc 368 base->flexioBase->SHIFTBUF[base->shifterIndex[0]] = *buffer;
AnnaBridge 171:3a7713b1edbc 369 }
AnnaBridge 171:3a7713b1edbc 370
AnnaBridge 171:3a7713b1edbc 371 /*!
AnnaBridge 171:3a7713b1edbc 372 * @brief Reads one byte of data.
AnnaBridge 171:3a7713b1edbc 373 *
AnnaBridge 171:3a7713b1edbc 374 * @note This is a non-blocking API, which returns directly after the data is read from the
AnnaBridge 171:3a7713b1edbc 375 * data register. Ensure that the RxFullFlag is asserted before calling this API.
AnnaBridge 171:3a7713b1edbc 376 *
AnnaBridge 171:3a7713b1edbc 377 * @param base Pointer to the FLEXIO_UART_Type structure.
AnnaBridge 171:3a7713b1edbc 378 * @param buffer The buffer to store the received bytes.
AnnaBridge 171:3a7713b1edbc 379 */
AnnaBridge 171:3a7713b1edbc 380 static inline void FLEXIO_UART_ReadByte(FLEXIO_UART_Type *base, uint8_t *buffer)
AnnaBridge 171:3a7713b1edbc 381 {
AnnaBridge 171:3a7713b1edbc 382 *buffer = base->flexioBase->SHIFTBUFBYS[base->shifterIndex[1]];
AnnaBridge 171:3a7713b1edbc 383 }
AnnaBridge 171:3a7713b1edbc 384
AnnaBridge 171:3a7713b1edbc 385 /*!
AnnaBridge 171:3a7713b1edbc 386 * @brief Sends a buffer of data bytes.
AnnaBridge 171:3a7713b1edbc 387 *
AnnaBridge 171:3a7713b1edbc 388 * @note This function blocks using the polling method until all bytes have been sent.
AnnaBridge 171:3a7713b1edbc 389 *
AnnaBridge 171:3a7713b1edbc 390 * @param base Pointer to the FLEXIO_UART_Type structure.
AnnaBridge 171:3a7713b1edbc 391 * @param txData The data bytes to send.
AnnaBridge 171:3a7713b1edbc 392 * @param txSize The number of data bytes to send.
AnnaBridge 171:3a7713b1edbc 393 */
AnnaBridge 171:3a7713b1edbc 394 void FLEXIO_UART_WriteBlocking(FLEXIO_UART_Type *base, const uint8_t *txData, size_t txSize);
AnnaBridge 171:3a7713b1edbc 395
AnnaBridge 171:3a7713b1edbc 396 /*!
AnnaBridge 171:3a7713b1edbc 397 * @brief Receives a buffer of bytes.
AnnaBridge 171:3a7713b1edbc 398 *
AnnaBridge 171:3a7713b1edbc 399 * @note This function blocks using the polling method until all bytes have been received.
AnnaBridge 171:3a7713b1edbc 400 *
AnnaBridge 171:3a7713b1edbc 401 * @param base Pointer to the FLEXIO_UART_Type structure.
AnnaBridge 171:3a7713b1edbc 402 * @param rxData The buffer to store the received bytes.
AnnaBridge 171:3a7713b1edbc 403 * @param rxSize The number of data bytes to be received.
AnnaBridge 171:3a7713b1edbc 404 */
AnnaBridge 171:3a7713b1edbc 405 void FLEXIO_UART_ReadBlocking(FLEXIO_UART_Type *base, uint8_t *rxData, size_t rxSize);
AnnaBridge 171:3a7713b1edbc 406
AnnaBridge 171:3a7713b1edbc 407 /* @} */
AnnaBridge 171:3a7713b1edbc 408
AnnaBridge 171:3a7713b1edbc 409 /*!
AnnaBridge 171:3a7713b1edbc 410 * @name Transactional
AnnaBridge 171:3a7713b1edbc 411 * @{
AnnaBridge 171:3a7713b1edbc 412 */
AnnaBridge 171:3a7713b1edbc 413
AnnaBridge 171:3a7713b1edbc 414 /*!
AnnaBridge 171:3a7713b1edbc 415 * @brief Initializes the UART handle.
AnnaBridge 171:3a7713b1edbc 416 *
AnnaBridge 171:3a7713b1edbc 417 * This function initializes the FlexIO UART handle, which can be used for other FlexIO
AnnaBridge 171:3a7713b1edbc 418 * UART transactional APIs. Call this API once to get the
AnnaBridge 171:3a7713b1edbc 419 * initialized handle.
AnnaBridge 171:3a7713b1edbc 420 *
AnnaBridge 171:3a7713b1edbc 421 * The UART driver supports the "background" receiving, which means that user can set up
AnnaBridge 171:3a7713b1edbc 422 * a RX ring buffer optionally. Data received is stored into the ring buffer even when
AnnaBridge 171:3a7713b1edbc 423 * the user doesn't call the FLEXIO_UART_TransferReceiveNonBlocking() API. If there is already data
AnnaBridge 171:3a7713b1edbc 424 * received in the ring buffer, user can get the received data from the ring buffer
AnnaBridge 171:3a7713b1edbc 425 * directly. The ring buffer is disabled if passing NULL as @p ringBuffer.
AnnaBridge 171:3a7713b1edbc 426 *
AnnaBridge 171:3a7713b1edbc 427 * @param base to FLEXIO_UART_Type structure.
AnnaBridge 171:3a7713b1edbc 428 * @param handle Pointer to the flexio_uart_handle_t structure to store the transfer state.
AnnaBridge 171:3a7713b1edbc 429 * @param callback The callback function.
AnnaBridge 171:3a7713b1edbc 430 * @param userData The parameter of the callback function.
AnnaBridge 171:3a7713b1edbc 431 * @retval kStatus_Success Successfully create the handle.
AnnaBridge 171:3a7713b1edbc 432 * @retval kStatus_OutOfRange The FlexIO type/handle/ISR table out of range.
AnnaBridge 171:3a7713b1edbc 433 */
AnnaBridge 171:3a7713b1edbc 434 status_t FLEXIO_UART_TransferCreateHandle(FLEXIO_UART_Type *base,
AnnaBridge 171:3a7713b1edbc 435 flexio_uart_handle_t *handle,
AnnaBridge 171:3a7713b1edbc 436 flexio_uart_transfer_callback_t callback,
AnnaBridge 171:3a7713b1edbc 437 void *userData);
AnnaBridge 171:3a7713b1edbc 438
AnnaBridge 171:3a7713b1edbc 439 /*!
AnnaBridge 171:3a7713b1edbc 440 * @brief Sets up the RX ring buffer.
AnnaBridge 171:3a7713b1edbc 441 *
AnnaBridge 171:3a7713b1edbc 442 * This function sets up the RX ring buffer to a specific UART handle.
AnnaBridge 171:3a7713b1edbc 443 *
AnnaBridge 171:3a7713b1edbc 444 * When the RX ring buffer is used, data received is stored into the ring buffer even when
AnnaBridge 171:3a7713b1edbc 445 * the user doesn't call the UART_ReceiveNonBlocking() API. If there are already data received
AnnaBridge 171:3a7713b1edbc 446 * in the ring buffer, user can get the received data from the ring buffer directly.
AnnaBridge 171:3a7713b1edbc 447 *
AnnaBridge 171:3a7713b1edbc 448 * @note When using the RX ring buffer, one byte is reserved for internal use. In other
AnnaBridge 171:3a7713b1edbc 449 * words, if @p ringBufferSize is 32, only 31 bytes are used for saving data.
AnnaBridge 171:3a7713b1edbc 450 *
AnnaBridge 171:3a7713b1edbc 451 * @param base Pointer to the FLEXIO_UART_Type structure.
AnnaBridge 171:3a7713b1edbc 452 * @param handle Pointer to the flexio_uart_handle_t structure to store the transfer state.
AnnaBridge 171:3a7713b1edbc 453 * @param ringBuffer Start address of ring buffer for background receiving. Pass NULL to disable the ring buffer.
AnnaBridge 171:3a7713b1edbc 454 * @param ringBufferSize Size of the ring buffer.
AnnaBridge 171:3a7713b1edbc 455 */
AnnaBridge 171:3a7713b1edbc 456 void FLEXIO_UART_TransferStartRingBuffer(FLEXIO_UART_Type *base,
AnnaBridge 171:3a7713b1edbc 457 flexio_uart_handle_t *handle,
AnnaBridge 171:3a7713b1edbc 458 uint8_t *ringBuffer,
AnnaBridge 171:3a7713b1edbc 459 size_t ringBufferSize);
AnnaBridge 171:3a7713b1edbc 460
AnnaBridge 171:3a7713b1edbc 461 /*!
AnnaBridge 171:3a7713b1edbc 462 * @brief Aborts the background transfer and uninstalls the ring buffer.
AnnaBridge 171:3a7713b1edbc 463 *
AnnaBridge 171:3a7713b1edbc 464 * This function aborts the background transfer and uninstalls the ring buffer.
AnnaBridge 171:3a7713b1edbc 465 *
AnnaBridge 171:3a7713b1edbc 466 * @param base Pointer to the FLEXIO_UART_Type structure.
AnnaBridge 171:3a7713b1edbc 467 * @param handle Pointer to the flexio_uart_handle_t structure to store the transfer state.
AnnaBridge 171:3a7713b1edbc 468 */
AnnaBridge 171:3a7713b1edbc 469 void FLEXIO_UART_StopRingBuffer(FLEXIO_UART_Type *base, flexio_uart_handle_t *handle);
AnnaBridge 171:3a7713b1edbc 470
AnnaBridge 171:3a7713b1edbc 471 /*!
AnnaBridge 171:3a7713b1edbc 472 * @brief Transmits a buffer of data using the interrupt method.
AnnaBridge 171:3a7713b1edbc 473 *
AnnaBridge 171:3a7713b1edbc 474 * This function sends data using an interrupt method. This is a non-blocking function,
AnnaBridge 171:3a7713b1edbc 475 * which returns directly without waiting for all data to be written to the TX register. When
AnnaBridge 171:3a7713b1edbc 476 * all data are written to TX register in ISR, the FlexIO UART driver calls the callback
AnnaBridge 171:3a7713b1edbc 477 * function and passes the @ref kStatus_FLEXIO_UART_TxIdle as status parameter.
AnnaBridge 171:3a7713b1edbc 478 *
AnnaBridge 171:3a7713b1edbc 479 * @note The kStatus_FLEXIO_UART_TxIdle is passed to the upper layer when all data is written
AnnaBridge 171:3a7713b1edbc 480 * to the TX register. However, it does not ensure that all data is sent out.
AnnaBridge 171:3a7713b1edbc 481 *
AnnaBridge 171:3a7713b1edbc 482 * @param base Pointer to the FLEXIO_UART_Type structure.
AnnaBridge 171:3a7713b1edbc 483 * @param handle Pointer to the flexio_uart_handle_t structure to store the transfer state.
AnnaBridge 171:3a7713b1edbc 484 * @param xfer FlexIO UART transfer structure. See #flexio_uart_transfer_t.
AnnaBridge 171:3a7713b1edbc 485 * @retval kStatus_Success Successfully starts the data transmission.
AnnaBridge 171:3a7713b1edbc 486 * @retval kStatus_UART_TxBusy Previous transmission still not finished, data not written to the TX register.
AnnaBridge 171:3a7713b1edbc 487 */
AnnaBridge 171:3a7713b1edbc 488 status_t FLEXIO_UART_TransferSendNonBlocking(FLEXIO_UART_Type *base,
AnnaBridge 171:3a7713b1edbc 489 flexio_uart_handle_t *handle,
AnnaBridge 171:3a7713b1edbc 490 flexio_uart_transfer_t *xfer);
AnnaBridge 171:3a7713b1edbc 491
AnnaBridge 171:3a7713b1edbc 492 /*!
AnnaBridge 171:3a7713b1edbc 493 * @brief Aborts the interrupt-driven data transmit.
AnnaBridge 171:3a7713b1edbc 494 *
AnnaBridge 171:3a7713b1edbc 495 * This function aborts the interrupt-driven data sending. Get the remainBytes to know
AnnaBridge 171:3a7713b1edbc 496 * how many bytes are still not sent out.
AnnaBridge 171:3a7713b1edbc 497 *
AnnaBridge 171:3a7713b1edbc 498 * @param base Pointer to the FLEXIO_UART_Type structure.
AnnaBridge 171:3a7713b1edbc 499 * @param handle Pointer to the flexio_uart_handle_t structure to store the transfer state.
AnnaBridge 171:3a7713b1edbc 500 */
AnnaBridge 171:3a7713b1edbc 501 void FLEXIO_UART_TransferAbortSend(FLEXIO_UART_Type *base, flexio_uart_handle_t *handle);
AnnaBridge 171:3a7713b1edbc 502
AnnaBridge 171:3a7713b1edbc 503 /*!
AnnaBridge 171:3a7713b1edbc 504 * @brief Gets the number of remaining bytes not sent.
AnnaBridge 171:3a7713b1edbc 505 *
AnnaBridge 171:3a7713b1edbc 506 * This function gets the number of remaining bytes not sent driven by interrupt.
AnnaBridge 171:3a7713b1edbc 507 *
AnnaBridge 171:3a7713b1edbc 508 * @param base Pointer to the FLEXIO_UART_Type structure.
AnnaBridge 171:3a7713b1edbc 509 * @param handle Pointer to the flexio_uart_handle_t structure to store the transfer state.
AnnaBridge 171:3a7713b1edbc 510 * @param count Number of bytes sent so far by the non-blocking transaction.
AnnaBridge 171:3a7713b1edbc 511 * @retval kStatus_InvalidArgument count is Invalid.
AnnaBridge 171:3a7713b1edbc 512 * @retval kStatus_Success Successfully return the count.
AnnaBridge 171:3a7713b1edbc 513 */
AnnaBridge 171:3a7713b1edbc 514 status_t FLEXIO_UART_TransferGetSendCount(FLEXIO_UART_Type *base, flexio_uart_handle_t *handle, size_t *count);
AnnaBridge 171:3a7713b1edbc 515
AnnaBridge 171:3a7713b1edbc 516 /*!
AnnaBridge 171:3a7713b1edbc 517 * @brief Receives a buffer of data using the interrupt method.
AnnaBridge 171:3a7713b1edbc 518 *
AnnaBridge 171:3a7713b1edbc 519 * This function receives data using the interrupt method. This is a non-blocking function,
AnnaBridge 171:3a7713b1edbc 520 * which returns without waiting for all data to be received.
AnnaBridge 171:3a7713b1edbc 521 * If the RX ring buffer is used and not empty, the data in ring buffer is copied and
AnnaBridge 171:3a7713b1edbc 522 * the parameter @p receivedBytes shows how many bytes are copied from the ring buffer.
AnnaBridge 171:3a7713b1edbc 523 * After copying, if the data in ring buffer is not enough to read, the receive
AnnaBridge 171:3a7713b1edbc 524 * request is saved by the UART driver. When new data arrives, the receive request
AnnaBridge 171:3a7713b1edbc 525 * is serviced first. When all data is received, the UART driver notifies the upper layer
AnnaBridge 171:3a7713b1edbc 526 * through a callback function and passes the status parameter @ref kStatus_UART_RxIdle.
AnnaBridge 171:3a7713b1edbc 527 * For example, if the upper layer needs 10 bytes but there are only 5 bytes in the ring buffer,
AnnaBridge 171:3a7713b1edbc 528 * the 5 bytes are copied to xfer->data. This function returns with the
AnnaBridge 171:3a7713b1edbc 529 * parameter @p receivedBytes set to 5. For the last 5 bytes, newly arrived data is
AnnaBridge 171:3a7713b1edbc 530 * saved from the xfer->data[5]. When 5 bytes are received, the UART driver notifies upper layer.
AnnaBridge 171:3a7713b1edbc 531 * If the RX ring buffer is not enabled, this function enables the RX and RX interrupt
AnnaBridge 171:3a7713b1edbc 532 * to receive data to xfer->data. When all data is received, the upper layer is notified.
AnnaBridge 171:3a7713b1edbc 533 *
AnnaBridge 171:3a7713b1edbc 534 * @param base Pointer to the FLEXIO_UART_Type structure.
AnnaBridge 171:3a7713b1edbc 535 * @param handle Pointer to the flexio_uart_handle_t structure to store the transfer state.
AnnaBridge 171:3a7713b1edbc 536 * @param xfer UART transfer structure. See #flexio_uart_transfer_t.
AnnaBridge 171:3a7713b1edbc 537 * @param receivedBytes Bytes received from the ring buffer directly.
AnnaBridge 171:3a7713b1edbc 538 * @retval kStatus_Success Successfully queue the transfer into the transmit queue.
AnnaBridge 171:3a7713b1edbc 539 * @retval kStatus_FLEXIO_UART_RxBusy Previous receive request is not finished.
AnnaBridge 171:3a7713b1edbc 540 */
AnnaBridge 171:3a7713b1edbc 541 status_t FLEXIO_UART_TransferReceiveNonBlocking(FLEXIO_UART_Type *base,
AnnaBridge 171:3a7713b1edbc 542 flexio_uart_handle_t *handle,
AnnaBridge 171:3a7713b1edbc 543 flexio_uart_transfer_t *xfer,
AnnaBridge 171:3a7713b1edbc 544 size_t *receivedBytes);
AnnaBridge 171:3a7713b1edbc 545
AnnaBridge 171:3a7713b1edbc 546 /*!
AnnaBridge 171:3a7713b1edbc 547 * @brief Aborts the receive data which was using IRQ.
AnnaBridge 171:3a7713b1edbc 548 *
AnnaBridge 171:3a7713b1edbc 549 * This function aborts the receive data which was using IRQ.
AnnaBridge 171:3a7713b1edbc 550 *
AnnaBridge 171:3a7713b1edbc 551 * @param base Pointer to the FLEXIO_UART_Type structure.
AnnaBridge 171:3a7713b1edbc 552 * @param handle Pointer to the flexio_uart_handle_t structure to store the transfer state.
AnnaBridge 171:3a7713b1edbc 553 */
AnnaBridge 171:3a7713b1edbc 554 void FLEXIO_UART_TransferAbortReceive(FLEXIO_UART_Type *base, flexio_uart_handle_t *handle);
AnnaBridge 171:3a7713b1edbc 555
AnnaBridge 171:3a7713b1edbc 556 /*!
AnnaBridge 171:3a7713b1edbc 557 * @brief Gets the number of remaining bytes not received.
AnnaBridge 171:3a7713b1edbc 558 *
AnnaBridge 171:3a7713b1edbc 559 * This function gets the number of remaining bytes not received driven by interrupt.
AnnaBridge 171:3a7713b1edbc 560 *
AnnaBridge 171:3a7713b1edbc 561 * @param base Pointer to the FLEXIO_UART_Type structure.
AnnaBridge 171:3a7713b1edbc 562 * @param handle Pointer to the flexio_uart_handle_t structure to store the transfer state.
AnnaBridge 171:3a7713b1edbc 563 * @param count Number of bytes received so far by the non-blocking transaction.
AnnaBridge 171:3a7713b1edbc 564 * @retval kStatus_InvalidArgument count is Invalid.
AnnaBridge 171:3a7713b1edbc 565 * @retval kStatus_Success Successfully return the count.
AnnaBridge 171:3a7713b1edbc 566 */
AnnaBridge 171:3a7713b1edbc 567 status_t FLEXIO_UART_TransferGetReceiveCount(FLEXIO_UART_Type *base, flexio_uart_handle_t *handle, size_t *count);
AnnaBridge 171:3a7713b1edbc 568
AnnaBridge 171:3a7713b1edbc 569 /*!
AnnaBridge 171:3a7713b1edbc 570 * @brief FlexIO UART IRQ handler function.
AnnaBridge 171:3a7713b1edbc 571 *
AnnaBridge 171:3a7713b1edbc 572 * This function processes the FlexIO UART transmit and receives the IRQ request.
AnnaBridge 171:3a7713b1edbc 573 *
AnnaBridge 171:3a7713b1edbc 574 * @param uartType Pointer to the FLEXIO_UART_Type structure.
AnnaBridge 171:3a7713b1edbc 575 * @param uartHandle Pointer to the flexio_uart_handle_t structure to store the transfer state.
AnnaBridge 171:3a7713b1edbc 576 */
AnnaBridge 171:3a7713b1edbc 577 void FLEXIO_UART_TransferHandleIRQ(void *uartType, void *uartHandle);
AnnaBridge 171:3a7713b1edbc 578
AnnaBridge 171:3a7713b1edbc 579 /*@}*/
AnnaBridge 171:3a7713b1edbc 580
AnnaBridge 171:3a7713b1edbc 581 #if defined(__cplusplus)
AnnaBridge 171:3a7713b1edbc 582 }
AnnaBridge 171:3a7713b1edbc 583 #endif /*_cplusplus*/
AnnaBridge 171:3a7713b1edbc 584 /*@}*/
AnnaBridge 171:3a7713b1edbc 585
AnnaBridge 171:3a7713b1edbc 586 #endif /*_FSL_FLEXIO_UART_H_*/