eventdev/eth_rx: support Rx queue config get

[dpdk.git] / doc / guides / prog_guide / event_ethernet_rx_adapter.rst

diff --git a/doc/guides/prog_guide/event_ethernet_rx_adapter.rst b/doc/guides/prog_guide/event_ethernet_rx_adapter.rst
index c01e5a9..ce23d8a 100644 (file)
--- a/doc/guides/prog_guide/event_ethernet_rx_adapter.rst
+++ b/doc/guides/prog_guide/event_ethernet_rx_adapter.rst
@@ -146,6 +146,14 @@ if the callback is supported, and the counts maintained by the service function,
 if one exists. The service function also maintains a count of cycles for which
 it was not able to enqueue to the event device.
 
+Getting Adapter queue config
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The  ``rte_event_eth_rx_adapter_queue_conf_get()`` function reports
+flags for handling received packets, event queue identifier, scheduler type,
+event priority, polling frequency of the receive queue and flow identifier
+in struct ``rte_event_eth_rx_adapter_queue_conf``.
+
 Interrupt Based Rx Queues
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -195,12 +203,17 @@ The event devices, ethernet device pairs which support the capability
 flow characteristics and generate a ``rte_event`` containing ``rte_event_vector``
 whose event type is either ``RTE_EVENT_TYPE_ETHDEV_VECTOR`` or
 ``RTE_EVENT_TYPE_ETH_RX_ADAPTER_VECTOR``.
-The aggregation size and timeout are configurable at a queue level and the
-maximum, minimum vector sizes and timeouts vary based on the device capability
-and can be queried using ``rte_event_eth_rx_adapter_vector_limits_get``.
+The maximum, minimum vector sizes and timeouts vary based on the device
+capability and can be queried using
+``rte_event_eth_rx_adapter_vector_limits_get``.
 The Rx adapter additionally might include useful data such as ethernet device
 port and queue identifier in the ``rte_event_vector::port`` and
 ``rte_event_vector::queue`` and mark ``rte_event_vector::attr_valid`` as true.
+The aggregation size and timeout are configurable at a queue level by setting
+``rte_event_eth_rx_adapter_queue_conf::vector_sz``,
+``rte_event_eth_rx_adapter_queue_conf::vector_timeout_ns`` and
+``rte_event_eth_rx_adapter_queue_conf::vector_mp`` when adding queues using
+``rte_event_eth_rx_adapter_queue_add``.
 
 A loop processing ``rte_event_vector`` containing mbufs is shown below.