API Reference Manual  1.45.0
odp_dma_param_t Struct Reference

DMA session parameters. More...

#include <dma_types.h>

Data Fields

odp_dma_direction_t direction
 Transfer direction. More...
 
odp_dma_transfer_type_t type
 Transfer type. More...
 
odp_dma_compl_mode_t compl_mode_mask
 Transfer completion modes. More...
 
odp_dma_mt_mode_t mt_mode
 Transfer operation multi-thread safeness. More...
 
odp_dma_transfer_order_t order
 Transfer ordering. More...
 

Detailed Description

DMA session parameters.

Examples
odp_dma_perf.c, and odp_dmafwd.c.

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

Field Documentation

◆ direction

odp_dma_direction_t odp_dma_param_t::direction

Transfer direction.

The default value is ODP_DMA_MAIN_TO_MAIN.

Examples
odp_dma_perf.c, and odp_dmafwd.c.

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

◆ type

odp_dma_transfer_type_t odp_dma_param_t::type

Transfer type.

The default value is ODP_DMA_TYPE_COPY.

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

◆ compl_mode_mask

odp_dma_compl_mode_t odp_dma_param_t::compl_mode_mask

Transfer completion modes.

Specify the completion modes application will use within the session.

Multiple modes may be selected, but it is implementation specific which combinations are supported. If an unsupported combination is requested odp_dma_create() returns a failure. See odp_dma_capability_t::compl_mode_mask for the supported modes.

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

◆ mt_mode

odp_dma_mt_mode_t odp_dma_param_t::mt_mode

Transfer operation multi-thread safeness.

The default value is ODP_DMA_MT_SAFE.

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

◆ order

odp_dma_transfer_order_t odp_dma_param_t::order

Transfer ordering.

The default value is ODP_DMA_ORDER_NONE.

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


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