Flexio_dma_uart

Data Structures
struct	_flexio_uart_dma_handle
	UART DMA handle. More...

Variables
flexio_uart_dma_transfer_callback_t	_flexio_uart_dma_handle::callback
void *	_flexio_uart_dma_handle::userData
size_t	_flexio_uart_dma_handle::txDataSizeAll
size_t	_flexio_uart_dma_handle::rxDataSizeAll
dma_handle_t *	_flexio_uart_dma_handle::txDmaHandle
dma_handle_t *	_flexio_uart_dma_handle::rxDmaHandle
volatile uint8_t	_flexio_uart_dma_handle::txState
volatile uint8_t	_flexio_uart_dma_handle::rxState

Driver version
typedef struct _flexio_uart_dma_handle	flexio_uart_dma_handle_t
typedef void(*	flexio_uart_dma_transfer_callback_t) (FLEXIO_UART_Type *base, flexio_uart_dma_handle_t *handle, status_t status, void *userData)
	UART transfer callback function.
#define	FSL_FLEXIO_UART_DMA_DRIVER_VERSION   (MAKE_VERSION(2, 4, 0))
	FlexIO UART DMA driver version.

eDMA transactional
status_t	FLEXIO_UART_TransferCreateHandleDMA (FLEXIO_UART_Type *base, flexio_uart_dma_handle_t *handle, flexio_uart_dma_transfer_callback_t callback, void *userData, dma_handle_t *txDmaHandle, dma_handle_t *rxDmaHandle)
	Initializes the FLEXIO_UART handle which is used in transactional functions.
status_t	FLEXIO_UART_TransferSendDMA (FLEXIO_UART_Type *base, flexio_uart_dma_handle_t *handle, flexio_uart_transfer_t *xfer)
	Sends data using DMA.
status_t	FLEXIO_UART_TransferReceiveDMA (FLEXIO_UART_Type *base, flexio_uart_dma_handle_t *handle, flexio_uart_transfer_t *xfer)
	Receives data using DMA.
void	FLEXIO_UART_TransferAbortSendDMA (FLEXIO_UART_Type *base, flexio_uart_dma_handle_t *handle)
	Aborts the sent data which using DMA.
void	FLEXIO_UART_TransferAbortReceiveDMA (FLEXIO_UART_Type *base, flexio_uart_dma_handle_t *handle)
	Aborts the receive data which using DMA.
status_t	FLEXIO_UART_TransferGetSendCountDMA (FLEXIO_UART_Type *base, flexio_uart_dma_handle_t *handle, size_t *count)
	Gets the number of bytes sent out.
status_t	FLEXIO_UART_TransferGetReceiveCountDMA (FLEXIO_UART_Type *base, flexio_uart_dma_handle_t *handle, size_t *count)
	Gets the number of bytes received.

Detailed Description

Function Documentation

FLEXIO_UART_TransferAbortReceiveDMA()

void FLEXIO_UART_TransferAbortReceiveDMA	(	FLEXIO_UART_Type *	base,
		flexio_uart_dma_handle_t *	handle
	)

Aborts the receive data which using DMA.

This function aborts the receive data which using DMA.

Parameters

base	Pointer to FLEXIO_UART_Type structure
handle	Pointer to flexio_uart_dma_handle_t structure

FLEXIO_UART_TransferAbortSendDMA()

void FLEXIO_UART_TransferAbortSendDMA	(	FLEXIO_UART_Type *	base,
		flexio_uart_dma_handle_t *	handle
	)

Aborts the sent data which using DMA.

This function aborts the sent data which using DMA.

Parameters

base	Pointer to FLEXIO_UART_Type structure
handle	Pointer to flexio_uart_dma_handle_t structure

FLEXIO_UART_TransferCreateHandleDMA()

status_t FLEXIO_UART_TransferCreateHandleDMA	(	FLEXIO_UART_Type *	base,
		flexio_uart_dma_handle_t *	handle,
		flexio_uart_dma_transfer_callback_t	callback,
		void *	userData,
		dma_handle_t *	txDmaHandle,
		dma_handle_t *	rxDmaHandle
	)

Initializes the FLEXIO_UART handle which is used in transactional functions.

