diff mbox series

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

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

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Ganapati Kundapura June 22, 2022, 4:54 p.m. UTC 
  Added rte_event_eth_rx_adapter_instance_get() details

Signed-off-by: Ganapati Kundapura <ganapati.kundapura@intel.com>
---
 doc/guides/prog_guide/event_ethernet_rx_adapter.rst | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Naga Harish K, S V June 22, 2022, 5:30 p.m. UTC | #1 
Reviewed-by: Naga Harish K S V <s.v.naga.harish.k@intel.com>

> -----Original Message-----
> From: Kundapura, Ganapati <ganapati.kundapura@intel.com>
> Sent: Wednesday, June 22, 2022 10:24 PM
> To: dev@dpdk.org; jerinj@marvell.com; Jayatheerthan, Jay
> <jay.jayatheerthan@intel.com>; Naga Harish K, S V
> <s.v.naga.harish.k@intel.com>
> Subject: [PATCH v8 6/7] doc/eth_rx: update instance get API
> 
> Added rte_event_eth_rx_adapter_instance_get() details
> 
> Signed-off-by: Ganapati Kundapura <ganapati.kundapura@intel.com>
> ---
>  doc/guides/prog_guide/event_ethernet_rx_adapter.rst | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> 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
>  ~~~~~~~~~~~~~~~~~~~~~~~~~~
> 
> --
> 2.6.4
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
 ~~~~~~~~~~~~~~~~~~~~~~~~~~