DMA completion event pool parameters. More...

#include <dma_types.h>

Data Fields
uint32_t	num
	Number of DMA completion events in the pool.

uint32_t	uarea_size
	User area size in bytes.

struct {

void(* init_fn )(void uarea, uint32_t size, void args, uint32_t index)
	See uarea_init.init_fn of odp_pool_param_t for details (odp_pool_param_t::init_fn). More...

void * args
	See uarea_init.args of odp_pool_param_t for details (odp_pool_param_t::args). More...

}	uarea_init
	Parameters for user area initialization.

uint32_t	cache_size
	Maximum number of events cached locally per thread.

Detailed Description

DMA completion event pool parameters.

Examples: odp_dma_perf.c, and odp_dmafwd.c.

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

Field Documentation

◆ num

uint32_t odp_dma_pool_param_t::num

Number of DMA completion events in the pool.

Maximum value is defined by 'max_num' pool capability

Examples: odp_dma_perf.c, and odp_dmafwd.c.

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

◆ uarea_size

uint32_t odp_dma_pool_param_t::uarea_size

User area size in bytes.

Maximum value is defined by 'max_uarea_size' pool capability. Specify as 0 if no user area is needed. The default value is 0.

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

◆ init_fn

void(* odp_dma_pool_param_t::init_fn) (void *uarea, uint32_t size, void *args, uint32_t index)

See uarea_init.init_fn of odp_pool_param_t for details (odp_pool_param_t::init_fn).

Function is called during odp_dma_pool_create().

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

◆ args

void* odp_dma_pool_param_t::args

See uarea_init.args of odp_pool_param_t for details (odp_pool_param_t::args).

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

◆ cache_size

uint32_t odp_dma_pool_param_t::cache_size

Maximum number of events cached locally per thread.

See odp_pool_param_t::cache_size documentation for details. Valid values range from 'min_cache_size' to 'max_cache_size' capability. The default value is implementation specific and set by odp_dma_pool_param_init().

Examples: odp_dmafwd.c.

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

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

api/spec/dma_types.h