mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

cmsis/BUILD/mbed/TARGET_K82F/TOOLCHAIN_IAR/fsl_qspi_edma.h@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 189:f392fc9709a3 1 /*
AnnaBridge 189:f392fc9709a3 2 * Copyright (c) 2015, Freescale Semiconductor, Inc.
AnnaBridge 189:f392fc9709a3 3 * All rights reserved.
AnnaBridge 189:f392fc9709a3 4 *
AnnaBridge 189:f392fc9709a3 5 * Redistribution and use in source and binary forms, with or without modification,
AnnaBridge 189:f392fc9709a3 6 * are permitted provided that the following conditions are met:
AnnaBridge 189:f392fc9709a3 7 *
AnnaBridge 189:f392fc9709a3 8 * o Redistributions of source code must retain the above copyright notice, this list
AnnaBridge 189:f392fc9709a3 9 * of conditions and the following disclaimer.
AnnaBridge 189:f392fc9709a3 10 *
AnnaBridge 189:f392fc9709a3 11 * o Redistributions in binary form must reproduce the above copyright notice, this
AnnaBridge 189:f392fc9709a3 12 * list of conditions and the following disclaimer in the documentation and/or
AnnaBridge 189:f392fc9709a3 13 * other materials provided with the distribution.
AnnaBridge 189:f392fc9709a3 14 *
AnnaBridge 189:f392fc9709a3 15 * o Neither the name of Freescale Semiconductor, Inc. nor the names of its
AnnaBridge 189:f392fc9709a3 16 * contributors may be used to endorse or promote products derived from this
AnnaBridge 189:f392fc9709a3 17 * software without specific prior written permission.
AnnaBridge 189:f392fc9709a3 18 *
AnnaBridge 189:f392fc9709a3 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
AnnaBridge 189:f392fc9709a3 20 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
AnnaBridge 189:f392fc9709a3 21 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
AnnaBridge 189:f392fc9709a3 22 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
AnnaBridge 189:f392fc9709a3 23 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
AnnaBridge 189:f392fc9709a3 24 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
AnnaBridge 189:f392fc9709a3 25 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
AnnaBridge 189:f392fc9709a3 26 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
AnnaBridge 189:f392fc9709a3 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
AnnaBridge 189:f392fc9709a3 28 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
AnnaBridge 189:f392fc9709a3 29 */
AnnaBridge 189:f392fc9709a3 30
AnnaBridge 189:f392fc9709a3 31 #ifndef _FSL_QSPI_EDMA_H_
AnnaBridge 189:f392fc9709a3 32 #define _FSL_QSPI_EDMA_H_
AnnaBridge 189:f392fc9709a3 33
AnnaBridge 189:f392fc9709a3 34 #include "fsl_qspi.h"
AnnaBridge 189:f392fc9709a3 35 #include "fsl_edma.h"
AnnaBridge 189:f392fc9709a3 36
AnnaBridge 189:f392fc9709a3 37 /*!
AnnaBridge 189:f392fc9709a3 38 * @addtogroup qspi_edma
AnnaBridge 189:f392fc9709a3 39 * @{
AnnaBridge 189:f392fc9709a3 40 */
AnnaBridge 189:f392fc9709a3 41
AnnaBridge 189:f392fc9709a3 42 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 43 * Definitions
AnnaBridge 189:f392fc9709a3 44 ******************************************************************************/
AnnaBridge 189:f392fc9709a3 45
AnnaBridge 189:f392fc9709a3 46 typedef struct _qspi_edma_handle qspi_edma_handle_t;
AnnaBridge 189:f392fc9709a3 47
AnnaBridge 189:f392fc9709a3 48 /*! @brief QSPI eDMA transfer callback function for finish and error */
AnnaBridge 189:f392fc9709a3 49 typedef void (*qspi_edma_callback_t)(QuadSPI_Type *base, qspi_edma_handle_t *handle, status_t status, void *userData);
AnnaBridge 189:f392fc9709a3 50
AnnaBridge 189:f392fc9709a3 51 /*! @brief QSPI DMA transfer handle, users should not touch the content of the handle.*/
AnnaBridge 189:f392fc9709a3 52 struct _qspi_edma_handle
AnnaBridge 189:f392fc9709a3 53 {
AnnaBridge 189:f392fc9709a3 54 edma_handle_t *dmaHandle; /*!< eDMA handler for QSPI send */
AnnaBridge 189:f392fc9709a3 55 size_t transferSize; /*!< Bytes need to transfer. */
AnnaBridge 189:f392fc9709a3 56 uint8_t nbytes; /*!< eDMA minor byte transfer count initially configured. */
AnnaBridge 189:f392fc9709a3 57 uint8_t count; /*!< The transfer data count in a DMA request */
AnnaBridge 189:f392fc9709a3 58 uint32_t state; /*!< Internal state for QSPI eDMA transfer */
AnnaBridge 189:f392fc9709a3 59 qspi_edma_callback_t callback; /*!< Callback for users while transfer finish or error occurred */
AnnaBridge 189:f392fc9709a3 60 void *userData; /*!< User callback parameter */
AnnaBridge 189:f392fc9709a3 61 };
AnnaBridge 189:f392fc9709a3 62
AnnaBridge 189:f392fc9709a3 63 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 64 * APIs
AnnaBridge 189:f392fc9709a3 65 ******************************************************************************/
AnnaBridge 189:f392fc9709a3 66 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 67 extern "C" {
AnnaBridge 189:f392fc9709a3 68 #endif
AnnaBridge 189:f392fc9709a3 69
AnnaBridge 189:f392fc9709a3 70 /*!
AnnaBridge 189:f392fc9709a3 71 * @name eDMA Transactional
AnnaBridge 189:f392fc9709a3 72 * @{
AnnaBridge 189:f392fc9709a3 73 */
AnnaBridge 189:f392fc9709a3 74
AnnaBridge 189:f392fc9709a3 75 /*!
AnnaBridge 189:f392fc9709a3 76 * @brief Initializes the QSPI handle for send which is used in transactional functions and set the callback.
AnnaBridge 189:f392fc9709a3 77 *
AnnaBridge 189:f392fc9709a3 78 * @param base QSPI peripheral base address
AnnaBridge 189:f392fc9709a3 79 * @param handle Pointer to qspi_edma_handle_t structure
AnnaBridge 189:f392fc9709a3 80 * @param callback QSPI callback, NULL means no callback.
AnnaBridge 189:f392fc9709a3 81 * @param userData User callback function data.
AnnaBridge 189:f392fc9709a3 82 * @param rxDmaHandle User requested eDMA handle for eDMA transfer
AnnaBridge 189:f392fc9709a3 83 */
AnnaBridge 189:f392fc9709a3 84 void QSPI_TransferTxCreateHandleEDMA(QuadSPI_Type *base,
AnnaBridge 189:f392fc9709a3 85 qspi_edma_handle_t *handle,
AnnaBridge 189:f392fc9709a3 86 qspi_edma_callback_t callback,
AnnaBridge 189:f392fc9709a3 87 void *userData,
AnnaBridge 189:f392fc9709a3 88 edma_handle_t *dmaHandle);
AnnaBridge 189:f392fc9709a3 89
AnnaBridge 189:f392fc9709a3 90 /*!
AnnaBridge 189:f392fc9709a3 91 * @brief Initializes the QSPI handle for receive which is used in transactional functions and set the callback.
AnnaBridge 189:f392fc9709a3 92 *
AnnaBridge 189:f392fc9709a3 93 * @param base QSPI peripheral base address
AnnaBridge 189:f392fc9709a3 94 * @param handle Pointer to qspi_edma_handle_t structure
AnnaBridge 189:f392fc9709a3 95 * @param callback QSPI callback, NULL means no callback.
AnnaBridge 189:f392fc9709a3 96 * @param userData User callback function data.
AnnaBridge 189:f392fc9709a3 97 * @param rxDmaHandle User requested eDMA handle for eDMA transfer
AnnaBridge 189:f392fc9709a3 98 */
AnnaBridge 189:f392fc9709a3 99 void QSPI_TransferRxCreateHandleEDMA(QuadSPI_Type *base,
AnnaBridge 189:f392fc9709a3 100 qspi_edma_handle_t *handle,
AnnaBridge 189:f392fc9709a3 101 qspi_edma_callback_t callback,
AnnaBridge 189:f392fc9709a3 102 void *userData,
AnnaBridge 189:f392fc9709a3 103 edma_handle_t *dmaHandle);
AnnaBridge 189:f392fc9709a3 104
AnnaBridge 189:f392fc9709a3 105 /*!
AnnaBridge 189:f392fc9709a3 106 * @brief Transfers QSPI data using an eDMA non-blocking method.
AnnaBridge 189:f392fc9709a3 107 *
AnnaBridge 189:f392fc9709a3 108 * This function writes data to the QSPI transmit FIFO. This function is non-blocking.
AnnaBridge 189:f392fc9709a3 109 * @param base Pointer to QuadSPI Type.
AnnaBridge 189:f392fc9709a3 110 * @param handle Pointer to qspi_edma_handle_t structure
AnnaBridge 189:f392fc9709a3 111 * @param xfer QSPI transfer structure.
AnnaBridge 189:f392fc9709a3 112 */
AnnaBridge 189:f392fc9709a3 113 status_t QSPI_TransferSendEDMA(QuadSPI_Type *base, qspi_edma_handle_t *handle, qspi_transfer_t *xfer);
AnnaBridge 189:f392fc9709a3 114
AnnaBridge 189:f392fc9709a3 115 /*!
AnnaBridge 189:f392fc9709a3 116 * @brief Receives data using an eDMA non-blocking method.
AnnaBridge 189:f392fc9709a3 117 *
AnnaBridge 189:f392fc9709a3 118 * This function receive data from the QSPI receive buffer/FIFO. This function is non-blocking.
AnnaBridge 189:f392fc9709a3 119 * @param base Pointer to QuadSPI Type.
AnnaBridge 189:f392fc9709a3 120 * @param handle Pointer to qspi_edma_handle_t structure
AnnaBridge 189:f392fc9709a3 121 * @param xfer QSPI transfer structure.
AnnaBridge 189:f392fc9709a3 122 */
AnnaBridge 189:f392fc9709a3 123 status_t QSPI_TransferReceiveEDMA(QuadSPI_Type *base, qspi_edma_handle_t *handle, qspi_transfer_t *xfer);
AnnaBridge 189:f392fc9709a3 124
AnnaBridge 189:f392fc9709a3 125 /*!
AnnaBridge 189:f392fc9709a3 126 * @brief Aborts the sent data using eDMA.
AnnaBridge 189:f392fc9709a3 127 *
AnnaBridge 189:f392fc9709a3 128 * This function aborts the sent data using eDMA.
AnnaBridge 189:f392fc9709a3 129 *
AnnaBridge 189:f392fc9709a3 130 * @param base QSPI peripheral base address.
AnnaBridge 189:f392fc9709a3 131 * @param handle Pointer to qspi_edma_handle_t structure
AnnaBridge 189:f392fc9709a3 132 */
AnnaBridge 189:f392fc9709a3 133 void QSPI_TransferAbortSendEDMA(QuadSPI_Type *base, qspi_edma_handle_t *handle);
AnnaBridge 189:f392fc9709a3 134
AnnaBridge 189:f392fc9709a3 135 /*!
AnnaBridge 189:f392fc9709a3 136 * @brief Aborts the receive data using eDMA.
AnnaBridge 189:f392fc9709a3 137 *
AnnaBridge 189:f392fc9709a3 138 * This function abort receive data which using eDMA.
AnnaBridge 189:f392fc9709a3 139 *
AnnaBridge 189:f392fc9709a3 140 * @param base QSPI peripheral base address.
AnnaBridge 189:f392fc9709a3 141 * @param handle Pointer to qspi_edma_handle_t structure
AnnaBridge 189:f392fc9709a3 142 */
AnnaBridge 189:f392fc9709a3 143 void QSPI_TransferAbortReceiveEDMA(QuadSPI_Type *base, qspi_edma_handle_t *handle);
AnnaBridge 189:f392fc9709a3 144
AnnaBridge 189:f392fc9709a3 145 /*!
AnnaBridge 189:f392fc9709a3 146 * @brief Gets the transferred counts of send.
AnnaBridge 189:f392fc9709a3 147 *
AnnaBridge 189:f392fc9709a3 148 * @param base Pointer to QuadSPI Type.
AnnaBridge 189:f392fc9709a3 149 * @param handle Pointer to qspi_edma_handle_t structure.
AnnaBridge 189:f392fc9709a3 150 * @param count Bytes sent.
AnnaBridge 189:f392fc9709a3 151 * @retval kStatus_Success Succeed get the transfer count.
AnnaBridge 189:f392fc9709a3 152 * @retval kStatus_NoTransferInProgress There is not a non-blocking transaction currently in progress.
AnnaBridge 189:f392fc9709a3 153 */
AnnaBridge 189:f392fc9709a3 154 status_t QSPI_TransferGetSendCountEDMA(QuadSPI_Type *base, qspi_edma_handle_t *handle, size_t *count);
AnnaBridge 189:f392fc9709a3 155
AnnaBridge 189:f392fc9709a3 156 /*!
AnnaBridge 189:f392fc9709a3 157 * @brief Gets the status of the receive transfer.
AnnaBridge 189:f392fc9709a3 158 *
AnnaBridge 189:f392fc9709a3 159 * @param base Pointer to QuadSPI Type.
AnnaBridge 189:f392fc9709a3 160 * @param handle Pointer to qspi_edma_handle_t structure
AnnaBridge 189:f392fc9709a3 161 * @param count Bytes received.
AnnaBridge 189:f392fc9709a3 162 * @retval kStatus_Success Succeed get the transfer count.
AnnaBridge 189:f392fc9709a3 163 * @retval kStatus_NoTransferInProgress There is not a non-blocking transaction currently in progress.
AnnaBridge 189:f392fc9709a3 164 */
AnnaBridge 189:f392fc9709a3 165 status_t QSPI_TransferGetReceiveCountEDMA(QuadSPI_Type *base, qspi_edma_handle_t *handle, size_t *count);
AnnaBridge 189:f392fc9709a3 166
AnnaBridge 189:f392fc9709a3 167 /* @} */
AnnaBridge 189:f392fc9709a3 168
AnnaBridge 189:f392fc9709a3 169 #if defined(__cplusplus)
AnnaBridge 189:f392fc9709a3 170 }
AnnaBridge 189:f392fc9709a3 171 #endif
AnnaBridge 189:f392fc9709a3 172
AnnaBridge 189:f392fc9709a3 173 /* @} */
AnnaBridge 189:f392fc9709a3 174
AnnaBridge 189:f392fc9709a3 175 #endif /* _FSL_QSPI_EDMA_H_ */