From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by dpdk.space (Postfix) with ESMTP id 60C8CA0471 for ; Mon, 17 Jun 2019 18:01:52 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 31A5D1BFBD; Mon, 17 Jun 2019 17:57:39 +0200 (CEST) Received: from mx0b-0016f401.pphosted.com (mx0b-0016f401.pphosted.com [67.231.156.173]) by dpdk.org (Postfix) with ESMTP id 06E1C1BFA6 for ; Mon, 17 Jun 2019 17:57:14 +0200 (CEST) Received: from pps.filterd (m0045851.ppops.net [127.0.0.1]) by mx0b-0016f401.pphosted.com (8.16.0.27/8.16.0.27) with SMTP id x5HFpuhH001280; Mon, 17 Jun 2019 08:57:14 -0700 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.com; h=from : to : cc : subject : date : message-id : in-reply-to : references : mime-version : content-transfer-encoding : content-type; s=pfpt0818; bh=tUWITAyRLaL+6Ua2izqdvapXTtH0OAXXvmTUiqOVkUQ=; b=Yp6Wv61xKny7wID6iLGhmJ0TzbgkP3h2VcnEO52UCZteVuY0NBsrab1UUp+1IfQBLuKK pNaXWdasPaSZyivr9r8QcaD164C1nvXZ7lZdbnrK+vc6tSK0Sx/nu4B/lPqwKM/v083w IxJrn0+CIeJ6CueeXFmzJquG1yRQPpkRmh1lUZnI7FgOQH5jvFYdPBpjmNTiJ8WptxCs jLiJHOJGovrOmBGBfDUic5d772VXw6+fIEcfHSemSyOqd/fGYT757hHiEJX69S7w2a4v YTqPL2vuCVO8DFg2G85jAppe1dHVfS2Y6nKZhGrLmrJlVW7MsNfimogaD199mqVdgrI0 nw== Received: from sc-exch03.marvell.com ([199.233.58.183]) by mx0b-0016f401.pphosted.com with ESMTP id 2t506hyb4c-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT); Mon, 17 Jun 2019 08:57:14 -0700 Received: from SC-EXCH01.marvell.com (10.93.176.81) by SC-EXCH03.marvell.com (10.93.176.83) with Microsoft SMTP Server (TLS) id 15.0.1367.3; Mon, 17 Jun 2019 08:57:12 -0700 Received: from maili.marvell.com (10.93.176.43) by SC-EXCH01.marvell.com (10.93.176.81) with Microsoft SMTP Server id 15.0.1367.3 via Frontend Transport; Mon, 17 Jun 2019 08:57:12 -0700 Received: from jerin-lab.marvell.com (jerin-lab.marvell.com [10.28.34.14]) by maili.marvell.com (Postfix) with ESMTP id B299F3F703F; Mon, 17 Jun 2019 08:57:09 -0700 (PDT) From: To: , Thomas Monjalon , John McNamara , Marko Kovacevic , "Jerin Jacob" , Nithin Dabilpuram , Vamsi Attunuru CC: Vivek Sharma Date: Mon, 17 Jun 2019 21:25:37 +0530 Message-ID: <20190617155537.36144-28-jerinj@marvell.com> X-Mailer: git-send-email 2.21.0 In-Reply-To: <20190617155537.36144-1-jerinj@marvell.com> References: <20190601014905.45531-1-jerinj@marvell.com> <20190617155537.36144-1-jerinj@marvell.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Content-Type: text/plain X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10434:, , definitions=2019-06-17_07:, , signatures=0 Subject: [dpdk-dev] [PATCH v3 27/27] doc: add Marvell OCTEON TX2 mempool documentation X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" From: Jerin Jacob Add Marvell OCTEON TX2 mempool documentation. This patch also updates the MAINTAINERS file and updates shared library versions in release_19_08.rst. Cc: John McNamara Cc: Thomas Monjalon Signed-off-by: Jerin Jacob Signed-off-by: Vivek Sharma Signed-off-by: Vamsi Attunuru Signed-off-by: Nithin Dabilpuram --- MAINTAINERS | 10 +++ doc/guides/mempool/index.rst | 1 + doc/guides/mempool/octeontx2.rst | 90 ++++++++++++++++++++++++++ doc/guides/platform/octeontx2.rst | 2 + doc/guides/rel_notes/release_19_08.rst | 2 + 5 files changed, 105 insertions(+) create mode 100644 doc/guides/mempool/octeontx2.rst diff --git a/MAINTAINERS b/MAINTAINERS index 0212fe6d0..4ea759197 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -444,6 +444,16 @@ M: Artem V. Andreev M: Andrew Rybchenko F: drivers/mempool/bucket/ +Marvell OCTEON TX2 +M: Jerin Jacob +M: Nithin Dabilpuram +M: Vamsi Attunuru +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 2ccf91633..756610264 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 000000000..2c9a0953b --- /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 3a5e03050..c9ea45647 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 --------------------------- diff --git a/doc/guides/rel_notes/release_19_08.rst b/doc/guides/rel_notes/release_19_08.rst index 8c3932d06..118d8fbe6 100644 --- a/doc/guides/rel_notes/release_19_08.rst +++ b/doc/guides/rel_notes/release_19_08.rst @@ -171,6 +171,7 @@ The libraries prepended with a plus sign were incremented in this version. librte_cfgfile.so.2 librte_cmdline.so.2 librte_compressdev.so.1 + + librte_common_octeontx2.so.1 librte_cryptodev.so.7 librte_distributor.so.1 librte_eal.so.10 @@ -191,6 +192,7 @@ The libraries prepended with a plus sign were incremented in this version. librte_mbuf.so.5 librte_member.so.1 librte_mempool.so.5 + + librte_mempool_octeontx2.so.1 librte_meter.so.3 librte_metrics.so.1 librte_net.so.1 -- 2.21.0