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