#include <rte_ethdev.h>

Data Fields
struct rte_device *	device

const char *	driver_name

unsigned int	if_index

uint16_t	min_mtu

uint16_t	max_mtu

const uint32_t *	dev_flags

uint32_t	min_rx_bufsize

uint32_t	max_rx_bufsize

uint32_t	max_rx_pktlen

uint32_t	max_lro_pkt_size

uint16_t	max_rx_queues

uint16_t	max_tx_queues

uint32_t	max_mac_addrs

uint32_t	max_hash_mac_addrs

uint16_t	max_vfs

uint16_t	max_vmdq_pools

struct rte_eth_rxseg_capa	rx_seg_capa

uint64_t	rx_offload_capa

uint64_t	tx_offload_capa

uint64_t	rx_queue_offload_capa

uint64_t	tx_queue_offload_capa

uint16_t	reta_size

uint8_t	hash_key_size

uint64_t	flow_type_rss_offloads

struct rte_eth_rxconf	default_rxconf

struct rte_eth_txconf	default_txconf

uint16_t	vmdq_queue_base

uint16_t	vmdq_queue_num

uint16_t	vmdq_pool_base

struct rte_eth_desc_lim	rx_desc_lim

struct rte_eth_desc_lim	tx_desc_lim

uint32_t	speed_capa

uint16_t	nb_rx_queues

uint16_t	nb_tx_queues

uint16_t	max_rx_mempools

struct rte_eth_dev_portconf	default_rxportconf

struct rte_eth_dev_portconf	default_txportconf

uint64_t	dev_capa

struct rte_eth_switch_info	switch_info

enum rte_eth_err_handle_mode	err_handle_mode

uint64_t	reserved_64s [2]

void *	reserved_ptrs [2]

Detailed Description

A structure used to retrieve the contextual information of an Ethernet device, such as the controlling driver of the device, etc...

Examples:: examples/bond/main.c, examples/distributor/main.c, examples/dma/dmafwd.c, examples/ethtool/ethtool-app/main.c, examples/ethtool/lib/rte_ethtool.c, examples/eventdev_pipeline/pipeline_worker_generic.c, examples/eventdev_pipeline/pipeline_worker_tx.c, examples/flow_filtering/main.c, examples/ip_fragmentation/main.c, examples/ip_pipeline/link.c, examples/ip_reassembly/main.c, examples/ipsec-secgw/ipsec-secgw.c, examples/ipsec-secgw/ipsec.c, examples/ipsec-secgw/sa.c, examples/ipv4_multicast/main.c, examples/l2fwd-crypto/main.c, examples/l2fwd-event/l2fwd_common.c, examples/l2fwd-jobstats/main.c, examples/l2fwd-keepalive/main.c, examples/l2fwd-macsec/main.c, examples/l2fwd/main.c, examples/l3fwd-graph/main.c, examples/l3fwd-power/main.c, examples/l3fwd/l3fwd_em.c, examples/l3fwd/l3fwd_event.c, examples/l3fwd/l3fwd_fib.c, examples/l3fwd/l3fwd_lpm.c, examples/l3fwd/main.c, examples/link_status_interrupt/main.c, examples/multi_process/symmetric_mp/main.c, examples/ntb/ntb_fwd.c, examples/packet_ordering/main.c, examples/pipeline/cli.c, examples/pipeline/obj.c, examples/ptpclient/ptpclient.c, examples/qos_meter/main.c, examples/qos_sched/init.c, examples/rxtx_callbacks/main.c, examples/server_node_efd/efd_server/init.c, examples/skeleton/basicfwd.c, examples/vhost/main.c, examples/vm_power_manager/main.c, examples/vmdq/main.c, and examples/vmdq_dcb/main.c.

Definition at line 1756 of file rte_ethdev.h.

Field Documentation

◆ device

struct rte_device* device

Generic device information

