From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <Jerin.JacobKollanukkaran@cavium.com>
Received: from NAM04-BN3-obe.outbound.protection.outlook.com
 (mail-eopbgr680078.outbound.protection.outlook.com [40.107.68.78])
 by dpdk.org (Postfix) with ESMTP id 853451ADD3
 for <dev@dpdk.org>; Mon, 17 Sep 2018 15:56:27 +0200 (CEST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=CAVIUMNETWORKS.onmicrosoft.com; s=selector1-cavium-com;
 h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck;
 bh=10qVEvJ3ktcJr9oey12OaoaKXzrMf+LaSg0ZfUtUbBk=;
 b=IBok1mRRT91fOF3vJStCPX+wpl6ZsMG4Ldwfhy1fVddqU3uEucezVLXpWFasZ9E08I2SVPwTGVHbazFye3+Ow3KDnAaWSALdkC6uDm8w1bUVQZX2bJcx2ZJGAUAq01VIcSDOmjVwpzcTISYcs72kukM/FV3BXgq6haqhGaSLr7s=
Authentication-Results: spf=none (sender IP is )
 smtp.mailfrom=Jerin.JacobKollanukkaran@cavium.com; 
Received: from jerin (115.113.156.3) by
 DM6PR07MB5004.namprd07.prod.outlook.com (2603:10b6:5:25::25) with Microsoft
 SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id
 15.20.1143.15; Mon, 17 Sep 2018 13:56:24 +0000
Date: Mon, 17 Sep 2018 19:26:10 +0530
From: Jerin Jacob <jerin.jacob@caviumnetworks.com>
To: Nikhil Rao <nikhil.rao@intel.com>
Cc: olivier.matz@6wind.com, dev@dpdk.org, marko.kovacevic@intel.com,
 john.mcnamara@intel.com
Message-ID: <20180917135609.GA9150@jerin>
References: <1534479652-80182-1-git-send-email-nikhil.rao@intel.com>
 <1535694069-88757-1-git-send-email-nikhil.rao@intel.com>
 <1535694069-88757-5-git-send-email-nikhil.rao@intel.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Content-Disposition: inline
In-Reply-To: <1535694069-88757-5-git-send-email-nikhil.rao@intel.com>
User-Agent: Mutt/1.10.1 (2018-07-13)
X-Originating-IP: [115.113.156.3]
X-ClientProxiedBy: BM1PR0101CA0027.INDPRD01.PROD.OUTLOOK.COM
 (2603:1096:b00:1a::13) To DM6PR07MB5004.namprd07.prod.outlook.com
 (2603:10b6:5:25::25)
X-MS-PublicTrafficType: Email
X-MS-Office365-Filtering-Correlation-Id: 7dab98bb-5d71-4e7d-c908-08d61ca55c4e
X-Microsoft-Antispam: BCL:0; PCL:0;
 RULEID:(7020095)(4652040)(8989137)(4534165)(7168020)(4627221)(201703031133081)(201702281549075)(8990107)(5600074)(711020)(2017052603328)(7153060)(7193020);
 SRVR:DM6PR07MB5004; 
X-Microsoft-Exchange-Diagnostics: 1; DM6PR07MB5004;
 3:EnaESfa/SACzAjDB1nsqhZX1H5PW7p1xwgZF4DhxpmmfhJ0YWEfKFqcdX8lvJFHgkysbVscT7mLytCT7y3YcytIEh3kEAI3pTZr/uZ7Im3AFq4mh0RXtu9pmxTorbRBmT/O7jt0orprQQFQqd8MEwI94XQoqTONitlZWnE6ksvXgsgORj5NLQOC4Yj+PsyOwP4bV8MmAWbOk2yRh+tj2itT9vJhY3674wkZptci039hZ+Hl/z4BNNEou+svhwUdZ;
 25:nk6z+ubRaKul9k8TSX02fZpskw7xqm+1xRgwoRKi526LPBkQbPZ+lA1L9Ye4AUfRe6VZZ6jjFZ0d6dRVzMiCXWayordaONq4ZtM8Ejp4haYHpKhxrBEONLc8XbOLVd5UnaNI89RQulPCLvVx8GdnXj0igPvzq8a+Jn60nyTT/v6Bp/9CjmGagTV1FfOrjKEU+2OxyZ6+zbkAYcdr3nvlcXwy/CzMgI6YrsRcHDqFnDdjKjZKej5kIeW7iDza4Vwa8dCkCpM3k6GJU0gi5aKOXl5X8G55EO+MzjGaFCzl8GZGSEFHt2btGSpWHKPLPF7vg8JBQarpf4pdT/FARAeEGA==;
 31:HY5uTap16dF1etGnDABRpO7GGbOdgGex43AZeR8MrWXd/Hv5MwK/7+iRQKonf5XEYEedOoYsPgdAY4CEF2C+UbAXGq6rLcjUKPp1kaDgPG9vi8pVjh3f9AKg9qbh8RWA8qI+O56rjUmjBvuk1jg0oReir+Y9uIzDP4eQSv5GeU6svQZ1PXPqUphkx7P7Z5W66iluLiWeA37S9oscbHZ5icqyo8XBVNRkOQaT06QlDIU=
X-MS-TrafficTypeDiagnostic: DM6PR07MB5004:
X-Microsoft-Exchange-Diagnostics: 1; DM6PR07MB5004;
 20:+X5UBbjLU4/JoAqvATilj7LitjNpo573itUIIssbMv4QRAG77FqVKq2jXr0JDkTWBt7VOy9ZqEIw2t02speVkrUdANTigsPrOklj2cqcqy4GuPzSF60didjHPF/erLPWNxo51khwwiIjttXEI2eaAarLFutd9UBZnLYYE9vDjThM7b6J7NkM2S0xoeMCDXendGrlnWGQPudHthSQWSuQfaljfYgUsxmQmJSz4ktLC0gAW3CEWWRDTiF9jjqbr1pJvGT3xCnpXvSFyLuibQK+KVoVn+1ARuAJXpSGWPAYVDGMKkmvtRAExU8/mCg5t9UfUG876b37vOA0ded5OyxqFTtaSJOxDAZGem4EVJZ4dLN/p9gM5bUMlgHhuOrxHmA4v2Iw/d9FTtBYZcHvy5thqMEYjO7t2xkuc11icGlLJRKK45h6Vhz+Y6MYJVAPf3ufZu36YL+XpGB+lMhOLpK2Vsf+ZgXIfAtLfcGjbY1sZb3ufmip7hmGULLoGc9SYFopF2St+WTTQa+I/01swaYtoithvL8GB3uD6YaU0Lq5SgdMovcfBOw3F5Y0DxUxpqJsO+OguR5nuxpz6dznlD9BSHpKP5Shvgnjr7x6/eu8pI4=;
 4:cPDifpSCyF2H4zZGh+XNEZKzp1lQ8nHvHm1EYDhc4KJzGmdKJ8TK2ICOF/uqyb+iOKvE+zZ1vlpGGccpk5uGBDbSup62L1kdn3WKQMT4yfp6aHQ+rkb/BpYMhuKS/EDvtmK+ov9ruq6IZ8Ditr+rDu0AO6aIxcOKQi5vQdQJbeY4EHkoEFdtVnwhSjxqQ8VIfkM6dTiXyQ7ogUlHLH3vI0ol6OIVJZNVDeA3pS0YRNxy4OslqhR6HGrdmoWF6pXZuZiiL6St3/gQjgqMJk13fy0D9gh6EKKkbZ13pE7P267UxhhS2zRn2ky0Pfyv2x6n
X-Microsoft-Antispam-PRVS: <DM6PR07MB5004D2FCD15E0DCD04147A82E31E0@DM6PR07MB5004.namprd07.prod.outlook.com>
X-Exchange-Antispam-Report-Test: UriScan:(228905959029699);
X-MS-Exchange-SenderADCheck: 1
X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0;
 RULEID:(8211001083)(6040522)(2401047)(5005006)(8121501046)(3231355)(944501410)(52105095)(93006095)(10201501046)(3002001)(149027)(150027)(6041310)(20161123558120)(20161123564045)(20161123560045)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123562045)(201708071742011)(7699050);
 SRVR:DM6PR07MB5004; BCL:0; PCL:0; RULEID:; SRVR:DM6PR07MB5004; 
