Sponsor:

Your company here, and a link to your site. Click to find out more.

rte_eth_rxconf - Man Page

Synopsis

#include <rte_ethdev.h>

Data Fields

struct rte_eth_thresh rx_thresh
uint16_t rx_free_thresh
uint8_t rx_drop_en
uint8_t rx_deferred_start
uint16_t rx_nseg
uint16_t share_group
uint16_t share_qid
uint64_t offloads
union rte_eth_rxseg * rx_seg
struct rte_mempool ** rx_mempools
uint64_t reserved_64s [2]
void * reserved_ptrs [2]

Detailed Description

A structure used to configure an Rx ring of an Ethernet port.

Definition at line 1109 of file rte_ethdev.h.

Field Documentation

struct rte_eth_thresh rx_thresh

Rx ring threshold registers.

Definition at line 1110 of file rte_ethdev.h.

uint16_t rx_free_thresh

Drives the freeing of Rx descriptors.

Definition at line 1111 of file rte_ethdev.h.

uint8_t rx_drop_en

Drop packets if no descriptors are available.

Definition at line 1112 of file rte_ethdev.h.

uint8_t rx_deferred_start

Do not start queue with rte_eth_dev_start().

Definition at line 1113 of file rte_ethdev.h.

uint16_t rx_nseg

Number of descriptions in rx_seg array.

Definition at line 1114 of file rte_ethdev.h.

uint16_t share_group

Share group index in Rx domain and switch domain. Non-zero value to enable Rx queue share, zero value disable share. PMD is responsible for Rx queue consistency checks to avoid member port's configuration contradict to each other.

Definition at line 1121 of file rte_ethdev.h.

uint16_t share_qid

Shared Rx queue ID in group

Definition at line 1122 of file rte_ethdev.h.

uint64_t offloads

Per-queue Rx offloads to be set using RTE_ETH_RX_OFFLOAD_* flags. Only offloads set on rx_queue_offload_capa or rx_offload_capa fields on rte_eth_dev_info structure are allowed to be set.

Definition at line 1128 of file rte_ethdev.h.

union rte_eth_rxseg* rx_seg

Points to the array of segment descriptions for an entire packet. Array elements are properties for consecutive Rx segments.

The supported capabilities of receiving segmentation is reported in rte_eth_dev_info.rx_seg_capa field.

Definition at line 1136 of file rte_ethdev.h.

struct rte_mempool** rx_mempools

Array of mempools to allocate Rx buffers from.

This provides support for multiple mbuf pools per Rx queue. The capability is reported in device info via positive max_rx_mempools.

It could be useful for more efficient usage of memory when an application creates different mempools to steer the specific size of the packet.

If many mempools are specified, packets received using Rx burst may belong to any provided mempool. From ethdev user point of view it is undefined how PMD/NIC chooses mempool for a packet.

If Rx scatter is enabled, a packet may be delivered using a chain of mbufs obtained from single mempool or multiple mempools based on the NIC implementation.

Definition at line 1157 of file rte_ethdev.h.

uint64_t reserved_64s[2]

< Number of Rx mempools Reserved for future fields

Definition at line 1160 of file rte_ethdev.h.

void* reserved_ptrs[2]

Reserved for future fields

Definition at line 1161 of file rte_ethdev.h.

Author

Generated automatically by Doxygen for DPDK from the source code.

Info

Version 23.11.0 DPDK