DMA transfer results. More...

#include <dma_types.h>

Collaboration diagram for odp_dma_result_t:

Data Fields
odp_bool_t	success
	DMA transfer success. More...

void *	user_ptr
	User context pointer. More...

uint32_t	num_dst
	Number of destination packets. More...

odp_packet_t *	dst_pkt
	Table of destination packets. More...

Detailed Description

DMA transfer results.

Examples: odp_dma_perf.c, and odp_dmafwd.c.

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

Field Documentation

◆ success

odp_bool_t odp_dma_result_t::success

DMA transfer success.

true: DMA transfer was successful false: DMA transfer failed

Examples: odp_dma_perf.c, and odp_dmafwd.c.

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

◆ user_ptr

void* odp_dma_result_t::user_ptr

User context pointer.

User defined context pointer value from transfer completion parameters (odp_dma_compl_param_t). The default value is NULL.

Examples: odp_dma_perf.c, and odp_dmafwd.c.

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

◆ num_dst

uint32_t odp_dma_result_t::num_dst

Number of destination packets.

When odp_dma_transfer_param_t::seg_alloc is used, this value provides the number of packets in the destination packet table.

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

◆ dst_pkt

odp_packet_t* odp_dma_result_t::dst_pkt

Table of destination packets.

When odp_dma_transfer_param_t::seg_alloc is used, the resulting array of completed destination packets. Packets remain accessible from completion of a transfer until next synchronous transfer or in case of asynchronous transfers, associated completion resource (transfer identifier or completion event) reuse. While accessible, application should take ownership of the completed packets regardless of the result of the transfer.

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

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