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