Quad Serial Peripheral Interface DMA Driver

Overview

Data Structures
struct	qspi_dma_handle_t
	QSPI DMA transfer handle, users should not touch the content of the handle. More...

Typedefs
typedef void(*	qspi_dma_callback_t )(QuadSPI_Type *base, qspi_dma_handle_t *handle, status_t status, void *userData)
	QSPI DMA transfer callback function for finish and error.

Driver version
#define	FSL_QSPI_DMA_DRIVER_VERSION   (MAKE_VERSION(2, 0, 0))
	QSPI DMA driver version 2.0.0. More...

DMA Transactional
void	QSPI_TransferTxCreateHandleDMA (QuadSPI_Type *base, qspi_dma_handle_t *handle, qspi_dma_callback_t callback, void *userData, dma_handle_t *dmaHandle)
	Initializes the QSPI handle for send which is used in transactional functions and set the callback. More...
status_t	QSPI_TransferSendDMA (QuadSPI_Type *base, qspi_dma_handle_t *handle, qspi_transfer_t *xfer)
	Transfers QSPI data using an DMA non-blocking method. More...
void	QSPI_TransferAbortSendDMA (QuadSPI_Type *base, qspi_dma_handle_t *handle)
	Aborts the sent data using DMA. More...
status_t	QSPI_TransferGetSendCountDMA (QuadSPI_Type *base, qspi_dma_handle_t *handle, size_t *count)
	Gets the transferred counts of send. More...

---

Data Structure Documentation

struct _qspi_dma_handle

Data Fields
dma_handle_t *	dmaHandle
	DMA handler start pointer for QSPI send.
size_t	transferSize
	Bytes need to transfer. More...
uint32_t	state
	Internal state for QSPI DMA transfer.
qspi_dma_callback_t	callback
	Callback for users while transfer finish or error occurred.
void *	userData
	User callback parameter.

Field Documentation

size_t qspi_dma_handle_t::transferSize

Macro Definition Documentation

#define FSL_QSPI_DMA_DRIVER_VERSION   (MAKE_VERSION(2, 0, 0))

Function Documentation

void QSPI_TransferTxCreateHandleDMA	(	QuadSPI_Type *	base,
		qspi_dma_handle_t *	handle,
		qspi_dma_callback_t	callback,
		void *	userData,
		dma_handle_t *	dmaHandle
	)

Parameters

base	QSPI peripheral base address
handle	Pointer to qspi_dma_handle_t structure
callback	QSPI callback, NULL means no callback.
userData	User callback function data.
dmaHandle	User requested DMA handle start pointer for DMA transfer
handleCount	Count for dma Handle.

status_t QSPI_TransferSendDMA	(	QuadSPI_Type *	base,
		qspi_dma_handle_t *	handle,
		qspi_transfer_t *	xfer
	)

This function writes data to the QSPI transmit FIFO. This function is non-blocking.

Parameters

base	Pointer to QuadSPI Type.
handle	Pointer to qspi_dma_handle_t structure
xfer	QSPI transfer structure.

void QSPI_TransferAbortSendDMA	(	QuadSPI_Type *	base,
		qspi_dma_handle_t *	handle
	)

This function aborts the sent data using DMA.

Parameters

base	QSPI peripheral base address.
handle	Pointer to qspi_dma_handle_t structure

status_t QSPI_TransferGetSendCountDMA	(	QuadSPI_Type *	base,
		qspi_dma_handle_t *	handle,
		size_t *	count
	)

Parameters

base	Pointer to QuadSPI Type.
handle	Pointer to qspi_dma_handle_t structure.
count	Bytes sent.

Return values

kStatus_Success	Succeed get the transfer count.
kStatus_NoTransferInProgress	There is not a non-blocking transaction currently in progress.