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_UBRIDGE/TOOLCHAIN_IAR/fsl_flexio_spi_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?
User | Revision | Line number | New 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_FLEXIO_SPI_EDMA_H_ |
AnnaBridge | 145:64910690c574 | 31 | #define _FSL_FLEXIO_SPI_EDMA_H_ |
AnnaBridge | 145:64910690c574 | 32 | |
AnnaBridge | 145:64910690c574 | 33 | #include "fsl_flexio_spi.h" |
AnnaBridge | 145:64910690c574 | 34 | #include "fsl_edma.h" |
AnnaBridge | 145:64910690c574 | 35 | |
AnnaBridge | 145:64910690c574 | 36 | /*! |
AnnaBridge | 145:64910690c574 | 37 | * @addtogroup flexio_edma_spi |
AnnaBridge | 145:64910690c574 | 38 | * @{ |
AnnaBridge | 145:64910690c574 | 39 | */ |
AnnaBridge | 145:64910690c574 | 40 | |
AnnaBridge | 145:64910690c574 | 41 | /******************************************************************************* |
AnnaBridge | 145:64910690c574 | 42 | * Definitions |
AnnaBridge | 145:64910690c574 | 43 | ******************************************************************************/ |
AnnaBridge | 145:64910690c574 | 44 | |
AnnaBridge | 145:64910690c574 | 45 | /*! @brief typedef for flexio_spi_master_edma_handle_t in advance. */ |
AnnaBridge | 145:64910690c574 | 46 | typedef struct _flexio_spi_master_edma_handle flexio_spi_master_edma_handle_t; |
AnnaBridge | 145:64910690c574 | 47 | |
AnnaBridge | 145:64910690c574 | 48 | /*! @brief Slave handle is the same with master handle. */ |
AnnaBridge | 145:64910690c574 | 49 | typedef flexio_spi_master_edma_handle_t flexio_spi_slave_edma_handle_t; |
AnnaBridge | 145:64910690c574 | 50 | |
AnnaBridge | 145:64910690c574 | 51 | /*! @brief FlexIO SPI master callback for finished transmit */ |
AnnaBridge | 145:64910690c574 | 52 | typedef void (*flexio_spi_master_edma_transfer_callback_t)(FLEXIO_SPI_Type *base, |
AnnaBridge | 145:64910690c574 | 53 | flexio_spi_master_edma_handle_t *handle, |
AnnaBridge | 145:64910690c574 | 54 | status_t status, |
AnnaBridge | 145:64910690c574 | 55 | void *userData); |
AnnaBridge | 145:64910690c574 | 56 | |
AnnaBridge | 145:64910690c574 | 57 | /*! @brief FlexIO SPI slave callback for finished transmit */ |
AnnaBridge | 145:64910690c574 | 58 | typedef void (*flexio_spi_slave_edma_transfer_callback_t)(FLEXIO_SPI_Type *base, |
AnnaBridge | 145:64910690c574 | 59 | flexio_spi_slave_edma_handle_t *handle, |
AnnaBridge | 145:64910690c574 | 60 | status_t status, |
AnnaBridge | 145:64910690c574 | 61 | void *userData); |
AnnaBridge | 145:64910690c574 | 62 | |
AnnaBridge | 145:64910690c574 | 63 | /*! @brief FlexIO SPI eDMA transfer handle, users should not touch the content of the handle.*/ |
AnnaBridge | 145:64910690c574 | 64 | struct _flexio_spi_master_edma_handle |
AnnaBridge | 145:64910690c574 | 65 | { |
AnnaBridge | 145:64910690c574 | 66 | size_t transferSize; /*!< Total bytes to be transferred. */ |
AnnaBridge | 145:64910690c574 | 67 | uint8_t nbytes; /*!< eDMA minor byte transfer count initially configured. */ |
AnnaBridge | 145:64910690c574 | 68 | bool txInProgress; /*!< Send transfer in progress */ |
AnnaBridge | 145:64910690c574 | 69 | bool rxInProgress; /*!< Receive transfer in progress */ |
AnnaBridge | 145:64910690c574 | 70 | edma_handle_t *txHandle; /*!< DMA handler for SPI send */ |
AnnaBridge | 145:64910690c574 | 71 | edma_handle_t *rxHandle; /*!< DMA handler for SPI receive */ |
AnnaBridge | 145:64910690c574 | 72 | flexio_spi_master_edma_transfer_callback_t callback; /*!< Callback for SPI DMA transfer */ |
AnnaBridge | 145:64910690c574 | 73 | void *userData; /*!< User Data for SPI DMA callback */ |
AnnaBridge | 145:64910690c574 | 74 | }; |
AnnaBridge | 145:64910690c574 | 75 | |
AnnaBridge | 145:64910690c574 | 76 | /******************************************************************************* |
AnnaBridge | 145:64910690c574 | 77 | * APIs |
AnnaBridge | 145:64910690c574 | 78 | ******************************************************************************/ |
AnnaBridge | 145:64910690c574 | 79 | #if defined(__cplusplus) |
AnnaBridge | 145:64910690c574 | 80 | extern "C" { |
AnnaBridge | 145:64910690c574 | 81 | #endif |
AnnaBridge | 145:64910690c574 | 82 | |
AnnaBridge | 145:64910690c574 | 83 | /*! |
AnnaBridge | 145:64910690c574 | 84 | * @name eDMA Transactional |
AnnaBridge | 145:64910690c574 | 85 | * @{ |
AnnaBridge | 145:64910690c574 | 86 | */ |
AnnaBridge | 145:64910690c574 | 87 | |
AnnaBridge | 145:64910690c574 | 88 | /*! |
AnnaBridge | 145:64910690c574 | 89 | * @brief Initializes the FlexIO SPI master eDMA handle. |
AnnaBridge | 145:64910690c574 | 90 | * |
AnnaBridge | 145:64910690c574 | 91 | * This function initializes the FlexIO SPI master eDMA handle which can be used for other FlexIO SPI master transactional |
AnnaBridge | 145:64910690c574 | 92 | * APIs. |
AnnaBridge | 145:64910690c574 | 93 | * For a specified FlexIO SPI instance, call this API once to get the initialized handle. |
AnnaBridge | 145:64910690c574 | 94 | * |
AnnaBridge | 145:64910690c574 | 95 | * @param base Pointer to FLEXIO_SPI_Type structure. |
AnnaBridge | 145:64910690c574 | 96 | * @param handle Pointer to flexio_spi_master_edma_handle_t structure to store the transfer state. |
AnnaBridge | 145:64910690c574 | 97 | * @param callback SPI callback, NULL means no callback. |
AnnaBridge | 145:64910690c574 | 98 | * @param userData callback function parameter. |
AnnaBridge | 145:64910690c574 | 99 | * @param txHandle User requested eDMA handle for FlexIO SPI RX eDMA transfer. |
AnnaBridge | 145:64910690c574 | 100 | * @param rxHandle User requested eDMA handle for FlexIO SPI TX eDMA transfer. |
AnnaBridge | 145:64910690c574 | 101 | * @retval kStatus_Success Successfully create the handle. |
AnnaBridge | 145:64910690c574 | 102 | * @retval kStatus_OutOfRange The FlexIO SPI eDMA type/handle table out of range. |
AnnaBridge | 145:64910690c574 | 103 | */ |
AnnaBridge | 145:64910690c574 | 104 | status_t FLEXIO_SPI_MasterTransferCreateHandleEDMA(FLEXIO_SPI_Type *base, |
AnnaBridge | 145:64910690c574 | 105 | flexio_spi_master_edma_handle_t *handle, |
AnnaBridge | 145:64910690c574 | 106 | flexio_spi_master_edma_transfer_callback_t callback, |
AnnaBridge | 145:64910690c574 | 107 | void *userData, |
AnnaBridge | 145:64910690c574 | 108 | edma_handle_t *txHandle, |
AnnaBridge | 145:64910690c574 | 109 | edma_handle_t *rxHandle); |
AnnaBridge | 145:64910690c574 | 110 | |
AnnaBridge | 145:64910690c574 | 111 | /*! |
AnnaBridge | 145:64910690c574 | 112 | * @brief Performs a non-blocking FlexIO SPI transfer using eDMA. |
AnnaBridge | 145:64910690c574 | 113 | * |
AnnaBridge | 145:64910690c574 | 114 | * @note This interface returns immediately after transfer initiates. Call |
AnnaBridge | 145:64910690c574 | 115 | * FLEXIO_SPI_MasterGetTransferCountEDMA to poll the transfer status and check |
AnnaBridge | 145:64910690c574 | 116 | * whether the FlexIO SPI transfer is finished. |
AnnaBridge | 145:64910690c574 | 117 | * |
AnnaBridge | 145:64910690c574 | 118 | * @param base Pointer to FLEXIO_SPI_Type structure. |
AnnaBridge | 145:64910690c574 | 119 | * @param handle Pointer to flexio_spi_master_edma_handle_t structure to store the transfer state. |
AnnaBridge | 145:64910690c574 | 120 | * @param xfer Pointer to FlexIO SPI transfer structure. |
AnnaBridge | 145:64910690c574 | 121 | * @retval kStatus_Success Successfully start a transfer. |
AnnaBridge | 145:64910690c574 | 122 | * @retval kStatus_InvalidArgument Input argument is invalid. |
AnnaBridge | 145:64910690c574 | 123 | * @retval kStatus_FLEXIO_SPI_Busy FlexIO SPI is not idle, is running another transfer. |
AnnaBridge | 145:64910690c574 | 124 | */ |
AnnaBridge | 145:64910690c574 | 125 | status_t FLEXIO_SPI_MasterTransferEDMA(FLEXIO_SPI_Type *base, |
AnnaBridge | 145:64910690c574 | 126 | flexio_spi_master_edma_handle_t *handle, |
AnnaBridge | 145:64910690c574 | 127 | flexio_spi_transfer_t *xfer); |
AnnaBridge | 145:64910690c574 | 128 | |
AnnaBridge | 145:64910690c574 | 129 | /*! |
AnnaBridge | 145:64910690c574 | 130 | * @brief Aborts a FlexIO SPI transfer using eDMA. |
AnnaBridge | 145:64910690c574 | 131 | * |
AnnaBridge | 145:64910690c574 | 132 | * @param base Pointer to FLEXIO_SPI_Type structure. |
AnnaBridge | 145:64910690c574 | 133 | * @param handle FlexIO SPI eDMA handle pointer. |
AnnaBridge | 145:64910690c574 | 134 | */ |
AnnaBridge | 145:64910690c574 | 135 | void FLEXIO_SPI_MasterTransferAbortEDMA(FLEXIO_SPI_Type *base, flexio_spi_master_edma_handle_t *handle); |
AnnaBridge | 145:64910690c574 | 136 | |
AnnaBridge | 145:64910690c574 | 137 | /*! |
AnnaBridge | 145:64910690c574 | 138 | * @brief Gets the remaining bytes for FlexIO SPI eDMA transfer. |
AnnaBridge | 145:64910690c574 | 139 | * |
AnnaBridge | 145:64910690c574 | 140 | * @param base Pointer to FLEXIO_SPI_Type structure. |
AnnaBridge | 145:64910690c574 | 141 | * @param handle FlexIO SPI eDMA handle pointer. |
AnnaBridge | 145:64910690c574 | 142 | * @param count Number of bytes transferred so far by the non-blocking transaction. |
AnnaBridge | 145:64910690c574 | 143 | */ |
AnnaBridge | 145:64910690c574 | 144 | status_t FLEXIO_SPI_MasterTransferGetCountEDMA(FLEXIO_SPI_Type *base, |
AnnaBridge | 145:64910690c574 | 145 | flexio_spi_master_edma_handle_t *handle, |
AnnaBridge | 145:64910690c574 | 146 | size_t *count); |
AnnaBridge | 145:64910690c574 | 147 | |
AnnaBridge | 145:64910690c574 | 148 | /*! |
AnnaBridge | 145:64910690c574 | 149 | * @brief Initializes the FlexIO SPI slave eDMA handle. |
AnnaBridge | 145:64910690c574 | 150 | * |
AnnaBridge | 145:64910690c574 | 151 | * This function initializes the FlexIO SPI slave eDMA handle. |
AnnaBridge | 145:64910690c574 | 152 | * |
AnnaBridge | 145:64910690c574 | 153 | * @param base Pointer to FLEXIO_SPI_Type structure. |
AnnaBridge | 145:64910690c574 | 154 | * @param handle Pointer to flexio_spi_slave_edma_handle_t structure to store the transfer state. |
AnnaBridge | 145:64910690c574 | 155 | * @param callback SPI callback, NULL means no callback. |
AnnaBridge | 145:64910690c574 | 156 | * @param userData callback function parameter. |
AnnaBridge | 145:64910690c574 | 157 | * @param txHandle User requested eDMA handle for FlexIO SPI TX eDMA transfer. |
AnnaBridge | 145:64910690c574 | 158 | * @param rxHandle User requested eDMA handle for FlexIO SPI RX eDMA transfer. |
AnnaBridge | 145:64910690c574 | 159 | */ |
AnnaBridge | 145:64910690c574 | 160 | static inline void FLEXIO_SPI_SlaveTransferCreateHandleEDMA(FLEXIO_SPI_Type *base, |
AnnaBridge | 145:64910690c574 | 161 | flexio_spi_slave_edma_handle_t *handle, |
AnnaBridge | 145:64910690c574 | 162 | flexio_spi_slave_edma_transfer_callback_t callback, |
AnnaBridge | 145:64910690c574 | 163 | void *userData, |
AnnaBridge | 145:64910690c574 | 164 | edma_handle_t *txHandle, |
AnnaBridge | 145:64910690c574 | 165 | edma_handle_t *rxHandle) |
AnnaBridge | 145:64910690c574 | 166 | { |
AnnaBridge | 145:64910690c574 | 167 | FLEXIO_SPI_MasterTransferCreateHandleEDMA(base, handle, callback, userData, txHandle, rxHandle); |
AnnaBridge | 145:64910690c574 | 168 | } |
AnnaBridge | 145:64910690c574 | 169 | |
AnnaBridge | 145:64910690c574 | 170 | /*! |
AnnaBridge | 145:64910690c574 | 171 | * @brief Performs a non-blocking FlexIO SPI transfer using eDMA. |
AnnaBridge | 145:64910690c574 | 172 | * |
AnnaBridge | 145:64910690c574 | 173 | * @note This interface returns immediately after transfer initiates. Call |
AnnaBridge | 145:64910690c574 | 174 | * FLEXIO_SPI_SlaveGetTransferCountEDMA to poll the transfer status and |
AnnaBridge | 145:64910690c574 | 175 | * check whether the FlexIO SPI transfer is finished. |
AnnaBridge | 145:64910690c574 | 176 | * |
AnnaBridge | 145:64910690c574 | 177 | * @param base Pointer to FLEXIO_SPI_Type structure. |
AnnaBridge | 145:64910690c574 | 178 | * @param handle Pointer to flexio_spi_slave_edma_handle_t structure to store the transfer state. |
AnnaBridge | 145:64910690c574 | 179 | * @param xfer Pointer to FlexIO SPI transfer structure. |
AnnaBridge | 145:64910690c574 | 180 | * @retval kStatus_Success Successfully start a transfer. |
AnnaBridge | 145:64910690c574 | 181 | * @retval kStatus_InvalidArgument Input argument is invalid. |
AnnaBridge | 145:64910690c574 | 182 | * @retval kStatus_FLEXIO_SPI_Busy FlexIO SPI is not idle, is running another transfer. |
AnnaBridge | 145:64910690c574 | 183 | */ |
AnnaBridge | 145:64910690c574 | 184 | status_t FLEXIO_SPI_SlaveTransferEDMA(FLEXIO_SPI_Type *base, |
AnnaBridge | 145:64910690c574 | 185 | flexio_spi_slave_edma_handle_t *handle, |
AnnaBridge | 145:64910690c574 | 186 | flexio_spi_transfer_t *xfer); |
AnnaBridge | 145:64910690c574 | 187 | |
AnnaBridge | 145:64910690c574 | 188 | /*! |
AnnaBridge | 145:64910690c574 | 189 | * @brief Aborts a FlexIO SPI transfer using eDMA. |
AnnaBridge | 145:64910690c574 | 190 | * |
AnnaBridge | 145:64910690c574 | 191 | * @param base Pointer to FLEXIO_SPI_Type structure. |
AnnaBridge | 145:64910690c574 | 192 | * @param handle Pointer to flexio_spi_slave_edma_handle_t structure to store the transfer state. |
AnnaBridge | 145:64910690c574 | 193 | */ |
AnnaBridge | 145:64910690c574 | 194 | static inline void FLEXIO_SPI_SlaveTransferAbortEDMA(FLEXIO_SPI_Type *base, flexio_spi_slave_edma_handle_t *handle) |
AnnaBridge | 145:64910690c574 | 195 | { |
AnnaBridge | 145:64910690c574 | 196 | FLEXIO_SPI_MasterTransferAbortEDMA(base, handle); |
AnnaBridge | 145:64910690c574 | 197 | } |
AnnaBridge | 145:64910690c574 | 198 | |
AnnaBridge | 145:64910690c574 | 199 | /*! |
AnnaBridge | 145:64910690c574 | 200 | * @brief Gets the remaining bytes to be transferred for FlexIO SPI eDMA. |
AnnaBridge | 145:64910690c574 | 201 | * |
AnnaBridge | 145:64910690c574 | 202 | * @param base Pointer to FLEXIO_SPI_Type structure. |
AnnaBridge | 145:64910690c574 | 203 | * @param handle FlexIO SPI eDMA handle pointer. |
AnnaBridge | 145:64910690c574 | 204 | * @param count Number of bytes transferred so far by the non-blocking transaction. |
AnnaBridge | 145:64910690c574 | 205 | */ |
AnnaBridge | 145:64910690c574 | 206 | static inline status_t FLEXIO_SPI_SlaveTransferGetCountEDMA(FLEXIO_SPI_Type *base, |
AnnaBridge | 145:64910690c574 | 207 | flexio_spi_slave_edma_handle_t *handle, |
AnnaBridge | 145:64910690c574 | 208 | size_t *count) |
AnnaBridge | 145:64910690c574 | 209 | { |
AnnaBridge | 145:64910690c574 | 210 | return FLEXIO_SPI_MasterTransferGetCountEDMA(base, handle, count); |
AnnaBridge | 145:64910690c574 | 211 | } |
AnnaBridge | 145:64910690c574 | 212 | |
AnnaBridge | 145:64910690c574 | 213 | /*! @} */ |
AnnaBridge | 145:64910690c574 | 214 | |
AnnaBridge | 145:64910690c574 | 215 | #if defined(__cplusplus) |
AnnaBridge | 145:64910690c574 | 216 | } |
AnnaBridge | 145:64910690c574 | 217 | #endif |
AnnaBridge | 145:64910690c574 | 218 | |
AnnaBridge | 145:64910690c574 | 219 | /*! |
AnnaBridge | 145:64910690c574 | 220 | * @} |
AnnaBridge | 145:64910690c574 | 221 | */ |
AnnaBridge | 145:64910690c574 | 222 | #endif |