From patchwork Wed Jul 25 17:04:55 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Ashish Gupta X-Patchwork-Id: 43363 X-Patchwork-Delegate: pablo.de.lara.guarch@intel.com 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 54C1D4C93; Wed, 25 Jul 2018 18:43:16 +0200 (CEST) Received: from NAM01-BN3-obe.outbound.protection.outlook.com (mail-bn3nam01on0074.outbound.protection.outlook.com [104.47.33.74]) by dpdk.org (Postfix) with ESMTP id A13D2160 for ; Wed, 25 Jul 2018 18:43:13 +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:X-MS-Exchange-SenderADCheck; bh=oSt1xB1/+1peZNwJ5fyPi+iSG1MLZ7aTljepMYUzsQo=; b=CPKypRLAgticvEgWxjas1tgzShT+Kqavpz2wT8JEA9puaIpMJHPXRQThh5drLy8tA47EHYogJ4+nZdMzfuMTIgIK9vatG6NFhM4B4gMbfp0eyaV2daZIKD/n066U4SzyRDMia8xKNT0aMPhcqgiiJ0Lgw1H1PQfyFVn0VQQbuaU= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=Ashish.Gupta@cavium.com; Received: from hyd1agupta-dt.caveonetworks.com (115.113.156.2) by CY4PR07MB3062.namprd07.prod.outlook.com (2603:10b6:903:d1::15) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.973.21; Wed, 25 Jul 2018 16:43:09 +0000 From: Ashish Gupta To: pablo.de.lara.guarch@intel.com Cc: dev@dpdk.org, narayanaprasad.athreya@cavium.com, mahipal.challa@cavium.com, fiona.trahe@intel.com, Ashish Gupta , Shally Verma , Sunila Sahu Date: Wed, 25 Jul 2018 22:34:55 +0530 Message-Id: <20180725170456.3319-6-Ashish.Gupta@caviumnetworks.com> X-Mailer: git-send-email 2.14.3 In-Reply-To: <20180725170456.3319-1-Ashish.Gupta@caviumnetworks.com> References: <20180725170456.3319-1-Ashish.Gupta@caviumnetworks.com> MIME-Version: 1.0 X-Originating-IP: [115.113.156.2] X-ClientProxiedBy: MA1PR01CA0106.INDPRD01.PROD.OUTLOOK.COM (2603:1096:a00:1::22) To CY4PR07MB3062.namprd07.prod.outlook.com (2603:10b6:903:d1::15) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: dc1f65fc-5839-4257-0438-08d5f24db5dc X-Microsoft-Antispam: BCL:0; PCL:0; RULEID:(7020095)(4652040)(8989117)(4534165)(7168020)(4627221)(201703031133081)(201702281549075)(8990107)(5600073)(711020)(2017052603328)(7153060)(7193020); SRVR:CY4PR07MB3062; X-Microsoft-Exchange-Diagnostics: 1; CY4PR07MB3062; 3:9imnawHr4au76rV40srJztekdDSUihXgaOCEcyKz5WhhLm1doFRsbJqiAn69HCzInnbB5nBQRP4WcdsuJ0OmcvmZctNtyqPV3/h9BwO6DBWaLkhjqfp1ebwPrvsusDlnss2HNWt4AHJCQSxFaPFoDNnDkl8xKYCnf3VWhRoYXn5f9f7gvXwbIyMkxhGWbRvnZU4jGYQAUWbCHMrPQ8TNcB+oxnZDLCvVuygCTgdE1pEdc6VZQPpMNiy8KoI2d/Eh; 25:3TwdrFyi+oqUvH4ZMOACQT78PAr/3Ftt4EMIRQv6DkKFPDDXneKgM6/xjdCVlCjm6V0NW5Df4EnPNprjSAb3oRDCEFSuy95HMcDSh019ONgH2gCSZ6zjubxA0N9Xdvn0PFKo2H9TmNtQGJxudILmmYUCSBUPqYmI/7NhYBdOKw8c2CHDpMOMhPzupo9HCXRqV4UtBNorc7TEjX3yY0CNOKMkXYyNU8mH5myDDwS6SLtqd/4rBtMFB5WcJ+8vFiSikxf1XLqPhfjNXQE52n4/scQNoDAt3hfbJAH3NgJXCrsvJ0nEUfPhrFeYpKb7luZ5gKRDPGLAk8drNHIwAl/OJA==; 31:7i7uQFL54oQXe7QIol3x4LckyopMMEXhdMYZaEb9m2eYRJmWqShxnxty0wn2FKM9gxgdmZ+nChUlfcmbeHozieRBalQbTQDzdQDQQBiwvzGcdXXlj5IKXEteX2k1fi2wX4nQ1TeGbMgU8DEvdjjA1azrhZEm+N2BzrFqtABdOxeVAzd2DNsJWnSZL1GVtSGi6QX3rMj4/ckgAV3QeHq3H2pzJq9BYxgU5tulG/RgavA= X-MS-TrafficTypeDiagnostic: CY4PR07MB3062: X-Microsoft-Exchange-Diagnostics: 1; CY4PR07MB3062; 20:QADDOvMhaq9n6GS7iHBoR2GBk+/e8QB1WiO8Dotc15bg4XEORU4eAwIsmEVYsIu/L4TqywVue0NBOKHJLiwZEIzTVRle4FEvJ/JqRLioqby0WfORAmQCeoabRX0Jt0GtWzhnodEyaK2bgiYvgtH9Rfmoq+kB2JRNUKNwjMakDWQ2Ba6X/0xJOHEGNFIwxP5IJnrzSmqXlV62V+g8QLnAt436RljwDWGeBuuu8MBY1LvJVu8alPwn6TBMKIZxqLfTQ2jnoZS8C68X5yPEPNHVEmZfrrCmzCx9fh5Oc5xA+ZWmMwOsjhGbJcSk6agagb6hiyaOJ4cAtbjPtSUJjzmnLRNlWXdpeWGk6m/FtEk8WB+BuQlDvTEFcfHXXxZjOJrH/46V8MXTetJ4nFtR5PYlU7GZOdEl088rcOAxx/+voXElukvUNYFsoTQMQCdSPXW7bfI9xb6ddqqeR1YhquaPxPh0qaIKKt6kUUprAOfxWnG5ovmkpUnjuprAFmkTjjpdRotw26pEYzLEu/04L7J7cms4hHhAk+O4N6DI/PyJnGJAtZI09uq/BN5d5T/uciBmteTg9j7ZyB4Hhi45b09MzaVYVbqNascoetKhls47z30=; 4:ac40JeIiUnvu7WOg5MJZbxmFyOZGuK3cn4GM/HMV2MJwDyxmM+q/D4y9SezyI5dX6s4NH1qWM+tvtv09enhQH72EB3F3LJL26rGlxjjhythnAFiWy1S94or+kNNbF3LYBdlvIp6Vd30Hkv4gdURYY93bYsLBtbkjz9MXPETxEMr4m4y9cL605JmARMEca+TZmMpTa7/QbFM8P3DRsKN89RRywkRGOpFBnfAWuJyc7t6c4pIjsXjieQjkR9cnWjDyUvTupZfuModD7KIbBlpU8Q== X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:; X-MS-Exchange-SenderADCheck: 1 X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(8211001083)(6040522)(2401047)(5005006)(8121501046)(10201501046)(3002001)(93006095)(3231311)(944501410)(52105095)(149027)(150027)(6041310)(20161123558120)(20161123562045)(20161123564045)(20161123560045)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(6072148)(201708071742011)(7699016); SRVR:CY4PR07MB3062; BCL:0; PCL:0; RULEID:; SRVR:CY4PR07MB3062; X-Forefront-PRVS: 0744CFB5E8 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(396003)(376002)(346002)(136003)(366004)(39860400002)(189003)(199004)(2616005)(956004)(446003)(25786009)(69596002)(6486002)(2351001)(53416004)(81156014)(8676002)(11346002)(47776003)(105586002)(4326008)(66066001)(81166006)(486006)(8936002)(476003)(2361001)(26005)(186003)(16526019)(42882007)(7736002)(106356001)(68736007)(386003)(305945005)(6506007)(50226002)(107886003)(6512007)(6306002)(51416003)(48376002)(52116002)(54906003)(72206003)(50466002)(6666003)(97736004)(6916009)(5660300001)(478600001)(76176011)(16586007)(53936002)(3846002)(36756003)(2906002)(6116002)(55236004)(1076002)(316002); DIR:OUT; SFP:1101; SCL:1; SRVR:CY4PR07MB3062; H:hyd1agupta-dt.caveonetworks.com; 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; CY4PR07MB3062; 23:KZWUOr1pWRjx4HsDRHkQOHEE2AhXO6PPvZLb7X+bt?= 2Tcve4Uqx+XPWF04MIsZvPOw0HN2szLR54sW0p9KmX7oGhHI6VnxAcK9IIG7ZI6eIAx76zruFTHMaDAT99S0bXyIIUkSqcwhj1fcKerpO7BilRzDzapo9/uqkC3PvOBcYv2lX/kBfwBs9l6S18FVvbge6fitanJu+0OlYhQjbiOxMzQfLh3edWR+EY+uEhW58S49acyRaoBqstIUHseZ9biQXbcju+P2VgZ0JWreGdbNngy0OsYYWhXBjDf+l5vDQWK9gbV1xtd1VXbNptxrP10ALHzLq+V7ujB5Vpm7IAXWzb9aCYkwoEGKH8IoxOZADVjgfET0nFmQPDcv5saA8rVLMI5WSMFtLa8xlIPBBsYOdNLVMIN8CYKJaCz4S6uy0y5bJBIsb0tGRASLlGxflI0LZfSpDymLTVbqf/uOoz6nXXfGTxV1uSLuCI2bU3lf7QSKX1QArehffynpu3FSJtya+AusH5So8lgAOpiG50mG19isAF8Q3EA1aqKIkeIManUUBavJ4ZAVd+w2QxPu3NaHuONHoiqjVoZK+Opi/eHCsz9jIeiG5XN+OHF8dFDVpqSXo/e/gOX9sUogcpyT9ICyJSd5Z3WXt/YXAh2RvZEpm3xrM9YQn7vXaaLLJDZUSfi1Q4ouvkYqfiAab7ec2kIVwylCTNy8cF7K7uGhaxGYvrjCLkAoiGfj3jReLZ5tOV9feKKkgR4TiBgvMlJQJwyhp5XAqpvFhjV3NVJBy3+R8BE14sum4wtp3htZzvPY+L28ueBV/55PvyR6ZLoW6uiA3v7MmW51juvYH0I18Q31wHpR+9+wEVjQu4VWsPS33wMop3VHFw97/auqsKOgeUrp1VEAnlEfR//ENRKU+9kirGhkgOveZ7EIewayyxdyhfoBmE2AHCITjvKovTjjVKqcBr8HfpyRr5XWndQC0o6gRgtGoLKa8Nm5uNccbmE8iXqJISIJoBAV1ri1HgUx0nQMZBFYdi+EkfFvR7QjddOWMezWB/prD2OH3pbx6P9pCuq3bohT9+MAdGoOAlz0e9QpGQa3/qO5M8/tcLyKtV6sdaZZ1F3GH6oQcP/AHormaulr5g07dd5CVSPOSg9cIDNX8a936iHmRtLu02eTSLTSB/b0WTWQ9hHMETm05Z52m0CR1Lk91z7EN6ZEtioFET7iRJAkzSLS9FRlj5XICQoAKiEkO6KsRaBHHfDqg4ZwyWo89Q1zathDNNBwE1VkevFihCEmSccRS8oVNabXF6whh5mIwSTd+ZsgyahX+CYtnc1V9WMP6msD9LVIX//HSSdtSzEMhjONcfZKNf5gSIPPSY6x408c6/Zu267mGZajAY= X-Microsoft-Antispam-Message-Info: LBIgdxP4pxDAahCU1h65RvG++xSFtjNjjxIVAfzmI6t6kd2VunMbdjPJ6kRIF4EPR70VtzS3YTVVMbc7QlQKTLpxrU1XSaRYNSUvCjRCZg7hOCHOM/2lCy015QVbEzA9CH0WcIsVx5Q06GW25me1IY/sEkuNsk3symA0+4e3lQsnoTPm1t7NLOc/eHG88/gFYn+PyVocVz3NhKz5gyqno3hSoGexxI0kry7s9Ctdw3DbuV/tZSyK/k5lMxSAin17RB0dAWAOhv3/nOL/1budpF7SGWg/RGERMWUgbyDWvrAF3bojfbbJkG+vtpSr7ivTzjVhNk22+03FmkeMziIkXhdNaoxeALLmzGlMa9yltrk= X-Microsoft-Exchange-Diagnostics: 1; CY4PR07MB3062; 6:Px3TUZzXOReXcZvSenWK+ROFv8fdcgXLyrNGbjbfykK+bHRnBiKdJst6SjgHpz5N3z+2O5WWrQoRhkmkuIdwvd6/E2bpFsrW1U4P3EVk1SZJldZyKEO5Mm2UJjNOHoLOQPoQCKAkRNac3LsPTgRw26Iqb3yUgBhwdDbfTMm/bgOPFdw80lbGgYlfThUFtotXLpJwGkw7gr1Et9BxdIF/l0td7g5t7RY1m+PHN9xobPm8a/sI2nqd7nzDlSw5cEKfdFIZKEBTFkBh7XVMmA+n+4RgxV7PXdGO2gpLjvUFjVNhV70pJg7NLNgs/eGxUYIZ4NqELBmk5JyUouQ+RdU7wl8c8rowM/Z/p28a9PEdhaphma4zVMKqQ2FNMaxcS+wtV/I6pT1Sq0nmcvtxi/puOI/7Wy05B8dtHQAyNOZK2/X1apMDIHhqmr6daNzD1AJ5YeLCJ7PfKE972QvbtoSpiQ==; 5:B0RyEriXS/UU1UZFxymQIfQi9lOZeYXLI9X+tC0rDN8rAtZnx3VPQu8RkIkdQsyJ8P7mmU3UWCLq0IJERJ35vnF/FYtol6aYAEPt8OU6zzkJRGXQ34qQoepmvEkFzIWh2HV0k/Zn/wikG635T6HbQITNrcoupKVKDhnz9NgtKKM=; 7:cvGgOWBKPzhJl1yX9C94C2a8tFaGT1ixxmKVbhsqajbYhAvbh7bbABQVPWS3jYsK1QFb2UJiendgKAMYIhKkSvDbRKugqSpiPbYl3aj4CiKwNJOpcqyuaL6krTP1jit7rzaQP3L+375qD2IBVAYx8Rcpby+w5PL7Pfb76ta+iRFWuvHuOpM5cLfVs5L1WVbNgJMXGyAB9S6LNJMu7bAE96e9jF0gW6bh22XXZ8GwVth3RxIq0JfCpnXkku6iO2L2 SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 25 Jul 2018 16:43:09.4860 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: dc1f65fc-5839-4257-0438-08d5f24db5dc X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 711e4ccf-2e9b-4bcf-a551-4094005b6194 X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY4PR07MB3062 Subject: [dpdk-dev] [PATCH v4 5/6] doc: add Octeonx zip guide 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" Add Octeontx ZIP PMD feature specification and user guide with build and run instructions. Signed-off-by: Ashish Gupta Signed-off-by: Shally Verma Signed-off-by: Sunila Sahu --- MAINTAINERS | 2 + doc/guides/compressdevs/features/octeontx.ini | 10 +++ doc/guides/compressdevs/index.rst | 1 + doc/guides/compressdevs/octeontx.rst | 107 ++++++++++++++++++++++++++ 4 files changed, 120 insertions(+) diff --git a/MAINTAINERS b/MAINTAINERS index 16cbfd0..18a78be 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -858,6 +858,8 @@ F: doc/guides/cryptodevs/features/zuc.ini Cavium OCTEONTX zipvf M: Ashish Gupta F: drivers/compress/octeontx +F: doc/guides/compressdevs/octeontx.rst +F: doc/guides/compressdevs/features/octeontx.ini Compression Drivers ------------------- diff --git a/doc/guides/compressdevs/features/octeontx.ini b/doc/guides/compressdevs/features/octeontx.ini new file mode 100644 index 0000000..884a8b0 --- /dev/null +++ b/doc/guides/compressdevs/features/octeontx.ini @@ -0,0 +1,10 @@ +; +; Refer to default.ini for the full list of available PMD features. +; +; Supported features of 'OCTEONTX ZIP' compression driver. +; +[Features] +HW Accelerated = Y +Deflate = Y +Fixed = Y +Dynamic = Y diff --git a/doc/guides/compressdevs/index.rst b/doc/guides/compressdevs/index.rst index 6ba6641..1f37e26 100644 --- a/doc/guides/compressdevs/index.rst +++ b/doc/guides/compressdevs/index.rst @@ -11,5 +11,6 @@ Compression Device Drivers overview isal + octeontx qat_comp zlib diff --git a/doc/guides/compressdevs/octeontx.rst b/doc/guides/compressdevs/octeontx.rst new file mode 100644 index 0000000..0b53f9b --- /dev/null +++ b/doc/guides/compressdevs/octeontx.rst @@ -0,0 +1,107 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2018 Cavium Networks. + +Octeontx ZIP Compression Poll Mode Driver +========================================= + +The Octeontx ZIP PMD (**librte_pmd_octeontx_zip**) provides poll mode +compression & decompression driver for ZIP HW offload device, found in +**Cavium OCTEONTX** SoC family. + +More information can be found at `Cavium, Inc Official Website +`_. + +Features +-------- + +Octeontx ZIP PMD has support for: + +Compression/Decompression algorithm: + +* DEFLATE + +Huffman code type: + +* FIXED +* DYNAMIC + +Window size support: + +* 2 to 2^14 + +Limitations +----------- + +* Chained mbufs are not supported. + +Supported OCTEONTX SoCs +----------------------- + +- CN83xx + +Steps To Setup Platform +----------------------- + + Octeontx SDK includes kernel image which provides Octeontx ZIP PF + driver to manage configuration of ZIPVF device + Required version of SDK is "OCTEONTX-SDK-6.2.0-build35" or above. + + SDK can be install by using below command. + #rpm -ivh CTEONTX-SDK-6.2.0-build35.x86_64.rpm --force --nodeps + It will install OCTEONTX-SDK at following default location + /usr/local/Cavium_Networks/OCTEONTX-SDK/ + + For more information on building and booting linux kernel on OCTEONTX + please refer /usr/local/Cavium_Networks/OCTEONTX-SDK/docs/OcteonTX-SDK-UG_6.2.0.pdf. + + SDK and related information can be obtained from: `Cavium support site `_. + +Installation +------------ + +Driver Compilation +~~~~~~~~~~~~~~~~~~ + +To compile the OCTEONTX ZIP PMD for Linux arm64 gcc target, run the +following ``make`` command: + + .. code-block:: console + + cd + make config T=arm64-thunderx-linuxapp-gcc install + + +Initialization +-------------- + +The octeontx zip is exposed as pci device which consists of a set of +PCIe VF devices. On EAL initialization, ZIP PCIe VF devices will be +probed. To use the PMD in an application, user must: + +* run dev_bind script to bind eight ZIP PCIe VFs to the ``vfio-pci`` driver: + + .. code-block:: console + + ./usertools/dpdk-devbind.py -b vfio-pci 0001:04:00.1 + ./usertools/dpdk-devbind.py -b vfio-pci 0001:04:00.2 + ./usertools/dpdk-devbind.py -b vfio-pci 0001:04:00.3 + ./usertools/dpdk-devbind.py -b vfio-pci 0001:04:00.4 + ./usertools/dpdk-devbind.py -b vfio-pci 0001:04:00.5 + ./usertools/dpdk-devbind.py -b vfio-pci 0001:04:00.6 + ./usertools/dpdk-devbind.py -b vfio-pci 0001:04:00.7 + ./usertools/dpdk-devbind.py -b vfio-pci 0001:04:01.0 + +* The unit test cases can be tested as below: + + .. code-block:: console + + reserve enough huge pages + cd to the top-level DPDK directory + export RTE_TARGET=arm64-thunderx-linuxapp-gcc + export RTE_SDK=`pwd` + cd to test/test + type the command "make" to compile + run the tests with "./test" + type the command "compressdev_autotest" to test + +