diff mbox series

[v3,3/3] doc: add rx queue get api detail in rx adapter guide

Message ID 20210907063946.374769-3-ganapati.kundapura@intel.com (mailing list archive)
State Superseded, archived
Headers
Series [v3,1/3] eventdev: add rx queue info get api |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation fail Compilation issues

Commit Message

Ganapati Kundapura Sept. 7, 2021, 6:39 a.m. UTC 
  rte_event_eth_rx_adapter_queue_info_get() api details are added
in rx adapter guide

Signed-off-by: Ganapati Kundapura <ganapati.kundapura@intel.com>
---
 doc/guides/prog_guide/event_ethernet_rx_adapter.rst | 8 ++++++++
 1 file changed, 8 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 c01e5a9..9897985 100644
--- 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 info
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The  ``rte_event_eth_rx_adapter_queue_info_get()`` function reports
+flags for handling received packets, event queue identifier, scheduar type,
+event priority, polling frequency of the receive queue and flow identifier
+in struct ``rte_event_eth_rx_adapter_queue_info``.
+
 Interrupt Based Rx Queues
 ~~~~~~~~~~~~~~~~~~~~~~~~~~