X-Forefront-PRVS: 0798146F16
X-Forefront-Antispam-Report: SFV:NSPM;
 SFS:(10009020)(396003)(346002)(376002)(39850400004)(136003)(366004)(199004)(189003)(13464003)(26005)(106356001)(25786009)(44832011)(42882007)(50466002)(229853002)(305945005)(55016002)(4326008)(9686003)(316002)(6496006)(66066001)(5660300001)(72206003)(76176011)(52116002)(33896004)(6246003)(58126008)(47776003)(11346002)(446003)(476003)(956004)(105586002)(486006)(16586007)(186003)(16526019)(81156014)(81166006)(6116002)(33656002)(3846002)(7736002)(478600001)(8936002)(33716001)(1076002)(2906002)(68736007)(6666003)(8676002)(6916009)(97736004)(53936002)(55236004)(386003)(23726003)(18370500001);
 DIR:OUT; SFP:1101; SCL:1; SRVR:DM6PR07MB5004; H:jerin; FPR:; SPF:None; LANG:en;
 PTR:InfoNoRecords; A:1; MX:1; 
Received-SPF: None (protection.outlook.com: cavium.com does not designate
 permitted sender hosts)
X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; DM6PR07MB5004;
 23:C/innbtfeSjCCUtEXZnsYVvckFwaDSRXX2VMl+boH?=
 =?us-ascii?Q?U8uowS9JpjzXeikvSBKcLe6PWIwAkxniV6iUY8I6/c/+jcM1qKslLl1rW40Y?=
 =?us-ascii?Q?8px2x7+etNm7aA4HMhyb+b/TGhs8bX8YvcwG7DhPagj3Szwm7PL2vFr8t6hw?=
 =?us-ascii?Q?PtxQuKSo0MFJYze5GHEz60hKFL2L1Kr6Jglz1bAbbZEqVmEnD+fMY0nnAA+7?=
 =?us-ascii?Q?Zy5oUdRp4ChtTjWf49+PjOG3DcX3jpeMUBwbmcQHXWndcEpl8tba8EYllAs+?=
 =?us-ascii?Q?BOf56hfdRnbxgb1UISVPwNeaJbge40WM3gGdrgbtqRf+YKrjc7CnEK0bmFk2?=
 =?us-ascii?Q?+WAz0cMYbdK5zfSprFBm+YJGoV8nwCHjZFFZyZakdBIKX9PWwZJpF8ejx8TM?=
 =?us-ascii?Q?8u5m7o5E8ExR7vKh6PuWIFbyse1HtFiF6UW3yxcHpXHOhsAHPAz6WzQehurP?=
 =?us-ascii?Q?prSpSjaihYEJ7AiV/JnipUo9Q+JbzeYePTtXouWExswJrK17/KrVUQKAnnaS?=
 =?us-ascii?Q?V5uqRCqG4zOqnVx8vhC4a8xgp6fJFzHilPFE+kn3av//aANQvUdRGnJWTiki?=
 =?us-ascii?Q?EHSudXy/Bb3BAAXgi0APJ9CepYiOWOL7YfRo11OgPea4PswhcChaNYToydFi?=
 =?us-ascii?Q?Kwn/6OvdIwy3M6PxvQzB1gH4FAntAOd9Cz6NEQwbNj+UetBkTfieywId/icM?=
 =?us-ascii?Q?2qGpTHqUoYPt9a7871Bu4LiogmMJ/NyLDo9ynvoOLhG1OVa5O/j93TbjB4EV?=
 =?us-ascii?Q?uHPZqq7ffUfy4lvJowBUlrK7qs1KV3k58m32FClZ520H5vnFLu3+N7z69SWT?=
 =?us-ascii?Q?fdsixEkokGBW4l75kNOH+DF88a+nAiQG+u+Eq6le9kUVOPK0sXGZqOM6V0TK?=
 =?us-ascii?Q?gkc0lw095fz8mtKot50EbodI7oPWdBVm8UZtF40+/OjLaGKYrJkWrk199MRO?=
 =?us-ascii?Q?IT99QXETyv/LIwQgdxUiu9skN2iZersImiiXz3KTfW3TM6xRCtUWKcJn1AJl?=
 =?us-ascii?Q?3mM/D5tlcpRLimNXdw9AcTdgg1czVh8i08OoT6F0cEqDhPcd9MnCoe/iVm/f?=
 =?us-ascii?Q?tL5nhkGVRrh4stk3b2IiGGuudOUPd/HI3WZ/CWJgfB8uRxwl432Jm+UbYfiY?=
 =?us-ascii?Q?EvPIbd+lNGrMejmjZ3+REGQm8JCDauTSqI0R3kxLBXvv5wcW+Wmc9py4rJW7?=
 =?us-ascii?Q?R6gRObWcqGi6ngUBsIPEedqtZ6ARDKLddjLDn7Np3Y5O8kKEKmFDknUOHkJv?=
 =?us-ascii?Q?z/zQvsQWNgTgVcw/+mTChh3Ne1KV5MPxdQNtuJ7yRM/AszSGFwy4kDf8IgqX?=
 =?us-ascii?Q?Aptd9hdRjM0gwd/MHdQrbw7TVT/yBm21WmOG6mTzLkK?=
