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