X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Fmempool%2Focteontx.rst;h=51915af96aafddfc829a846a232b7192f4fee659;hb=6cc51b1293ceac4a77d4bf7ac91a8bbd59e1f78c;hp=39088ee278d9f097ee6a341995e5a2f2591011f8;hpb=a9263e3c5ad0b71adb95d686c1c3153865b0e1d2;p=dpdk.git diff --git a/doc/guides/mempool/octeontx.rst b/doc/guides/mempool/octeontx.rst index 39088ee278..51915af96a 100644 --- a/doc/guides/mempool/octeontx.rst +++ b/doc/guides/mempool/octeontx.rst @@ -1,11 +1,11 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright(c) 2017 Cavium, Inc -OCTEONTX FPAVF Mempool Driver -============================= +OCTEON TX FPAVF Mempool Driver +============================== -The OCTEONTX FPAVF PMD (**librte_mempool_octeontx**) is a mempool -driver for offload mempool device found in **Cavium OCTEONTX** SoC +The OCTEON TX FPAVF PMD (**librte_mempool_octeontx**) is a mempool +driver for offload mempool device found in **Cavium OCTEON TX** SoC family. More information can be found at `Cavium, Inc Official Website @@ -14,14 +14,14 @@ More information can be found at `Cavium, Inc Official Website Features -------- -Features of the OCTEONTX FPAVF PMD are: +Features of the OCTEON TX FPAVF PMD are: - 32 SR-IOV Virtual functions - 32 Pools - HW mempool manager -Supported OCTEONTX SoCs ------------------------ +Supported OCTEON TX SoCs +------------------------ - CN83xx @@ -36,37 +36,23 @@ Pre-Installation Configuration Config File Options ~~~~~~~~~~~~~~~~~~~ -The following options can be modified in the ``config`` file. +The following option can be modified in the ``config/rte_config.h`` file. Please note that enabling debugging options may affect system performance. -- ``CONFIG_RTE_MBUF_DEFAULT_MEMPOOL_OPS`` ( set to ``octeontx_fpavf``) +- ``RTE_MBUF_DEFAULT_MEMPOOL_OPS`` ( set to ``octeontx_fpavf``) Set default mempool ops to octeontx_fpavf. -- ``CONFIG_RTE_LIBRTE_OCTEONTX_MEMPOOL`` (default ``y``) - - Toggle compilation of the ``librte_mempool_octeontx`` driver. - -- ``CONFIG_RTE_LIBRTE_OCTEONTX_MEMPOOL_DEBUG`` (default ``n``) - - Toggle display of generic debugging messages - Driver Compilation ~~~~~~~~~~~~~~~~~~ -To compile the OCTEONTX FPAVF MEMPOOL PMD for Linux arm64 gcc target, run the -following ``make`` command: - -.. code-block:: console - - cd - make config T=arm64-thunderx-linuxapp-gcc test-build +See :doc:`../linux_gsg/build_dpdk` for more information on compiling DPDK. Initialization -------------- -The octeontx fpavf mempool initialization similar to other mempool +The OCTEON TX fpavf mempool initialization similar to other mempool drivers like ring. However user need to pass --base-virtaddr as command line input to application example test_mempool.c application. @@ -74,5 +60,5 @@ Example: .. code-block:: console - ./build/app/test -c 0xf --base-virtaddr=0x100000000000 \ + .//app/test/dpdk-test -c 0xf --base-virtaddr=0x100000000000 \ --mbuf-pool-ops-name="octeontx_fpavf"