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_edma.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, 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 #ifndef _FSL_FLEXIO_UART_EDMA_H_
AnnaBridge 161:aa5281ff4a02 35 #define _FSL_FLEXIO_UART_EDMA_H_
AnnaBridge 161:aa5281ff4a02 36
AnnaBridge 161:aa5281ff4a02 37 #include "fsl_flexio_uart.h"
AnnaBridge 161:aa5281ff4a02 38 #include "fsl_edma.h"
AnnaBridge 161:aa5281ff4a02 39
AnnaBridge 161:aa5281ff4a02 40 /*!
AnnaBridge 161:aa5281ff4a02 41 * @addtogroup flexio_edma_uart
AnnaBridge 161:aa5281ff4a02 42 * @{
AnnaBridge 161:aa5281ff4a02 43 */
AnnaBridge 161:aa5281ff4a02 44
AnnaBridge 161:aa5281ff4a02 45 /*******************************************************************************
AnnaBridge 161:aa5281ff4a02 46 * Definitions
AnnaBridge 161:aa5281ff4a02 47 ******************************************************************************/
AnnaBridge 161:aa5281ff4a02 48
AnnaBridge 170:e95d10626187 49 /*! @name Driver version */
AnnaBridge 170:e95d10626187 50 /*@{*/
AnnaBridge 170:e95d10626187 51 /*! @brief FlexIO UART EDMA driver version 2.1.4. */
AnnaBridge 170:e95d10626187 52 #define FSL_FLEXIO_UART_EDMA_DRIVER_VERSION (MAKE_VERSION(2, 1, 4))
AnnaBridge 170:e95d10626187 53 /*@}*/
AnnaBridge 170:e95d10626187 54
AnnaBridge 161:aa5281ff4a02 55 /* Forward declaration of the handle typedef. */
AnnaBridge 161:aa5281ff4a02 56 typedef struct _flexio_uart_edma_handle flexio_uart_edma_handle_t;
AnnaBridge 161:aa5281ff4a02 57
AnnaBridge 161:aa5281ff4a02 58 /*! @brief UART transfer callback function. */
AnnaBridge 161:aa5281ff4a02 59 typedef void (*flexio_uart_edma_transfer_callback_t)(FLEXIO_UART_Type *base,
AnnaBridge 161:aa5281ff4a02 60 flexio_uart_edma_handle_t *handle,
AnnaBridge 161:aa5281ff4a02 61 status_t status,
AnnaBridge 161:aa5281ff4a02 62 void *userData);
AnnaBridge 161:aa5281ff4a02 63
AnnaBridge 161:aa5281ff4a02 64 /*!
AnnaBridge 161:aa5281ff4a02 65 * @brief UART eDMA handle
AnnaBridge 161:aa5281ff4a02 66 */
AnnaBridge 161:aa5281ff4a02 67 struct _flexio_uart_edma_handle
AnnaBridge 161:aa5281ff4a02 68 {
AnnaBridge 161:aa5281ff4a02 69 flexio_uart_edma_transfer_callback_t callback; /*!< Callback function. */
AnnaBridge 161:aa5281ff4a02 70 void *userData; /*!< UART callback function parameter.*/
AnnaBridge 161:aa5281ff4a02 71
AnnaBridge 161:aa5281ff4a02 72 size_t txDataSizeAll; /*!< Total bytes to be sent. */
AnnaBridge 161:aa5281ff4a02 73 size_t rxDataSizeAll; /*!< Total bytes to be received. */
AnnaBridge 161:aa5281ff4a02 74
AnnaBridge 161:aa5281ff4a02 75 edma_handle_t *txEdmaHandle; /*!< The eDMA TX channel used. */
AnnaBridge 161:aa5281ff4a02 76 edma_handle_t *rxEdmaHandle; /*!< The eDMA RX channel used. */
AnnaBridge 161:aa5281ff4a02 77
AnnaBridge 161:aa5281ff4a02 78 uint8_t nbytes; /*!< eDMA minor byte transfer count initially configured. */
AnnaBridge 161:aa5281ff4a02 79
AnnaBridge 161:aa5281ff4a02 80 volatile uint8_t txState; /*!< TX transfer state. */
AnnaBridge 161:aa5281ff4a02 81 volatile uint8_t rxState; /*!< RX transfer state */
AnnaBridge 161:aa5281ff4a02 82 };
AnnaBridge 161:aa5281ff4a02 83
AnnaBridge 161:aa5281ff4a02 84 /*******************************************************************************
AnnaBridge 161:aa5281ff4a02 85 * API
AnnaBridge 161:aa5281ff4a02 86 ******************************************************************************/
AnnaBridge 161:aa5281ff4a02 87
AnnaBridge 161:aa5281ff4a02 88 #if defined(__cplusplus)
AnnaBridge 161:aa5281ff4a02 89 extern "C" {
AnnaBridge 161:aa5281ff4a02 90 #endif
AnnaBridge 161:aa5281ff4a02 91
AnnaBridge 161:aa5281ff4a02 92 /*!
AnnaBridge 161:aa5281ff4a02 93 * @name eDMA transactional
AnnaBridge 161:aa5281ff4a02 94 * @{
AnnaBridge 161:aa5281ff4a02 95 */
AnnaBridge 161:aa5281ff4a02 96
AnnaBridge 161:aa5281ff4a02 97 /*!
AnnaBridge 161:aa5281ff4a02 98 * @brief Initializes the UART handle which is used in transactional functions.
AnnaBridge 161:aa5281ff4a02 99 *
AnnaBridge 161:aa5281ff4a02 100 * @param base Pointer to FLEXIO_UART_Type.
AnnaBridge 161:aa5281ff4a02 101 * @param handle Pointer to flexio_uart_edma_handle_t structure.
AnnaBridge 161:aa5281ff4a02 102 * @param callback The callback function.
AnnaBridge 161:aa5281ff4a02 103 * @param userData The parameter of the callback function.
AnnaBridge 161:aa5281ff4a02 104 * @param rxEdmaHandle User requested DMA handle for RX DMA transfer.
AnnaBridge 161:aa5281ff4a02 105 * @param txEdmaHandle User requested DMA handle for TX DMA transfer.
AnnaBridge 161:aa5281ff4a02 106 * @retval kStatus_Success Successfully create the handle.
AnnaBridge 161:aa5281ff4a02 107 * @retval kStatus_OutOfRange The FlexIO SPI eDMA type/handle table out of range.
AnnaBridge 161:aa5281ff4a02 108 */
AnnaBridge 161:aa5281ff4a02 109 status_t FLEXIO_UART_TransferCreateHandleEDMA(FLEXIO_UART_Type *base,
AnnaBridge 161:aa5281ff4a02 110 flexio_uart_edma_handle_t *handle,
AnnaBridge 161:aa5281ff4a02 111 flexio_uart_edma_transfer_callback_t callback,
AnnaBridge 161:aa5281ff4a02 112 void *userData,
AnnaBridge 161:aa5281ff4a02 113 edma_handle_t *txEdmaHandle,
AnnaBridge 161:aa5281ff4a02 114 edma_handle_t *rxEdmaHandle);
AnnaBridge 161:aa5281ff4a02 115
AnnaBridge 161:aa5281ff4a02 116 /*!
AnnaBridge 161:aa5281ff4a02 117 * @brief Sends data using eDMA.
AnnaBridge 161:aa5281ff4a02 118 *
AnnaBridge 161:aa5281ff4a02 119 * This function sends data using eDMA. This is a non-blocking function, which returns
AnnaBridge 161:aa5281ff4a02 120 * right away. When all data is sent out, the send callback function is called.
AnnaBridge 161:aa5281ff4a02 121 *
AnnaBridge 161:aa5281ff4a02 122 * @param base Pointer to FLEXIO_UART_Type
AnnaBridge 161:aa5281ff4a02 123 * @param handle UART handle pointer.
AnnaBridge 161:aa5281ff4a02 124 * @param xfer UART eDMA transfer structure, see #flexio_uart_transfer_t.
AnnaBridge 161:aa5281ff4a02 125 * @retval kStatus_Success if succeed, others failed.
AnnaBridge 161:aa5281ff4a02 126 * @retval kStatus_FLEXIO_UART_TxBusy Previous transfer on going.
AnnaBridge 161:aa5281ff4a02 127 */
AnnaBridge 161:aa5281ff4a02 128 status_t FLEXIO_UART_TransferSendEDMA(FLEXIO_UART_Type *base,
AnnaBridge 161:aa5281ff4a02 129 flexio_uart_edma_handle_t *handle,
AnnaBridge 161:aa5281ff4a02 130 flexio_uart_transfer_t *xfer);
AnnaBridge 161:aa5281ff4a02 131
AnnaBridge 161:aa5281ff4a02 132 /*!
AnnaBridge 161:aa5281ff4a02 133 * @brief Receives data using eDMA.
AnnaBridge 161:aa5281ff4a02 134 *
AnnaBridge 161:aa5281ff4a02 135 * This function receives data using eDMA. This is a non-blocking function, which returns
AnnaBridge 161:aa5281ff4a02 136 * right away. When all data is received, the receive callback function is called.
AnnaBridge 161:aa5281ff4a02 137 *
AnnaBridge 161:aa5281ff4a02 138 * @param base Pointer to FLEXIO_UART_Type
AnnaBridge 161:aa5281ff4a02 139 * @param handle Pointer to flexio_uart_edma_handle_t structure
AnnaBridge 161:aa5281ff4a02 140 * @param xfer UART eDMA transfer structure, see #flexio_uart_transfer_t.
AnnaBridge 161:aa5281ff4a02 141 * @retval kStatus_Success if succeed, others failed.
AnnaBridge 161:aa5281ff4a02 142 * @retval kStatus_UART_RxBusy Previous transfer on going.
AnnaBridge 161:aa5281ff4a02 143 */
AnnaBridge 161:aa5281ff4a02 144 status_t FLEXIO_UART_TransferReceiveEDMA(FLEXIO_UART_Type *base,
AnnaBridge 161:aa5281ff4a02 145 flexio_uart_edma_handle_t *handle,
AnnaBridge 161:aa5281ff4a02 146 flexio_uart_transfer_t *xfer);
AnnaBridge 161:aa5281ff4a02 147
AnnaBridge 161:aa5281ff4a02 148 /*!
AnnaBridge 161:aa5281ff4a02 149 * @brief Aborts the sent data which using eDMA.
AnnaBridge 161:aa5281ff4a02 150 *
AnnaBridge 161:aa5281ff4a02 151 * This function aborts sent data which using eDMA.
AnnaBridge 161:aa5281ff4a02 152 *
AnnaBridge 161:aa5281ff4a02 153 * @param base Pointer to FLEXIO_UART_Type
AnnaBridge 161:aa5281ff4a02 154 * @param handle Pointer to flexio_uart_edma_handle_t structure
AnnaBridge 161:aa5281ff4a02 155 */
AnnaBridge 161:aa5281ff4a02 156 void FLEXIO_UART_TransferAbortSendEDMA(FLEXIO_UART_Type *base, flexio_uart_edma_handle_t *handle);
AnnaBridge 161:aa5281ff4a02 157
AnnaBridge 161:aa5281ff4a02 158 /*!
AnnaBridge 161:aa5281ff4a02 159 * @brief Aborts the receive data which using eDMA.
AnnaBridge 161:aa5281ff4a02 160 *
AnnaBridge 161:aa5281ff4a02 161 * This function aborts the receive data which using eDMA.
AnnaBridge 161:aa5281ff4a02 162 *
AnnaBridge 161:aa5281ff4a02 163 * @param base Pointer to FLEXIO_UART_Type
AnnaBridge 161:aa5281ff4a02 164 * @param handle Pointer to flexio_uart_edma_handle_t structure
AnnaBridge 161:aa5281ff4a02 165 */
AnnaBridge 161:aa5281ff4a02 166 void FLEXIO_UART_TransferAbortReceiveEDMA(FLEXIO_UART_Type *base, flexio_uart_edma_handle_t *handle);
AnnaBridge 161:aa5281ff4a02 167
AnnaBridge 161:aa5281ff4a02 168 /*!
AnnaBridge 161:aa5281ff4a02 169 * @brief Gets the number of bytes sent out.
AnnaBridge 161:aa5281ff4a02 170 *
AnnaBridge 161:aa5281ff4a02 171 * This function gets the number of bytes sent out.
AnnaBridge 161:aa5281ff4a02 172 *
AnnaBridge 161:aa5281ff4a02 173 * @param base Pointer to FLEXIO_UART_Type
AnnaBridge 161:aa5281ff4a02 174 * @param handle Pointer to flexio_uart_edma_handle_t structure
AnnaBridge 161:aa5281ff4a02 175 * @param count Number of bytes sent so far by the non-blocking transaction.
AnnaBridge 161:aa5281ff4a02 176 * @retval kStatus_NoTransferInProgress transfer has finished or no transfer in progress.
AnnaBridge 161:aa5281ff4a02 177 * @retval kStatus_Success Successfully return the count.
AnnaBridge 161:aa5281ff4a02 178 */
AnnaBridge 161:aa5281ff4a02 179 status_t FLEXIO_UART_TransferGetSendCountEDMA(FLEXIO_UART_Type *base, flexio_uart_edma_handle_t *handle, size_t *count);
AnnaBridge 161:aa5281ff4a02 180
AnnaBridge 161:aa5281ff4a02 181 /*!
AnnaBridge 161:aa5281ff4a02 182 * @brief Gets the number of bytes received.
AnnaBridge 161:aa5281ff4a02 183 *
AnnaBridge 161:aa5281ff4a02 184 * This function gets the number of bytes received.
AnnaBridge 161:aa5281ff4a02 185 *
AnnaBridge 161:aa5281ff4a02 186 * @param base Pointer to FLEXIO_UART_Type
AnnaBridge 161:aa5281ff4a02 187 * @param handle Pointer to flexio_uart_edma_handle_t structure
AnnaBridge 161:aa5281ff4a02 188 * @param count Number of bytes received so far by the non-blocking transaction.
AnnaBridge 161:aa5281ff4a02 189 * @retval kStatus_NoTransferInProgress transfer has finished or no transfer in progress.
AnnaBridge 161:aa5281ff4a02 190 * @retval kStatus_Success Successfully return the count.
AnnaBridge 161:aa5281ff4a02 191 */
AnnaBridge 161:aa5281ff4a02 192 status_t FLEXIO_UART_TransferGetReceiveCountEDMA(FLEXIO_UART_Type *base,
AnnaBridge 161:aa5281ff4a02 193 flexio_uart_edma_handle_t *handle,
AnnaBridge 161:aa5281ff4a02 194 size_t *count);
AnnaBridge 161:aa5281ff4a02 195
AnnaBridge 161:aa5281ff4a02 196 /*@}*/
AnnaBridge 161:aa5281ff4a02 197
AnnaBridge 161:aa5281ff4a02 198 #if defined(__cplusplus)
AnnaBridge 161:aa5281ff4a02 199 }
AnnaBridge 161:aa5281ff4a02 200 #endif
AnnaBridge 161:aa5281ff4a02 201
AnnaBridge 161:aa5281ff4a02 202 /*! @}*/
AnnaBridge 161:aa5281ff4a02 203
AnnaBridge 161:aa5281ff4a02 204 #endif /* _FSL_UART_EDMA_H_ */