From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <Jerin.JacobKollanukkaran@cavium.com> Received: from NAM03-CO1-obe.outbound.protection.outlook.com (mail-co1nam03on0043.outbound.protection.outlook.com [104.47.40.43]) by dpdk.org (Postfix) with ESMTP id D43C48D88 for <dev@dpdk.org>; Wed, 9 May 2018 04:46:03 +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; bh=PuI1M0cQT62iqyg6dFQqODoOwMqMB5I0Is0iDf8AMRM=; b=Dm13EIHDu7ifC9TjEXNp5EdN66srKKBGNlwRT5qYDVEDg6uaYmhEaH6mcrZr1jxce5es5irvsdxQ4aWO0WI7SjLnJSyWqUsriPpluM0MNA/oGD+HBpnqWQt+RyAnmbdsUEETQiTzotewInnX5JSebsZHUyj07+P3WCklFXY/BM4= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=Jerin.JacobKollanukkaran@cavium.com; Received: from jerin (12.108.191.226) by SN2PR07MB2528.namprd07.prod.outlook.com (2603:10b6:804:7::6) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.735.18; Wed, 9 May 2018 02:45:57 +0000 Date: Wed, 9 May 2018 08:15:50 +0530 From: Jerin Jacob <jerin.jacob@caviumnetworks.com> To: Abhinandan Gujjar <abhinandan.gujjar@intel.com> Cc: hemant.agrawal@nxp.com, akhil.goyal@nxp.com, dev@dpdk.org, narender.vangati@intel.com, nikhil.rao@intel.com, gage.eads@intel.com Message-ID: <20180509024549.GD19502@jerin> References: <1525808764-109595-1-git-send-email-abhinandan.gujjar@intel.com> <1525808764-109595-6-git-send-email-abhinandan.gujjar@intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <1525808764-109595-6-git-send-email-abhinandan.gujjar@intel.com> User-Agent: Mutt/1.9.5 (2018-04-13) X-Originating-IP: [12.108.191.226] X-ClientProxiedBy: CO2PR06CA0074.namprd06.prod.outlook.com (2603:10b6:104:3::32) To SN2PR07MB2528.namprd07.prod.outlook.com (2603:10b6:804:7::6) X-MS-PublicTrafficType: Email X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(7020095)(4652020)(5600026)(4534165)(4627221)(201703031133081)(201702281549075)(2017052603328)(7153060)(7193020); SRVR:SN2PR07MB2528; X-Microsoft-Exchange-Diagnostics: 1; SN2PR07MB2528; 3:R61O/GvlZu30DNperQBzfGR8Tl/5AcZc6BNnlNoMRCupXs7jUg9XZEeVOFpjIpPcSgsJ7wYZHhJcalI1IilevmR9PK9ZrewxSzjkRVSAKNAuwrtAhY+SVMw22llzqMIq52FQ3IXwJt5k9ce29eByMWc9WcMUoF4IcgKjaNhIJfYLhA5gJI11P17gi8Yay9pMnF0p3IGLczX7sfNCOv77FtVTadTWJMPCWU2V4Am2BUchaOzCp4bNKE5lAPkTfO8b; 25:rN6W9MWNzui5PK4wyysFcz4U9xb8dd+vNkTEmUnQ6+Hg8hhPd48gk1SQNlPpR4vS0mHB9NqMDR8IfUK2B/HAP3WQYSQEh9gCsmrVa0oU0qYLoho3xTIa/IGe09FaiqYB0V0AFI7qWfOWtknF+XyRg/MJGIZL4DA2YONqsz0hN0b37gdGXqtASr/zhdGgPw8Z4Jzv6vpaFmFP7pTIYLRcHXpaopassjZUfI08daSL3JOtPFcAXAEtdXTQ8tkrdT9zjekWUgCcKPQ0+dSdNwJRCwUXtBu2JQuqEYnFkaVw0cMZCXzAee7hQk//n7ONTZlGeIHE81SIovQlQ6h8eLqzGg==; 31:3QaVU/nfRIlXJ4zSJsuyPhyMlDweXKM2keJPM02vWUguesTHdCPs55l4NiKvr7/XYhyTZAFZ9rv9P41HYk8ChscwzuDPZjwRm9W/DdEnTTN72L3Nle27LwBzTX+zVDXbHcPmxqWknP1kghoz5W+cpwDK8OTdTyVfdmRt2on0tBe71i1xPMny8+a4q7R6zh7fbu35TiHFCwyNQstb7CnewTiO9lPepnaMwS5JbqqOV/c= X-MS-TrafficTypeDiagnostic: SN2PR07MB2528: X-Microsoft-Exchange-Diagnostics: 1; SN2PR07MB2528; 20:gbMUVRuxlwm4dljNCs3GLerK1RLXZifgRxHR39S3E94eIySsd3ZkXYDUchTaPCUoyqo8+iR6C9iik2T8/YqK0SDBAt7hp6wDKxqe3lfWSRsv5Zdv7ChbqJaVwaTY069QhIWoLpg8t8KHSD9osXgktOrm0CvCH0P+B22642Jbxz4VuPCz6o6LXEorMC999i63HFSlj5ZjWt1ZCeGScy42kPq4s2eC2t1/tonc5+wvSNnXcQVVFbnpM3+3MTwuCnzlJVQRyIXN+vwdTW2O2u/YkuZwYvTl3eGldprUB/4i2AqGwkhHERC+tzKxmRXiZw/isCGG1s8hX4kGQpVNoFekVQSGEDXWqi+PnfAZjtN/FXlNEVBj0QppW9E/Lk6aNqdw6ZZ6B56pWjY8v3wQXIgEu6gZC5Q/Uwt414hZ5MVZXvSVr5hT904SMUESvxr+p42+2J9EJW56qAE487iqnNQvRMk/yR/tCmB866gEa+9q493qv6l6rQiGGzIIIDmKOGELeuYxHhcadcGrol8UN5wRIaHMc/Z4EmbB4cOBaFv90jBdxRa6g2hRwMERuOn9WUQzO/ue4dwMTXxMnFAPL0tBBvMKipI0I/oJnTgl2lyZHL0= X-Microsoft-Antispam-PRVS: <SN2PR07MB25280D824772358495214DBDE3990@SN2PR07MB2528.namprd07.prod.outlook.com> X-Exchange-Antispam-Report-Test: UriScan:(185117386973197)(228905959029699); X-MS-Exchange-SenderADCheck: 1 X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(8211001083)(6040522)(2401047)(8121501046)(5005006)(10201501046)(3002001)(3231254)(944501410)(52105095)(93006095)(149027)(150027)(6041310)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123558120)(20161123562045)(20161123564045)(20161123560045)(6072148)(201708071742011); SRVR:SN2PR07MB2528; BCL:0; PCL:0; RULEID:; SRVR:SN2PR07MB2528; X-Microsoft-Exchange-Diagnostics: 1; SN2PR07MB2528; 4:ZszSufI4UYazUyMzth/2yjl2Nch6jM3kbegroBi26yYFtq1zakiDVK/P5g/9iaR0Epi8HMvEfzgBERMbS7QoTVLKpMMlQrJe4Gg/1FCmZLqUCyhJGdKAj8zWehU4gx/HM7NukkxCgMHW0ahq7+iLhUEP8KWkEPvb1m1NA5WzJvZfXkTIMjSR6Cc6tNEtNO0F9+73y9hpG7fPoqPotkhW1/Z1hktQFeR+ZE7wS2VFzapMDOtN9VTnFVkYpyKx9Q6FqSnUOlQdCdrdTsVzKENj0uOZD9bThVxN07fDPhVSilhWrecCWVgQypjK/HNvwc2AtnSm0tQGaT3X9rRWgdd/8R8VQqhp92mzCsWDs3HPrDc= X-Forefront-PRVS: 0667289FF8 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(39860400002)(376002)(346002)(396003)(366004)(39380400002)(189003)(13464003)(199004)(25786009)(2906002)(23726003)(50466002)(956004)(1076002)(186003)(72206003)(97736004)(47776003)(42882007)(33656002)(486006)(386003)(76176011)(33716001)(44832011)(59450400001)(11346002)(8656006)(478600001)(66066001)(52116002)(16526019)(33896004)(26005)(6496006)(476003)(446003)(8676002)(8936002)(105586002)(5660300001)(58126008)(229853002)(68736007)(6666003)(16586007)(7736002)(81156014)(81166006)(6916009)(6116002)(3846002)(305945005)(4326008)(6246003)(53936002)(9686003)(316002)(55016002)(106356001)(18370500001); DIR:OUT; SFP:1101; SCL:1; SRVR:SN2PR07MB2528; H:jerin; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; MX:1; A:1; Received-SPF: None (protection.outlook.com: cavium.com does not designate permitted sender hosts) X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; SN2PR07MB2528; 23:LoYvZewMSev9aavY7PiRgwXRsMlHTZqvD9GwXm6W9?= =?us-ascii?Q?rBv9zy8otC2ZTuvV0q3WvDDWM3YsSndmS5mNdHQU/JVQS8ParIRUu9DjRVGp?= =?us-ascii?Q?MpQMaZDH+LGP7+L+Sh1bGO2MiRNLWY4GR9/1SZBzy9Oxsud66igx09VO7ado?= =?us-ascii?Q?xZtvNMdjdLLD0B8r32fS/FnBCPxiTYsl6QX2t4IhjLm4xQmGvtMTgZV48lwU?= =?us-ascii?Q?wVMNHSUfT5g0I/e08kGR2FDIWfI36FMYyTPv5mpgJYx8soynwhs4aMYpQs8B?= =?us-ascii?Q?0yLXrI1artzuQk++0QpaHrhMZ93/YAJY60MP/VPd4neV1833hQKCXVscLpZ7?= =?us-ascii?Q?EwtUhFe8Dz/xikq0upoDYqx9sEXhhaACwpu6OKwr8OcRQgEsz1PSQGiVYOdV?= =?us-ascii?Q?gwZcr/JSlbR05+VhWgijpDz2SGj2EayguIDL2q2+L+ag5G05qY3hDbEJ1PpI?= =?us-ascii?Q?kSC+X6wp5DLFyQ8fIAR98Wfs6ww4LE6NfPA/PNQQgmAejM59eO3MO2hDGMBu?= =?us-ascii?Q?OF2of81xTTzuEZKEj59jlY859Gr31LjdG4cBvKLgHE1VaSgAvROxS6t+mjWA?= =?us-ascii?Q?PDZcG5tT+qd2MbDLFzAT7mSXBV48V0tU1tKXaEPE2Hp24+EjILT9IBeBZhp1?= =?us-ascii?Q?eDi/h4xvlrICfGHACAkhKctWjZ2Hyjm2QEiWzcT8tGfMlWHF6vIB17ILYFhQ?= =?us-ascii?Q?YaQLxJmQ34R+h89S/oW9lmZLp95M+LOzyl3G6GArE2x7m5k3lHuAfv5dPkcZ?= =?us-ascii?Q?s+Us9lknj6IpVuekFbRWoFdqbhrP+N5iMm+jW4YCtmsuMUy6GjBRXLj8n5rV?= =?us-ascii?Q?hXyIwCgAdV4BywGWUydKO2WwI3xEkhAw68AFu3rmMloPwclZfAwZMgfb0fr3?= =?us-ascii?Q?wHuWbA0+4ruI8w8LkgCg0J6AHZ0WrO9Ygtez06LA3V4XSwLHlQ6VpctxVXr/?= =?us-ascii?Q?lsCx2hLFNexV97R7tlePjtAHSBpHwNiKWiMBFeK9SPkMeootVIc632oPNXoP?= =?us-ascii?Q?2ne9XH4AHrTo1L5FzwwUXz8iELP7uzNZct1/6VD42SJNWkJLJq/0GY5fLRDJ?= =?us-ascii?Q?0KcuzAzPkLk54+fLnmf57oXtPhXQlhTwPV11SbNg0vsd9+q4hNQURbZ8gwYd?= =?us-ascii?Q?oTxs54xAnXGmOWNa5DX3+fL+yCDli0N5lG8dRpLl5F8rsqMGYh0e2s7d3T0o?= =?us-ascii?Q?tScvKnkHPUIWzZBkNyAcJbfl7Fq+rcQ8dla5+jCx6kLVxcTruN3kEDw7lzxR?= =?us-ascii?Q?LfwNVGDZ+wpQO8NdGZdTxoujBjHB8oWGnpf5TnO4oxNtuHsbH8dZ/1kxfTX8?= =?us-ascii?Q?GXZtDjLLARWYSKXjkAB2J4Y0oyU1prDeBOgSNxpUP9q2nfal0PYAZlr9VNit?= =?us-ascii?Q?Km+b6bM765PDQRrgFFPotcKYyw=3D?= X-Microsoft-Antispam-Message-Info: fue5aEDxctdtt++0Ot2R5J3fTFVIfZxDG6lySs3VvP7r7I6r+rNZkyRhEZDPClm9phyw5UpYgylos0ph8XhiiNUPy7n3iIDuvp0BNJcNvs6G1eGnGaUn8N8NPmDImdvYg2TXsM3p/UaRwQo7Ayk147wiuPZmVXPszP1Dqs5juTWKTMWwvEv1RFR8ZOXhM6El X-Microsoft-Exchange-Diagnostics: 1; SN2PR07MB2528; 6:3+hWAdM9J3tHvdfeSUdOs3AiPR9KJxnPXRB/zQcyVFQvOtts3uapQrKoWFP/h1sQqVd3wCKSyVdGfdM/dCBR+T4s0WJ/8lHQJN8cJ5cf9SZmj+BFTd+/a3jmk2xiFuZKJ5BVEmDcoT6eXequGMcDLzt02rGvqEYS0/WeVVLrbeIyKef57S0aGifu24r+948ekWbEY2CdmXu6kskxjzWDY9q/Kt+N4hSn1iRoa86rtzoTlgNXtIs/c3MTpx2FWx5je0yhoC0BOcJM9WpBmn2ZYEh6/6Rb7jgdluGIFLfK5GyMp5mTC80bBLyi971XuLp0qeFA9hiWlph155M+WcI8TOTWCD0kLSLlXYTFnWk4Fy908p1woIu89/evEz1/PRdy5unMJS/U4c6c6Rp1zJWziuD5jd+SOLiTwtXIhk3qADGkogS7gYcDvHCrcuwNlUx0tEinrLVkWa9w5MWz2B7iqQ==; 5:Gylc0puqxrLlbTISGF83rpLH8mVweoi1f+8+K1q+Ks+a37K5plxwMMLRRzL++kjXLy72OW0ErPzDY1JZE36MLcVQj4DDyV4Gicz9Tl0AxFe8DL1m9GUofApdeXirGTgISqbrCw7niurDhJVelJ3JqPn3f1SkWtqhWrR7cOBH494=; 24:40CSwMLFBzdXdVAyXDpwPck8ryydjSLWccRLTWvSPVoCgXH4TQ9t3xM70orxdybFPDyc2erFJhGylnLFo5B5iseGUmUr9gUYtFnME7U2wsk= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; SN2PR07MB2528; 7:Ii5EF1485U86wDtm1I3acjhGCgbFtGvON/P3rt51iqP/wIbaIiD9O0bJe7+9tJJEg19cwADixTSo78qARBIQhCH3/BGx8onbi62e6mHzUopHrWmkROhV3l569XPSKgcTljWCBhe/lRskT/YgR9AqG50EvNprP82CVXYJuzoLligttHQeUhx6aIZ5bImsnHIsUj2eticwmL0pCKdZaxOLrgISI4JM2WLcZs2IAH8LAVC3dmzyfFbDH9rU2AoPu1Lm X-MS-Office365-Filtering-Correlation-Id: 45e3143a-fa3f-4f2d-0a64-08d5b5570048 X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 09 May 2018 02:45:57.8202 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 45e3143a-fa3f-4f2d-0a64-08d5b5570048 X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 711e4ccf-2e9b-4bcf-a551-4094005b6194 X-MS-Exchange-Transport-CrossTenantHeadersStamped: SN2PR07MB2528 Subject: Re: [dpdk-dev] [v4, 5/5] 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 <dev.dpdk.org> List-Unsubscribe: <https://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: <https://dpdk.org/ml/listinfo/dev>, <mailto:dev-request@dpdk.org?subject=subscribe> X-List-Received-Date: Wed, 09 May 2018 02:46:04 -0000 -----Original Message----- > Date: Wed, 9 May 2018 01:16:04 +0530 > From: Abhinandan Gujjar <abhinandan.gujjar@intel.com> > To: jerin.jacob@caviumnetworks.com, hemant.agrawal@nxp.com, > akhil.goyal@nxp.com, dev@dpdk.org > CC: narender.vangati@intel.com, abhinandan.gujjar@intel.com, > nikhil.rao@intel.com, gage.eads@intel.com > Subject: [v4,5/5] doc: add event crypto adapter documentation > X-Mailer: git-send-email 1.9.1 > > Add entries in the programmer's guide, API index, maintainer's file > and release notes for the event crypto adapter. > > Signed-off-by: Abhinandan Gujjar <abhinandan.gujjar@intel.com> > Acked-by: Jerin Jacob <jerin.jacob@caviumnetworks.com> > --- > MAINTAINERS | 1 + > doc/api/doxy-api-index.md | 1 + > doc/guides/prog_guide/event_crypto_adapter.rst | 290 ++++++ > .../img/event_crypto_adapter_op_forward.svg | 1073 ++++++++++++++++++++ > .../prog_guide/img/event_crypto_adapter_op_new.svg | 968 ++++++++++++++++++ > doc/guides/prog_guide/index.rst | 1 + > doc/guides/rel_notes/release_18_05.rst | 6 + > 7 files changed, 2340 insertions(+) > create mode 100644 doc/guides/prog_guide/event_crypto_adapter.rst > create mode 100644 doc/guides/prog_guide/img/event_crypto_adapter_op_forward.svg > create mode 100644 doc/guides/prog_guide/img/event_crypto_adapter_op_new.svg event_crypto_adapter_op_new.svg diagram is not updated. If you have time then please update the SVG diagram else remove programmer guide for this patch series and submit the documentation patch just after the RC3. Since it is documentation patch, it can be merged after RC3. But I guess, not much time is required to update the diagram. Some suggestion to improve: diff --git a/doc/guides/prog_guide/event_crypto_adapter.rst b/doc/guides/prog_guide/event_crypto_adapter.rst index e1670a6db..008faaef3 100644 --- a/doc/guides/prog_guide/event_crypto_adapter.rst +++ b/doc/guides/prog_guide/event_crypto_adapter.rst @@ -35,7 +35,7 @@ the ingress packet ordering. .. figure:: img/event_crypto_adapter_op_new.* -Working model of RTE_EVENT_CRYPTO_ADAPTER_OP_NEW mode +Working model of ``RTE_EVENT_CRYPTO_ADAPTER_OP_NEW`` mode: In the RTE_EVENT_CRYPTO_ADAPTER_OP_NEW mode, application submits crypto operations directly to crypto device. The adapter then dequeues crypto @@ -47,7 +47,7 @@ enqueues to cryptodev without going through crypto/atomic stage. .. figure:: img/event_crypto_adapter_op_forward.* -Working model of RTE_EVENT_CRYPTO_ADAPTER_OP_FORWARD mode +Working model of ``RTE_EVENT_CRYPTO_ADAPTER_OP_FORWARD`` mode: >