b luo / mbed-dev

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed-dev by mbed official

targets/hal/TARGET_Freescale/TARGET_KSDK2_MCUS/TARGET_KL27Z/drivers/fsl_spi_dma.h@144:ef7eb2e8f9f7, 2016-09-02 (annotated)

Committer:
<>
Date:
Fri Sep 02 15:07:44 2016 +0100
Revision:
144:ef7eb2e8f9f7
Parent:
121:7f86b4238bec 
This updates the lib to the mbed lib v125

Who changed what in which revision?

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