From mboxrd@z Thu Jan 1 00:00:00 1970 From: "Carrillo, Erik G" Subject: Re: [PATCH v3 3/3] doc: add notes about eventdev producer consumer dependency Date: Wed, 13 Mar 2019 22:22:21 +0000 Message-ID: References: <20190227200019.1085-1-pbhagavatula@marvell.com> <20190312204037.16141-1-pbhagavatula@marvell.com> <20190312204037.16141-3-pbhagavatula@marvell.com> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable Cc: "dev@dpdk.org" To: Pavan Nikhilesh Bhagavatula , "Jerin Jacob Kollanukkaran" , "Van Haaren, Harry" , "Rao, Nikhil" , "Gujjar, Abhinandan S" , "Mcnamara, John" Return-path: Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) by dpdk.org (Postfix) with ESMTP id 515052C28 for ; Wed, 13 Mar 2019 23:22:24 +0100 (CET) In-Reply-To: <20190312204037.16141-3-pbhagavatula@marvell.com> Content-Language: en-US List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" > -----Original Message----- > From: Pavan Nikhilesh Bhagavatula [mailto:pbhagavatula@marvell.com] > Sent: Tuesday, March 12, 2019 3:41 PM > To: Jerin Jacob Kollanukkaran ; Van Haaren, Harry > ; Rao, Nikhil ; Carrill= o, > Erik G ; Gujjar, Abhinandan S > ; Mcnamara, John > > Cc: dev@dpdk.org; Pavan Nikhilesh Bhagavatula > > Subject: [dpdk-dev] [PATCH v3 3/3] doc: add notes about eventdev producer > consumer dependency >=20 > From: Pavan Nikhilesh >=20 > EventDev i.e consumer needs to be started before starting the event > producers. > Update documentation of EventDev and EventDev adapters. >=20 > Signed-off-by: Pavan Nikhilesh > --- > v2 Changes: Add Notes to doxygen API. >=20 > 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 +++++ > lib/librte_eventdev/rte_event_crypto_adapter.h | 4 ++++ > lib/librte_eventdev/rte_event_eth_rx_adapter.h | 4 ++++ > lib/librte_eventdev/rte_event_timer_adapter.h | 4 ++++ > 7 files changed, 32 insertions(+) >=20 > 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. >=20 > rte_event_crypto_adapter_start(id, mode); >=20 > +.. Note:: > + > + The eventdev to which the event_crypto_adapter is connected nee= ds > to > + be started before calling rte_event_crypto_adapter_start(). > + > Get adapter statistics > ~~~~~~~~~~~~~~~~~~~~~~ >=20 > 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 event= dev > PMDs for hardware based eventdev-ethdev connections and > ``rte_service_run_state_set()`` to enable the service function if one ex= ists. >=20 > +.. Note:: > + > + The eventdev to which the event_eth_rx_adapter is connected nee= ds > to > + be started before calling rte_event_eth_rx_adapter_start(). > + > Getting Adapter Statistics > ~~~~~~~~~~~~~~~~~~~~~~~~~~ >=20 > 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 th= e > software implementation. >=20 > +.. Note:: > + > + The eventdev to which the event_timer_adapter is connected need= s > to > + be started before calling rte_event_timer_adapter_start(). > + > Arming Event Timers > ~~~~~~~~~~~~~~~~~~~ >=20 > 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. >=20 > int err =3D rte_event_dev_start(dev_id); >=20 > +.. Note:: > + > + EventDev needs to be started before starting the event producer= s such > + as event_eth_rx_adapter, event_timer_adapter and > event_crypto_adapter. > + > Ingress of New Events > ~~~~~~~~~~~~~~~~~~~~~ >=20 > diff --git a/lib/librte_eventdev/rte_event_crypto_adapter.h > b/lib/librte_eventdev/rte_event_crypto_adapter.h > index d367309cb..a7419e91c 100644 > --- a/lib/librte_eventdev/rte_event_crypto_adapter.h > +++ b/lib/librte_eventdev/rte_event_crypto_adapter.h > @@ -472,6 +472,10 @@ rte_event_crypto_adapter_queue_pair_del(uint8_t > id, uint8_t cdev_id, > * @return > * - 0: Success, adapter started successfully. > * - <0: Error code on failure. > + * > + * @note > + * The eventdev to which the event_crypto_adapter is connected needs > + to > + * be started before calling rte_event_crypto_adapter_start(). > */ > int __rte_experimental > rte_event_crypto_adapter_start(uint8_t id); diff --git > a/lib/librte_eventdev/rte_event_eth_rx_adapter.h > b/lib/librte_eventdev/rte_event_eth_rx_adapter.h > index 863b72a10..2314b93f6 100644 > --- a/lib/librte_eventdev/rte_event_eth_rx_adapter.h > +++ b/lib/librte_eventdev/rte_event_eth_rx_adapter.h > @@ -405,6 +405,10 @@ int rte_event_eth_rx_adapter_queue_del(uint8_t > id, uint16_t eth_dev_id, > * @return > * - 0: Success, Adapter started correctly. > * - <0: Error code on failure. > + * > + * @note > + * The eventdev to which the event_eth_rx_adapter is connected needs > + to > + * be started before calling rte_event_eth_rx_adapter_start(). > */ > int rte_event_eth_rx_adapter_start(uint8_t id); >=20 > diff --git a/lib/librte_eventdev/rte_event_timer_adapter.h > b/lib/librte_eventdev/rte_event_timer_adapter.h > index db98dec46..cc4518d41 100644 > --- a/lib/librte_eventdev/rte_event_timer_adapter.h > +++ b/lib/librte_eventdev/rte_event_timer_adapter.h > @@ -339,6 +339,10 @@ rte_event_timer_adapter_get_info( > * - -EINVAL if adapter identifier invalid > * - -ENOENT if software adapter but no service core mapped > * - -ENOTSUP if software adapter and more than one service core mappe= d > + * > + * @note > + * The eventdev to which the event_timer_adapter is connected needs to > + * be started before calling rte_event_timer_adapter_start(). > */ > int __rte_experimental > rte_event_timer_adapter_start( > -- > 2.21.0 Reviewed-by: Erik Gabriel Carrillo