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_KL43Z/TOOLCHAIN_GCC_ARM/fsl_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_SPI_DMA_H_
AnnaBridge 171:3a7713b1edbc 31 #define _FSL_SPI_DMA_H_
AnnaBridge 171:3a7713b1edbc 32
AnnaBridge 171:3a7713b1edbc 33 #include "fsl_spi.h"
AnnaBridge 171:3a7713b1edbc 34 #include "fsl_dma.h"
AnnaBridge 171:3a7713b1edbc 35
AnnaBridge 171:3a7713b1edbc 36 /*!
AnnaBridge 171:3a7713b1edbc 37 * @addtogroup spi_dma_driver
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 typedef struct _spi_dma_handle spi_dma_handle_t;
AnnaBridge 171:3a7713b1edbc 47
AnnaBridge 171:3a7713b1edbc 48 /*! @brief SPI DMA callback called at the end of transfer. */
AnnaBridge 171:3a7713b1edbc 49 typedef void (*spi_dma_callback_t)(SPI_Type *base, spi_dma_handle_t *handle, status_t status, void *userData);
AnnaBridge 171:3a7713b1edbc 50
AnnaBridge 171:3a7713b1edbc 51 /*! @brief SPI DMA transfer handle, users should not touch the content of the handle.*/
AnnaBridge 171:3a7713b1edbc 52 struct _spi_dma_handle
AnnaBridge 171:3a7713b1edbc 53 {
AnnaBridge 171:3a7713b1edbc 54 bool txInProgress; /*!< Send transfer finished */
AnnaBridge 171:3a7713b1edbc 55 bool rxInProgress; /*!< Receive transfer finished */
AnnaBridge 171:3a7713b1edbc 56 dma_handle_t *txHandle; /*!< DMA handler for SPI send */
AnnaBridge 171:3a7713b1edbc 57 dma_handle_t *rxHandle; /*!< DMA handler for SPI receive */
AnnaBridge 171:3a7713b1edbc 58 uint8_t bytesPerFrame; /*!< Bytes in a frame for SPI tranfer */
AnnaBridge 171:3a7713b1edbc 59 spi_dma_callback_t callback; /*!< Callback for SPI DMA transfer */
AnnaBridge 171:3a7713b1edbc 60 void *userData; /*!< User Data for SPI DMA callback */
AnnaBridge 171:3a7713b1edbc 61 uint32_t state; /*!< Internal state of SPI DMA transfer */
AnnaBridge 171:3a7713b1edbc 62 size_t transferSize; /*!< Bytes need to be transfer */
AnnaBridge 171:3a7713b1edbc 63 };
AnnaBridge 171:3a7713b1edbc 64
AnnaBridge 171:3a7713b1edbc 65 /*******************************************************************************
AnnaBridge 171:3a7713b1edbc 66 * APIs
AnnaBridge 171:3a7713b1edbc 67 ******************************************************************************/
AnnaBridge 171:3a7713b1edbc 68 #if defined(__cplusplus)
AnnaBridge 171:3a7713b1edbc 69 extern "C" {
AnnaBridge 171:3a7713b1edbc 70 #endif
AnnaBridge 171:3a7713b1edbc 71
AnnaBridge 171:3a7713b1edbc 72 /*!
AnnaBridge 171:3a7713b1edbc 73 * @name DMA Transactional
AnnaBridge 171:3a7713b1edbc 74 * @{
AnnaBridge 171:3a7713b1edbc 75 */
AnnaBridge 171:3a7713b1edbc 76
AnnaBridge 171:3a7713b1edbc 77 /*!
AnnaBridge 171:3a7713b1edbc 78 * @brief Initialize the SPI master DMA handle.
AnnaBridge 171:3a7713b1edbc 79 *
AnnaBridge 171:3a7713b1edbc 80 * This function initializes the SPI master DMA handle which can be used for other SPI master transactional APIs.
AnnaBridge 171:3a7713b1edbc 81 * Usually, for a specified SPI instance, user need only call this API once to get the initialized handle.
AnnaBridge 171:3a7713b1edbc 82 *
AnnaBridge 171:3a7713b1edbc 83 * @param base SPI peripheral base address.
AnnaBridge 171:3a7713b1edbc 84 * @param handle SPI handle pointer.
AnnaBridge 171:3a7713b1edbc 85 * @param callback User callback function called at the end of a transfer.
AnnaBridge 171:3a7713b1edbc 86 * @param userData User data for callback.
AnnaBridge 171:3a7713b1edbc 87 * @param txHandle DMA handle pointer for SPI Tx, the handle shall be static allocated by users.
AnnaBridge 171:3a7713b1edbc 88 * @param rxHandle DMA handle pointer for SPI Rx, the handle shall be static allocated by users.
AnnaBridge 171:3a7713b1edbc 89 */
AnnaBridge 171:3a7713b1edbc 90 void SPI_MasterTransferCreateHandleDMA(SPI_Type *base,
AnnaBridge 171:3a7713b1edbc 91 spi_dma_handle_t *handle,
AnnaBridge 171:3a7713b1edbc 92 spi_dma_callback_t callback,
AnnaBridge 171:3a7713b1edbc 93 void *userData,
AnnaBridge 171:3a7713b1edbc 94 dma_handle_t *txHandle,
AnnaBridge 171:3a7713b1edbc 95 dma_handle_t *rxHandle);
AnnaBridge 171:3a7713b1edbc 96
AnnaBridge 171:3a7713b1edbc 97 /*!
AnnaBridge 171:3a7713b1edbc 98 * @brief Perform a non-blocking SPI transfer using DMA.
AnnaBridge 171:3a7713b1edbc 99 *
AnnaBridge 171:3a7713b1edbc 100 * @note This interface returned immediately after transfer initiates, users should call
AnnaBridge 171:3a7713b1edbc 101 * SPI_GetTransferStatus to poll the transfer status to check whether SPI transfer finished.
AnnaBridge 171:3a7713b1edbc 102 *
AnnaBridge 171:3a7713b1edbc 103 * @param base SPI peripheral base address.
AnnaBridge 171:3a7713b1edbc 104 * @param handle SPI DMA handle pointer.
AnnaBridge 171:3a7713b1edbc 105 * @param xfer Pointer to dma transfer structure.
AnnaBridge 171:3a7713b1edbc 106 * @retval kStatus_Success Successfully start a transfer.
AnnaBridge 171:3a7713b1edbc 107 * @retval kStatus_InvalidArgument Input argument is invalid.
AnnaBridge 171:3a7713b1edbc 108 * @retval kStatus_SPI_Busy SPI is not idle, is running another transfer.
AnnaBridge 171:3a7713b1edbc 109 */
AnnaBridge 171:3a7713b1edbc 110 status_t SPI_MasterTransferDMA(SPI_Type *base, spi_dma_handle_t *handle, spi_transfer_t *xfer);
AnnaBridge 171:3a7713b1edbc 111
AnnaBridge 171:3a7713b1edbc 112 /*!
AnnaBridge 171:3a7713b1edbc 113 * @brief Abort a SPI transfer using DMA.
AnnaBridge 171:3a7713b1edbc 114 *
AnnaBridge 171:3a7713b1edbc 115 * @param base SPI peripheral base address.
AnnaBridge 171:3a7713b1edbc 116 * @param handle SPI DMA handle pointer.
AnnaBridge 171:3a7713b1edbc 117 */
AnnaBridge 171:3a7713b1edbc 118 void SPI_MasterTransferAbortDMA(SPI_Type *base, spi_dma_handle_t *handle);
AnnaBridge 171:3a7713b1edbc 119
AnnaBridge 171:3a7713b1edbc 120 /*!
AnnaBridge 171:3a7713b1edbc 121 * @brief Get the transferred bytes for SPI slave DMA.
AnnaBridge 171:3a7713b1edbc 122 *
AnnaBridge 171:3a7713b1edbc 123 * @param base SPI peripheral base address.
AnnaBridge 171:3a7713b1edbc 124 * @param handle SPI DMA handle pointer.
AnnaBridge 171:3a7713b1edbc 125 * @param count Transferred bytes.
AnnaBridge 171:3a7713b1edbc 126 * @retval kStatus_SPI_Success Succeed get the transfer count.
AnnaBridge 171:3a7713b1edbc 127 * @retval kStatus_NoTransferInProgress There is not a non-blocking transaction currently in progress.
AnnaBridge 171:3a7713b1edbc 128 */
AnnaBridge 171:3a7713b1edbc 129 status_t SPI_MasterTransferGetCountDMA(SPI_Type *base, spi_dma_handle_t *handle, size_t *count);
AnnaBridge 171:3a7713b1edbc 130
AnnaBridge 171:3a7713b1edbc 131 /*!
AnnaBridge 171:3a7713b1edbc 132 * @brief Initialize the SPI slave DMA handle.
AnnaBridge 171:3a7713b1edbc 133 *
AnnaBridge 171:3a7713b1edbc 134 * This function initializes the SPI slave DMA handle which can be used for other SPI master transactional APIs.
AnnaBridge 171:3a7713b1edbc 135 * Usually, for a specified SPI instance, user need only call this API once to get the initialized handle.
AnnaBridge 171:3a7713b1edbc 136 *
AnnaBridge 171:3a7713b1edbc 137 * @param base SPI peripheral base address.
AnnaBridge 171:3a7713b1edbc 138 * @param handle SPI handle pointer.
AnnaBridge 171:3a7713b1edbc 139 * @param callback User callback function called at the end of a transfer.
AnnaBridge 171:3a7713b1edbc 140 * @param userData User data for callback.
AnnaBridge 171:3a7713b1edbc 141 * @param txHandle DMA handle pointer for SPI Tx, the handle shall be static allocated by users.
AnnaBridge 171:3a7713b1edbc 142 * @param rxHandle DMA handle pointer for SPI Rx, the handle shall be static allocated by users.
AnnaBridge 171:3a7713b1edbc 143 */
AnnaBridge 171:3a7713b1edbc 144 static inline void SPI_SlaveTransferCreateHandleDMA(SPI_Type *base,
AnnaBridge 171:3a7713b1edbc 145 spi_dma_handle_t *handle,
AnnaBridge 171:3a7713b1edbc 146 spi_dma_callback_t callback,
AnnaBridge 171:3a7713b1edbc 147 void *userData,
AnnaBridge 171:3a7713b1edbc 148 dma_handle_t *txHandle,
AnnaBridge 171:3a7713b1edbc 149 dma_handle_t *rxHandle)
AnnaBridge 171:3a7713b1edbc 150 {
AnnaBridge 171:3a7713b1edbc 151 SPI_MasterTransferCreateHandleDMA(base, handle, callback, userData, txHandle, rxHandle);
AnnaBridge 171:3a7713b1edbc 152 }
AnnaBridge 171:3a7713b1edbc 153
AnnaBridge 171:3a7713b1edbc 154 /*!
AnnaBridge 171:3a7713b1edbc 155 * @brief Perform a non-blocking SPI transfer using DMA.
AnnaBridge 171:3a7713b1edbc 156 *
AnnaBridge 171:3a7713b1edbc 157 * @note This interface returned immediately after transfer initiates, users should call
AnnaBridge 171:3a7713b1edbc 158 * SPI_GetTransferStatus to poll the transfer status to check whether SPI transfer finished.
AnnaBridge 171:3a7713b1edbc 159 *
AnnaBridge 171:3a7713b1edbc 160 * @param base SPI peripheral base address.
AnnaBridge 171:3a7713b1edbc 161 * @param handle SPI DMA handle pointer.
AnnaBridge 171:3a7713b1edbc 162 * @param xfer Pointer to dma transfer structure.
AnnaBridge 171:3a7713b1edbc 163 * @retval kStatus_Success Successfully start a transfer.
AnnaBridge 171:3a7713b1edbc 164 * @retval kStatus_InvalidArgument Input argument is invalid.
AnnaBridge 171:3a7713b1edbc 165 * @retval kStatus_SPI_Busy SPI is not idle, is running another transfer.
AnnaBridge 171:3a7713b1edbc 166 */
AnnaBridge 171:3a7713b1edbc 167 static inline status_t SPI_SlaveTransferDMA(SPI_Type *base, spi_dma_handle_t *handle, spi_transfer_t *xfer)
AnnaBridge 171:3a7713b1edbc 168 {
AnnaBridge 171:3a7713b1edbc 169 return SPI_MasterTransferDMA(base, handle, xfer);
AnnaBridge 171:3a7713b1edbc 170 }
AnnaBridge 171:3a7713b1edbc 171
AnnaBridge 171:3a7713b1edbc 172 /*!
AnnaBridge 171:3a7713b1edbc 173 * @brief Abort a SPI transfer using DMA.
AnnaBridge 171:3a7713b1edbc 174 *
AnnaBridge 171:3a7713b1edbc 175 * @param base SPI peripheral base address.
AnnaBridge 171:3a7713b1edbc 176 * @param handle SPI DMA handle pointer.
AnnaBridge 171:3a7713b1edbc 177 */
AnnaBridge 171:3a7713b1edbc 178 static inline void SPI_SlaveTransferAbortDMA(SPI_Type *base, spi_dma_handle_t *handle)
AnnaBridge 171:3a7713b1edbc 179 {
AnnaBridge 171:3a7713b1edbc 180 SPI_MasterTransferAbortDMA(base, handle);
AnnaBridge 171:3a7713b1edbc 181 }
AnnaBridge 171:3a7713b1edbc 182
AnnaBridge 171:3a7713b1edbc 183 /*!
AnnaBridge 171:3a7713b1edbc 184 * @brief Get the transferred bytes for SPI slave DMA.
AnnaBridge 171:3a7713b1edbc 185 *
AnnaBridge 171:3a7713b1edbc 186 * @param base SPI peripheral base address.
AnnaBridge 171:3a7713b1edbc 187 * @param handle SPI DMA handle pointer.
AnnaBridge 171:3a7713b1edbc 188 * @param count Transferred bytes.
AnnaBridge 171:3a7713b1edbc 189 * @retval kStatus_SPI_Success Succeed get the transfer count.
AnnaBridge 171:3a7713b1edbc 190 * @retval kStatus_NoTransferInProgress There is not a non-blocking transaction currently in progress.
AnnaBridge 171:3a7713b1edbc 191 */
AnnaBridge 171:3a7713b1edbc 192 static inline status_t SPI_SlaveTransferGetCountDMA(SPI_Type *base, spi_dma_handle_t *handle, size_t *count)
AnnaBridge 171:3a7713b1edbc 193 {
AnnaBridge 171:3a7713b1edbc 194 return SPI_MasterTransferGetCountDMA(base, handle, count);
AnnaBridge 171:3a7713b1edbc 195 }
AnnaBridge 171:3a7713b1edbc 196
AnnaBridge 171:3a7713b1edbc 197 /*! @} */
AnnaBridge 171:3a7713b1edbc 198
AnnaBridge 171:3a7713b1edbc 199 #if defined(__cplusplus)
AnnaBridge 171:3a7713b1edbc 200 }
AnnaBridge 171:3a7713b1edbc 201 #endif
AnnaBridge 171:3a7713b1edbc 202
AnnaBridge 171:3a7713b1edbc 203 /*!
AnnaBridge 171:3a7713b1edbc 204 * @}
AnnaBridge 171:3a7713b1edbc 205 */
AnnaBridge 171:3a7713b1edbc 206 #endif