Skip to contentSkip to conversation

eventdev: fix doxygen comment

PATCH Superseded [email protected] 2 participants 5 messages Jun 19, 2019 – Jul 2, 2019

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 eventdev: fix doxygen comment

From: Jerin Jacob <[email protected]>

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

Fixes c9bf83947e2e ("eventdev: add eth Tx adapter APIs")
Cc Nikhil Rao <[email protected]>
---
 lib/librte_eventdev/rte_eventdev.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
lib/librte_eventdev/rte_eventdev.h +3 -3
index 517cd8083..a5ec5d99b 100644
@@ -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
Signature · 1 line
2.21.0
#1 lore raw

Hi Jerin,

Quoted 30 lines

-----Original Message-----
From: [email protected] [mailto:[email protected]]
Sent: Wednesday, June 19, 2019 1:33 PM
To: [email protected]; Jerin Jacob <[email protected]>
Cc: [email protected]; Rao, Nikhil <[email protected]>
Subject: [dpdk-dev] [PATCH] eventdev: fix doxygen comment

From: Jerin Jacob <[email protected]>

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

Fixes c9bf83947e2e ("eventdev: add eth Tx adapter APIs")
Cc Nikhil Rao <[email protected]>
---
 lib/librte_eventdev/rte_eventdev.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)
lib/librte_eventdev/rte_eventdev.h +0 -0
index 517cd8083..a5ec5d99b 100644
@@ -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

Quoted 8 lines

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

Quoted 6 lines

*
* 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

#2 lore raw

PATCH v2 1/1 eventdev: fix doxygen comment

In reply to [email protected]

From: Jerin Jacob <[email protected]>

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

Fixes c9bf83947e2e ("eventdev: add eth Tx adapter APIs")
Cc Nikhil Rao <[email protected]>

---

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(-)
lib/librte_eventdev/rte_eventdev.h +2 -3
index 517cd8083..927f43c24 100644
@@ -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
Signature · 1 line
2.21.0
Reviewed-by on v2 1/1
#3 lore raw
Quoted 45 lines

-----Original Message-----
From: [email protected] [mailto:[email protected]]
Sent: Tuesday, July 2, 2019 12:16 PM
To: [email protected]; Jerin Jacob <[email protected]>
Cc: [email protected]; Rao, Nikhil <[email protected]>
Subject: [dpdk-dev] [PATCH v2] eventdev: fix doxygen comment

From: Jerin Jacob <[email protected]>

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

Fixes c9bf83947e2e ("eventdev: add eth Tx adapter APIs")
Cc Nikhil Rao <[email protected]>

---

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(-)
lib/librte_eventdev/rte_eventdev.h +0 -0
index 517cd8083..927f43c24 100644
@@ -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

Quoted 8 lines

+ 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

#4 lore raw
Quoted 25 lines

-----Original Message-----
From: Rao, Nikhil <[email protected]>
Sent: Tuesday, July 2, 2019 1:05 PM
To: Jerin Jacob Kollanukkaran <[email protected]>; [email protected]
Cc: [email protected]
Subject: [EXT] RE: [dpdk-dev] [PATCH v2] eventdev: fix doxygen comment

Quoted 18 lines

-----Original Message-----
From: [email protected] [mailto:[email protected]]
Sent: Tuesday, July 2, 2019 12:16 PM
To: [email protected]; Jerin Jacob <[email protected]>
Cc: [email protected]; Rao, Nikhil <[email protected]>
Subject: [dpdk-dev] [PATCH v2] eventdev: fix doxygen comment

From: Jerin Jacob <[email protected]>

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

Fixes c9bf83947e2e ("eventdev: add eth Tx adapter APIs")
Cc Nikhil Rao <[email protected]>

---

Quoted 8 lines
Quoted 7 lines

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)

---

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