From patchwork Fri Oct 20 15:21:23 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Santosh Shukla X-Patchwork-Id: 30648 Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id C36141B280; Fri, 20 Oct 2017 17:22:29 +0200 (CEST) Received: from NAM02-CY1-obe.outbound.protection.outlook.com (mail-cys01nam02on0087.outbound.protection.outlook.com [104.47.37.87]) by dpdk.org (Postfix) with ESMTP id 51C631B269 for ; Fri, 20 Oct 2017 17:22:22 +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=/aKfebhrqg2KQkdhMsCbIcZF1mVOZ3BMs5E2YAnfIrY=; b=bZn4gVY+VpgaUEfRd1KaLvV6wg5Tz+p60EsTDwHRNathppAo2+wbhEWv5rqmx37Rc0ZXw2plaWCjusRLfxTL/zX/q7EMXYqNrWafSNm/dTh0wQiqmy9+5P/6N3LNkzOHDtCjC36Qu1oH4sai9qpWY06wrdhN14TE1uGXo53Ul2o= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=Santosh.Shukla@cavium.com; Received: from localhost.localdomain (14.140.2.178) by DM5PR07MB3098.namprd07.prod.outlook.com (10.172.85.8) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.156.4; Fri, 20 Oct 2017 15:22:18 +0000 From: Santosh Shukla To: dev@dpdk.org Cc: thomas@monjalon.net, jerin.jacob@caviumnetworks.com, john.mcnamara@intel.com, Santosh Shukla Date: Fri, 20 Oct 2017 20:51:23 +0530 Message-Id: <20171020152124.14746-3-santosh.shukla@caviumnetworks.com> X-Mailer: git-send-email 2.14.1 In-Reply-To: <20171020152124.14746-1-santosh.shukla@caviumnetworks.com> References: <20171008124011.1577-11-santosh.shukla@caviumnetworks.com> <20171020152124.14746-1-santosh.shukla@caviumnetworks.com> MIME-Version: 1.0 X-Originating-IP: [14.140.2.178] X-ClientProxiedBy: MA1PR0101CA0035.INDPRD01.PROD.OUTLOOK.COM (52.134.137.21) To DM5PR07MB3098.namprd07.prod.outlook.com (10.172.85.8) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: cd8e0f37-9bd5-4eb8-adbf-08d517ce5b6c X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(22001)(4534020)(4602075)(4627075)(201703031133081)(201702281549075)(2017052603199); SRVR:DM5PR07MB3098; X-Microsoft-Exchange-Diagnostics: 1; DM5PR07MB3098; 3:cHLZdiN8kOIZD9deFR5l+mspwAGMAMKdk//CNs+PMtu+V1yYoOmUybZFLKe9zs4J5Mg3BO8IERGSl9IpR+3gkzuTgiZsbRpzuwdqNizzN+6nNmUGzBnOlDPm/0hEaODEh+3imB8Vey16DE/G3g9pKkslLpIfgb+rx/9PRFyleh+ZnUiYjXHVKhEYWvAwEjnM/ey55ixxsGUAssc4rN3DRuFa6bNrvTB0dLPGdoYanxinqxCcfwdaDIGImdb29Hgj; 25:eAO/ED0eH3cyxKMUpoyrlfXPkfLE40ECvxlgzKEfjaf1rRMXlD4W3aJK/e7XjbYoSoKe2kQo9BkR1xamq6VNPnCRKmp+JtL1/BM0apNR7pvNlTjjPlf2rP9DCScg81K+6KouPGveXPLRIIy4slja9ihY/BT57ehnLNKAgxPp1S0oW6xoqHKOjxP68FfSuAJdFWuZNn5i9ENPGzNg+/LMlSCVXRkqJjR8JwBxnoY66GWqTJrRdQaB9UWzhlcQjlEPDBroCE5DAyPqtjNaYvqjVdaTrtiAfvdwXqQyg+el5ySx0/os44Bdx8xD3AUUsNpWAT9mYzsqzTzSswxr9f3EDw==; 31:MY2+ivmiAxD0glCOc858/85THCXDRUuERGII7EUGCWIft5oPkYH7l3Ti0raoPuS4C1vN3uNDFspfLTMD4cvMpYN6uhIuzrKe6M2L3At0mKBUjynazZ33A6rPOkM+7nDwsaMAXCgPXjAACoTeiwECFOEt7Hi91bsD30oCC7GJpj4AizybzFi3cgS6TQ3EziZm5NBh5NCCH9Uuz/XSyurTO/8O9j2EUBrBQH15RfzH/dk= X-MS-TrafficTypeDiagnostic: DM5PR07MB3098: X-Microsoft-Exchange-Diagnostics: 1; DM5PR07MB3098; 20:0w0VQebGv5uWdGmGzeTNMDRJoAHBV8kVY//snl7ZQj4u78Uabxlat3tAZ/HCaDs8C/dw4rrboHvS4qv95uBn3MzcwQHMBylzKWCtmh7y+j9SLsYYxtMvvb5XH5yVRhb4kd0VRSp76ylq/jGoLFh40k+R82RAHNYEzkTNsZC45ggwXnixpG2/SBYuhkzmq+mD3PgRxL8y9z27a6IrcAu0P4xFxc0ya0VmqmW9TvGHumeRwXW0OqZ9HvPeW0VP3V9qNlu+nQuKuGdAraR1SHoOl3ACQRF68zOpy14ZpHUfHFjmKHFFbTa/jLUK7nFogHhxHcbZNyH9R6uJoSFvj3F6+4Y1JxVJmRtKbjQCFW0+eQzH6z0mjguI78Jh5ls6JaKLIzxlTHIRpuNgXpzC+knSIg4xA7Oe57fZvAp0lgzwdOPajKNK24dSTkivoOfMVlsLn3UIWUCcfjiwWsdTynWbic0VnTfi4JJ02vkjiuhfKV1LFCo7H3adh3TIpNmoeTjFWy+9v40GFmBGR6dj9gP06RTcdIlyGe0Sx36YzbnetgRqHs/2vP63HqgDjNDVFaZ6vwtznSnchTPKPxfmXt7wI+T2HXgKCegN944DUtAv9dw=; 4:TsdbOvZZwypjWNrqPGNU+jJjPywVjNFwjgUn9VOdO5nkfJZOABZNohrNWfdmS3pwLoEZWb8+fhHNJGpDaa2rEO4gYvqUYZPjw50a7lASH/N/bWXUAh1y3lvD3Kn5xJyB0QP2d/zzD22WHeKyBF48vtYZKx0/AfzTbTeWpgEhSZFoJJn1Dh+iVjB43L4vlzZNQwctVWKpJwFoKNyBfGtEoKNF6TIvC+1HRIQKvxYISFLLF1F1qdLl4Pgnrlzh/3hXdO4istrRpwycmvv7UmYqEBrqoff0+JwCDn32ZTxR6Qk= 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)(5005006)(8121501046)(3002001)(93006095)(10201501046)(3231020)(100000703101)(100105400095)(6041248)(20161123562025)(20161123558100)(201703131423075)(201702281528075)(201703061421075)(201703061406153)(20161123560025)(20161123564025)(20161123555025)(6072148)(201708071742011)(100000704101)(100105200095)(100000705101)(100105500095); SRVR:DM5PR07MB3098; BCL:0; PCL:0; RULEID:(100000800101)(100110000095)(100000801101)(100110300095)(100000802101)(100110100095)(100000803101)(100110400095)(100000804101)(100110200095)(100000805101)(100110500095); SRVR:DM5PR07MB3098; X-Forefront-PRVS: 0466CA5A45 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(6009001)(6069001)(346002)(376002)(199003)(189002)(2906002)(6486002)(42882006)(189998001)(8676002)(6506006)(81166006)(25786009)(4326008)(72206003)(7736002)(5003940100001)(107886003)(8936002)(97736004)(305945005)(81156014)(50466002)(16526018)(2950100002)(6916009)(48376002)(68736007)(50226002)(101416001)(106356001)(16586007)(3846002)(105586002)(5660300001)(2351001)(1076002)(6512007)(2361001)(66066001)(76176999)(6116002)(33646002)(47776003)(6666003)(5009440100003)(36756003)(316002)(50986999)(6306002)(478600001)(53936002)(110426004); DIR:OUT; SFP:1101; SCL:1; SRVR:DM5PR07MB3098; H:localhost.localdomain; 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; DM5PR07MB3098; 23:qGnvL2bXHJWx365zUrgvXG+dnA/TfXU5oz/k93tDT?= cw60COw0Qq7ypjJInhLjuBJ9yl9LalokBbUnLLDJUa1T6o+DlTItiFly4TpLhm7D2KAwqZRhNQ3FQIaai0si5X2Ba2/L+73p2hhKJhN3qSHfBFs6OwtwHFdsaGTNIcmYWvTjetOxq/+P23eEDJdOLju2mCi/MJ9ICVMzABijwIQa5J/sBnEIIk8uJTXFjAqKQ7t+/W5VbdISQdNogVxv1E4e63cgpklMrAT/rujdJaRv5BDUqZUyXkcdS+7Jj6moFa8lt8JzeWRGMPyH+7BrdUyGt3I7aiCtFIRZXHYVxx34CRQN87QwOQ1dI0k8hnlQaTvIrJONtU0gw2TZDEFjKqk/Ea6ftOOXTh00evetpBvQqiLiPnkA4njKkmvE42RGHIa+tFKTyxWepccKQpb8VyIOBD1Y5ohMnAUvxiO8Y/2owD47rE5hSiKLAvvBKBeRmVKQW6zw5D9zAU/SqJFuKn7b8E7YbRTl5Np926FbRet0PUTKOQzrPqIYKf69Zono8KoKHsN5WTVLHWPdxPeW/ZhraZqK+sBWLGLdQwpw6x2ufTT8YtfuiEysyFrIahOCpSRvxEGCVNQXqUC9T5qLB0pbuHZ38wApYym/+VB7DMaKFw/xCYF970LTXG4GwbztNqhSZLM0sfEMDHxAzAXDRDn28TvtjVqVPKeaC+Vp8jDdw2uzqfB3xZiDGN0lU5oqRJQU6YE122HrY7Zf51v1xtX8OccYzyoqkySwwmu83Z3Cztd7AohQ8Eo31ofUEp0Sp3k3XGq0cepvwk1UH6xR938MBKt8rimND8dmMDtBbaL6hUSdumttyoF9OXHt1lUC7icx+7ESmG1mwJ3eUlWsW/m5fZVVzJL4aJDGhOZKw19AcM5J7vuRpCMuT2zkP2GSek3Re5kkKDMfAahIJlUr557F09zbyUWR9EZr1/JYQsozogY6me8Cv5+CyY+TTjYXe8cpDqgHpYCXrR3+V7cvooRbipGX4iS1xGdvo2RQv+MzM9zeYSeCAUp9NBNFb6Mpgv4JIqTFNieRwP7TM97XEe65W1vSq8LxLJVY9Q3ljd7PlGopm+B1U69lCOrfqIShKT+T3AqREGXLVVjmmxL533Ls/jZW2MGyYDpTh2cIQGw/FZsCd/lwenMH6+nrZpefXyUgj84aAoXSFjFxEM4GJdFB9woUlsQ00NgZgTWP8+0kFp7mCT0lhqx1x4ZFbz15m8= X-Microsoft-Exchange-Diagnostics: 1; DM5PR07MB3098; 6:LWaRR+8clLIVGwSLls98hSWoM+ZHE9HxmZqFot4eK81IPvLN7Sm+IfOqZRMoHFHGyrahJxJgNm1SPmhYDqzlqFI4+OBxfDU4tlrDTYZpmPF0zeEvVPm/CdSprU9AUzoU7dGqgIvWcDBmkpK/VnWWJ8i0V414EpKrwuBkRY+G3NLt/kTwpzaIWRyQq4K+3zBbeB5yr9Ga7YdzcpxiF8CItC5XYbxt+NqdoHGAwC7huQbv3igBUdVe4DK7RBkZQX58pLosmrAxdaBCtSr+PaQfWAn1AefGPrTVL+nAjhoxmlzIlyBJ2YW5izQFd3FULNHN9CFrsdX8YE6TfI/OywXh5g==; 5:j5cCvzkKMMGLB5n2Gd72ful8jp3fRBjiGmXUukpFEPK2FYXu6xi8daSVagH6kTcPBRGoleHMA8JAakVhN1cej+yMF40++10Nmk26bxeaKXo2Xtibh9U1tgt6S2hFakyfLZCdi7KKrMjsNSyqIaA64Q==; 24:+c1guYh2SYPL4pVFI0KdO17eKcZ5fACDL5SomEzea5+aBdamPCodGgJIcaROx11Lb/LIFA1GEfK9Yf4sjySCjiEp/u+erU2+oQFQESoSMmY=; 7:QnsgM6vQt1XVuas/U0V3bldJHpDJSzdd99R2ZLb5GszjD/4ix5yhr25oOdGRmkv+/10g4oLBF5n/gKdLJi54UgklO4LpE2lkZRT8KBIl+xlpsD4bAt7C4Xhd3cGSK+OvyGa+WnzZIYG1T0iKBvOuP2wMiz/4p+yb8AZSTt+ZwZFeIrmOYIBrS1uQ8VFxNkCZn0ERKbJHyvWMRmH6bSRDZie/+TS0dkTJGcN02xXui9Y= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 20 Oct 2017 15:22:18.6406 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: cd8e0f37-9bd5-4eb8-adbf-08d517ce5b6c X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 711e4ccf-2e9b-4bcf-a551-4094005b6194 X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM5PR07MB3098 Subject: [dpdk-dev] [PATCH v4 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: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 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 --- v3 --> v4: - Moved Prerequisite section from mempool/octeontx.rst to platform/octeontx.rst. doc/guides/index.rst | 1 + doc/guides/mempool/index.rst | 40 +++++++++++++++ doc/guides/mempool/octeontx.rst | 104 +++++++++++++++++++++++++++++++++++++++ doc/guides/platform/octeontx.rst | 3 ++ 4 files changed, 148 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 9c24dcb46..c92bb8003 100644 --- a/doc/guides/index.rst +++ b/doc/guides/index.rst @@ -48,3 +48,4 @@ DPDK documentation rel_notes/index faq/index platform/index + mempool/index diff --git a/doc/guides/mempool/index.rst b/doc/guides/mempool/index.rst new file mode 100644 index 000000000..440fb175a --- /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 Intel Corporation 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 000000000..88dabc5d2 --- /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 +`_. + +Feature +------- + +Features of the OCTEONTX FPAVF PMD are: + +- 32 SR-IOV Virtual functions +- 32 Pools +- HW mempool manager + +Supported OCTEONTX SoCs +----------------------- + +- CN83xx + +Prerequisites +------------- + +Ref: `OCTEONTX Platform Driver` for setup information of PMD. + +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 11cff6a11..bd2bb156b 100644 --- a/doc/guides/platform/octeontx.rst +++ b/doc/guides/platform/octeontx.rst @@ -43,6 +43,9 @@ Common Offload HW Block Drivers 1. **Eventdev Driver** Ref:`OCTEONTX SSOVF Eventdev Driver` +2. **Mempool Driver** + Ref:`OCTEONTX FPAVF Mempool Driver` + Steps To Setup Platform Driver ------------------------------