From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from EUR03-VE1-obe.outbound.protection.outlook.com (mail-eopbgr50042.outbound.protection.outlook.com [40.107.5.42]) by dpdk.org (Postfix) with ESMTP id 80DD81BB61 for ; Tue, 5 Jun 2018 22:32:42 +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=b4g0NrkLKIKg6XaoRU7xS4yq+filZ6Chwyfq5KETqwg=; b=V6q7XOT91S0kEeUhjix7f7NuwSBKGXGfMpBuxiv2HF2ZRbpvRsaNpMtxAzKT0vOq0tts1kQVpOLHStcM4eL6YZA14rbTqJ4EcrfNYjDgkBxrEoCsocdUXQF+JrcdqlgRuil1+YnqFAZlN2tk3oexm7USp4XzJAdUIJiKIgfKgyc= Received: from HE1PR0801MB1930.eurprd08.prod.outlook.com (10.168.94.136) by HE1PR0801MB1756.eurprd08.prod.outlook.com (10.168.150.11) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.820.15; Tue, 5 Jun 2018 20:32:39 +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; Tue, 5 Jun 2018 20:32:39 +0000 From: Honnappa Nagarahalli To: "Van Haaren, Harry" , Jerin Jacob CC: "dev@dpdk.org" Thread-Topic: [PATCH] doc/event: improve eventdev library documentation Thread-Index: AQHT+757V4pMJC2byEarJikx5To3wKRR3dKAgABCIRA= Date: Tue, 5 Jun 2018 20:32:39 +0000 Message-ID: References: <1527798222-1873-1-git-send-email-honnappa.nagarahalli@arm.com> <20180604044217.GA2901@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; HE1PR0801MB1756; 7:mBdtz8nlZxV0QBBbP3TgvrVrqamxdZ5WlQcaa0qe0ZA9iq1/ovAL//oBV28GvRaICo9wEJBxFnRYTj2JOAs6uoKx1loqX4tlNFMFbvfD/0cD6Gt99IroFyRji7A0I2hPuabaRhrY4tfbIZsgTGIVYUnbRiO+S9xAEETAGunwXp7J6kgBwzTrgDeZJ7N+zAxUPfMwl2QEwfsXYBM2TwjKjBYiw+Ba6nSC3moFKcXcZp1an8VGhILPu0ejp+uZ+Va3 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:HE1PR0801MB1756; x-ms-traffictypediagnostic: HE1PR0801MB1756: 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)(93006095)(93001095)(10201501046)(3002001)(3231254)(944501410)(52105095)(6055026)(149027)(150027)(6041310)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123560045)(20161123562045)(20161123558120)(20161123564045)(6072148)(201708071742011)(7699016); SRVR:HE1PR0801MB1756; BCL:0; PCL:0; RULEID:; SRVR:HE1PR0801MB1756; x-forefront-prvs: 0694C54398 x-forefront-antispam-report: SFV:NSPM; SFS:(10009020)(39860400002)(366004)(346002)(396003)(376002)(39380400002)(199004)(189003)(13464003)(40434004)(11346002)(53546011)(446003)(102836004)(2900100001)(486006)(26005)(186003)(68736007)(105586002)(6506007)(106356001)(110136005)(4326008)(6246003)(476003)(53936002)(7696005)(9686003)(86362001)(74316002)(76176011)(7736002)(305945005)(59450400001)(99286004)(25786009)(316002)(8676002)(81166006)(81156014)(33656002)(8936002)(55016002)(14454004)(6436002)(66066001)(2906002)(5890100001)(6116002)(229853002)(478600001)(3846002)(97736004)(3660700001)(5250100002)(5660300001)(72206003)(3280700002); DIR:OUT; SFP:1101; SCL:1; SRVR:HE1PR0801MB1756; 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: eGWm9DfxPpwTH8CdXm6a4HyC+GzFf55WnXAfmkESBUnxAFo15vGVDw2/LJg9uw729bid0SDG/bKp6RIZ7iFh6ICVDKt2yBWNgL2287d16K0s6U6tzBxpx1+soJvFX7bHHvECQm9F7kHJQc3Wea9mydh/V4hzGqqRiqW7AT0u2ssUTALVnoMJMhS0tsl9be+/ 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: 0a64344e-9c1e-4309-2402-08d5cb237b75 X-OriginatorOrg: arm.com X-MS-Exchange-CrossTenant-Network-Message-Id: 0a64344e-9c1e-4309-2402-08d5cb237b75 X-MS-Exchange-CrossTenant-originalarrivaltime: 05 Jun 2018 20:32:39.6955 (UTC) X-MS-Exchange-CrossTenant-fromentityheader: Hosted X-MS-Exchange-CrossTenant-id: f34e5979-57d9-4aaa-ad4d-b122a662184d X-MS-Exchange-Transport-CrossTenantHeadersStamped: HE1PR0801MB1756 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: Tue, 05 Jun 2018 20:32:42 -0000 -----Original Message----- From: Van Haaren, Harry Sent: Tuesday, June 5, 2018 11:31 AM To: Jerin Jacob ; Honnappa Nagarahalli Cc: dev@dpdk.org Subject: RE: [PATCH] doc/event: improve eventdev library documentation > 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 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 > > > > 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 > > across code blocks, change the image to represent queues and CPU > > cores intuitively. These help improve the eventdev library > > 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. Thanks Jerin, >> uint16_t nb_rx =3D rte_event_dequeue_burst(dev_id, worker_port_id1, >> events, BATCH_SIZE, timeout); why is the worker port variable named "worker_port_id1"? Previously it was = just worker_port_id. I think just worker_port_id makes more sense, perhaps update the 2 occuranc= es of id1 ? Will change in V2 With that you have my Acked-by: Harry van Haaren > > 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, showing > > how > to > > create and configure an eventdev and use it for a two-stage atomic > pipeline > > -with a single core for TX. The diagram below shows the final state > > of the > > +with one core each for RX and TX. The diagram below shows the final > > +state > of the > > I think, we can mention the usage of RX and TX core are API > illustration purpose only, In the real case, it is abstracted using > Eventdev - Ethdev adapters to hide the difference between various > eventdev capabilities to Rx or Tx the packets. > or something on similar lines. > I think we should leave it as is currently, the code under the section 'Ing= ress of New Events' is tied into RX core. I think the API walk-through sect= ion as a whole has to change to introduce the usage of adaptors. > > > > > > 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 reference= . > > With above changes: Will add in V2 > > Acked-by: Jerin Jacob IMPORTANT NOTICE: The contents of this email and any attachments are confid= ential and may also be privileged. If you are not the intended recipient, p= lease notify the sender immediately and do not disclose the contents to any= other person, use it for any purpose, or store or copy the information in = any medium. Thank you.