From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <abhinandan.gujjar@intel.com> Received: from mga12.intel.com (mga12.intel.com [192.55.52.136]) by dpdk.org (Postfix) with ESMTP id B4E582C28 for <dev@dpdk.org>; Thu, 14 Mar 2019 06:04:00 +0100 (CET) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga007.jf.intel.com ([10.7.209.58]) by fmsmga106.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 13 Mar 2019 22:03:59 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.58,477,1544515200"; d="scan'208";a="122542372" Received: from pgsmsx105.gar.corp.intel.com ([10.221.44.96]) by orsmga007.jf.intel.com with ESMTP; 13 Mar 2019 22:03:58 -0700 Received: from pgsmsx102.gar.corp.intel.com ([169.254.6.31]) by PGSMSX105.gar.corp.intel.com ([169.254.4.121]) with mapi id 14.03.0415.000; Thu, 14 Mar 2019 13:03:57 +0800 From: "Gujjar, Abhinandan S" <abhinandan.gujjar@intel.com> To: Pavan Nikhilesh Bhagavatula <pbhagavatula@marvell.com>, "Jerin Jacob Kollanukkaran" <jerinj@marvell.com>, "Van Haaren, Harry" <harry.van.haaren@intel.com>, "Rao, Nikhil" <nikhil.rao@intel.com>, "Carrillo, Erik G" <erik.g.carrillo@intel.com>, "Mcnamara, John" <john.mcnamara@intel.com> CC: "dev@dpdk.org" <dev@dpdk.org> Thread-Topic: [dpdk-dev] [PATCH v3 3/3] doc: add notes about eventdev producer consumer dependency Thread-Index: AQHU2RP7M/+bme4clk2Gf5fZlVGUPaYKlCnw Date: Thu, 14 Mar 2019 05:03:56 +0000 Message-ID: <5612CB344B05EE4F95FC5B729939F7807948457D@PGSMSX102.gar.corp.intel.com> References: <20190227200019.1085-1-pbhagavatula@marvell.com> <20190312204037.16141-1-pbhagavatula@marvell.com> <20190312204037.16141-3-pbhagavatula@marvell.com> In-Reply-To: <20190312204037.16141-3-pbhagavatula@marvell.com> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ctpclassification: CTP_NT x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiYmRjOTk0YzEtZTJiNy00M2QyLThhMTItZWE0NTI3M2ZhNWU1IiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE3LjEwLjE4MDQuNDkiLCJUcnVzdGVkTGFiZWxIYXNoIjoiWE9FckhneE9yVzRCc0NGN1hkRjVIMlRSS3JocVFOekIxeFpjZzFDSFNKN3ZIZ3plMlwvSHlHc2Z4bVZGT3o1MXYifQ== dlp-product: dlpe-windows dlp-version: 11.0.400.15 dlp-reaction: no-action x-originating-ip: [172.30.20.205] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [PATCH v3 3/3] doc: add notes about eventdev producer consumer dependency X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions <dev.dpdk.org> List-Unsubscribe: <https://mails.dpdk.org/options/dev>, <mailto:dev-request@dpdk.org?subject=unsubscribe> List-Archive: <http://mails.dpdk.org/archives/dev/> List-Post: <mailto:dev@dpdk.org> List-Help: <mailto:dev-request@dpdk.org?subject=help> List-Subscribe: <https://mails.dpdk.org/listinfo/dev>, <mailto:dev-request@dpdk.org?subject=subscribe> X-List-Received-Date: Thu, 14 Mar 2019 05:04:01 -0000 > -----Original Message----- > From: Pavan Nikhilesh Bhagavatula <pbhagavatula@marvell.com> > Sent: Wednesday, March 13, 2019 2:11 AM > To: Jerin Jacob Kollanukkaran <jerinj@marvell.com>; Van Haaren, Harry > <harry.van.haaren@intel.com>; Rao, Nikhil <nikhil.rao@intel.com>; Carrill= o, > Erik G <erik.g.carrillo@intel.com>; Gujjar, Abhinandan S > <abhinandan.gujjar@intel.com>; Mcnamara, John <john.mcnamara@intel.com> > Cc: dev@dpdk.org; Pavan Nikhilesh Bhagavatula <pbhagavatula@marvell.com> > Subject: [dpdk-dev] [PATCH v3 3/3] doc: add notes about eventdev producer > consumer dependency >=20 > From: Pavan Nikhilesh <pbhagavatula@marvell.com> >=20 > EventDev i.e consumer needs to be started before starting the event produ= cers. > Update documentation of EventDev and EventDev adapters. >=20 > Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com> > --- > v2 Changes: Add Notes to doxygen API. >=20 > 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(+) >=20 > 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. >=20 > rte_event_crypto_adapter_start(id, mode); >=20 > +.. Note:: > + > + The eventdev to which the event_crypto_adapter is connected nee= ds 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/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 event= dev > PMDs for hardware based eventdev-ethdev connections and > ``rte_service_run_state_set()`` to enable the service function if one ex= ists. >=20 > +.. Note:: > + > + The eventdev to which the event_eth_rx_adapter is connected nee= ds 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/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. >=20 > +.. Note:: > + > + The eventdev to which the event_timer_adapter is connected need= s 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/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. >=20 > int err =3D rte_event_dev_start(dev_id); >=20 > +.. Note:: > + > + EventDev needs to be started before starting the event producer= s such > + as event_eth_rx_adapter, event_timer_adapter and > event_crypto_adapter. > + > Ingress of New Events > ~~~~~~~~~~~~~~~~~~~~~ >=20 > 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); >=20 > 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 mappe= d > + * > + * @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 Reviewed-by: Abhinandan Gujjar <abhinandan.gs@intel.com> From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <dev-bounces@dpdk.org> Received: from dpdk.org (dpdk.org [92.243.14.124]) by dpdk.space (Postfix) with ESMTP id 93CE9A0096 for <public@inbox.dpdk.org>; Thu, 14 Mar 2019 06:04:03 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id BFADD3572; Thu, 14 Mar 2019 06:04:02 +0100 (CET) Received: from mga12.intel.com (mga12.intel.com [192.55.52.136]) by dpdk.org (Postfix) with ESMTP id B4E582C28 for <dev@dpdk.org>; Thu, 14 Mar 2019 06:04:00 +0100 (CET) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga007.jf.intel.com ([10.7.209.58]) by fmsmga106.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 13 Mar 2019 22:03:59 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.58,477,1544515200"; d="scan'208";a="122542372" Received: from pgsmsx105.gar.corp.intel.com ([10.221.44.96]) by orsmga007.jf.intel.com with ESMTP; 13 Mar 2019 22:03:58 -0700 Received: from pgsmsx102.gar.corp.intel.com ([169.254.6.31]) by PGSMSX105.gar.corp.intel.com ([169.254.4.121]) with mapi id 14.03.0415.000; Thu, 14 Mar 2019 13:03:57 +0800 From: "Gujjar, Abhinandan S" <abhinandan.gujjar@intel.com> To: Pavan Nikhilesh Bhagavatula <pbhagavatula@marvell.com>, "Jerin Jacob Kollanukkaran" <jerinj@marvell.com>, "Van Haaren, Harry" <harry.van.haaren@intel.com>, "Rao, Nikhil" <nikhil.rao@intel.com>, "Carrillo, Erik G" <erik.g.carrillo@intel.com>, "Mcnamara, John" <john.mcnamara@intel.com> CC: "dev@dpdk.org" <dev@dpdk.org> Thread-Topic: [dpdk-dev] [PATCH v3 3/3] doc: add notes about eventdev producer consumer dependency Thread-Index: AQHU2RP7M/+bme4clk2Gf5fZlVGUPaYKlCnw Date: Thu, 14 Mar 2019 05:03:56 +0000 Message-ID: <5612CB344B05EE4F95FC5B729939F7807948457D@PGSMSX102.gar.corp.intel.com> References: <20190227200019.1085-1-pbhagavatula@marvell.com> <20190312204037.16141-1-pbhagavatula@marvell.com> <20190312204037.16141-3-pbhagavatula@marvell.com> In-Reply-To: <20190312204037.16141-3-pbhagavatula@marvell.com> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ctpclassification: CTP_NT x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiYmRjOTk0YzEtZTJiNy00M2QyLThhMTItZWE0NTI3M2ZhNWU1IiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE3LjEwLjE4MDQuNDkiLCJUcnVzdGVkTGFiZWxIYXNoIjoiWE9FckhneE9yVzRCc0NGN1hkRjVIMlRSS3JocVFOekIxeFpjZzFDSFNKN3ZIZ3plMlwvSHlHc2Z4bVZGT3o1MXYifQ== dlp-product: dlpe-windows dlp-version: 11.0.400.15 dlp-reaction: no-action x-originating-ip: [172.30.20.205] Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [PATCH v3 3/3] doc: add notes about eventdev producer consumer dependency X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions <dev.dpdk.org> List-Unsubscribe: <https://mails.dpdk.org/options/dev>, <mailto:dev-request@dpdk.org?subject=unsubscribe> List-Archive: <http://mails.dpdk.org/archives/dev/> List-Post: <mailto:dev@dpdk.org> List-Help: <mailto:dev-request@dpdk.org?subject=help> List-Subscribe: <https://mails.dpdk.org/listinfo/dev>, <mailto:dev-request@dpdk.org?subject=subscribe> Errors-To: dev-bounces@dpdk.org Sender: "dev" <dev-bounces@dpdk.org> Message-ID: <20190314050356.pw5eHNHYaLzYiXv5ubYsP9W5_AbTb2V6aAsUR4_93p8@z> > -----Original Message----- > From: Pavan Nikhilesh Bhagavatula <pbhagavatula@marvell.com> > Sent: Wednesday, March 13, 2019 2:11 AM > To: Jerin Jacob Kollanukkaran <jerinj@marvell.com>; Van Haaren, Harry > <harry.van.haaren@intel.com>; Rao, Nikhil <nikhil.rao@intel.com>; Carrill= o, > Erik G <erik.g.carrillo@intel.com>; Gujjar, Abhinandan S > <abhinandan.gujjar@intel.com>; Mcnamara, John <john.mcnamara@intel.com> > Cc: dev@dpdk.org; Pavan Nikhilesh Bhagavatula <pbhagavatula@marvell.com> > Subject: [dpdk-dev] [PATCH v3 3/3] doc: add notes about eventdev producer > consumer dependency >=20 > From: Pavan Nikhilesh <pbhagavatula@marvell.com> >=20 > EventDev i.e consumer needs to be started before starting the event produ= cers. > Update documentation of EventDev and EventDev adapters. >=20 > Signed-off-by: Pavan Nikhilesh <pbhagavatula@marvell.com> > --- > v2 Changes: Add Notes to doxygen API. >=20 > 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(+) >=20 > 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. >=20 > rte_event_crypto_adapter_start(id, mode); >=20 > +.. Note:: > + > + The eventdev to which the event_crypto_adapter is connected nee= ds 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/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 event= dev > PMDs for hardware based eventdev-ethdev connections and > ``rte_service_run_state_set()`` to enable the service function if one ex= ists. >=20 > +.. Note:: > + > + The eventdev to which the event_eth_rx_adapter is connected nee= ds 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/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. >=20 > +.. Note:: > + > + The eventdev to which the event_timer_adapter is connected need= s 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/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. >=20 > int err =3D rte_event_dev_start(dev_id); >=20 > +.. Note:: > + > + EventDev needs to be started before starting the event producer= s such > + as event_eth_rx_adapter, event_timer_adapter and > event_crypto_adapter. > + > Ingress of New Events > ~~~~~~~~~~~~~~~~~~~~~ >=20 > 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); >=20 > 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 mappe= d > + * > + * @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 Reviewed-by: Abhinandan Gujjar <abhinandan.gs@intel.com>