[2/2] doc: add notes regarding eventdev producer consumer dependency

Message ID 20190227200019.1085-2-pbhagavatula@marvell.com
State Changes Requested, archived
Delegated to: Jerin Jacob
Headers show
Series
  • [1/2] app/eventdev: start event producers after eventdev is started
Related show

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Pavan Nikhilesh Bhagavatula Feb. 27, 2019, 8 p.m.
From: Pavan Nikhilesh <pbhagavatula@marvell.com>

EventDev i.e consumer needs to be started before starting the
event producers.
Update documentation of EventDev and EventDev adapters.

Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
---
 doc/guides/prog_guide/event_crypto_adapter.rst      | 5 +++++
 doc/guides/prog_guide/event_ethernet_rx_adapter.rst | 5 +++++
 doc/guides/prog_guide/event_timer_adapter.rst       | 5 +++++
 doc/guides/prog_guide/eventdev.rst                  | 5 +++++
 4 files changed, 20 insertions(+)

Comments

Jerin Jacob Kollanukkaran March 5, 2019, 3:15 p.m. | #1
On Wed, 2019-02-27 at 20:00 +0000, Pavan Nikhilesh Bhagavatula wrote:
> From: Pavan Nikhilesh <pbhagavatula@marvell.com>
> 
> EventDev i.e consumer needs to be started before starting the
> event producers.
> Update documentation of EventDev and EventDev adapters.
> 


Adding all the eventdev adapter maintainers for the feedback.
It looks good to me as it is an natural flow(i.e
we need to start eventdev first to consume the adapter events)


> Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
> ---
>  doc/guides/prog_guide/event_crypto_adapter.rst      | 5 +++++
>  doc/guides/prog_guide/event_ethernet_rx_adapter.rst | 5 +++++
>  doc/guides/prog_guide/event_timer_adapter.rst       | 5 +++++
>  doc/guides/prog_guide/eventdev.rst                  | 5 +++++
>  4 files changed, 20 insertions(+)
> 
> diff --git a/doc/guides/prog_guide/event_crypto_adapter.rst
> b/doc/guides/prog_guide/event_crypto_adapter.rst
> index 9fe09c805..1e3eb7139 100644
> --- a/doc/guides/prog_guide/event_crypto_adapter.rst
> +++ b/doc/guides/prog_guide/event_crypto_adapter.rst
> @@ -286,6 +286,11 @@ service function if one exists.
>  
>          rte_event_crypto_adapter_start(id, mode);
>  
> +.. Note::
> +
> +         The eventdev to which the event_crypto_adapter is connected
> needs to
> +         be started before calling rte_event_crypto_adapter_start().


IMO, It is better to add @note under the all the *_adapter_start() APIs
to capture the notes on doxygen.
Carrillo, Erik G March 5, 2019, 11:52 p.m. | #2
> -----Original Message-----
> From: Jerin Jacob Kollanukkaran [mailto:jerinj@marvell.com]
> Sent: Tuesday, March 5, 2019 9:16 AM
> To: Pavan Nikhilesh Bhagavatula <pbhagavatula@marvell.com>
> Cc: Mcnamara, John <john.mcnamara@intel.com>; Rao, Nikhil
> <nikhil.rao@intel.com>; Carrillo, Erik G <erik.g.carrillo@intel.com>; Gujjar,
> Abhinandan S <abhinandan.gujjar@intel.com>; dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH 2/2] doc: add notes regarding eventdev
> producer consumer dependency
> 
> On Wed, 2019-02-27 at 20:00 +0000, Pavan Nikhilesh Bhagavatula wrote:
> > From: Pavan Nikhilesh <pbhagavatula@marvell.com>
> >
> > EventDev i.e consumer needs to be started before starting the event
> > producers.
> > Update documentation of EventDev and EventDev adapters.
> >
> 
> 
> Adding all the eventdev adapter maintainers for the feedback.
> It looks good to me as it is an natural flow(i.e we need to start eventdev first
> to consume the adapter events)
> 
> 
> > Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
> > ---
> >  doc/guides/prog_guide/event_crypto_adapter.rst      | 5 +++++
> >  doc/guides/prog_guide/event_ethernet_rx_adapter.rst | 5 +++++
> >  doc/guides/prog_guide/event_timer_adapter.rst       | 5 +++++
> >  doc/guides/prog_guide/eventdev.rst                  | 5 +++++
> >  4 files changed, 20 insertions(+)
> >
> > diff --git a/doc/guides/prog_guide/event_crypto_adapter.rst
> > b/doc/guides/prog_guide/event_crypto_adapter.rst
> > index 9fe09c805..1e3eb7139 100644
> > --- a/doc/guides/prog_guide/event_crypto_adapter.rst
> > +++ b/doc/guides/prog_guide/event_crypto_adapter.rst
> > @@ -286,6 +286,11 @@ service function if one exists.
> >
> >          rte_event_crypto_adapter_start(id, mode);
> >
> > +.. Note::
> > +
> > +         The eventdev to which the event_crypto_adapter is connected
> > needs to
> > +         be started before calling rte_event_crypto_adapter_start().
> 
> 
> IMO, It is better to add @note under the all the *_adapter_start() APIs to
> capture the notes on doxygen.

