* [PATCH] eventdev: update doxygen
@ 2017-09-05 21:14 Tim McDaniel
2017-09-06 6:12 ` Jerin Jacob
2017-09-06 15:42 ` [PATCH v2] eventdev: clarify usage of forward and release ops Tim McDaniel
0 siblings, 2 replies; 5+ messages in thread
From: Tim McDaniel @ 2017-09-05 21:14 UTC (permalink / raw)
To: jerin.jacob; +Cc: dev
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 <timothy.mcdaniel@intel.com>
---
lib/librte_eventdev/rte_eventdev.h | 14 +++++++++++++-
1 file changed, 13 insertions(+), 1 deletion(-)
diff --git a/lib/librte_eventdev/rte_eventdev.h b/lib/librte_eventdev/rte_eventdev.h
index 128bc52..117eeb0 100644
--- a/lib/librte_eventdev/rte_eventdev.h
+++ b/lib/librte_eventdev/rte_eventdev.h
@@ -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
--
2.6.4
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH] eventdev: update doxygen
2017-09-05 21:14 [PATCH] eventdev: update doxygen Tim McDaniel
@ 2017-09-06 6:12 ` Jerin Jacob
2017-09-06 15:42 ` [PATCH v2] eventdev: clarify usage of forward and release ops Tim McDaniel
1 sibling, 0 replies; 5+ messages in thread
From: Jerin Jacob @ 2017-09-06 6:12 UTC (permalink / raw)
To: Tim McDaniel; +Cc: dev
-----Original Message-----
> Date: Tue, 5 Sep 2017 16:14:48 -0500
> From: Tim McDaniel <timothy.mcdaniel@intel.com>
> To: jerin.jacob@caviumnetworks.com
> CC: dev@dpdk.org
> Subject: [PATCH] eventdev: update doxygen
It is better to update the log message with more appropriate comment.
Something like eventdev: clarify .... usage
> 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 <timothy.mcdaniel@intel.com>
> ---
> lib/librte_eventdev/rte_eventdev.h | 14 +++++++++++++-
> 1 file changed, 13 insertions(+), 1 deletion(-)
>
> diff --git a/lib/librte_eventdev/rte_eventdev.h b/lib/librte_eventdev/rte_eventdev.h
> index 128bc52..117eeb0 100644
> --- a/lib/librte_eventdev/rte_eventdev.h
> +++ b/lib/librte_eventdev/rte_eventdev.h
> @@ -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.
> + * 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 <jerin.jacob@caviumnetworks.com>
^ permalink raw reply [flat|nested] 5+ messages in thread
* [PATCH v2] eventdev: clarify usage of forward and release ops
2017-09-05 21:14 [PATCH] eventdev: update doxygen Tim McDaniel
2017-09-06 6:12 ` Jerin Jacob
@ 2017-09-06 15:42 ` Tim McDaniel
2017-09-11 8:29 ` Jerin Jacob
1 sibling, 1 reply; 5+ messages in thread
From: Tim McDaniel @ 2017-09-06 15:42 UTC (permalink / raw)
To: dev
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 <timothy.mcdaniel@intel.com>
---
lib/librte_eventdev/rte_eventdev.h | 14 +++++++++++++-
1 file changed, 13 insertions(+), 1 deletion(-)
diff --git a/lib/librte_eventdev/rte_eventdev.h b/lib/librte_eventdev/rte_eventdev.h
index 128bc52..cf246a4 100644
--- a/lib/librte_eventdev/rte_eventdev.h
+++ b/lib/librte_eventdev/rte_eventdev.h
@@ -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
--
2.6.4
^ permalink raw reply related [flat|nested] 5+ messages in thread
* Re: [PATCH v2] eventdev: clarify usage of forward and release ops
2017-09-06 15:42 ` [PATCH v2] eventdev: clarify usage of forward and release ops Tim McDaniel
@ 2017-09-11 8:29 ` Jerin Jacob
2017-09-15 12:44 ` Jerin Jacob
0 siblings, 1 reply; 5+ messages in thread
From: Jerin Jacob @ 2017-09-11 8:29 UTC (permalink / raw)
To: Tim McDaniel; +Cc: dev
-----Original Message-----
> Date: Wed, 6 Sep 2017 10:42:07 -0500
> From: Tim McDaniel <timothy.mcdaniel@intel.com>
> To: dev@dpdk.org
> 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
> original event was dequeued from.
>
> Signed-off-by: Tim McDaniel <timothy.mcdaniel@intel.com>
I could fix the above change on apply.
Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
> ---
> lib/librte_eventdev/rte_eventdev.h | 14 +++++++++++++-
> 1 file changed, 13 insertions(+), 1 deletion(-)
>
> diff --git a/lib/librte_eventdev/rte_eventdev.h b/lib/librte_eventdev/rte_eventdev.h
> index 128bc52..cf246a4 100644
> --- a/lib/librte_eventdev/rte_eventdev.h
> +++ b/lib/librte_eventdev/rte_eventdev.h
> @@ -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
> --
> 2.6.4
>
^ permalink raw reply [flat|nested] 5+ messages in thread
* Re: [PATCH v2] eventdev: clarify usage of forward and release ops
2017-09-11 8:29 ` Jerin Jacob
@ 2017-09-15 12:44 ` Jerin Jacob
0 siblings, 0 replies; 5+ messages in thread
From: Jerin Jacob @ 2017-09-15 12:44 UTC (permalink / raw)
To: Tim McDaniel; +Cc: dev
-----Original Message-----
> Date: Mon, 11 Sep 2017 13:59:01 +0530
> From: Jerin Jacob <jerin.jacob@caviumnetworks.com>
> To: Tim McDaniel <timothy.mcdaniel@intel.com>
> CC: dev@dpdk.org
> 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-----
> > Date: Wed, 6 Sep 2017 10:42:07 -0500
> > From: Tim McDaniel <timothy.mcdaniel@intel.com>
> > To: dev@dpdk.org
> > 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
>
> > original event was dequeued from.
> >
> > Signed-off-by: Tim McDaniel <timothy.mcdaniel@intel.com>
>
> I could fix the above change on apply.
>
> Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
Applied to dpdk-next-eventdev/master with above change. Thanks.
^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2017-09-15 12:45 UTC | newest]
Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-09-05 21:14 [PATCH] eventdev: update doxygen Tim McDaniel
2017-09-06 6:12 ` Jerin Jacob
2017-09-06 15:42 ` [PATCH v2] eventdev: clarify usage of forward and release ops Tim McDaniel
2017-09-11 8:29 ` Jerin Jacob
2017-09-15 12:44 ` Jerin Jacob
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.