From 1534cc6ab1d93041dcbb0bb6c7f1e111578dffd4 Mon Sep 17 00:00:00 2001 From: Pavan Nikhilesh Date: Tue, 12 Mar 2019 20:41:13 +0000 Subject: [PATCH] doc: add notes about eventdev producer/consumer dependency 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 Reviewed-by: Erik Gabriel Carrillo Reviewed-by: Abhinandan Gujjar --- 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 9fe09c805d..1e3eb71395 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 0166bb45de..e955299746 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 3b4446ee92..eb195ebd4c 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 8fcae54695..dcdfeb75ef 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 d367309cb7..a7419e91c1 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 863b72a105..2314b93f6b 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 db98dec46b..cc4518d41e 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.20.1