From mboxrd@z Thu Jan 1 00:00:00 1970 From: Pavan Nikhilesh Bhagavatula Subject: [PATCH v2 2/2] doc: add notes about eventdev producer consumer dependency Date: Mon, 11 Mar 2019 07:59:55 +0000 Message-ID: <20190311075922.9937-2-pbhagavatula@marvell.com> References: <20190227200019.1085-1-pbhagavatula@marvell.com> <20190311075922.9937-1-pbhagavatula@marvell.com> Mime-Version: 1.0 Content-Type: text/plain; charset="iso-8859-1" Content-Transfer-Encoding: quoted-printable Cc: "dev@dpdk.org" , Pavan Nikhilesh Bhagavatula To: Jerin Jacob Kollanukkaran , "nikhil.rao@intel.com" , "erik.g.carrillo@intel.com" , "abhinandan.gujjar@intel.com" , "john.mcnamara@intel.com" Return-path: Received: from mx0b-0016f401.pphosted.com (mx0b-0016f401.pphosted.com [67.231.156.173]) by dpdk.org (Postfix) with ESMTP id 7A1F55323 for ; Mon, 11 Mar 2019 09:00:13 +0100 (CET) In-Reply-To: <20190311075922.9937-1-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" From: Pavan Nikhilesh 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 --- v2 Changes: Add Notes to doxygen API. 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(+) diff --git a/doc/guides/prog_guide/event_crypto_adapter.rst b/doc/guides/pr= og_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/guid= es/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 eventde= v 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/pro= g_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 t= he 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/eve= ntdev.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 =3D 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_ada= pter. + Ingress of New Events ~~~~~~~~~~~~~~~~~~~~~ diff --git a/lib/librte_eventdev/rte_event_crypto_adapter.h b/lib/librte_ev= entdev/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, ui= nt8_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_ev= entdev/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, uin= t16_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); diff --git a/lib/librte_eventdev/rte_event_timer_adapter.h b/lib/librte_eve= ntdev/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 mapped + * + * @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