Parameters

base	Pointer to FLEXIO_UART_Type structure.
handle	Pointer to flexio_uart_dma_handle_t structure.
callback	FlexIO UART callback, NULL means no callback.
userData	User callback function data.
txDmaHandle	User requested DMA handle for TX DMA transfer.
rxDmaHandle	User requested DMA handle for RX DMA transfer.

Return values

kStatus_Success	Successfully create the handle.
kStatus_OutOfRange	The FlexIO UART DMA type/handle table out of range.

FLEXIO_UART_TransferGetReceiveCountDMA()

status_t FLEXIO_UART_TransferGetReceiveCountDMA	(	FLEXIO_UART_Type *	base,
		flexio_uart_dma_handle_t *	handle,
		size_t *	count
	)

Gets the number of bytes received.

This function gets the number of bytes received.

Parameters

base	Pointer to FLEXIO_UART_Type structure
handle	Pointer to flexio_uart_dma_handle_t structure
count	Number of bytes received so far by the non-blocking transaction.

Return values

kStatus_NoTransferInProgress	transfer has finished or no transfer in progress.
kStatus_Success	Successfully return the count.

FLEXIO_UART_TransferGetSendCountDMA()

status_t FLEXIO_UART_TransferGetSendCountDMA	(	FLEXIO_UART_Type *	base,
		flexio_uart_dma_handle_t *	handle,
		size_t *	count
	)

Gets the number of bytes sent out.

This function gets the number of bytes sent out.

Parameters

base	Pointer to FLEXIO_UART_Type structure
handle	Pointer to flexio_uart_dma_handle_t structure
count	Number of bytes sent so far by the non-blocking transaction.

Return values

kStatus_NoTransferInProgress	transfer has finished or no transfer in progress.
kStatus_Success	Successfully return the count.

FLEXIO_UART_TransferReceiveDMA()

status_t FLEXIO_UART_TransferReceiveDMA	(	FLEXIO_UART_Type *	base,
		flexio_uart_dma_handle_t *	handle,
		flexio_uart_transfer_t *	xfer
	)

Receives data using DMA.

This function receives data using DMA. This is non-blocking function, which returns right away. When all data is received, the receive callback function is called.

Parameters

base	Pointer to FLEXIO_UART_Type structure
handle	Pointer to flexio_uart_dma_handle_t structure
xfer	FLEXIO_UART DMA transfer structure, see flexio_uart_transfer_t.

Return values

kStatus_Success	if succeed, others failed.
kStatus_FLEXIO_UART_RxBusy	Previous transfer on going.

FLEXIO_UART_TransferSendDMA()

status_t FLEXIO_UART_TransferSendDMA	(	FLEXIO_UART_Type *	base,
		flexio_uart_dma_handle_t *	handle,
		flexio_uart_transfer_t *	xfer
	)

Sends data using DMA.

This function send data using DMA. This is non-blocking function, which returns right away. When all data is sent out, the send callback function is called.

Parameters

base	Pointer to FLEXIO_UART_Type structure
handle	Pointer to flexio_uart_dma_handle_t structure
xfer	FLEXIO_UART DMA transfer structure, see flexio_uart_transfer_t.

Return values

kStatus_Success	if succeed, others failed.
kStatus_FLEXIO_UART_TxBusy	Previous transfer on going.

Variable Documentation

callback

flexio_uart_dma_transfer_callback_t _flexio_uart_dma_handle::callback

Callback function.

rxDataSizeAll

size_t _flexio_uart_dma_handle::rxDataSizeAll

Total bytes to be received.

rxDmaHandle

dma_handle_t* _flexio_uart_dma_handle::rxDmaHandle

The DMA RX channel used.

rxState

volatile uint8_t _flexio_uart_dma_handle::rxState

RX transfer state

txDataSizeAll

size_t _flexio_uart_dma_handle::txDataSizeAll

Total bytes to be sent.

txDmaHandle

dma_handle_t* _flexio_uart_dma_handle::txDmaHandle

The DMA TX channel used.

txState

volatile uint8_t _flexio_uart_dma_handle::txState

TX transfer state.

userData

void* _flexio_uart_dma_handle::userData

UART callback function parameter.