From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga17.intel.com (mga17.intel.com [192.55.52.151]) by dpdk.org (Postfix) with ESMTP id C51875B3E for ; Wed, 25 Apr 2018 14:15:52 +0200 (CEST) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by fmsmga107.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 25 Apr 2018 05:15:49 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.49,326,1520924400"; d="scan'208";a="223222920" Received: from pgsmsx104.gar.corp.intel.com ([10.221.44.91]) by fmsmga005.fm.intel.com with ESMTP; 25 Apr 2018 05:15:48 -0700 Received: from pgsmsx102.gar.corp.intel.com ([169.254.6.245]) by PGSMSX104.gar.corp.intel.com ([169.254.3.13]) with mapi id 14.03.0319.002; Wed, 25 Apr 2018 20:15:47 +0800 From: "Gujjar, Abhinandan S" To: "Kovacevic, Marko" , "jerin.jacob@caviumnetworks.com" , "hemant.agrawal@nxp.com" , "akhil.goyal@nxp.com" , "dev@dpdk.org" CC: "Vangati, Narender" , "Rao, Nikhil" , "Eads, Gage" Thread-Topic: [dpdk-dev] [v2,6/6] doc: add event crypto adapter documentation Thread-Index: AQHT28njgIImIf+jGUWjYwSoubkgsaQQw3mAgAChsqA= Date: Wed, 25 Apr 2018 12:15:47 +0000 Message-ID: <5612CB344B05EE4F95FC5B729939F780706FF364@PGSMSX102.gar.corp.intel.com> References: <1524573807-168522-1-git-send-email-abhinandan.gujjar@intel.com> <1524573807-168522-7-git-send-email-abhinandan.gujjar@intel.com> <6DC05C7C5F25994B81B3F2F214251F66369CF6@IRSMSX104.ger.corp.intel.com> In-Reply-To: <6DC05C7C5F25994B81B3F2F214251F66369CF6@IRSMSX104.ger.corp.intel.com> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: x-ctpclassification: CTP_NT x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiNWEwOWVkMjItZTc0OC00NDc2LWJjYTYtZGRjNmJkZmNiZmFiIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE2LjUuOS4zIiwiVHJ1c3RlZExhYmVsSGFzaCI6IkRBeEIxb0RLd0M2b05MbEJES3AyZ2tkdUFQUGtvSlNpMVpFekduQk0zZ289In0= dlp-product: dlpe-windows dlp-version: 11.0.200.100 dlp-reaction: no-action x-originating-ip: [172.30.20.205] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [v2, 6/6] doc: add event crypto adapter 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, 25 Apr 2018 12:15:54 -0000 Hi Marko, Thanks for reviewing. I will update the below links and also replace tab with 8 spaces for the co= de blocks. Regards Abhinandan > -----Original Message----- > From: Kovacevic, Marko > Sent: Wednesday, April 25, 2018 4:02 PM > To: Gujjar, Abhinandan S ; > jerin.jacob@caviumnetworks.com; hemant.agrawal@nxp.com; > akhil.goyal@nxp.com; dev@dpdk.org > Cc: Vangati, Narender ; Gujjar, Abhinandan S > ; Rao, Nikhil ; Eads, = Gage > > Subject: RE: [dpdk-dev] [v2,6/6] doc: add event crypto adapter documentat= ion >=20 > Few things below. >=20 > > Signed-off-by: Abhinandan Gujjar > > --- > > MAINTAINERS | 7 + > > doc/api/doxy-api-index.md | 1 + > > doc/guides/prog_guide/event_crypto_adapter.rst | 236 > > doc/guides/prog_guide/index.rst | 1 + > > doc/guides/rel_notes/release_18_05.rst | 6 + > > 5 files changed, 251 insertions(+) > > create mode 100644 doc/guides/prog_guide/event_crypto_adapter.rst >=20 > <...> >=20 > > +Event Crypto 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 > > + > > +The DPDK Event device library > > +'`_ >=20 > I'd suggest making a change to the link it looks messy the way it is at t= he > moment can you link the file this way please, >=20 > :doc:`DPDK Event device library ` >=20 >=20 > > +provides event driven programming model with features to schedule > > events. > > +The cryptodev library > > +'`_ >=20 > Same above: :doc:`cryptodev library ` >=20 >=20 > > +provides interface to crypto poll mode drivers which supports > > +different > > crypto operations. > > +The Event Crypto Adapter is one of the event adapter which is > > +intended to bridge between event devices and cryptodev. >=20 > <...> >=20 > > +The ``rte_event_crypto_adapter_create_ext()`` function is passed as 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_crypto_adapter_conf`` structure passed to it. > > + > > +For ENQ-DEQ mode, the event port created by adapter can be retrived >=20 > Spelling retrived / retrieved >=20 > > +using ``rte_event_crypto_adapter_event_port_get()`` API. > > +Application can use this event port to link with event queue on which > > +it enqueue events towards the crypto adapter. >=20 >=20 > <...> >=20 > > + > > +Adding queue pair to the adapter instance > > +----------------------------------------- > > + > > +Cryptodev device id and queue pair are created using cryptodev APIs. > > +Refer '`_. >=20 > Change above: > And maybe instead of just Refer, maybe try "For more information click he= re" > Just a suggestion >=20 > :doc:`here `. >=20 > <...> >=20 > > + > > +Get adapter statistics > > +---------------------- > > + > > +The rte_event_crypto_adapter_stats_get()`` function reports counters >=20 > Missing a `` at the beginning of this function above. >=20 >=20 > > +defined in struct ``rte_event_crypto_adapter_stats``. The received > > +packet and enqueued event counts are a sum of the counts from the > > +eventdev PMD callbacks if the callback is supported, and the counts > > +maintained by the service function, if one exists. >=20 > <...> >=20 > Also try and keep the code blocks with 4 to 8 spaces in some cases there = is a lot > of tabs. > Especially as you have spaces in a few and not others. >=20 > Thanks >=20 > Marko K.