Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/7440/?format=api
{ "id": 7440, "url": "https://patches.dpdk.org/api/patches/7440/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/1444067589-29513-14-git-send-email-adrien.mazarguil@6wind.com/", "project": { "id": 1, "url": "https://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": "<1444067589-29513-14-git-send-email-adrien.mazarguil@6wind.com>", "list_archive_url": "https://inbox.dpdk.org/dev/1444067589-29513-14-git-send-email-adrien.mazarguil@6wind.com", "date": "2015-10-05T17:53:09", "name": "[dpdk-dev,13/13] doc: add mlx5 documentation and release notes for version 2.2", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "60d8819ac8675bfadd999956b4e38c3b46e68cdf", "submitter": { "id": 165, "url": "https://patches.dpdk.org/api/people/165/?format=api", "name": "Adrien Mazarguil", "email": "adrien.mazarguil@6wind.com" }, "delegate": null, "mbox": "https://patches.dpdk.org/project/dpdk/patch/1444067589-29513-14-git-send-email-adrien.mazarguil@6wind.com/mbox/", "series": [], "comments": "https://patches.dpdk.org/api/patches/7440/comments/", "check": "pending", "checks": "https://patches.dpdk.org/api/patches/7440/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 [IPv6:::1])\n\tby dpdk.org (Postfix) with ESMTP id 8202E9230;\n\tMon, 5 Oct 2015 19:54:07 +0200 (CEST)", "from mail-wi0-f174.google.com (mail-wi0-f174.google.com\n\t[209.85.212.174]) by dpdk.org (Postfix) with ESMTP id D9A79939E\n\tfor <dev@dpdk.org>; Mon, 5 Oct 2015 19:54:05 +0200 (CEST)", "by wiclk2 with SMTP id lk2so132422532wic.0\n\tfor <dev@dpdk.org>; Mon, 05 Oct 2015 10:54:05 -0700 (PDT)", "from 6wind.com (guy78-3-82-239-227-177.fbx.proxad.net.\n\t[82.239.227.177]) by smtp.gmail.com with ESMTPSA id\n\th7sm28085379wjz.7.2015.10.05.10.54.04\n\tfor <dev@dpdk.org> (version=TLSv1.2 cipher=RC4-SHA bits=128/128);\n\tMon, 05 Oct 2015 10:54:04 -0700 (PDT)" ], "X-Google-DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed;\n\td=1e100.net; s=20130820;\n\th=x-gm-message-state:from:to:subject:date:message-id:in-reply-to\n\t:references;\n\tbh=l6T+0frRAScBs8+Q0fC+I7+5gn4ZWc48BAJ+yTmtxSo=;\n\tb=M6l0ArXlT8rYyhom0ZSZgDVO3odobxLcpp9eJBsq6ltd0NaAUmr+m3UNy+AVFb9IjM\n\t9R9vkOqFfVUfkVv46X8h/lAD0ziyZDnXzurNFNVFhQTnNF2Wogcr/e+2SbxyYCOamgsz\n\tv5CUhryq70ylkFWWmzyczVsZKBOZnjYUQfwLm1C12gfhZ/fbTqga80muOw3zySkJoC40\n\t8iWN5HXATIf4uTZGZJn7wM03QX1zxxEyuekVm8k88B69w0l+uvbXBt3e5V/nA2HU+2BT\n\tzQYoHnB7ElCJZbWeiWgzHDmf8DNhb2bH7Z7ncKwLIbKJFeNQloBQpHCXXzkbRklBYqg1\n\tBGTQ==", "X-Gm-Message-State": "ALoCoQmt9q4qxQu/SFlvy3BJQhiWLHAatG5TYB1ZiJgGMX4x51JsstU9gQXTsL7AEIirkLioPM0U", "X-Received": "by 10.180.210.163 with SMTP id mv3mr12387445wic.40.1444067645210;\n\tMon, 05 Oct 2015 10:54:05 -0700 (PDT)", "From": "Adrien Mazarguil <adrien.mazarguil@6wind.com>", "To": "dev@dpdk.org", "Date": "Mon, 5 Oct 2015 19:53:09 +0200", "Message-Id": "<1444067589-29513-14-git-send-email-adrien.mazarguil@6wind.com>", "X-Mailer": "git-send-email 2.1.0", "In-Reply-To": "<1444067589-29513-1-git-send-email-adrien.mazarguil@6wind.com>", "References": "<1444067589-29513-1-git-send-email-adrien.mazarguil@6wind.com>", "Subject": "[dpdk-dev] [PATCH 13/13] doc: add mlx5 documentation and release\n\tnotes for version 2.2", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "Precedence": "list", "List-Id": "patches and discussions about DPDK <dev.dpdk.org>", "List-Unsubscribe": "<http://dpdk.org/ml/options/dev>,\n\t<mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://dpdk.org/ml/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<http://dpdk.org/ml/listinfo/dev>,\n\t<mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "Signed-off-by: Adrien Mazarguil <adrien.mazarguil@6wind.com>\n---\n doc/guides/nics/mlx5.rst | 308 +++++++++++++++++++++++++++++++++++\n doc/guides/rel_notes/release_2_2.rst | 8 +\n 2 files changed, 316 insertions(+)\n create mode 100644 doc/guides/nics/mlx5.rst", "diff": "diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst\nnew file mode 100644\nindex 0000000..fdb621c\n--- /dev/null\n+++ b/doc/guides/nics/mlx5.rst\n@@ -0,0 +1,308 @@\n+.. BSD LICENSE\n+ Copyright 2015 6WIND S.A.\n+\n+ Redistribution and use in source and binary forms, with or without\n+ modification, are permitted provided that the following conditions\n+ are met:\n+\n+ * Redistributions of source code must retain the above copyright\n+ notice, this list of conditions and the following disclaimer.\n+ * Redistributions in binary form must reproduce the above copyright\n+ notice, this list of conditions and the following disclaimer in\n+ the documentation and/or other materials provided with the\n+ distribution.\n+ * Neither the name of 6WIND S.A. nor the names of its\n+ contributors may be used to endorse or promote products derived\n+ from this software without specific prior written permission.\n+\n+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS\n+ \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT\n+ LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR\n+ A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT\n+ OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,\n+ SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT\n+ LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,\n+ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY\n+ THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT\n+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\n+ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n+\n+MLX5 poll mode driver\n+=====================\n+\n+The MLX5 poll mode driver library (**librte_pmd_mlx5**) provides support for\n+**Mellanox ConnectX-4 EN** and **Mellanox ConnectX-4 Lx EN** families of\n+10/25/40/50/100 Gb/s adapters as well as their virtual functions (VF) in\n+SR-IOV context.\n+\n+Information and documentation about these adapters can be found on the\n+`Mellanox website <http://www.mellanox.com>`__. Help is also provided by the\n+`Mellanox community <http://community.mellanox.com/welcome>`__.\n+\n+There is also a `section dedicated to this poll mode driver\n+<http://www.mellanox.com/page/products_dyn?product_family=209&mtag=pmd_for_dpdk>`__.\n+\n+.. note::\n+\n+ Due to external dependencies, this driver is disabled by default. It must\n+ be enabled manually by setting ``CONFIG_RTE_LIBRTE_MLX5_PMD=y`` and\n+ recompiling DPDK.\n+\n+.. warning::\n+\n+ ``CONFIG_RTE_BUILD_COMBINE_LIBS`` with ``CONFIG_RTE_BUILD_SHARED_LIB``\n+ is not supported and thus the compilation will fail with this configuration.\n+\n+Implementation details\n+----------------------\n+\n+Besides its dependency on libibverbs (that implies libmlx5 and associated\n+kernel support), librte_pmd_mlx5 relies heavily on system calls for control\n+operations such as querying/updating the MTU and flow control parameters.\n+\n+For security reasons and robustness, this driver only deals with virtual\n+memory addresses. The way resources allocations are handled by the kernel\n+combined with hardware specifications that allow it to handle virtual memory\n+addresses directly ensure that DPDK applications cannot access random\n+physical memory (or memory that does not belong to the current process).\n+\n+This capability allows the PMD to coexist with kernel network interfaces\n+which remain functional, although they stop receiving unicast packets as\n+long as they share the same MAC address.\n+\n+Enabling librte_pmd_mlx5 causes DPDK applications to be linked against\n+libibverbs.\n+\n+Configuration\n+-------------\n+\n+Compilation options\n+~~~~~~~~~~~~~~~~~~~\n+\n+These options can be modified in the ``.config`` file.\n+\n+- ``CONFIG_RTE_LIBRTE_MLX5_PMD`` (default **n**)\n+\n+ Toggle compilation of librte_pmd_mlx5 itself.\n+\n+- ``CONFIG_RTE_LIBRTE_MLX5_DEBUG`` (default **n**)\n+\n+ Toggle debugging code and stricter compilation flags. Enabling this option\n+ adds additional run-time checks and debugging messages at the cost of\n+ lower performance.\n+\n+- ``CONFIG_RTE_LIBRTE_MLX5_SGE_WR_N`` (default **4**)\n+\n+ Number of scatter/gather elements (SGEs) per work request (WR). Lowering\n+ this number improves performance but also limits the ability to receive\n+ scattered packets (packets that do not fit a single mbuf). The default\n+ value is a safe tradeoff.\n+\n+- ``CONFIG_RTE_LIBRTE_MLX5_MAX_INLINE`` (default **0**)\n+\n+ Amount of data to be inlined during TX operations. Improves latency but\n+ lowers throughput.\n+\n+- ``CONFIG_RTE_LIBRTE_MLX5_TX_MP_CACHE`` (default **8**)\n+\n+ Maximum number of cached memory pools (MPs) per TX queue. Each MP from\n+ which buffers are to be transmitted must be associated to memory regions\n+ (MRs). This is a slow operation that must be cached.\n+\n+ This value is always 1 for RX queues since they use a single MP.\n+\n+Run-time configuration\n+~~~~~~~~~~~~~~~~~~~~~~\n+\n+- librte_pmd_mlx5 brings kernel network interfaces up during initialization\n+ because it is affected by their state. Forcing them down prevents packets\n+ reception.\n+\n+- **ethtool** operations on related kernel interfaces also affect the PMD.\n+\n+Prerequisites\n+-------------\n+\n+This driver relies on external libraries and kernel drivers for resources\n+allocations and initialization. The following dependencies are not part of\n+DPDK and must be installed separately:\n+\n+- **libibverbs**\n+\n+ User space Verbs framework used by librte_pmd_mlx5. This library provides\n+ a generic interface between the kernel and low-level user space drivers\n+ such as libmlx5.\n+\n+ It allows slow and privileged operations (context initialization, hardware\n+ resources allocations) to be managed by the kernel and fast operations to\n+ never leave user space.\n+\n+- **libmlx5**\n+\n+ Low-level user space driver library for Mellanox ConnectX-4 devices,\n+ it is automatically loaded by libibverbs.\n+\n+ This library basically implements send/receive calls to the hardware\n+ queues.\n+\n+- **Kernel modules** (mlnx-ofed-kernel)\n+\n+ They provide the kernel-side Verbs API and low level device drivers that\n+ manage actual hardware initialization and resources sharing with user\n+ space processes.\n+\n+ Unlike most other PMDs, these modules must remain loaded and bound to\n+ their devices:\n+\n+ - mlx5_core: hardware driver managing Mellanox ConnectX-4 devices and\n+ related Ethernet kernel network devices.\n+ - mlx5_ib: InifiniBand device driver.\n+ - ib_uverbs: user space driver for Verbs (entry point for libibverbs).\n+\n+- **Firmware update**\n+\n+ Mellanox OFED releases include firmware updates for ConnectX-4 adapters.\n+\n+ Because each release provides new features, these updates must be applied to\n+ match the kernel modules and libraries they come with.\n+\n+.. note::\n+\n+ Both libraries are BSD and GPL licensed. Linux kernel modules are GPL\n+ licensed.\n+\n+Getting Mellanox OFED\n+~~~~~~~~~~~~~~~~~~~~~\n+\n+While these libraries and kernel modules are available on OpenFabrics\n+Alliance's `website <https://www.openfabrics.org/>`__ and provided by package\n+managers on most distributions, this PMD requires Ethernet extensions that\n+may not be supported at the moment (this is a work in progress).\n+\n+`Mellanox OFED\n+<http://www.mellanox.com/page/products_dyn?product_family=26&mtag=linux>`__\n+includes the necessary support and should be used in the meantime. For DPDK,\n+only libibverbs, libmlx5, mlnx-ofed-kernel packages and firmware updates are\n+required from that distribution.\n+\n+.. note::\n+\n+ Several versions of Mellanox OFED are available. Installing the version\n+ this DPDK release was developed and tested against is strongly\n+ recommended. Please check the `prerequisites`_.\n+\n+Usage example\n+-------------\n+\n+This section demonstrates how to launch **testpmd** with Mellanox ConnectX-4\n+devices managed by librte_pmd_mlx5.\n+\n+#. Load the kernel modules:\n+\n+ .. code-block:: console\n+\n+ modprobe -a ib_uverbs mlx5_core mlx5_ib\n+\n+ .. note::\n+\n+ User space I/O kernel modules (uio and igb_uio) are not used and do\n+ not have to be loaded.\n+\n+#. Make sure Ethernet interfaces are in working order and linked to kernel\n+ verbs. Related sysfs entries should be present:\n+\n+ .. code-block:: console\n+\n+ ls -d /sys/class/net/*/device/infiniband_verbs/uverbs* | cut -d / -f 5\n+\n+ Example output:\n+\n+ .. code-block:: console\n+\n+ eth30\n+ eth31\n+ eth32\n+ eth33\n+\n+#. Optionally, retrieve their PCI bus addresses for whitelisting:\n+\n+ .. code-block:: console\n+\n+ {\n+ for intf in eth2 eth3 eth4 eth5;\n+ do\n+ (cd \"/sys/class/net/${intf}/device/\" && pwd -P);\n+ done;\n+ } |\n+ sed -n 's,.*/\\(.*\\),-w \\1,p'\n+\n+ Example output:\n+\n+ .. code-block:: console\n+\n+ -w 0000:05:00.1\n+ -w 0000:06:00.0\n+ -w 0000:06:00.1\n+ -w 0000:05:00.0\n+\n+#. Request huge pages:\n+\n+ .. code-block:: console\n+\n+ echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/nr_hugepages\n+\n+#. Start testpmd with basic parameters:\n+\n+ .. code-block:: console\n+\n+ testpmd -c 0xff00 -n 4 -w 05:00.0 -w 05:00.1 -w 06:00.0 -w 06:00.1 -- --rxq=2 --txq=2 -i\n+\n+ Example output:\n+\n+ .. code-block:: console\n+\n+ [...]\n+ EAL: PCI device 0000:05:00.0 on NUMA socket 0\n+ EAL: probe driver: 15b3:1013 librte_pmd_mlx5\n+ PMD: librte_pmd_mlx5: PCI information matches, using device \"mlx5_0\" (VF: false)\n+ PMD: librte_pmd_mlx5: 1 port(s) detected\n+ PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fe\n+ EAL: PCI device 0000:05:00.1 on NUMA socket 0\n+ EAL: probe driver: 15b3:1013 librte_pmd_mlx5\n+ PMD: librte_pmd_mlx5: PCI information matches, using device \"mlx5_1\" (VF: false)\n+ PMD: librte_pmd_mlx5: 1 port(s) detected\n+ PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:ff\n+ EAL: PCI device 0000:06:00.0 on NUMA socket 0\n+ EAL: probe driver: 15b3:1013 librte_pmd_mlx5\n+ PMD: librte_pmd_mlx5: PCI information matches, using device \"mlx5_2\" (VF: false)\n+ PMD: librte_pmd_mlx5: 1 port(s) detected\n+ PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fa\n+ EAL: PCI device 0000:06:00.1 on NUMA socket 0\n+ EAL: probe driver: 15b3:1013 librte_pmd_mlx5\n+ PMD: librte_pmd_mlx5: PCI information matches, using device \"mlx5_3\" (VF: false)\n+ PMD: librte_pmd_mlx5: 1 port(s) detected\n+ PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fb\n+ Interactive-mode selected\n+ Configuring Port 0 (socket 0)\n+ PMD: librte_pmd_mlx5: 0x8cba80: TX queues number update: 0 -> 2\n+ PMD: librte_pmd_mlx5: 0x8cba80: RX queues number update: 0 -> 2\n+ Port 0: E4:1D:2D:E7:0C:FE\n+ Configuring Port 1 (socket 0)\n+ PMD: librte_pmd_mlx5: 0x8ccac8: TX queues number update: 0 -> 2\n+ PMD: librte_pmd_mlx5: 0x8ccac8: RX queues number update: 0 -> 2\n+ Port 1: E4:1D:2D:E7:0C:FF\n+ Configuring Port 2 (socket 0)\n+ PMD: librte_pmd_mlx5: 0x8cdb10: TX queues number update: 0 -> 2\n+ PMD: librte_pmd_mlx5: 0x8cdb10: RX queues number update: 0 -> 2\n+ Port 2: E4:1D:2D:E7:0C:FA\n+ Configuring Port 3 (socket 0)\n+ PMD: librte_pmd_mlx5: 0x8ceb58: TX queues number update: 0 -> 2\n+ PMD: librte_pmd_mlx5: 0x8ceb58: RX queues number update: 0 -> 2\n+ Port 3: E4:1D:2D:E7:0C:FB\n+ Checking link statuses...\n+ Port 0 Link Up - speed 40000 Mbps - full-duplex\n+ Port 1 Link Up - speed 40000 Mbps - full-duplex\n+ Port 2 Link Up - speed 10000 Mbps - full-duplex\n+ Port 3 Link Up - speed 10000 Mbps - full-duplex\n+ Done\n+ testpmd>\ndiff --git a/doc/guides/rel_notes/release_2_2.rst b/doc/guides/rel_notes/release_2_2.rst\nindex 5687676..e562030 100644\n--- a/doc/guides/rel_notes/release_2_2.rst\n+++ b/doc/guides/rel_notes/release_2_2.rst\n@@ -4,6 +4,14 @@ DPDK Release 2.2\n New Features\n ------------\n \n+* **Added support for Mellanox ConnectX-4 adapters (mlx5).**\n+\n+ The mlx5 poll-mode driver implements support for Mellanox ConnectX-4 EN\n+ and Mellanox ConnectX-4 Lx EN families of 10/25/40/50/100 Gb/s adapters.\n+\n+ Like mlx4, this PMD is only available for Linux and is disabled by default\n+ due to external dependencies (libibverbs and libmlx5).\n+\n \n Resolved Issues\n ---------------\n", "prefixes": [ "dpdk-dev", "13/13" ] }