From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from NAM03-DM3-obe.outbound.protection.outlook.com (mail-dm3nam03on0084.outbound.protection.outlook.com [104.47.41.84]) by dpdk.org (Postfix) with ESMTP id 86FBE1B7F2 for ; Tue, 5 Jun 2018 12:36:16 +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=oFUQ557wsOcaVCy/Qtd1edpi1RXYgUw4Bx7WMO26DJw=; b=blqakdfU5B+nxB4iur69q93QRCvEZRUu+LeaTzgxC+oY6UV9MKsq5TRNRyQHEzEonih/DOJNb2t1V0Ro7OeslHJVnSlhMwzy+lxW1sXQQ8Awp+R5ssvPJ37jjYGmzc8NHuQp2/liVKNHjvMAGhwGFm9UYVXnFnBrQAw7TU9Nwtc= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=Shally.Verma@cavium.com; Received: from hyd1sverma-dt.caveonetworks.com (115.113.156.2) by CY4PR0701MB3633.namprd07.prod.outlook.com (2603:10b6:910:92::35) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.820.11; Tue, 5 Jun 2018 10:36:12 +0000 From: Shally Verma To: pablo.de.lara.guarch@intel.com Cc: fiona.trahe@intel.com, dev@dpdk.org, pathreya@caviumnetworks.com, mchalla@caviumnetworks.com, Ashish Gupta , Sunila Sahu Date: Tue, 5 Jun 2018 16:05:12 +0530 Message-Id: <1528194913-25893-7-git-send-email-shally.verma@caviumnetworks.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1528194913-25893-1-git-send-email-shally.verma@caviumnetworks.com> References: <1528194913-25893-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: PN1PR0101CA0006.INDPRD01.PROD.OUTLOOK.COM (2603:1096:c00:e::16) To CY4PR0701MB3633.namprd07.prod.outlook.com (2603:10b6:910:92::35) X-MS-PublicTrafficType: Email X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(7020095)(4652020)(5600026)(4534165)(7168020)(4627221)(201703031133081)(201702281549075)(2017052603328)(7153060)(7193020); SRVR:CY4PR0701MB3633; X-Microsoft-Exchange-Diagnostics: 1; CY4PR0701MB3633; 3:ED1CsOTyz2ZOaYUe+bhAXSBFoatGdQ35Dlboj1d26GH/MIzJYWEVUEST+eGoYyA6MSmzAb4mQuilsqI2mli25bkWTJ2/g78r6ZBTR+s2+idp+BJDmz/rvE73JyeILT0vW/hYSjawpmk6NNqfhzZ7NZHuf4NWRX9Rjb/tYFNbeJ6Dd9CnNeqRTCqpqGoKkwsTRWtjo6Twx224GEP+2JDLXFhsxZ9L53Js0r0Vs50F1Rv+d9oXO8ciA5D5qNaBUOAr; 25:IHWynMYl5ChfQzpQNGNaFZSJSHgjWUjbOe5SyhBym8KzpFyKlvSfyhZamJdOnXpZDr8hHgbHPZWKchLRqt6Rb+M9bq0yfqVZygsUr57l0499h55Wew8QUyL6nteWZKdVILWKNN3j21BLpKxxnfZjxSPtWj1YcGSFmzvwyQFSwafgAO8UJjKZ4RZfwp+1/NyCDz/HbNQfEUYixgcrB1yGRh/OKxfgK4Td+O7mivW6t4k1jzLEbaS9XV7y+ezjLIXBiRqnSQLAVcqCGOCO1xmzvAWFypeRUjgXKKu930bxRVJ3DYZBsUj7Zb4Mmi+DJiwdZFYeWMVC2aNaWW+2wz3PDw==; 31:mexhtfNx1hH6hgDnSV/DWOouJKmOuUBsWcGDjhI4+deVAHEBeu3kqnZbymFKjl0xlcr9PQv7GSI/NPZMYXcvxLwHrCmKhfOxgZSB/MG+iLSQdM8xJAlNTbJrY78Fiuaah6YgZYA4Cj1sCtRUIW2oom+Fn+DKMSOZpHK25ABJNgvrT/jkTu6uvOY1iynqY5+l8znrBTAyX0qImBC8JdyyEd1H7ptVpA8gn/oFRxvmW+c= X-MS-TrafficTypeDiagnostic: CY4PR0701MB3633: X-Microsoft-Exchange-Diagnostics: 1; CY4PR0701MB3633; 20:JCMHEGUdunvovhpdxLMbDKq9aNUjfmcRWgnIRRGTNCS8lGN+7QL7YiAaa6IL36g0dAncLd/fHhRekJQaC14Lkmm1tkJBhHF/N8AmJ496HELZeT82vJlPfrYgahwEwaeWkHoGODyhVCjPj53si8jUCSqn6FQf1/opYA8zanwt6t6CMrsj/l9zdQskrbczrFQLox1Ye5QT4mvnWX5BP65WEkGHcLl6KVjthkrkNXxzl8eCuS0ZOd5Zxc75pAk0L9fqQ5QLrOWqkXTJJVV/D2+FPOnpWZqAqW2avlbNYMpm18+nyGYQVqVufhPAPRbn7eTtTlwbtNArb7G3IFZMnhdJvIlb47pQyWGm6Gjk3vnrx/yGS4qjSLC79lUTQ1Yg7XY4dsQOJBiOiEwCPyLEvTlbdYNKmPsGeIjdGcunneHfFHZGdBZyYalYQUzD3HQAHSG96Qr6l18dYY4QVLgYuqWeaZsU8HEY8LftUJISSy8Awswwxx+dYPjnx9MafrOGjvtsTO+wTHSyJ+5BwoHoa055+ltRYzQD1BCpANeed27cV+63mZjzjIkk2kv7Y4X5aSEiPjbO4qbB8e0aqZwqySFlyPzqWTh/tN0lPtwnwBwOtuA=; 4:iFab76Vp/Pwprwbg2BHlg/WWg52Ka0gqcY3JH19x1dsUvxbeD5hWymkM/viTQIWui7S4YM+KJcAuOP5bHqS7CcT+b5T4NPFRt14D9M8jFkiClb99X2q9yVV7ZTSXpngZGB0xSE5KNAm+jkiDg0HOtf7kIMoAlEW7dYTtfbuTe9PvYPbDvak9hp1CiYYlfz1WqrjeGrZdrzLF4KDMeVkQIxiIzSjCA8p0tf4uaHu2cztg6rc6SgMp53D3K0RyX3AHr53Jxhv/XvIW2hlVMEhg6A== 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)(93006095)(3231254)(944501410)(52105095)(10201501046)(3002001)(149027)(150027)(6041310)(20161123564045)(20161123560045)(20161123562045)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123558120)(6072148)(201708071742011)(7699016); SRVR:CY4PR0701MB3633; BCL:0; PCL:0; RULEID:; SRVR:CY4PR0701MB3633; X-Forefront-PRVS: 0694C54398 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(39380400002)(366004)(39860400002)(346002)(396003)(376002)(189003)(199004)(6486002)(956004)(476003)(36756003)(97736004)(54906003)(5660300001)(316002)(386003)(25786009)(50466002)(69596002)(44832011)(53416004)(6306002)(2906002)(186003)(48376002)(42882007)(52116002)(16526019)(76176011)(6512007)(486006)(8936002)(6916009)(8676002)(53936002)(6506007)(6116002)(3846002)(81166006)(105586002)(81156014)(2616005)(2351001)(26005)(47776003)(51416003)(72206003)(305945005)(107886003)(7736002)(16586007)(55236004)(106356001)(2361001)(4326008)(66066001)(478600001)(446003)(50226002)(11346002)(68736007); DIR:OUT; SFP:1101; SCL:1; SRVR:CY4PR0701MB3633; 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; CY4PR0701MB3633; 23:X7S39VABj2u7co+vhS3ocidGhYyEgATGOKQ+8Ku?= =?us-ascii?Q?YZmrnKtmVDp/N98LQM/N3dtg9YMIVEz9xDJdABY2ZrWfoop2UP+Jt3yL9WXm?= =?us-ascii?Q?M+TwbWdKmINdToKdL2V6uAKPCfzq7FDzCkkR0ZcxVWb60KmSRZw3l0tyYgTe?= =?us-ascii?Q?HT3jo1/TvJkhjn09BJZjhhEmqqnzEIi96c+qIxHEIZubDfKsmVxB6aePMAXf?= =?us-ascii?Q?EWbMFCW7yRBB334rembvBulODTUrLRk6BcF3QX+0vj4LTFaVX4ASRKTmnoEv?= =?us-ascii?Q?u4q0gBjsiCZg0bly8ecq6oNaRltP4i7mdF5pJHkaFq1U94dDbO3btn6qSXdx?= =?us-ascii?Q?+p0uG/THotqVNUBmmkx/eQElKj0MFlOi371PLRrm1lNSQlnp7Soi+md6pbbQ?= =?us-ascii?Q?cLUNUFXIXRBMiPed3rF3wXREzQAU2Fu41Ul64ie1kxoCp+inkk/KTWoNvWPe?= =?us-ascii?Q?RycsJQBRrphRx1mfR/1WxJjiIPAj79egdc+RU98TMW1f3XCKMasqu1RSYLHo?= =?us-ascii?Q?qB63v5Zuml9INr31FUmQ3L47Rg4DAYjWK4VNwFu9WgxgtQljoowwWkWxdj5W?= =?us-ascii?Q?bBnDmUkC77rth63CNLbn0xBL4iO/1qti33DRmiGVvib0KZhB/vmuJ0pT60zZ?= =?us-ascii?Q?nkkenGVnzJJ1ATv3oWXUlGYLvmidzzfY9NRC3SVOL8q09MlLMXHhtwBom412?= =?us-ascii?Q?mx9cKWibNKl8s9DytJMGvscESmQEaJGTbL/i7GfaiLGCnOlHbDP72oONBSSA?= =?us-ascii?Q?is9Ka510Q2SizYBSl1+A4OriE7XVMzUCFZKiEpJ0OLYYAEY+tmNOMfGlD7cW?= =?us-ascii?Q?FUCd3lK9ukPdvIehmVHfb9ftFESdIONSn599/KF0DQCAJYS9eKATmCJqkBOq?= =?us-ascii?Q?ho+F5mbOSAF/gV/3L+cj+iNXd68fdJVPn1k4H0JMc8cn+HNpiBcAbpksZvIc?= =?us-ascii?Q?xDINWXoPVk3ughBuGbLDTOoo8ZDKGx39T80KWVNaxaUCgwscixTQ9HsUIknp?= =?us-ascii?Q?eho7C+3SWwMsvj5lT+4GzA1hzA959DNn1m5BpQ+nvylkh0sL6vq7r3kXA4r8?= =?us-ascii?Q?Rjl1BOeAH7042Qak1rZbMzu0ePPsN+tV+1Q5BDJiKoH2n9TQ9dE6GIUHpIqa?= =?us-ascii?Q?95qBySmtkjv8RgEiyyh1V14fJRi/+X3y97h4koyMyPaHzCgMM8IvPGeoVfem?= =?us-ascii?Q?owYM3H0NU/eGfRbIprf8BQTx8rNdcO0SySCF/LN5fGJLTCFeAdXehIWKYA/W?= =?us-ascii?Q?Y9+7VsuQKDxojVBh2jiKzs9TEj+7wUu0oI1c5/tK2T0wEE2k0pMZTrReybrn?= =?us-ascii?Q?bUOfuSTkjfyyfoXrqDmfUnPbbJqNLikMLdvS/TVSuGxFAnxcg+iRW4G2Oz2L?= =?us-ascii?Q?t/ufkjA=3D=3D?= X-Microsoft-Antispam-Message-Info: ORAMGF+hN7UWoRPkyEbMCmo7Qamq/idCmOvhl9Rm3sY1zpSQ+tXSMLao0rT8UK5xqbUrcx27z+UFwN4AcnUih0WFvKkmh83gh58nyGkdulhsHukXyce4xRj31XUG5fCG+Yj7wSGtwqWAtgBoMpF2p8/A1TD14o7rF6oZJIxnvCgH5tF6MIbCFvf7ptNZLjNi X-Microsoft-Exchange-Diagnostics: 1; CY4PR0701MB3633; 6:W9YPyXnbYNssYHTvsZ0/86Ut2B1aL8lKJ8LYVNXbQq0i6Xe0uDPGvUJ/bVE930h5GKLLcCr1z3iMmjr1TOqR5p4skkV3BWhtm8+nelsjV4Cx1UV9zbtC2z0+AGnCOafWKgkwlZyfZme8mLAOqr+GR5cajJ7DMB8noSwufB85TUgChE2GZW/wNd26e8B/BQRIIGePfnAipWJBLhgt7RL41tIRUbiiZ8qNrcu4kY8z8S6XVxQNp8hVDkRL2xS2DXC3qjKEIOQ7gVv/A/NnjKW3FY/NGXDT9zjoWaD5MxvbSJxXnLNY4ev85kqAfnsEImRrsmk9z6q1oCeo/vZ9Aw7GzVewNlUKKclD6gdN1xUegnHAmkO+ywNFIIXkoYR5T3UnI2bVcxXoPrwQtxch1I/MH1eSl2Ltuysin5jPUQyvqSNhBqTIGA4hs/7RRpWFckVx82VWuyQwD/hkyuxX3O4ISQ==; 5:whydjDpLFrRHkwFP1Qy+b4q+k4oag0DzoDWsqpLVRVYz57R0el8JBw7vgCREd7LZjZbFG7yZWGFV2+bxlsmmzSDrEH0ZNkTQNnz1/vPvkk5ETguaPSKY4miKDGLDtpPkYwyzMJSx6ODuyI51hCmWw/Ql6QCLeAm2HgzWCpDP6pU=; 24:6GG++7cogSU/Yy7asBwzn5+3cJ0tuM0I6WMVYH7KVYaLDEkQqc00SqhryYDEszE60InxkUlE8Gtq4wr/xgwni8jkIypf8YdsjdHiYngQWQc= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; CY4PR0701MB3633; 7:qY9l02r3gmhmgKeu93T68ydLcsNBjtWBk96hhzZRQL1ny6yuH2qqgYmjs2DNz80vrGlAtVxUQvg7TFfyNv7cvbn6YiUJxeK5xODyMxUFGfpFySkOk/2zVMsZWNJV/5JhkxOtaQzAIxN/UaP6L08CONlTMXY3Alcmu4CBCf6RUqjeYcYZO5GTFKKPEflCx/gIPKwpKuX0iiPfY9mZ0YeOj17lY2JGl7FUoHmLns5hGV6XfxAF0doE0x+6Go+54xWv X-MS-Office365-Filtering-Correlation-Id: 3db0bb1e-1a70-4db8-83f7-08d5cad02a4f X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 05 Jun 2018 10:36:12.6844 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 3db0bb1e-1a70-4db8-83f7-08d5cad02a4f X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 711e4ccf-2e9b-4bcf-a551-4094005b6194 X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY4PR0701MB3633 Subject: [dpdk-dev] [PATCH v1 6/7] doc: add octeontx zip PMD documentation 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, 05 Jun 2018 10:36:17 -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 | 116 ++++++++++++++++++++++++++ 3 files changed, 139 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..6ad5e31ce --- /dev/null +++ b/doc/guides/compressdevs/octeontx.rst @@ -0,0 +1,116 @@ +.. 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: + +* 32K + +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 the Physical Function of Octeontx ZIP 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 +------------ + +Config File Options +~~~~~~~~~~~~~~~~~~~ + +The following options can be modified in the ``config`` file. + +- ``CONFIG_RTE_LIBRTE_PMD_OCTEONTX_ZIPVF`` (default ``y``) + + Toggle compilation of the ``librte_pmd_octeontx_zip`` driver. + +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