numam-dpdk/doc/guides/mempool/octeontx.rst
Ciara Power a3b34b1df8 doc: remove references to make from mempool guide
Make is no longer supported for compiling DPDK, references are now
removed in the documentation.

Signed-off-by: Ciara Power <ciara.power@intel.com>
Reviewed-by: Kevin Laatz <kevin.laatz@intel.com>
2020-10-22 22:54:05 +02:00

65 lines
1.5 KiB
ReStructuredText

.. SPDX-License-Identifier: BSD-3-Clause
Copyright(c) 2017 Cavium, Inc
OCTEON TX FPAVF Mempool Driver
==============================
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
<http://www.cavium.com/OCTEON-TX_ARM_Processors.html>`_.
Features
--------
Features of the OCTEON TX FPAVF PMD are:
- 32 SR-IOV Virtual functions
- 32 Pools
- HW mempool manager
Supported OCTEON TX SoCs
------------------------
- CN83xx
Prerequisites
-------------
See :doc: `../platform/octeontx.rst` for setup information.
Pre-Installation Configuration
------------------------------
Config File Options
~~~~~~~~~~~~~~~~~~~
The following option can be modified in the ``config/rte_config.h`` file.
Please note that enabling debugging options may affect system performance.
- ``RTE_MBUF_DEFAULT_MEMPOOL_OPS`` ( set to ``octeontx_fpavf``)
Set default mempool ops to octeontx_fpavf.
Driver Compilation
~~~~~~~~~~~~~~~~~~
See :doc:`../linux_gsg/build_dpdk` for more information on compiling DPDK.
Initialization
--------------
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.
Example:
.. code-block:: console
./<build_dir>/app/test/dpdk-test -c 0xf --base-virtaddr=0x100000000000 \
--mbuf-pool-ops-name="octeontx_fpavf"