X-Microsoft-Antispam-Message-Info: pwBILrxzPdi1m37yb4jUiMukl/uIkkKxOrJRinbuf9THRWxy5uinRFHBOb+qt4bMP87IWRWptZjyZNqpejWADkSmgIg1V773SPT/agSRze0gUS/ix/wt7r2RNHqtDQAmtgd8uX32pmSrCAaiTbgu8+c5crXSN8zwa62ICREBuPivY/QxnTHddWBx0qdEUUKDCmV7791uA8PPB+fmGRjaJOf5TzyYUX8uAWPXM/s8K8GIMjkxqI5se+N1M1qeuJ2DRsLg2TG6F0d75LEFNpHX36sMN0P6+ouatdvuQJJlmKhaty0bP5+eIjOv+dMslFG3P9hpwqUMQYdI6sLGcWumB0f83gaGueR1S3CSWp+HOBs=
X-Microsoft-Exchange-Diagnostics: 1; DM6PR07MB5004;
 6:4ZnVEWft4wRJ1ooI4+eNWRYaneKhgbxQSzA9Zmpf1bIzNROTjzuY82pcF8WyUVN1QRgKdgsEkmJVwq3PlMe+4ImH+NBESa1jRZHjM+CtSebFNaLQwl19oNDJAqGjyohgijO/Prf45t+X751PO7oUx4sZN54GKpqrofz3ZKl3aab9p67Nhju77ZPA748p1rXq6r6zNPh0HN+mETibL/0V3CLegDftA87oPH9YaftWmwzzYfxjzSxYaTlIABj6EvQded1GucB0eMPgNDZ3dmy52UuK7Ef1FBLpRjL6Y+xY0GLyASlc1s62FXZFJi11hwXXaBlLyr8o6K5bt0q+WQki2LySxaRjazPZKvVOkNwo+yZZPHkV/pPTtdyaowVxNjBfw34FG6RiMhqqQtJX9FYfNsR4gu0HxsE38nQYg1tWzJqxBUudQSdFGAsq2D6xCCrD7clME7LWPZwVGQhWs2ZDTg==;
 5:tT8dd0+nWXO+g0n5lCr+D1nE6AoAl2nANJOh/cfVJfqZ7YhNr38P2nlRTi6fM8wbgH93rR2enTw3QLdK0jEBdD4tHBLXfPhCIp211ZyFGRm0x7kFvGt/mfxX9u9CapbUneTwq09mky+MrAlduqawb/pDftjiTuCnNUVfXEkxqL8=;
 7:ma9JCuQ+IVU1SHODlTn1tW/CKCjaznyNaiZJWSOeyZY09fXlXOe00T+g0h8KCYa/IJN1B4bP8XkhEGb27DrC0TFkizu6yVrj2asHbaiXnkEKqaGIQM1foyw1xD5BHCS7xRmLwpSB58jHYw+NOQWC4ohK5pWVkiojjEK6kwJ/ymEFkA/AktQKft5JIbTtGsa6NPcBPBjoKDCqapHwCBhi3wXLxEg9v1RRqJRc185FcL2zOYig2PMyaLZ9SU3sYJTo
