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_LPC546XX/TOOLCHAIN_GCC_ARM/fsl_spifi_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_SPIFI_DMA_H_
AnnaBridge 171:3a7713b1edbc 35 #define _FSL_SPIFI_DMA_H_
AnnaBridge 171:3a7713b1edbc 36
AnnaBridge 171:3a7713b1edbc 37 #include "fsl_dma.h"
AnnaBridge 171:3a7713b1edbc 38 #include "fsl_spifi.h"
AnnaBridge 171:3a7713b1edbc 39
AnnaBridge 171:3a7713b1edbc 40 /*!
AnnaBridge 171:3a7713b1edbc 41 * @addtogroup spifi
AnnaBridge 171:3a7713b1edbc 42 * @{
AnnaBridge 171:3a7713b1edbc 43 */
AnnaBridge 171:3a7713b1edbc 44
AnnaBridge 171:3a7713b1edbc 45 /*******************************************************************************
AnnaBridge 171:3a7713b1edbc 46 * Definitions
AnnaBridge 171:3a7713b1edbc 47 ******************************************************************************/
AnnaBridge 171:3a7713b1edbc 48
AnnaBridge 171:3a7713b1edbc 49 typedef struct _spifi_dma_handle spifi_dma_handle_t;
AnnaBridge 171:3a7713b1edbc 50
AnnaBridge 171:3a7713b1edbc 51 /*! @brief SPIFI DMA transfer callback function for finish and error */
AnnaBridge 171:3a7713b1edbc 52 typedef void (*spifi_dma_callback_t)(SPIFI_Type *base, spifi_dma_handle_t *handle, status_t status, void *userData);
AnnaBridge 171:3a7713b1edbc 53
AnnaBridge 171:3a7713b1edbc 54 /*! @brief SPIFI DMA transfer handle, users should not touch the content of the handle.*/
AnnaBridge 171:3a7713b1edbc 55 struct _spifi_dma_handle
AnnaBridge 171:3a7713b1edbc 56 {
AnnaBridge 171:3a7713b1edbc 57 dma_handle_t *dmaHandle; /*!< DMA handler for SPIFI send */
AnnaBridge 171:3a7713b1edbc 58 size_t transferSize; /*!< Bytes need to transfer. */
AnnaBridge 171:3a7713b1edbc 59 uint32_t state; /*!< Internal state for SPIFI DMA transfer */
AnnaBridge 171:3a7713b1edbc 60 spifi_dma_callback_t callback; /*!< Callback for users while transfer finish or error occurred */
AnnaBridge 171:3a7713b1edbc 61 void *userData; /*!< User callback parameter */
AnnaBridge 171:3a7713b1edbc 62 };
AnnaBridge 171:3a7713b1edbc 63
AnnaBridge 171:3a7713b1edbc 64 /*******************************************************************************
AnnaBridge 171:3a7713b1edbc 65 * APIs
AnnaBridge 171:3a7713b1edbc 66 ******************************************************************************/
AnnaBridge 171:3a7713b1edbc 67 #if defined(__cplusplus)
AnnaBridge 171:3a7713b1edbc 68 extern "C" {
AnnaBridge 171:3a7713b1edbc 69 #endif
AnnaBridge 171:3a7713b1edbc 70
AnnaBridge 171:3a7713b1edbc 71 /*!
AnnaBridge 171:3a7713b1edbc 72 * @name DMA Transactional
AnnaBridge 171:3a7713b1edbc 73 * @{
AnnaBridge 171:3a7713b1edbc 74 */
AnnaBridge 171:3a7713b1edbc 75
AnnaBridge 171:3a7713b1edbc 76 /*!
AnnaBridge 171:3a7713b1edbc 77 * @brief Initializes the SPIFI handle for send which is used in transactional functions and set the callback.
AnnaBridge 171:3a7713b1edbc 78 *
AnnaBridge 171:3a7713b1edbc 79 * @param base SPIFI peripheral base address
AnnaBridge 171:3a7713b1edbc 80 * @param handle Pointer to spifi_dma_handle_t structure
AnnaBridge 171:3a7713b1edbc 81 * @param callback SPIFI callback, NULL means no callback.
AnnaBridge 171:3a7713b1edbc 82 * @param userData User callback function data.
AnnaBridge 171:3a7713b1edbc 83 * @param rxDmaHandle User requested DMA handle for DMA transfer
AnnaBridge 171:3a7713b1edbc 84 */
AnnaBridge 171:3a7713b1edbc 85 void SPIFI_TransferTxCreateHandleDMA(SPIFI_Type *base,
AnnaBridge 171:3a7713b1edbc 86 spifi_dma_handle_t *handle,
AnnaBridge 171:3a7713b1edbc 87 spifi_dma_callback_t callback,
AnnaBridge 171:3a7713b1edbc 88 void *userData,
AnnaBridge 171:3a7713b1edbc 89 dma_handle_t *dmaHandle);
AnnaBridge 171:3a7713b1edbc 90
AnnaBridge 171:3a7713b1edbc 91 /*!
AnnaBridge 171:3a7713b1edbc 92 * @brief Initializes the SPIFI handle for receive which is used in transactional functions and set the callback.
AnnaBridge 171:3a7713b1edbc 93 *
AnnaBridge 171:3a7713b1edbc 94 * @param base SPIFI peripheral base address
AnnaBridge 171:3a7713b1edbc 95 * @param handle Pointer to spifi_dma_handle_t structure
AnnaBridge 171:3a7713b1edbc 96 * @param callback SPIFI callback, NULL means no callback.
AnnaBridge 171:3a7713b1edbc 97 * @param userData User callback function data.
AnnaBridge 171:3a7713b1edbc 98 * @param rxDmaHandle User requested DMA handle for DMA transfer
AnnaBridge 171:3a7713b1edbc 99 */
AnnaBridge 171:3a7713b1edbc 100 void SPIFI_TransferRxCreateHandleDMA(SPIFI_Type *base,
AnnaBridge 171:3a7713b1edbc 101 spifi_dma_handle_t *handle,
AnnaBridge 171:3a7713b1edbc 102 spifi_dma_callback_t callback,
AnnaBridge 171:3a7713b1edbc 103 void *userData,
AnnaBridge 171:3a7713b1edbc 104 dma_handle_t *dmaHandle);
AnnaBridge 171:3a7713b1edbc 105
AnnaBridge 171:3a7713b1edbc 106 /*!
AnnaBridge 171:3a7713b1edbc 107 * @brief Transfers SPIFI data using an DMA non-blocking method.
AnnaBridge 171:3a7713b1edbc 108 *
AnnaBridge 171:3a7713b1edbc 109 * This function writes data to the SPIFI transmit FIFO. This function is non-blocking.
AnnaBridge 171:3a7713b1edbc 110 * @param base Pointer to QuadSPI Type.
AnnaBridge 171:3a7713b1edbc 111 * @param handle Pointer to spifi_dma_handle_t structure
AnnaBridge 171:3a7713b1edbc 112 * @param xfer SPIFI transfer structure.
AnnaBridge 171:3a7713b1edbc 113 */
AnnaBridge 171:3a7713b1edbc 114 status_t SPIFI_TransferSendDMA(SPIFI_Type *base, spifi_dma_handle_t *handle, spifi_transfer_t *xfer);
AnnaBridge 171:3a7713b1edbc 115
AnnaBridge 171:3a7713b1edbc 116 /*!
AnnaBridge 171:3a7713b1edbc 117 * @brief Receives data using an DMA non-blocking method.
AnnaBridge 171:3a7713b1edbc 118 *
AnnaBridge 171:3a7713b1edbc 119 * This function receive data from the SPIFI receive buffer/FIFO. This function is non-blocking.
AnnaBridge 171:3a7713b1edbc 120 * @param base Pointer to QuadSPI Type.
AnnaBridge 171:3a7713b1edbc 121 * @param handle Pointer to spifi_dma_handle_t structure
AnnaBridge 171:3a7713b1edbc 122 * @param xfer SPIFI transfer structure.
AnnaBridge 171:3a7713b1edbc 123 */
AnnaBridge 171:3a7713b1edbc 124 status_t SPIFI_TransferReceiveDMA(SPIFI_Type *base, spifi_dma_handle_t *handle, spifi_transfer_t *xfer);
AnnaBridge 171:3a7713b1edbc 125
AnnaBridge 171:3a7713b1edbc 126 /*!
AnnaBridge 171:3a7713b1edbc 127 * @brief Aborts the sent data using DMA.
AnnaBridge 171:3a7713b1edbc 128 *
AnnaBridge 171:3a7713b1edbc 129 * This function aborts the sent data using DMA.
AnnaBridge 171:3a7713b1edbc 130 *
AnnaBridge 171:3a7713b1edbc 131 * @param base SPIFI peripheral base address.
AnnaBridge 171:3a7713b1edbc 132 * @param handle Pointer to spifi_dma_handle_t structure
AnnaBridge 171:3a7713b1edbc 133 */
AnnaBridge 171:3a7713b1edbc 134 void SPIFI_TransferAbortSendDMA(SPIFI_Type *base, spifi_dma_handle_t *handle);
AnnaBridge 171:3a7713b1edbc 135
AnnaBridge 171:3a7713b1edbc 136 /*!
AnnaBridge 171:3a7713b1edbc 137 * @brief Aborts the receive data using DMA.
AnnaBridge 171:3a7713b1edbc 138 *
AnnaBridge 171:3a7713b1edbc 139 * This function abort receive data which using DMA.
AnnaBridge 171:3a7713b1edbc 140 *
AnnaBridge 171:3a7713b1edbc 141 * @param base SPIFI peripheral base address.
AnnaBridge 171:3a7713b1edbc 142 * @param handle Pointer to spifi_dma_handle_t structure
AnnaBridge 171:3a7713b1edbc 143 */
AnnaBridge 171:3a7713b1edbc 144 void SPIFI_TransferAbortReceiveDMA(SPIFI_Type *base, spifi_dma_handle_t *handle);
AnnaBridge 171:3a7713b1edbc 145
AnnaBridge 171:3a7713b1edbc 146 /*!
AnnaBridge 171:3a7713b1edbc 147 * @brief Gets the transferred counts of send.
AnnaBridge 171:3a7713b1edbc 148 *
AnnaBridge 171:3a7713b1edbc 149 * @param base Pointer to QuadSPI Type.
AnnaBridge 171:3a7713b1edbc 150 * @param handle Pointer to spifi_dma_handle_t structure.
AnnaBridge 171:3a7713b1edbc 151 * @param count Bytes sent.
AnnaBridge 171:3a7713b1edbc 152 * @retval kStatus_Success Succeed get the transfer count.
AnnaBridge 171:3a7713b1edbc 153 * @retval kStatus_NoTransferInProgress There is not a non-blocking transaction currently in progress.
AnnaBridge 171:3a7713b1edbc 154 */
AnnaBridge 171:3a7713b1edbc 155 status_t SPIFI_TransferGetSendCountDMA(SPIFI_Type *base, spifi_dma_handle_t *handle, size_t *count);
AnnaBridge 171:3a7713b1edbc 156
AnnaBridge 171:3a7713b1edbc 157 /*!
AnnaBridge 171:3a7713b1edbc 158 * @brief Gets the status of the receive transfer.
AnnaBridge 171:3a7713b1edbc 159 *
AnnaBridge 171:3a7713b1edbc 160 * @param base Pointer to QuadSPI Type.
AnnaBridge 171:3a7713b1edbc 161 * @param handle Pointer to spifi_dma_handle_t structure
AnnaBridge 171:3a7713b1edbc 162 * @param count Bytes received.
AnnaBridge 171:3a7713b1edbc 163 * @retval kStatus_Success Succeed get the transfer count.
AnnaBridge 171:3a7713b1edbc 164 * @retval kStatus_NoTransferInProgress There is not a non-blocking transaction currently in progress.
AnnaBridge 171:3a7713b1edbc 165 */
AnnaBridge 171:3a7713b1edbc 166 status_t SPIFI_TransferGetReceiveCountDMA(SPIFI_Type *base, spifi_dma_handle_t *handle, size_t *count);
AnnaBridge 171:3a7713b1edbc 167
AnnaBridge 171:3a7713b1edbc 168 /* @} */
AnnaBridge 171:3a7713b1edbc 169
AnnaBridge 171:3a7713b1edbc 170 #if defined(__cplusplus)
AnnaBridge 171:3a7713b1edbc 171 }
AnnaBridge 171:3a7713b1edbc 172 #endif
AnnaBridge 171:3a7713b1edbc 173
AnnaBridge 171:3a7713b1edbc 174 /* @} */
AnnaBridge 171:3a7713b1edbc 175
AnnaBridge 171:3a7713b1edbc 176 #endif /* _FSL_SPIFI_DMA_H_ */