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_MIMXRT1050_EVK/TOOLCHAIN_IAR/fsl_lpspi_edma.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 161:aa5281ff4a02 1 /*
AnnaBridge 170:e95d10626187 2 * The Clear BSD License
AnnaBridge 161:aa5281ff4a02 3 * Copyright (c) 2015, Freescale Semiconductor, Inc.
AnnaBridge 161:aa5281ff4a02 4 * Copyright 2016-2017 NXP
AnnaBridge 170:e95d10626187 5 * All rights reserved.
AnnaBridge 161:aa5281ff4a02 6 *
AnnaBridge 161:aa5281ff4a02 7 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 170:e95d10626187 8 * are permitted (subject to the limitations in the disclaimer below) provided
AnnaBridge 170:e95d10626187 9 * that the following conditions are met:
AnnaBridge 161:aa5281ff4a02 10 *
AnnaBridge 161:aa5281ff4a02 11 * o Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 161:aa5281ff4a02 12 * of conditions and the following disclaimer.
AnnaBridge 161:aa5281ff4a02 13 *
AnnaBridge 161:aa5281ff4a02 14 * o Redistributions in binary form must reproduce the above copyright notice, this
AnnaBridge 161:aa5281ff4a02 15 * list of conditions and the following disclaimer in the documentation and/or
AnnaBridge 161:aa5281ff4a02 16 * other materials provided with the distribution.
AnnaBridge 161:aa5281ff4a02 17 *
AnnaBridge 161:aa5281ff4a02 18 * o Neither the name of the copyright holder nor the names of its
AnnaBridge 161:aa5281ff4a02 19 * contributors may be used to endorse or promote products derived from this
AnnaBridge 161:aa5281ff4a02 20 * software without specific prior written permission.
AnnaBridge 161:aa5281ff4a02 21 *
AnnaBridge 170:e95d10626187 22 * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE.
AnnaBridge 161:aa5281ff4a02 23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 161:aa5281ff4a02 24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 161:aa5281ff4a02 25 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 161:aa5281ff4a02 26 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 161:aa5281ff4a02 27 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 161:aa5281ff4a02 28 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 161:aa5281ff4a02 29 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 161:aa5281ff4a02 30 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 161:aa5281ff4a02 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 161:aa5281ff4a02 32 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 161:aa5281ff4a02 33 */
AnnaBridge 161:aa5281ff4a02 34 #ifndef _FSL_LPSPI_EDMA_H_
AnnaBridge 161:aa5281ff4a02 35 #define _FSL_LPSPI_EDMA_H_
AnnaBridge 161:aa5281ff4a02 36
AnnaBridge 161:aa5281ff4a02 37 #include "fsl_lpspi.h"
AnnaBridge 161:aa5281ff4a02 38 #include "fsl_edma.h"
AnnaBridge 161:aa5281ff4a02 39
AnnaBridge 161:aa5281ff4a02 40 /*!
AnnaBridge 161:aa5281ff4a02 41 * @addtogroup lpspi_edma_driver
AnnaBridge 161:aa5281ff4a02 42 * @{
AnnaBridge 161:aa5281ff4a02 43 */
AnnaBridge 161:aa5281ff4a02 44
AnnaBridge 161:aa5281ff4a02 45 /***********************************************************************************************************************
AnnaBridge 161:aa5281ff4a02 46 * Definitions
AnnaBridge 161:aa5281ff4a02 47 **********************************************************************************************************************/
AnnaBridge 170:e95d10626187 48 /*! @name Driver version */
AnnaBridge 170:e95d10626187 49 /*@{*/
AnnaBridge 170:e95d10626187 50 /*! @brief LPSPI EDMA driver version 2.0.2. */
AnnaBridge 170:e95d10626187 51 #define FSL_LPSPI_EDMA_DRIVER_VERSION (MAKE_VERSION(2, 0, 2))
AnnaBridge 170:e95d10626187 52 /*@}*/
AnnaBridge 161:aa5281ff4a02 53
AnnaBridge 161:aa5281ff4a02 54 /*!
AnnaBridge 161:aa5281ff4a02 55 * @brief Forward declaration of the _lpspi_master_edma_handle typedefs.
AnnaBridge 161:aa5281ff4a02 56 */
AnnaBridge 161:aa5281ff4a02 57 typedef struct _lpspi_master_edma_handle lpspi_master_edma_handle_t;
AnnaBridge 161:aa5281ff4a02 58
AnnaBridge 161:aa5281ff4a02 59 /*!
AnnaBridge 161:aa5281ff4a02 60 * @brief Forward declaration of the _lpspi_slave_edma_handle typedefs.
AnnaBridge 161:aa5281ff4a02 61 */
AnnaBridge 161:aa5281ff4a02 62 typedef struct _lpspi_slave_edma_handle lpspi_slave_edma_handle_t;
AnnaBridge 161:aa5281ff4a02 63
AnnaBridge 161:aa5281ff4a02 64 /*!
AnnaBridge 161:aa5281ff4a02 65 * @brief Completion callback function pointer type.
AnnaBridge 161:aa5281ff4a02 66 *
AnnaBridge 161:aa5281ff4a02 67 * @param base LPSPI peripheral base address.
AnnaBridge 161:aa5281ff4a02 68 * @param handle Pointer to the handle for the LPSPI master.
AnnaBridge 161:aa5281ff4a02 69 * @param status Success or error code describing whether the transfer completed.
AnnaBridge 161:aa5281ff4a02 70 * @param userData Arbitrary pointer-dataSized value passed from the application.
AnnaBridge 161:aa5281ff4a02 71 */
AnnaBridge 161:aa5281ff4a02 72 typedef void (*lpspi_master_edma_transfer_callback_t)(LPSPI_Type *base,
AnnaBridge 161:aa5281ff4a02 73 lpspi_master_edma_handle_t *handle,
AnnaBridge 161:aa5281ff4a02 74 status_t status,
AnnaBridge 161:aa5281ff4a02 75 void *userData);
AnnaBridge 161:aa5281ff4a02 76 /*!
AnnaBridge 161:aa5281ff4a02 77 * @brief Completion callback function pointer type.
AnnaBridge 161:aa5281ff4a02 78 *
AnnaBridge 161:aa5281ff4a02 79 * @param base LPSPI peripheral base address.
AnnaBridge 161:aa5281ff4a02 80 * @param handle Pointer to the handle for the LPSPI slave.
AnnaBridge 161:aa5281ff4a02 81 * @param status Success or error code describing whether the transfer completed.
AnnaBridge 161:aa5281ff4a02 82 * @param userData Arbitrary pointer-dataSized value passed from the application.
AnnaBridge 161:aa5281ff4a02 83 */
AnnaBridge 161:aa5281ff4a02 84 typedef void (*lpspi_slave_edma_transfer_callback_t)(LPSPI_Type *base,
AnnaBridge 161:aa5281ff4a02 85 lpspi_slave_edma_handle_t *handle,
AnnaBridge 161:aa5281ff4a02 86 status_t status,
AnnaBridge 161:aa5281ff4a02 87 void *userData);
AnnaBridge 161:aa5281ff4a02 88
AnnaBridge 161:aa5281ff4a02 89 /*! @brief LPSPI master eDMA transfer handle structure used for transactional API. */
AnnaBridge 161:aa5281ff4a02 90 struct _lpspi_master_edma_handle
AnnaBridge 161:aa5281ff4a02 91 {
AnnaBridge 161:aa5281ff4a02 92 volatile bool isPcsContinuous; /*!< Is PCS continuous in transfer. */
AnnaBridge 161:aa5281ff4a02 93
AnnaBridge 161:aa5281ff4a02 94 volatile bool isByteSwap; /*!< A flag that whether should byte swap. */
AnnaBridge 161:aa5281ff4a02 95
AnnaBridge 161:aa5281ff4a02 96 volatile uint8_t fifoSize; /*!< FIFO dataSize. */
AnnaBridge 161:aa5281ff4a02 97
AnnaBridge 161:aa5281ff4a02 98 volatile uint8_t rxWatermark; /*!< Rx watermark. */
AnnaBridge 161:aa5281ff4a02 99
AnnaBridge 170:e95d10626187 100 volatile uint8_t bytesEachWrite; /*!< Bytes for each write TDR. */
AnnaBridge 170:e95d10626187 101 volatile uint8_t bytesEachRead; /*!< Bytes for each read RDR. */
AnnaBridge 161:aa5281ff4a02 102
AnnaBridge 170:e95d10626187 103 volatile uint8_t bytesLastRead; /*!< Bytes for last read RDR. */
AnnaBridge 161:aa5281ff4a02 104 volatile uint8_t isThereExtraRxBytes; /*!< Is there extra RX byte. */
AnnaBridge 161:aa5281ff4a02 105
AnnaBridge 161:aa5281ff4a02 106 uint8_t *volatile txData; /*!< Send buffer. */
AnnaBridge 161:aa5281ff4a02 107 uint8_t *volatile rxData; /*!< Receive buffer. */
AnnaBridge 161:aa5281ff4a02 108 volatile size_t txRemainingByteCount; /*!< Number of bytes remaining to send.*/
AnnaBridge 161:aa5281ff4a02 109 volatile size_t rxRemainingByteCount; /*!< Number of bytes remaining to receive.*/
AnnaBridge 161:aa5281ff4a02 110
AnnaBridge 161:aa5281ff4a02 111 volatile uint32_t writeRegRemainingTimes; /*!< Write TDR register remaining times. */
AnnaBridge 161:aa5281ff4a02 112 volatile uint32_t readRegRemainingTimes; /*!< Read RDR register remaining times. */
AnnaBridge 161:aa5281ff4a02 113
AnnaBridge 161:aa5281ff4a02 114 uint32_t totalByteCount; /*!< Number of transfer bytes*/
AnnaBridge 161:aa5281ff4a02 115
AnnaBridge 161:aa5281ff4a02 116 uint32_t txBuffIfNull; /*!< Used if there is not txData for DMA purpose.*/
AnnaBridge 161:aa5281ff4a02 117 uint32_t rxBuffIfNull; /*!< Used if there is not rxData for DMA purpose.*/
AnnaBridge 161:aa5281ff4a02 118
AnnaBridge 161:aa5281ff4a02 119 uint32_t transmitCommand; /*!< Used to write TCR for DMA purpose.*/
AnnaBridge 161:aa5281ff4a02 120
AnnaBridge 161:aa5281ff4a02 121 volatile uint8_t state; /*!< LPSPI transfer state , _lpspi_transfer_state.*/
AnnaBridge 161:aa5281ff4a02 122
AnnaBridge 161:aa5281ff4a02 123 uint8_t nbytes; /*!< eDMA minor byte transfer count initially configured. */
AnnaBridge 161:aa5281ff4a02 124
AnnaBridge 161:aa5281ff4a02 125 lpspi_master_edma_transfer_callback_t callback; /*!< Completion callback. */
AnnaBridge 161:aa5281ff4a02 126 void *userData; /*!< Callback user data. */
AnnaBridge 161:aa5281ff4a02 127
AnnaBridge 161:aa5281ff4a02 128 edma_handle_t *edmaRxRegToRxDataHandle; /*!<edma_handle_t handle point used for RxReg to RxData buff*/
AnnaBridge 161:aa5281ff4a02 129 edma_handle_t *edmaTxDataToTxRegHandle; /*!<edma_handle_t handle point used for TxData to TxReg buff*/
AnnaBridge 161:aa5281ff4a02 130
AnnaBridge 170:e95d10626187 131 edma_tcd_t lpspiSoftwareTCD[3]; /*!<SoftwareTCD, internal used*/
AnnaBridge 161:aa5281ff4a02 132 };
AnnaBridge 161:aa5281ff4a02 133
AnnaBridge 161:aa5281ff4a02 134 /*! @brief LPSPI slave eDMA transfer handle structure used for transactional API.*/
AnnaBridge 161:aa5281ff4a02 135 struct _lpspi_slave_edma_handle
AnnaBridge 161:aa5281ff4a02 136 {
AnnaBridge 161:aa5281ff4a02 137 volatile bool isByteSwap; /*!< A flag that whether should byte swap. */
AnnaBridge 161:aa5281ff4a02 138
AnnaBridge 161:aa5281ff4a02 139 volatile uint8_t fifoSize; /*!< FIFO dataSize. */
AnnaBridge 161:aa5281ff4a02 140
AnnaBridge 161:aa5281ff4a02 141 volatile uint8_t rxWatermark; /*!< Rx watermark. */
AnnaBridge 161:aa5281ff4a02 142
AnnaBridge 170:e95d10626187 143 volatile uint8_t bytesEachWrite; /*!< Bytes for each write TDR. */
AnnaBridge 170:e95d10626187 144 volatile uint8_t bytesEachRead; /*!< Bytes for each read RDR. */
AnnaBridge 161:aa5281ff4a02 145
AnnaBridge 170:e95d10626187 146 volatile uint8_t bytesLastRead; /*!< Bytes for last read RDR. */
AnnaBridge 161:aa5281ff4a02 147 volatile uint8_t isThereExtraRxBytes; /*!< Is there extra RX byte. */
AnnaBridge 161:aa5281ff4a02 148
AnnaBridge 161:aa5281ff4a02 149 uint8_t nbytes; /*!< eDMA minor byte transfer count initially configured. */
AnnaBridge 161:aa5281ff4a02 150
AnnaBridge 161:aa5281ff4a02 151 uint8_t *volatile txData; /*!< Send buffer. */
AnnaBridge 161:aa5281ff4a02 152 uint8_t *volatile rxData; /*!< Receive buffer. */
AnnaBridge 161:aa5281ff4a02 153 volatile size_t txRemainingByteCount; /*!< Number of bytes remaining to send.*/
AnnaBridge 161:aa5281ff4a02 154 volatile size_t rxRemainingByteCount; /*!< Number of bytes remaining to receive.*/
AnnaBridge 161:aa5281ff4a02 155
AnnaBridge 170:e95d10626187 156 volatile uint32_t writeRegRemainingTimes; /*!< Write TDR register remaining times. */
AnnaBridge 170:e95d10626187 157 volatile uint32_t readRegRemainingTimes; /*!< Read RDR register remaining times. */
AnnaBridge 161:aa5281ff4a02 158
AnnaBridge 161:aa5281ff4a02 159 uint32_t totalByteCount; /*!< Number of transfer bytes*/
AnnaBridge 161:aa5281ff4a02 160
AnnaBridge 161:aa5281ff4a02 161 uint32_t txBuffIfNull; /*!< Used if there is not txData for DMA purpose.*/
AnnaBridge 161:aa5281ff4a02 162 uint32_t rxBuffIfNull; /*!< Used if there is not rxData for DMA purpose.*/
AnnaBridge 161:aa5281ff4a02 163
AnnaBridge 161:aa5281ff4a02 164 volatile uint8_t state; /*!< LPSPI transfer state.*/
AnnaBridge 161:aa5281ff4a02 165
AnnaBridge 161:aa5281ff4a02 166 uint32_t errorCount; /*!< Error count for slave transfer.*/
AnnaBridge 161:aa5281ff4a02 167
AnnaBridge 161:aa5281ff4a02 168 lpspi_slave_edma_transfer_callback_t callback; /*!< Completion callback. */
AnnaBridge 161:aa5281ff4a02 169 void *userData; /*!< Callback user data. */
AnnaBridge 161:aa5281ff4a02 170
AnnaBridge 161:aa5281ff4a02 171 edma_handle_t *edmaRxRegToRxDataHandle; /*!<edma_handle_t handle point used for RxReg to RxData buff*/
AnnaBridge 161:aa5281ff4a02 172 edma_handle_t *edmaTxDataToTxRegHandle; /*!<edma_handle_t handle point used for TxData to TxReg*/
AnnaBridge 161:aa5281ff4a02 173
AnnaBridge 170:e95d10626187 174 edma_tcd_t lpspiSoftwareTCD[2]; /*!<SoftwareTCD, internal used*/
AnnaBridge 161:aa5281ff4a02 175 };
AnnaBridge 161:aa5281ff4a02 176
AnnaBridge 161:aa5281ff4a02 177 /***********************************************************************************************************************
AnnaBridge 161:aa5281ff4a02 178 * API
AnnaBridge 161:aa5281ff4a02 179 **********************************************************************************************************************/
AnnaBridge 161:aa5281ff4a02 180 #if defined(__cplusplus)
AnnaBridge 161:aa5281ff4a02 181 extern "C" {
AnnaBridge 161:aa5281ff4a02 182 #endif /*_cplusplus*/
AnnaBridge 161:aa5281ff4a02 183
AnnaBridge 161:aa5281ff4a02 184 /*Transactional APIs*/
AnnaBridge 161:aa5281ff4a02 185
AnnaBridge 161:aa5281ff4a02 186 /*!
AnnaBridge 161:aa5281ff4a02 187 * @brief Initializes the LPSPI master eDMA handle.
AnnaBridge 161:aa5281ff4a02 188 *
AnnaBridge 161:aa5281ff4a02 189 * This function initializes the LPSPI eDMA handle which can be used for other LPSPI transactional APIs. Usually, for a
AnnaBridge 161:aa5281ff4a02 190 * specified LPSPI instance, call this API once to get the initialized handle.
AnnaBridge 161:aa5281ff4a02 191 *
AnnaBridge 161:aa5281ff4a02 192 * Note that the LPSPI eDMA has a separated (Rx and Rx as two sources) or shared (Rx and Tx are the same source) DMA
AnnaBridge 161:aa5281ff4a02 193 * request source.
AnnaBridge 161:aa5281ff4a02 194 * (1) For a separated DMA request source, enable and set the Rx DMAMUX source for edmaRxRegToRxDataHandle and
AnnaBridge 161:aa5281ff4a02 195 * Tx DMAMUX source for edmaIntermediaryToTxRegHandle.
AnnaBridge 161:aa5281ff4a02 196 * (2) For a shared DMA request source, enable and set the Rx/Rx DMAMUX source for edmaRxRegToRxDataHandle.
AnnaBridge 161:aa5281ff4a02 197 *
AnnaBridge 161:aa5281ff4a02 198 * @param base LPSPI peripheral base address.
AnnaBridge 161:aa5281ff4a02 199 * @param handle LPSPI handle pointer to lpspi_master_edma_handle_t.
AnnaBridge 161:aa5281ff4a02 200 * @param callback LPSPI callback.
AnnaBridge 161:aa5281ff4a02 201 * @param userData callback function parameter.
AnnaBridge 161:aa5281ff4a02 202 * @param edmaRxRegToRxDataHandle edmaRxRegToRxDataHandle pointer to edma_handle_t.
AnnaBridge 161:aa5281ff4a02 203 * @param edmaTxDataToTxRegHandle edmaTxDataToTxRegHandle pointer to edma_handle_t.
AnnaBridge 161:aa5281ff4a02 204 */
AnnaBridge 161:aa5281ff4a02 205 void LPSPI_MasterTransferCreateHandleEDMA(LPSPI_Type *base,
AnnaBridge 161:aa5281ff4a02 206 lpspi_master_edma_handle_t *handle,
AnnaBridge 161:aa5281ff4a02 207 lpspi_master_edma_transfer_callback_t callback,
AnnaBridge 161:aa5281ff4a02 208 void *userData,
AnnaBridge 161:aa5281ff4a02 209 edma_handle_t *edmaRxRegToRxDataHandle,
AnnaBridge 161:aa5281ff4a02 210 edma_handle_t *edmaTxDataToTxRegHandle);
AnnaBridge 161:aa5281ff4a02 211
AnnaBridge 161:aa5281ff4a02 212 /*!
AnnaBridge 161:aa5281ff4a02 213 * @brief LPSPI master transfer data using eDMA.
AnnaBridge 161:aa5281ff4a02 214 *
AnnaBridge 161:aa5281ff4a02 215 * This function transfers data using eDMA. This is a non-blocking function, which returns right away. When all data
AnnaBridge 161:aa5281ff4a02 216 * is transferred, the callback function is called.
AnnaBridge 161:aa5281ff4a02 217 *
AnnaBridge 161:aa5281ff4a02 218 * Note:
AnnaBridge 161:aa5281ff4a02 219 * The transfer data size should be an integer multiple of bytesPerFrame if bytesPerFrame is less than or equal to 4.
AnnaBridge 161:aa5281ff4a02 220 * For bytesPerFrame greater than 4:
AnnaBridge 161:aa5281ff4a02 221 * The transfer data size should be equal to bytesPerFrame if the bytesPerFrame is not an integer multiple of 4.
AnnaBridge 161:aa5281ff4a02 222 * Otherwise, the transfer data size can be an integer multiple of bytesPerFrame.
AnnaBridge 161:aa5281ff4a02 223 *
AnnaBridge 161:aa5281ff4a02 224 * @param base LPSPI peripheral base address.
AnnaBridge 161:aa5281ff4a02 225 * @param handle pointer to lpspi_master_edma_handle_t structure which stores the transfer state.
AnnaBridge 161:aa5281ff4a02 226 * @param transfer pointer to lpspi_transfer_t structure.
AnnaBridge 161:aa5281ff4a02 227 * @return status of status_t.
AnnaBridge 161:aa5281ff4a02 228 */
AnnaBridge 161:aa5281ff4a02 229 status_t LPSPI_MasterTransferEDMA(LPSPI_Type *base, lpspi_master_edma_handle_t *handle, lpspi_transfer_t *transfer);
AnnaBridge 161:aa5281ff4a02 230
AnnaBridge 161:aa5281ff4a02 231 /*!
AnnaBridge 161:aa5281ff4a02 232 * @brief LPSPI master aborts a transfer which is using eDMA.
AnnaBridge 161:aa5281ff4a02 233 *
AnnaBridge 161:aa5281ff4a02 234 * This function aborts a transfer which is using eDMA.
AnnaBridge 161:aa5281ff4a02 235 *
AnnaBridge 161:aa5281ff4a02 236 * @param base LPSPI peripheral base address.
AnnaBridge 161:aa5281ff4a02 237 * @param handle pointer to lpspi_master_edma_handle_t structure which stores the transfer state.
AnnaBridge 161:aa5281ff4a02 238 */
AnnaBridge 161:aa5281ff4a02 239 void LPSPI_MasterTransferAbortEDMA(LPSPI_Type *base, lpspi_master_edma_handle_t *handle);
AnnaBridge 161:aa5281ff4a02 240
AnnaBridge 161:aa5281ff4a02 241 /*!
AnnaBridge 161:aa5281ff4a02 242 * @brief Gets the master eDMA transfer remaining bytes.
AnnaBridge 161:aa5281ff4a02 243 *
AnnaBridge 161:aa5281ff4a02 244 * This function gets the master eDMA transfer remaining bytes.
AnnaBridge 161:aa5281ff4a02 245 *
AnnaBridge 161:aa5281ff4a02 246 * @param base LPSPI peripheral base address.
AnnaBridge 161:aa5281ff4a02 247 * @param handle pointer to lpspi_master_edma_handle_t structure which stores the transfer state.
AnnaBridge 161:aa5281ff4a02 248 * @param count Number of bytes transferred so far by the EDMA transaction.
AnnaBridge 161:aa5281ff4a02 249 * @return status of status_t.
AnnaBridge 161:aa5281ff4a02 250 */
AnnaBridge 161:aa5281ff4a02 251 status_t LPSPI_MasterTransferGetCountEDMA(LPSPI_Type *base, lpspi_master_edma_handle_t *handle, size_t *count);
AnnaBridge 161:aa5281ff4a02 252
AnnaBridge 161:aa5281ff4a02 253 /*!
AnnaBridge 161:aa5281ff4a02 254 * @brief Initializes the LPSPI slave eDMA handle.
AnnaBridge 161:aa5281ff4a02 255 *
AnnaBridge 161:aa5281ff4a02 256 * This function initializes the LPSPI eDMA handle which can be used for other LPSPI transactional APIs. Usually, for a
AnnaBridge 161:aa5281ff4a02 257 * specified LPSPI instance, call this API once to get the initialized handle.
AnnaBridge 161:aa5281ff4a02 258 *
AnnaBridge 161:aa5281ff4a02 259 * Note that LPSPI eDMA has a separated (Rx and Tx as two sources) or shared (Rx and Tx as the same source) DMA request
AnnaBridge 161:aa5281ff4a02 260 * source.
AnnaBridge 161:aa5281ff4a02 261 *
AnnaBridge 161:aa5281ff4a02 262 * (1) For a separated DMA request source, enable and set the Rx DMAMUX source for edmaRxRegToRxDataHandle and
AnnaBridge 161:aa5281ff4a02 263 * Tx DMAMUX source for edmaTxDataToTxRegHandle.
AnnaBridge 161:aa5281ff4a02 264 * (2) For a shared DMA request source, enable and set the Rx/Rx DMAMUX source for edmaRxRegToRxDataHandle .
AnnaBridge 161:aa5281ff4a02 265 *
AnnaBridge 161:aa5281ff4a02 266 * @param base LPSPI peripheral base address.
AnnaBridge 161:aa5281ff4a02 267 * @param handle LPSPI handle pointer to lpspi_slave_edma_handle_t.
AnnaBridge 161:aa5281ff4a02 268 * @param callback LPSPI callback.
AnnaBridge 161:aa5281ff4a02 269 * @param userData callback function parameter.
AnnaBridge 161:aa5281ff4a02 270 * @param edmaRxRegToRxDataHandle edmaRxRegToRxDataHandle pointer to edma_handle_t.
AnnaBridge 161:aa5281ff4a02 271 * @param edmaTxDataToTxRegHandle edmaTxDataToTxRegHandle pointer to edma_handle_t.
AnnaBridge 161:aa5281ff4a02 272 */
AnnaBridge 161:aa5281ff4a02 273 void LPSPI_SlaveTransferCreateHandleEDMA(LPSPI_Type *base,
AnnaBridge 161:aa5281ff4a02 274 lpspi_slave_edma_handle_t *handle,
AnnaBridge 161:aa5281ff4a02 275 lpspi_slave_edma_transfer_callback_t callback,
AnnaBridge 161:aa5281ff4a02 276 void *userData,
AnnaBridge 161:aa5281ff4a02 277 edma_handle_t *edmaRxRegToRxDataHandle,
AnnaBridge 161:aa5281ff4a02 278 edma_handle_t *edmaTxDataToTxRegHandle);
AnnaBridge 161:aa5281ff4a02 279
AnnaBridge 161:aa5281ff4a02 280 /*!
AnnaBridge 161:aa5281ff4a02 281 * @brief LPSPI slave transfers data using eDMA.
AnnaBridge 161:aa5281ff4a02 282 *
AnnaBridge 161:aa5281ff4a02 283 * This function transfers data using eDMA. This is a non-blocking function, which return right away. When all data
AnnaBridge 161:aa5281ff4a02 284 * is transferred, the callback function is called.
AnnaBridge 161:aa5281ff4a02 285 *
AnnaBridge 161:aa5281ff4a02 286 * Note:
AnnaBridge 161:aa5281ff4a02 287 * The transfer data size should be an integer multiple of bytesPerFrame if bytesPerFrame is less than or equal to 4.
AnnaBridge 161:aa5281ff4a02 288 * For bytesPerFrame greater than 4:
AnnaBridge 161:aa5281ff4a02 289 * The transfer data size should be equal to bytesPerFrame if the bytesPerFrame is not an integer multiple of 4.
AnnaBridge 161:aa5281ff4a02 290 * Otherwise, the transfer data size can be an integer multiple of bytesPerFrame.
AnnaBridge 161:aa5281ff4a02 291 *
AnnaBridge 161:aa5281ff4a02 292 * @param base LPSPI peripheral base address.
AnnaBridge 161:aa5281ff4a02 293 * @param handle pointer to lpspi_slave_edma_handle_t structure which stores the transfer state.
AnnaBridge 161:aa5281ff4a02 294 * @param transfer pointer to lpspi_transfer_t structure.
AnnaBridge 161:aa5281ff4a02 295 * @return status of status_t.
AnnaBridge 161:aa5281ff4a02 296 */
AnnaBridge 161:aa5281ff4a02 297 status_t LPSPI_SlaveTransferEDMA(LPSPI_Type *base, lpspi_slave_edma_handle_t *handle, lpspi_transfer_t *transfer);
AnnaBridge 161:aa5281ff4a02 298
AnnaBridge 161:aa5281ff4a02 299 /*!
AnnaBridge 161:aa5281ff4a02 300 * @brief LPSPI slave aborts a transfer which is using eDMA.
AnnaBridge 161:aa5281ff4a02 301 *
AnnaBridge 161:aa5281ff4a02 302 * This function aborts a transfer which is using eDMA.
AnnaBridge 161:aa5281ff4a02 303 *
AnnaBridge 161:aa5281ff4a02 304 * @param base LPSPI peripheral base address.
AnnaBridge 161:aa5281ff4a02 305 * @param handle pointer to lpspi_slave_edma_handle_t structure which stores the transfer state.
AnnaBridge 161:aa5281ff4a02 306 */
AnnaBridge 161:aa5281ff4a02 307 void LPSPI_SlaveTransferAbortEDMA(LPSPI_Type *base, lpspi_slave_edma_handle_t *handle);
AnnaBridge 161:aa5281ff4a02 308
AnnaBridge 161:aa5281ff4a02 309 /*!
AnnaBridge 161:aa5281ff4a02 310 * @brief Gets the slave eDMA transfer remaining bytes.
AnnaBridge 161:aa5281ff4a02 311 *
AnnaBridge 161:aa5281ff4a02 312 * This function gets the slave eDMA transfer remaining bytes.
AnnaBridge 161:aa5281ff4a02 313 *
AnnaBridge 161:aa5281ff4a02 314 * @param base LPSPI peripheral base address.
AnnaBridge 161:aa5281ff4a02 315 * @param handle pointer to lpspi_slave_edma_handle_t structure which stores the transfer state.
AnnaBridge 161:aa5281ff4a02 316 * @param count Number of bytes transferred so far by the eDMA transaction.
AnnaBridge 161:aa5281ff4a02 317 * @return status of status_t.
AnnaBridge 161:aa5281ff4a02 318 */
AnnaBridge 161:aa5281ff4a02 319 status_t LPSPI_SlaveTransferGetCountEDMA(LPSPI_Type *base, lpspi_slave_edma_handle_t *handle, size_t *count);
AnnaBridge 161:aa5281ff4a02 320
AnnaBridge 161:aa5281ff4a02 321 #if defined(__cplusplus)
AnnaBridge 161:aa5281ff4a02 322 }
AnnaBridge 161:aa5281ff4a02 323 #endif /*_cplusplus*/
AnnaBridge 161:aa5281ff4a02 324 /*!
AnnaBridge 161:aa5281ff4a02 325 *@}
AnnaBridge 161:aa5281ff4a02 326 */
AnnaBridge 161:aa5281ff4a02 327
AnnaBridge 161:aa5281ff4a02 328 #endif /*_FSL_LPSPI_EDMA_H_*/