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_KL27Z/TOOLCHAIN_ARM_STD/fsl_flexio_spi_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?

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