Examples:: examples/ethtool/lib/rte_ethtool.c, examples/l3fwd/l3fwd_em.c, examples/l3fwd/l3fwd_fib.c, and examples/l3fwd/l3fwd_lpm.c.

Definition at line 1757 of file rte_ethdev.h.

◆ driver_name

const char* driver_name

Device Driver name.

Examples:: examples/ethtool/lib/rte_ethtool.c.

Definition at line 1758 of file rte_ethdev.h.

◆ if_index

unsigned int if_index

Index to bound host interface, or 0 if none. Use if_indextoname() to translate into an interface name.

Definition at line 1759 of file rte_ethdev.h.

◆ min_mtu

uint16_t min_mtu

Minimum MTU allowed

Definition at line 1761 of file rte_ethdev.h.

◆ max_mtu

uint16_t max_mtu

Maximum MTU allowed

Examples:: examples/dma/dmafwd.c, examples/l3fwd-graph/main.c, examples/l3fwd-power/main.c, and examples/l3fwd/main.c.

Definition at line 1762 of file rte_ethdev.h.

◆ dev_flags

const uint32_t* dev_flags

Device flags

Definition at line 1763 of file rte_ethdev.h.

◆ min_rx_bufsize

uint32_t min_rx_bufsize

Minimum Rx buffer size per descriptor supported by HW.

Definition at line 1765 of file rte_ethdev.h.

◆ max_rx_bufsize

uint32_t max_rx_bufsize

Maximum Rx buffer size per descriptor supported by HW. The value is not enforced, information only to application to optimize mbuf size. Its value is UINT32_MAX when not specified by the driver.

Definition at line 1772 of file rte_ethdev.h.

◆ max_rx_pktlen

uint32_t max_rx_pktlen

Maximum configurable length of Rx pkt.

Examples:: examples/dma/dmafwd.c, examples/l3fwd-graph/main.c, examples/l3fwd-power/main.c, and examples/l3fwd/main.c.

Definition at line 1773 of file rte_ethdev.h.

◆ max_lro_pkt_size

uint32_t max_lro_pkt_size

Maximum configurable size of LRO aggregated packet.

Definition at line 1775 of file rte_ethdev.h.

◆ max_rx_queues

uint16_t max_rx_queues

Maximum number of Rx queues.

Examples:: examples/ipsec-secgw/ipsec-secgw.c, examples/l3fwd-power/main.c, examples/l3fwd/main.c, examples/pipeline/obj.c, examples/vmdq/main.c, and examples/vmdq_dcb/main.c.

Definition at line 1776 of file rte_ethdev.h.

◆ max_tx_queues

uint16_t max_tx_queues

Maximum number of Tx queues.

Examples:: examples/ipsec-secgw/ipsec-secgw.c, examples/l3fwd-power/main.c, and examples/vmdq/main.c.

Definition at line 1777 of file rte_ethdev.h.

◆ max_mac_addrs

uint32_t max_mac_addrs

Maximum number of MAC addresses.

Definition at line 1778 of file rte_ethdev.h.

◆ max_hash_mac_addrs

uint32_t max_hash_mac_addrs

Maximum number of hash MAC addresses for MTA and UTA.

Definition at line 1780 of file rte_ethdev.h.

◆ max_vfs

uint16_t max_vfs

Maximum number of VFs.

Examples:: examples/ethtool/lib/rte_ethtool.c.

Definition at line 1781 of file rte_ethdev.h.

◆ max_vmdq_pools

uint16_t max_vmdq_pools

Maximum number of VMDq pools.

Examples:: examples/vmdq/main.c, and examples/vmdq_dcb/main.c.

Definition at line 1782 of file rte_ethdev.h.

◆ rx_seg_capa

struct rte_eth_rxseg_capa rx_seg_capa

Segmentation capability.

Definition at line 1783 of file rte_ethdev.h.

◆ rx_offload_capa

uint64_t rx_offload_capa

