eventdev: update doxygen

PATCH In review Tim McDaniel 2 participants 5 messages Sep 5, 2017 – Sep 15, 2017

Share & tools

Tim McDaniel

author

2017-09-05 21:14 UTC #0 lore raw

PATCH 1/1 eventdev: update doxygen

Update doxygen to make it clear that RTE_EVENT_OP_FORWARD and RTE_EVENT_OP_RELEASE may only be enqueued to the same port that the original event was dequeued from.

Signed-off-by Tim McDaniel <[email protected]>

---
 lib/librte_eventdev/rte_eventdev.h | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

lib/librte_eventdev/rte_eventdev.h +13 -1

index 128bc52..117eeb0 100644
@@ -882,7 +882,10 @@ rte_event_dev_close(uint8_t dev_id);
 #define RTE_EVENT_OP_FORWARD            1
 /**< The CPU use this operation to forward the event to different event queue or
  * change to new application specific flow or schedule type to enable
- * pipelining
+ * pipelining.
+ *
+ * RTE_EVENT_OP_FORWARD must only be enqueued to the same port that the
+ * event to be forwarded was dequeued from.
  */
 #define RTE_EVENT_OP_RELEASE            2
 /**< Release the flow context associated with the schedule type.

@@ -912,6 +915,9 @@ rte_event_dev_close(uint8_t dev_id);
  * or no scheduling context is held then this function may be an NOOP,
  * depending on the implementation.
  *
+ * RTE_EVENT_OP_RELEASE must only be enqueued to the same port that the
+ * event to be released was dequeued from.
+ *
  */
 
 /**

@@ -1144,6 +1150,9 @@ __rte_event_enqueue_burst(uint8_t dev_id, uint8_t port_id,
  * The *nb_events* parameter is the number of event objects to enqueue which are
  * supplied in the *ev* array of *rte_event* structure.
  *
+ * Event operations RTE_EVENT_OP_FORWARD and RTE_EVENT_OP_RELEASE must only be
+ * enqueued to the same port that their associated events were dequeued from.
+ *
  * The rte_event_enqueue_burst() function returns the number of
  * events objects it actually enqueued. A return value equal to *nb_events*
  * means that all event objects have been enqueued.

@@ -1346,6 +1355,9 @@ rte_event_dequeue_timeout_ticks(uint8_t dev_id, uint64_t ns,
  * with RTE_EVENT_OP_RELEASE operation can be used to release the
  * contexts early.
  *
+ * Event operations RTE_EVENT_OP_FORWARD and RTE_EVENT_OP_RELEASE must only be
+ * enqueued to the same port that their associated events were dequeued from.
+ *
  * @param dev_id
  *   The identifier of the device.
  * @param port_id

Signature · 1 line

2.6.4

Jerin Jacob

Acked-by on v1 1/1

2017-09-06 06:12 UTC #1 lore raw

-----Original Message-----

Quoted 5 lines

Date: Tue, 5 Sep 2017 16:14:48 -0500
From: Tim McDaniel <[email protected]>
To: [email protected]
CC: [email protected]
Subject: [PATCH] eventdev: update doxygen

It is better to update the log message with more appropriate comment. Something like eventdev: clarify .... usage

Quoted 16 lines

X-Mailer: git-send-email 2.7.4
Update doxygen to make it clear that RTE_EVENT_OP_FORWARD and RTE_EVENT_OP_RELEASE may only be enqueued to the same port that the original event was dequeued from.
Signed-off-by Tim McDaniel <[email protected]>
---
 lib/librte_eventdev/rte_eventdev.h | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)
lib/librte_eventdev/rte_eventdev.h +0 -0
index 128bc52..117eeb0 100644

lib/librte_eventdev/rte_eventdev.h rte_event_dev_close(uint8_t dev_id); · line 887

Quoted 7 lines

lib/librte_eventdev/rte_eventdev.h +3 -1

@@ -882,7 +882,10 @@ rte_event_dev_close(uint8_t dev_id);
 #define RTE_EVENT_OP_FORWARD            1
 /**< The CPU use this operation to forward the event to different event queue or
  * change to new application specific flow or schedule type to enable
- * pipelining
+ * pipelining.
+ *
+ * RTE_EVENT_OP_FORWARD must only be enqueued to the same port that the

This text is under RTE_EVENT_OP_FORWARD. IMO, No need to explicitly mention the RTE_EVENT_OP_FORWARD again. Other than that the content looks good.

lib/librte_eventdev/rte_eventdev.h rte_event_dev_close(uint8_t dev_id); · line 919

Quoted 10 lines

lib/librte_eventdev/rte_eventdev.h +3 -0

+ * event to be forwarded was dequeued from.
  */
 #define RTE_EVENT_OP_RELEASE            2
 /**< Release the flow context associated with the schedule type.

@@ -912,6 +915,9 @@ rte_event_dev_close(uint8_t dev_id);
  * or no scheduling context is held then this function may be an NOOP,
  * depending on the implementation.
  *
+ * RTE_EVENT_OP_RELEASE must only be enqueued to the same port that the
+ * event to be released was dequeued from.

Same as above.

With above changes:

Acked-by Jerin Jacob <[email protected]>

Tim McDaniel

author

2017-09-06 15:42 UTC #2 lore raw

PATCH v2 1/1 eventdev: clarify usage of forward and release ops

In reply to Tim McDaniel

Update doxygen to make it clear that RTE_EVENT_OP_FORWARD and RTE_EVENT_OP_RELEASE may only be enqueued to the same port that the original event was dequeued from.

Signed-off-by Tim McDaniel <[email protected]>

---
 lib/librte_eventdev/rte_eventdev.h | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

lib/librte_eventdev/rte_eventdev.h +13 -1

index 128bc52..cf246a4 100644
@@ -882,7 +882,10 @@ rte_event_dev_close(uint8_t dev_id);
 #define RTE_EVENT_OP_FORWARD            1
 /**< The CPU use this operation to forward the event to different event queue or
  * change to new application specific flow or schedule type to enable
- * pipelining
+ * pipelining.
+ *
+ * This operation must only be enqueued to the same port that the
+ * event to be forwarded was dequeued from.
  */
 #define RTE_EVENT_OP_RELEASE            2
 /**< Release the flow context associated with the schedule type.

@@ -912,6 +915,9 @@ rte_event_dev_close(uint8_t dev_id);
  * or no scheduling context is held then this function may be an NOOP,
  * depending on the implementation.
  *
+ * This operation must only be enqueued to the same port that the
+ * event to be released was dequeued from.
+ *
  */
 
 /**

@@ -1144,6 +1150,9 @@ __rte_event_enqueue_burst(uint8_t dev_id, uint8_t port_id,
  * The *nb_events* parameter is the number of event objects to enqueue which are
  * supplied in the *ev* array of *rte_event* structure.
  *
+ * Event operations RTE_EVENT_OP_FORWARD and RTE_EVENT_OP_RELEASE must only be
+ * enqueued to the same port that their associated events were dequeued from.
+ *
  * The rte_event_enqueue_burst() function returns the number of
  * events objects it actually enqueued. A return value equal to *nb_events*
  * means that all event objects have been enqueued.

@@ -1346,6 +1355,9 @@ rte_event_dequeue_timeout_ticks(uint8_t dev_id, uint64_t ns,
  * with RTE_EVENT_OP_RELEASE operation can be used to release the
  * contexts early.
  *
+ * Event operations RTE_EVENT_OP_FORWARD and RTE_EVENT_OP_RELEASE must only be
+ * enqueued to the same port that their associated events were dequeued from.
+ *
  * @param dev_id
  *   The identifier of the device.
  * @param port_id

Signature · 1 line

2.6.4

Jerin Jacob

Acked-by on v2 1/1

2017-09-11 08:29 UTC #3 lore raw

Re: [PATCH v2] eventdev: clarify usage of forward and release ops

-----Original Message-----

Quoted 9 lines

Date: Wed, 6 Sep 2017 10:42:07 -0500
From: Tim McDaniel <[email protected]>
To: [email protected]
Subject: [dpdk-dev] [PATCH v2] eventdev: clarify usage of forward and
release ops
X-Mailer: git-send-email 2.7.4
Update doxygen to make it clear that RTE_EVENT_OP_FORWARD and RTE_EVENT_OP_RELEASE may only be enqueued to the same port that the

s/may/must

Quoted 3 lines

original event was dequeued from.
Signed-off-by Tim McDaniel <[email protected]>

I could fix the above change on apply.

Acked-by Jerin Jacob <[email protected]>

Quoted 53 lines

---
 lib/librte_eventdev/rte_eventdev.h | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

lib/librte_eventdev/rte_eventdev.h +13 -1

index 128bc52..cf246a4 100644
@@ -882,7 +882,10 @@ rte_event_dev_close(uint8_t dev_id);
 #define RTE_EVENT_OP_FORWARD            1
 /**< The CPU use this operation to forward the event to different event queue or
  * change to new application specific flow or schedule type to enable
- * pipelining
+ * pipelining.
+ *
+ * This operation must only be enqueued to the same port that the
+ * event to be forwarded was dequeued from.
  */
 #define RTE_EVENT_OP_RELEASE            2
 /**< Release the flow context associated with the schedule type.

@@ -912,6 +915,9 @@ rte_event_dev_close(uint8_t dev_id);
  * or no scheduling context is held then this function may be an NOOP,
  * depending on the implementation.
  *
+ * This operation must only be enqueued to the same port that the
+ * event to be released was dequeued from.
+ *
  */
 
 /**

@@ -1144,6 +1150,9 @@ __rte_event_enqueue_burst(uint8_t dev_id, uint8_t port_id,
  * The *nb_events* parameter is the number of event objects to enqueue which are
  * supplied in the *ev* array of *rte_event* structure.
  *
+ * Event operations RTE_EVENT_OP_FORWARD and RTE_EVENT_OP_RELEASE must only be
+ * enqueued to the same port that their associated events were dequeued from.
+ *
  * The rte_event_enqueue_burst() function returns the number of
  * events objects it actually enqueued. A return value equal to *nb_events*
  * means that all event objects have been enqueued.

@@ -1346,6 +1355,9 @@ rte_event_dequeue_timeout_ticks(uint8_t dev_id, uint64_t ns,
  * with RTE_EVENT_OP_RELEASE operation can be used to release the
  * contexts early.
  *
+ * Event operations RTE_EVENT_OP_FORWARD and RTE_EVENT_OP_RELEASE must only be
+ * enqueued to the same port that their associated events were dequeued from.
+ *
  * @param dev_id
  *   The identifier of the device.
  * @param port_id

Signature · 1 line

2.6.4

Jerin Jacob

Applied

2017-09-15 12:45 UTC #4 lore raw

Re: [PATCH v2] eventdev: clarify usage of forward and release ops

-----Original Message-----

Quoted 21 lines

Date: Mon, 11 Sep 2017 13:59:01 +0530
From: Jerin Jacob <[email protected]>
To: Tim McDaniel <[email protected]>
CC: [email protected]
Subject: Re: [dpdk-dev] [PATCH v2] eventdev: clarify usage of forward and
release ops
User-Agent: Mutt/1.9.0 (2017-09-02)
-----Original Message-----
Quoted 9 lines
Date: Wed, 6 Sep 2017 10:42:07 -0500
From: Tim McDaniel <[email protected]>
To: [email protected]
Subject: [dpdk-dev] [PATCH v2] eventdev: clarify usage of forward and
release ops
X-Mailer: git-send-email 2.7.4
Update doxygen to make it clear that RTE_EVENT_OP_FORWARD and RTE_EVENT_OP_RELEASE may only be enqueued to the same port that the
s/may/must

Quoted 7 lines

Quoted 3 lines
original event was dequeued from.
Signed-off-by Tim McDaniel <[email protected]>
I could fix the above change on apply.
Acked-by Jerin Jacob <[email protected]>

Applied to dpdk-next-eventdev/master with above change. Thanks.