diff mbox series

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

Message ID 20220623093036.708448-7-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/iol-abi-testing warning Testing issues
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/github-robot: build success github build: passed
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/intel-Testing success Testing PASS
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Ganapati Kundapura June 23, 2022, 9:30 a.m. UTC
Added rte_event_eth_tx_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_tx_adapter.rst | 6 ++++++
 1 file changed, 6 insertions(+)
diff mbox series

Patch

diff --git a/doc/guides/prog_guide/event_ethernet_tx_adapter.rst b/doc/guides/prog_guide/event_ethernet_tx_adapter.rst
index f80d226..4da9bcd 100644
--- a/doc/guides/prog_guide/event_ethernet_tx_adapter.rst
+++ b/doc/guides/prog_guide/event_ethernet_tx_adapter.rst
@@ -165,6 +165,12 @@  in struct ``rte_event_eth_tx_adapter_stats``. The counter values are the sum of
 the counts from the eventdev PMD callback if the callback is supported, and
 the counts maintained by the service function, if one exists.
 
+Getting Adapter instance id
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The  ``rte_event_eth_tx_adapter_instance_get()`` function reports
+tx adapter instance id for a specified ethernet device id and tx queue index.
+
 Tx event vectorization
 ~~~~~~~~~~~~~~~~~~~~~~