From mboxrd@z Thu Jan 1 00:00:00 1970 From: Pavan Nikhilesh Bhagavatula Subject: [PATCH 2/2] doc: add notes regarding eventdev producer consumer dependency Date: Wed, 27 Feb 2019 20:00:43 +0000 Message-ID: <20190227200019.1085-2-pbhagavatula@marvell.com> References: <20190227200019.1085-1-pbhagavatula@marvell.com> Mime-Version: 1.0 Content-Type: text/plain; charset="iso-8859-1" Content-Transfer-Encoding: quoted-printable Cc: "john.mcnamara@intel.com" , "dev@dpdk.org" , Pavan Nikhilesh Bhagavatula To: Jerin Jacob Kollanukkaran Return-path: Received: from mx0b-0016f401.pphosted.com (mx0a-0016f401.pphosted.com [67.231.148.174]) by dpdk.org (Postfix) with ESMTP id 21FE75F28 for ; Wed, 27 Feb 2019 21:00:57 +0100 (CET) In-Reply-To: <20190227200019.1085-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 --- 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/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. =20 rte_event_crypto_adapter_start(id, mode); =20 +.. 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 ~~~~~~~~~~~~~~~~~~~~~~ =20 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. =20 +.. 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 ~~~~~~~~~~~~~~~~~~~~~~~~~~ =20 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. =20 +.. 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 ~~~~~~~~~~~~~~~~~~~ =20 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. =20 int err =3D rte_event_dev_start(dev_id); =20 +.. 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 ~~~~~~~~~~~~~~~~~~~~~ =20 --=20 2.21.0