1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(C) 2021 Marvell.
4 cnxk NPA Mempool Driver
5 =======================
7 The cnxk NPA PMD (**librte_mempool_cnxk**) provides mempool driver support for
8 the integrated mempool device found in **Marvell OCTEON CN9K/CN10K** SoC family.
10 More information about cnxk SoC can be found at `Marvell Official Website
11 <https://www.marvell.com/embedded-processors/infrastructure-processors/>`_.
16 cnxk NPA PMD supports:
21 - Ethdev Rx buffer allocation in HW to save CPU cycles in the Rx path.
22 - Ethdev Tx buffer recycling in HW to save CPU cycles in the Tx path.
24 Prerequisites and Compilation procedure
25 ---------------------------------------
27 See :doc:`../platform/cnxk` for setup information.
29 Pre-Installation Configuration
30 ------------------------------
33 Runtime Config Options
34 ~~~~~~~~~~~~~~~~~~~~~~
36 - ``Maximum number of mempools per application`` (default ``128``)
38 The maximum number of mempools per application needs to be configured on
39 HW during mempool driver initialization. HW can support up to 1M mempools,
40 Since each mempool costs set of HW resources, the ``max_pools`` ``devargs``
41 parameter is being introduced to configure the number of mempools required
45 -a 0002:02:00.0,max_pools=512
47 With the above configuration, the driver will set up only 512 mempools for
48 the given application to save HW resources.
52 Since this configuration is per application, the end user needs to
53 provide ``max_pools`` parameter to the first PCIe device probed by the given
59 .. _table_cnxk_mempool_debug_options:
61 .. table:: cnxk mempool debug options
63 +---+------------+-------------------------------------------------------+
64 | # | Component | EAL log command |
65 +===+============+=======================================================+
66 | 1 | NPA | --log-level='pmd\.mempool.cnxk,8' |
67 +---+------------+-------------------------------------------------------+
69 Standalone mempool device
70 ~~~~~~~~~~~~~~~~~~~~~~~~~
72 The ``usertools/dpdk-devbind.py`` script shall enumerate all the mempool
73 devices available in the system. In order to avoid, the end user to bind the
74 mempool device prior to use ethdev and/or eventdev device, the respective
75 driver configures an NPA LF and attach to the first probed ethdev or eventdev
76 device. In case, if end user need to run mempool as a standalone device
77 (without ethdev or eventdev), end user needs to bind a mempool device using
78 ``usertools/dpdk-devbind.py``