odp_dma_transfer_param_t Struct Reference

DMA transfer parameters. More...

#include <dma_types.h>

Collaboration diagram for odp_dma_transfer_param_t:

Data Fields
odp_dma_data_format_t	src_format
	Source data format. More...
odp_dma_data_format_t	dst_format
	Destination data format. More...
uint32_t	num_src
	Number of source segments. More...
uint32_t	num_dst
	Number of destination segments. More...
odp_dma_seg_t *	src_seg
	Table of source segments. More...
odp_dma_seg_t *	dst_seg
	Table of destination segments. More...

Detailed Description

DMA transfer parameters.

These parameters define data sources and destinations for a DMA transfer. Capabilities specify the maximum number of segments and the maximum segment length that are supported.

The selected data format specifies how segment structure fields are used. When data format is ODP_DMA_FORMAT_ADDR, set segment start address (odp_dma_seg_t::addr) and length (odp_dma_seg_t::len). When data format is ODP_DMA_FORMAT_PACKET, set packet handle (odp_dma_seg_t::packet), segment start offset (odp_dma_seg_t::offset) and length. If a DMA segment spans over multiple packet segments, it is considered as equally many DMA segments. So, take packet segmentation into account when making sure that the maximum number of DMA segments capabilities are not exceeded.

Examples

odp_dma_perf.c, and odp_dmafwd.c.

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

Field Documentation

src_format

odp_dma_data_format_t odp_dma_transfer_param_t::src_format

Source data format.

The default value is ODP_DMA_FORMAT_ADDR.

Examples

odp_dma_perf.c, and odp_dmafwd.c.

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

dst_format

odp_dma_data_format_t odp_dma_transfer_param_t::dst_format

Destination data format.

The default value is ODP_DMA_FORMAT_ADDR.

Examples

odp_dma_perf.c, and odp_dmafwd.c.

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

num_src

uint32_t odp_dma_transfer_param_t::num_src

Number of source segments.

The default value is 1.

Examples

odp_dma_perf.c, and odp_dmafwd.c.

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

num_dst

uint32_t odp_dma_transfer_param_t::num_dst

Number of destination segments.

The default value is 1.

Examples

odp_dma_perf.c, and odp_dmafwd.c.

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

src_seg

odp_dma_seg_t* odp_dma_transfer_param_t::src_seg

Table of source segments.

The table has 'num_src' entries. Data format is defined by 'src_format'.

Examples

odp_dma_perf.c, and odp_dmafwd.c.

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

dst_seg

odp_dma_seg_t* odp_dma_transfer_param_t::dst_seg

Table of destination segments.

The table has 'num_dst' entries. Data format is defined by 'dst_format'.

Examples

odp_dma_perf.c, and odp_dmafwd.c.

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

---

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

• api/spec/dma_types.h