SpamDiagnosticOutput: 1:99
SpamDiagnosticMetadata: NSPM
X-OriginatorOrg: caviumnetworks.com
X-MS-Exchange-CrossTenant-OriginalArrivalTime: 17 Sep 2018 13:56:24.0856 (UTC)
X-MS-Exchange-CrossTenant-Network-Message-Id: 7dab98bb-5d71-4e7d-c908-08d61ca55c4e
X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted
X-MS-Exchange-CrossTenant-Id: 711e4ccf-2e9b-4bcf-a551-4094005b6194
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM6PR07MB5004
Subject: Re: [dpdk-dev] [PATCH v3 5/5] doc: add event eth Tx adapter guide
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, 17 Sep 2018 13:56:28 -0000

-----Original Message-----
> Date: Fri, 31 Aug 2018 11:11:09 +0530
> From: Nikhil Rao <nikhil.rao@intel.com>
> To: jerin.jacob@caviumnetworks.com, olivier.matz@6wind.com
> CC: dev@dpdk.org, Nikhil Rao <nikhil.rao@intel.com>
> Subject: [PATCH v3 5/5] doc: add event eth Tx adapter guide
> X-Mailer: git-send-email 1.8.3.1
> 
> 
> Add programmer's guide doc to explain the use of the
> Event Ethernet Tx Adapter library.
> 
> Signed-off-by: Nikhil Rao <nikhil.rao@intel.com>
> ---

