Pool information struct Used to get information about a pool. More...

#include <pool_types.h>

Collaboration diagram for odp_pool_info_t:

Data Fields
odp_pool_type_t	type
	Pool type.

const char *	name
	Pool name.

odp_bool_t	pool_ext
	External memory pool.

union {

odp_pool_param_t params
	Copy of pool parameters. More...

odp_pool_ext_param_t pool_ext_param
	Copy of external memory pool parameters. More...

odp_dma_pool_param_t dma_pool_param
	Copy of pool parameters when pool type is ODP_POOL_DMA_COMPL. More...

odp_ml_compl_pool_param_t ml_pool_param
	Copy of pool parameters when pool type is ODP_POOL_ML_COMPL. More...

};
	Pool parameters union.

struct {

uint32_t max_num
	Maximum number of packets of any length. More...

}	pkt
	Additional info for packet pools.

uintptr_t	min_data_addr
	Minimum data address.

uintptr_t	max_data_addr
	Maximum data address.

Detailed Description

Pool information struct Used to get information about a pool.

Definition at line 932 of file api/spec/pool_types.h.

Field Documentation

◆ type

odp_pool_type_t odp_pool_info_t::type

Pool type.

Definition at line 934 of file api/spec/pool_types.h.

◆ name

const char* odp_pool_info_t::name

Pool name.

Definition at line 937 of file api/spec/pool_types.h.

◆ pool_ext

odp_bool_t odp_pool_info_t::pool_ext

External memory pool.

0: Pool is a normal pool 1: Pool is an external memory pool

Definition at line 944 of file api/spec/pool_types.h.

◆ params

odp_pool_param_t odp_pool_info_t::params

Copy of pool parameters.

This is set when pool_ext is 0.

Definition at line 949 of file api/spec/pool_types.h.

◆ pool_ext_param

odp_pool_ext_param_t odp_pool_info_t::pool_ext_param

Copy of external memory pool parameters.

This is set when pool_ext is 1.

Definition at line 952 of file api/spec/pool_types.h.

◆ dma_pool_param

odp_dma_pool_param_t odp_pool_info_t::dma_pool_param

Copy of pool parameters when pool type is ODP_POOL_DMA_COMPL.

Definition at line 955 of file api/spec/pool_types.h.

◆ ml_pool_param

odp_ml_compl_pool_param_t odp_pool_info_t::ml_pool_param

Copy of pool parameters when pool type is ODP_POOL_ML_COMPL.

Definition at line 958 of file api/spec/pool_types.h.

◆ max_num

uint32_t odp_pool_info_t::max_num

Maximum number of packets of any length.

This is the maximum number of packets that can be allocated from the pool at anytime. Application can use this e.g. to prepare enough per packet contexts.

Definition at line 969 of file api/spec/pool_types.h.

◆ min_data_addr

uintptr_t odp_pool_info_t::min_data_addr

Minimum data address.

This is the minimum address that application accessible data of any object (event) allocated from the pool may locate. When there's no application accessible data (e.g. ODP_POOL_TIMEOUT pools), the value may be zero.

Definition at line 980 of file api/spec/pool_types.h.

◆ max_data_addr

uintptr_t odp_pool_info_t::max_data_addr

Maximum data address.

This is the maximum address that application accessible data of any object (event) allocated from the pool may locate. When there's no application accessible data (e.g. ODP_POOL_TIMEOUT pools), the value may be zero.

Definition at line 989 of file api/spec/pool_types.h.

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

api/spec/pool_types.h

Data Fields