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_uart_dma.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 #ifndef _FSL_UART_DMA_H_
AnnaBridge 171:3a7713b1edbc 31 #define _FSL_UART_DMA_H_
AnnaBridge 171:3a7713b1edbc 32
AnnaBridge 171:3a7713b1edbc 33 #include "fsl_uart.h"
AnnaBridge 171:3a7713b1edbc 34 #include "fsl_dmamux.h"
AnnaBridge 171:3a7713b1edbc 35 #include "fsl_dma.h"
AnnaBridge 171:3a7713b1edbc 36
AnnaBridge 171:3a7713b1edbc 37 /*!
AnnaBridge 171:3a7713b1edbc 38 * @addtogroup uart_dma_driver
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 /* Forward declaration of the handle typedef. */
AnnaBridge 171:3a7713b1edbc 49 typedef struct _uart_dma_handle uart_dma_handle_t;
AnnaBridge 171:3a7713b1edbc 50
AnnaBridge 171:3a7713b1edbc 51 /*! @brief UART transfer callback function. */
AnnaBridge 171:3a7713b1edbc 52 typedef void (*uart_dma_transfer_callback_t)(UART_Type *base,
AnnaBridge 171:3a7713b1edbc 53 uart_dma_handle_t *handle,
AnnaBridge 171:3a7713b1edbc 54 status_t status,
AnnaBridge 171:3a7713b1edbc 55 void *userData);
AnnaBridge 171:3a7713b1edbc 56
AnnaBridge 171:3a7713b1edbc 57 /*!
AnnaBridge 171:3a7713b1edbc 58 * @brief UART DMA handle
AnnaBridge 171:3a7713b1edbc 59 */
AnnaBridge 171:3a7713b1edbc 60 struct _uart_dma_handle
AnnaBridge 171:3a7713b1edbc 61 {
AnnaBridge 171:3a7713b1edbc 62 UART_Type *base; /*!< UART peripheral base address. */
AnnaBridge 171:3a7713b1edbc 63
AnnaBridge 171:3a7713b1edbc 64 uart_dma_transfer_callback_t callback; /*!< Callback function. */
AnnaBridge 171:3a7713b1edbc 65 void *userData; /*!< UART callback function parameter.*/
AnnaBridge 171:3a7713b1edbc 66 size_t rxDataSizeAll; /*!< Size of the data to receive. */
AnnaBridge 171:3a7713b1edbc 67 size_t txDataSizeAll; /*!< Size of the data to send out. */
AnnaBridge 171:3a7713b1edbc 68
AnnaBridge 171:3a7713b1edbc 69 dma_handle_t *txDmaHandle; /*!< The DMA TX channel used. */
AnnaBridge 171:3a7713b1edbc 70 dma_handle_t *rxDmaHandle; /*!< The DMA RX channel used. */
AnnaBridge 171:3a7713b1edbc 71
AnnaBridge 171:3a7713b1edbc 72 volatile uint8_t txState; /*!< TX transfer state. */
AnnaBridge 171:3a7713b1edbc 73 volatile uint8_t rxState; /*!< RX transfer state */
AnnaBridge 171:3a7713b1edbc 74 };
AnnaBridge 171:3a7713b1edbc 75
AnnaBridge 171:3a7713b1edbc 76 /*******************************************************************************
AnnaBridge 171:3a7713b1edbc 77 * API
AnnaBridge 171:3a7713b1edbc 78 ******************************************************************************/
AnnaBridge 171:3a7713b1edbc 79
AnnaBridge 171:3a7713b1edbc 80 #if defined(__cplusplus)
AnnaBridge 171:3a7713b1edbc 81 extern "C" {
AnnaBridge 171:3a7713b1edbc 82 #endif
AnnaBridge 171:3a7713b1edbc 83
AnnaBridge 171:3a7713b1edbc 84 /*!
AnnaBridge 171:3a7713b1edbc 85 * @name EDMA transactional
AnnaBridge 171:3a7713b1edbc 86 * @{
AnnaBridge 171:3a7713b1edbc 87 */
AnnaBridge 171:3a7713b1edbc 88
AnnaBridge 171:3a7713b1edbc 89 /*!
AnnaBridge 171:3a7713b1edbc 90 * @brief Initializes the UART handle which is used in transactional functions and sets the callback.
AnnaBridge 171:3a7713b1edbc 91 *
AnnaBridge 171:3a7713b1edbc 92 * @param base UART peripheral base address.
AnnaBridge 171:3a7713b1edbc 93 * @param handle Pointer to uart_dma_handle_t structure.
AnnaBridge 171:3a7713b1edbc 94 * @param callback UART callback, NULL means no callback.
AnnaBridge 171:3a7713b1edbc 95 * @param userData User callback function data.
AnnaBridge 171:3a7713b1edbc 96 * @param rxDmaHandle User requested DMA handle for RX DMA transfer.
AnnaBridge 171:3a7713b1edbc 97 * @param txDmaHandle User requested DMA handle for TX DMA transfer.
AnnaBridge 171:3a7713b1edbc 98 */
AnnaBridge 171:3a7713b1edbc 99 void UART_TransferCreateHandleDMA(UART_Type *base,
AnnaBridge 171:3a7713b1edbc 100 uart_dma_handle_t *handle,
AnnaBridge 171:3a7713b1edbc 101 uart_dma_transfer_callback_t callback,
AnnaBridge 171:3a7713b1edbc 102 void *userData,
AnnaBridge 171:3a7713b1edbc 103 dma_handle_t *txDmaHandle,
AnnaBridge 171:3a7713b1edbc 104 dma_handle_t *rxDmaHandle);
AnnaBridge 171:3a7713b1edbc 105
AnnaBridge 171:3a7713b1edbc 106 /*!
AnnaBridge 171:3a7713b1edbc 107 * @brief Sends data using DMA.
AnnaBridge 171:3a7713b1edbc 108 *
AnnaBridge 171:3a7713b1edbc 109 * This function sends data using DMA. This is non-blocking function, which returns
AnnaBridge 171:3a7713b1edbc 110 * right away. When all data is sent, the send callback function is called.
AnnaBridge 171:3a7713b1edbc 111 *
AnnaBridge 171:3a7713b1edbc 112 * @param base UART peripheral base address.
AnnaBridge 171:3a7713b1edbc 113 * @param handle UART handle pointer.
AnnaBridge 171:3a7713b1edbc 114 * @param xfer UART DMA transfer structure. See #uart_transfer_t.
AnnaBridge 171:3a7713b1edbc 115 * @retval kStatus_Success if succeed, others failed.
AnnaBridge 171:3a7713b1edbc 116 * @retval kStatus_UART_TxBusy Previous transfer on going.
AnnaBridge 171:3a7713b1edbc 117 * @retval kStatus_InvalidArgument Invalid argument.
AnnaBridge 171:3a7713b1edbc 118 */
AnnaBridge 171:3a7713b1edbc 119 status_t UART_TransferSendDMA(UART_Type *base, uart_dma_handle_t *handle, uart_transfer_t *xfer);
AnnaBridge 171:3a7713b1edbc 120
AnnaBridge 171:3a7713b1edbc 121 /*!
AnnaBridge 171:3a7713b1edbc 122 * @brief Receives data using DMA.
AnnaBridge 171:3a7713b1edbc 123 *
AnnaBridge 171:3a7713b1edbc 124 * This function receives data using DMA. This is non-blocking function, which returns
AnnaBridge 171:3a7713b1edbc 125 * right away. When all data is received, the receive callback function is called.
AnnaBridge 171:3a7713b1edbc 126 *
AnnaBridge 171:3a7713b1edbc 127 * @param base UART peripheral base address.
AnnaBridge 171:3a7713b1edbc 128 * @param handle Pointer to uart_dma_handle_t structure.
AnnaBridge 171:3a7713b1edbc 129 * @param xfer UART DMA transfer structure. See #uart_transfer_t.
AnnaBridge 171:3a7713b1edbc 130 * @retval kStatus_Success if succeed, others failed.
AnnaBridge 171:3a7713b1edbc 131 * @retval kStatus_UART_RxBusy Previous transfer on going.
AnnaBridge 171:3a7713b1edbc 132 * @retval kStatus_InvalidArgument Invalid argument.
AnnaBridge 171:3a7713b1edbc 133 */
AnnaBridge 171:3a7713b1edbc 134 status_t UART_TransferReceiveDMA(UART_Type *base, uart_dma_handle_t *handle, uart_transfer_t *xfer);
AnnaBridge 171:3a7713b1edbc 135
AnnaBridge 171:3a7713b1edbc 136 /*!
AnnaBridge 171:3a7713b1edbc 137 * @brief Aborts the send data using DMA.
AnnaBridge 171:3a7713b1edbc 138 *
AnnaBridge 171:3a7713b1edbc 139 * This function aborts the sent data using DMA.
AnnaBridge 171:3a7713b1edbc 140 *
AnnaBridge 171:3a7713b1edbc 141 * @param base UART peripheral base address.
AnnaBridge 171:3a7713b1edbc 142 * @param handle Pointer to uart_dma_handle_t structure.
AnnaBridge 171:3a7713b1edbc 143 */
AnnaBridge 171:3a7713b1edbc 144 void UART_TransferAbortSendDMA(UART_Type *base, uart_dma_handle_t *handle);
AnnaBridge 171:3a7713b1edbc 145
AnnaBridge 171:3a7713b1edbc 146 /*!
AnnaBridge 171:3a7713b1edbc 147 * @brief Aborts the received data using DMA.
AnnaBridge 171:3a7713b1edbc 148 *
AnnaBridge 171:3a7713b1edbc 149 * This function abort receive data which using DMA.
AnnaBridge 171:3a7713b1edbc 150 *
AnnaBridge 171:3a7713b1edbc 151 * @param base UART peripheral base address.
AnnaBridge 171:3a7713b1edbc 152 * @param handle Pointer to uart_dma_handle_t structure.
AnnaBridge 171:3a7713b1edbc 153 */
AnnaBridge 171:3a7713b1edbc 154 void UART_TransferAbortReceiveDMA(UART_Type *base, uart_dma_handle_t *handle);
AnnaBridge 171:3a7713b1edbc 155
AnnaBridge 171:3a7713b1edbc 156 /*!
AnnaBridge 171:3a7713b1edbc 157 * @brief Get the number of bytes that have been written to UART TX register.
AnnaBridge 171:3a7713b1edbc 158 *
AnnaBridge 171:3a7713b1edbc 159 * This function gets the number of bytes that have been written to UART TX
AnnaBridge 171:3a7713b1edbc 160 * register by DMA.
AnnaBridge 171:3a7713b1edbc 161 *
AnnaBridge 171:3a7713b1edbc 162 * @param base UART peripheral base address.
AnnaBridge 171:3a7713b1edbc 163 * @param handle UART handle pointer.
AnnaBridge 171:3a7713b1edbc 164 * @param count Send bytes count.
AnnaBridge 171:3a7713b1edbc 165 * @retval kStatus_NoTransferInProgress No send in progress.
AnnaBridge 171:3a7713b1edbc 166 * @retval kStatus_InvalidArgument Parameter is invalid.
AnnaBridge 171:3a7713b1edbc 167 * @retval kStatus_Success Get successfully through the parameter \p count;
AnnaBridge 171:3a7713b1edbc 168 */
AnnaBridge 171:3a7713b1edbc 169 status_t UART_TransferGetSendCountDMA(UART_Type *base, uart_dma_handle_t *handle, uint32_t *count);
AnnaBridge 171:3a7713b1edbc 170
AnnaBridge 171:3a7713b1edbc 171 /*!
AnnaBridge 171:3a7713b1edbc 172 * @brief Get the number of bytes that have been received.
AnnaBridge 171:3a7713b1edbc 173 *
AnnaBridge 171:3a7713b1edbc 174 * This function gets the number of bytes that have been received.
AnnaBridge 171:3a7713b1edbc 175 *
AnnaBridge 171:3a7713b1edbc 176 * @param base UART peripheral base address.
AnnaBridge 171:3a7713b1edbc 177 * @param handle UART handle pointer.
AnnaBridge 171:3a7713b1edbc 178 * @param count Receive bytes count.
AnnaBridge 171:3a7713b1edbc 179 * @retval kStatus_NoTransferInProgress No receive in progress.
AnnaBridge 171:3a7713b1edbc 180 * @retval kStatus_InvalidArgument Parameter is invalid.
AnnaBridge 171:3a7713b1edbc 181 * @retval kStatus_Success Get successfully through the parameter \p count;
AnnaBridge 171:3a7713b1edbc 182 */
AnnaBridge 171:3a7713b1edbc 183 status_t UART_TransferGetReceiveCountDMA(UART_Type *base, uart_dma_handle_t *handle, uint32_t *count);
AnnaBridge 171:3a7713b1edbc 184
AnnaBridge 171:3a7713b1edbc 185 /*@}*/
AnnaBridge 171:3a7713b1edbc 186
AnnaBridge 171:3a7713b1edbc 187 #if defined(__cplusplus)
AnnaBridge 171:3a7713b1edbc 188 }
AnnaBridge 171:3a7713b1edbc 189 #endif
AnnaBridge 171:3a7713b1edbc 190
AnnaBridge 171:3a7713b1edbc 191 /*! @}*/
AnnaBridge 171:3a7713b1edbc 192
AnnaBridge 171:3a7713b1edbc 193 #endif /* _FSL_UART_DMA_H_ */