X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fcompressdevs%2Focteontx.rst;h=5924ad1fa3db20a81cdb476eed7421a216217678;hb=b176cb32b5582b96abc060c0064c5122a1b7d3be;hp=5a32d5d1bbdf55ca91697aeb1d8dae6b546a39a8;hpb=f23c977d0362dd428f396d6ba932ad02cd47443c;p=dpdk.git diff --git a/doc/guides/compressdevs/octeontx.rst b/doc/guides/compressdevs/octeontx.rst index 5a32d5d1bb..5924ad1fa3 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,19 +62,19 @@ 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 cd - make config T=arm64-thunderx-linuxapp-gcc install + make config T=arm64-thunderx-linux-gcc install 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: @@ -97,9 +97,9 @@ probed. To use the PMD in an application, user must: reserve enough huge pages cd to the top-level DPDK directory - export RTE_TARGET=arm64-thunderx-linuxapp-gcc + export RTE_TARGET=arm64-thunderx-linux-gcc export RTE_SDK=`pwd` - cd to test/test + cd to app/test type the command "make" to compile run the tests with "./test" type the command "compressdev_autotest" to test