+ john.mcnamara@intel.com, marko.kovacevic@intel.com

> +++ b/doc/guides/prog_guide/event_ethernet_tx_adapter.rst
> @@ -0,0 +1,165 @@
> +..  SPDX-License-Identifier: BSD-3-Clause
> +    Copyright(c) 2017 Intel Corporation.
> +
> +
> +Creating an Adapter Instance
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +An adapter instance is created using ``rte_event_eth_tx_adapter_create()``. This
> +function is passed the event device to be associated with the adapter and port
> +configuration for the adapter to setup an event port if the adapter needs to use
> +a service function.
> +
> +If the application desires to have finer control of eventdev port configuration,
> +it can use the ``rte_event_eth_tx_adapter_create_ext()`` function. The
> +``rte_event_eth_tx_adapter_create_ext()`` function is passed a callback function.
> +The callback function is invoked if the adapter needs to use a service function
> +and needs to create an event port for it. The callback is expected to fill the
> +``struct rte_event_eth_tx_adapter_confi`` structure passed to it.

s/rte_event_eth_tx_adapter_confi/rte_event_eth_tx_adapter_conf/

> +
> +.. code-block:: c
> +
> +        struct rte_event_dev_info dev_info;
> +        struct rte_event_port_conf tx_p_conf = {0};
> +
> +        err = rte_event_dev_info_get(id, &dev_info);
> +
> +        tx_p_conf.new_event_threshold = dev_info.max_num_events;
> +        tx_p_conf.dequeue_depth = dev_info.max_event_port_dequeue_depth;
> +        tx_p_conf.enqueue_depth = dev_info.max_event_port_enqueue_depth;
> +
> +        err = rte_event_eth_tx_adapter_create(id, dev_id, &tx_p_conf);
> +
> +
> +Querying Adapter Capabilities
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +The ``rte_event_eth_tx_adapter_caps_get()`` function allows
> +the application to query the adapter capabilities for an eventdev and ethdev
> +combination. Currently, the only capability flag defined is
> +``RTE_EVENT_ETH_TX_ADAPTER_CAP_INTERNAL_PORT``, the application can
> +query this flag to determine if a service function is associated with the
> +adapter and retrieve its service identifier using the
> +``rte_event_eth_tx_adapter_service_id_get()`` API.
> +
> +
> +.. code-block:: c
> +
> +        int err = rte_event_eth_tx_adapter_caps_get(dev_id, eth_dev_id, &cap);
> +
> +        if (cap & RTE_EVENT_ETH_TX_ADAPTER_CAP_INTERNAL_PORT)


Shouldn't it be, if (!(cap & RTE_EVENT_ETH_TX_ADAPTER_CAP_INTERNAL_PORT))
ie. rte_event_eth_tx_adapter_service_id_get valid only when cap is
!RTE_EVENT_ETH_TX_ADAPTER_CAP_INTERNAL_PORT

> +                err = rte_event_eth_tx_adapter_service_id_get(id, &service_id);
> +
> +
> +Enqueueing Packets to the Adapter

s/Enqueueing/Enqueuing ??

> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +

With above change it looks good to me.

Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com>