API Reference Manual  1.45.1
odp_dma_capability_t Struct Reference

DMA capabilities. More...

#include <dma_types.h>

Collaboration diagram for odp_dma_capability_t:
[legend]

Data Fields

uint32_t max_sessions
 Maximum number of DMA sessions. More...
 
uint32_t max_transfers
 Maximum number of transfers per DMA session. More...
 
uint32_t max_src_segs
 Maximum number of source segments in a single transfer.
 
uint32_t max_dst_segs
 Maximum number of destination segments in a single transfer.
 
uint32_t max_segs
 Maximum number of destination and source segments combined in a single transfer.
 
uint32_t max_seg_len
 Maximum segment length in bytes. More...
 
odp_dma_compl_mode_t compl_mode_mask
 Supported completion modes. More...
 
odp_bool_t queue_type_sched
 Scheduled queue support. More...
 
odp_bool_t queue_type_plain
 Plain queue support. More...
 
odp_dma_pool_capability_t pool
 DMA completion event pool capabilities.
 

Detailed Description

DMA capabilities.

Examples
odp_dma_perf.c, odp_dmafwd.c, and odp_sysinfo.c.

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

Field Documentation

◆ max_sessions

uint32_t odp_dma_capability_t::max_sessions

Maximum number of DMA sessions.

The value of zero means that DMA offload is not available.

Examples
odp_dma_perf.c, odp_dmafwd.c, and odp_sysinfo.c.

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

◆ max_transfers

uint32_t odp_dma_capability_t::max_transfers

Maximum number of transfers per DMA session.

Maximum number of transfers that can be in-flight (started but not yet completed) per session. When this limit is reached, new transfer requests may not be accepted until some previously started transfers are complete.

Examples
odp_dma_perf.c, odp_dmafwd.c, and odp_sysinfo.c.

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

◆ max_seg_len

uint32_t odp_dma_capability_t::max_seg_len

Maximum segment length in bytes.

This is the maximum length of any source or destination segment.

Examples
odp_dma_perf.c, odp_dmafwd.c, and odp_sysinfo.c.

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

◆ compl_mode_mask

odp_dma_compl_mode_t odp_dma_capability_t::compl_mode_mask

Supported completion modes.

Each supported completion mode has a corresponding flag set in the mask. Synchronous transfer (ODP_DMA_COMPL_SYNC) is always supported.

Examples
odp_dma_perf.c, odp_dmafwd.c, and odp_sysinfo.c.

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

◆ queue_type_sched

odp_bool_t odp_dma_capability_t::queue_type_sched

Scheduled queue support.

0: Scheduled queues are not supported as DMA completion queues 1: Scheduled queues are supported as DMA completion queues

Examples
odp_dma_perf.c, odp_dmafwd.c, and odp_sysinfo.c.

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

◆ queue_type_plain

odp_bool_t odp_dma_capability_t::queue_type_plain

Plain queue support.

0: Plain queues are not supported as DMA completion queues 1: Plain queues are supported as DMA completion queues

Examples
odp_sysinfo.c.

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


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