From 8d01b9cd70a67cdafd5b965a70420c3bd7fb3f82 Mon Sep 17 00:00:00 2001 From: Luca Boccassi Date: Thu, 1 Nov 2018 11:59:50 +0000 Subject: New upstream version 18.11-rc1 Change-Id: Iaa71986dd6332e878d8f4bf493101b2bbc6313bb Signed-off-by: Luca Boccassi --- doc/guides/compressdevs/features/octeontx.ini | 2 +- doc/guides/compressdevs/features/qat.ini | 1 + doc/guides/compressdevs/octeontx.rst | 24 ++++++++++++------------ doc/guides/compressdevs/qat_comp.rst | 11 ++++------- 4 files changed, 18 insertions(+), 20 deletions(-) (limited to 'doc/guides/compressdevs') diff --git a/doc/guides/compressdevs/features/octeontx.ini b/doc/guides/compressdevs/features/octeontx.ini index 884a8b07..cc8b0256 100644 --- a/doc/guides/compressdevs/features/octeontx.ini +++ b/doc/guides/compressdevs/features/octeontx.ini @@ -1,7 +1,7 @@ ; ; Refer to default.ini for the full list of available PMD features. ; -; Supported features of 'OCTEONTX ZIP' compression driver. +; Supported features of 'OCTEON TX ZIP' compression driver. ; [Features] HW Accelerated = Y diff --git a/doc/guides/compressdevs/features/qat.ini b/doc/guides/compressdevs/features/qat.ini index 5cd4524b..6b1e7f93 100644 --- a/doc/guides/compressdevs/features/qat.ini +++ b/doc/guides/compressdevs/features/qat.ini @@ -13,3 +13,4 @@ Adler32 = Y Crc32 = Y Adler32&Crc32 = Y Fixed = Y +Dynamic = Y diff --git a/doc/guides/compressdevs/octeontx.rst b/doc/guides/compressdevs/octeontx.rst index 5a32d5d1..05dbd681 100644 --- a/doc/guides/compressdevs/octeontx.rst +++ b/doc/guides/compressdevs/octeontx.rst @@ -1,12 +1,12 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2018 Cavium Networks. -Octeontx ZIP Compression Poll Mode Driver -========================================= +OCTEON TX ZIP Compression Poll Mode Driver +========================================== -The Octeontx ZIP PMD (**librte_pmd_octeontx_zip**) provides poll mode +The OCTEON TX ZIP PMD (**librte_pmd_octeontx_zip**) provides poll mode compression & decompression driver for ZIP HW offload device, found in -**Cavium OCTEONTX** SoC family. +**Cavium OCTEON TX** SoC family. More information can be found at `Cavium, Inc Official Website `_. @@ -14,7 +14,7 @@ More information can be found at `Cavium, Inc Official Website Features -------- -Octeontx ZIP PMD has support for: +OCTEON TX ZIP PMD has support for: Compression/Decompression algorithm: @@ -34,24 +34,24 @@ Limitations * Chained mbufs are not supported. -Supported OCTEONTX SoCs ------------------------ +Supported OCTEON TX SoCs +------------------------ - CN83xx Steps To Setup Platform ----------------------- - Octeontx SDK includes kernel image which provides Octeontx ZIP PF + OCTEON TX SDK includes kernel image which provides OCTEON TX 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 + #rpm -ivh OCTEONTX-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 + For more information on building and booting linux kernel on OCTEON TX 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 `_. @@ -62,7 +62,7 @@ Installation Driver Compilation ~~~~~~~~~~~~~~~~~~ -To compile the OCTEONTX ZIP PMD for Linux arm64 gcc target, run the +To compile the OCTEON TX ZIP PMD for Linux arm64 gcc target, run the following ``make`` command: .. code-block:: console @@ -74,7 +74,7 @@ following ``make`` command: Initialization -------------- -The octeontx zip is exposed as pci device which consists of a set of +The OCTEON TX 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: diff --git a/doc/guides/compressdevs/qat_comp.rst b/doc/guides/compressdevs/qat_comp.rst index 8b1270b7..aee3b99b 100644 --- a/doc/guides/compressdevs/qat_comp.rst +++ b/doc/guides/compressdevs/qat_comp.rst @@ -18,11 +18,7 @@ QAT compression PMD has support for: Compression/Decompression algorithm: - * DEFLATE - -Huffman code type: - - * FIXED + * DEFLATE - using Fixed and Dynamic Huffman encoding Window size support: @@ -36,12 +32,13 @@ Limitations ----------- * Compressdev level 0, no compression, is not supported. +* Queue pairs are not thread-safe (that is, within a single queue pair, RX and TX from different lcores is not supported). +* No BSD support as BSD QAT kernel driver not available. -* Dynamic Huffman encoding is not yet supported. Installation ------------ The QAT compression PMD is built by default with a standard DPDK build. -It depends on a QAT kernel driver, see :ref:`qat_kernel_installation`. +It depends on a QAT kernel driver, see :ref:`building_qat`. -- cgit 1.2.3-korg