diff mbox series

[v10,6/7] doc/eth_rx: update instance get API

Message ID 20220623093036.708448-6-ganapati.kundapura@intel.com (mailing list archive)
State Deferred
Delegated to: Jerin Jacob
Headers show
Series [v10,1/7] eventdev/eth_rx: add adapter instance get API | expand

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Ganapati Kundapura June 23, 2022, 9:30 a.m. UTC
Added rte_event_eth_rx_adapter_instance_get() details

Signed-off-by: Ganapati Kundapura <ganapati.kundapura@intel.com>

Reviewed-by: Naga Harish K S V <s.v.naga.harish.k@intel.com>
Acked-by: Jay Jayatheerthan <jay.jayatheerthan@intel.com>
---
 doc/guides/prog_guide/event_ethernet_rx_adapter.rst | 6 ++++++
 1 file changed, 6 insertions(+)
diff mbox series

Patch

diff --git a/doc/guides/prog_guide/event_ethernet_rx_adapter.rst b/doc/guides/prog_guide/event_ethernet_rx_adapter.rst
index 3b4ef50..5b9d0cf 100644
--- a/doc/guides/prog_guide/event_ethernet_rx_adapter.rst
+++ b/doc/guides/prog_guide/event_ethernet_rx_adapter.rst
@@ -177,6 +177,12 @@  used otherwise it returns -EINVAL.
 The ``rte_event_eth_rx_adapter_queue_stats_reset`` function can be used to
 reset queue level stats when queue level event buffer is in use.
 
+Getting Adapter instance id
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The ``rte_event_eth_rx_adapter_instance_get()`` function reports
+rx adapter instance id for a specified ethernet device id and rx queue index.
+
 Interrupt Based Rx Queues
 ~~~~~~~~~~~~~~~~~~~~~~~~~~