1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2017 Cavium, Inc
4 OCTEON TX FPAVF Mempool Driver
5 ==============================
7 The OCTEON TX FPAVF PMD (**librte_mempool_octeontx**) is a mempool
8 driver for offload mempool device found in **Cavium OCTEON TX** SoC
11 More information can be found at `Cavium, Inc Official Website
12 <http://www.cavium.com/OCTEON-TX_ARM_Processors.html>`_.
17 Features of the OCTEON TX FPAVF PMD are:
19 - 32 SR-IOV Virtual functions
23 Supported OCTEON TX SoCs
24 ------------------------
31 See :doc: `../platform/octeontx.rst` for setup information.
33 Pre-Installation Configuration
34 ------------------------------
39 The following options can be modified in the ``config`` file.
40 Please note that enabling debugging options may affect system performance.
42 - ``CONFIG_RTE_MBUF_DEFAULT_MEMPOOL_OPS`` ( set to ``octeontx_fpavf``)
44 Set default mempool ops to octeontx_fpavf.
46 - ``CONFIG_RTE_LIBRTE_OCTEONTX_MEMPOOL`` (default ``y``)
48 Toggle compilation of the ``librte_mempool_octeontx`` driver.
53 To compile the OCTEON TX FPAVF MEMPOOL PMD for Linux arm64 gcc target, run the
54 following ``make`` command:
56 .. code-block:: console
58 cd <DPDK-source-directory>
59 make config T=arm64-thunderx-linux-gcc
65 The OCTEON TX fpavf mempool initialization similar to other mempool
66 drivers like ring. However user need to pass --base-virtaddr as
67 command line input to application example test_mempool.c application.
71 .. code-block:: console
73 ./build/app/test -c 0xf --base-virtaddr=0x100000000000 \
74 --mbuf-pool-ops-name="octeontx_fpavf"