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_FF_LPC546XX/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 * The Clear BSD License
AnnaBridge 171:3a7713b1edbc 3 * Copyright (c) 2016, Freescale Semiconductor, Inc.
AnnaBridge 171:3a7713b1edbc 4 * Copyright 2016-2017 NXP
AnnaBridge 171:3a7713b1edbc 5 * All rights reserved.
AnnaBridge 171:3a7713b1edbc 6 *
AnnaBridge 171:3a7713b1edbc 7 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 171:3a7713b1edbc 8 * are permitted (subject to the limitations in the disclaimer below) provided
AnnaBridge 171:3a7713b1edbc 9 * that the following conditions are met:
AnnaBridge 171:3a7713b1edbc 10 *
AnnaBridge 171:3a7713b1edbc 11 * o Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 171:3a7713b1edbc 12 * of conditions and the following disclaimer.
AnnaBridge 171:3a7713b1edbc 13 *
AnnaBridge 171:3a7713b1edbc 14 * o Redistributions in binary form must reproduce the above copyright notice, this
AnnaBridge 171:3a7713b1edbc 15 * list of conditions and the following disclaimer in the documentation and/or
AnnaBridge 171:3a7713b1edbc 16 * other materials provided with the distribution.
AnnaBridge 171:3a7713b1edbc 17 *
AnnaBridge 171:3a7713b1edbc 18 * o Neither the name of the copyright holder nor the names of its
AnnaBridge 171:3a7713b1edbc 19 * contributors may be used to endorse or promote products derived from this
AnnaBridge 171:3a7713b1edbc 20 * software without specific prior written permission.
AnnaBridge 171:3a7713b1edbc 21 *
AnnaBridge 171:3a7713b1edbc 22 * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE.
AnnaBridge 171:3a7713b1edbc 23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 171:3a7713b1edbc 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 171:3a7713b1edbc 25 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 171:3a7713b1edbc 26 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 171:3a7713b1edbc 27 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 171:3a7713b1edbc 28 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 171:3a7713b1edbc 29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 171:3a7713b1edbc 30 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 171:3a7713b1edbc 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 171:3a7713b1edbc 32 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 171:3a7713b1edbc 33 */
AnnaBridge 171:3a7713b1edbc 34 #ifndef _FSL_SPI_DMA_H_
AnnaBridge 171:3a7713b1edbc 35 #define _FSL_SPI_DMA_H_
AnnaBridge 171:3a7713b1edbc 36
AnnaBridge 171:3a7713b1edbc 37 #include "fsl_dma.h"
AnnaBridge 171:3a7713b1edbc 38 #include "fsl_spi.h"
AnnaBridge 171:3a7713b1edbc 39
AnnaBridge 171:3a7713b1edbc 40 /*!
AnnaBridge 171:3a7713b1edbc 41 * @addtogroup spi_dma_driver
AnnaBridge 171:3a7713b1edbc 42 * @{
AnnaBridge 171:3a7713b1edbc 43 */
AnnaBridge 171:3a7713b1edbc 44
AnnaBridge 171:3a7713b1edbc 45 /*! @file */
AnnaBridge 171:3a7713b1edbc 46
AnnaBridge 171:3a7713b1edbc 47 /*******************************************************************************
AnnaBridge 171:3a7713b1edbc 48 * Definitions
AnnaBridge 171:3a7713b1edbc 49 ******************************************************************************/
AnnaBridge 171:3a7713b1edbc 50
AnnaBridge 171:3a7713b1edbc 51 typedef struct _spi_dma_handle spi_dma_handle_t;
AnnaBridge 171:3a7713b1edbc 52
AnnaBridge 171:3a7713b1edbc 53 /*! @brief SPI DMA callback called at the end of transfer. */
AnnaBridge 171:3a7713b1edbc 54 typedef void (*spi_dma_callback_t)(SPI_Type *base, spi_dma_handle_t *handle, status_t status, void *userData);
AnnaBridge 171:3a7713b1edbc 55
AnnaBridge 171:3a7713b1edbc 56 /*! @brief SPI DMA transfer handle, users should not touch the content of the handle.*/
AnnaBridge 171:3a7713b1edbc 57 struct _spi_dma_handle
AnnaBridge 171:3a7713b1edbc 58 {
AnnaBridge 171:3a7713b1edbc 59 volatile bool txInProgress; /*!< Send transfer finished */
AnnaBridge 171:3a7713b1edbc 60 volatile bool rxInProgress; /*!< Receive transfer finished */
AnnaBridge 171:3a7713b1edbc 61 dma_handle_t *txHandle; /*!< DMA handler for SPI send */
AnnaBridge 171:3a7713b1edbc 62 dma_handle_t *rxHandle; /*!< DMA handler for SPI receive */
AnnaBridge 171:3a7713b1edbc 63 uint8_t bytesPerFrame; /*!< Bytes in a frame for SPI tranfer */
AnnaBridge 171:3a7713b1edbc 64 spi_dma_callback_t callback; /*!< Callback for SPI DMA transfer */
AnnaBridge 171:3a7713b1edbc 65 void *userData; /*!< User Data for SPI DMA callback */
AnnaBridge 171:3a7713b1edbc 66 uint32_t state; /*!< Internal state of SPI DMA transfer */
AnnaBridge 171:3a7713b1edbc 67 size_t transferSize; /*!< Bytes need to be transfer */
AnnaBridge 171:3a7713b1edbc 68 };
AnnaBridge 171:3a7713b1edbc 69
AnnaBridge 171:3a7713b1edbc 70 /*******************************************************************************
AnnaBridge 171:3a7713b1edbc 71 * APIs
AnnaBridge 171:3a7713b1edbc 72 ******************************************************************************/
AnnaBridge 171:3a7713b1edbc 73
AnnaBridge 171:3a7713b1edbc 74 #if defined(__cplusplus)
AnnaBridge 171:3a7713b1edbc 75 extern "C" {
AnnaBridge 171:3a7713b1edbc 76 #endif
AnnaBridge 171:3a7713b1edbc 77
AnnaBridge 171:3a7713b1edbc 78 /*!
AnnaBridge 171:3a7713b1edbc 79 * @name DMA Transactional
AnnaBridge 171:3a7713b1edbc 80 * @{
AnnaBridge 171:3a7713b1edbc 81 */
AnnaBridge 171:3a7713b1edbc 82
AnnaBridge 171:3a7713b1edbc 83 /*!
AnnaBridge 171:3a7713b1edbc 84 * @brief Initialize the SPI master DMA handle.
AnnaBridge 171:3a7713b1edbc 85 *
AnnaBridge 171:3a7713b1edbc 86 * This function initializes the SPI master DMA handle which can be used for other SPI master transactional APIs.
AnnaBridge 171:3a7713b1edbc 87 * Usually, for a specified SPI instance, user need only call this API once to get the initialized handle.
AnnaBridge 171:3a7713b1edbc 88 *
AnnaBridge 171:3a7713b1edbc 89 * @param base SPI peripheral base address.
AnnaBridge 171:3a7713b1edbc 90 * @param handle SPI handle pointer.
AnnaBridge 171:3a7713b1edbc 91 * @param callback User callback function called at the end of a transfer.
AnnaBridge 171:3a7713b1edbc 92 * @param userData User data for callback.
AnnaBridge 171:3a7713b1edbc 93 * @param txHandle DMA handle pointer for SPI Tx, the handle shall be static allocated by users.
AnnaBridge 171:3a7713b1edbc 94 * @param rxHandle DMA handle pointer for SPI Rx, the handle shall be static allocated by users.
AnnaBridge 171:3a7713b1edbc 95 */
AnnaBridge 171:3a7713b1edbc 96 status_t SPI_MasterTransferCreateHandleDMA(SPI_Type *base,
AnnaBridge 171:3a7713b1edbc 97 spi_dma_handle_t *handle,
AnnaBridge 171:3a7713b1edbc 98 spi_dma_callback_t callback,
AnnaBridge 171:3a7713b1edbc 99 void *userData,
AnnaBridge 171:3a7713b1edbc 100 dma_handle_t *txHandle,
AnnaBridge 171:3a7713b1edbc 101 dma_handle_t *rxHandle);
AnnaBridge 171:3a7713b1edbc 102
AnnaBridge 171:3a7713b1edbc 103 /*!
AnnaBridge 171:3a7713b1edbc 104 * @brief Perform a non-blocking SPI transfer using DMA.
AnnaBridge 171:3a7713b1edbc 105 *
AnnaBridge 171:3a7713b1edbc 106 * @note This interface returned immediately after transfer initiates, users should call
AnnaBridge 171:3a7713b1edbc 107 * SPI_GetTransferStatus to poll the transfer status to check whether SPI transfer finished.
AnnaBridge 171:3a7713b1edbc 108 *
AnnaBridge 171:3a7713b1edbc 109 * @param base SPI peripheral base address.
AnnaBridge 171:3a7713b1edbc 110 * @param handle SPI DMA handle pointer.
AnnaBridge 171:3a7713b1edbc 111 * @param xfer Pointer to dma transfer structure.
AnnaBridge 171:3a7713b1edbc 112 * @retval kStatus_Success Successfully start a transfer.
AnnaBridge 171:3a7713b1edbc 113 * @retval kStatus_InvalidArgument Input argument is invalid.
AnnaBridge 171:3a7713b1edbc 114 * @retval kStatus_SPI_Busy SPI is not idle, is running another transfer.
AnnaBridge 171:3a7713b1edbc 115 */
AnnaBridge 171:3a7713b1edbc 116 status_t SPI_MasterTransferDMA(SPI_Type *base, spi_dma_handle_t *handle, spi_transfer_t *xfer);
AnnaBridge 171:3a7713b1edbc 117
AnnaBridge 171:3a7713b1edbc 118 /*!
AnnaBridge 171:3a7713b1edbc 119 * @brief Transfers a block of data using a DMA method.
AnnaBridge 171:3a7713b1edbc 120 *
AnnaBridge 171:3a7713b1edbc 121 * This function using polling way to do the first half transimission and using DMA way to
AnnaBridge 171:3a7713b1edbc 122 * do the srcond half transimission, the transfer mechanism is half-duplex.
AnnaBridge 171:3a7713b1edbc 123 * When do the second half transimission, code will return right away. When all data is transferred,
AnnaBridge 171:3a7713b1edbc 124 * the callback function is called.
AnnaBridge 171:3a7713b1edbc 125 *
AnnaBridge 171:3a7713b1edbc 126 * @param base SPI base pointer
AnnaBridge 171:3a7713b1edbc 127 * @param handle A pointer to the spi_master_dma_handle_t structure which stores the transfer state.
AnnaBridge 171:3a7713b1edbc 128 * @param transfer A pointer to the spi_half_duplex_transfer_t structure.
AnnaBridge 171:3a7713b1edbc 129 * @return status of status_t.
AnnaBridge 171:3a7713b1edbc 130 */
AnnaBridge 171:3a7713b1edbc 131 status_t SPI_MasterHalfDuplexTransferDMA(SPI_Type *base, spi_dma_handle_t *handle, spi_half_duplex_transfer_t *xfer);
AnnaBridge 171:3a7713b1edbc 132
AnnaBridge 171:3a7713b1edbc 133 /*!
AnnaBridge 171:3a7713b1edbc 134 * @brief Initialize the SPI slave DMA handle.
AnnaBridge 171:3a7713b1edbc 135 *
AnnaBridge 171:3a7713b1edbc 136 * This function initializes the SPI slave DMA handle which can be used for other SPI master transactional APIs.
AnnaBridge 171:3a7713b1edbc 137 * Usually, for a specified SPI instance, user need only call this API once to get the initialized handle.
AnnaBridge 171:3a7713b1edbc 138 *
AnnaBridge 171:3a7713b1edbc 139 * @param base SPI peripheral base address.
AnnaBridge 171:3a7713b1edbc 140 * @param handle SPI handle pointer.
AnnaBridge 171:3a7713b1edbc 141 * @param callback User callback function called at the end of a transfer.
AnnaBridge 171:3a7713b1edbc 142 * @param userData User data for callback.
AnnaBridge 171:3a7713b1edbc 143 * @param txHandle DMA handle pointer for SPI Tx, the handle shall be static allocated by users.
AnnaBridge 171:3a7713b1edbc 144 * @param rxHandle DMA handle pointer for SPI Rx, the handle shall be static allocated by users.
AnnaBridge 171:3a7713b1edbc 145 */
AnnaBridge 171:3a7713b1edbc 146 static inline status_t SPI_SlaveTransferCreateHandleDMA(SPI_Type *base,
AnnaBridge 171:3a7713b1edbc 147 spi_dma_handle_t *handle,
AnnaBridge 171:3a7713b1edbc 148 spi_dma_callback_t callback,
AnnaBridge 171:3a7713b1edbc 149 void *userData,
AnnaBridge 171:3a7713b1edbc 150 dma_handle_t *txHandle,
AnnaBridge 171:3a7713b1edbc 151 dma_handle_t *rxHandle)
AnnaBridge 171:3a7713b1edbc 152 {
AnnaBridge 171:3a7713b1edbc 153 return SPI_MasterTransferCreateHandleDMA(base, handle, callback, userData, txHandle, rxHandle);
AnnaBridge 171:3a7713b1edbc 154 }
AnnaBridge 171:3a7713b1edbc 155
AnnaBridge 171:3a7713b1edbc 156 /*!
AnnaBridge 171:3a7713b1edbc 157 * @brief Perform a non-blocking SPI transfer using DMA.
AnnaBridge 171:3a7713b1edbc 158 *
AnnaBridge 171:3a7713b1edbc 159 * @note This interface returned immediately after transfer initiates, users should call
AnnaBridge 171:3a7713b1edbc 160 * SPI_GetTransferStatus to poll the transfer status to check whether SPI transfer finished.
AnnaBridge 171:3a7713b1edbc 161 *
AnnaBridge 171:3a7713b1edbc 162 * @param base SPI peripheral base address.
AnnaBridge 171:3a7713b1edbc 163 * @param handle SPI DMA handle pointer.
AnnaBridge 171:3a7713b1edbc 164 * @param xfer Pointer to dma transfer structure.
AnnaBridge 171:3a7713b1edbc 165 * @retval kStatus_Success Successfully start a transfer.
AnnaBridge 171:3a7713b1edbc 166 * @retval kStatus_InvalidArgument Input argument is invalid.
AnnaBridge 171:3a7713b1edbc 167 * @retval kStatus_SPI_Busy SPI is not idle, is running another transfer.
AnnaBridge 171:3a7713b1edbc 168 */
AnnaBridge 171:3a7713b1edbc 169 static inline status_t SPI_SlaveTransferDMA(SPI_Type *base, spi_dma_handle_t *handle, spi_transfer_t *xfer)
AnnaBridge 171:3a7713b1edbc 170 {
AnnaBridge 171:3a7713b1edbc 171 return SPI_MasterTransferDMA(base, handle, xfer);
AnnaBridge 171:3a7713b1edbc 172 }
AnnaBridge 171:3a7713b1edbc 173
AnnaBridge 171:3a7713b1edbc 174 /*!
AnnaBridge 171:3a7713b1edbc 175 * @brief Abort a SPI transfer using DMA.
AnnaBridge 171:3a7713b1edbc 176 *
AnnaBridge 171:3a7713b1edbc 177 * @param base SPI peripheral base address.
AnnaBridge 171:3a7713b1edbc 178 * @param handle SPI DMA handle pointer.
AnnaBridge 171:3a7713b1edbc 179 */
AnnaBridge 171:3a7713b1edbc 180 void SPI_MasterTransferAbortDMA(SPI_Type *base, spi_dma_handle_t *handle);
AnnaBridge 171:3a7713b1edbc 181
AnnaBridge 171:3a7713b1edbc 182 /*!
AnnaBridge 171:3a7713b1edbc 183 * @brief Gets the master DMA transfer remaining bytes.
AnnaBridge 171:3a7713b1edbc 184 *
AnnaBridge 171:3a7713b1edbc 185 * This function gets the master DMA transfer remaining bytes.
AnnaBridge 171:3a7713b1edbc 186 *
AnnaBridge 171:3a7713b1edbc 187 * @param base SPI peripheral base address.
AnnaBridge 171:3a7713b1edbc 188 * @param handle A pointer to the spi_dma_handle_t structure which stores the transfer state.
AnnaBridge 171:3a7713b1edbc 189 * @param count A number of bytes transferred by the non-blocking transaction.
AnnaBridge 171:3a7713b1edbc 190 * @return status of status_t.
AnnaBridge 171:3a7713b1edbc 191 */
AnnaBridge 171:3a7713b1edbc 192 status_t SPI_MasterTransferGetCountDMA(SPI_Type *base, spi_dma_handle_t *handle, size_t *count);
AnnaBridge 171:3a7713b1edbc 193
AnnaBridge 171:3a7713b1edbc 194 /*!
AnnaBridge 171:3a7713b1edbc 195 * @brief Abort a SPI transfer using DMA.
AnnaBridge 171:3a7713b1edbc 196 *
AnnaBridge 171:3a7713b1edbc 197 * @param base SPI peripheral base address.
AnnaBridge 171:3a7713b1edbc 198 * @param handle SPI DMA handle pointer.
AnnaBridge 171:3a7713b1edbc 199 */
AnnaBridge 171:3a7713b1edbc 200 static inline void SPI_SlaveTransferAbortDMA(SPI_Type *base, spi_dma_handle_t *handle)
AnnaBridge 171:3a7713b1edbc 201 {
AnnaBridge 171:3a7713b1edbc 202 SPI_MasterTransferAbortDMA(base, handle);
AnnaBridge 171:3a7713b1edbc 203 }
AnnaBridge 171:3a7713b1edbc 204
AnnaBridge 171:3a7713b1edbc 205 /*!
AnnaBridge 171:3a7713b1edbc 206 * @brief Gets the slave DMA transfer remaining bytes.
AnnaBridge 171:3a7713b1edbc 207 *
AnnaBridge 171:3a7713b1edbc 208 * This function gets the slave DMA transfer remaining bytes.
AnnaBridge 171:3a7713b1edbc 209 *
AnnaBridge 171:3a7713b1edbc 210 * @param base SPI peripheral base address.
AnnaBridge 171:3a7713b1edbc 211 * @param handle A pointer to the spi_dma_handle_t structure which stores the transfer state.
AnnaBridge 171:3a7713b1edbc 212 * @param count A number of bytes transferred by the non-blocking transaction.
AnnaBridge 171:3a7713b1edbc 213 * @return status of status_t.
AnnaBridge 171:3a7713b1edbc 214 */
AnnaBridge 171:3a7713b1edbc 215 static inline status_t SPI_SlaveTransferGetCountDMA(SPI_Type *base, spi_dma_handle_t *handle, size_t *count)
AnnaBridge 171:3a7713b1edbc 216 {
AnnaBridge 171:3a7713b1edbc 217 return SPI_MasterTransferGetCountDMA(base, handle, count);
AnnaBridge 171:3a7713b1edbc 218 }
AnnaBridge 171:3a7713b1edbc 219
AnnaBridge 171:3a7713b1edbc 220 /*! @} */
AnnaBridge 171:3a7713b1edbc 221
AnnaBridge 171:3a7713b1edbc 222 #if defined(__cplusplus)
AnnaBridge 171:3a7713b1edbc 223 }
AnnaBridge 171:3a7713b1edbc 224 #endif
AnnaBridge 171:3a7713b1edbc 225
AnnaBridge 171:3a7713b1edbc 226 /*! @} */
AnnaBridge 171:3a7713b1edbc 227
AnnaBridge 171:3a7713b1edbc 228 #endif /* _FSL_SPI_DMA_H_*/