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