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_IAR/fsl_flexio_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?
User | Revision | Line number | New 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_FLEXIO_UART_DMA_H_ |
AnnaBridge | 171:3a7713b1edbc | 31 | #define _FSL_FLEXIO_UART_DMA_H_ |
AnnaBridge | 171:3a7713b1edbc | 32 | |
AnnaBridge | 171:3a7713b1edbc | 33 | #include "fsl_flexio_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 flexio_dma_uart |
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 _flexio_uart_dma_handle flexio_uart_dma_handle_t; |
AnnaBridge | 171:3a7713b1edbc | 50 | |
AnnaBridge | 171:3a7713b1edbc | 51 | /*! @brief UART transfer callback function. */ |
AnnaBridge | 171:3a7713b1edbc | 52 | typedef void (*flexio_uart_dma_transfer_callback_t)(FLEXIO_UART_Type *base, |
AnnaBridge | 171:3a7713b1edbc | 53 | flexio_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 _flexio_uart_dma_handle |
AnnaBridge | 171:3a7713b1edbc | 61 | { |
AnnaBridge | 171:3a7713b1edbc | 62 | flexio_uart_dma_transfer_callback_t callback; /*!< Callback function. */ |
AnnaBridge | 171:3a7713b1edbc | 63 | void *userData; /*!< UART callback function parameter.*/ |
AnnaBridge | 171:3a7713b1edbc | 64 | |
AnnaBridge | 171:3a7713b1edbc | 65 | size_t txSize; /*!< Total bytes to be sent. */ |
AnnaBridge | 171:3a7713b1edbc | 66 | size_t rxSize; /*!< Total bytes to be received. */ |
AnnaBridge | 171:3a7713b1edbc | 67 | |
AnnaBridge | 171:3a7713b1edbc | 68 | dma_handle_t *txDmaHandle; /*!< The DMA TX channel used. */ |
AnnaBridge | 171:3a7713b1edbc | 69 | dma_handle_t *rxDmaHandle; /*!< The DMA RX channel used. */ |
AnnaBridge | 171:3a7713b1edbc | 70 | |
AnnaBridge | 171:3a7713b1edbc | 71 | volatile uint8_t txState; /*!< TX transfer state. */ |
AnnaBridge | 171:3a7713b1edbc | 72 | volatile uint8_t rxState; /*!< RX transfer state */ |
AnnaBridge | 171:3a7713b1edbc | 73 | }; |
AnnaBridge | 171:3a7713b1edbc | 74 | |
AnnaBridge | 171:3a7713b1edbc | 75 | /******************************************************************************* |
AnnaBridge | 171:3a7713b1edbc | 76 | * API |
AnnaBridge | 171:3a7713b1edbc | 77 | ******************************************************************************/ |
AnnaBridge | 171:3a7713b1edbc | 78 | |
AnnaBridge | 171:3a7713b1edbc | 79 | #if defined(__cplusplus) |
AnnaBridge | 171:3a7713b1edbc | 80 | extern "C" { |
AnnaBridge | 171:3a7713b1edbc | 81 | #endif |
AnnaBridge | 171:3a7713b1edbc | 82 | |
AnnaBridge | 171:3a7713b1edbc | 83 | /*! |
AnnaBridge | 171:3a7713b1edbc | 84 | * @name eDMA transactional |
AnnaBridge | 171:3a7713b1edbc | 85 | * @{ |
AnnaBridge | 171:3a7713b1edbc | 86 | */ |
AnnaBridge | 171:3a7713b1edbc | 87 | |
AnnaBridge | 171:3a7713b1edbc | 88 | /*! |
AnnaBridge | 171:3a7713b1edbc | 89 | * @brief Initializes the FLEXIO_UART handle which is used in transactional functions |
AnnaBridge | 171:3a7713b1edbc | 90 | * |
AnnaBridge | 171:3a7713b1edbc | 91 | * @param base Pointer to FLEXIO_UART_Type structure. |
AnnaBridge | 171:3a7713b1edbc | 92 | * @param handle Pointer to flexio_uart_dma_handle_t structure. |
AnnaBridge | 171:3a7713b1edbc | 93 | * @param callback FlexIO UART callback, NULL means no callback. |
AnnaBridge | 171:3a7713b1edbc | 94 | * @param userData User callback function data. |
AnnaBridge | 171:3a7713b1edbc | 95 | * @param txDmaHandle User requested DMA handle for TX DMA transfer. |
AnnaBridge | 171:3a7713b1edbc | 96 | * @param rxDmaHandle User requested DMA handle for RX DMA transfer. |
AnnaBridge | 171:3a7713b1edbc | 97 | * @retval kStatus_Success Successfully create the handle. |
AnnaBridge | 171:3a7713b1edbc | 98 | * @retval kStatus_OutOfRange The FlexIO UART DMA type/handle table out of range. |
AnnaBridge | 171:3a7713b1edbc | 99 | */ |
AnnaBridge | 171:3a7713b1edbc | 100 | status_t FLEXIO_UART_TransferCreateHandleDMA(FLEXIO_UART_Type *base, |
AnnaBridge | 171:3a7713b1edbc | 101 | flexio_uart_dma_handle_t *handle, |
AnnaBridge | 171:3a7713b1edbc | 102 | flexio_uart_dma_transfer_callback_t callback, |
AnnaBridge | 171:3a7713b1edbc | 103 | void *userData, |
AnnaBridge | 171:3a7713b1edbc | 104 | dma_handle_t *txDmaHandle, |
AnnaBridge | 171:3a7713b1edbc | 105 | dma_handle_t *rxDmaHandle); |
AnnaBridge | 171:3a7713b1edbc | 106 | |
AnnaBridge | 171:3a7713b1edbc | 107 | /*! |
AnnaBridge | 171:3a7713b1edbc | 108 | * @brief Sends data using DMA. |
AnnaBridge | 171:3a7713b1edbc | 109 | * |
AnnaBridge | 171:3a7713b1edbc | 110 | * This function send data using DMA, this is non-blocking function, which return |
AnnaBridge | 171:3a7713b1edbc | 111 | * right away. When all data have been sent out, the send callback function is called. |
AnnaBridge | 171:3a7713b1edbc | 112 | * |
AnnaBridge | 171:3a7713b1edbc | 113 | * @param base Pointer to FLEXIO_UART_Type structure |
AnnaBridge | 171:3a7713b1edbc | 114 | * @param handle Pointer to flexio_uart_dma_handle_t structure |
AnnaBridge | 171:3a7713b1edbc | 115 | * @param xfer FLEXIO_UART DMA transfer structure, refer to #flexio_uart_transfer_t. |
AnnaBridge | 171:3a7713b1edbc | 116 | * @retval kStatus_Success if succeed, others failed. |
AnnaBridge | 171:3a7713b1edbc | 117 | * @retval kStatus_FLEXIO_UART_TxBusy Previous transfer on going. |
AnnaBridge | 171:3a7713b1edbc | 118 | */ |
AnnaBridge | 171:3a7713b1edbc | 119 | status_t FLEXIO_UART_TransferSendDMA(FLEXIO_UART_Type *base, |
AnnaBridge | 171:3a7713b1edbc | 120 | flexio_uart_dma_handle_t *handle, |
AnnaBridge | 171:3a7713b1edbc | 121 | flexio_uart_transfer_t *xfer); |
AnnaBridge | 171:3a7713b1edbc | 122 | |
AnnaBridge | 171:3a7713b1edbc | 123 | /*! |
AnnaBridge | 171:3a7713b1edbc | 124 | * @brief Receives data using DMA. |
AnnaBridge | 171:3a7713b1edbc | 125 | * |
AnnaBridge | 171:3a7713b1edbc | 126 | * This function receives data using DMA. This is non-blocking function, which returns |
AnnaBridge | 171:3a7713b1edbc | 127 | * right away. When all data have been received, the receive callback function is called. |
AnnaBridge | 171:3a7713b1edbc | 128 | * |
AnnaBridge | 171:3a7713b1edbc | 129 | * @param base Pointer to FLEXIO_UART_Type structure |
AnnaBridge | 171:3a7713b1edbc | 130 | * @param handle Pointer to flexio_uart_dma_handle_t structure |
AnnaBridge | 171:3a7713b1edbc | 131 | * @param xfer FLEXIO_UART DMA transfer sturcture, refer to #flexio_uart_transfer_t. |
AnnaBridge | 171:3a7713b1edbc | 132 | * @retval kStatus_Success if succeed, others failed. |
AnnaBridge | 171:3a7713b1edbc | 133 | * @retval kStatus_FLEXIO_UART_RxBusy Previous transfer on going. |
AnnaBridge | 171:3a7713b1edbc | 134 | */ |
AnnaBridge | 171:3a7713b1edbc | 135 | status_t FLEXIO_UART_TransferReceiveDMA(FLEXIO_UART_Type *base, |
AnnaBridge | 171:3a7713b1edbc | 136 | flexio_uart_dma_handle_t *handle, |
AnnaBridge | 171:3a7713b1edbc | 137 | flexio_uart_transfer_t *xfer); |
AnnaBridge | 171:3a7713b1edbc | 138 | |
AnnaBridge | 171:3a7713b1edbc | 139 | /*! |
AnnaBridge | 171:3a7713b1edbc | 140 | * @brief Aborts the sent data which using DMA. |
AnnaBridge | 171:3a7713b1edbc | 141 | * |
AnnaBridge | 171:3a7713b1edbc | 142 | * This function aborts the sent data which using DMA. |
AnnaBridge | 171:3a7713b1edbc | 143 | * |
AnnaBridge | 171:3a7713b1edbc | 144 | * @param base Pointer to FLEXIO_UART_Type structure |
AnnaBridge | 171:3a7713b1edbc | 145 | * @param handle Pointer to flexio_uart_dma_handle_t structure |
AnnaBridge | 171:3a7713b1edbc | 146 | */ |
AnnaBridge | 171:3a7713b1edbc | 147 | void FLEXIO_UART_TransferAbortSendDMA(FLEXIO_UART_Type *base, flexio_uart_dma_handle_t *handle); |
AnnaBridge | 171:3a7713b1edbc | 148 | |
AnnaBridge | 171:3a7713b1edbc | 149 | /*! |
AnnaBridge | 171:3a7713b1edbc | 150 | * @brief Aborts the receive data which using DMA. |
AnnaBridge | 171:3a7713b1edbc | 151 | * |
AnnaBridge | 171:3a7713b1edbc | 152 | * This function aborts the receive data which using DMA. |
AnnaBridge | 171:3a7713b1edbc | 153 | * |
AnnaBridge | 171:3a7713b1edbc | 154 | * @param base Pointer to FLEXIO_UART_Type structure |
AnnaBridge | 171:3a7713b1edbc | 155 | * @param handle Pointer to flexio_uart_dma_handle_t structure |
AnnaBridge | 171:3a7713b1edbc | 156 | */ |
AnnaBridge | 171:3a7713b1edbc | 157 | void FLEXIO_UART_TransferAbortReceiveDMA(FLEXIO_UART_Type *base, flexio_uart_dma_handle_t *handle); |
AnnaBridge | 171:3a7713b1edbc | 158 | |
AnnaBridge | 171:3a7713b1edbc | 159 | /*! |
AnnaBridge | 171:3a7713b1edbc | 160 | * @brief Gets the number of bytes still not sent out. |
AnnaBridge | 171:3a7713b1edbc | 161 | * |
AnnaBridge | 171:3a7713b1edbc | 162 | * This function gets the number of bytes still not sent out. |
AnnaBridge | 171:3a7713b1edbc | 163 | * |
AnnaBridge | 171:3a7713b1edbc | 164 | * @param base Pointer to FLEXIO_UART_Type structure |
AnnaBridge | 171:3a7713b1edbc | 165 | * @param handle Pointer to flexio_uart_dma_handle_t structure |
AnnaBridge | 171:3a7713b1edbc | 166 | * @param count Number of bytes sent so far by the non-blocking transaction. |
AnnaBridge | 171:3a7713b1edbc | 167 | */ |
AnnaBridge | 171:3a7713b1edbc | 168 | status_t FLEXIO_UART_TransferGetSendCountDMA(FLEXIO_UART_Type *base, flexio_uart_dma_handle_t *handle, size_t *count); |
AnnaBridge | 171:3a7713b1edbc | 169 | |
AnnaBridge | 171:3a7713b1edbc | 170 | /*! |
AnnaBridge | 171:3a7713b1edbc | 171 | * @brief Gets the number of bytes still not received. |
AnnaBridge | 171:3a7713b1edbc | 172 | * |
AnnaBridge | 171:3a7713b1edbc | 173 | * This function gets the number of bytes still not received. |
AnnaBridge | 171:3a7713b1edbc | 174 | * |
AnnaBridge | 171:3a7713b1edbc | 175 | * @param base Pointer to FLEXIO_UART_Type structure |
AnnaBridge | 171:3a7713b1edbc | 176 | * @param handle Pointer to flexio_uart_dma_handle_t structure |
AnnaBridge | 171:3a7713b1edbc | 177 | * @param count Number of bytes received so far by the non-blocking transaction. |
AnnaBridge | 171:3a7713b1edbc | 178 | */ |
AnnaBridge | 171:3a7713b1edbc | 179 | status_t FLEXIO_UART_TransferGetReceiveCountDMA(FLEXIO_UART_Type *base, |
AnnaBridge | 171:3a7713b1edbc | 180 | flexio_uart_dma_handle_t *handle, |
AnnaBridge | 171:3a7713b1edbc | 181 | size_t *count); |
AnnaBridge | 171:3a7713b1edbc | 182 | |
AnnaBridge | 171:3a7713b1edbc | 183 | /*@}*/ |
AnnaBridge | 171:3a7713b1edbc | 184 | |
AnnaBridge | 171:3a7713b1edbc | 185 | #if defined(__cplusplus) |
AnnaBridge | 171:3a7713b1edbc | 186 | } |
AnnaBridge | 171:3a7713b1edbc | 187 | #endif |
AnnaBridge | 171:3a7713b1edbc | 188 | |
AnnaBridge | 171:3a7713b1edbc | 189 | /*! @}*/ |
AnnaBridge | 171:3a7713b1edbc | 190 | |
AnnaBridge | 171:3a7713b1edbc | 191 | #endif /* _FSL_UART_DMA_H_ */ |