Flexio_edma_camera

Data Structures
struct	_flexio_camera_edma_handle
	Camera eDMA handle. More...

Variables
flexio_camera_edma_transfer_callback_t	_flexio_camera_edma_handle::callback
void *	_flexio_camera_edma_handle::userData
size_t	_flexio_camera_edma_handle::rxSize
edma_handle_t *	_flexio_camera_edma_handle::rxEdmaHandle
uint8_t	_flexio_camera_edma_handle::nbytes
volatile uint8_t	_flexio_camera_edma_handle::rxState

Driver version
typedef struct _flexio_camera_edma_handle	flexio_camera_edma_handle_t
	Forward declaration of the handle typedef.
typedef void(*	flexio_camera_edma_transfer_callback_t) (FLEXIO_CAMERA_Type *base, flexio_camera_edma_handle_t *handle, status_t status, void *userData)
	Camera transfer callback function.
#define	FSL_FLEXIO_CAMERA_EDMA_DRIVER_VERSION   (MAKE_VERSION(2, 1, 3))
	FlexIO Camera EDMA driver version 2.1.3.

eDMA transactional
status_t	FLEXIO_CAMERA_TransferCreateHandleEDMA (FLEXIO_CAMERA_Type *base, flexio_camera_edma_handle_t *handle, flexio_camera_edma_transfer_callback_t callback, void *userData, edma_handle_t *rxEdmaHandle)
	Initializes the Camera handle, which is used in transactional functions.
status_t	FLEXIO_CAMERA_TransferReceiveEDMA (FLEXIO_CAMERA_Type *base, flexio_camera_edma_handle_t *handle, flexio_camera_transfer_t *xfer)
	Receives data using eDMA.
void	FLEXIO_CAMERA_TransferAbortReceiveEDMA (FLEXIO_CAMERA_Type *base, flexio_camera_edma_handle_t *handle)
	Aborts the receive data which used the eDMA.
status_t	FLEXIO_CAMERA_TransferGetReceiveCountEDMA (FLEXIO_CAMERA_Type *base, flexio_camera_edma_handle_t *handle, size_t *count)
	Gets the remaining bytes to be received.

Detailed Description

Function Documentation

FLEXIO_CAMERA_TransferAbortReceiveEDMA()

void FLEXIO_CAMERA_TransferAbortReceiveEDMA	(	FLEXIO_CAMERA_Type *	base,
		flexio_camera_edma_handle_t *	handle
	)

Aborts the receive data which used the eDMA.

This function aborts the receive data which used the eDMA.

Parameters

base	Pointer to the FLEXIO_CAMERA_Type.
handle	Pointer to the flexio_camera_edma_handle_t structure.

FLEXIO_CAMERA_TransferCreateHandleEDMA()

status_t FLEXIO_CAMERA_TransferCreateHandleEDMA	(	FLEXIO_CAMERA_Type *	base,
		flexio_camera_edma_handle_t *	handle,
		flexio_camera_edma_transfer_callback_t	callback,
		void *	userData,
		edma_handle_t *	rxEdmaHandle
	)

Initializes the Camera handle, which is used in transactional functions.

Parameters

base	Pointer to the FLEXIO_CAMERA_Type.
handle	Pointer to flexio_camera_edma_handle_t structure.
callback	The callback function.
userData	The parameter of the callback function.
rxEdmaHandle	User requested DMA handle for RX DMA transfer.

Return values

kStatus_Success	Successfully create the handle.
kStatus_OutOfRange	The FlexIO Camera eDMA type/handle table out of range.

FLEXIO_CAMERA_TransferGetReceiveCountEDMA()

status_t FLEXIO_CAMERA_TransferGetReceiveCountEDMA	(	FLEXIO_CAMERA_Type *	base,
		flexio_camera_edma_handle_t *	handle,
		size_t *	count
	)

Gets the remaining bytes to be received.

This function gets the number of bytes still not received.

Parameters

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

Return values

kStatus_Success	Succeed get the transfer count.
kStatus_InvalidArgument	The count parameter is invalid.

FLEXIO_CAMERA_TransferReceiveEDMA()

status_t FLEXIO_CAMERA_TransferReceiveEDMA	(	FLEXIO_CAMERA_Type *	base,
		flexio_camera_edma_handle_t *	handle,
		flexio_camera_transfer_t *	xfer
	)

Receives data using eDMA.

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

Parameters

base	Pointer to the FLEXIO_CAMERA_Type.
handle	Pointer to the flexio_camera_edma_handle_t structure.
xfer	Camera eDMA transfer structure, see flexio_camera_transfer_t.

Return values

kStatus_Success	if succeeded, others failed.
kStatus_CAMERA_RxBusy	Previous transfer on going.

Variable Documentation

callback

flexio_camera_edma_transfer_callback_t _flexio_camera_edma_handle::callback

Callback function.

nbytes

uint8_t _flexio_camera_edma_handle::nbytes

eDMA minor byte transfer count initially configured.

rxEdmaHandle

edma_handle_t* _flexio_camera_edma_handle::rxEdmaHandle

The eDMA RX channel used.

rxSize

size_t _flexio_camera_edma_handle::rxSize

Total bytes to be received.

rxState

volatile uint8_t _flexio_camera_edma_handle::rxState

RX transfer state

userData

void* _flexio_camera_edma_handle::userData

Camera callback function parameter.