From 41267f7642a9ee3e82a9452984188440e12f7006 Mon Sep 17 00:00:00 2001 From: Jerin Jacob Date: Sat, 22 Jun 2019 18:54:17 +0530 Subject: [PATCH] doc: add Marvell OCTEON TX2 mempool guide Add Marvell OCTEON TX2 mempool documentation. Signed-off-by: Jerin Jacob Signed-off-by: Vivek Sharma Signed-off-by: Vamsi Attunuru Signed-off-by: Nithin Dabilpuram --- MAINTAINERS | 1 + doc/guides/mempool/index.rst | 1 + doc/guides/mempool/octeontx2.rst | 90 +++++++++++++++++++++++++++++++ doc/guides/platform/octeontx2.rst | 2 + 4 files changed, 94 insertions(+) create mode 100644 doc/guides/mempool/octeontx2.rst diff --git a/MAINTAINERS b/MAINTAINERS index 905f79ac6b..55b8c90da1 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -453,6 +453,7 @@ F: drivers/common/octeontx2/ F: drivers/mempool/octeontx2/ F: doc/guides/platform/img/octeontx2_* F: doc/guides/platform/octeontx2.rst +F: doc/guides/mempool/octeontx2.rst Bus Drivers diff --git a/doc/guides/mempool/index.rst b/doc/guides/mempool/index.rst index 2ccf91633c..756610264a 100644 --- a/doc/guides/mempool/index.rst +++ b/doc/guides/mempool/index.rst @@ -12,3 +12,4 @@ application through the mempool API. :numbered: octeontx + octeontx2 diff --git a/doc/guides/mempool/octeontx2.rst b/doc/guides/mempool/octeontx2.rst new file mode 100644 index 0000000000..2c9a0953b1 --- /dev/null +++ b/doc/guides/mempool/octeontx2.rst @@ -0,0 +1,90 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2019 Marvell International Ltd. + +OCTEON TX2 NPA Mempool Driver +============================= + +The OCTEON TX2 NPA PMD (**librte_mempool_octeontx2**) provides mempool +driver support for the integrated mempool device found in **Marvell OCTEON TX2** SoC family. + +More information about OCTEON TX2 SoC can be found at `Marvell Official Website +`_. + +Features +-------- + +OCTEON TX2 NPA PMD supports: + +- Up to 128 NPA LFs +- 1M Pools per LF +- HW mempool manager +- Ethdev Rx buffer allocation in HW to save CPU cycles in the Rx path. +- Ethdev Tx buffer recycling in HW to save CPU cycles in the Tx path. + +Prerequisites and Compilation procedure +--------------------------------------- + + See :doc:`../platform/octeontx2` for setup information. + +Pre-Installation Configuration +------------------------------ + +Compile time Config Options +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The following option can be modified in the ``config`` file. + +- ``CONFIG_RTE_LIBRTE_OCTEONTX2_MEMPOOL`` (default ``y``) + + Toggle compilation of the ``librte_mempool_octeontx2`` driver. + +Runtime Config Options +~~~~~~~~~~~~~~~~~~~~~~ + +- ``Maximum number of mempools per application`` (default ``128``) + + The maximum number of mempools per application needs to be configured on + HW during mempool driver initialization. HW can support up to 1M mempools, + Since each mempool costs set of HW resources, the ``max_pools`` ``devargs`` + parameter is being introduced to configure the number of mempools required + for the application. + For example:: + + -w 0002:02:00.0,max_pools=512 + + With the above configuration, the driver will set up only 512 mempools for + the given application to save HW resources. + +.. note:: + + Since this configuration is per application, the end user needs to + provide ``max_pools`` parameter to the first PCIe device probed by the given + application. + +Debugging Options +~~~~~~~~~~~~~~~~~ + +.. _table_octeontx2_mempool_debug_options: + +.. table:: OCTEON TX2 mempool debug options + + +---+------------+-------------------------------------------------------+ + | # | Component | EAL log command | + +===+============+=======================================================+ + | 1 | NPA | --log-level='pmd\.mempool.octeontx2,8' | + +---+------------+-------------------------------------------------------+ + +Standalone mempool device +~~~~~~~~~~~~~~~~~~~~~~~~~ + + The ``usertools/dpdk-devbind.py`` script shall enumerate all the mempool devices + available in the system. In order to avoid, the end user to bind the mempool + device prior to use ethdev and/or eventdev device, the respective driver + configures an NPA LF and attach to the first probed ethdev or eventdev device. + In case, if end user need to run mempool as a standalone device + (without ethdev or eventdev), end user needs to bind a mempool device using + ``usertools/dpdk-devbind.py`` + + Example command to run ``mempool_autotest`` test with standalone OCTEONTX2 NPA device:: + + echo "mempool_autotest" | build/app/test -c 0xf0 --mbuf-pool-ops-name="octeontx2_npa" diff --git a/doc/guides/platform/octeontx2.rst b/doc/guides/platform/octeontx2.rst index 3a5e030508..c9ea456478 100644 --- a/doc/guides/platform/octeontx2.rst +++ b/doc/guides/platform/octeontx2.rst @@ -98,6 +98,8 @@ HW Offload Drivers This section lists dataplane H/W block(s) available in OCTEON TX2 SoC. +#. **Mempool Driver** + See :doc:`../mempool/octeontx2` for NPA mempool driver information. Procedure to Setup Platform --------------------------- -- 2.20.1