From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from EUR01-HE1-obe.outbound.protection.outlook.com (mail-he1eur01on0064.outbound.protection.outlook.com [104.47.0.64]) by dpdk.org (Postfix) with ESMTP id C96991B877 for ; Wed, 6 Jun 2018 03:44:04 +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=BFD6+I4FJn5NHaTP+fBgYivyZfy3wXYZxru0qPud3bQ=; b=I6WdTuM9IwvATQwN04vS1nHdcpoWMvrpqthH4pJP5aCtzdzZFpyDYPyVxStmoTHgnNfftTuJl9l9LrwWEOlwsBr7sXbshuj0IJGTrPl+fsWQLGitpUj+Rxcz605n4tVPTHpab/L4MED9QE4WPf1nUFjOe5gz1tKT6Fgt4zG3mdo= Received: from HE1PR0801MB1930.eurprd08.prod.outlook.com (10.168.94.136) by HE1PR0801MB2091.eurprd08.prod.outlook.com (10.168.95.143) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.820.13; Wed, 6 Jun 2018 01:44:02 +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:44:02 +0000 From: Honnappa Nagarahalli To: Jerin Jacob CC: "Van Haaren, Harry" , "dev@dpdk.org" , nd Thread-Topic: [PATCH] doc/event: improve eventdev library documentation Thread-Index: AQHT+757V4pMJC2byEarJikx5To3wKRR3dKAgABCIRCAADcEgIAAFpEggAAKXQA= Date: Wed, 6 Jun 2018 01:44:01 +0000 Message-ID: References: <1527798222-1873-1-git-send-email-honnappa.nagarahalli@arm.com> <20180604044217.GA2901@jerin> <20180605234503.GA5277@jerin> In-Reply-To: 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; HE1PR0801MB2091; 7:TVXjD9xrQRI9xp+fis3XKtwkOy4FvlXKmIMsES8KCoW3HA4ya/8Pv69FluOEIZENNAQqdX2E2sLTPLlpqJCLR2hmnSSrTGoPrhbgHCOs71b+Gfcec4Xtc7KwG4ZEzyLqRrqEvaBqFcmvIRbWZ0vcCahn5+pMxGNjOWsOKXzyxph7kJPACSmeNow4A5pzjD7C9b+D7Inte8HT47dxkc2mH2fF8wqRneUIZqD5eRziAcYvKrsjF3pkpqwxSI7dVvwI 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:HE1PR0801MB2091; x-ms-traffictypediagnostic: HE1PR0801MB2091: nodisclaimer: True x-microsoft-antispam-prvs: 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)(8121501046)(5005006)(3002001)(10201501046)(93006095)(93001095)(3231254)(944501410)(52105095)(6055026)(149027)(150027)(6041310)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123560045)(20161123562045)(20161123558120)(20161123564045)(6072148)(201708071742011)(7699016); SRVR:HE1PR0801MB2091; BCL:0; PCL:0; RULEID:; SRVR:HE1PR0801MB2091; x-forefront-prvs: 06952FC175 x-forefront-antispam-report: SFV:NSPM; SFS:(10009020)(979002)(396003)(376002)(39860400002)(366004)(39380400002)(346002)(40434004)(199004)(189003)(13464003)(53936002)(81166006)(81156014)(8676002)(8936002)(66066001)(6436002)(6916009)(229853002)(6116002)(3846002)(72206003)(74316002)(966005)(86362001)(2900100001)(68736007)(33656002)(14454004)(478600001)(102836004)(105586002)(6506007)(53546011)(59450400001)(186003)(6306002)(9686003)(93886005)(53376002)(2940100002)(26005)(11346002)(7696005)(25786009)(2906002)(76176011)(305945005)(99286004)(6246003)(3280700002)(54906003)(4326008)(55016002)(476003)(446003)(5660300001)(97736004)(3660700001)(316002)(5890100001)(106356001)(5250100002)(7736002)(486006)(969003)(989001)(999001)(1009001)(1019001); DIR:OUT; SFP:1101; SCL:1; SRVR:HE1PR0801MB2091; H:HE1PR0801MB1930.eurprd08.prod.outlook.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; A:1; MX:1; received-spf: None (protection.outlook.com: arm.com does not designate permitted sender hosts) x-microsoft-antispam-message-info: 88xcv0u+9bK9AVJmk0g/+olQzOd4nbE7lb37EM1NriRo12+DvPrJC9DnsZxJhP8aRalxiGzR5F993yZZEvaQ8VVqs5G6QXSZISz5eXeoh6HTDJRbBREfYJEVRs8dpDdqWuKwxEDNa3yoIO9r200mqqCQgSfPC69wViOuKaXUuoZ3YSH0HHJ/9OjzJxMAyRW3 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: 976f149a-5871-4e77-f9be-08d5cb4efaf2 X-OriginatorOrg: arm.com X-MS-Exchange-CrossTenant-Network-Message-Id: 976f149a-5871-4e77-f9be-08d5cb4efaf2 X-MS-Exchange-CrossTenant-originalarrivaltime: 06 Jun 2018 01:44:01.9814 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: f34e5979-57d9-4aaa-ad4d-b122a662184d X-MS-Exchange-Transport-CrossTenantHeadersStamped: HE1PR0801MB2091 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 List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 06 Jun 2018 01:44:05 -0000 -----Original Message----- > Date: Tue, 5 Jun 2018 20:32:39 +0000 > From: Honnappa Nagarahalli > To: "Van Haaren, Harry" , Jerin Jacob=20 > > CC: "dev@dpdk.org" > Subject: RE: [PATCH] doc/event: improve eventdev library documentation >=20 >=20 >=20 > -----Original Message----- > From: Van Haaren, Harry > Sent: Tuesday, June 5, 2018 11:31 AM > To: Jerin Jacob ; Honnappa Nagarahalli=20 > > 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 > > Cc: dev@dpdk.org; Van Haaren, Harry > > Subject: Re: [PATCH] doc/event: improve eventdev library=20 > > documentation > > > > -----Original Message----- > > > Date: Thu, 31 May 2018 15:23:42 -0500 > > > From: Honnappa Nagarahalli > > > To: jerin.jacob@caviumnetworks.com > > > CC: dev@dpdk.org, Honnappa Nagarahalli=20 > > > > > > 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 > > > Reviewed-by: Gavin Hu > > > --- > > > > 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 >=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. Apologies, I see the TX adapter RFC. I will change the text. >=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 @@ > > > > > > > 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 >=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.