mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

cmsis/BUILD/mbed/TARGET_K82F/TOOLCHAIN_IAR/fsl_flexio_spi_edma.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 189:f392fc9709a3 1 /*
AnnaBridge 189:f392fc9709a3 2 * Copyright (c) 2015, Freescale Semiconductor, Inc.
AnnaBridge 189:f392fc9709a3 3 * All rights reserved.
AnnaBridge 189:f392fc9709a3 4 *
AnnaBridge 189:f392fc9709a3 5 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 189:f392fc9709a3 6 * are permitted provided that the following conditions are met:
AnnaBridge 189:f392fc9709a3 7 *
AnnaBridge 189:f392fc9709a3 8 * o Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 189:f392fc9709a3 9 * of conditions and the following disclaimer.
AnnaBridge 189:f392fc9709a3 10 *
AnnaBridge 189:f392fc9709a3 11 * o Redistributions in binary form must reproduce the above copyright notice, this
AnnaBridge 189:f392fc9709a3 12 * list of conditions and the following disclaimer in the documentation and/or
AnnaBridge 189:f392fc9709a3 13 * other materials provided with the distribution.
AnnaBridge 189:f392fc9709a3 14 *
AnnaBridge 189:f392fc9709a3 15 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
AnnaBridge 189:f392fc9709a3 16 * contributors may be used to endorse or promote products derived from this
AnnaBridge 189:f392fc9709a3 17 * software without specific prior written permission.
AnnaBridge 189:f392fc9709a3 18 *
AnnaBridge 189:f392fc9709a3 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 189:f392fc9709a3 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 189:f392fc9709a3 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 189:f392fc9709a3 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 189:f392fc9709a3 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 189:f392fc9709a3 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 189:f392fc9709a3 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 189:f392fc9709a3 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 189:f392fc9709a3 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 189:f392fc9709a3 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 189:f392fc9709a3 29 */
AnnaBridge 189:f392fc9709a3 30 #ifndef _FSL_FLEXIO_SPI_EDMA_H_
AnnaBridge 189:f392fc9709a3 31 #define _FSL_FLEXIO_SPI_EDMA_H_
AnnaBridge 189:f392fc9709a3 32
AnnaBridge 189:f392fc9709a3 33 #include "fsl_flexio_spi.h"
AnnaBridge 189:f392fc9709a3 34 #include "fsl_edma.h"
AnnaBridge 189:f392fc9709a3 35
AnnaBridge 189:f392fc9709a3 36 /*!
AnnaBridge 189:f392fc9709a3 37 * @addtogroup flexio_edma_spi
AnnaBridge 189:f392fc9709a3 38 * @{
AnnaBridge 189:f392fc9709a3 39 */
AnnaBridge 189:f392fc9709a3 40
AnnaBridge 189:f392fc9709a3 41 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 42 * Definitions
AnnaBridge 189:f392fc9709a3 43 ******************************************************************************/
AnnaBridge 189:f392fc9709a3 44
AnnaBridge 189:f392fc9709a3 45 /*! @brief typedef for flexio_spi_master_edma_handle_t in advance. */
AnnaBridge 189:f392fc9709a3 46 typedef struct _flexio_spi_master_edma_handle flexio_spi_master_edma_handle_t;
AnnaBridge 189:f392fc9709a3 47
AnnaBridge 189:f392fc9709a3 48 /*! @brief Slave handle is the same with master handle. */
AnnaBridge 189:f392fc9709a3 49 typedef flexio_spi_master_edma_handle_t flexio_spi_slave_edma_handle_t;
AnnaBridge 189:f392fc9709a3 50
AnnaBridge 189:f392fc9709a3 51 /*! @brief FlexIO SPI master callback for finished transmit */
AnnaBridge 189:f392fc9709a3 52 typedef void (*flexio_spi_master_edma_transfer_callback_t)(FLEXIO_SPI_Type *base,
AnnaBridge 189:f392fc9709a3 53 flexio_spi_master_edma_handle_t *handle,
AnnaBridge 189:f392fc9709a3 54 status_t status,
AnnaBridge 189:f392fc9709a3 55 void *userData);
AnnaBridge 189:f392fc9709a3 56
AnnaBridge 189:f392fc9709a3 57 /*! @brief FlexIO SPI slave callback for finished transmit */
AnnaBridge 189:f392fc9709a3 58 typedef void (*flexio_spi_slave_edma_transfer_callback_t)(FLEXIO_SPI_Type *base,
AnnaBridge 189:f392fc9709a3 59 flexio_spi_slave_edma_handle_t *handle,
AnnaBridge 189:f392fc9709a3 60 status_t status,
AnnaBridge 189:f392fc9709a3 61 void *userData);
AnnaBridge 189:f392fc9709a3 62
AnnaBridge 189:f392fc9709a3 63 /*! @brief FlexIO SPI eDMA transfer handle, users should not touch the content of the handle.*/
AnnaBridge 189:f392fc9709a3 64 struct _flexio_spi_master_edma_handle
AnnaBridge 189:f392fc9709a3 65 {
AnnaBridge 189:f392fc9709a3 66 size_t transferSize; /*!< Total bytes to be transferred. */
AnnaBridge 189:f392fc9709a3 67 uint8_t nbytes; /*!< eDMA minor byte transfer count initially configured. */
AnnaBridge 189:f392fc9709a3 68 bool txInProgress; /*!< Send transfer in progress */
AnnaBridge 189:f392fc9709a3 69 bool rxInProgress; /*!< Receive transfer in progress */
AnnaBridge 189:f392fc9709a3 70 edma_handle_t *txHandle; /*!< DMA handler for SPI send */
AnnaBridge 189:f392fc9709a3 71 edma_handle_t *rxHandle; /*!< DMA handler for SPI receive */
AnnaBridge 189:f392fc9709a3 72 flexio_spi_master_edma_transfer_callback_t callback; /*!< Callback for SPI DMA transfer */
AnnaBridge 189:f392fc9709a3 73 void *userData; /*!< User Data for SPI DMA callback */
AnnaBridge 189:f392fc9709a3 74 };
AnnaBridge 189:f392fc9709a3 75
AnnaBridge 189:f392fc9709a3 76 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 77 * APIs
AnnaBridge 189:f392fc9709a3 78 ******************************************************************************/
AnnaBridge 189:f392fc9709a3 79 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 80 extern "C" {
AnnaBridge 189:f392fc9709a3 81 #endif
AnnaBridge 189:f392fc9709a3 82
AnnaBridge 189:f392fc9709a3 83 /*!
AnnaBridge 189:f392fc9709a3 84 * @name eDMA Transactional
AnnaBridge 189:f392fc9709a3 85 * @{
AnnaBridge 189:f392fc9709a3 86 */
AnnaBridge 189:f392fc9709a3 87
AnnaBridge 189:f392fc9709a3 88 /*!
AnnaBridge 189:f392fc9709a3 89 * @brief Initializes the FlexIO SPI master eDMA handle.
AnnaBridge 189:f392fc9709a3 90 *
AnnaBridge 189:f392fc9709a3 91 * This function initializes the FlexIO SPI master eDMA handle which can be used for other FlexIO SPI master transactional
AnnaBridge 189:f392fc9709a3 92 * APIs.
AnnaBridge 189:f392fc9709a3 93 * For a specified FlexIO SPI instance, call this API once to get the initialized handle.
AnnaBridge 189:f392fc9709a3 94 *
AnnaBridge 189:f392fc9709a3 95 * @param base Pointer to FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 96 * @param handle Pointer to flexio_spi_master_edma_handle_t structure to store the transfer state.
AnnaBridge 189:f392fc9709a3 97 * @param callback SPI callback, NULL means no callback.
AnnaBridge 189:f392fc9709a3 98 * @param userData callback function parameter.
AnnaBridge 189:f392fc9709a3 99 * @param txHandle User requested eDMA handle for FlexIO SPI RX eDMA transfer.
AnnaBridge 189:f392fc9709a3 100 * @param rxHandle User requested eDMA handle for FlexIO SPI TX eDMA transfer.
AnnaBridge 189:f392fc9709a3 101 * @retval kStatus_Success Successfully create the handle.
AnnaBridge 189:f392fc9709a3 102 * @retval kStatus_OutOfRange The FlexIO SPI eDMA type/handle table out of range.
AnnaBridge 189:f392fc9709a3 103 */
AnnaBridge 189:f392fc9709a3 104 status_t FLEXIO_SPI_MasterTransferCreateHandleEDMA(FLEXIO_SPI_Type *base,
AnnaBridge 189:f392fc9709a3 105 flexio_spi_master_edma_handle_t *handle,
AnnaBridge 189:f392fc9709a3 106 flexio_spi_master_edma_transfer_callback_t callback,
AnnaBridge 189:f392fc9709a3 107 void *userData,
AnnaBridge 189:f392fc9709a3 108 edma_handle_t *txHandle,
AnnaBridge 189:f392fc9709a3 109 edma_handle_t *rxHandle);
AnnaBridge 189:f392fc9709a3 110
AnnaBridge 189:f392fc9709a3 111 /*!
AnnaBridge 189:f392fc9709a3 112 * @brief Performs a non-blocking FlexIO SPI transfer using eDMA.
AnnaBridge 189:f392fc9709a3 113 *
AnnaBridge 189:f392fc9709a3 114 * @note This interface returns immediately after transfer initiates. Call
AnnaBridge 189:f392fc9709a3 115 * FLEXIO_SPI_MasterGetTransferCountEDMA to poll the transfer status and check
AnnaBridge 189:f392fc9709a3 116 * whether the FlexIO SPI transfer is finished.
AnnaBridge 189:f392fc9709a3 117 *
AnnaBridge 189:f392fc9709a3 118 * @param base Pointer to FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 119 * @param handle Pointer to flexio_spi_master_edma_handle_t structure to store the transfer state.
AnnaBridge 189:f392fc9709a3 120 * @param xfer Pointer to FlexIO SPI transfer structure.
AnnaBridge 189:f392fc9709a3 121 * @retval kStatus_Success Successfully start a transfer.
AnnaBridge 189:f392fc9709a3 122 * @retval kStatus_InvalidArgument Input argument is invalid.
AnnaBridge 189:f392fc9709a3 123 * @retval kStatus_FLEXIO_SPI_Busy FlexIO SPI is not idle, is running another transfer.
AnnaBridge 189:f392fc9709a3 124 */
AnnaBridge 189:f392fc9709a3 125 status_t FLEXIO_SPI_MasterTransferEDMA(FLEXIO_SPI_Type *base,
AnnaBridge 189:f392fc9709a3 126 flexio_spi_master_edma_handle_t *handle,
AnnaBridge 189:f392fc9709a3 127 flexio_spi_transfer_t *xfer);
AnnaBridge 189:f392fc9709a3 128
AnnaBridge 189:f392fc9709a3 129 /*!
AnnaBridge 189:f392fc9709a3 130 * @brief Aborts a FlexIO SPI transfer using eDMA.
AnnaBridge 189:f392fc9709a3 131 *
AnnaBridge 189:f392fc9709a3 132 * @param base Pointer to FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 133 * @param handle FlexIO SPI eDMA handle pointer.
AnnaBridge 189:f392fc9709a3 134 */
AnnaBridge 189:f392fc9709a3 135 void FLEXIO_SPI_MasterTransferAbortEDMA(FLEXIO_SPI_Type *base, flexio_spi_master_edma_handle_t *handle);
AnnaBridge 189:f392fc9709a3 136
AnnaBridge 189:f392fc9709a3 137 /*!
AnnaBridge 189:f392fc9709a3 138 * @brief Gets the remaining bytes for FlexIO SPI eDMA transfer.
AnnaBridge 189:f392fc9709a3 139 *
AnnaBridge 189:f392fc9709a3 140 * @param base Pointer to FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 141 * @param handle FlexIO SPI eDMA handle pointer.
AnnaBridge 189:f392fc9709a3 142 * @param count Number of bytes transferred so far by the non-blocking transaction.
AnnaBridge 189:f392fc9709a3 143 */
AnnaBridge 189:f392fc9709a3 144 status_t FLEXIO_SPI_MasterTransferGetCountEDMA(FLEXIO_SPI_Type *base,
AnnaBridge 189:f392fc9709a3 145 flexio_spi_master_edma_handle_t *handle,
AnnaBridge 189:f392fc9709a3 146 size_t *count);
AnnaBridge 189:f392fc9709a3 147
AnnaBridge 189:f392fc9709a3 148 /*!
AnnaBridge 189:f392fc9709a3 149 * @brief Initializes the FlexIO SPI slave eDMA handle.
AnnaBridge 189:f392fc9709a3 150 *
AnnaBridge 189:f392fc9709a3 151 * This function initializes the FlexIO SPI slave eDMA handle.
AnnaBridge 189:f392fc9709a3 152 *
AnnaBridge 189:f392fc9709a3 153 * @param base Pointer to FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 154 * @param handle Pointer to flexio_spi_slave_edma_handle_t structure to store the transfer state.
AnnaBridge 189:f392fc9709a3 155 * @param callback SPI callback, NULL means no callback.
AnnaBridge 189:f392fc9709a3 156 * @param userData callback function parameter.
AnnaBridge 189:f392fc9709a3 157 * @param txHandle User requested eDMA handle for FlexIO SPI TX eDMA transfer.
AnnaBridge 189:f392fc9709a3 158 * @param rxHandle User requested eDMA handle for FlexIO SPI RX eDMA transfer.
AnnaBridge 189:f392fc9709a3 159 */
AnnaBridge 189:f392fc9709a3 160 static inline void FLEXIO_SPI_SlaveTransferCreateHandleEDMA(FLEXIO_SPI_Type *base,
AnnaBridge 189:f392fc9709a3 161 flexio_spi_slave_edma_handle_t *handle,
AnnaBridge 189:f392fc9709a3 162 flexio_spi_slave_edma_transfer_callback_t callback,
AnnaBridge 189:f392fc9709a3 163 void *userData,
AnnaBridge 189:f392fc9709a3 164 edma_handle_t *txHandle,
AnnaBridge 189:f392fc9709a3 165 edma_handle_t *rxHandle)
AnnaBridge 189:f392fc9709a3 166 {
AnnaBridge 189:f392fc9709a3 167 FLEXIO_SPI_MasterTransferCreateHandleEDMA(base, handle, callback, userData, txHandle, rxHandle);
AnnaBridge 189:f392fc9709a3 168 }
AnnaBridge 189:f392fc9709a3 169
AnnaBridge 189:f392fc9709a3 170 /*!
AnnaBridge 189:f392fc9709a3 171 * @brief Performs a non-blocking FlexIO SPI transfer using eDMA.
AnnaBridge 189:f392fc9709a3 172 *
AnnaBridge 189:f392fc9709a3 173 * @note This interface returns immediately after transfer initiates. Call
AnnaBridge 189:f392fc9709a3 174 * FLEXIO_SPI_SlaveGetTransferCountEDMA to poll the transfer status and
AnnaBridge 189:f392fc9709a3 175 * check whether the FlexIO SPI transfer is finished.
AnnaBridge 189:f392fc9709a3 176 *
AnnaBridge 189:f392fc9709a3 177 * @param base Pointer to FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 178 * @param handle Pointer to flexio_spi_slave_edma_handle_t structure to store the transfer state.
AnnaBridge 189:f392fc9709a3 179 * @param xfer Pointer to FlexIO SPI transfer structure.
AnnaBridge 189:f392fc9709a3 180 * @retval kStatus_Success Successfully start a transfer.
AnnaBridge 189:f392fc9709a3 181 * @retval kStatus_InvalidArgument Input argument is invalid.
AnnaBridge 189:f392fc9709a3 182 * @retval kStatus_FLEXIO_SPI_Busy FlexIO SPI is not idle, is running another transfer.
AnnaBridge 189:f392fc9709a3 183 */
AnnaBridge 189:f392fc9709a3 184 status_t FLEXIO_SPI_SlaveTransferEDMA(FLEXIO_SPI_Type *base,
AnnaBridge 189:f392fc9709a3 185 flexio_spi_slave_edma_handle_t *handle,
AnnaBridge 189:f392fc9709a3 186 flexio_spi_transfer_t *xfer);
AnnaBridge 189:f392fc9709a3 187
AnnaBridge 189:f392fc9709a3 188 /*!
AnnaBridge 189:f392fc9709a3 189 * @brief Aborts a FlexIO SPI transfer using eDMA.
AnnaBridge 189:f392fc9709a3 190 *
AnnaBridge 189:f392fc9709a3 191 * @param base Pointer to FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 192 * @param handle Pointer to flexio_spi_slave_edma_handle_t structure to store the transfer state.
AnnaBridge 189:f392fc9709a3 193 */
AnnaBridge 189:f392fc9709a3 194 static inline void FLEXIO_SPI_SlaveTransferAbortEDMA(FLEXIO_SPI_Type *base, flexio_spi_slave_edma_handle_t *handle)
AnnaBridge 189:f392fc9709a3 195 {
AnnaBridge 189:f392fc9709a3 196 FLEXIO_SPI_MasterTransferAbortEDMA(base, handle);
AnnaBridge 189:f392fc9709a3 197 }
AnnaBridge 189:f392fc9709a3 198
AnnaBridge 189:f392fc9709a3 199 /*!
AnnaBridge 189:f392fc9709a3 200 * @brief Gets the remaining bytes to be transferred for FlexIO SPI eDMA.
AnnaBridge 189:f392fc9709a3 201 *
AnnaBridge 189:f392fc9709a3 202 * @param base Pointer to FLEXIO_SPI_Type structure.
AnnaBridge 189:f392fc9709a3 203 * @param handle FlexIO SPI eDMA handle pointer.
AnnaBridge 189:f392fc9709a3 204 * @param count Number of bytes transferred so far by the non-blocking transaction.
AnnaBridge 189:f392fc9709a3 205 */
AnnaBridge 189:f392fc9709a3 206 static inline status_t FLEXIO_SPI_SlaveTransferGetCountEDMA(FLEXIO_SPI_Type *base,
AnnaBridge 189:f392fc9709a3 207 flexio_spi_slave_edma_handle_t *handle,
AnnaBridge 189:f392fc9709a3 208 size_t *count)
AnnaBridge 189:f392fc9709a3 209 {
AnnaBridge 189:f392fc9709a3 210 return FLEXIO_SPI_MasterTransferGetCountEDMA(base, handle, count);
AnnaBridge 189:f392fc9709a3 211 }
AnnaBridge 189:f392fc9709a3 212
AnnaBridge 189:f392fc9709a3 213 /*! @} */
AnnaBridge 189:f392fc9709a3 214
AnnaBridge 189:f392fc9709a3 215 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 216 }
AnnaBridge 189:f392fc9709a3 217 #endif
AnnaBridge 189:f392fc9709a3 218
AnnaBridge 189:f392fc9709a3 219 /*!
AnnaBridge 189:f392fc9709a3 220 * @}
AnnaBridge 189:f392fc9709a3 221 */
AnnaBridge 189:f392fc9709a3 222 #endif