[v2,2/2] doc: add notes about eventdev producer consumer dependency
Checks
Commit Message
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(+)
--
2.21.0
@@ -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
~~~~~~~~~~~~~~~~~~~~~~
@@ -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
~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -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
~~~~~~~~~~~~~~~~~~~
@@ -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
~~~~~~~~~~~~~~~~~~~~~
@@ -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);
@@ -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);
@@ -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(