[dpdk-dev] [PATCH] eventdev: fix doxygen comment

[dpdk-dev] [PATCH] eventdev: fix doxygen comment

[jerinj]

From: Jerin Jacob <jerinj@marvell.com>

Update rte_eventdev.h file description to adapt to Tx adapter changes.

Fixes: c9bf83947e2e ("eventdev: add eth Tx adapter APIs")
Cc: stable@dpdk.org
Cc: Nikhil Rao <nikhil.rao@intel.com>

Signed-off-by: Jerin Jacob <jerinj@marvell.com>
---
 lib/librte_eventdev/rte_eventdev.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/lib/librte_eventdev/rte_eventdev.h b/lib/librte_eventdev/rte_eventdev.h
index 517cd8083..a5ec5d99b 100644
--- a/lib/librte_eventdev/rte_eventdev.h
+++ b/lib/librte_eventdev/rte_eventdev.h
@@ -181,9 +181,9 @@
  * The *dequeue* operation gets one or more events from the event ports.
  * The application process the events and send to downstream event queue through
  * rte_event_enqueue_burst() if it is an intermediate stage of event processing,
- * on the final stage, the application may send to different subsystem like
- * ethdev to send the packet/event on the wire using ethdev
- * rte_eth_tx_burst() API.
+ * on the final stage, the application may send to Tx adapter for maintaining
+ * the ingress order and then to send the packet/event on the wire using
+ * rte_event_eth_tx_adapter_enqueue() API.
  *
  * The point at which events are scheduled to ports depends on the device.
  * For hardware devices, scheduling occurs asynchronously without any software
-- 
2.21.0

Re: [dpdk-dev] [PATCH] eventdev: fix doxygen comment

[Rao, Nikhil]

Hi Jerin,

> -----Original Message-----
> From: jerinj@marvell.com [mailto:jerinj@marvell.com]
> Sent: Wednesday, June 19, 2019 1:33 PM
> To: dev@dpdk.org; Jerin Jacob <jerinj@marvell.com>
> Cc: stable@dpdk.org; Rao, Nikhil <nikhil.rao@intel.com>
> Subject: [dpdk-dev] [PATCH] eventdev: fix doxygen comment
> 
> From: Jerin Jacob <jerinj@marvell.com>
> 
> Update rte_eventdev.h file description to adapt to Tx adapter changes.
> 
> Fixes: c9bf83947e2e ("eventdev: add eth Tx adapter APIs")
> Cc: stable@dpdk.org
> Cc: Nikhil Rao <nikhil.rao@intel.com>
> 
> Signed-off-by: Jerin Jacob <jerinj@marvell.com>
> ---
>  lib/librte_eventdev/rte_eventdev.h | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/lib/librte_eventdev/rte_eventdev.h
> b/lib/librte_eventdev/rte_eventdev.h
> index 517cd8083..a5ec5d99b 100644
> --- a/lib/librte_eventdev/rte_eventdev.h
> +++ b/lib/librte_eventdev/rte_eventdev.h
> @@ -181,9 +181,9 @@
>   * The *dequeue* operation gets one or more events from the event ports.
>   * The application process the events and send to downstream event queue
> through
>   * rte_event_enqueue_burst() if it is an intermediate stage of event
> processing,
> - * on the final stage, the application may send to different subsystem like
> - * ethdev to send the packet/event on the wire using ethdev
> - * rte_eth_tx_burst() API.
> + * on the final stage, the application may send to Tx adapter for
> maintaining
> + * the ingress order and then to send the packet/event on the wire using
> + * rte_event_eth_tx_adapter_enqueue() API.

Since the change above is applicable only if  eventdev supports the RTE_EVENT_ETH_TX_ADAPTER_CAP_INTERNAL_PORT, can we rephrase to include both cases ?  The Tx adapter documentation has the details, it would be good to cross reference it.

Thanks,
Nikhil

>   *
>   * The point at which events are scheduled to ports depends on the device.
>   * For hardware devices, scheduling occurs asynchronously without any
> software
> --
> 2.21.0

[dpdk-dev] [PATCH v2] eventdev: fix doxygen comment

[jerinj]

From: Jerin Jacob <jerinj@marvell.com>

Update rte_eventdev.h file description to adapt to Tx adapter changes.

Fixes: c9bf83947e2e ("eventdev: add eth Tx adapter APIs")
Cc: stable@dpdk.org
Cc: Nikhil Rao <nikhil.rao@intel.com>

Signed-off-by: Jerin Jacob <jerinj@marvell.com>
---

v2:
- Removed refference to rte_event_eth_tx_adapter_enqueue() API and made
generic Tx adapter API to address RTE_EVENT_ETH_TX_ADAPTER_CAP_INTERNAL_PORT
vs non RTE_EVENT_ETH_TX_ADAPTER_CAP_INTERNAL_PORT case(Nikhil)

---
 lib/librte_eventdev/rte_eventdev.h | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/lib/librte_eventdev/rte_eventdev.h b/lib/librte_eventdev/rte_eventdev.h
index 517cd8083..927f43c24 100644
--- a/lib/librte_eventdev/rte_eventdev.h
+++ b/lib/librte_eventdev/rte_eventdev.h
@@ -181,9 +181,8 @@
  * The *dequeue* operation gets one or more events from the event ports.
  * The application process the events and send to downstream event queue through
  * rte_event_enqueue_burst() if it is an intermediate stage of event processing,
