From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from NAM02-CY1-obe.outbound.protection.outlook.com (mail-cys01nam02on0064.outbound.protection.outlook.com [104.47.37.64]) by dpdk.org (Postfix) with ESMTP id C6179236 for ; Tue, 7 Nov 2017 08:00:22 +0100 (CET) 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=a8osVzMFkGvBL5jLetO/58VhZRyD0LAdkNjJyRP8WXs=; b=eHSu4Xl4WVy570v2zEzqhON+q0cx5nVnuu4i+m51NWlvXQipOHiFoV7YC7nkZg+TAne8QasQWCh3SJYfRHkkuA9i9oZY0ARbxByU1NT6lwXJeqAqwyR+MlaQVgUAeGHtIS2s4gYXGescLALxs+If/76LjO+EpnNT+AwlYfpqjpM= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=Santosh.Shukla@cavium.com; Received: from santosh-Latitude-5580.caveonetworks.com (50.233.148.156) by BN6PR07MB3089.namprd07.prod.outlook.com (10.172.105.7) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.197.13; Tue, 7 Nov 2017 07:00:15 +0000 From: Santosh Shukla To: dev@dpdk.org Cc: john.mcnamara@intel.com, thomas@monjalon.net, jerin.jacob@caviumnetworks.com, Santosh Shukla Date: Tue, 7 Nov 2017 12:29:33 +0530 Message-Id: <1510037974-1511-3-git-send-email-santosh.shukla@caviumnetworks.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1510037974-1511-1-git-send-email-santosh.shukla@caviumnetworks.com> References: <20171020152124.14746-1-santosh.shukla@caviumnetworks.com> <1510037974-1511-1-git-send-email-santosh.shukla@caviumnetworks.com> MIME-Version: 1.0 Content-Type: text/plain X-Originating-IP: [50.233.148.156] X-ClientProxiedBy: PN1PR0101CA0066.INDPRD01.PROD.OUTLOOK.COM (10.174.150.156) To BN6PR07MB3089.namprd07.prod.outlook.com (10.172.105.7) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: e83e59bd-c209-4721-1283-08d525ad3603 X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(22001)(4534020)(4602075)(4627115)(201703031133081)(201702281549075)(2017052603249); SRVR:BN6PR07MB3089; X-Microsoft-Exchange-Diagnostics: 1; BN6PR07MB3089; 3:b768xQ+8Yi1jBTe2iYozhtwFHBgFqVZ4n+LSqmAyZJD/H4rtTpt2nYqOT0cpPQo+BrPsyhlNJL5UCPWL8r6jPkPXJ7C9vjokNK6BavhZuot2h0VWA4HqAUVjYRBL4tOVs5zMqEYmK4SfPkEDLg9IYQ8b1czLbFG+qs8Fghk3Qy/lbepCZ7tZrf4VN+p5iiGVqd/fbYvkSvitoWfKKp19ziMBXVBlQRoeLahY6RnlAzzIs37gDwaYTEn1jEBPcQMm; 25:9v1YTRD1Ef+w25zjxR3JCIiNL8YeUU+lPvZOvRbJ3UIRzbqBc7TM5csgHvormX+gBMv53Zmi/bjiJa319Uqnw/+XQzaSBcCBGRznzVVAXGN05M0jE6muocbPeJwsMMmEC295jw27aPWHiRhjt7nbp434qLm2YsHKOLb7upIbeg2vY3lxZUQrRiLlHnXztHqEmqqLTgdSuU8WNw1Lz1SrwPfKDBcYOS5cK/R3oSd1v+PczaEk85zfYirMors9k/BpkxPs+qSGlseC8ypqykrGZj2YCsgO7PzPkYD8/RW80MiWACULWuWWLnnRzEHQg7jr4zeDqX3dyt/oNkknAb8TeQ==; 31:NvFQ0r500lrQsUVd0gpP61kWrD53MAqiguA0KO7VGsk6iA+pUzqxtJOUsY6XvCLB3VWsytw/ZCLUWv0En5bz6QDhxZpYLQbEovkTMXOsmDXFM9bHyqkpm7A79ACQPS9slw2XXi9Z1vNbW24L0/r5RQEwh+TvO95g/XJUR+B8ug1G827tuNOuSCP/1yGi6efXhIFRLb5ptthMyzU/s0DOVvM83wAsGlo15u8LIhmmXnU= X-MS-TrafficTypeDiagnostic: BN6PR07MB3089: X-Microsoft-Exchange-Diagnostics: 1; BN6PR07MB3089; 20:2izxYgqkl2DrLU4hyU0rnq5iapJ84fvIgqxO3zKTaVssuX2caw48QKBmACB/b8odFk8TplOP5cBT/Nr2gU5AJWxTZN3wNnjK/2ufaE46e9nWhC8qAlxNjvg5HNoABzbW8j5lG9NgUYB7l+/4f/XeMw7TRwNZHy5RKEDnvkhQTg6T/2znfDmj5qS97ujjCQtgi6fdU6OJiNTMrubBHgu14VzGviM6i6+bd5Ehe5iBEgKhNwUS42XTTr3RvPyViVhwIKhyreV3bIFx8M81tcWv0SELXoJOEsDP+Hhvjk9yFmzZHZoKtQMvuKjLCp7omIPNVITjCnGuyPjDwpRRRdAJsOpSdJmz4zVStSshkh3x9zzu6v+0U58srYxL1dz8pYsHrRngsCnD4QhU6+61fYoN71qf/JhL+17/sR9w810lWbf9aLjw+spACYHfkTosaU0Zg6nT959eW4KF2p2BpKGXuxweFlYWXJMxdx1eYF0TpR8CN2vH8fRbXzwEDz711qAZst/ZcZaCa8YqxDAoSlJ2bdFz+KrdTExj7WOEcuD2oXjfy49D4mRp71SFxjdwF3jaxsgKmPnsc53ndYocxRDgiqqy2tSSuT8W7YY292Qh5mg=; 4:FinZSzbA+Sz8xAvdGGR3UnnA3SCJ6rrPrYAlbHSzxGg/U9r5SPDooTx51jALKx/+Ouo6rdWk5kOFs764i2/oI+Ys2VmX67Kr9opSU8KumVyxxR5rbaX5pskB8NIe1mMlIrsjaW3cBmwdLWS3RaptRSBMmqbCTnBkpo/WOy175PQoQxK46T+eW8ekEQZx0tBE0Z0XEP9aulzf/drsRANLSE3NtgyIGbrBbwfpNABslXy98Mxce7wGDxIaDakaDdR/LBGF+5FhPnSn5jFr1jyvMVV8gZKcgZberHNT5Cf/bp5vir6Aho/zsstPKOxa08Y/ X-Exchange-Antispam-Report-Test: UriScan:(228905959029699); X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(100000700101)(100105000095)(100000701101)(100105300095)(100000702101)(100105100095)(6040450)(2401047)(8121501046)(5005006)(3231021)(100000703101)(100105400095)(10201501046)(3002001)(93006095)(6041248)(20161123564025)(20161123562025)(20161123555025)(20161123560025)(201703131423075)(201702281528075)(201703061421075)(201703061406153)(20161123558100)(6072148)(201708071742011)(100000704101)(100105200095)(100000705101)(100105500095); SRVR:BN6PR07MB3089; BCL:0; PCL:0; RULEID:(100000800101)(100110000095)(100000801101)(100110300095)(100000802101)(100110100095)(100000803101)(100110400095)(100000804101)(100110200095)(100000805101)(100110500095); SRVR:BN6PR07MB3089; X-Forefront-PRVS: 0484063412 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(6009001)(376002)(346002)(199003)(189002)(81166006)(7736002)(6506006)(69596002)(16526018)(5003940100001)(81156014)(316002)(6486002)(33646002)(68736007)(3846002)(66066001)(8676002)(305945005)(36756003)(5660300001)(6116002)(6306002)(6512007)(50986999)(76176999)(53936002)(72206003)(2906002)(53416004)(105586002)(6916009)(2950100002)(42882006)(48376002)(6666003)(47776003)(97736004)(50466002)(189998001)(25786009)(107886003)(50226002)(101416001)(478600001)(4326008)(16586007)(106356001)(8936002)(2361001)(2351001); DIR:OUT; SFP:1101; SCL:1; SRVR:BN6PR07MB3089; H:santosh-Latitude-5580.caveonetworks.com; FPR:; SPF:None; PTR:InfoNoRecords; A:1; MX:1; LANG:en; Received-SPF: None (protection.outlook.com: cavium.com does not designate permitted sender hosts) X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; BN6PR07MB3089; 23:QWq+TYPDsMpKJHNg1t1Y7smPJhDP4gyyPiT/a1hor?= =?us-ascii?Q?RNWRqh29YBe7/o9mXJlek9AyVXhcO3aLhaJDI2H5+xIdjMU77ivSkQJN2Oe6?= =?us-ascii?Q?43edTpkaZIv9yL327ocNDLNnDHZuMikD7Lsuo1mFHmTNi8fT0Galexc6TQip?= =?us-ascii?Q?AG7/pTGAJxXIzpV4GjLcMOvwQCPLlR9NIVBSP2EBRQnDKkj1DVaxIe1NELIs?= =?us-ascii?Q?EOiMM9GShJlDqGE/PerBPyDkJ8JVilCQh69JZEBozxqQEuKUs/DPOQ6/vp0j?= =?us-ascii?Q?+0XaXWrfHlcnC/UETpbou77mfa66wDUCOkKFXpaVnHA+Mu0FBAHaBydE8txN?= =?us-ascii?Q?fUdH5GEKY+kPpDrntTbrJ0gh4zPq/WIOMFLpcheZbrpafUlZ6fc0T+h3J4qp?= =?us-ascii?Q?w9jHVwxYrZCeeyQ88LX8FYkqfSAVM7iqUbFNo9FEddhOpPwJ+PbHGqeZ/PIE?= =?us-ascii?Q?L5qkfycUFfrUjgSmQUyUaRLt2IGOQSHUAemb9pco/eLFfmf36Z57As6OFdsc?= =?us-ascii?Q?yHzDL4IPs7Pb3MDQZclwyKfQ/OzlXt5eyUGt3nlkPr6BZM533ZU2Lrv0lnN8?= =?us-ascii?Q?vrh+gKGYML4WFG3jiN0X7qgFxFFU3tvE2ehe7XHlahQQLB942/5aigGYJlsp?= =?us-ascii?Q?WBlTpUwQjzgNEEycupN1EPZKTC0Wzppqs4B6M6hMWHhWhcyXfB4TguszoZsr?= =?us-ascii?Q?zm9fVlR0ompWHFyrPsZkPNBsyZvGH1F0WrVq78KCtJbolY0QdghudMne2jvp?= =?us-ascii?Q?Wv3cv/aaw0MicnN+l1Y07fu20vEeuvAJ9to5pijy9J7bhyytG6Ya1kELZa5u?= =?us-ascii?Q?TRNIJtSHZW/CIPIhKKMb1q6x6WpAqhEpJc8e22VNWdU4wM9yK8O8A+x/OCCj?= =?us-ascii?Q?61iF/OH9SgvxTcI4gK+i544OGLNaXXwUMwzpf6vJjaDLKrOU7iOfhKaC2Wq3?= =?us-ascii?Q?72g5r3kH4QLlMtP+EmpLvO/tOCloUO+FAPF7F6jf9BRni7S4OX6GrY6k9+Ll?= =?us-ascii?Q?rtjX9MvQ4uB+bcpUb+bz6nY0Embrn2CDSobG6AJ7WaBjkYiI2Xke5rQraYcK?= =?us-ascii?Q?aO3yP0RJ5JeyvKi9VOYYeB1QyJitSP2ViBVZcFUXdJpn8NYdyz7uwdQmWeuI?= =?us-ascii?Q?kka5gqb2NagCxRcuVtpj+Mac2AmwfBMdFLPSNcQcASr5m7VE8huU4P6X65t1?= =?us-ascii?Q?q7DU6v8TRFy9gVXpcvSMtuGsw+QaSUZtNQH?= X-Microsoft-Exchange-Diagnostics: 1; BN6PR07MB3089; 6:PLNb4gMk8UjtsdzFBD/WDL2VsH53/9zfch4nMTUJvFSWvAHYn43L4O4CtGzUaROM1WFQ87oRA+Tm+dZ0JgjzgT47W1XCyYIuFJWWYBZf1GIzbhYOdMhbpW2YKn+xvaKu0hNFmDuhIuNEVQ65ZRW6NfoKScIbFuLFqBNkG9C8hmRYKnJ6iteX9y1KUwWxDhIl9sZit+rreP4XN2ZXwnL4rx7wkxjk366wSrTuGLk/rfMdw63KvnmFkbCmviCxIK5gzd3+uW0R+UA4sLQCzM6LRd+3hyuBWzmCy2l/A6I+TcHe+ulO6+OQ7CVceXkFLQZ8K8E/gwj8tTVLBNMZXfCu7hUUvW2PwWYH2m9U+LPtG+Y=; 5:X3RPfOH1iJTZL3L1ADSlri3MkNyOS/r2cpWknd/cMjnkG6YSEgsYLCDigABp8QUC77F5XiLzJsEOHxVlykM9ccM270MmCsPHVZX+n5M1+LLixVRnzKPkJxYVjMb9h1PFCgQrFvpJXloDhkHxyOY4ip3Rf4IGm/C416fM71dgPuM=; 24:ug0McSTZL7W6QUqorsi0/yeWXXqzdBKhMf62a+7ycMP8vpArMJ/bs7VttRvFc/m7dFwBxx7BPt2l0hxLlbuGa37lKNc3RX7TINJ3udcnsjw=; 7:MQjoenzRMUUV/KZh0zwZfSg8A2oGogS7eXhU6cHumdQOZ0Umwp0HzkWO6mgjnb6OA/LHOWbXxVuJXhsz2biJ6F3k6SQ0jiUblOh1si6fTp1hIGsXdHHT72vFJU2f9InWZcT2HqSn4S0U8COrluEM/uWKJuoDhE1RIwefsa1FecsUJeelmi86JCQPZCsz5Vd0+sWuW4I5OZiANCTp7J/EriMWlEeHqWbnpSdKgcUnp7tuF5x+5P+X9Ab2/2LlGIs+ SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 07 Nov 2017 07:00:15.7910 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: e83e59bd-c209-4721-1283-08d525ad3603 X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 711e4ccf-2e9b-4bcf-a551-4094005b6194 X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN6PR07MB3089 Subject: [dpdk-dev] [PATCH v5 2/3] doc: add mempool and octeontx mempool device 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, 07 Nov 2017 07:00:23 -0000 This commit adds a section to the docs listing the mempool device PMDs available. It then adds the octeontx fpavf mempool PMD to the listed mempool devices. Cc: John McNamara Signed-off-by: Santosh Shukla --- v4 --> v5: * Replaced `Ref :` with `See :doc:` (John) * Renamed section from Platform Device Drivers to Platform Specific Guides doc/guides/index.rst | 1 + doc/guides/mempool/index.rst | 40 +++++++++++++++ doc/guides/mempool/octeontx.rst | 104 +++++++++++++++++++++++++++++++++++++++ doc/guides/platform/octeontx.rst | 4 ++ 4 files changed, 149 insertions(+) create mode 100644 doc/guides/mempool/index.rst create mode 100644 doc/guides/mempool/octeontx.rst diff --git a/doc/guides/index.rst b/doc/guides/index.rst index 91a7ebf..f924a7c 100644 --- a/doc/guides/index.rst +++ b/doc/guides/index.rst @@ -44,6 +44,7 @@ DPDK documentation nics/index cryptodevs/index eventdevs/index + mempool/index platform/index contributing/index rel_notes/index diff --git a/doc/guides/mempool/index.rst b/doc/guides/mempool/index.rst new file mode 100644 index 0000000..b3c8e7f --- /dev/null +++ b/doc/guides/mempool/index.rst @@ -0,0 +1,40 @@ +.. BSD LICENSE + Copyright(c) 2017 Cavium Inc. All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + * Neither the name of Cavium Inc nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +Mempool Device Driver +===================== + +The following are a list of mempool PMDs, which can be used from an +application through the mempool API. + +.. toctree:: + :maxdepth: 2 + :numbered: + + octeontx diff --git a/doc/guides/mempool/octeontx.rst b/doc/guides/mempool/octeontx.rst new file mode 100644 index 0000000..b262c82 --- /dev/null +++ b/doc/guides/mempool/octeontx.rst @@ -0,0 +1,104 @@ +.. BSD LICENSE + Copyright (C) Cavium, Inc. 2017. All rights reserved. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + * Neither the name of Cavium, Inc nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +OCTEONTX FPAVF Mempool Driver +============================= + +The OCTEONTX FPAVF PMD (**librte_mempool_octeontx**) is a mempool +driver for offload mempool device found in **Cavium OCTEONTX** SoC +family. + +More information can be found at `Cavium, Inc Official Website +`_. + +Features +-------- + +Features of the OCTEONTX FPAVF PMD are: + +- 32 SR-IOV Virtual functions +- 32 Pools +- HW mempool manager + +Supported OCTEONTX SoCs +----------------------- + +- CN83xx + +Prerequisites +------------- + +See :doc: `../platform/octeontx.rst` for setup information. + +Pre-Installation Configuration +------------------------------ + +Config File Options +~~~~~~~~~~~~~~~~~~~ + +The following options can be modified in the ``config`` file. +Please note that enabling debugging options may affect system performance. + +- ``CONFIG_RTE_MBUF_DEFAULT_MEMPOOL_OPS`` ( set to ``octeontx_fpavf``) + + Set default mempool ops to octeontx_fpavf. + +- ``CONFIG_RTE_LIBRTE_OCTEONTX_MEMPOOL`` (default ``y``) + + Toggle compilation of the ``librte_mempool_octeontx`` driver. + +- ``CONFIG_RTE_LIBRTE_OCTEONTX_MEMPOOL_DEBUG`` (default ``n``) + + Toggle display of generic debugging messages + +Driver Compilation +~~~~~~~~~~~~~~~~~~ + +To compile the OCTEONTX FPAVF MEMPOOL PMD for Linux arm64 gcc target, run the +following ``make`` command: + +.. code-block:: console + + cd + make config T=arm64-thunderx-linuxapp-gcc test-build + + +Initialization +-------------- + +The octeontx fpavf mempool initialization similar to other mempool +drivers like ring. However user need to pass --base-virtaddr as +command line input to application example test_mempool.c application. + +Example: + +.. code-block:: console + + ./build/app/test -c 0xf --base-virtaddr=0x100000000000 \ + --mbuf-pool-ops-name="octeontx_fpavf" diff --git a/doc/guides/platform/octeontx.rst b/doc/guides/platform/octeontx.rst index 34c0339..fb708ca 100644 --- a/doc/guides/platform/octeontx.rst +++ b/doc/guides/platform/octeontx.rst @@ -45,6 +45,10 @@ Common Offload HW Block Drivers See :doc: `../eventdevs/octeontx.rst` for octeontx ssovf eventdev driver information. +2. **Mempool Driver** + See :doc: `../mempool/octeontx.rst` for octeontx fpavf mempool driver + information. + Steps To Setup Platform ----------------------- -- 2.7.4