doc/guides/mempool/octeontx.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2017 Cavium, Inc
   3
   4 OCTEON TX FPAVF Mempool Driver
   5 ==============================
   6
   7 The OCTEON TX FPAVF PMD (**librte_mempool_octeontx**) is a mempool
   8 driver for offload mempool device found in **Cavium OCTEON TX** SoC
   9 family.
  10
  11 More information can be found at `Cavium, Inc Official Website
  12 <http://www.cavium.com/OCTEON-TX_ARM_Processors.html>`_.
  13
  14 Features
  15 --------
  16
  17 Features of the OCTEON TX FPAVF PMD are:
  18
  19 - 32 SR-IOV Virtual functions
  20 - 32 Pools
  21 - HW mempool manager
  22
  23 Supported OCTEON TX SoCs
  24 ------------------------
  25
  26 - CN83xx
  27
  28 Prerequisites
  29 -------------
  30
  31 See :doc: `../platform/octeontx.rst` for setup information.
  32
  33 Pre-Installation Configuration
  34 ------------------------------
  35
  36 Config File Options
  37 ~~~~~~~~~~~~~~~~~~~
  38
  39 The following option can be modified in the ``config/rte_config.h`` file.
  40 Please note that enabling debugging options may affect system performance.
  41
  42 - ``RTE_MBUF_DEFAULT_MEMPOOL_OPS`` ( set to ``octeontx_fpavf``)
  43
  44   Set default mempool ops to octeontx_fpavf.
  45
  46 Driver Compilation
  47 ~~~~~~~~~~~~~~~~~~
  48
  49 See :doc:`../linux_gsg/build_dpdk` for more information on compiling DPDK.
  50
  51
  52 Initialization
  53 --------------
  54
  55 The OCTEON TX fpavf mempool initialization similar to other mempool
  56 drivers like ring. However user need to pass --base-virtaddr as
  57 command line input to application example test_mempool.c application.
  58
  59 Example:
  60
  61 .. code-block:: console
  62
  63     ./<build_dir>/app/test/dpdk-test -c 0xf --base-virtaddr=0x100000000000 \
  64                         --mbuf-pool-ops-name="octeontx_fpavf"