- * on the final stage, the application may send to different subsystem like
- * ethdev to send the packet/event on the wire using ethdev
- * rte_eth_tx_burst() API.
+ * on the final stage, the application may use Tx adapter API for maintaining
+ * the ingress order and then send the packet/event on the wire.
  *
  * The point at which events are scheduled to ports depends on the device.
  * For hardware devices, scheduling occurs asynchronously without any software
-- 
2.21.0

Re: [dpdk-dev] [PATCH v2] eventdev: fix doxygen comment

[Rao, Nikhil]

> -----Original Message-----
> From: jerinj@marvell.com [mailto:jerinj@marvell.com]
> Sent: Tuesday, July 2, 2019 12:16 PM
> To: dev@dpdk.org; Jerin Jacob <jerinj@marvell.com>
> Cc: stable@dpdk.org; Rao, Nikhil <nikhil.rao@intel.com>
> Subject: [dpdk-dev] [PATCH v2] eventdev: fix doxygen comment
> 
> From: Jerin Jacob <jerinj@marvell.com>
> 
> Update rte_eventdev.h file description to adapt to Tx adapter changes.
> 
> Fixes: c9bf83947e2e ("eventdev: add eth Tx adapter APIs")
> Cc: stable@dpdk.org
> Cc: Nikhil Rao <nikhil.rao@intel.com>
> 
> Signed-off-by: Jerin Jacob <jerinj@marvell.com>
> ---
> 
> v2:
> - Removed refference to rte_event_eth_tx_adapter_enqueue() API and
> made generic Tx adapter API to address
> RTE_EVENT_ETH_TX_ADAPTER_CAP_INTERNAL_PORT
> vs non RTE_EVENT_ETH_TX_ADAPTER_CAP_INTERNAL_PORT case(Nikhil)
> 
> ---
>  lib/librte_eventdev/rte_eventdev.h | 5 ++---
>  1 file changed, 2 insertions(+), 3 deletions(-)
> 
> diff --git a/lib/librte_eventdev/rte_eventdev.h
> b/lib/librte_eventdev/rte_eventdev.h
> index 517cd8083..927f43c24 100644
> --- a/lib/librte_eventdev/rte_eventdev.h
> +++ b/lib/librte_eventdev/rte_eventdev.h
> @@ -181,9 +181,8 @@
>   * The *dequeue* operation gets one or more events from the event ports.
>   * The application process the events and send to downstream event queue
> through
>   * rte_event_enqueue_burst() if it is an intermediate stage of event
> processing,
> - * on the final stage, the application may send to different subsystem like
> - * ethdev to send the packet/event on the wire using ethdev
> - * rte_eth_tx_burst() API.
> + * on the final stage, the application may use Tx adapter API for
> + maintaining
> + * the ingress order and then send the packet/event on the wire.
>   *
>   * The point at which events are scheduled to ports depends on the device.
>   * For hardware devices, scheduling occurs asynchronously without any
> software
> --
> 2.21.0
Reviewed-by: Nikhil Rao <nikhil.rao@intel.com>

Re: [dpdk-dev] [PATCH v2] eventdev: fix doxygen comment

[Jerin Jacob Kollanukkaran]

> -----Original Message-----
> From: Rao, Nikhil <nikhil.rao@intel.com>
> Sent: Tuesday, July 2, 2019 1:05 PM
> To: Jerin Jacob Kollanukkaran <jerinj@marvell.com>; dev@dpdk.org
> Cc: stable@dpdk.org
> Subject: [EXT] RE: [dpdk-dev] [PATCH v2] eventdev: fix doxygen comment
> 
> > -----Original Message-----
> > From: jerinj@marvell.com [mailto:jerinj@marvell.com]
> > Sent: Tuesday, July 2, 2019 12:16 PM
> > To: dev@dpdk.org; Jerin Jacob <jerinj@marvell.com>
> > Cc: stable@dpdk.org; Rao, Nikhil <nikhil.rao@intel.com>
> > Subject: [dpdk-dev] [PATCH v2] eventdev: fix doxygen comment
> >
> > From: Jerin Jacob <jerinj@marvell.com>
> >
> > Update rte_eventdev.h file description to adapt to Tx adapter changes.
> >
> > Fixes: c9bf83947e2e ("eventdev: add eth Tx adapter APIs")
> > Cc: stable@dpdk.org
> > Cc: Nikhil Rao <nikhil.rao@intel.com>
> >
> > Signed-off-by: Jerin Jacob <jerinj@marvell.com>
> > ---
> >
> > v2:
> > - Removed refference to rte_event_eth_tx_adapter_enqueue() API and
> > made generic Tx adapter API to address
> > RTE_EVENT_ETH_TX_ADAPTER_CAP_INTERNAL_PORT
> > vs non RTE_EVENT_ETH_TX_ADAPTER_CAP_INTERNAL_PORT case(Nikhil)
> >
> > ---
> Reviewed-by: Nikhil Rao <nikhil.rao@intel.com>

Applied to dpdk-next-eventdev/master. Thanks.