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_LPC546XX/TOOLCHAIN_ARM_STD/fsl_usart_dma.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
mbed library. Release version 164

Who changed what in which revision?

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