DMA transfer completion parameters. More...

#include <dma_types.h>

Collaboration diagram for odp_dma_compl_param_t:

Data Fields
odp_dma_compl_mode_t	compl_mode
	Completion mode. More...

odp_dma_transfer_id_t	transfer_id
	Transfer identifier. More...

odp_event_t	event
	Completion event. More...

odp_queue_t	queue
	Completion queue. More...

void *	user_ptr
	User context pointer. More...

Detailed Description

DMA transfer completion parameters.

Examples: odp_dma_perf.c, and odp_dmafwd.c.

Definition at line 500 of file api/spec/dma_types.h.

Field Documentation

◆ compl_mode

odp_dma_compl_mode_t odp_dma_compl_param_t::compl_mode

Completion mode.

Select a completion mode: ODP_DMA_COMPL_EVENT, ODP_DMA_COMPL_POLL or ODP_DMA_COMPL_NONE. The mode must match one of the modes selected in session creation parameters (odp_dma_param_t::compl_mode_mask).

ODP_DMA_COMPL_NONE can be used to specify that completion indication is not requested. Application may for example start a series of transfers and request completion indication only on the last one.

Examples: odp_dma_perf.c, and odp_dmafwd.c.

Definition at line 511 of file api/spec/dma_types.h.

◆ transfer_id

odp_dma_transfer_id_t odp_dma_compl_param_t::transfer_id

Transfer identifier.

Transfer identifier is used in ODP_DMA_COMPL_POLL mode. Application passes the same identifier here and to a later odp_dma_transfer_done() call to check transfer completion status. Identifiers are allocated with odp_dma_transfer_id_alloc(). The identifier of a completed transfer may be reused for another transfer.

Examples: odp_dma_perf.c, and odp_dmafwd.c.

Definition at line 520 of file api/spec/dma_types.h.

◆ event

odp_event_t odp_dma_compl_param_t::event

Completion event.

When a transfer is started in ODP_DMA_COMPL_EVENT mode, this event is sent to the completion queue when the transfer is complete. The event type must be ODP_EVENT_DMA_COMPL. Use odp_dma_compl_result() to retrieve transfer results from the event.

Examples: odp_dma_perf.c, and odp_dmafwd.c.

Definition at line 529 of file api/spec/dma_types.h.

◆ queue

odp_queue_t odp_dma_compl_param_t::queue

Completion queue.

The completion event is sent into this queue in ODP_DMA_COMPL_EVENT mode.

Examples: odp_dma_perf.c, and odp_dmafwd.c.

Definition at line 535 of file api/spec/dma_types.h.

◆ user_ptr

void* odp_dma_compl_param_t::user_ptr

User context pointer.

User defined context pointer which is copied to transfer results (odp_dma_result_t). The value does not need to represent a valid address (any intptr_t value is allowed).

The default value is NULL.

Examples: odp_dma_perf.c, and odp_dmafwd.c.

Definition at line 544 of file api/spec/dma_types.h.

The documentation for this struct was generated from the following file:

api/spec/dma_types.h