5fd313c8d57229d7b4c4fa83c96b3fd1cd24bd1e
[dpdk.git] / doc / guides / nics / mlx5.rst
1 ..  SPDX-License-Identifier: BSD-3-Clause
2     Copyright 2015 6WIND S.A.
3     Copyright 2015 Mellanox Technologies, Ltd
4
5 MLX5 poll mode driver
6 =====================
7
8 The MLX5 poll mode driver library (**librte_pmd_mlx5**) provides support
9 for **Mellanox ConnectX-4**, **Mellanox ConnectX-4 Lx** , **Mellanox
10 ConnectX-5**, **Mellanox ConnectX-6**, **Mellanox ConnectX-6DX** and
11 **Mellanox BlueField** families of 10/25/40/50/100/200 Gb/s adapters
12 as well as their virtual functions (VF) in SR-IOV context.
13
14 Information and documentation about these adapters can be found on the
15 `Mellanox website <http://www.mellanox.com>`__. Help is also provided by the
16 `Mellanox community <http://community.mellanox.com/welcome>`__.
17
18 There is also a `section dedicated to this poll mode driver
19 <http://www.mellanox.com/page/products_dyn?product_family=209&mtag=pmd_for_dpdk>`__.
20
21 .. note::
22
23    Due to external dependencies, this driver is disabled in default configuration
24    of the "make" build. It can be enabled with ``CONFIG_RTE_LIBRTE_MLX5_PMD=y``
25    or by using "meson" build system which will detect dependencies.
26
27 Design
28 ------
29
30 Besides its dependency on libibverbs (that implies libmlx5 and associated
31 kernel support), librte_pmd_mlx5 relies heavily on system calls for control
32 operations such as querying/updating the MTU and flow control parameters.
33
34 For security reasons and robustness, this driver only deals with virtual
35 memory addresses. The way resources allocations are handled by the kernel,
36 combined with hardware specifications that allow to handle virtual memory
37 addresses directly, ensure that DPDK applications cannot access random
38 physical memory (or memory that does not belong to the current process).
39
40 This capability allows the PMD to coexist with kernel network interfaces
41 which remain functional, although they stop receiving unicast packets as
42 long as they share the same MAC address.
43 This means legacy linux control tools (for example: ethtool, ifconfig and
44 more) can operate on the same network interfaces that owned by the DPDK
45 application.
46
47 The PMD can use libibverbs and libmlx5 to access the device firmware
48 or directly the hardware components.
49 There are different levels of objects and bypassing abilities
50 to get the best performances:
51
52 - Verbs is a complete high-level generic API
53 - Direct Verbs is a device-specific API
54 - DevX allows to access firmware objects
55 - Direct Rules manages flow steering at low-level hardware layer
56
57 Enabling librte_pmd_mlx5 causes DPDK applications to be linked against
58 libibverbs.
59
60 Features
61 --------
62
63 - Multi arch support: x86_64, POWER8, ARMv8, i686.
64 - Multiple TX and RX queues.
65 - Support for scattered TX and RX frames.
66 - IPv4, IPv6, TCPv4, TCPv6, UDPv4 and UDPv6 RSS on any number of queues.
67 - Several RSS hash keys, one for each flow type.
68 - Default RSS operation with no hash key specification.
69 - Configurable RETA table.
70 - Link flow control (pause frame).
71 - Support for multiple MAC addresses.
72 - VLAN filtering.
73 - RX VLAN stripping.
74 - TX VLAN insertion.
75 - RX CRC stripping configuration.
76 - Promiscuous mode on PF and VF.
77 - Multicast promiscuous mode on PF and VF.
78 - Hardware checksum offloads.
79 - Flow director (RTE_FDIR_MODE_PERFECT, RTE_FDIR_MODE_PERFECT_MAC_VLAN and
80   RTE_ETH_FDIR_REJECT).
81 - Flow API, including :ref:`flow_isolated_mode`.
82 - Multiple process.
83 - KVM and VMware ESX SR-IOV modes are supported.
84 - RSS hash result is supported.
85 - Hardware TSO for generic IP or UDP tunnel, including VXLAN and GRE.
86 - Hardware checksum Tx offload for generic IP or UDP tunnel, including VXLAN and GRE.
87 - RX interrupts.
88 - Statistics query including Basic, Extended and per queue.
89 - Rx HW timestamp.
90 - Tunnel types: VXLAN, L3 VXLAN, VXLAN-GPE, GRE, MPLSoGRE, MPLSoUDP, IP-in-IP, Geneve.
91 - Tunnel HW offloads: packet type, inner/outer RSS, IP and UDP checksum verification.
92 - NIC HW offloads: encapsulation (vxlan, gre, mplsoudp, mplsogre), NAT, routing, TTL
93   increment/decrement, count, drop, mark. For details please see :ref:`mlx5_offloads_support`.
94 - Flow insertion rate of more then million flows per second, when using Direct Rules.
95 - Support for multiple rte_flow groups.
96 - Hardware LRO.
97
98 Limitations
99 -----------
100
101 - For secondary process:
102
103   - Forked secondary process not supported.
104   - External memory unregistered in EAL memseg list cannot be used for DMA
105     unless such memory has been registered by ``mlx5_mr_update_ext_mp()`` in
106     primary process and remapped to the same virtual address in secondary
107     process. If the external memory is registered by primary process but has
108     different virtual address in secondary process, unexpected error may happen.
109
110 - Flow pattern without any specific vlan will match for vlan packets as well:
111
112   When VLAN spec is not specified in the pattern, the matching rule will be created with VLAN as a wild card.
113   Meaning, the flow rule::
114
115         flow create 0 ingress pattern eth / vlan vid is 3 / ipv4 / end ...
116
117   Will only match vlan packets with vid=3. and the flow rules::
118
119         flow create 0 ingress pattern eth / ipv4 / end ...
120
121   Or::
122
123         flow create 0 ingress pattern eth / vlan / ipv4 / end ...
124
125   Will match any ipv4 packet (VLAN included).
126
127 - VLAN pop offload command:
128
129   - Flow rules having a VLAN pop offload command as one of their actions and
130     are lacking a match on VLAN as one of their items are not supported.
131   - The command is not supported on egress traffic.
132
133 - VLAN push offload is not supported on ingress traffic.
134
135 - VLAN set PCP offload is not supported on existing headers.
136
137 - A multi segment packet must have not more segments than reported by dev_infos_get()
138   in tx_desc_lim.nb_seg_max field. This value depends on maximal supported Tx descriptor
139   size and ``txq_inline_min`` settings and may be from 2 (worst case forced by maximal
140   inline settings) to 58.
141
142 - Flows with a VXLAN Network Identifier equal (or ends to be equal)
143   to 0 are not supported.
144
145 - VXLAN TSO and checksum offloads are not supported on VM.
146
147 - L3 VXLAN and VXLAN-GPE tunnels cannot be supported together with MPLSoGRE and MPLSoUDP.
148
149 - Match on Geneve header supports the following fields only:
150
151      - VNI
152      - OAM
153      - protocol type
154      - options length
155        Currently, the only supported options length value is 0.
156
157 - VF: flow rules created on VF devices can only match traffic targeted at the
158   configured MAC addresses (see ``rte_eth_dev_mac_addr_add()``).
159
160 .. note::
161
162    MAC addresses not already present in the bridge table of the associated
163    kernel network device will be added and cleaned up by the PMD when closing
164    the device. In case of ungraceful program termination, some entries may
165    remain present and should be removed manually by other means.
166
167 - When Multi-Packet Rx queue is configured (``mprq_en``), a Rx packet can be
168   externally attached to a user-provided mbuf with having EXT_ATTACHED_MBUF in
169   ol_flags. As the mempool for the external buffer is managed by PMD, all the
170   Rx mbufs must be freed before the device is closed. Otherwise, the mempool of
171   the external buffers will be freed by PMD and the application which still
172   holds the external buffers may be corrupted.
173
174 - If Multi-Packet Rx queue is configured (``mprq_en``) and Rx CQE compression is
175   enabled (``rxq_cqe_comp_en``) at the same time, RSS hash result is not fully
176   supported. Some Rx packets may not have PKT_RX_RSS_HASH.
177
178 - IPv6 Multicast messages are not supported on VM, while promiscuous mode
179   and allmulticast mode are both set to off.
180   To receive IPv6 Multicast messages on VM, explicitly set the relevant
181   MAC address using rte_eth_dev_mac_addr_add() API.
182
183 - The amount of descriptors in Tx queue may be limited by data inline settings.
184   Inline data require the more descriptor building blocks and overall block
185   amount may exceed the hardware supported limits. The application should
186   reduce the requested Tx size or adjust data inline settings with
187   ``txq_inline_max`` and ``txq_inline_mpw`` devargs keys.
188
189 - E-Switch decapsulation Flow:
190
191   - can be applied to PF port only.
192   - must specify VF port action (packet redirection from PF to VF).
193   - optionally may specify tunnel inner source and destination MAC addresses.
194
195 - E-Switch  encapsulation Flow:
196
197   - can be applied to VF ports only.
198   - must specify PF port action (packet redirection from VF to PF).
199
200 - ICMP/ICMP6 code/type matching, IP-in-IP and MPLS flow matching are all
201   mutually exclusive features which cannot be supported together
202   (see :ref:`mlx5_firmware_config`).
203
204 - LRO:
205
206   - Requires DevX and DV flow to be enabled.
207   - KEEP_CRC offload cannot be supported with LRO.
208   - The first mbuf length, without head-room,  must be big enough to include the
209     TCP header (122B).
210
211 Statistics
212 ----------
213
214 MLX5 supports various methods to report statistics:
215
216 Port statistics can be queried using ``rte_eth_stats_get()``. The received and sent statistics are through SW only and counts the number of packets received or sent successfully by the PMD. The imissed counter is the amount of packets that could not be delivered to SW because a queue was full. Packets not received due to congestion in the bus or on the NIC can be queried via the rx_discards_phy xstats counter.
217
218 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.
219
220 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.
221
222 Configuration
223 -------------
224
225 Compilation options
226 ~~~~~~~~~~~~~~~~~~~
227
228 These options can be modified in the ``.config`` file.
229
230 - ``CONFIG_RTE_LIBRTE_MLX5_PMD`` (default **n**)
231
232   Toggle compilation of librte_pmd_mlx5 itself.
233
234 - ``CONFIG_RTE_IBVERBS_LINK_DLOPEN`` (default **n**)
235
236   Build PMD with additional code to make it loadable without hard
237   dependencies on **libibverbs** nor **libmlx5**, which may not be installed
238   on the target system.
239
240   In this mode, their presence is still required for it to run properly,
241   however their absence won't prevent a DPDK application from starting (with
242   ``CONFIG_RTE_BUILD_SHARED_LIB`` disabled) and they won't show up as
243   missing with ``ldd(1)``.
244
245   It works by moving these dependencies to a purpose-built rdma-core "glue"
246   plug-in which must either be installed in a directory whose name is based
247   on ``CONFIG_RTE_EAL_PMD_PATH`` suffixed with ``-glue`` if set, or in a
248   standard location for the dynamic linker (e.g. ``/lib``) if left to the
249   default empty string (``""``).
250
251   This option has no performance impact.
252
253 - ``CONFIG_RTE_IBVERBS_LINK_STATIC`` (default **n**)
254
255   Embed static flavor of the dependencies **libibverbs** and **libmlx5**
256   in the PMD shared library or the executable static binary.
257
258 - ``CONFIG_RTE_LIBRTE_MLX5_DEBUG`` (default **n**)
259
260   Toggle debugging code and stricter compilation flags. Enabling this option
261   adds additional run-time checks and debugging messages at the cost of
262   lower performance.
263
264 .. note::
265
266    For BlueField, target should be set to ``arm64-bluefield-linux-gcc``. This
267    will enable ``CONFIG_RTE_LIBRTE_MLX5_PMD`` and set ``RTE_CACHE_LINE_SIZE`` to
268    64. Default armv8a configuration of make build and meson build set it to 128
269    then brings performance degradation.
270
271 Environment variables
272 ~~~~~~~~~~~~~~~~~~~~~
273
274 - ``MLX5_GLUE_PATH``
275
276   A list of directories in which to search for the rdma-core "glue" plug-in,
277   separated by colons or semi-colons.
278
279   Only matters when compiled with ``CONFIG_RTE_IBVERBS_LINK_DLOPEN``
280   enabled and most useful when ``CONFIG_RTE_EAL_PMD_PATH`` is also set,
281   since ``LD_LIBRARY_PATH`` has no effect in this case.
282
283 - ``MLX5_SHUT_UP_BF``
284
285   Configures HW Tx doorbell register as IO-mapped.
286
287   By default, the HW Tx doorbell is configured as a write-combining register.
288   The register would be flushed to HW usually when the write-combining buffer
289   becomes full, but it depends on CPU design.
290
291   Except for vectorized Tx burst routines, a write memory barrier is enforced
292   after updating the register so that the update can be immediately visible to
293   HW.
294
295   When vectorized Tx burst is called, the barrier is set only if the burst size
296   is not aligned to MLX5_VPMD_TX_MAX_BURST. However, setting this environmental
297   variable will bring better latency even though the maximum throughput can
298   slightly decline.
299
300 Run-time configuration
301 ~~~~~~~~~~~~~~~~~~~~~~
302
303 - librte_pmd_mlx5 brings kernel network interfaces up during initialization
304   because it is affected by their state. Forcing them down prevents packets
305   reception.
306
307 - **ethtool** operations on related kernel interfaces also affect the PMD.
308
309 - ``rxq_cqe_comp_en`` parameter [int]
310
311   A nonzero value enables the compression of CQE on RX side. This feature
312   allows to save PCI bandwidth and improve performance. Enabled by default.
313
314   Supported on:
315
316   - x86_64 with ConnectX-4, ConnectX-4 LX, ConnectX-5, ConnectX-6, ConnectX-6 DX
317     and BlueField.
318   - POWER9 and ARMv8 with ConnectX-4 LX, ConnectX-5, ConnectX-6, ConnectX-6 DX
319     and BlueField.
320
321 - ``rxq_cqe_pad_en`` parameter [int]
322
323   A nonzero value enables 128B padding of CQE on RX side. The size of CQE
324   is aligned with the size of a cacheline of the core. If cacheline size is
325   128B, the CQE size is configured to be 128B even though the device writes
326   only 64B data on the cacheline. This is to avoid unnecessary cache
327   invalidation by device's two consecutive writes on to one cacheline.
328   However in some architecture, it is more beneficial to update entire
329   cacheline with padding the rest 64B rather than striding because
330   read-modify-write could drop performance a lot. On the other hand,
331   writing extra data will consume more PCIe bandwidth and could also drop
332   the maximum throughput. It is recommended to empirically set this
333   parameter. Disabled by default.
334
335   Supported on:
336
337   - CPU having 128B cacheline with ConnectX-5 and BlueField.
338
339 - ``rxq_pkt_pad_en`` parameter [int]
340
341   A nonzero value enables padding Rx packet to the size of cacheline on PCI
342   transaction. This feature would waste PCI bandwidth but could improve
343   performance by avoiding partial cacheline write which may cause costly
344   read-modify-copy in memory transaction on some architectures. Disabled by
345   default.
346
347   Supported on:
348
349   - x86_64 with ConnectX-4, ConnectX-4 LX, ConnectX-5, ConnectX-6, ConnectX-6 DX
350     and BlueField.
351   - POWER8 and ARMv8 with ConnectX-4 LX, ConnectX-5, ConnectX-6, ConnectX-6 DX
352     and BlueField.
353
354 - ``mprq_en`` parameter [int]
355
356   A nonzero value enables configuring Multi-Packet Rx queues. Rx queue is
357   configured as Multi-Packet RQ if the total number of Rx queues is
358   ``rxqs_min_mprq`` or more and Rx scatter isn't configured. Disabled by
359   default.
360
361   Multi-Packet Rx Queue (MPRQ a.k.a Striding RQ) can further save PCIe bandwidth
362   by posting a single large buffer for multiple packets. Instead of posting a
363   buffers per a packet, one large buffer is posted in order to receive multiple
364   packets on the buffer. A MPRQ buffer consists of multiple fixed-size strides
365   and each stride receives one packet. MPRQ can improve throughput for
366   small-packet traffic.
367
368   When MPRQ is enabled, max_rx_pkt_len can be larger than the size of
369   user-provided mbuf even if DEV_RX_OFFLOAD_SCATTER isn't enabled. PMD will
370   configure large stride size enough to accommodate max_rx_pkt_len as long as
371   device allows. Note that this can waste system memory compared to enabling Rx
372   scatter and multi-segment packet.
373
374 - ``mprq_log_stride_num`` parameter [int]
375
376   Log 2 of the number of strides for Multi-Packet Rx queue. Configuring more
377   strides can reduce PCIe traffic further. If configured value is not in the
378   range of device capability, the default value will be set with a warning
379   message. The default value is 4 which is 16 strides per a buffer, valid only
380   if ``mprq_en`` is set.
381
382   The size of Rx queue should be bigger than the number of strides.
383
384 - ``mprq_max_memcpy_len`` parameter [int]
385
386   The maximum length of packet to memcpy in case of Multi-Packet Rx queue. Rx
387   packet is mem-copied to a user-provided mbuf if the size of Rx packet is less
388   than or equal to this parameter. Otherwise, PMD will attach the Rx packet to
389   the mbuf by external buffer attachment - ``rte_pktmbuf_attach_extbuf()``.
390   A mempool for external buffers will be allocated and managed by PMD. If Rx
391   packet is externally attached, ol_flags field of the mbuf will have
392   EXT_ATTACHED_MBUF and this flag must be preserved. ``RTE_MBUF_HAS_EXTBUF()``
393   checks the flag. The default value is 128, valid only if ``mprq_en`` is set.
394
395 - ``rxqs_min_mprq`` parameter [int]
396
397   Configure Rx queues as Multi-Packet RQ if the total number of Rx queues is
398   greater or equal to this value. The default value is 12, valid only if
399   ``mprq_en`` is set.
400
401 - ``txq_inline`` parameter [int]
402
403   Amount of data to be inlined during TX operations. This parameter is
404   deprecated and converted to the new parameter ``txq_inline_max`` providing
405   partial compatibility.
406
407 - ``txqs_min_inline`` parameter [int]
408
409   Enable inline data send only when the number of TX queues is greater or equal
410   to this value.
411
412   This option should be used in combination with ``txq_inline_max`` and
413   ``txq_inline_mpw`` below and does not affect ``txq_inline_min`` settings above.
414
415   If this option is not specified the default value 16 is used for BlueField
416   and 8 for other platforms
417
418   The data inlining consumes the CPU cycles, so this option is intended to
419   auto enable inline data if we have enough Tx queues, which means we have
420   enough CPU cores and PCI bandwidth is getting more critical and CPU
421   is not supposed to be bottleneck anymore.
422
423   The copying data into WQE improves latency and can improve PPS performance
424   when PCI back pressure is detected and may be useful for scenarios involving
425   heavy traffic on many queues.
426
427   Because additional software logic is necessary to handle this mode, this
428   option should be used with care, as it may lower performance when back
429   pressure is not expected.
430
431   If inline data are enabled it may affect the maximal size of Tx queue in
432   descriptors because the inline data increase the descriptor size and
433   queue size limits supported by hardware may be exceeded.
434
435 - ``txq_inline_min`` parameter [int]
436
437   Minimal amount of data to be inlined into WQE during Tx operations. NICs
438   may require this minimal data amount to operate correctly. The exact value
439   may depend on NIC operation mode, requested offloads, etc. It is strongly
440   recommended to omit this parameter and use the default values. Anyway,
441   applications using this parameter should take into consideration that
442   specifying an inconsistent value may prevent the NIC from sending packets.
443
444   If ``txq_inline_min`` key is present the specified value (may be aligned
445   by the driver in order not to exceed the limits and provide better descriptor
446   space utilization) will be used by the driver and it is guaranteed that
447   requested amount of data bytes are inlined into the WQE beside other inline
448   settings. This key also may update ``txq_inline_max`` value (default
449   or specified explicitly in devargs) to reserve the space for inline data.
450
451   If ``txq_inline_min`` key is not present, the value may be queried by the
452   driver from the NIC via DevX if this feature is available. If there is no DevX
453   enabled/supported the value 18 (supposing L2 header including VLAN) is set
454   for ConnectX-4 and ConnectX-4LX, and 0 is set by default for ConnectX-5
455   and newer NICs. If packet is shorter the ``txq_inline_min`` value, the entire
456   packet is inlined.
457
458   For ConnectX-4 NIC, driver does not allow specifying value below 18
459   (minimal L2 header, including VLAN), error will be raised.
460
461   For ConnectX-4LX NIC, it is allowed to specify values below 18, but
462   it is not recommended and may prevent NIC from sending packets over
463   some configurations.
464
465   Please, note, this minimal data inlining disengages eMPW feature (Enhanced
466   Multi-Packet Write), because last one does not support partial packet inlining.
467   This is not very critical due to minimal data inlining is mostly required
468   by ConnectX-4 and ConnectX-4 Lx, these NICs do not support eMPW feature.
469
470 - ``txq_inline_max`` parameter [int]
471
472   Specifies the maximal packet length to be completely inlined into WQE
473   Ethernet Segment for ordinary SEND method. If packet is larger than specified
474   value, the packet data won't be copied by the driver at all, data buffer
475   is addressed with a pointer. If packet length is less or equal all packet
476   data will be copied into WQE. This may improve PCI bandwidth utilization for
477   short packets significantly but requires the extra CPU cycles.
478
479   The data inline feature is controlled by number of Tx queues, if number of Tx
480   queues is larger than ``txqs_min_inline`` key parameter, the inline feature
481   is engaged, if there are not enough Tx queues (which means not enough CPU cores
482   and CPU resources are scarce), data inline is not performed by the driver.
483   Assigning ``txqs_min_inline`` with zero always enables the data inline.
484
485   The default ``txq_inline_max`` value is 290. The specified value may be adjusted
486   by the driver in order not to exceed the limit (930 bytes) and to provide better
487   WQE space filling without gaps, the adjustment is reflected in the debug log.
488   Also, the default value (290) may be decreased in run-time if the large transmit
489   queue size is requested and hardware does not support enough descriptor
490   amount, in this case warning is emitted. If ``txq_inline_max`` key is
491   specified and requested inline settings can not be satisfied then error
492   will be raised.
493
494 - ``txq_inline_mpw`` parameter [int]
495
496   Specifies the maximal packet length to be completely inlined into WQE for
497   Enhanced MPW method. If packet is large the specified value, the packet data
498   won't be copied, and data buffer is addressed with pointer. If packet length
499   is less or equal, all packet data will be copied into WQE. This may improve PCI
500   bandwidth utilization for short packets significantly but requires the extra
501   CPU cycles.
502
503   The data inline feature is controlled by number of TX queues, if number of Tx
504   queues is larger than ``txqs_min_inline`` key parameter, the inline feature
505   is engaged, if there are not enough Tx queues (which means not enough CPU cores
506   and CPU resources are scarce), data inline is not performed by the driver.
507   Assigning ``txqs_min_inline`` with zero always enables the data inline.
508
509   The default ``txq_inline_mpw`` value is 268. The specified value may be adjusted
510   by the driver in order not to exceed the limit (930 bytes) and to provide better
511   WQE space filling without gaps, the adjustment is reflected in the debug log.
512   Due to multiple packets may be included to the same WQE with Enhanced Multi
513   Packet Write Method and overall WQE size is limited it is not recommended to
514   specify large values for the ``txq_inline_mpw``. Also, the default value (268)
515   may be decreased in run-time if the large transmit queue size is requested
516   and hardware does not support enough descriptor amount, in this case warning
517   is emitted. If ``txq_inline_mpw`` key is  specified and requested inline
518   settings can not be satisfied then error will be raised.
519
520 - ``txqs_max_vec`` parameter [int]
521
522   Enable vectorized Tx only when the number of TX queues is less than or
523   equal to this value. This parameter is deprecated and ignored, kept
524   for compatibility issue to not prevent driver from probing.
525
526 - ``txq_mpw_hdr_dseg_en`` parameter [int]
527
528   A nonzero value enables including two pointers in the first block of TX
529   descriptor. The parameter is deprecated and ignored, kept for compatibility
530   issue.
531
532 - ``txq_max_inline_len`` parameter [int]
533
534   Maximum size of packet to be inlined. This limits the size of packet to
535   be inlined. If the size of a packet is larger than configured value, the
536   packet isn't inlined even though there's enough space remained in the
537   descriptor. Instead, the packet is included with pointer. This parameter
538   is deprecated and converted directly to ``txq_inline_mpw`` providing full
539   compatibility. Valid only if eMPW feature is engaged.
540
541 - ``txq_mpw_en`` parameter [int]
542
543   A nonzero value enables Enhanced Multi-Packet Write (eMPW) for ConnectX-5,
544   ConnectX-6, ConnectX-6 DX and BlueField. eMPW allows the TX burst function to pack
545   up multiple packets in a single descriptor session in order to save PCI bandwidth
546   and improve performance at the cost of a slightly higher CPU usage. When
547   ``txq_inline_mpw`` is set along with ``txq_mpw_en``, TX burst function copies
548   entire packet data on to TX descriptor instead of including pointer of packet.
549
550   The Enhanced Multi-Packet Write feature is enabled by default if NIC supports
551   it, can be disabled by explicit specifying 0 value for ``txq_mpw_en`` option.
552   Also, if minimal data inlining is requested by non-zero ``txq_inline_min``
553   option or reported by the NIC, the eMPW feature is disengaged.
554
555 - ``tx_db_nc`` parameter [int]
556
557   The rdma core library can map doorbell register in two ways, depending on the
558   environment variable "MLX5_SHUT_UP_BF":
559
560   - As regular cached memory, if the variable is either missing or set to zero.
561   - As non-cached memory, if the variable is present and set to not "0" value.
562
563   The type of mapping may slightly affect the Tx performance, the optimal choice
564   is strongly relied on the host architecture and should be deduced practically.
565
566   If ``tx_db_nc`` is either omitted or set to zero, the doorbell is forced to be
567   mapped to regular memory, the PMD will perform the extra write memory barrier
568   after writing to doorbell, it might increase the needed CPU clocks per packet
569   to send, but latency might be improved.
570
571   If ``tx_db_nc`` is set to not zero, the doorbell is forced to be mapped to
572   non cached memory, the PMD will not perform the extra write memory barrier
573   after writing to doorbell, on some architectures it might improve the
574   performance.
575
576   The default ``tx_db_nc`` value is zero ARM64 hosts and one for others.
577
578 - ``tx_vec_en`` parameter [int]
579
580   A nonzero value enables Tx vector on ConnectX-5, ConnectX-6, ConnectX-6 DX
581   and BlueField NICs if the number of global Tx queues on the port is less than
582   ``txqs_max_vec``. The parameter is deprecated and ignored.
583
584 - ``rx_vec_en`` parameter [int]
585
586   A nonzero value enables Rx vector if the port is not configured in
587   multi-segment otherwise this parameter is ignored.
588
589   Enabled by default.
590
591 - ``vf_nl_en`` parameter [int]
592
593   A nonzero value enables Netlink requests from the VF to add/remove MAC
594   addresses or/and enable/disable promiscuous/all multicast on the Netdevice.
595   Otherwise the relevant configuration must be run with Linux iproute2 tools.
596   This is a prerequisite to receive this kind of traffic.
597
598   Enabled by default, valid only on VF devices ignored otherwise.
599
600 - ``l3_vxlan_en`` parameter [int]
601
602   A nonzero value allows L3 VXLAN and VXLAN-GPE flow creation. To enable
603   L3 VXLAN or VXLAN-GPE, users has to configure firmware and enable this
604   parameter. This is a prerequisite to receive this kind of traffic.
605
606   Disabled by default.
607
608 - ``dv_xmeta_en`` parameter [int]
609
610   A nonzero value enables extensive flow metadata support if device is
611   capable and driver supports it. This can enable extensive support of
612   ``MARK`` and ``META`` item of ``rte_flow``. The newly introduced
613   ``SET_TAG`` and ``SET_META`` actions do not depend on ``dv_xmeta_en``.
614
615   There are some possible configurations, depending on parameter value:
616
617   - 0, this is default value, defines the legacy mode, the ``MARK`` and
618     ``META`` related actions and items operate only within NIC Tx and
619     NIC Rx steering domains, no ``MARK`` and ``META`` information crosses
620     the domain boundaries. The ``MARK`` item is 24 bits wide, the ``META``
621     item is 32 bits wide and match supported on egress only.
622
623   - 1, this engages extensive metadata mode, the ``MARK`` and ``META``
624     related actions and items operate within all supported steering domains,
625     including FDB, ``MARK`` and ``META`` information may cross the domain
626     boundaries. The ``MARK`` item is 24 bits wide, the ``META`` item width
627     depends on kernel and firmware configurations and might be 0, 16 or
628     32 bits. Within NIC Tx domain ``META`` data width is 32 bits for
629     compatibility, the actual width of data transferred to the FDB domain
630     depends on kernel configuration and may be vary. The actual supported
631     width can be retrieved in runtime by series of rte_flow_validate()
632     trials.
633
634   - 2, this engages extensive metadata mode, the ``MARK`` and ``META``
635     related actions and items operate within all supported steering domains,
636     including FDB, ``MARK`` and ``META`` information may cross the domain
637     boundaries. The ``META`` item is 32 bits wide, the ``MARK`` item width
638     depends on kernel and firmware configurations and might be 0, 16 or
639     24 bits. The actual supported width can be retrieved in runtime by
640     series of rte_flow_validate() trials.
641
642   +------+-----------+-----------+-------------+-------------+
643   | Mode | ``MARK``  | ``META``  | ``META`` Tx | FDB/Through |
644   +======+===========+===========+=============+=============+
645   | 0    | 24 bits   | 32 bits   | 32 bits     | no          |
646   +------+-----------+-----------+-------------+-------------+
647   | 1    | 24 bits   | vary 0-32 | 32 bits     | yes         |
648   +------+-----------+-----------+-------------+-------------+
649   | 2    | vary 0-32 | 32 bits   | 32 bits     | yes         |
650   +------+-----------+-----------+-------------+-------------+
651
652   If there is no E-Switch configuration the ``dv_xmeta_en`` parameter is
653   ignored and the device is configured to operate in legacy mode (0).
654
655   Disabled by default (set to 0).
656
657 - ``dv_flow_en`` parameter [int]
658
659   A nonzero value enables the DV flow steering assuming it is supported
660   by the driver.
661
662   Disabled by default.
663
664 - ``dv_esw_en`` parameter [int]
665
666   A nonzero value enables E-Switch using Direct Rules.
667
668   Enabled by default if supported.
669
670 - ``mr_ext_memseg_en`` parameter [int]
671
672   A nonzero value enables extending memseg when registering DMA memory. If
673   enabled, the number of entries in MR (Memory Region) lookup table on datapath
674   is minimized and it benefits performance. On the other hand, it worsens memory
675   utilization because registered memory is pinned by kernel driver. Even if a
676   page in the extended chunk is freed, that doesn't become reusable until the
677   entire memory is freed.
678
679   Enabled by default.
680
681 - ``representor`` parameter [list]
682
683   This parameter can be used to instantiate DPDK Ethernet devices from
684   existing port (or VF) representors configured on the device.
685
686   It is a standard parameter whose format is described in
687   :ref:`ethernet_device_standard_device_arguments`.
688
689   For instance, to probe port representors 0 through 2::
690
691     representor=[0-2]
692
693 - ``max_dump_files_num`` parameter [int]
694
695   The maximum number of files per PMD entity that may be created for debug information.
696   The files will be created in /var/log directory or in current directory.
697
698   set to 128 by default.
699
700 - ``lro_timeout_usec`` parameter [int]
701
702   The maximum allowed duration of an LRO session, in micro-seconds.
703   PMD will set the nearest value supported by HW, which is not bigger than
704   the input ``lro_timeout_usec`` value.
705   If this parameter is not specified, by default PMD will set
706   the smallest value supported by HW.
707
708 .. _mlx5_firmware_config:
709
710 Firmware configuration
711 ~~~~~~~~~~~~~~~~~~~~~~
712
713 Firmware features can be configured as key/value pairs.
714
715 The command to set a value is::
716
717   mlxconfig -d <device> set <key>=<value>
718
719 The command to query a value is::
720
721   mlxconfig -d <device> query | grep <key>
722
723 The device name for the command ``mlxconfig`` can be either the PCI address,
724 or the mst device name found with::
725
726   mst status
727
728 Below are some firmware configurations listed.
729
730 - link type::
731
732     LINK_TYPE_P1
733     LINK_TYPE_P2
734     value: 1=Infiniband 2=Ethernet 3=VPI(auto-sense)
735
736 - enable SR-IOV::
737
738     SRIOV_EN=1
739
740 - maximum number of SR-IOV virtual functions::
741
742     NUM_OF_VFS=<max>
743
744 - enable DevX (required by Direct Rules and other features)::
745
746     UCTX_EN=1
747
748 - aggressive CQE zipping::
749
750     CQE_COMPRESSION=1
751
752 - L3 VXLAN and VXLAN-GPE destination UDP port::
753
754     IP_OVER_VXLAN_EN=1
755     IP_OVER_VXLAN_PORT=<udp dport>
756
757 - enable IP-in-IP tunnel flow matching::
758
759     FLEX_PARSER_PROFILE_ENABLE=0
760
761 - enable MPLS flow matching::
762
763     FLEX_PARSER_PROFILE_ENABLE=1
764
765 - enable ICMP/ICMP6 code/type fields matching::
766
767     FLEX_PARSER_PROFILE_ENABLE=2
768
769 - enable Geneve flow matching::
770
771    FLEX_PARSER_PROFILE_ENABLE=0
772
773 Prerequisites
774 -------------
775
776 This driver relies on external libraries and kernel drivers for resources
777 allocations and initialization. The following dependencies are not part of
778 DPDK and must be installed separately:
779
780 - **libibverbs**
781
782   User space Verbs framework used by librte_pmd_mlx5. This library provides
783   a generic interface between the kernel and low-level user space drivers
784   such as libmlx5.
785
786   It allows slow and privileged operations (context initialization, hardware
787   resources allocations) to be managed by the kernel and fast operations to
788   never leave user space.
789
790 - **libmlx5**
791
792   Low-level user space driver library for Mellanox
793   ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices, it is automatically loaded
794   by libibverbs.
795
796   This library basically implements send/receive calls to the hardware
797   queues.
798
799 - **Kernel modules**
800
801   They provide the kernel-side Verbs API and low level device drivers that
802   manage actual hardware initialization and resources sharing with user
803   space processes.
804
805   Unlike most other PMDs, these modules must remain loaded and bound to
806   their devices:
807
808   - mlx5_core: hardware driver managing Mellanox
809     ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices and related Ethernet kernel
810     network devices.
811   - mlx5_ib: InifiniBand device driver.
812   - ib_uverbs: user space driver for Verbs (entry point for libibverbs).
813
814 - **Firmware update**
815
816   Mellanox OFED/EN releases include firmware updates for
817   ConnectX-4/ConnectX-5/ConnectX-6/BlueField adapters.
818
819   Because each release provides new features, these updates must be applied to
820   match the kernel modules and libraries they come with.
821
822 .. note::
823
824    Both libraries are BSD and GPL licensed. Linux kernel modules are GPL
825    licensed.
826
827 Installation
828 ~~~~~~~~~~~~
829
830 Either RDMA Core library with a recent enough Linux kernel release
831 (recommended) or Mellanox OFED/EN, which provides compatibility with older
832 releases.
833
834 RDMA Core with Linux Kernel
835 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
836
837 - Minimal kernel version : v4.14 or the most recent 4.14-rc (see `Linux installation documentation`_)
838 - Minimal rdma-core version: v15+ commit 0c5f5765213a ("Merge pull request #227 from yishaih/tm")
839   (see `RDMA Core installation documentation`_)
840 - When building for i686 use:
841
842   - rdma-core version 18.0 or above built with 32bit support.
843   - Kernel version 4.14.41 or above.
844
845 - Starting with rdma-core v21, static libraries can be built::
846
847     cd build
848     CFLAGS=-fPIC cmake -DIN_PLACE=1 -DENABLE_STATIC=1 -GNinja ..
849     ninja
850
851 .. _`Linux installation documentation`: https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux-stable.git/plain/Documentation/admin-guide/README.rst
852 .. _`RDMA Core installation documentation`: https://raw.githubusercontent.com/linux-rdma/rdma-core/master/README.md
853
854 If rdma-core libraries are built but not installed, DPDK makefile can link them,
855 thanks to these environment variables:
856
857    - ``EXTRA_CFLAGS=-I/path/to/rdma-core/build/include``
858    - ``EXTRA_LDFLAGS=-L/path/to/rdma-core/build/lib``
859    - ``PKG_CONFIG_PATH=/path/to/rdma-core/build/lib/pkgconfig``
860
861 Mellanox OFED/EN
862 ^^^^^^^^^^^^^^^^
863
864 - Mellanox OFED version: ** 4.5, 4.6** /
865   Mellanox EN version: **4.5, 4.6**
866 - firmware version:
867
868   - ConnectX-4: **12.21.1000** and above.
869   - ConnectX-4 Lx: **14.21.1000** and above.
870   - ConnectX-5: **16.21.1000** and above.
871   - ConnectX-5 Ex: **16.21.1000** and above.
872   - ConnectX-6: **20.99.5374** and above.
873   - ConnectX-6 DX: **22.27.0090** and above.
874   - BlueField: **18.25.1010** and above.
875
876 While these libraries and kernel modules are available on OpenFabrics
877 Alliance's `website <https://www.openfabrics.org/>`__ and provided by package
878 managers on most distributions, this PMD requires Ethernet extensions that
879 may not be supported at the moment (this is a work in progress).
880
881 `Mellanox OFED
882 <http://www.mellanox.com/page/products_dyn?product_family=26&mtag=linux>`__ and
883 `Mellanox EN
884 <http://www.mellanox.com/page/products_dyn?product_family=27&mtag=linux>`__
885 include the necessary support and should be used in the meantime. For DPDK,
886 only libibverbs, libmlx5, mlnx-ofed-kernel packages and firmware updates are
887 required from that distribution.
888
889 .. note::
890
891    Several versions of Mellanox OFED/EN are available. Installing the version
892    this DPDK release was developed and tested against is strongly
893    recommended. Please check the `prerequisites`_.
894
895 Supported NICs
896 --------------
897
898 * Mellanox(R) ConnectX(R)-4 10G MCX4111A-XCAT (1x10G)
899 * Mellanox(R) ConnectX(R)-4 10G MCX4121A-XCAT (2x10G)
900 * Mellanox(R) ConnectX(R)-4 25G MCX4111A-ACAT (1x25G)
901 * Mellanox(R) ConnectX(R)-4 25G MCX4121A-ACAT (2x25G)
902 * Mellanox(R) ConnectX(R)-4 40G MCX4131A-BCAT (1x40G)
903 * Mellanox(R) ConnectX(R)-4 40G MCX413A-BCAT (1x40G)
904 * Mellanox(R) ConnectX(R)-4 40G MCX415A-BCAT (1x40G)
905 * Mellanox(R) ConnectX(R)-4 50G MCX4131A-GCAT (1x50G)
906 * Mellanox(R) ConnectX(R)-4 50G MCX413A-GCAT (1x50G)
907 * Mellanox(R) ConnectX(R)-4 50G MCX414A-BCAT (2x50G)
908 * Mellanox(R) ConnectX(R)-4 50G MCX415A-GCAT (2x50G)
909 * Mellanox(R) ConnectX(R)-4 50G MCX416A-BCAT (2x50G)
910 * Mellanox(R) ConnectX(R)-4 50G MCX416A-GCAT (2x50G)
911 * Mellanox(R) ConnectX(R)-4 50G MCX415A-CCAT (1x100G)
912 * Mellanox(R) ConnectX(R)-4 100G MCX416A-CCAT (2x100G)
913 * Mellanox(R) ConnectX(R)-4 Lx 10G MCX4121A-XCAT (2x10G)
914 * Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G)
915 * Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G)
916 * Mellanox(R) ConnectX(R)-5 Ex EN 100G MCX516A-CDAT (2x100G)
917 * Mellanox(R) ConnectX(R)-6 200G MCX654106A-HCAT (4x200G)
918 * Mellanox(R) ConnectX(R)-6DX EN 100G MCX623106AN-CDAT (2*100g)
919 * Mellanox(R) ConnectX(R)-6DX EN 200G MCX623105AN-VDAT (1*200g)
920
921 Quick Start Guide on OFED/EN
922 ----------------------------
923
924 1. Download latest Mellanox OFED/EN. For more info check the  `prerequisites`_.
925
926
927 2. Install the required libraries and kernel modules either by installing
928    only the required set, or by installing the entire Mellanox OFED/EN::
929
930         ./mlnxofedinstall --upstream-libs --dpdk
931
932 3. Verify the firmware is the correct one::
933
934         ibv_devinfo
935
936 4. Verify all ports links are set to Ethernet::
937
938         mlxconfig -d <mst device> query | grep LINK_TYPE
939         LINK_TYPE_P1                        ETH(2)
940         LINK_TYPE_P2                        ETH(2)
941
942    Link types may have to be configured to Ethernet::
943
944         mlxconfig -d <mst device> set LINK_TYPE_P1/2=1/2/3
945
946         * LINK_TYPE_P1=<1|2|3> , 1=Infiniband 2=Ethernet 3=VPI(auto-sense)
947
948    For hypervisors, verify SR-IOV is enabled on the NIC::
949
950         mlxconfig -d <mst device> query | grep SRIOV_EN
951         SRIOV_EN                            True(1)
952
953    If needed, configure SR-IOV::
954
955         mlxconfig -d <mst device> set SRIOV_EN=1 NUM_OF_VFS=16
956         mlxfwreset -d <mst device> reset
957
958 5. Restart the driver::
959
960         /etc/init.d/openibd restart
961
962    or::
963
964         service openibd restart
965
966    If link type was changed, firmware must be reset as well::
967
968         mlxfwreset -d <mst device> reset
969
970    For hypervisors, after reset write the sysfs number of virtual functions
971    needed for the PF.
972
973    To dynamically instantiate a given number of virtual functions (VFs)::
974
975         echo [num_vfs] > /sys/class/infiniband/mlx5_0/device/sriov_numvfs
976
977 6. Compile DPDK and you are ready to go. See instructions on
978    :ref:`Development Kit Build System <Development_Kit_Build_System>`
979
980 Enable switchdev mode
981 ---------------------
982
983 Switchdev mode is a mode in E-Switch, that binds between representor and VF.
984 Representor is a port in DPDK that is connected to a VF in such a way
985 that assuming there are no offload flows, each packet that is sent from the VF
986 will be received by the corresponding representor. While each packet that is
987 sent to a representor will be received by the VF.
988 This is very useful in case of SRIOV mode, where the first packet that is sent
989 by the VF will be received by the DPDK application which will decide if this
990 flow should be offloaded to the E-Switch. After offloading the flow packet
991 that the VF that are matching the flow will not be received any more by
992 the DPDK application.
993
994 1. Enable SRIOV mode::
995
996         mlxconfig -d <mst device> set SRIOV_EN=true
997
998 2. Configure the max number of VFs::
999
1000         mlxconfig -d <mst device> set NUM_OF_VFS=<num of vfs>
1001
1002 3. Reset the FW::
1003
1004         mlxfwreset -d <mst device> reset
1005
1006 3. Configure the actual number of VFs::
1007
1008         echo <num of vfs > /sys/class/net/<net device>/device/sriov_numvfs
1009
1010 4. Unbind the device (can be rebind after the switchdev mode)::
1011
1012         echo -n "<device pci address" > /sys/bus/pci/drivers/mlx5_core/unbind
1013
1014 5. Enbale switchdev mode::
1015
1016         echo switchdev > /sys/class/net/<net device>/compat/devlink/mode
1017
1018 Performance tuning
1019 ------------------
1020
1021 1. Configure aggressive CQE Zipping for maximum performance::
1022
1023         mlxconfig -d <mst device> s CQE_COMPRESSION=1
1024
1025   To set it back to the default CQE Zipping mode use::
1026
1027         mlxconfig -d <mst device> s CQE_COMPRESSION=0
1028
1029 2. In case of virtualization:
1030
1031    - Make sure that hypervisor kernel is 3.16 or newer.
1032    - Configure boot with ``iommu=pt``.
1033    - Use 1G huge pages.
1034    - Make sure to allocate a VM on huge pages.
1035    - Make sure to set CPU pinning.
1036
1037 3. Use the CPU near local NUMA node to which the PCIe adapter is connected,
1038    for better performance. For VMs, verify that the right CPU
1039    and NUMA node are pinned according to the above. Run::
1040
1041         lstopo-no-graphics
1042
1043    to identify the NUMA node to which the PCIe adapter is connected.
1044
1045 4. If more than one adapter is used, and root complex capabilities allow
1046    to put both adapters on the same NUMA node without PCI bandwidth degradation,
1047    it is recommended to locate both adapters on the same NUMA node.
1048    This in order to forward packets from one to the other without
1049    NUMA performance penalty.
1050
1051 5. Disable pause frames::
1052
1053         ethtool -A <netdev> rx off tx off
1054
1055 6. Verify IO non-posted prefetch is disabled by default. This can be checked
1056    via the BIOS configuration. Please contact you server provider for more
1057    information about the settings.
1058
1059 .. note::
1060
1061         On some machines, depends on the machine integrator, it is beneficial
1062         to set the PCI max read request parameter to 1K. This can be
1063         done in the following way:
1064
1065         To query the read request size use::
1066
1067                 setpci -s <NIC PCI address> 68.w
1068
1069         If the output is different than 3XXX, set it by::
1070
1071                 setpci -s <NIC PCI address> 68.w=3XXX
1072
1073         The XXX can be different on different systems. Make sure to configure
1074         according to the setpci output.
1075
1076 7. To minimize overhead of searching Memory Regions:
1077
1078    - '--socket-mem' is recommended to pin memory by predictable amount.
1079    - Configure per-lcore cache when creating Mempools for packet buffer.
1080    - Refrain from dynamically allocating/freeing memory in run-time.
1081
1082 .. _mlx5_offloads_support:
1083
1084 Supported hardware offloads
1085 ---------------------------
1086
1087 .. table:: Minimal SW/HW versions for queue offloads
1088
1089    ============== ===== ===== ========= ===== ========== ==========
1090    Offload        DPDK  Linux rdma-core OFED   firmware   hardware
1091    ============== ===== ===== ========= ===== ========== ==========
1092    common base    17.11  4.14    16     4.2-1 12.21.1000 ConnectX-4
1093    checksums      17.11  4.14    16     4.2-1 12.21.1000 ConnectX-4
1094    Rx timestamp   17.11  4.14    16     4.2-1 12.21.1000 ConnectX-4
1095    TSO            17.11  4.14    16     4.2-1 12.21.1000 ConnectX-4
1096    LRO            19.08  N/A     N/A    4.6-4 16.25.6406 ConnectX-5
1097    ============== ===== ===== ========= ===== ========== ==========
1098
1099 .. table:: Minimal SW/HW versions for rte_flow offloads
1100
1101    +-----------------------+-----------------+-----------------+
1102    | Offload               | with E-Switch   | with vNIC       |
1103    +=======================+=================+=================+
1104    | Count                 | | DPDK 19.05    | | DPDK 19.02    |
1105    |                       | | OFED 4.6      | | OFED 4.6      |
1106    |                       | | rdma-core 24  | | rdma-core 23  |
1107    |                       | | ConnectX-5    | | ConnectX-5    |
1108    +-----------------------+-----------------+-----------------+
1109    | Drop / Queue / RSS    | | DPDK 19.05    | | DPDK 18.11    |
1110    |                       | | OFED 4.6      | | OFED 4.5      |
1111    |                       | | rdma-core 24  | | rdma-core 23  |
1112    |                       | | ConnectX-5    | | ConnectX-4    |
1113    +-----------------------+-----------------+-----------------+
1114    | Encapsulation         | | DPDK 19.05    | | DPDK 19.02    |
1115    | (VXLAN / NVGRE / RAW) | | OFED 4.6-2    | | OFED 4.6      |
1116    |                       | | rdma-core 24  | | rdma-core 23  |
1117    |                       | | ConnectX-5    | | ConnectX-5    |
1118    +-----------------------+-----------------+-----------------+
1119    | | Header rewrite      | | DPDK 19.05    | | DPDK 19.02    |
1120    | | (set_ipv4_src /     | | OFED 4.6-2    | | OFED 4.6-2    |
1121    | | set_ipv4_dst /      | | rdma-core 24  | | rdma-core 23  |
1122    | | set_ipv6_src /      | | ConnectX-5    | | ConnectX-5    |
1123    | | set_ipv6_dst /      | |               | |               |
1124    | | set_tp_src /        | |               | |               |
1125    | | set_tp_dst /        | |               | |               |
1126    | | dec_ttl /           | |               | |               |
1127    | | set_ttl /           | |               | |               |
1128    | | set_mac_src /       | |               | |               |
1129    | | set_mac_dst)        | |               | |               |
1130    | |                     | |               | |               |
1131    | | (of_set_vlan_vid)   | | DPDK 19.11    | | DPDK 19.11    |
1132    |                       | | OFED 4.6-4    | | OFED 4.6-4    |
1133    |                       | | ConnectX-5    | | ConnectX-5    |
1134    +-----------------------+-----------------+-----------------+
1135    | Jump                  | | DPDK 19.05    | | DPDK 19.02    |
1136    |                       | | OFED 4.6-4    | | OFED 4.6-4    |
1137    |                       | | rdma-core 24  | | N/A           |
1138    |                       | | ConnectX-5    | | ConnectX-5    |
1139    +-----------------------+-----------------+-----------------+
1140    | Mark / Flag           | | DPDK 19.05    | | DPDK 18.11    |
1141    |                       | | OFED 4.6      | | OFED 4.5      |
1142    |                       | | rdma-core 24  | | rdma-core 23  |
1143    |                       | | ConnectX-5    | | ConnectX-4    |
1144    +-----------------------+-----------------+-----------------+
1145    | Port ID               | | DPDK 19.05    |     | N/A       |
1146    |                       | | OFED 4.6      |     | N/A       |
1147    |                       | | rdma-core 24  |     | N/A       |
1148    |                       | | ConnectX-5    |     | N/A       |
1149    +-----------------------+-----------------+-----------------+
1150    | | VLAN                | | DPDK 19.11    | | DPDK 19.11    |
1151    | | (of_pop_vlan /      | | OFED 4.6-4    | | OFED 4.6-4    |
1152    | | of_push_vlan /      | | ConnectX-5    | | ConnectX-5    |
1153    | | of_set_vlan_pcp /   |                 |                 |
1154    | | of_set_vlan_vid)    |                 |                 |
1155    +-----------------------+-----------------+-----------------+
1156
1157 Notes for testpmd
1158 -----------------
1159
1160 Compared to librte_pmd_mlx4 that implements a single RSS configuration per
1161 port, librte_pmd_mlx5 supports per-protocol RSS configuration.
1162
1163 Since ``testpmd`` defaults to IP RSS mode and there is currently no
1164 command-line parameter to enable additional protocols (UDP and TCP as well
1165 as IP), the following commands must be entered from its CLI to get the same
1166 behavior as librte_pmd_mlx4::
1167
1168    > port stop all
1169    > port config all rss all
1170    > port start all
1171
1172 Usage example
1173 -------------
1174
1175 This section demonstrates how to launch **testpmd** with Mellanox
1176 ConnectX-4/ConnectX-5/ConnectX-6/BlueField devices managed by librte_pmd_mlx5.
1177
1178 #. Load the kernel modules::
1179
1180       modprobe -a ib_uverbs mlx5_core mlx5_ib
1181
1182    Alternatively if MLNX_OFED/MLNX_EN is fully installed, the following script
1183    can be run::
1184
1185       /etc/init.d/openibd restart
1186
1187    .. note::
1188
1189       User space I/O kernel modules (uio and igb_uio) are not used and do
1190       not have to be loaded.
1191
1192 #. Make sure Ethernet interfaces are in working order and linked to kernel
1193    verbs. Related sysfs entries should be present::
1194
1195       ls -d /sys/class/net/*/device/infiniband_verbs/uverbs* | cut -d / -f 5
1196
1197    Example output::
1198
1199       eth30
1200       eth31
1201       eth32
1202       eth33
1203
1204 #. Optionally, retrieve their PCI bus addresses for whitelisting::
1205
1206       {
1207           for intf in eth2 eth3 eth4 eth5;
1208           do
1209               (cd "/sys/class/net/${intf}/device/" && pwd -P);
1210           done;
1211       } |
1212       sed -n 's,.*/\(.*\),-w \1,p'
1213
1214    Example output::
1215
1216       -w 0000:05:00.1
1217       -w 0000:06:00.0
1218       -w 0000:06:00.1
1219       -w 0000:05:00.0
1220
1221 #. Request huge pages::
1222
1223       echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/nr_hugepages
1224
1225 #. Start testpmd with basic parameters::
1226
1227       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
1228
1229    Example output::
1230
1231       [...]
1232       EAL: PCI device 0000:05:00.0 on NUMA socket 0
1233       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
1234       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_0" (VF: false)
1235       PMD: librte_pmd_mlx5: 1 port(s) detected
1236       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fe
1237       EAL: PCI device 0000:05:00.1 on NUMA socket 0
1238       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
1239       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_1" (VF: false)
1240       PMD: librte_pmd_mlx5: 1 port(s) detected
1241       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:ff
1242       EAL: PCI device 0000:06:00.0 on NUMA socket 0
1243       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
1244       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_2" (VF: false)
1245       PMD: librte_pmd_mlx5: 1 port(s) detected
1246       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fa
1247       EAL: PCI device 0000:06:00.1 on NUMA socket 0
1248       EAL:   probe driver: 15b3:1013 librte_pmd_mlx5
1249       PMD: librte_pmd_mlx5: PCI information matches, using device "mlx5_3" (VF: false)
1250       PMD: librte_pmd_mlx5: 1 port(s) detected
1251       PMD: librte_pmd_mlx5: port 1 MAC address is e4:1d:2d:e7:0c:fb
1252       Interactive-mode selected
1253       Configuring Port 0 (socket 0)
1254       PMD: librte_pmd_mlx5: 0x8cba80: TX queues number update: 0 -> 2
1255       PMD: librte_pmd_mlx5: 0x8cba80: RX queues number update: 0 -> 2
1256       Port 0: E4:1D:2D:E7:0C:FE
1257       Configuring Port 1 (socket 0)
1258       PMD: librte_pmd_mlx5: 0x8ccac8: TX queues number update: 0 -> 2
1259       PMD: librte_pmd_mlx5: 0x8ccac8: RX queues number update: 0 -> 2
1260       Port 1: E4:1D:2D:E7:0C:FF
1261       Configuring Port 2 (socket 0)
1262       PMD: librte_pmd_mlx5: 0x8cdb10: TX queues number update: 0 -> 2
1263       PMD: librte_pmd_mlx5: 0x8cdb10: RX queues number update: 0 -> 2
1264       Port 2: E4:1D:2D:E7:0C:FA
1265       Configuring Port 3 (socket 0)
1266       PMD: librte_pmd_mlx5: 0x8ceb58: TX queues number update: 0 -> 2
1267       PMD: librte_pmd_mlx5: 0x8ceb58: RX queues number update: 0 -> 2
1268       Port 3: E4:1D:2D:E7:0C:FB
1269       Checking link statuses...
1270       Port 0 Link Up - speed 40000 Mbps - full-duplex
1271       Port 1 Link Up - speed 40000 Mbps - full-duplex
1272       Port 2 Link Up - speed 10000 Mbps - full-duplex
1273       Port 3 Link Up - speed 10000 Mbps - full-duplex
1274       Done
1275       testpmd>