CdiAdapterData Struct Reference

Configuration data used by the CdiCoreNetworkAdapterInitialize() API function. More...

#include <cdi_core_api.h>

Data Fields
const char *	adapter_ip_addr_str
	The IP address to use for the local network interface dedicated to the SDK's use. NOTE: This must be the dotted form of an IPv4 address. DHCP and/or DNS may be supported in the future.
uint64_t	tx_buffer_size_bytes
	The size in bytes of a memory region for holding payload data to transmit. If no transmit connections will be created, then this value can be zero. Otherwise it must be a value greater than 1.
void *	ret_tx_buffer_ptr
	Returned pointer to start of the allocated transmit buffer. Size is specified using tx_buffer_size_kbytes.
CdiAdapterTypeSelection	adapter_type
	The type of adapter to use/initialize.

Detailed Description

Configuration data used by the CdiCoreNetworkAdapterInitialize() API function.

Field Documentation

tx_buffer_size_bytes

uint64_t CdiAdapterData::tx_buffer_size_bytes

The size in bytes of a memory region for holding payload data to transmit. If no transmit connections will be created, then this value can be zero. Otherwise it must be a value greater than 1.

A special memory type is used so both CPU and DMA hardware can access the memory. The application manages how the buffer is partitioned and used.

---

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

• include/cdi_core_api.h