From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <john.mcnamara@intel.com> Received: from mga09.intel.com (mga09.intel.com [134.134.136.24]) by dpdk.org (Postfix) with ESMTP id BE47A1B3CD for <dev@dpdk.org>; Mon, 23 Oct 2017 14:19:18 +0200 (CEST) Received: from orsmga004.jf.intel.com ([10.7.209.38]) by orsmga102.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 23 Oct 2017 05:19:16 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.43,422,1503385200"; d="scan'208";a="141226221" Received: from irsmsx110.ger.corp.intel.com ([163.33.3.25]) by orsmga004.jf.intel.com with ESMTP; 23 Oct 2017 05:19:15 -0700 Received: from irsmsx103.ger.corp.intel.com ([169.254.3.49]) by irsmsx110.ger.corp.intel.com ([163.33.3.25]) with mapi id 14.03.0319.002; Mon, 23 Oct 2017 13:19:14 +0100 From: "Mcnamara, John" <john.mcnamara@intel.com> To: "Rao, Nikhil" <nikhil.rao@intel.com>, "jerin.jacob@caviumnetworks.com" <jerin.jacob@caviumnetworks.com> CC: "dev@dpdk.org" <dev@dpdk.org> Thread-Topic: [dpdk-dev] [PATCH v2] doc: add event eth Rx adapter programmer's guide Thread-Index: AQHTR/gQEhyScQ9cjkmDiB+Xfi1L9qLxX/ww Date: Mon, 23 Oct 2017 12:19:14 +0000 Message-ID: <B27915DBBA3421428155699D51E4CFE23EDE131E@IRSMSX103.ger.corp.intel.com> References: <1508318141-11256-1-git-send-email-nikhil.rao@intel.com> <1508320690-12047-1-git-send-email-nikhil.rao@intel.com> In-Reply-To: <1508320690-12047-1-git-send-email-nikhil.rao@intel.com> Accept-Language: en-GB, en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ctpclassification: CTP_IC x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiMzNlZWRlNzgtMzNhMi00NGU1LThhOGUtNDYwYWVhNzFlMDk2IiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX0lDIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE2LjUuOS4zIiwiVHJ1c3RlZExhYmVsSGFzaCI6Im9NU1dcL3NSWWYrak44QWVrTzNwNTVqSWJnQVBIek5WY1pDK1p3TjlFS1lBPSJ9 dlp-product: dlpe-windows dlp-version: 11.0.0.116 dlp-reaction: no-action x-originating-ip: [163.33.239.181] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [PATCH v2] doc: add event eth Rx adapter programmer's 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: <http://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: <http://dpdk.org/ml/listinfo/dev>, <mailto:dev-request@dpdk.org?subject=subscribe> X-List-Received-Date: Mon, 23 Oct 2017 12:19:19 -0000 > -----Original Message----- > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Nikhil Rao > Sent: Wednesday, October 18, 2017 10:58 AM > To: jerin.jacob@caviumnetworks.com > Cc: dev@dpdk.org > Subject: [dpdk-dev] [PATCH v2] doc: add event eth Rx adapter programmer's > guide >=20 > Add programmer's guide doc to explain the use of the Event Ethernet Rx > Adapter library. >=20 > Signed-off-by: Nikhil Rao <nikhil.rao@intel.com> > + > +Event Ethernet Rx Adapter Library > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D > + > +The DPDK Eventdev API allows the application to use an event driven > +programming model for packet processing. In this model, the application > +polls an event device port for receiving events that reference packets > +instead of polling Rx queues of ethdev ports. Packet transfer between > +ethdev and the event device can be supported in hardware or require a > +software thread to receive packets from the ethdev port using ethdev > +poll mode APIs and enqueue these as events to the event device using > +the eventdev API. Both transfer mechanisms may be present on the same > platform depending on the particular combination of the ethdev and the > event device. In general the text in paragraphs should be wrapped at 80 chars:=20 http://dpdk.org/doc/guides/contributing/documentation.html#line-length > + > +For SW based packet transfers from ethdev to eventdev, the the adapter s/the the/the/ > +.. code-block:: c > + > + int err; > + uint8_t dev_id; > + struct rte_event_dev_info dev_info; > + struct rte_event_port_conf rx_p_conf; Code in the docs should be indented with spaces not tabs: http://dpdk.org/doc/guides/contributing/documentation.html#whitespace > + > +Querying Adapter Capabilties > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ s/Capabilties/Capabilities/ Also adjust the underline length to match. > +Adding Rx Queues to the Adapter Instance > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ > + > +Ethdev Rx queues are added to the instance using the > +rte_event_eth_rx_adapter_queue_add() function. Configuration for the Rx > +queue is passed in using a struct rte_event_eth_rx_adapter_queue_conf > +parameter. Event information for packets from this Rx queue is encoded > +in the ''ev'' field of struct rte_event_eth_rx_adapter_queue_conf. The Probably ''ev'' should be in backquotes: ``ev``. Also all function and struct names in the doc should be in backquotes. http://dpdk.org/doc/guides/contributing/documentation.html#code-and-literal= -block-sections Also, could you mark the previous version of this doc as superseded in patc= hwork: http://dpdk.org/dev/patchwork/project/dpdk/list/?submitter=3D&state=3D&q=3D= doc%3A+add+event+eth+Rx+adapter+programmer&archive=3D&delegate=3D Thanks, John