summaryrefslogtreecommitdiff
path: root/doc/guides/nics/mlx5.rst
diff options
context:
space:
mode:
authorWisam Jaddo <wisamm@mellanox.com>2018-12-31 12:43:48 +0000
committerFerruh Yigit <ferruh.yigit@intel.com>2019-01-03 13:07:06 +0100
commitf0354d842344b976182e540044a2d5131ec94b6b (patch)
treec04f73a4a818d32303daca0ffbad120547960cf9 /doc/guides/nics/mlx5.rst
parentc0d2392631563a148111e76de25a02e4668762bb (diff)
downloaddpdk-f0354d842344b976182e540044a2d5131ec94b6b.zip
dpdk-f0354d842344b976182e540044a2d5131ec94b6b.tar.gz
dpdk-f0354d842344b976182e540044a2d5131ec94b6b.tar.xz
net/mlx5: add ConnectX-6 device IDs
This commit includes the add of: - ConnectX-6 device ID - ConnectX-6 SRIOV device ID Signed-off-by: Wisam Jaddo <wisamm@mellanox.com> Acked-by: Shahaf Shuler <shahafs@mellanox.com>
Diffstat (limited to 'doc/guides/nics/mlx5.rst')
-rw-r--r--doc/guides/nics/mlx5.rst32
1 files changed, 17 insertions, 15 deletions
diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 2c516fe..add8bc1 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -7,8 +7,9 @@ MLX5 poll mode driver
The MLX5 poll mode driver library (**librte_pmd_mlx5**) provides support
for **Mellanox ConnectX-4**, **Mellanox ConnectX-4 Lx** , **Mellanox
-ConnectX-5** and **Mellanox Bluefield** families of 10/25/40/50/100 Gb/s
-adapters as well as their virtual functions (VF) in SR-IOV context.
+ConnectX-5**, **Mellanox ConnectX-6** and **Mellanox Bluefield** families
+of 10/25/40/50/100/200 Gb/s adapters as well as their virtual functions (VF)
+in SR-IOV context.
Information and documentation about these adapters can be found on the
`Mellanox website <http://www.mellanox.com>`__. Help is also provided by the
@@ -274,8 +275,8 @@ Run-time configuration
Supported on:
- - x86_64 with ConnectX-4, ConnectX-4 LX, ConnectX-5 and Bluefield.
- - POWER8 and ARMv8 with ConnectX-4 LX, ConnectX-5 and Bluefield.
+ - x86_64 with ConnectX-4, ConnectX-4 LX, ConnectX-5, ConnectX-6 and Bluefield.
+ - POWER8 and ARMv8 with ConnectX-4 LX, ConnectX-5, ConnectX-6 and Bluefield.
- ``rxq_cqe_pad_en`` parameter [int]
@@ -359,13 +360,13 @@ Run-time configuration
This option should be used in combination with ``txq_inline`` above.
- On ConnectX-4, ConnectX-4 LX, ConnectX-5 and Bluefield without
+ On ConnectX-4, ConnectX-4 LX, ConnectX-5, ConnectX-6 and Bluefield without
Enhanced MPW:
- Disabled by default.
- In case ``txq_inline`` is set recommendation is 4.
- On ConnectX-5 and Bluefield with Enhanced MPW:
+ On ConnectX-5, ConnectX-6 and Bluefield with Enhanced MPW:
- Set to 8 by default.
@@ -386,7 +387,7 @@ Run-time configuration
- ``txq_mpw_en`` parameter [int]
A nonzero value enables multi-packet send (MPS) for ConnectX-4 Lx and
- enhanced multi-packet send (Enhanced MPS) for ConnectX-5 and Bluefield.
+ enhanced multi-packet send (Enhanced MPS) for ConnectX-5, ConnectX-6 and Bluefield.
MPS allows the TX burst function to pack up multiple packets in a
single descriptor session in order to save PCI bandwidth and improve
performance at the cost of a slightly higher CPU usage. When
@@ -401,13 +402,13 @@ Run-time configuration
DEV_TX_OFFLOAD_VXLAN_TNL_TSO, DEV_TX_OFFLOAD_GRE_TNL_TSO, DEV_TX_OFFLOAD_VLAN_INSERT``.
When those offloads are requested the MPS send function will not be used.
- It is currently only supported on the ConnectX-4 Lx, ConnectX-5 and Bluefield
+ It is currently only supported on the ConnectX-4 Lx, ConnectX-5, ConnectX-6 and Bluefield
families of adapters.
On ConnectX-4 Lx the MPW is considered un-secure hence disabled by default.
Users which enable the MPW should be aware that application which provides incorrect
mbuf descriptors in the Tx burst can lead to serious errors in the host including, on some cases,
NIC to get stuck.
- On ConnectX-5 and Bluefield the MPW is secure and enabled by default.
+ On ConnectX-5, ConnectX-6 and Bluefield the MPW is secure and enabled by default.
- ``txq_mpw_hdr_dseg_en`` parameter [int]
@@ -427,14 +428,14 @@ Run-time configuration
- ``tx_vec_en`` parameter [int]
- A nonzero value enables Tx vector on ConnectX-5 and Bluefield NICs if the number of
+ A nonzero value enables Tx vector on ConnectX-5, ConnectX-6 and Bluefield NICs if the number of
global Tx queues on the port is less than ``txqs_max_vec``.
This option cannot be used with certain offloads such as ``DEV_TX_OFFLOAD_TCP_TSO,
DEV_TX_OFFLOAD_VXLAN_TNL_TSO, DEV_TX_OFFLOAD_GRE_TNL_TSO, DEV_TX_OFFLOAD_VLAN_INSERT``.
When those offloads are requested the MPS send function will not be used.
- Enabled by default on ConnectX-5 and Bluefield.
+ Enabled by default on ConnectX-5, ConnectX-6 and Bluefield.
- ``rx_vec_en`` parameter [int]
@@ -518,7 +519,7 @@ DPDK and must be installed separately:
- **libmlx5**
Low-level user space driver library for Mellanox
- ConnectX-4/ConnectX-5/Bluefield devices, it is automatically loaded
+ ConnectX-4/ConnectX-5/ConnectX-6/Bluefield devices, it is automatically loaded
by libibverbs.
This library basically implements send/receive calls to the hardware
@@ -540,7 +541,7 @@ DPDK and must be installed separately:
their devices:
- mlx5_core: hardware driver managing Mellanox
- ConnectX-4/ConnectX-5/Bluefield devices and related Ethernet kernel
+ ConnectX-4/ConnectX-5/ConnectX-6/Bluefield devices and related Ethernet kernel
network devices.
- mlx5_ib: InifiniBand device driver.
- ib_uverbs: user space driver for Verbs (entry point for libibverbs).
@@ -548,7 +549,7 @@ DPDK and must be installed separately:
- **Firmware update**
Mellanox OFED releases include firmware updates for
- ConnectX-4/ConnectX-5/Bluefield adapters.
+ ConnectX-4/ConnectX-5/ConnectX-6/Bluefield adapters.
Because each release provides new features, these updates must be applied to
match the kernel modules and libraries they come with.
@@ -589,6 +590,7 @@ Mellanox OFED
- ConnectX-4 Lx: **14.21.1000** and above.
- ConnectX-5: **16.21.1000** and above.
- ConnectX-5 Ex: **16.21.1000** and above.
+ - ConnectX-6: **20.99.5374** and above.
- Bluefield: **18.99.3950** and above.
While these libraries and kernel modules are available on OpenFabrics
@@ -820,7 +822,7 @@ Usage example
-------------
This section demonstrates how to launch **testpmd** with Mellanox
-ConnectX-4/ConnectX-5/Bluefield devices managed by librte_pmd_mlx5.
+ConnectX-4/ConnectX-5/ConnectX-6/Bluefield devices managed by librte_pmd_mlx5.
#. Load the kernel modules: