From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <prvs=0973a10374=pbhagavatula@marvell.com>
Received: from mx0b-0016f401.pphosted.com (mx0b-0016f401.pphosted.com
[67.231.156.173]) by dpdk.org (Postfix) with ESMTP id 7A1F55323
for <dev@dpdk.org>; Mon, 11 Mar 2019 09:00:13 +0100 (CET)
Received: from pps.filterd (m0045851.ppops.net [127.0.0.1])
by mx0b-0016f401.pphosted.com (8.16.0.27/8.16.0.27) with SMTP id
x2B7onWf005332; Mon, 11 Mar 2019 01:00:12 -0700
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.com;
h=from : to : cc :
subject : date : message-id : references : in-reply-to : content-type :
content-transfer-encoding : mime-version; s=pfpt0818;
bh=L84WuFmoy72XrmFh/MPNo7FcqYc2kyiN0GHwnAEAo+w=;
b=duH9L0WXGQOpxYoj6xRyPhW5sANPECyY42Q2NlUaA5zQIuI3H3APtvBpQLlqUzAtIsJM
TAX/sqBLzXaKgXKU82CyH4PKD73wOQjwfaB5GqVzt2lPduNOjisOcVFsZ+GKr0iPv2yQ
FXdaT/TlUd4eQe44Z5XqkKURu5gxKV8eB112Ff6uTMss01aomu82lQUMSKX2kkv9PVbN
Con731nEfPxxWKOZlg9fnClLK1brDk1H3IixSQfTGWO5easvK+HmX6eyk7ohm1OmfsfL
mA9nYeKJTml0KfEovKqIIFT4Z1Wal7difnT9aEIt459em5szf2EHRfD1ixtmtZVhktrm mQ==
Received: from sc-exch04.marvell.com ([199.233.58.184])
by mx0b-0016f401.pphosted.com with ESMTP id 2r4dvrd2cg-4
(version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT);
Mon, 11 Mar 2019 01:00:12 -0700
Received: from SC-EXCH03.marvell.com (10.93.176.83) by SC-EXCH04.marvell.com
(10.93.176.84) with Microsoft SMTP Server (TLS) id 15.0.1367.3; Mon, 11 Mar
2019 00:59:57 -0700
Received: from NAM04-CO1-obe.outbound.protection.outlook.com (104.47.45.59) by
SC-EXCH03.marvell.com (10.93.176.83) with Microsoft SMTP Server
(TLS) id
15.0.1367.3 via Frontend Transport; Mon, 11 Mar 2019 00:59:57 -0700
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=marvell.onmicrosoft.com; s=selector1-marvell-com;
h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck;
bh=L84WuFmoy72XrmFh/MPNo7FcqYc2kyiN0GHwnAEAo+w=;
b=Tilrp1Ecrt+zcyJlcaEdGc8EEUsX4Dl7JxKUeSS+TRJaiaJCkWlgjp9TfLQ39A+byYebWgwKYtJpT/un8esvYVM/wY+CdTikE4e+bFvB6Vm8RrlgqMNK7MTNrwU9ugm7uU5v5cxWOQ73NkEg2/M3HDEUuQJ1ZIrMZccqw3THmGc=
Received: from CY4PR1801MB1863.namprd18.prod.outlook.com (10.171.255.14) by
CY4PR1801MB1895.namprd18.prod.outlook.com (10.171.255.22) with Microsoft SMTP
Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id
15.20.1686.18; Mon, 11 Mar 2019 07:59:56 +0000
Received: from CY4PR1801MB1863.namprd18.prod.outlook.com
([fe80::286d:5e93:974e:8bfa]) by CY4PR1801MB1863.namprd18.prod.outlook.com
([fe80::286d:5e93:974e:8bfa%2]) with mapi id 15.20.1686.021; Mon, 11 Mar 2019
07:59:56 +0000
From: Pavan Nikhilesh Bhagavatula <pbhagavatula@marvell.com>
To: Jerin Jacob Kollanukkaran <jerinj@marvell.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>
Thread-Topic: [dpdk-dev] [PATCH v2 2/2] doc: add notes about eventdev producer
consumer dependency
Thread-Index: AQHU1+Bqwk0raGHucECBDdldtobCqA==
Date: Mon, 11 Mar 2019 07:59:55 +0000
Message-ID: <20190311075922.9937-2-pbhagavatula@marvell.com>
References: <20190227200019.1085-1-pbhagavatula@marvell.com>
<20190311075922.9937-1-pbhagavatula@marvell.com>
In-Reply-To: <20190311075922.9937-1-pbhagavatula@marvell.com>
Accept-Language: en-IN, en-US
Content-Language: en-US
X-MS-Has-Attach:
X-MS-TNEF-Correlator:
x-clientproxiedby: BMXPR01CA0029.INDPRD01.PROD.OUTLOOK.COM
(2603:1096:b00:c::15) To CY4PR1801MB1863.namprd18.prod.outlook.com
(2603:10b6:910:7a::14)
x-ms-exchange-messagesentrepresentingtype: 1
x-mailer: git-send-email 2.21.0
x-originating-ip: [117.203.49.141]
x-ms-publictraffictype: Email
x-ms-office365-filtering-correlation-id: 4af457eb-5693-40c9-ba7f-08d6a5f78c53
x-microsoft-antispam: BCL:0; PCL:0;
RULEID:(2390118)(7020095)(4652040)(8989299)(4534185)(7168020)(4627221)(201703031133081)(201702281549075)(8990200)(5600127)(711020)(4605104)(2017052603328)(7153060)(7193020);
SRVR:CY4PR1801MB1895;
x-ms-traffictypediagnostic: CY4PR1801MB1895:
x-microsoft-exchange-diagnostics: =?iso-8859-1?Q?1; CY4PR1801MB1895;
23:I2q4LJQ0R8CLC1V5hAqIDaFryPP5X1xynWFip?=
=?iso-8859-1?Q?d7FUnnd6CH0g/4C2e2yGSi2nQp3D8d2f3kIiSJ9dA7s28o8Z87joBMVIL+?=
=?iso-8859-1?Q?lFIo31lO63h4o7TWxlaimOjCc4JTBhF8w4HNLJJwjlLqK29NT35PdRc6vG?=
=?iso-8859-1?Q?Oc5gAQ0vIGMFlNZ3UVRY7DnyBJ9N2fWD4Ow7meNIntUV5i+JJmgV0pIjnF?=
=?iso-8859-1?Q?wGcjMAejo+DcH2FEMFWOSpgGbc/XsJGpwBH5mxPETdfMlXO29iBPIGF38S?=
=?iso-8859-1?Q?UjP3iLgMH8NFX6AOjUYUsTHvuETMyrbXiOWwC1YghXbBt1vulDLKr2wZiz?=
=?iso-8859-1?Q?B3MKKerbILcILOTqsIL3dSrYAYnhT43mkLsWopmwmXMaV5uA/Vka7VrIby?=
=?iso-8859-1?Q?ojkHg7X+WNoKsHib0bwSCqZrOd1BAACg5ZdgQQ32DaLpEMgtsUMKRk6N9P?=
=?iso-8859-1?Q?k+lFI+CiV7ZFkSt7gpiGRw3x7BToj/y46EI3uRRcMchjahSnYCdSLm6h8k?=
=?iso-8859-1?Q?SF3wgOgIVmprCOY+2Nk6KoO9aYxIEgdkrjYTWmx2VwOLOCM2fdCq4O7u6n?=
=?iso-8859-1?Q?72GSpZmoOSDgu4oxZk5DgSMIXmjoUEWvHVTsHhwWUANOs0U0HggltrX1yK?=
=?iso-8859-1?Q?jhs36nRpQUkrgl926AAOX/NO1Sf9ZDcl4do5ZT0dfONgeWmSYmfz3T1ff5?=
=?iso-8859-1?Q?QlwdxM1A5AXG5tSyX9Zy4xHX0rouSkPVdJUqqyWTRdLqPZFfnUcrTpq/tj?=
=?iso-8859-1?Q?gZ1Tl3AC5L5ushaHBRDArpIaZXIXcmXa+Yawm/AiZ7LobpjjpsjA5qN79j?=
=?iso-8859-1?Q?ZAbRjutOPnm2ngnV8jnvpKQ5Y86edYqqTtSPmZ4/BY72dvRghApqHBUKYz?=
=?iso-8859-1?Q?dNpYMERKDLcaKC56YNBWVHw0beWXdvNJFe36TTw15TNLk8ULZiSMqVyHuD?=
=?iso-8859-1?Q?xdRNzImWoC4hJfAs5qvFD9+yvOD8P/GyG7XmUPE68IjxiVBlsmnFWdLM/0?=
=?iso-8859-1?Q?OXU+1q42HEKe2xA4U+qsfXXFfFkEP3wo7Q7r4W6MQCADY5Rn9g16OPF8Nf?=
=?iso-8859-1?Q?zK+p5kCnfdWMb8bTk0s67ZOHgF3ymVjknkk+q/yQUJdfLg7X2ATyNThU7Z?=
=?iso-8859-1?Q?bwK4TKb6HKd4ELUfb1X3blyRdu7EWngQnDctGSWjYlDgiUVm3CxbtdGpas?=
=?iso-8859-1?Q?wJ44JxpOv76fyraJm2uzVatYDoBcu+50lnKk6ozNKrhdq00LOtamOgqWmO?=
=?iso-8859-1?Q?LI3+cnZBaadoxZlNAjzquJU6EYTsbea1hP2Tc4Flb/mwo+PgQQmV4pKB9t?=
=?iso-8859-1?Q?nhThSK//v6vB4J45QZUPBU0NVFRG7A8CVhjV4yBlv2iRREeYxRS2MJEe2Z?=
=?iso-8859-1?Q?MKiKrMDCZA=3D?=
x-microsoft-antispam-prvs: <CY4PR1801MB1895224B3427BE0E18B04164DE480@CY4PR1801MB1895.namprd18.prod.outlook.com>
x-forefront-prvs: 09730BD177
x-forefront-antispam-report: SFV:NSPM;
SFS:(10009020)(346002)(136003)(366004)(396003)(39850400004)(376002)(199004)(189003)(6512007)(53936002)(6436002)(107886003)(68736007)(110136005)(81156014)(81166006)(54906003)(52116002)(50226002)(386003)(8936002)(55236004)(6116002)(102836004)(3846002)(2501003)(105586002)(106356001)(1076003)(26005)(478600001)(14454004)(186003)(36756003)(6506007)(316002)(256004)(14444005)(5660300002)(446003)(8676002)(11346002)(476003)(2616005)(2906002)(25786009)(6486002)(305945005)(7736002)(97736004)(486006)(76176011)(71190400001)(71200400001)(66066001)(86362001)(99286004)(2201001)(4326008);
DIR:OUT; SFP:1101; SCL:1; SRVR:CY4PR1801MB1895;
H:CY4PR1801MB1863.namprd18.prod.outlook.com; FPR:; SPF:None; LANG:en;
PTR:InfoNoRecords; A:1; MX:1;
received-spf: None (protection.outlook.com: marvell.com does not designate
permitted sender hosts)
x-ms-exchange-senderadcheck: 1
x-microsoft-antispam-message-info: uOOb5zAdCPXz18H1Gz6d0iRJfJRzrH0Kzt/PRkInSvbBLeN/zC5oiJZ08GDpwzW254z8MCHsokt6WYtekh1M4dEXfVvWV2YuCjq0VVo1Uo+xL2Na8PjG4KtzWCxZdKmDfucpkzXP1JTQBXPRCFpedgh9+0Gep6vadYF9CaVbcF7bZ2xjtvJVBG2eQ2tvML4hjQ71ubzsXgXE3p4E9HWA1EUwpslTF+SHAIc1AysD0Vwwmp/+ekVQ/t4BNOueap323pFduCK3a9jmeMWAlbCiiIStKpupJ7gcXDwbdbfMPx3rzv6VSQcOMGPFwOc9iYuIbX/rHKCj+ywHmXc3kimF9sbfsV3VR/7zstmwNX4w4sNdBotUw0TdkTjfUfQn1eeYQ8xk454CSq1bnic1h2DJWNHvm6WhQZ6t9UBvVTG7lsY=
Content-Type: text/plain; charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-MS-Exchange-CrossTenant-Network-Message-Id: 4af457eb-5693-40c9-ba7f-08d6a5f78c53
X-MS-Exchange-CrossTenant-originalarrivaltime: 11 Mar 2019 07:59:55.9713 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 70e1fb47-1155-421d-87fc-2e58f638b6e0
X-MS-Exchange-CrossTenant-mailboxtype: HOSTED
X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY4PR1801MB1895
X-OriginatorOrg: marvell.com
X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:, ,
definitions=2019-03-11_06:, , signatures=0
Subject: [dpdk-dev] [PATCH v2 2/2] 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: Mon, 11 Mar 2019 08:00:13 -0000
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/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.
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/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.
+.. 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/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.
+.. 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/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.
int err =3D 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_ada=
pter.
+
Ingress of New Events
~~~~~~~~~~~~~~~~~~~~~
diff --git a/lib/librte_eventdev/rte_event_crypto_adapter.h b/lib/librte_ev=
entdev/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, ui=
nt8_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_ev=
entdev/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, uin=
t16_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_eve=
ntdev/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