Lee Kai Xuan / mbed-os

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.

Fork of mbed-os by erkin yucel

targets/TARGET_Freescale/TARGET_KSDK2_MCUS/TARGET_KL27Z/drivers/fsl_uart_dma.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
elessair 0:f269e3021894 1 /*
elessair 0:f269e3021894 2 * Copyright (c) 2015, Freescale Semiconductor, Inc.
elessair 0:f269e3021894 3 * All rights reserved.
elessair 0:f269e3021894 4 *
elessair 0:f269e3021894 5 * Redistribution and use in source and binary forms, with or without modification,
elessair 0:f269e3021894 6 * are permitted provided that the following conditions are met:
elessair 0:f269e3021894 7 *
elessair 0:f269e3021894 8 * o Redistributions of source code must retain the above copyright notice, this list
elessair 0:f269e3021894 9 * of conditions and the following disclaimer.
elessair 0:f269e3021894 10 *
elessair 0:f269e3021894 11 * o Redistributions in binary form must reproduce the above copyright notice, this
elessair 0:f269e3021894 12 * list of conditions and the following disclaimer in the documentation and/or
elessair 0:f269e3021894 13 * other materials provided with the distribution.
elessair 0:f269e3021894 14 *
elessair 0:f269e3021894 15 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
elessair 0:f269e3021894 16 * contributors may be used to endorse or promote products derived from this
elessair 0:f269e3021894 17 * software without specific prior written permission.
elessair 0:f269e3021894 18 *
elessair 0:f269e3021894 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
elessair 0:f269e3021894 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
elessair 0:f269e3021894 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
elessair 0:f269e3021894 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
elessair 0:f269e3021894 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
elessair 0:f269e3021894 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
elessair 0:f269e3021894 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
elessair 0:f269e3021894 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
elessair 0:f269e3021894 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
elessair 0:f269e3021894 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
elessair 0:f269e3021894 29 */
elessair 0:f269e3021894 30 #ifndef _FSL_UART_DMA_H_
elessair 0:f269e3021894 31 #define _FSL_UART_DMA_H_
elessair 0:f269e3021894 32
elessair 0:f269e3021894 33 #include "fsl_uart.h"
elessair 0:f269e3021894 34 #include "fsl_dmamux.h"
elessair 0:f269e3021894 35 #include "fsl_dma.h"
elessair 0:f269e3021894 36
elessair 0:f269e3021894 37 /*!
elessair 0:f269e3021894 38 * @addtogroup uart_dma_driver
elessair 0:f269e3021894 39 * @{
elessair 0:f269e3021894 40 */
elessair 0:f269e3021894 41
elessair 0:f269e3021894 42 /*! @file*/
elessair 0:f269e3021894 43
elessair 0:f269e3021894 44 /*******************************************************************************
elessair 0:f269e3021894 45 * Definitions
elessair 0:f269e3021894 46 ******************************************************************************/
elessair 0:f269e3021894 47
elessair 0:f269e3021894 48 /* Forward declaration of the handle typedef. */
elessair 0:f269e3021894 49 typedef struct _uart_dma_handle uart_dma_handle_t;
elessair 0:f269e3021894 50
elessair 0:f269e3021894 51 /*! @brief UART transfer callback function. */
elessair 0:f269e3021894 52 typedef void (*uart_dma_transfer_callback_t)(UART_Type *base,
elessair 0:f269e3021894 53 uart_dma_handle_t *handle,
elessair 0:f269e3021894 54 status_t status,
elessair 0:f269e3021894 55 void *userData);
elessair 0:f269e3021894 56
elessair 0:f269e3021894 57 /*!
elessair 0:f269e3021894 58 * @brief UART DMA handle
elessair 0:f269e3021894 59 */
elessair 0:f269e3021894 60 struct _uart_dma_handle
elessair 0:f269e3021894 61 {
elessair 0:f269e3021894 62 UART_Type *base; /*!< UART peripheral base address. */
elessair 0:f269e3021894 63
elessair 0:f269e3021894 64 uart_dma_transfer_callback_t callback; /*!< Callback function. */
elessair 0:f269e3021894 65 void *userData; /*!< UART callback function parameter.*/
elessair 0:f269e3021894 66 size_t rxDataSizeAll; /*!< Size of the data to receive. */
elessair 0:f269e3021894 67 size_t txDataSizeAll; /*!< Size of the data to send out. */
elessair 0:f269e3021894 68
elessair 0:f269e3021894 69 dma_handle_t *txDmaHandle; /*!< The DMA TX channel used. */
elessair 0:f269e3021894 70 dma_handle_t *rxDmaHandle; /*!< The DMA RX channel used. */
elessair 0:f269e3021894 71
elessair 0:f269e3021894 72 volatile uint8_t txState; /*!< TX transfer state. */
elessair 0:f269e3021894 73 volatile uint8_t rxState; /*!< RX transfer state */
elessair 0:f269e3021894 74 };
elessair 0:f269e3021894 75
elessair 0:f269e3021894 76 /*******************************************************************************
elessair 0:f269e3021894 77 * API
elessair 0:f269e3021894 78 ******************************************************************************/
elessair 0:f269e3021894 79
elessair 0:f269e3021894 80 #if defined(__cplusplus)
elessair 0:f269e3021894 81 extern "C" {
elessair 0:f269e3021894 82 #endif
elessair 0:f269e3021894 83
elessair 0:f269e3021894 84 /*!
elessair 0:f269e3021894 85 * @name EDMA transactional
elessair 0:f269e3021894 86 * @{
elessair 0:f269e3021894 87 */
elessair 0:f269e3021894 88
elessair 0:f269e3021894 89 /*!
elessair 0:f269e3021894 90 * @brief Initializes the UART handle which is used in transactional functions and sets the callback.
elessair 0:f269e3021894 91 *
elessair 0:f269e3021894 92 * @param base UART peripheral base address.
elessair 0:f269e3021894 93 * @param handle Pointer to uart_dma_handle_t structure.
elessair 0:f269e3021894 94 * @param callback UART callback, NULL means no callback.
elessair 0:f269e3021894 95 * @param userData User callback function data.
elessair 0:f269e3021894 96 * @param rxDmaHandle User requested DMA handle for RX DMA transfer.
elessair 0:f269e3021894 97 * @param txDmaHandle User requested DMA handle for TX DMA transfer.
elessair 0:f269e3021894 98 */
elessair 0:f269e3021894 99 void UART_TransferCreateHandleDMA(UART_Type *base,
elessair 0:f269e3021894 100 uart_dma_handle_t *handle,
elessair 0:f269e3021894 101 uart_dma_transfer_callback_t callback,
elessair 0:f269e3021894 102 void *userData,
elessair 0:f269e3021894 103 dma_handle_t *txDmaHandle,
elessair 0:f269e3021894 104 dma_handle_t *rxDmaHandle);
elessair 0:f269e3021894 105
elessair 0:f269e3021894 106 /*!
elessair 0:f269e3021894 107 * @brief Sends data using DMA.
elessair 0:f269e3021894 108 *
elessair 0:f269e3021894 109 * This function sends data using DMA. This is non-blocking function, which returns
elessair 0:f269e3021894 110 * right away. When all data is sent, the send callback function is called.
elessair 0:f269e3021894 111 *
elessair 0:f269e3021894 112 * @param base UART peripheral base address.
elessair 0:f269e3021894 113 * @param handle UART handle pointer.
elessair 0:f269e3021894 114 * @param xfer UART DMA transfer structure. See #uart_transfer_t.
elessair 0:f269e3021894 115 * @retval kStatus_Success if succeed, others failed.
elessair 0:f269e3021894 116 * @retval kStatus_UART_TxBusy Previous transfer on going.
elessair 0:f269e3021894 117 * @retval kStatus_InvalidArgument Invalid argument.
elessair 0:f269e3021894 118 */
elessair 0:f269e3021894 119 status_t UART_TransferSendDMA(UART_Type *base, uart_dma_handle_t *handle, uart_transfer_t *xfer);
elessair 0:f269e3021894 120
elessair 0:f269e3021894 121 /*!
elessair 0:f269e3021894 122 * @brief Receives data using DMA.
elessair 0:f269e3021894 123 *
elessair 0:f269e3021894 124 * This function receives data using DMA. This is non-blocking function, which returns
elessair 0:f269e3021894 125 * right away. When all data is received, the receive callback function is called.
elessair 0:f269e3021894 126 *
elessair 0:f269e3021894 127 * @param base UART peripheral base address.
elessair 0:f269e3021894 128 * @param handle Pointer to uart_dma_handle_t structure.
elessair 0:f269e3021894 129 * @param xfer UART DMA transfer structure. See #uart_transfer_t.
elessair 0:f269e3021894 130 * @retval kStatus_Success if succeed, others failed.
elessair 0:f269e3021894 131 * @retval kStatus_UART_RxBusy Previous transfer on going.
elessair 0:f269e3021894 132 * @retval kStatus_InvalidArgument Invalid argument.
elessair 0:f269e3021894 133 */
elessair 0:f269e3021894 134 status_t UART_TransferReceiveDMA(UART_Type *base, uart_dma_handle_t *handle, uart_transfer_t *xfer);
elessair 0:f269e3021894 135
elessair 0:f269e3021894 136 /*!
elessair 0:f269e3021894 137 * @brief Aborts the send data using DMA.
elessair 0:f269e3021894 138 *
elessair 0:f269e3021894 139 * This function aborts the sent data using DMA.
elessair 0:f269e3021894 140 *
elessair 0:f269e3021894 141 * @param base UART peripheral base address.
elessair 0:f269e3021894 142 * @param handle Pointer to uart_dma_handle_t structure.
elessair 0:f269e3021894 143 */
elessair 0:f269e3021894 144 void UART_TransferAbortSendDMA(UART_Type *base, uart_dma_handle_t *handle);
elessair 0:f269e3021894 145
elessair 0:f269e3021894 146 /*!
elessair 0:f269e3021894 147 * @brief Aborts the received data using DMA.
elessair 0:f269e3021894 148 *
elessair 0:f269e3021894 149 * This function abort receive data which using DMA.
elessair 0:f269e3021894 150 *
elessair 0:f269e3021894 151 * @param base UART peripheral base address.
elessair 0:f269e3021894 152 * @param handle Pointer to uart_dma_handle_t structure.
elessair 0:f269e3021894 153 */
elessair 0:f269e3021894 154 void UART_TransferAbortReceiveDMA(UART_Type *base, uart_dma_handle_t *handle);
elessair 0:f269e3021894 155
elessair 0:f269e3021894 156 /*!
elessair 0:f269e3021894 157 * @brief Get the number of bytes that have been written to UART TX register.
elessair 0:f269e3021894 158 *
elessair 0:f269e3021894 159 * This function gets the number of bytes that have been written to UART TX
elessair 0:f269e3021894 160 * register by DMA.
elessair 0:f269e3021894 161 *
elessair 0:f269e3021894 162 * @param base UART peripheral base address.
elessair 0:f269e3021894 163 * @param handle UART handle pointer.
elessair 0:f269e3021894 164 * @param count Send bytes count.
elessair 0:f269e3021894 165 * @retval kStatus_NoTransferInProgress No send in progress.
elessair 0:f269e3021894 166 * @retval kStatus_InvalidArgument Parameter is invalid.
elessair 0:f269e3021894 167 * @retval kStatus_Success Get successfully through the parameter \p count;
elessair 0:f269e3021894 168 */
elessair 0:f269e3021894 169 status_t UART_TransferGetSendCountDMA(UART_Type *base, uart_dma_handle_t *handle, uint32_t *count);
elessair 0:f269e3021894 170
elessair 0:f269e3021894 171 /*!
elessair 0:f269e3021894 172 * @brief Get the number of bytes that have been received.
elessair 0:f269e3021894 173 *
elessair 0:f269e3021894 174 * This function gets the number of bytes that have been received.
elessair 0:f269e3021894 175 *
elessair 0:f269e3021894 176 * @param base UART peripheral base address.
elessair 0:f269e3021894 177 * @param handle UART handle pointer.
elessair 0:f269e3021894 178 * @param count Receive bytes count.
elessair 0:f269e3021894 179 * @retval kStatus_NoTransferInProgress No receive in progress.
elessair 0:f269e3021894 180 * @retval kStatus_InvalidArgument Parameter is invalid.
elessair 0:f269e3021894 181 * @retval kStatus_Success Get successfully through the parameter \p count;
elessair 0:f269e3021894 182 */
elessair 0:f269e3021894 183 status_t UART_TransferGetReceiveCountDMA(UART_Type *base, uart_dma_handle_t *handle, uint32_t *count);
elessair 0:f269e3021894 184
elessair 0:f269e3021894 185 /*@}*/
elessair 0:f269e3021894 186
elessair 0:f269e3021894 187 #if defined(__cplusplus)
elessair 0:f269e3021894 188 }
elessair 0:f269e3021894 189 #endif
elessair 0:f269e3021894 190
elessair 0:f269e3021894 191 /*! @}*/
elessair 0:f269e3021894 192
elessair 0:f269e3021894 193 #endif /* _FSL_UART_DMA_H_ */