doc/guides/mempool/octeontx.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2017 Cavium, Inc
   3
   4 OCTEONTX FPAVF Mempool Driver
   5 =============================
   6
   7 The OCTEONTX FPAVF PMD (**librte_mempool_octeontx**) is a mempool
   8 driver for offload mempool device found in **Cavium OCTEONTX** 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 OCTEONTX FPAVF PMD are:
  18
  19 - 32 SR-IOV Virtual functions
  20 - 32 Pools
  21 - HW mempool manager
  22
  23 Supported OCTEONTX 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 options can be modified in the ``config`` file.
  40 Please note that enabling debugging options may affect system performance.
  41
  42 - ``CONFIG_RTE_MBUF_DEFAULT_MEMPOOL_OPS`` ( set to ``octeontx_fpavf``)
  43
  44   Set default mempool ops to octeontx_fpavf.
  45
  46 - ``CONFIG_RTE_LIBRTE_OCTEONTX_MEMPOOL`` (default ``y``)
  47
  48   Toggle compilation of the ``librte_mempool_octeontx`` driver.
  49
  50 - ``CONFIG_RTE_LIBRTE_OCTEONTX_MEMPOOL_DEBUG`` (default ``n``)
  51
  52   Toggle display of generic debugging messages
  53
  54 Driver Compilation
  55 ~~~~~~~~~~~~~~~~~~
  56
  57 To compile the OCTEONTX FPAVF MEMPOOL PMD for Linux arm64 gcc target, run the
  58 following ``make`` command:
  59
  60 .. code-block:: console
  61
  62    cd <DPDK-source-directory>
  63    make config T=arm64-thunderx-linuxapp-gcc test-build
  64
  65
  66 Initialization
  67 --------------
  68
  69 The octeontx fpavf mempool initialization similar to other mempool
  70 drivers like ring. However user need to pass --base-virtaddr as
  71 command line input to application example test_mempool.c application.
  72
  73 Example:
  74
  75 .. code-block:: console
  76
  77     ./build/app/test -c 0xf --base-virtaddr=0x100000000000 \
  78                         --mbuf-pool-ops-name="octeontx_fpavf"