From: Pavan Nikhilesh Bhagavatula <pbhagavatula@marvell.com>
To: Jerin Jacob Kollanukkaran <jerinj@marvell.com>,
"harry.van.haaren@intel.com" <harry.van.haaren@intel.com>,
"nikhil.rao@intel.com" <nikhil.rao@intel.com>,
"erik.g.carrillo@intel.com" <erik.g.carrillo@intel.com>,
"abhinandan.gujjar@intel.com" <abhinandan.gujjar@intel.com>,
"john.mcnamara@intel.com" <john.mcnamara@intel.com>
Cc: "dev@dpdk.org" <dev@dpdk.org>,
Pavan Nikhilesh Bhagavatula <pbhagavatula@marvell.com>
Subject: [dpdk-dev] [PATCH v3 3/3] doc: add notes about eventdev producer consumer dependency
Date: Tue, 12 Mar 2019 20:41:13 +0000 [thread overview]
Message-ID: <20190312204037.16141-3-pbhagavatula@marvell.com> (raw)
In-Reply-To: <20190312204037.16141-1-pbhagavatula@marvell.com>
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>
---
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/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
~~~~~~~~~~~~~~~~~~~~~
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);
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 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
next prev parent reply other threads:[~2019-03-12 20:41 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-02-27 20:00 [dpdk-dev] [PATCH 1/2] app/eventdev: start event producers after eventdev is started Pavan Nikhilesh Bhagavatula
2019-02-27 20:00 ` [dpdk-dev] [PATCH 2/2] doc: add notes regarding eventdev producer consumer dependency Pavan Nikhilesh Bhagavatula
2019-03-05 15:15 ` Jerin Jacob Kollanukkaran
2019-03-05 23:52 ` Carrillo, Erik G
2019-03-06 5:32 ` Gujjar, Abhinandan S
2019-03-08 18:24 ` [dpdk-dev] [PATCH 1/2] app/eventdev: start event producers after eventdev is started Jerin Jacob Kollanukkaran
2019-03-11 7:59 ` [dpdk-dev] [PATCH v2 1/2] app/eventdev: start event producers after eventdev Pavan Nikhilesh Bhagavatula
2019-03-11 7:59 ` [dpdk-dev] [PATCH v2 2/2] doc: add notes about eventdev producer consumer dependency Pavan Nikhilesh Bhagavatula
2019-03-12 20:41 ` [dpdk-dev] [PATCH v3 1/3] app/eventdev: start event producers after eventdev Pavan Nikhilesh Bhagavatula
2019-03-12 20:41 ` [dpdk-dev] [PATCH v3 2/3] examples/eventdev: start ethdev after eth adapter setup Pavan Nikhilesh Bhagavatula
2019-03-13 13:10 ` Rao, Nikhil
2019-03-12 20:41 ` Pavan Nikhilesh Bhagavatula [this message]
2019-03-13 22:22 ` [dpdk-dev] [PATCH v3 3/3] doc: add notes about eventdev producer consumer dependency Carrillo, Erik G
2019-03-13 22:22 ` Carrillo, Erik G
2019-03-14 16:17 ` Jerin Jacob Kollanukkaran
2019-03-14 16:17 ` Jerin Jacob Kollanukkaran
2019-03-14 5:03 ` Gujjar, Abhinandan S
2019-03-14 5:03 ` Gujjar, Abhinandan S
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=20190312204037.16141-3-pbhagavatula@marvell.com \
--to=pbhagavatula@marvell.com \
--cc=abhinandan.gujjar@intel.com \
--cc=dev@dpdk.org \
--cc=erik.g.carrillo@intel.com \
--cc=harry.van.haaren@intel.com \
--cc=jerinj@marvell.com \
--cc=john.mcnamara@intel.com \
--cc=nikhil.rao@intel.com \
/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).