All Rx offload capabilities including all per-queue ones

Examples:: examples/eventdev_pipeline/pipeline_worker_generic.c, examples/ipsec-secgw/ipsec-secgw.c, examples/ipsec-secgw/sa.c, examples/l3fwd-power/main.c, examples/l3fwd/main.c, examples/ptpclient/ptpclient.c, and examples/rxtx_callbacks/main.c.

Definition at line 1785 of file rte_ethdev.h.

◆ tx_offload_capa

uint64_t tx_offload_capa

All Tx offload capabilities including all per-queue ones

Examples:: examples/bond/main.c, examples/distributor/main.c, examples/eventdev_pipeline/pipeline_worker_generic.c, examples/eventdev_pipeline/pipeline_worker_tx.c, examples/flow_filtering/main.c, examples/ipsec-secgw/ipsec-secgw.c, examples/ipsec-secgw/sa.c, examples/l2fwd-crypto/main.c, examples/l2fwd-event/l2fwd_common.c, examples/l3fwd-graph/main.c, examples/l3fwd-power/main.c, examples/l3fwd/l3fwd_event.c, examples/l3fwd/main.c, examples/multi_process/symmetric_mp/main.c, examples/packet_ordering/main.c, examples/ptpclient/ptpclient.c, examples/qos_meter/main.c, examples/qos_sched/init.c, examples/rxtx_callbacks/main.c, examples/server_node_efd/efd_server/init.c, examples/skeleton/basicfwd.c, examples/vm_power_manager/main.c, examples/vmdq/main.c, and examples/vmdq_dcb/main.c.

Definition at line 1787 of file rte_ethdev.h.

◆ rx_queue_offload_capa

uint64_t rx_queue_offload_capa

Device per-queue Rx offload capabilities.

Definition at line 1789 of file rte_ethdev.h.

◆ tx_queue_offload_capa

uint64_t tx_queue_offload_capa

Device per-queue Tx offload capabilities.

Definition at line 1791 of file rte_ethdev.h.

◆ reta_size

uint16_t reta_size

Device redirection table size, the total number of entries.

Examples:: examples/pipeline/obj.c.

Definition at line 1793 of file rte_ethdev.h.

◆ hash_key_size

uint8_t hash_key_size

Hash key size in bytes

Definition at line 1794 of file rte_ethdev.h.

◆ flow_type_rss_offloads

uint64_t flow_type_rss_offloads

RSS hash algorithms capabilities Bit mask of RSS offloads, the bit offset also means flow type

Examples:: examples/bond/main.c, examples/distributor/main.c, examples/dma/dmafwd.c, examples/eventdev_pipeline/pipeline_worker_generic.c, examples/eventdev_pipeline/pipeline_worker_tx.c, examples/ipsec-secgw/ipsec-secgw.c, examples/l2fwd-event/l2fwd_common.c, examples/l3fwd-graph/main.c, examples/l3fwd-power/main.c, examples/l3fwd/l3fwd_event.c, examples/l3fwd/main.c, examples/multi_process/symmetric_mp/main.c, examples/ntb/ntb_fwd.c, examples/pipeline/obj.c, examples/qos_meter/main.c, examples/vmdq/main.c, and examples/vmdq_dcb/main.c.

Definition at line 1797 of file rte_ethdev.h.

◆ default_rxconf

◆ default_txconf

struct rte_eth_txconf default_txconf

Default Tx configuration

