DPDK patches and discussions
 help / color / mirror / Atom feed
From: Jerin Jacob <jerin.jacob@caviumnetworks.com>
To: Gage Eads <gage.eads@intel.com>
Cc: dev@dpdk.org, jerin.jacob@caviumnetworks.org
Subject: Re: [dpdk-dev] [PATCH] eventdev: clarify atomic and ordered queue config
Date: Mon, 15 May 2017 09:14:18 +0530	[thread overview]
Message-ID: <20170515034416.GA21183@jerin> (raw)
In-Reply-To: <1494617137-8619-1-git-send-email-gage.eads@intel.com>

-----Original Message-----
> Date: Fri, 12 May 2017 14:25:37 -0500
> From: Gage Eads <gage.eads@intel.com>
> To: dev@dpdk.org
> CC: jerin.jacob@caviumnetworks.org
> Subject: [dpdk-dev] [PATCH] eventdev: clarify atomic and ordered queue
>  config
> X-Mailer: git-send-email 2.7.4
> 
> The nb_atomic_flows and nb_atomic_order_sequences fields are only inspected
> if the queue is configured for atomic or ordered scheduling, respectively.
> This commit updates the documentation to reflect that.
> 
> Signed-off-by: Gage Eads <gage.eads@intel.com>
> ---
>  lib/librte_eventdev/rte_eventdev.h | 15 ++++++++++-----
>  1 file changed, 10 insertions(+), 5 deletions(-)
> 
> diff --git a/lib/librte_eventdev/rte_eventdev.h b/lib/librte_eventdev/rte_eventdev.h
> index 20e7293..32ffcd1 100644
> --- a/lib/librte_eventdev/rte_eventdev.h
> +++ b/lib/librte_eventdev/rte_eventdev.h
> @@ -521,9 +521,11 @@ rte_event_dev_configure(uint8_t dev_id,
>  struct rte_event_queue_conf {
>  	uint32_t nb_atomic_flows;
>  	/**< The maximum number of active flows this queue can track at any
> -	 * given time. The value must be in the range of
> -	 * [1 - nb_event_queue_flows)] which previously provided in
> -	 * rte_event_dev_info_get().
> +	 * given time. If the queue is configured for atomic scheduling (by
> +	 * applying the RTE_EVENT_QUEUE_CFG_ALL_TYPES or
> +	 * RTE_EVENT_QUEUE_CFG_ATOMIC_ONLY flags to event_queue_cfg), then the
> +	 * value must be in the range of [1 - nb_event_queue_flows)], which was
> +	 * previously provided in rte_event_dev_configure().
>  	 */
>  	uint32_t nb_atomic_order_sequences;
>  	/**< The maximum number of outstanding events waiting to be
> @@ -533,8 +535,11 @@ struct rte_event_queue_conf {
>  	 * scheduler cannot schedule the events from this queue and invalid
>  	 * event will be returned from dequeue until one or more entries are
>  	 * freed up/released.
> -	 * The value must be in the range of [1 - nb_event_queue_flows)]
> -	 * which previously supplied to rte_event_dev_configure().
> +	 * If the queue is configured for ordered scheduling (by applying the
> +	 * RTE_EVENT_QUEUE_CFG_ALL_TYPES or RTE_EVENT_QUEUE_CFG_ORDERED_ONLY
> +	 * flags to event_queue_cfg), then the value must be in the range of [1
> +	 * - nb_event_queue_flows)], which was previously supplied to

At this line, HTML document rendering is not showing up correctly.
Please check the generated HTML output with "make doc-api-html"

Other than that, content looks OK.

> +	 * rte_event_dev_configure().
>  	 */
>  	uint32_t event_queue_cfg; /**< Queue cfg flags(EVENT_QUEUE_CFG_) */
>  	uint8_t priority;
> -- 
> 2.7.4
> 

  reply	other threads:[~2017-05-15  3:44 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-05-12 19:25 Gage Eads
2017-05-15  3:44 ` Jerin Jacob [this message]
2017-05-15 19:40 ` [dpdk-dev] [PATCH v2] " Gage Eads
2017-05-16  3:15   ` Jerin Jacob
2017-05-17 18:09   ` Jerin Jacob

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20170515034416.GA21183@jerin \
    --to=jerin.jacob@caviumnetworks.com \
    --cc=dev@dpdk.org \
    --cc=gage.eads@intel.com \
    --cc=jerin.jacob@caviumnetworks.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).