From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from NAM03-CO1-obe.outbound.protection.outlook.com (mail-co1nam03on0088.outbound.protection.outlook.com [104.47.40.88]) by dpdk.org (Postfix) with ESMTP id 06B091B554 for ; Mon, 2 Jul 2018 18:56:09 +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=YyRGItndvZAw8TEn0itgeN57xAutMHefZ7o5LScQsYc=; b=I+Xy7nCDmBObvHjvChmkW+3ToTDv7zbd0rFlVh6X9OZkDkxcFvLEGEGFC2IHGV1gNdV7iuvGFRG/a/i0Ch97YmPOOS88q1AftiC1Ha9Lveczz1/O98vvbj8p2bXmZH0QKoOOOqUusNC1CDgGbB7sQrQ+rzzJAfEv4YNQpbAYbC0= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=Shally.Verma@cavium.com; Received: from hyd1sverma-dt.caveonetworks.com (115.113.156.2) by MWHPR0701MB3644.namprd07.prod.outlook.com (2603:10b6:301:7d::37) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.906.20; Mon, 2 Jul 2018 16:56:06 +0000 From: Shally Verma To: pablo.de.lara.guarch@intel.com Cc: dev@dpdk.org, pathreya@caviumnetworks.com, mchalla@caviumnetworks.com, Ashish Gupta , Sunila Sahu Date: Mon, 2 Jul 2018 22:24:36 +0530 Message-Id: <1530550477-22444-6-git-send-email-shally.verma@caviumnetworks.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1530550477-22444-1-git-send-email-shally.verma@caviumnetworks.com> References: <1530550477-22444-1-git-send-email-shally.verma@caviumnetworks.com> MIME-Version: 1.0 Content-Type: text/plain X-Originating-IP: [115.113.156.2] X-ClientProxiedBy: MAXPR0101CA0007.INDPRD01.PROD.OUTLOOK.COM (2603:1096:a00:c::17) To MWHPR0701MB3644.namprd07.prod.outlook.com (2603:10b6:301:7d::37) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 61272d99-d7c7-498b-2664-08d5e03cb54b X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(7020095)(4652040)(8989117)(5600053)(711020)(4534165)(7168020)(4627221)(201703031133081)(201702281549075)(8990107)(2017052603328)(7153060)(7193020); SRVR:MWHPR0701MB3644; X-Microsoft-Exchange-Diagnostics: 1; MWHPR0701MB3644; 3:q1wy/gr4pKRnJNEHNhtA5cVXESE4dlucqbhDXYmfABHmBwxk6gTUe+wTIby0SQils3tgdELrK3rF2x0llqU5d2PNFTlKD5uHzQzN0VD7RNyzBk3bFf//nUF8ICnMtcvg4Ot1wVIfN0DCyB6yau+NbvKBBXmjUR61wq2oMX0H0QtZAEggmZzFgzhqwhwAQTQ2Go/vd1pyMO04cMUghsHFi76xjkqK78X1gfL+yvF7cgfduDiED6BQbKNjIV/JDguF; 25:lR7f1H/AY0gbfBrWU0/QNmvY2kTRHGK2jAyvJZxzZxvGo9vF3ycYghqsoZHZdYrWyjOgiBdayXSEMLVIBV17+Va6pG8FnKCY1fmHmv6ta3fkZfcmBcrP4AaPoNoUxjTUFdA4uERXWbgpMkyGPP3Tv/8D1pDxcLcq4KBWsXvXVufgUxGXuHgfszYK0WT9k75yEchpPbPnWZ85w+ZbR1gRMfchaTzrbwm47kPKddpy8Ivc5Xz1NS+hy04vzeu+sJ5C6VzOwlCASV45Dv7pPlHuhWtfU3McHoS8I/vYn8hUZ492DP1P7W/KqKMn/7Gb0wKI93AahthszrS1gVt4CMi/5g==; 31:Hj8/1R+tQR/Pq+lfjP9yKGL/xfdvLew55U+Q2FOQQQPjGmXc0IaRrLJrpM2g71V1qM9zOGAiHOnsliekgIEyEjbwOMlVPAEPHBFCJzgEk6JaDguQNsrKn5dRZNx3jb+0dEBIQm0qapRdf5NNl+XwkbbbH5mSy0Ge8IVULY/lRPK4hiGS9cF1h9G/6pkU3n8tpnabXQ0X/LScsOsC3BPmm+uwqWrdMHMOrhTmySalGj0= X-MS-TrafficTypeDiagnostic: MWHPR0701MB3644: X-Microsoft-Exchange-Diagnostics: 1; MWHPR0701MB3644; 20:xP1zwn8GWrg0yWlUQplxz99Fft2HfNwa7UdFVAO00FJIt2Ap9LJyRcaZAsLXy0yXMPMfTq8nTyN7UV3oTSIRrd/r3XJzsoLyb8ci2tkCyMM9gZVFtrse4uZwYvXUUEsh65Ac6veVbfQ/OTBmLt88JD1PikOEYPkf1kN991GzyR3uAQfxz9jsZJPHHDS7+TmrHz2oxkXYXskqqZCi4E/sMTDGIlD5i77Bwn0+ML0SX+SyBYJkozguRDJkKIFv6N03yA7SCAMmnXsMkGQrAAcCaiSC0Pf0hcEIoCFoFB+l4MvtADHh+fet03tCidbgVg0LVxN3miQkgUihC7w415W3LHJBOpn4MwxqO/FHTkU30qjhf+RU9oXVLxwNFdtR8ebpQT7vaahhWyVyE0hIeIWtApedGfIwSiWdJpTdKLWpxmbQ54GcVhRY2lh06iw/wRj2CkKPawQbJhrg99HC+Cl0V3z+oBP4bO5SYqiJTEbDQR3dD1n2GERC/kg97KTY8HpHJNl5IY5eB0YytAzy/0X60AsuFB/Ry75Va6hkmrQVGO0jEuGRVh7eabKNvM1etkrB7xLrvGH/Tkcxu6AyOhXzeph+IKPxB1e9za+XQkFW3PU=; 4:foh1wYz5GY3sNuGXZ/xFzyLC3iytSHPq/WJIJtEj4wb0mYVwG4W38z/A+aDJte0mTay+qUiFonzV3LucgwddoJArvXm9GqjVOizNyP2DD9lIl3btMAcohmbJxWO9FVLKs9KfmvidreEDkvLpVdDrWhkQAFCQSyALjBfXTC4CLgGGiCS0mRS0kotZs/sU2KYmo72Su0X+jyO9Ipd+iajhP3R/V7JlGdoecFaI5whInYOarWVU2T1WcR6jyeFi9WsH8USf7BDWZ1jlQK0cnHaWYg== 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)(8121501046)(5005006)(93006095)(10201501046)(3002001)(3231254)(944501410)(52105095)(149027)(150027)(6041310)(20161123560045)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123564045)(20161123558120)(20161123562045)(6072148)(201708071742011)(7699016); SRVR:MWHPR0701MB3644; BCL:0; PCL:0; RULEID:; SRVR:MWHPR0701MB3644; X-Forefront-PRVS: 07215D0470 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(366004)(396003)(136003)(39860400002)(346002)(376002)(189003)(199004)(6506007)(25786009)(55236004)(107886003)(3846002)(6116002)(16586007)(2906002)(186003)(51416003)(52116002)(16526019)(76176011)(4326008)(6486002)(105586002)(386003)(36756003)(6512007)(6306002)(2351001)(42882007)(54906003)(69596002)(72206003)(2361001)(53936002)(26005)(48376002)(50466002)(316002)(68736007)(478600001)(6916009)(476003)(81166006)(66066001)(81156014)(8936002)(97736004)(8676002)(47776003)(446003)(11346002)(106356001)(50226002)(2616005)(956004)(6666003)(44832011)(53416004)(486006)(7736002)(305945005)(5660300001); DIR:OUT; SFP:1101; SCL:1; SRVR:MWHPR0701MB3644; H:hyd1sverma-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; MWHPR0701MB3644; 23:0W9has9S03iO7mggtcIjzxuQ/J/HzP2aos98w7O?= =?us-ascii?Q?MtytXZh+txwSGXZF5kas7EgJfZkhS+8O2TSrJWnZonEsdAcRdPRkcPet4OQd?= =?us-ascii?Q?IWLO6DhUquru946yXEwleMF8kQ4UJa4KuowFfoyueqsQ/AP8TL7d04KHcJgi?= =?us-ascii?Q?ZLkDRS8KyizMDCPz5pDChggpDzrwVWA7o0uPMGzX4hB6vz/V4D2H8ZMgukZ4?= =?us-ascii?Q?rYVHjjtBlMsJII7r+PdHDRmQejG4Ul8bHPWd6FhR1sbH5FieAo/ncKHkiRlm?= =?us-ascii?Q?izvorKDybXgNSIDPDP8G7zBWcaYpnczwGuWlXmmQj3gNWTsKBb63lZevyaiU?= =?us-ascii?Q?l7MnbCGoBxoSdbp1v0kbtVfebR6WIMFxKYBZFNRWMPFbysTzRKCXotr55/6v?= =?us-ascii?Q?ZMIBl34z3lDNKicO2pwJhXp6l6zeAuspuLI/huvpzrGqLrHXh8Fc9P16ya0j?= =?us-ascii?Q?VHd4j3ht75glj+sYmv5dER+MjQdhnie5AR+6zyDKb8gWK1tu6O+fXKKIsKPF?= =?us-ascii?Q?q1KV7AD+ANgqUKpBpirqcvKhkpKMOIM/moeuKKqXIsnbmBxfIGV9am2J9YV3?= =?us-ascii?Q?hkpr9waHd+uxIf6kVbGB0VOvFlC37EWl3tPpCyAXR06O/rMr8bxXq2hlb8qa?= =?us-ascii?Q?OGRrWXksfb+s+C4Q/xHq3JlLORtFz5rZD1/5KnYZXqpxZlQNqxxD/6z9eHT8?= =?us-ascii?Q?yu6QQaj3TzkNpELoxk9l83UDtR2sEJlNs4/hJb6FnWYjZHCjt8wXYqMhMy1Q?= =?us-ascii?Q?qhiti1pIrt4Gqsrp4hkcyAMiejzyCdHcxPeCGAWD9PLHQT6POtN9WIPyEWwi?= =?us-ascii?Q?FYP/gl8T59tBYNDCSr+30QVuTtjUHjwu/iArYzv+D254ElVCPZB2Utr8fBkw?= =?us-ascii?Q?odiHJ37lANLYeH51EU+MIWx0EpuPtQjNjKt8vCaXxIkfCrWcYykWIwN7GIqg?= =?us-ascii?Q?1nekHVb4MyZu1pxHGUHCso2/iC0/1bTFu4E4D0sHS7y1AoOqMy4B71Hf4kJX?= =?us-ascii?Q?ehKTw2CXUhIBlx/wRDGxomX2RFWaVdWcI09TMzuFIh6arn3ZIF8AdpFTC3ZA?= =?us-ascii?Q?gaYNV9Ds2Vywqay5a10uDaOc9xyr/oYaQz0ma6Om9NHxOKM9B+FBVSev41VP?= =?us-ascii?Q?U9mH2NUtQSMmdIi9x8SOUKm/hk5+0Cm6LIjSrB+lOcSqTi1N6NgUl4ll67K2?= =?us-ascii?Q?RE2lVLAnOfl3al4pfcDr/JwSAwRKTPUbw15a9nQZOq0Xc3PLoSI0I9tVuKbB?= =?us-ascii?Q?c9uzc9d4Xf9kZqR8B1KoRS2IRYk8Z/7ewKOKzPh8ikp98BotSyKTOxY7rjre?= =?us-ascii?Q?If3cupWaZxSyEf7PUAszm1+D6rN2u+meLHUiNuD4sImFgG0drEOa7ic3aF/u?= =?us-ascii?Q?FR9ApADbTQhEDDaneD4I3ACqG/sQ=3D?= X-Microsoft-Antispam-Message-Info: 7rhfD132YuDMESM+SZ+x1l4dWLHdYb23VodCP1y7HVD1K49tuPMlmfrfxH9C4xu4/XwJav6WDqKalOhoSVaslytiBB+GUorsNTggHJOXrkUIUTj0XoLX/4tN/K82lYzsFbBsrGh3R9J+ftrGFDYu0UYx6OS9KNFsPo9YJrnI+ig7gRwMAscEJLIgDIs9QGC1dUFZlEEux5ral69m/7vtUmycwK4HjXtTTG6Qhbo3ESTHGDXQ+j4wOnEQhmGsVi14s6HmHgbyHz1UFDZMyOXFvewtrrO9qwuTLRR7xwGLn3RklIWAo4hX8nAg3IXmB75a0VoBvuRSQVjXHh933YeKLjAk0pwLa9/pMj4xLK3x6Qk= X-Microsoft-Exchange-Diagnostics: 1; MWHPR0701MB3644; 6:NDjOFY570Jh77KNnCcT+B2SZjZCO2yapPoBxWgmZqabOsSLZks4XUH3R6tzVZSdhYcAT53Tkv6jDyQavVhvgbnfV3SPe41ddjFyXI0euEH3bJNXYYNzHOnjEiw4b9hPnBs1sgfG1cl7ev6vh8dPn4y8/E7dCnx/pegUP/WhnaIfq5u3oD/zTC6YctM/rwfiRFPaKsQ2jUR/uw9P7IEV9MHNBD66fwwdNfkQ6HX4m0d5xSna08SfvMlbR5Kg0c0uJpVxSv7exk7+/ZiWQ5IFVV2Zo0qmPc+Red0wFbdv+yNuoAFGCuR0I45QJO9289HsWOSSXj2qUsVjzPSeFTbtzM2ACiD5gY/nn3OOItl7HdPW0YGzw183vfvIKRVo6BbvseEBGIrJ9Rrdc7tHf8xntBVnl6O700sjw6Uozoftxny9n3ECZTOwVmel0oR6aJqbVtbBeDUsHdxj/sCFhnnusEw==; 5:Wso2hLFy69SIqaO4DBKnNOeMlzFNyYGBsXdVcaOHa3IIZ/cGPg68FLqIshyUFpYom+6FIAzotoAzZNOSTOdsJLu0VG9+s+iViiZGW/UBobP9xI46YecPR+vcknplL9DDy/BNQfK8Yhm6H0dN7WvJBnlnaSVtov/5jEEgijsbeP0=; 24:VG+L366G+o+IUSC2ywMle3xI4r+gUgfDHAAWEVYICD56GXSjUDwQW1TwAVieIe0Cs0oB9j+jmYSslHNzOhddSdNN8TJSxPodWg7jZZ4LIqI= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; MWHPR0701MB3644; 7:H86TWsswoJAdRHEYkZ7XMars12N4QEF89mkONw1fjYMyOnhAqa5gGE4LP0BbL81Es0i3tJiHGlT+JD4JyQDgUP1g6TQbIT78IkUaLQZe6ChXumTI7BBe5UEy5co4HZTvEksKycBJQ/vBJmWHb11OmPu1TWtam3qrH1rHlE0tFeWPZXunakNsPwF9VjtioTFQ3/riYWiH6JWd+neaqYXhbt6abQVRWZmBupo4bXxM60YUIEauxjHU2MoxttUoiTZU X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 02 Jul 2018 16:56:06.8928 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 61272d99-d7c7-498b-2664-08d5e03cb54b X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 711e4ccf-2e9b-4bcf-a551-4094005b6194 X-MS-Exchange-Transport-CrossTenantHeadersStamped: MWHPR0701MB3644 Subject: [dpdk-dev] [PATCH v2 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: , X-List-Received-Date: Mon, 02 Jul 2018 16:56:10 -0000 add zip pmd feature specification and overview documentation Signed-off-by: Ashish Gupta Signed-off-by: Shally Verma Signed-off-by: Sunila Sahu --- doc/guides/compressdevs/features/octeontx.ini | 22 ++++++ doc/guides/compressdevs/index.rst | 1 + doc/guides/compressdevs/octeontx.rst | 107 ++++++++++++++++++++++++++ 3 files changed, 130 insertions(+) diff --git a/doc/guides/compressdevs/features/octeontx.ini b/doc/guides/compressdevs/features/octeontx.ini new file mode 100644 index 000000000..224bcb8bb --- /dev/null +++ b/doc/guides/compressdevs/features/octeontx.ini @@ -0,0 +1,22 @@ +; +; Refer to default.ini for the full list of available PMD features. +; +; Supported features of 'OCTEONTX ZIP' compression driver. +; +[Features] +HW Accelerated = Y +CPU SSE = +CPU AVX = +CPU AVX2 = +CPU AVX512 = +CPU NEON = +Stateful = +By-Pass = +Chained mbufs = +Deflate = Y +LZS = +Adler32 = +Crc32 = +Adler32&Crc32 = +Fixed = Y +Dynamic = Y diff --git a/doc/guides/compressdevs/index.rst b/doc/guides/compressdevs/index.rst index bc59ce810..cb467ab90 100644 --- a/doc/guides/compressdevs/index.rst +++ b/doc/guides/compressdevs/index.rst @@ -11,3 +11,4 @@ Compression Device Drivers overview isal + octeontx diff --git a/doc/guides/compressdevs/octeontx.rst b/doc/guides/compressdevs/octeontx.rst new file mode 100644 index 000000000..d4010d31d --- /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 16K (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 + + -- 2.14.3