doc/guides/nics/mlx5.rst

   1 ..  BSD LICENSE
   2     Copyright 2015 6WIND S.A.
   3     Copyright 2015 Mellanox
   4
   5     Redistribution and use in source and binary forms, with or without
   6     modification, are permitted provided that the following conditions
   7     are met:
   8
   9     * Redistributions of source code must retain the above copyright
  10     notice, this list of conditions and the following disclaimer.
  11     * Redistributions in binary form must reproduce the above copyright
  12     notice, this list of conditions and the following disclaimer in
  13     the documentation and/or other materials provided with the
  14     distribution.
  15     * Neither the name of 6WIND S.A. nor the names of its
  16     contributors may be used to endorse or promote products derived
  17     from this software without specific prior written permission.
  18
  19     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20     "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22     A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23     OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25     LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26     DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27     THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30
  31 MLX5 poll mode driver
  32 =====================
  33
  34 The MLX5 poll mode driver library (**librte_pmd_mlx5**) provides support
  35 for **Mellanox ConnectX-4**, **Mellanox ConnectX-4 Lx** and **Mellanox
  36 ConnectX-5** families of 10/25/40/50/100 Gb/s adapters as well as their
  37 virtual functions (VF) in SR-IOV context.
  38
  39 Information and documentation about these adapters can be found on the
  40 `Mellanox website <http://www.mellanox.com>`__. Help is also provided by the
  41 `Mellanox community <http://community.mellanox.com/welcome>`__.
  42
  43 There is also a `section dedicated to this poll mode driver
  44 <http://www.mellanox.com/page/products_dyn?product_family=209&mtag=pmd_for_dpdk>`__.
  45
  46 .. note::
  47
  48    Due to external dependencies, this driver is disabled by default. It must
  49    be enabled manually by setting ``CONFIG_RTE_LIBRTE_MLX5_PMD=y`` and
  50    recompiling DPDK.
  51
  52 Implementation details
  53 ----------------------
  54
  55 Besides its dependency on libibverbs (that implies libmlx5 and associated
  56 kernel support), librte_pmd_mlx5 relies heavily on system calls for control
  57 operations such as querying/updating the MTU and flow control parameters.
  58
  59 For security reasons and robustness, this driver only deals with virtual
  60 memory addresses. The way resources allocations are handled by the kernel
  61 combined with hardware specifications that allow it to handle virtual memory
  62 addresses directly ensure that DPDK applications cannot access random
  63 physical memory (or memory that does not belong to the current process).
  64
  65 This capability allows the PMD to coexist with kernel network interfaces
  66 which remain functional, although they stop receiving unicast packets as
  67 long as they share the same MAC address.
  68 This means legacy linux control tools (for example: ethtool, ifconfig and
  69 more) can operate on the same network interfaces that owned by the DPDK
  70 application.
  71
  72 Enabling librte_pmd_mlx5 causes DPDK applications to be linked against
  73 libibverbs.
  74
  75 Features
  76 --------
  77
  78 - Multi arch support: x86_64, POWER8, ARMv8.
  79 - Multiple TX and RX queues.
  80 - Support for scattered TX and RX frames.
  81 - IPv4, IPv6, TCPv4, TCPv6, UDPv4 and UDPv6 RSS on any number of queues.
  82 - Several RSS hash keys, one for each flow type.
  83 - Configurable RETA table.
  84 - Support for multiple MAC addresses.
  85 - VLAN filtering.
  86 - RX VLAN stripping.
  87 - TX VLAN insertion.
  88 - RX CRC stripping configuration.
  89 - Promiscuous mode.
  90 - Multicast promiscuous mode.
  91 - Hardware checksum offloads.
  92 - Flow director (RTE_FDIR_MODE_PERFECT, RTE_FDIR_MODE_PERFECT_MAC_VLAN and
  93   RTE_ETH_FDIR_REJECT).
  94 - Flow API.
  95 - Multiple process.
  96 - KVM and VMware ESX SR-IOV modes are supported.
  97 - RSS hash result is supported.
  98 - Hardware TSO.
  99 - Hardware checksum TX offload for VXLAN and GRE.
 100 - RX interrupts.
 101 - Statistics query including Basic, Extended and per queue.
 102 - Rx HW timestamp.
 103
 104 Limitations
 105 -----------
 106
 107 - Inner RSS for VXLAN frames is not supported yet.
 108 - Hardware checksum RX offloads for VXLAN inner header are not supported yet.
 109 - For secondary process:
 110
 111   - Forked secondary process not supported.
 112   - All mempools must be initialized before rte_eth_dev_start().
 113
 114 - Flow pattern without any specific vlan will match for vlan packets as well:
 115
 116   When VLAN spec is not specified in the pattern, the matching rule will be created with VLAN as a wild card.
 117   Meaning, the flow rule::
 118
 119         flow create 0 ingress pattern eth / vlan vid is 3 / ipv4 / end ...
 120
 121   Will only match vlan packets with vid=3. and the flow rules::
 122
 123         flow create 0 ingress pattern eth / ipv4 / end ...
 124
 125   Or::
 126
 127         flow create 0 ingress pattern eth / vlan / ipv4 / end ...
 128
 129   Will match any ipv4 packet (VLAN included).
 130
 131 - A multi segment packet must have less than 6 segments in case the Tx burst function
 132   is set to multi-packet send or Enhanced multi-packet send. Otherwise it must have
 133   less than 50 segments.
 134 - Count action for RTE flow is only supported in Mellanox OFED 4.2.
 135 - Flows with a VXLAN Network Identifier equal (or ends to be equal)
 136   to 0 are not supported.
 137 - VXLAN TSO and checksum offloads are not supported on VM.
 138
 139 Statistics
 140 ----------
 141
 142 MLX5 supports various of methods to report statistics:
 143
 144 Port statistics can be queried using ``rte_eth_stats_get()``. The port statistics are through SW only and counts the number of packets received or sent successfully by the PMD.
 145
 146 Extended statistics can be queried using ``rte_eth_xstats_get()``. The extended statistics expose a wider set of counters counted by the device. The extended port statistics counts the number of packets received or sent successfully by the port. As Mellanox NICs are using the :ref:`Bifurcated Linux Driver <linux_gsg_linux_drivers>` those counters counts also packet received or sent by the Linux kernel. The counters with ``_phy`` suffix counts the total events on the physical port, therefore not valid for VF.
 147
 148 Finally per-flow statistics can by queried using ``rte_flow_query`` when attaching a count action for specific flow. The flow counter counts the number of packets received successfully by the port and match the specific flow.
 149
 150 Configuration
 151 -------------
 152
 153 Compilation options
 154 ~~~~~~~~~~~~~~~~~~~
 155
 156 These options can be modified in the ``.config`` file.
 157
 158 - ``CONFIG_RTE_LIBRTE_MLX5_PMD`` (default **n**)
 159
 160   Toggle compilation of librte_pmd_mlx5 itself.
 161
 162 - ``CONFIG_RTE_LIBRTE_MLX5_DEBUG`` (default **n**)
 163
 164   Toggle debugging code and stricter compilation flags. Enabling this option
 165   adds additional run-time checks and debugging messages at the cost of
 166   lower performance.
 167
 168 - ``CONFIG_RTE_LIBRTE_MLX5_TX_MP_CACHE`` (default **8**)
 169
 170   Maximum number of cached memory pools (MPs) per TX queue. Each MP from
 171   which buffers are to be transmitted must be associated to memory regions
 172   (MRs). This is a slow operation that must be cached.
 173
 174   This value is always 1 for RX queues since they use a single MP.
 175
 176 Environment variables
 177 ~~~~~~~~~~~~~~~~~~~~~
 178
 179 - ``MLX5_PMD_ENABLE_PADDING``
 180
 181   Enables HW packet padding in PCI bus transactions.
 182
 183   When packet size is cache aligned and CRC stripping is enabled, 4 fewer
 184   bytes are written to the PCI bus. Enabling padding makes such packets
 185   aligned again.
 186
 187   In cases where PCI bandwidth is the bottleneck, padding can improve
 188   performance by 10%.
 189
 190   This is disabled by default since this can also decrease performance for
 191   unaligned packet sizes.
 192
 193 - ``MLX5_SHUT_UP_BF``
 194
 195   Configures HW Tx doorbell register as IO-mapped.
 196
 197   By default, the HW Tx doorbell is configured as a write-combining register.
 198   The register would be flushed to HW usually when the write-combining buffer
 199   becomes full, but it depends on CPU design.
 200
 201   Except for vectorized Tx burst routines, a write memory barrier is enforced
 202   after updating the register so that the update can be immediately visible to
 203   HW.
 204
 205   When vectorized Tx burst is called, the barrier is set only if the burst size
 206   is not aligned to MLX5_VPMD_TX_MAX_BURST. However, setting this environmental
 207   variable will bring better latency even though the maximum throughput can
 208   slightly decline.
 209
 210 Run-time configuration
 211 ~~~~~~~~~~~~~~~~~~~~~~
 212
 213 - librte_pmd_mlx5 brings kernel network interfaces up during initialization
 214   because it is affected by their state. Forcing them down prevents packets
 215   reception.
 216
 217 - **ethtool** operations on related kernel interfaces also affect the PMD.
 218
 219 - ``rxq_cqe_comp_en`` parameter [int]
 220
 221   A nonzero value enables the compression of CQE on RX side. This feature
 222   allows to save PCI bandwidth and improve performance. Enabled by default.
 223
 224   Supported on:
 225
 226   - x86_64 with ConnectX-4, ConnectX-4 LX and ConnectX-5.
 227   - POWER8 and ARMv8 with ConnectX-4 LX and ConnectX-5.
 228
 229 - ``txq_inline`` parameter [int]
 230
 231   Amount of data to be inlined during TX operations. Improves latency.
 232   Can improve PPS performance when PCI back pressure is detected and may be
 233   useful for scenarios involving heavy traffic on many queues.
 234
 235   Because additional software logic is necessary to handle this mode, this
 236   option should be used with care, as it can lower performance when back
 237   pressure is not expected.
 238
 239 - ``txqs_min_inline`` parameter [int]
 240
 241   Enable inline send only when the number of TX queues is greater or equal
 242   to this value.
 243
 244   This option should be used in combination with ``txq_inline`` above.
 245
 246   On ConnectX-4, ConnectX-4 LX and ConnectX-5 without Enhanced MPW:
 247
 248         - Disabled by default.
 249         - In case ``txq_inline`` is set recommendation is 4.
 250
 251   On ConnectX-5 with Enhanced MPW:
 252
 253         - Set to 8 by default.
 254
 255 - ``txq_mpw_en`` parameter [int]
 256
 257   A nonzero value enables multi-packet send (MPS) for ConnectX-4 Lx and
 258   enhanced multi-packet send (Enhanced MPS) for ConnectX-5. MPS allows the
 259   TX burst function to pack up multiple packets in a single descriptor
 260   session in order to save PCI bandwidth and improve performance at the
 261   cost of a slightly higher CPU usage. When ``txq_inline`` is set along
 262   with ``txq_mpw_en``, TX burst function tries to copy entire packet data
 263   on to TX descriptor instead of including pointer of packet only if there
 264   is enough room remained in the descriptor. ``txq_inline`` sets
 265   per-descriptor space for either pointers or inlined packets. In addition,
 266   Enhanced MPS supports hybrid mode - mixing inlined packets and pointers
 267   in the same descriptor.
 268
 269   This option cannot be used with certain offloads such as ``DEV_TX_OFFLOAD_TCP_TSO,
 270   DEV_TX_OFFLOAD_VXLAN_TNL_TSO, DEV_TX_OFFLOAD_GRE_TNL_TSO, DEV_TX_OFFLOAD_VLAN_INSERT``.
 271   When those offloads are requested the MPS send function will not be used.
 272
 273   It is currently only supported on the ConnectX-4 Lx and ConnectX-5
 274   families of adapters. Enabled by default.
 275
 276 - ``txq_mpw_hdr_dseg_en`` parameter [int]
 277
 278   A nonzero value enables including two pointers in the first block of TX
 279   descriptor. This can be used to lessen CPU load for memory copy.
 280
 281   Effective only when Enhanced MPS is supported. Disabled by default.
 282
 283 - ``txq_max_inline_len`` parameter [int]
 284
 285   Maximum size of packet to be inlined. This limits the size of packet to
 286   be inlined. If the size of a packet is larger than configured value, the
 287   packet isn't inlined even though there's enough space remained in the
 288   descriptor. Instead, the packet is included with pointer.
 289
 290   Effective only when Enhanced MPS is supported. The default value is 256.
 291
 292 - ``tx_vec_en`` parameter [int]
 293
 294   A nonzero value enables Tx vector on ConnectX-5 only NIC if the number of
 295   global Tx queues on the port is lesser than MLX5_VPMD_MIN_TXQS.
 296
 297   This option cannot be used with certain offloads such as ``DEV_TX_OFFLOAD_TCP_TSO,
 298   DEV_TX_OFFLOAD_VXLAN_TNL_TSO, DEV_TX_OFFLOAD_GRE_TNL_TSO, DEV_TX_OFFLOAD_VLAN_INSERT``.
 299   When those offloads are requested the MPS send function will not be used.
 300
 301   Enabled by default on ConnectX-5.
 302
 303 - ``rx_vec_en`` parameter [int]
 304
 305   A nonzero value enables Rx vector if the port is not configured in
 306   multi-segment otherwise this parameter is ignored.
 307
 308   Enabled by default.
 309
 310 Prerequisites
 311 -------------
 312
 313 This driver relies on external libraries and kernel drivers for resources
 314 allocations and initialization. The following dependencies are not part of
 315 DPDK and must be installed separately:
 316
 317 - **libibverbs**
 318
 319   User space Verbs framework used by librte_pmd_mlx5. This library provides
 320   a generic interface between the kernel and low-level user space drivers
 321   such as libmlx5.
 322
 323   It allows slow and privileged operations (context initialization, hardware
 324   resources allocations) to be managed by the kernel and fast operations to
 325   never leave user space.
 326
 327 - **libmlx5**
 328
 329   Low-level user space driver library for Mellanox ConnectX-4/ConnectX-5
 330   devices, it is automatically loaded by libibverbs.
 331
 332   This library basically implements send/receive calls to the hardware
 333   queues.
 334
 335 - **Kernel modules**
 336
 337   They provide the kernel-side Verbs API and low level device drivers that
 338   manage actual hardware initialization and resources sharing with user
 339   space processes.
 340
 341   Unlike most other PMDs, these modules must remain loaded and bound to
 342   their devices:
 343
 344   - mlx5_core: hardware driver managing Mellanox ConnectX-4/ConnectX-5
 345     devices and related Ethernet kernel network devices.
 346   - mlx5_ib: InifiniBand device driver.
 347   - ib_uverbs: user space driver for Verbs (entry point for libibverbs).
 348
 349 - **Firmware update**
 350
 351   Mellanox OFED releases include firmware updates for ConnectX-4/ConnectX-5
 352   adapters.
 353
 354   Because each release provides new features, these updates must be applied to
 355   match the kernel modules and libraries they come with.
 356
 357 .. note::
 358
 359    Both libraries are BSD and GPL licensed. Linux kernel modules are GPL
 360    licensed.
 361
 362 Installation
 363 ~~~~~~~~~~~~
 364
 365 Either RDMA Core library with a recent enough Linux kernel release
 366 (recommended) or Mellanox OFED, which provides compatibility with older
 367 releases.
 368
 369 RMDA Core with Linux Kernel
 370 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 371
 372 - Minimal kernel version : v4.14 or the most recent 4.14-rc (see `Linux installation documentation`_)
 373 - Minimal rdma-core version: v15+ commit 0c5f5765213a ("Merge pull request #227 from yishaih/tm")
 374   (see `RDMA Core installation documentation`_)
 375
 376 .. _`Linux installation documentation`: https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux-stable.git/plain/Documentation/admin-guide/README.rst
 377 .. _`RDMA Core installation documentation`: https://raw.githubusercontent.com/linux-rdma/rdma-core/master/README.md
 378
 379 Mellanox OFED
 380 ^^^^^^^^^^^^^
 381
 382 - Mellanox OFED version: **4.2**.
 383 - firmware version:
 384
 385   - ConnectX-4: **12.21.1000** and above.
 386   - ConnectX-4 Lx: **14.21.1000** and above.
 387   - ConnectX-5: **16.21.1000** and above.
 388   - ConnectX-5 Ex: **16.21.1000** and above.
 389
 390 While these libraries and kernel modules are available on OpenFabrics
 391 Alliance's `website <https://www.openfabrics.org/>`__ and provided by package
 392 managers on most distributions, this PMD requires Ethernet extensions that
 393 may not be supported at the moment (this is a work in progress).
 394
 395 `Mellanox OFED
 396 <http://www.mellanox.com/page/products_dyn?product_family=26&mtag=linux>`__
 397 includes the necessary support and should be used in the meantime. For DPDK,
 398 only libibverbs, libmlx5, mlnx-ofed-kernel packages and firmware updates are
 399 required from that distribution.
 400
 401 .. note::
 402
 403    Several versions of Mellanox OFED are available. Installing the version
 404    this DPDK release was developed and tested against is strongly
 405    recommended. Please check the `prerequisites`_.
 406
 407 Supported NICs
 408 --------------
 409
 410 * Mellanox(R) ConnectX(R)-4 10G MCX4111A-XCAT (1x10G)
 411 * Mellanox(R) ConnectX(R)-4 10G MCX4121A-XCAT (2x10G)
 412 * Mellanox(R) ConnectX(R)-4 25G MCX4111A-ACAT (1x25G)
 413 * Mellanox(R) ConnectX(R)-4 25G MCX4121A-ACAT (2x25G)
 414 * Mellanox(R) ConnectX(R)-4 40G MCX4131A-BCAT (1x40G)
 415 * Mellanox(R) ConnectX(R)-4 40G MCX413A-BCAT (1x40G)
 416 * Mellanox(R) ConnectX(R)-4 40G MCX415A-BCAT (1x40G)
 417 * Mellanox(R) ConnectX(R)-4 50G MCX4131A-GCAT (1x50G)
 418 * Mellanox(R) ConnectX(R)-4 50G MCX413A-GCAT (1x50G)
 419 * Mellanox(R) ConnectX(R)-4 50G MCX414A-BCAT (2x50G)
 420 * Mellanox(R) ConnectX(R)-4 50G MCX415A-GCAT (2x50G)
 421 * Mellanox(R) ConnectX(R)-4 50G MCX416A-BCAT (2x50G)
 422 * Mellanox(R) ConnectX(R)-4 50G MCX416A-GCAT (2x50G)
 423 * Mellanox(R) ConnectX(R)-4 50G MCX415A-CCAT (1x100G)
 424 * Mellanox(R) ConnectX(R)-4 100G MCX416A-CCAT (2x100G)
 425 * Mellanox(R) ConnectX(R)-4 Lx 10G MCX4121A-XCAT (2x10G)
 426 * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)
 427 * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
 428 * Mellanox(R) ConnectX(R)-5 Ex EN 100G MCX516A-CDAT (2x100G)
 429
 430 Quick Start Guide on OFED
 431 -------------------------
 432
 433 1. Download latest Mellanox OFED. For more info check the  `prerequisites`_.
 434
 435
 436 2. Install the required libraries and kernel modules either by installing
 437    only the required set, or by installing the entire Mellanox OFED:
 438
 439    .. code-block:: console
 440
 441         ./mlnxofedinstall --upstream-libs --dpdk
 442
 443 3. Verify the firmware is the correct one:
 444
 445    .. code-block:: console
 446
 447         ibv_devinfo
 448
 449 4. Verify all ports links are set to Ethernet:
 450
 451    .. code-block:: console
 452
 453         mlxconfig -d <mst device> query | grep LINK_TYPE
 454         LINK_TYPE_P1                        ETH(2)
 455         LINK_TYPE_P2                        ETH(2)
 456
 457    Link types may have to be configured to Ethernet:
 458
 459    .. code-block:: console
 460
 461         mlxconfig -d <mst device> set LINK_TYPE_P1/2=1/2/3
 462
 463         * LINK_TYPE_P1=<1|2|3> , 1=Infiniband 2=Ethernet 3=VPI(auto-sense)
 464
 465    For hypervisors verify SR-IOV is enabled on the NIC:
 466
 467    .. code-block:: console
 468
 469         mlxconfig -d <mst device> query | grep SRIOV_EN
 470         SRIOV_EN                            True(1)
 471
 472    If needed, set enable the set the relevant fields:
 473
 474    .. code-block:: console
 475
 476         mlxconfig -d <mst device> set SRIOV_EN=1 NUM_OF_VFS=16
 477         mlxfwreset -d <mst device> reset
 478
 479 5. Restart the driver:
 480
 481    .. code-block:: console
 482
 483         /etc/init.d/openibd restart
 484
 485    or:
 486
 487    .. code-block:: console
 488
 489         service openibd restart
 490
 491    If link type was changed, firmware must be reset as well:
 492
 493    .. code-block:: console
 494
 495         mlxfwreset -d <mst device> reset
 496
 497    For hypervisors, after reset write the sysfs number of virtual functions
 498    needed for the PF.
 499
 500    To dynamically instantiate a given number of virtual functions (VFs):
 501
 502    .. code-block:: console
 503
 504         echo [num_vfs] > /sys/class/infiniband/mlx5_0/device/sriov_numvfs
 505
 506 6. Compile DPDK and you are ready to go. See instructions on
 507    :ref:`Development Kit Build System <Development_Kit_Build_System>`
 508
 509 Performance tuning
 510 ------------------
 511
 512 1. Configure aggressive CQE Zipping for maximum performance:
 513
 514   .. code-block:: console
 515
 516         mlxconfig -d <mst device> s CQE_COMPRESSION=1
 517
 518   To set it back to the default CQE Zipping mode use:
 519
 520   .. code-block:: console
 521
 522         mlxconfig -d <mst device> s CQE_COMPRESSION=0
 523
 524 2. In case of virtualization:
 525
 526    - Make sure that hypervisor kernel is 3.16 or newer.
 527    - Configure boot with ``iommu=pt``.
 528    - Use 1G huge pages.
 529    - Make sure to allocate a VM on huge pages.
 530    - Make sure to set CPU pinning.
 531
 532 3. Use the CPU near local NUMA node to which the PCIe adapter is connected,
 533    for better performance. For VMs, verify that the right CPU
 534    and NUMA node are pinned according to the above. Run:
 535
 536    .. code-block:: console
 537
 538         lstopo-no-graphics
 539
 540    to identify the NUMA node to which the PCIe adapter is connected.
 541
 542 4. If more than one adapter is used, and root complex capabilities allow
 543    to put both adapters on the same NUMA node without PCI bandwidth degradation,
 544    it is recommended to locate both adapters on the same NUMA node.
 545    This in order to forward packets from one to the other without
 546    NUMA performance penalty.
 547
 548 5. Disable pause frames:
 549
 550    .. code-block:: console
 551
 552         ethtool -A <netdev> rx off tx off
 553
 554 6. Verify IO non-posted prefetch is disabled by default. This can be checked
 555    via the BIOS configuration. Please contact you server provider for more
 556    information about the settings.
 557
 558 .. note::
 559
 560         On some machines, depends on the machine integrator, it is beneficial
 561         to set the PCI max read request parameter to 1K. This can be
 562         done in the following way:
 563
 564         To query the read request size use:
 565
 566         .. code-block:: console
 567
 568                 setpci -s <NIC PCI address> 68.w
 569
 570         If the output is different than 3XXX, set it by:
 571
 572         .. code-block:: console
 573
 574                 setpci -s <NIC PCI address> 68.w=3XXX
 575
 576         The XXX can be different on different systems. Make sure to configure
 577         according to the setpci output.
 578
 579 Notes for testpmd
 580 -----------------
 581
 582 Compared to librte_pmd_mlx4 that implements a single RSS configuration per
 583 port, librte_pmd_mlx5 supports per-protocol RSS configuration.
 584
 585 Since ``testpmd`` defaults to IP RSS mode and there is currently no
 586 command-line parameter to enable additional protocols (UDP and TCP as well
 587 as IP), the following commands must be entered from its CLI to get the same
 588 behavior as librte_pmd_mlx4:
 589
 590 .. code-block:: console
 591
 592    > port stop all
 593    > port config all rss all
 594    > port start all
 595
 596 Usage example
 597 -------------
 598
 599 This section demonstrates how to launch **testpmd** with Mellanox
 600 ConnectX-4/ConnectX-5 devices managed by librte_pmd_mlx5.
 601
 602 #. Load the kernel modules:
 603
 604    .. code-block:: console
 605
 606       modprobe -a ib_uverbs mlx5_core mlx5_ib
 607
 608    Alternatively if MLNX_OFED is fully installed, the following script can
 609    be run:
 610
 611    .. code-block:: console
 612
 613       /etc/init.d/openibd restart
 614
 615    .. note::
 616
 617       User space I/O kernel modules (uio and igb_uio) are not used and do
 618       not have to be loaded.
 619
 620 #. Make sure Ethernet interfaces are in working order and linked to kernel
 621    verbs. Related sysfs entries should be present:
 622
 623    .. code-block:: console
 624
 625       ls -d /sys/class/net/*/device/infiniband_verbs/uverbs* | cut -d / -f 5
 626
 627    Example output:
 628
 629    .. code-block:: console
 630
 631       eth30
 632       eth31
 633       eth32
 634       eth33
 635
 636 #. Optionally, retrieve their PCI bus addresses for whitelisting:
 637
 638    .. code-block:: console
 639
 640       {
 641           for intf in eth2 eth3 eth4 eth5;
 642           do
 643               (cd "/sys/class/net/${intf}/device/" && pwd -P);
 644           done;
 645       } |
 646       sed -n 's,.*/\(.*\),-w \1,p'
 647
 648    Example output:
 649
 650    .. code-block:: console
 651
 652       -w 0000:05:00.1
 653       -w 0000:06:00.0
 654       -w 0000:06:00.1
 655       -w 0000:05:00.0
 656
 657 #. Request huge pages:
 658
 659    .. code-block:: console
 660
 661       echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/nr_hugepages
 662
 663 #. Start testpmd with basic parameters:
 664
 665    .. code-block:: console
 666
 667       testpmd -l 8-15 -n 4 -w 05:00.0 -w 05:00.1 -w 06:00.0 -w 06:00.1 -- --rxq=2 --txq=2 -i
 668
 669    Example output:
 670
 671    .. code-block:: console
 672
 673       [...]
 674       EAL: PCI device 0000:05:00.0 on NUMA socket 0
 675       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
 676       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_0" (VF: false)
 677       PMD: librte_pmd_mlx5: 1 port(s) detected
 678       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fe
 679       EAL: PCI device 0000:05:00.1 on NUMA socket 0
 680       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
 681       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_1" (VF: false)
 682       PMD: librte_pmd_mlx5: 1 port(s) detected
 683       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:ff
 684       EAL: PCI device 0000:06:00.0 on NUMA socket 0
 685       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
 686       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_2" (VF: false)
 687       PMD: librte_pmd_mlx5: 1 port(s) detected
 688       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fa
 689       EAL: PCI device 0000:06:00.1 on NUMA socket 0
 690       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
 691       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_3" (VF: false)
 692       PMD: librte_pmd_mlx5: 1 port(s) detected
 693       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fb
 694       Interactive-mode selected
 695       Configuring Port 0 (socket 0)
 696       PMD: librte_pmd_mlx5: 0x8cba80: TX queues number update: 0 -> 2
 697       PMD: librte_pmd_mlx5: 0x8cba80: RX queues number update: 0 -> 2
 698       Port 0: E4:1D:2D:E7:0C:FE
 699       Configuring Port 1 (socket 0)
 700       PMD: librte_pmd_mlx5: 0x8ccac8: TX queues number update: 0 -> 2
 701       PMD: librte_pmd_mlx5: 0x8ccac8: RX queues number update: 0 -> 2
 702       Port 1: E4:1D:2D:E7:0C:FF
 703       Configuring Port 2 (socket 0)
 704       PMD: librte_pmd_mlx5: 0x8cdb10: TX queues number update: 0 -> 2
 705       PMD: librte_pmd_mlx5: 0x8cdb10: RX queues number update: 0 -> 2
 706       Port 2: E4:1D:2D:E7:0C:FA
 707       Configuring Port 3 (socket 0)
 708       PMD: librte_pmd_mlx5: 0x8ceb58: TX queues number update: 0 -> 2
 709       PMD: librte_pmd_mlx5: 0x8ceb58: RX queues number update: 0 -> 2
 710       Port 3: E4:1D:2D:E7:0C:FB
 711       Checking link statuses...
 712       Port 0 Link Up - speed 40000 Mbps - full-duplex
 713       Port 1 Link Up - speed 40000 Mbps - full-duplex
 714       Port 2 Link Up - speed 10000 Mbps - full-duplex
 715       Port 3 Link Up - speed 10000 Mbps - full-duplex
 716       Done
 717       testpmd>