From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <Honnappa.Nagarahalli@arm.com>
Received: from EUR01-DB5-obe.outbound.protection.outlook.com
 (mail-db5eur01on0058.outbound.protection.outlook.com [104.47.2.58])
 by dpdk.org (Postfix) with ESMTP id A991F1B87D
 for <dev@dpdk.org>; Wed,  6 Jun 2018 03:27:30 +0200 (CEST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=armh.onmicrosoft.com; 
 s=selector1-arm-com;
 h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck;
 bh=+GWAyrroqaC+1SgAcjbsfRT6/QJ8/59AANsua0DN6JQ=;
 b=c8VBq6USTYbYScR+q87uC7RFVXA6Uz/ZTTeKH/Cx8iU7p8lhdU5gzQUH40TDWLNq4O2Bbxk/TKv+yLg4hB+PbQXmtZ22eKuLQJvqZa6g3BkhmJ3WFONw5sVO/1KsN66m9hLLmhZw1N2BQnBJ43k2259meEB2dtjS8Z2/c17Eo88=
Received: from HE1PR0801MB1930.eurprd08.prod.outlook.com (10.168.94.136) by
 HE1PR0801MB1770.eurprd08.prod.outlook.com (10.168.150.13) with Microsoft SMTP
 Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id
 15.20.820.15; Wed, 6 Jun 2018 01:27:28 +0000
Received: from HE1PR0801MB1930.eurprd08.prod.outlook.com
 ([fe80::410b:9819:fe6b:64ad]) by HE1PR0801MB1930.eurprd08.prod.outlook.com
 ([fe80::410b:9819:fe6b:64ad%8]) with mapi id 15.20.0820.015; Wed, 6 Jun 2018
 01:27:28 +0000
From: Honnappa Nagarahalli <Honnappa.Nagarahalli@arm.com>
To: Jerin Jacob <jerin.jacob@caviumnetworks.com>
CC: "Van Haaren, Harry" <harry.van.haaren@intel.com>, "dev@dpdk.org"
 <dev@dpdk.org>, nd <nd@arm.com>
Thread-Topic: [PATCH] doc/event: improve eventdev library documentation
Thread-Index: AQHT+757V4pMJC2byEarJikx5To3wKRR3dKAgABCIRCAADcEgIAAFpEg
Date: Wed, 6 Jun 2018 01:27:28 +0000
Message-ID: <HE1PR0801MB19307121144D4D6ECAF638F998650@HE1PR0801MB1930.eurprd08.prod.outlook.com>
References: <1527798222-1873-1-git-send-email-honnappa.nagarahalli@arm.com>
 <20180604044217.GA2901@jerin>
 <E923DB57A917B54B9182A2E928D00FA65E257536@IRSMSX102.ger.corp.intel.com>
 <HE1PR0801MB19306F1C880D003C5F0CB17898660@HE1PR0801MB1930.eurprd08.prod.outlook.com>
 <20180605234503.GA5277@jerin>
In-Reply-To: <20180605234503.GA5277@jerin>
Accept-Language: en-US
Content-Language: en-US
X-MS-Has-Attach: 
X-MS-TNEF-Correlator: 
authentication-results: spf=none (sender IP is )
 smtp.mailfrom=Honnappa.Nagarahalli@arm.com; 
x-originating-ip: [217.140.111.135]
x-ms-publictraffictype: Email
x-microsoft-exchange-diagnostics: 1; HE1PR0801MB1770;
 7:unQxgZbgDr8mb5NratiboFbmdAoiWZ4Kbft0dpltTba/lBGNxlcq8yxdZJMn3eJBHqGa+J30G3ydOIM3yk+21bbryTnR2/iYJNbclskHaG02a/Pyr/A/5VcUdgS+EBn6gOEz0MfWuNIml5Xk40xTpB0ZEnK5qHKNMccA+kzKr+TwAH0gDsJ4+hJlfi33A9N++G9tU8RYNUYNj6kvpXWjmL08gixTzyW4t+Imobu1yMy/Yn7j6f32Vc7GJxwvFGpi
x-ms-exchange-antispam-srfa-diagnostics: SOS;
x-ms-office365-filtering-ht: Tenant
x-microsoft-antispam: UriScan:; BCL:0; PCL:0;
 RULEID:(7020095)(4652020)(48565401081)(5600026)(4534165)(4627221)(201703031133081)(201702281549075)(2017052603328)(7153060)(7193020);
 SRVR:HE1PR0801MB1770; 
x-ms-traffictypediagnostic: HE1PR0801MB1770:
nodisclaimer: True
x-microsoft-antispam-prvs: <HE1PR0801MB177012E7DB500064AA200E1498650@HE1PR0801MB1770.eurprd08.prod.outlook.com>
x-exchange-antispam-report-test: UriScan:(180628864354917)(228905959029699);
x-ms-exchange-senderadcheck: 1
x-exchange-antispam-report-cfa-test: BCL:0; PCL:0;
 RULEID:(8211001083)(6040522)(2401047)(5005006)(8121501046)(3002001)(3231254)(944501410)(52105095)(93006095)(93001095)(10201501046)(6055026)(149027)(150027)(6041310)(20161123564045)(20161123558120)(20161123560045)(20161123562045)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(6072148)(201708071742011)(7699016);
 SRVR:HE1PR0801MB1770; BCL:0; PCL:0; RULEID:; SRVR:HE1PR0801MB1770; 
x-forefront-prvs: 06952FC175
x-forefront-antispam-report: SFV:NSPM;
 SFS:(10009020)(39380400002)(346002)(376002)(39860400002)(366004)(396003)(189003)(40434004)(199004)(13464003)(9686003)(8676002)(74316002)(2906002)(3660700001)(446003)(76176011)(14454004)(11346002)(33656002)(5660300001)(229853002)(6436002)(25786009)(93886005)(68736007)(7736002)(66066001)(86362001)(6306002)(316002)(54906003)(55016002)(305945005)(72206003)(105586002)(81156014)(486006)(81166006)(53546011)(97736004)(6506007)(476003)(106356001)(59450400001)(99286004)(6116002)(53376002)(3846002)(186003)(966005)(7696005)(5890100001)(8936002)(3280700002)(4326008)(6916009)(2900100001)(5250100002)(53936002)(102836004)(478600001)(6246003)(26005);
 DIR:OUT; SFP:1101; SCL:1; SRVR:HE1PR0801MB1770;
 H:HE1PR0801MB1930.eurprd08.prod.outlook.com; FPR:; SPF:None; LANG:en;
 PTR:InfoNoRecords; MX:1; A:1; 
received-spf: None (protection.outlook.com: arm.com does not designate
 permitted sender hosts)
x-microsoft-antispam-message-info: DLLHJcAuKi41UCeT7ygb3CkR77wO4Y/aGDIPBYUvfYa0aTd9uuI1DGm0qaAJHl4sRIuhjDJuIFS4GiKAyqoVCDUuy/fHjUjXyBUnnfHXWM7fjIuliDnQ2yWwiIHX5PukML1sPvElv8pgSWQNwe5ujU8CJLgaJQDHCFp+AFyLfTYtqtd3RJJP6oZHUjNTvsci
spamdiagnosticoutput: 1:99
spamdiagnosticmetadata: NSPM
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-MS-Office365-Filtering-Correlation-Id: adfbf208-2726-4d13-ca49-08d5cb4caaa6
X-OriginatorOrg: arm.com
X-MS-Exchange-CrossTenant-Network-Message-Id: adfbf208-2726-4d13-ca49-08d5cb4caaa6
X-MS-Exchange-CrossTenant-originalarrivaltime: 06 Jun 2018 01:27:28.2709 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: f34e5979-57d9-4aaa-ad4d-b122a662184d
X-MS-Exchange-Transport-CrossTenantHeadersStamped: HE1PR0801MB1770
Subject: Re: [dpdk-dev] [PATCH] doc/event: improve eventdev library
	documentation
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://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Wed, 06 Jun 2018 01:27:31 -0000



-----Original Message-----
From: Jerin Jacob <jerin.jacob@caviumnetworks.com>=20
Sent: Tuesday, June 5, 2018 6:45 PM
To: Honnappa Nagarahalli <Honnappa.Nagarahalli@arm.com>
Cc: Van Haaren, Harry <harry.van.haaren@intel.com>; dev@dpdk.org
Subject: Re: [PATCH] doc/event: improve eventdev library documentation

-----Original Message-----
> Date: Tue, 5 Jun 2018 20:32:39 +0000
> From: Honnappa Nagarahalli <Honnappa.Nagarahalli@arm.com>
> To: "Van Haaren, Harry" <harry.van.haaren@intel.com>, Jerin Jacob =20
> <jerin.jacob@caviumnetworks.com>
> CC: "dev@dpdk.org" <dev@dpdk.org>
> Subject: RE: [PATCH] doc/event: improve eventdev library documentation
>=20
>=20
>=20
> -----Original Message-----
> From: Van Haaren, Harry <harry.van.haaren@intel.com>
> Sent: Tuesday, June 5, 2018 11:31 AM
> To: Jerin Jacob <jerin.jacob@caviumnetworks.com>; Honnappa Nagarahalli=20
> <Honnappa.Nagarahalli@arm.com>
> Cc: dev@dpdk.org
> Subject: RE: [PATCH] doc/event: improve eventdev library documentation
>=20
> > From: Jerin Jacob [mailto:jerin.jacob@caviumnetworks.com]
> > Sent: Monday, June 4, 2018 5:42 AM
> > To: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
> > Cc: dev@dpdk.org; Van Haaren, Harry <harry.van.haaren@intel.com>
> > Subject: Re: [PATCH] doc/event: improve eventdev library=20
> > documentation
> >
> > -----Original Message-----
> > > Date: Thu, 31 May 2018 15:23:42 -0500
> > > From: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
> > > To: jerin.jacob@caviumnetworks.com
> > > CC: dev@dpdk.org, Honnappa Nagarahalli=20
> > > <honnappa.nagarahalli@arm.com>
> > > Subject: [PATCH] doc/event: improve eventdev library documentation
> > > X-Mailer: git-send-email 2.7.4
> > >
> > > Add small amount of additional code, use consistent variable names=20
> > > across code blocks, change the image to represent queues and CPU=20
> > > cores intuitively. These help improve the eventdev library=20
> > > documentation.
> > >
> > > Signed-off-by: Honnappa Nagarahalli <honnappa.nagarahalli@arm.com>
> > > Reviewed-by: Gavin Hu <gavin.hu@arm.com>
> > > ---
> >
> > Changes looks good to me.
> >
> > Adding Harry for this review as he is the original author of this file.
>=20
> Thanks Jerin,
>=20
> >> uint16_t nb_rx =3D rte_event_dequeue_burst(dev_id, worker_port_id1,=20
> >> events, BATCH_SIZE, timeout);
>=20
> why is the worker port variable named "worker_port_id1"? Previously it wa=
s just worker_port_id.
>=20
> I think just worker_port_id makes more sense, perhaps update the 2 occura=
nces of id1 ?
>=20
> Will change in V2
>=20
> With that you have my
> Acked-by: Harry van Haaren <harry.van.haaren@intel.com>
>=20
>=20
>=20
> > >  doc/guides/prog_guide/eventdev.rst           |   55 +-
> > >  doc/guides/prog_guide/img/eventdev_usage.svg | 1518
> > > +++++++++------------
> > -----
> > >  2 files changed, 570 insertions(+), 1003 deletions(-)
> > >
> > > diff --git a/doc/guides/prog_guide/eventdev.rst
> > b/doc/guides/prog_guide/eventdev.rst
> > > index ce19997..0203d9e 100644
> > > --- a/doc/guides/prog_guide/eventdev.rst
> > > +++ b/doc/guides/prog_guide/eventdev.rst
> > > @@ -1,5 +1,6 @@
> > >  ..  SPDX-License-Identifier: BSD-3-Clause
> > >      Copyright(c) 2017 Intel Corporation.
> > > +    Copyright(c) 2018 Arm Limited.
> > >
> > >  Event Device Library
> > >  =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
> > > @@ -129,7 +130,7 @@ API Walk-through
> > >
> > >  This section will introduce the reader to the eventdev API,=20
> > > showing how
> > to
> > >  create and configure an eventdev and use it for a two-stage=20
> > > atomic
> > pipeline
> > > -with a single core for TX. The diagram below shows the final=20
> > > state of the
> > > +with one core each for RX and TX. The diagram below shows the=20
> > > +final state
> > of the
> >
> > I think, we can mention the usage of RX and TX core are API=20
> > illustration purpose only, In the real case, it is abstracted using=20
> > Eventdev - Ethdev adapters to hide the difference between various=20
> > eventdev capabilities to Rx or Tx the packets.
> > or something on similar lines.
> >
>=20
> I think we should leave it as is currently, the code under the section 'I=
ngress of New Events' is tied into RX core. I think the API walk-through se=
ction as a whole has to change to introduce the usage of adaptors.

We already have Rx adapter documentation at http://dpdk.org/doc/guides/prog=
_guide/event_ethernet_rx_adapter.html
My concern is reader gets confused about Rx core and think That way to send=
 the packets in eventdev from ethdev. I think, it will help reader if give =
pointers about adapter here and mention the Rx and Tx core usage as API ill=
ustration purpose only to clarify the existing architecture.

Ok, understood for RX. I do not see anything for TX core, I will leave it o=
ut from this clarification. Also TX core should be left out of this since w=
e have to show the single link queue case.

>=20
> > >
> > >
> > >  Egress of Events
> > > diff --git a/doc/guides/prog_guide/img/eventdev_usage.svg
> > b/doc/guides/prog_guide/img/eventdev_usage.svg
> > > index 7765649..b0792dc 100644
> > > --- a/doc/guides/prog_guide/img/eventdev_usage.svg
> > > +++ b/doc/guides/prog_guide/img/eventdev_usage.svg
> > > @@ -1,994 +1,546 @@
> > >  <?xml version=3D"1.0" encoding=3D"UTF-8" standalone=3D"no"?>
> >
> > License is missing
> >
> > see doc/guides/prog_guide/img/architecture-overview.svg file as referen=
ce.
> >
> > With above changes:
>=20
> Will add in V2
>=20
> >
> > Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>
>=20
> IMPORTANT NOTICE: The contents of this email and any attachments are conf=
idential and may also be privileged. If you are not the intended recipient,=
 please notify the sender immediately and do not disclose the contents to a=
ny other person, use it for any purpose, or store or copy the information i=
n any medium. Thank you.