mbed official / mbed-dev

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

cmsis/BUILD/mbed/TARGET_MIMXRT1050_EVK/TOOLCHAIN_ARM_STD/fsl_flexio_uart_edma.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 189:f392fc9709a3 1 /*
AnnaBridge 189:f392fc9709a3 2 * The Clear BSD License
AnnaBridge 189:f392fc9709a3 3 * Copyright (c) 2015, Freescale Semiconductor, Inc.
AnnaBridge 189:f392fc9709a3 4 * Copyright 2016-2017 NXP
AnnaBridge 189:f392fc9709a3 5 * All rights reserved.
AnnaBridge 189:f392fc9709a3 6 *
AnnaBridge 189:f392fc9709a3 7 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 189:f392fc9709a3 8 * are permitted (subject to the limitations in the disclaimer below) provided
AnnaBridge 189:f392fc9709a3 9 * that the following conditions are met:
AnnaBridge 189:f392fc9709a3 10 *
AnnaBridge 189:f392fc9709a3 11 * o Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 189:f392fc9709a3 12 * of conditions and the following disclaimer.
AnnaBridge 189:f392fc9709a3 13 *
AnnaBridge 189:f392fc9709a3 14 * o Redistributions in binary form must reproduce the above copyright notice, this
AnnaBridge 189:f392fc9709a3 15 * list of conditions and the following disclaimer in the documentation and/or
AnnaBridge 189:f392fc9709a3 16 * other materials provided with the distribution.
AnnaBridge 189:f392fc9709a3 17 *
AnnaBridge 189:f392fc9709a3 18 * o Neither the name of the copyright holder nor the names of its
AnnaBridge 189:f392fc9709a3 19 * contributors may be used to endorse or promote products derived from this
AnnaBridge 189:f392fc9709a3 20 * software without specific prior written permission.
AnnaBridge 189:f392fc9709a3 21 *
AnnaBridge 189:f392fc9709a3 22 * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE.
AnnaBridge 189:f392fc9709a3 23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 189:f392fc9709a3 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 189:f392fc9709a3 25 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 189:f392fc9709a3 26 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 189:f392fc9709a3 27 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 189:f392fc9709a3 28 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 189:f392fc9709a3 29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 189:f392fc9709a3 30 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 189:f392fc9709a3 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 189:f392fc9709a3 32 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 189:f392fc9709a3 33 */
AnnaBridge 189:f392fc9709a3 34 #ifndef _FSL_FLEXIO_UART_EDMA_H_
AnnaBridge 189:f392fc9709a3 35 #define _FSL_FLEXIO_UART_EDMA_H_
AnnaBridge 189:f392fc9709a3 36
AnnaBridge 189:f392fc9709a3 37 #include "fsl_flexio_uart.h"
AnnaBridge 189:f392fc9709a3 38 #include "fsl_edma.h"
AnnaBridge 189:f392fc9709a3 39
AnnaBridge 189:f392fc9709a3 40 /*!
AnnaBridge 189:f392fc9709a3 41 * @addtogroup flexio_edma_uart
AnnaBridge 189:f392fc9709a3 42 * @{
AnnaBridge 189:f392fc9709a3 43 */
AnnaBridge 189:f392fc9709a3 44
AnnaBridge 189:f392fc9709a3 45 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 46 * Definitions
AnnaBridge 189:f392fc9709a3 47 ******************************************************************************/
AnnaBridge 189:f392fc9709a3 48
AnnaBridge 189:f392fc9709a3 49 /*! @name Driver version */
AnnaBridge 189:f392fc9709a3 50 /*@{*/
AnnaBridge 189:f392fc9709a3 51 /*! @brief FlexIO UART EDMA driver version 2.1.4. */
AnnaBridge 189:f392fc9709a3 52 #define FSL_FLEXIO_UART_EDMA_DRIVER_VERSION (MAKE_VERSION(2, 1, 4))
AnnaBridge 189:f392fc9709a3 53 /*@}*/
AnnaBridge 189:f392fc9709a3 54
AnnaBridge 189:f392fc9709a3 55 /* Forward declaration of the handle typedef. */
AnnaBridge 189:f392fc9709a3 56 typedef struct _flexio_uart_edma_handle flexio_uart_edma_handle_t;
AnnaBridge 189:f392fc9709a3 57
AnnaBridge 189:f392fc9709a3 58 /*! @brief UART transfer callback function. */
AnnaBridge 189:f392fc9709a3 59 typedef void (*flexio_uart_edma_transfer_callback_t)(FLEXIO_UART_Type *base,
AnnaBridge 189:f392fc9709a3 60 flexio_uart_edma_handle_t *handle,
AnnaBridge 189:f392fc9709a3 61 status_t status,
AnnaBridge 189:f392fc9709a3 62 void *userData);
AnnaBridge 189:f392fc9709a3 63
AnnaBridge 189:f392fc9709a3 64 /*!
AnnaBridge 189:f392fc9709a3 65 * @brief UART eDMA handle
AnnaBridge 189:f392fc9709a3 66 */
AnnaBridge 189:f392fc9709a3 67 struct _flexio_uart_edma_handle
AnnaBridge 189:f392fc9709a3 68 {
AnnaBridge 189:f392fc9709a3 69 flexio_uart_edma_transfer_callback_t callback; /*!< Callback function. */
AnnaBridge 189:f392fc9709a3 70 void *userData; /*!< UART callback function parameter.*/
AnnaBridge 189:f392fc9709a3 71
AnnaBridge 189:f392fc9709a3 72 size_t txDataSizeAll; /*!< Total bytes to be sent. */
AnnaBridge 189:f392fc9709a3 73 size_t rxDataSizeAll; /*!< Total bytes to be received. */
AnnaBridge 189:f392fc9709a3 74
AnnaBridge 189:f392fc9709a3 75 edma_handle_t *txEdmaHandle; /*!< The eDMA TX channel used. */
AnnaBridge 189:f392fc9709a3 76 edma_handle_t *rxEdmaHandle; /*!< The eDMA RX channel used. */
AnnaBridge 189:f392fc9709a3 77
AnnaBridge 189:f392fc9709a3 78 uint8_t nbytes; /*!< eDMA minor byte transfer count initially configured. */
AnnaBridge 189:f392fc9709a3 79
AnnaBridge 189:f392fc9709a3 80 volatile uint8_t txState; /*!< TX transfer state. */
AnnaBridge 189:f392fc9709a3 81 volatile uint8_t rxState; /*!< RX transfer state */
AnnaBridge 189:f392fc9709a3 82 };
AnnaBridge 189:f392fc9709a3 83
AnnaBridge 189:f392fc9709a3 84 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 85 * API
AnnaBridge 189:f392fc9709a3 86 ******************************************************************************/
AnnaBridge 189:f392fc9709a3 87
AnnaBridge 189:f392fc9709a3 88 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 89 extern "C" {
AnnaBridge 189:f392fc9709a3 90 #endif
AnnaBridge 189:f392fc9709a3 91
AnnaBridge 189:f392fc9709a3 92 /*!
AnnaBridge 189:f392fc9709a3 93 * @name eDMA transactional
AnnaBridge 189:f392fc9709a3 94 * @{
AnnaBridge 189:f392fc9709a3 95 */
AnnaBridge 189:f392fc9709a3 96
AnnaBridge 189:f392fc9709a3 97 /*!
AnnaBridge 189:f392fc9709a3 98 * @brief Initializes the UART handle which is used in transactional functions.
AnnaBridge 189:f392fc9709a3 99 *
AnnaBridge 189:f392fc9709a3 100 * @param base Pointer to FLEXIO_UART_Type.
AnnaBridge 189:f392fc9709a3 101 * @param handle Pointer to flexio_uart_edma_handle_t structure.
AnnaBridge 189:f392fc9709a3 102 * @param callback The callback function.
AnnaBridge 189:f392fc9709a3 103 * @param userData The parameter of the callback function.
AnnaBridge 189:f392fc9709a3 104 * @param rxEdmaHandle User requested DMA handle for RX DMA transfer.
AnnaBridge 189:f392fc9709a3 105 * @param txEdmaHandle User requested DMA handle for TX DMA transfer.
AnnaBridge 189:f392fc9709a3 106 * @retval kStatus_Success Successfully create the handle.
AnnaBridge 189:f392fc9709a3 107 * @retval kStatus_OutOfRange The FlexIO SPI eDMA type/handle table out of range.
AnnaBridge 189:f392fc9709a3 108 */
AnnaBridge 189:f392fc9709a3 109 status_t FLEXIO_UART_TransferCreateHandleEDMA(FLEXIO_UART_Type *base,
AnnaBridge 189:f392fc9709a3 110 flexio_uart_edma_handle_t *handle,
AnnaBridge 189:f392fc9709a3 111 flexio_uart_edma_transfer_callback_t callback,
AnnaBridge 189:f392fc9709a3 112 void *userData,
AnnaBridge 189:f392fc9709a3 113 edma_handle_t *txEdmaHandle,
AnnaBridge 189:f392fc9709a3 114 edma_handle_t *rxEdmaHandle);
AnnaBridge 189:f392fc9709a3 115
AnnaBridge 189:f392fc9709a3 116 /*!
AnnaBridge 189:f392fc9709a3 117 * @brief Sends data using eDMA.
AnnaBridge 189:f392fc9709a3 118 *
AnnaBridge 189:f392fc9709a3 119 * This function sends data using eDMA. This is a non-blocking function, which returns
AnnaBridge 189:f392fc9709a3 120 * right away. When all data is sent out, the send callback function is called.
AnnaBridge 189:f392fc9709a3 121 *
AnnaBridge 189:f392fc9709a3 122 * @param base Pointer to FLEXIO_UART_Type
AnnaBridge 189:f392fc9709a3 123 * @param handle UART handle pointer.
AnnaBridge 189:f392fc9709a3 124 * @param xfer UART eDMA transfer structure, see #flexio_uart_transfer_t.
AnnaBridge 189:f392fc9709a3 125 * @retval kStatus_Success if succeed, others failed.
AnnaBridge 189:f392fc9709a3 126 * @retval kStatus_FLEXIO_UART_TxBusy Previous transfer on going.
AnnaBridge 189:f392fc9709a3 127 */
AnnaBridge 189:f392fc9709a3 128 status_t FLEXIO_UART_TransferSendEDMA(FLEXIO_UART_Type *base,
AnnaBridge 189:f392fc9709a3 129 flexio_uart_edma_handle_t *handle,
AnnaBridge 189:f392fc9709a3 130 flexio_uart_transfer_t *xfer);
AnnaBridge 189:f392fc9709a3 131
AnnaBridge 189:f392fc9709a3 132 /*!
AnnaBridge 189:f392fc9709a3 133 * @brief Receives data using eDMA.
AnnaBridge 189:f392fc9709a3 134 *
AnnaBridge 189:f392fc9709a3 135 * This function receives data using eDMA. This is a non-blocking function, which returns
AnnaBridge 189:f392fc9709a3 136 * right away. When all data is received, the receive callback function is called.
AnnaBridge 189:f392fc9709a3 137 *
AnnaBridge 189:f392fc9709a3 138 * @param base Pointer to FLEXIO_UART_Type
AnnaBridge 189:f392fc9709a3 139 * @param handle Pointer to flexio_uart_edma_handle_t structure
AnnaBridge 189:f392fc9709a3 140 * @param xfer UART eDMA transfer structure, see #flexio_uart_transfer_t.
AnnaBridge 189:f392fc9709a3 141 * @retval kStatus_Success if succeed, others failed.
AnnaBridge 189:f392fc9709a3 142 * @retval kStatus_UART_RxBusy Previous transfer on going.
AnnaBridge 189:f392fc9709a3 143 */
AnnaBridge 189:f392fc9709a3 144 status_t FLEXIO_UART_TransferReceiveEDMA(FLEXIO_UART_Type *base,
AnnaBridge 189:f392fc9709a3 145 flexio_uart_edma_handle_t *handle,
AnnaBridge 189:f392fc9709a3 146 flexio_uart_transfer_t *xfer);
AnnaBridge 189:f392fc9709a3 147
AnnaBridge 189:f392fc9709a3 148 /*!
AnnaBridge 189:f392fc9709a3 149 * @brief Aborts the sent data which using eDMA.
AnnaBridge 189:f392fc9709a3 150 *
AnnaBridge 189:f392fc9709a3 151 * This function aborts sent data which using eDMA.
AnnaBridge 189:f392fc9709a3 152 *
AnnaBridge 189:f392fc9709a3 153 * @param base Pointer to FLEXIO_UART_Type
AnnaBridge 189:f392fc9709a3 154 * @param handle Pointer to flexio_uart_edma_handle_t structure
AnnaBridge 189:f392fc9709a3 155 */
AnnaBridge 189:f392fc9709a3 156 void FLEXIO_UART_TransferAbortSendEDMA(FLEXIO_UART_Type *base, flexio_uart_edma_handle_t *handle);
AnnaBridge 189:f392fc9709a3 157
AnnaBridge 189:f392fc9709a3 158 /*!
AnnaBridge 189:f392fc9709a3 159 * @brief Aborts the receive data which using eDMA.
AnnaBridge 189:f392fc9709a3 160 *
AnnaBridge 189:f392fc9709a3 161 * This function aborts the receive data which using eDMA.
AnnaBridge 189:f392fc9709a3 162 *
AnnaBridge 189:f392fc9709a3 163 * @param base Pointer to FLEXIO_UART_Type
AnnaBridge 189:f392fc9709a3 164 * @param handle Pointer to flexio_uart_edma_handle_t structure
AnnaBridge 189:f392fc9709a3 165 */
AnnaBridge 189:f392fc9709a3 166 void FLEXIO_UART_TransferAbortReceiveEDMA(FLEXIO_UART_Type *base, flexio_uart_edma_handle_t *handle);
AnnaBridge 189:f392fc9709a3 167
AnnaBridge 189:f392fc9709a3 168 /*!
AnnaBridge 189:f392fc9709a3 169 * @brief Gets the number of bytes sent out.
AnnaBridge 189:f392fc9709a3 170 *
AnnaBridge 189:f392fc9709a3 171 * This function gets the number of bytes sent out.
AnnaBridge 189:f392fc9709a3 172 *
AnnaBridge 189:f392fc9709a3 173 * @param base Pointer to FLEXIO_UART_Type
AnnaBridge 189:f392fc9709a3 174 * @param handle Pointer to flexio_uart_edma_handle_t structure
AnnaBridge 189:f392fc9709a3 175 * @param count Number of bytes sent so far by the non-blocking transaction.
AnnaBridge 189:f392fc9709a3 176 * @retval kStatus_NoTransferInProgress transfer has finished or no transfer in progress.
AnnaBridge 189:f392fc9709a3 177 * @retval kStatus_Success Successfully return the count.
AnnaBridge 189:f392fc9709a3 178 */
AnnaBridge 189:f392fc9709a3 179 status_t FLEXIO_UART_TransferGetSendCountEDMA(FLEXIO_UART_Type *base, flexio_uart_edma_handle_t *handle, size_t *count);
AnnaBridge 189:f392fc9709a3 180
AnnaBridge 189:f392fc9709a3 181 /*!
AnnaBridge 189:f392fc9709a3 182 * @brief Gets the number of bytes received.
AnnaBridge 189:f392fc9709a3 183 *
AnnaBridge 189:f392fc9709a3 184 * This function gets the number of bytes received.
AnnaBridge 189:f392fc9709a3 185 *
AnnaBridge 189:f392fc9709a3 186 * @param base Pointer to FLEXIO_UART_Type
AnnaBridge 189:f392fc9709a3 187 * @param handle Pointer to flexio_uart_edma_handle_t structure
AnnaBridge 189:f392fc9709a3 188 * @param count Number of bytes received so far by the non-blocking transaction.
AnnaBridge 189:f392fc9709a3 189 * @retval kStatus_NoTransferInProgress transfer has finished or no transfer in progress.
AnnaBridge 189:f392fc9709a3 190 * @retval kStatus_Success Successfully return the count.
AnnaBridge 189:f392fc9709a3 191 */
AnnaBridge 189:f392fc9709a3 192 status_t FLEXIO_UART_TransferGetReceiveCountEDMA(FLEXIO_UART_Type *base,
AnnaBridge 189:f392fc9709a3 193 flexio_uart_edma_handle_t *handle,
AnnaBridge 189:f392fc9709a3 194 size_t *count);
AnnaBridge 189:f392fc9709a3 195
AnnaBridge 189:f392fc9709a3 196 /*@}*/
AnnaBridge 189:f392fc9709a3 197
AnnaBridge 189:f392fc9709a3 198 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 199 }
AnnaBridge 189:f392fc9709a3 200 #endif
AnnaBridge 189:f392fc9709a3 201
AnnaBridge 189:f392fc9709a3 202 /*! @}*/
AnnaBridge 189:f392fc9709a3 203
AnnaBridge 189:f392fc9709a3 204 #endif /* _FSL_UART_EDMA_H_ */