Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/53645/?format=api
{ "id": 53645, "url": "http://patches.dpdk.org/api/patches/53645/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/patch/20190523081339.56348-28-jerinj@marvell.com/", "project": { "id": 1, "url": "http://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<20190523081339.56348-28-jerinj@marvell.com>", "list_archive_url": "https://inbox.dpdk.org/dev/20190523081339.56348-28-jerinj@marvell.com", "date": "2019-05-23T08:13:39", "name": "[v1,27/27] doc: add Marvell OCTEON TX2 mempool documentation", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "40307b9a7c0efd1aea0b7762cd9b3cfbf85f116e", "submitter": { "id": 1188, "url": "http://patches.dpdk.org/api/people/1188/?format=api", "name": "Jerin Jacob Kollanukkaran", "email": "jerinj@marvell.com" }, "delegate": null, "mbox": "http://patches.dpdk.org/project/dpdk/patch/20190523081339.56348-28-jerinj@marvell.com/mbox/", "series": [ { "id": 4754, "url": "http://patches.dpdk.org/api/series/4754/?format=api", "web_url": "http://patches.dpdk.org/project/dpdk/list/?series=4754", "date": "2019-05-23T08:13:12", "name": "OCTEON TX2 common and mempool driver", "version": 1, "mbox": "http://patches.dpdk.org/series/4754/mbox/" } ], "comments": "http://patches.dpdk.org/api/patches/53645/comments/", "check": "fail", "checks": "http://patches.dpdk.org/api/patches/53645/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@dpdk.org", "Delivered-To": "patchwork@dpdk.org", "Received": [ "from [92.243.14.124] (localhost [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id C81B21B9B1;\n\tThu, 23 May 2019 10:16:56 +0200 (CEST)", "from mx0b-0016f401.pphosted.com (mx0a-0016f401.pphosted.com\n\t[67.231.148.174]) by dpdk.org (Postfix) with ESMTP id 1BC051B949\n\tfor <dev@dpdk.org>; Thu, 23 May 2019 10:16:50 +0200 (CEST)", "from pps.filterd (m0045849.ppops.net [127.0.0.1])\n\tby mx0a-0016f401.pphosted.com (8.16.0.27/8.16.0.27) with SMTP id\n\tx4N8F29t021710; Thu, 23 May 2019 01:16:50 -0700", "from sc-exch01.marvell.com ([199.233.58.181])\n\tby mx0a-0016f401.pphosted.com with ESMTP id 2sneqj28r6-4\n\t(version=TLSv1.2 cipher=ECDHE-RSA-AES256-SHA384 bits=256 verify=NOT); \n\tThu, 23 May 2019 01:16:50 -0700", "from SC-EXCH01.marvell.com (10.93.176.81) by SC-EXCH01.marvell.com\n\t(10.93.176.81) with Microsoft SMTP Server (TLS) id 15.0.1367.3;\n\tThu, 23 May 2019 01:16:23 -0700", "from maili.marvell.com (10.93.176.43) by SC-EXCH01.marvell.com\n\t(10.93.176.81) with Microsoft SMTP Server id 15.0.1367.3 via Frontend\n\tTransport; Thu, 23 May 2019 01:16:23 -0700", "from jerin-lab.marvell.com (unknown [10.28.34.14])\n\tby maili.marvell.com (Postfix) with ESMTP id B92D03F703F;\n\tThu, 23 May 2019 01:16:21 -0700 (PDT)" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed; d=marvell.com;\n\th=from : to : cc :\n\tsubject : date : message-id : in-reply-to : references : mime-version\n\t: content-transfer-encoding : content-type; s=pfpt0818;\n\tbh=KHrifcjNfcNRoh8lFalBBg7Ac8BLb89LpSfPreDPLaM=;\n\tb=fEJyDoJ26CmJpiJ4kcf7IIB+lycp6dNpIy6lbItE5bore4xcJWFeET7ZbVG8LV5B1ZcF\n\tjsg3y9hwU9VemW3xHaGEWkNNF035hhYwVaywgE9Bzgb42/1aLOFjkplD9rcNLvaRYmzD\n\tMcS46ZbQk1D/r8mwJyJWkjhhJsMxQO6lRtsLF67fK5oGqrhtr8E79xqD2xEVlHVz+fOu\n\tO175mHAJgJp3tyhJF7Cm7J2telEzqMilb1DCpzlW8SIHD0PqtoK9iCpo5cD5gUyOFL3R\n\tal0cfzyWcjAjqnCHg2+qcWdZfpqJsX+3wp/MY2EQ/1pb7cpsIvnKHtTaMHk2rt3Kwzgj\n\t+g== ", "From": "<jerinj@marvell.com>", "To": "<dev@dpdk.org>, Thomas Monjalon <thomas@monjalon.net>, John McNamara\n\t<john.mcnamara@intel.com>, Marko Kovacevic <marko.kovacevic@intel.com>", "CC": "Jerin Jacob <jerinj@marvell.com>, Vivek Sharma <viveksharma@marvell.com>,\n\tVamsi Attunuru <vattunuru@marvell.com>, Nithin Dabilpuram\n\t<ndabilpuram@marvell.com>", "Date": "Thu, 23 May 2019 13:43:39 +0530", "Message-ID": "<20190523081339.56348-28-jerinj@marvell.com>", "X-Mailer": "git-send-email 2.21.0", "In-Reply-To": "<20190523081339.56348-1-jerinj@marvell.com>", "References": "<20190523081339.56348-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:, ,\n\tdefinitions=2019-05-23_08:, , signatures=0", "Subject": "[dpdk-dev] [PATCH v1 27/27] doc: add Marvell OCTEON TX2 mempool\n\tdocumentation", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n\t<mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://mails.dpdk.org/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n\t<mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "From: Jerin Jacob <jerinj@marvell.com>\n\nAdd Marvell OCTEON TX2 mempool documentation.\n\nThis patch also updates the MAINTAINERS file and\nupdates shared library versions in release_19_08.rst.\n\nCc: John McNamara <john.mcnamara@intel.com>\nCc: Thomas Monjalon <thomas@monjalon.net>\n\nSigned-off-by: Jerin Jacob <jerinj@marvell.com>\nSigned-off-by: Vivek Sharma <viveksharma@marvell.com>\nSigned-off-by: Vamsi Attunuru <vattunuru@marvell.com>\nSigned-off-by: Nithin Dabilpuram <ndabilpuram@marvell.com>\n---\n MAINTAINERS | 10 +++\n doc/guides/mempool/index.rst | 1 +\n doc/guides/mempool/octeontx2.rst | 90 ++++++++++++++++++++++++++\n doc/guides/platform/octeontx2.rst | 2 +\n doc/guides/rel_notes/release_19_08.rst | 2 +\n 5 files changed, 105 insertions(+)\n create mode 100644 doc/guides/mempool/octeontx2.rst", "diff": "diff --git a/MAINTAINERS b/MAINTAINERS\nindex 15d0829c5..74ac6d41f 100644\n--- a/MAINTAINERS\n+++ b/MAINTAINERS\n@@ -444,6 +444,16 @@ M: Artem V. Andreev <artem.andreev@oktetlabs.ru>\n M: Andrew Rybchenko <arybchenko@solarflare.com>\n F: drivers/mempool/bucket/\n \n+Marvell OCTEON TX2\n+M: Jerin Jacob <jerinj@marvell.com>\n+M: Nithin Dabilpuram <ndabilpuram@marvell.com>\n+M: Vamsi Attunuru <vattunuru@marvell.com>\n+F: drivers/common/octeontx2/\n+F: drivers/mempool/octeontx2/\n+F: doc/guides/platform/img/octeontx2_*\n+F: doc/guides/platform/octeontx2.rst\n+F: doc/guides/mempool/octeontx2.rst\n+\n \n Bus Drivers\n -----------\ndiff --git a/doc/guides/mempool/index.rst b/doc/guides/mempool/index.rst\nindex 2ccf91633..756610264 100644\n--- a/doc/guides/mempool/index.rst\n+++ b/doc/guides/mempool/index.rst\n@@ -12,3 +12,4 @@ application through the mempool API.\n :numbered:\n \n octeontx\n+ octeontx2\ndiff --git a/doc/guides/mempool/octeontx2.rst b/doc/guides/mempool/octeontx2.rst\nnew file mode 100644\nindex 000000000..2c9a0953b\n--- /dev/null\n+++ b/doc/guides/mempool/octeontx2.rst\n@@ -0,0 +1,90 @@\n+.. SPDX-License-Identifier: BSD-3-Clause\n+ Copyright(c) 2019 Marvell International Ltd.\n+\n+OCTEON TX2 NPA Mempool Driver\n+=============================\n+\n+The OCTEON TX2 NPA PMD (**librte_mempool_octeontx2**) provides mempool\n+driver support for the integrated mempool device found in **Marvell OCTEON TX2** SoC family.\n+\n+More information about OCTEON TX2 SoC can be found at `Marvell Official Website\n+<https://www.marvell.com/embedded-processors/infrastructure-processors/>`_.\n+\n+Features\n+--------\n+\n+OCTEON TX2 NPA PMD supports:\n+\n+- Up to 128 NPA LFs\n+- 1M Pools per LF\n+- HW mempool manager\n+- Ethdev Rx buffer allocation in HW to save CPU cycles in the Rx path.\n+- Ethdev Tx buffer recycling in HW to save CPU cycles in the Tx path.\n+\n+Prerequisites and Compilation procedure\n+---------------------------------------\n+\n+ See :doc:`../platform/octeontx2` for setup information.\n+\n+Pre-Installation Configuration\n+------------------------------\n+\n+Compile time Config Options\n+~~~~~~~~~~~~~~~~~~~~~~~~~~~\n+\n+The following option can be modified in the ``config`` file.\n+\n+- ``CONFIG_RTE_LIBRTE_OCTEONTX2_MEMPOOL`` (default ``y``)\n+\n+ Toggle compilation of the ``librte_mempool_octeontx2`` driver.\n+\n+Runtime Config Options\n+~~~~~~~~~~~~~~~~~~~~~~\n+\n+- ``Maximum number of mempools per application`` (default ``128``)\n+\n+ The maximum number of mempools per application needs to be configured on\n+ HW during mempool driver initialization. HW can support up to 1M mempools,\n+ Since each mempool costs set of HW resources, the ``max_pools`` ``devargs``\n+ parameter is being introduced to configure the number of mempools required\n+ for the application.\n+ For example::\n+\n+ -w 0002:02:00.0,max_pools=512\n+\n+ With the above configuration, the driver will set up only 512 mempools for\n+ the given application to save HW resources.\n+\n+.. note::\n+\n+ Since this configuration is per application, the end user needs to\n+ provide ``max_pools`` parameter to the first PCIe device probed by the given\n+ application.\n+\n+Debugging Options\n+~~~~~~~~~~~~~~~~~\n+\n+.. _table_octeontx2_mempool_debug_options:\n+\n+.. table:: OCTEON TX2 mempool debug options\n+\n+ +---+------------+-------------------------------------------------------+\n+ | # | Component | EAL log command |\n+ +===+============+=======================================================+\n+ | 1 | NPA | --log-level='pmd\\.mempool.octeontx2,8' |\n+ +---+------------+-------------------------------------------------------+\n+\n+Standalone mempool device\n+~~~~~~~~~~~~~~~~~~~~~~~~~\n+\n+ The ``usertools/dpdk-devbind.py`` script shall enumerate all the mempool devices\n+ available in the system. In order to avoid, the end user to bind the mempool\n+ device prior to use ethdev and/or eventdev device, the respective driver\n+ configures an NPA LF and attach to the first probed ethdev or eventdev device.\n+ In case, if end user need to run mempool as a standalone device\n+ (without ethdev or eventdev), end user needs to bind a mempool device using\n+ ``usertools/dpdk-devbind.py``\n+\n+ Example command to run ``mempool_autotest`` test with standalone OCTEONTX2 NPA device::\n+\n+ echo \"mempool_autotest\" | build/app/test -c 0xf0 --mbuf-pool-ops-name=\"octeontx2_npa\"\ndiff --git a/doc/guides/platform/octeontx2.rst b/doc/guides/platform/octeontx2.rst\nindex fdff8319f..a876cbfdd 100644\n--- a/doc/guides/platform/octeontx2.rst\n+++ b/doc/guides/platform/octeontx2.rst\n@@ -98,6 +98,8 @@ HW Offload Drivers\n \n This section lists dataplane H/W block(s) available in OCTEON TX2 SoC.\n \n+#. **Mempool Driver**\n+ See :doc:`../mempool/octeontx2` for NPA mempool driver information.\n \n Procedure to Setup Platform\n ---------------------------\ndiff --git a/doc/guides/rel_notes/release_19_08.rst b/doc/guides/rel_notes/release_19_08.rst\nindex b9510f93a..925ce839b 100644\n--- a/doc/guides/rel_notes/release_19_08.rst\n+++ b/doc/guides/rel_notes/release_19_08.rst\n@@ -130,6 +130,7 @@ The libraries prepended with a plus sign were incremented in this version.\n librte_cfgfile.so.2\n librte_cmdline.so.2\n librte_compressdev.so.1\n+ + librte_common_octeontx2.so.1\n librte_cryptodev.so.7\n librte_distributor.so.1\n librte_eal.so.10\n@@ -150,6 +151,7 @@ The libraries prepended with a plus sign were incremented in this version.\n librte_mbuf.so.5\n librte_member.so.1\n librte_mempool.so.5\n+ + librte_mempool_octeontx2.so.1\n librte_meter.so.3\n librte_metrics.so.1\n librte_net.so.1\n", "prefixes": [ "v1", "27/27" ] }