Examples:: examples/bond/main.c, examples/distributor/main.c, examples/dma/dmafwd.c, examples/eventdev_pipeline/pipeline_worker_generic.c, examples/eventdev_pipeline/pipeline_worker_tx.c, examples/flow_filtering/main.c, examples/ipsec-secgw/ipsec-secgw.c, examples/l2fwd-crypto/main.c, examples/l2fwd-event/l2fwd_common.c, examples/l3fwd-graph/main.c, examples/l3fwd-power/main.c, examples/l3fwd/l3fwd_event.c, examples/l3fwd/main.c, examples/multi_process/symmetric_mp/main.c, examples/ntb/ntb_fwd.c, examples/packet_ordering/main.c, examples/ptpclient/ptpclient.c, examples/qos_meter/main.c, examples/rxtx_callbacks/main.c, examples/server_node_efd/efd_server/init.c, examples/skeleton/basicfwd.c, examples/vm_power_manager/main.c, examples/vmdq/main.c, and examples/vmdq_dcb/main.c.

Definition at line 1799 of file rte_ethdev.h.

◆ vmdq_queue_base

uint16_t vmdq_queue_base

First queue ID for VMDq pools.

Examples:: examples/vmdq/main.c, and examples/vmdq_dcb/main.c.

Definition at line 1800 of file rte_ethdev.h.

◆ vmdq_queue_num

uint16_t vmdq_queue_num

Queue number for VMDq pools.

Examples:: examples/vmdq/main.c, and examples/vmdq_dcb/main.c.

Definition at line 1801 of file rte_ethdev.h.

◆ vmdq_pool_base

uint16_t vmdq_pool_base

First ID of VMDq pools.

Examples:: examples/vmdq/main.c, and examples/vmdq_dcb/main.c.

Definition at line 1802 of file rte_ethdev.h.

◆ rx_desc_lim

struct rte_eth_desc_lim rx_desc_lim

Rx descriptors limits

Examples:: examples/ethtool/ethtool-app/main.c, and examples/ethtool/lib/rte_ethtool.c.

Definition at line 1803 of file rte_ethdev.h.

◆ tx_desc_lim

struct rte_eth_desc_lim tx_desc_lim

Tx descriptors limits

Examples:: examples/ethtool/ethtool-app/main.c, and examples/ethtool/lib/rte_ethtool.c.

Definition at line 1804 of file rte_ethdev.h.

◆ speed_capa

uint32_t speed_capa

Supported speeds bitmap (RTE_ETH_LINK_SPEED_).

Definition at line 1805 of file rte_ethdev.h.

◆ nb_rx_queues

uint16_t nb_rx_queues

Configured number of Rx/Tx queues Number of Rx queues.

Examples:: examples/ipsec-secgw/ipsec.c, and examples/pipeline/cli.c.

Definition at line 1807 of file rte_ethdev.h.

◆ nb_tx_queues

uint16_t nb_tx_queues

Number of Tx queues.

Examples:: examples/pipeline/cli.c.

Definition at line 1808 of file rte_ethdev.h.

◆ max_rx_mempools

uint16_t max_rx_mempools

Maximum number of Rx mempools supported per Rx queue.

Value greater than 0 means that the driver supports Rx queue mempools specification via rx_conf->rx_mempools.

Definition at line 1815 of file rte_ethdev.h.

◆ default_rxportconf

struct rte_eth_dev_portconf default_rxportconf

Rx parameter recommendations

Definition at line 1817 of file rte_ethdev.h.

◆ default_txportconf

struct rte_eth_dev_portconf default_txportconf

Tx parameter recommendations

Definition at line 1819 of file rte_ethdev.h.

◆ dev_capa

uint64_t dev_capa

Generic device capabilities (RTE_ETH_DEV_CAPA_).

Definition at line 1821 of file rte_ethdev.h.

◆ switch_info

struct rte_eth_switch_info switch_info

Switching information for ports on a device with a embedded managed interconnect/switch.

Definition at line 1826 of file rte_ethdev.h.

◆ err_handle_mode

enum rte_eth_err_handle_mode err_handle_mode

Supported error handling mode.

Definition at line 1828 of file rte_ethdev.h.

◆ reserved_64s

uint64_t reserved_64s[2]

Reserved for future fields

Definition at line 1830 of file rte_ethdev.h.

◆ reserved_ptrs

void* reserved_ptrs[2]