I agree that a @note under the *_adapter_start() APIs would be more discoverable, or perhaps it could be mentioned in both places.  Looks good otherwise.
Abhinandan Gujjar March 6, 2019, 5:32 a.m. | #3
> -----Original Message-----
> From: Jerin Jacob Kollanukkaran <jerinj@marvell.com>
> Sent: Tuesday, March 5, 2019 8:46 PM
> To: Pavan Nikhilesh Bhagavatula <pbhagavatula@marvell.com>
> Cc: Mcnamara, John <john.mcnamara@intel.com>; Rao, Nikhil
> <nikhil.rao@intel.com>; Carrillo, Erik G <erik.g.carrillo@intel.com>; Gujjar,
> Abhinandan S <abhinandan.gujjar@intel.com>; dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH 2/2] doc: add notes regarding eventdev
> producer consumer dependency
> 
> On Wed, 2019-02-27 at 20:00 +0000, Pavan Nikhilesh Bhagavatula wrote:
> > From: Pavan Nikhilesh <pbhagavatula@marvell.com>
> >
> > EventDev i.e consumer needs to be started before starting the event
> > producers.
> > Update documentation of EventDev and EventDev adapters.
> >
> 
> 
> Adding all the eventdev adapter maintainers for the feedback.
> It looks good to me as it is an natural flow(i.e we need to start eventdev first to
> consume the adapter events)
> 
> 
> > Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com>
> > ---
> >  doc/guides/prog_guide/event_crypto_adapter.rst      | 5 +++++
> >  doc/guides/prog_guide/event_ethernet_rx_adapter.rst | 5 +++++
> >  doc/guides/prog_guide/event_timer_adapter.rst       | 5 +++++
> >  doc/guides/prog_guide/eventdev.rst                  | 5 +++++
> >  4 files changed, 20 insertions(+)
> >
> > diff --git a/doc/guides/prog_guide/event_crypto_adapter.rst
> > b/doc/guides/prog_guide/event_crypto_adapter.rst
> > index 9fe09c805..1e3eb7139 100644
> > --- a/doc/guides/prog_guide/event_crypto_adapter.rst
> > +++ b/doc/guides/prog_guide/event_crypto_adapter.rst
> > @@ -286,6 +286,11 @@ service function if one exists.
> >
> >          rte_event_crypto_adapter_start(id, mode);
> >
> > +.. Note::
> > +
> > +         The eventdev to which the event_crypto_adapter is connected
> > needs to
> > +         be started before calling rte_event_crypto_adapter_start().
> 
> 
> IMO, It is better to add @note under the all the *_adapter_start() APIs to
> capture the notes on doxygen.

Looks good to me.

-Abhinandan

Patch

diff --git a/doc/guides/prog_guide/event_crypto_adapter.rst b/doc/guides/prog_guide/event_crypto_adapter.rst
index 9fe09c805..1e3eb7139 100644
--- a/doc/guides/prog_guide/event_crypto_adapter.rst
+++ b/doc/guides/prog_guide/event_crypto_adapter.rst
@@ -286,6 +286,11 @@  service function if one exists.
 
         rte_event_crypto_adapter_start(id, mode);
 
+.. Note::
+
+         The eventdev to which the event_crypto_adapter is connected needs to
+         be started before calling rte_event_crypto_adapter_start().
+
 Get adapter statistics
 ~~~~~~~~~~~~~~~~~~~~~~
 
diff --git a/doc/guides/prog_guide/event_ethernet_rx_adapter.rst b/doc/guides/prog_guide/event_ethernet_rx_adapter.rst
index 0166bb45d..e95529974 100644
--- a/doc/guides/prog_guide/event_ethernet_rx_adapter.rst
+++ b/doc/guides/prog_guide/event_ethernet_rx_adapter.rst
@@ -135,6 +135,11 @@  This function calls the start callbacks of the eventdev PMDs for hardware based
 eventdev-ethdev connections and ``rte_service_run_state_set()`` to enable the
 service function if one exists.
 
+.. Note::
+
+         The eventdev to which the event_eth_rx_adapter is connected needs to
+         be started before calling rte_event_eth_rx_adapter_start().
+
 Getting Adapter Statistics
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 
diff --git a/doc/guides/prog_guide/event_timer_adapter.rst b/doc/guides/prog_guide/event_timer_adapter.rst
index 3b4446ee9..eb195ebd4 100644
--- a/doc/guides/prog_guide/event_timer_adapter.rst
+++ b/doc/guides/prog_guide/event_timer_adapter.rst
@@ -179,6 +179,11 @@  running the event timer adapter. This function calls the start entry points
 defined by eventdev PMDs for hardware implementations or puts a service
 component into the running state in the software implementation.
 
+.. Note::
+
+         The eventdev to which the event_timer_adapter is connected needs to
+         be started before calling rte_event_timer_adapter_start().
+
 Arming Event Timers
 ~~~~~~~~~~~~~~~~~~~
 
diff --git a/doc/guides/prog_guide/eventdev.rst b/doc/guides/prog_guide/eventdev.rst
index 8fcae5469..dcdfeb75e 100644
--- a/doc/guides/prog_guide/eventdev.rst
+++ b/doc/guides/prog_guide/eventdev.rst
@@ -296,6 +296,11 @@  eventdev.
 
         int err = rte_event_dev_start(dev_id);
 
+.. Note::
+
+         EventDev needs to be started before starting the event producers such
+         as event_eth_rx_adapter, event_timer_adapter and event_crypto_adapter.
+
 Ingress of New Events
 ~~~~~~~~~~~~~~~~~~~~~