From ee76bddc768c81b342d3901c84206421113544ca Mon Sep 17 00:00:00 2001 From: Thomas Monjalon Date: Mon, 24 Feb 2020 20:52:14 +0100 Subject: [PATCH] doc: fix naming of Mellanox devices The devices of the family ConnectX may have two letters as suffix. Such suffix is preceded with a space and the second x is lowercase: - ConnectX-4 Lx - ConnectX-5 Ex - ConnectX-6 Dx Uppercase of the device family name BlueField is also fixed. The lists of supported devices are fixed. Signed-off-by: Thomas Monjalon --- config/common_base | 4 +- doc/guides/nics/mlx4.rst | 5 -- doc/guides/nics/mlx5.rst | 81 ++++++++++++++++---------- doc/guides/rel_notes/release_18_08.rst | 2 +- doc/guides/rel_notes/release_19_02.rst | 2 +- doc/guides/rel_notes/release_19_11.rst | 2 +- doc/guides/vdpadevs/mlx5.rst | 12 ++-- drivers/net/mlx5/mlx5.c | 2 +- drivers/net/mlx5/mlx5_rxtx.c | 2 +- drivers/net/mlx5/mlx5_txq.c | 2 +- 10 files changed, 64 insertions(+), 50 deletions(-) diff --git a/config/common_base b/config/common_base index 6ea9c63cc3..7ca2f28b19 100644 --- a/config/common_base +++ b/config/common_base @@ -361,13 +361,13 @@ CONFIG_RTE_LIBRTE_MLX4_DEBUG=n # # Compile burst-oriented Mellanox ConnectX-4, ConnectX-5, -# ConnectX-6 & Bluefield (MLX5) PMD +# ConnectX-6 & BlueField (MLX5) PMD # CONFIG_RTE_LIBRTE_MLX5_PMD=n CONFIG_RTE_LIBRTE_MLX5_DEBUG=n # -# Compile vdpa-oriented Mellanox ConnectX-6 & Bluefield (MLX5) PMD +# Compile vdpa-oriented Mellanox ConnectX-6 & BlueField (MLX5) PMD # CONFIG_RTE_LIBRTE_MLX5_VDPA_PMD=n diff --git a/doc/guides/nics/mlx4.rst b/doc/guides/nics/mlx4.rst index 4b1d1aceb2..1f1e2f6c77 100644 --- a/doc/guides/nics/mlx4.rst +++ b/doc/guides/nics/mlx4.rst @@ -298,11 +298,6 @@ Installing Mellanox OFED 5. Continue with :ref:`section 2 of the Quick Start Guide `. -Supported NICs --------------- - -* Mellanox(R) ConnectX(R)-3 Pro 40G MCX354A-FCC_Ax (2*40G) - .. _qsg: Quick Start Guide diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index 006d075e86..4a9697941b 100644 --- a/doc/guides/nics/mlx5.rst +++ b/doc/guides/nics/mlx5.rst @@ -2,12 +2,14 @@ Copyright 2015 6WIND S.A. Copyright 2015 Mellanox Technologies, Ltd +.. include:: + 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**, **Mellanox ConnectX-6**, **Mellanox ConnectX-6DX** and +ConnectX-5**, **Mellanox ConnectX-6**, **Mellanox ConnectX-6 Dx** 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. @@ -336,9 +338,9 @@ Run-time configuration Supported on: - - x86_64 with ConnectX-4, ConnectX-4 LX, ConnectX-5, ConnectX-6, ConnectX-6 DX + - x86_64 with ConnectX-4, ConnectX-4 Lx, ConnectX-5, ConnectX-6, ConnectX-6 Dx and BlueField. - - POWER9 and ARMv8 with ConnectX-4 LX, ConnectX-5, ConnectX-6, ConnectX-6 DX + - POWER9 and ARMv8 with ConnectX-4 Lx, ConnectX-5, ConnectX-6, ConnectX-6 Dx and BlueField. - ``rxq_cqe_pad_en`` parameter [int] @@ -369,9 +371,9 @@ Run-time configuration Supported on: - - x86_64 with ConnectX-4, ConnectX-4 LX, ConnectX-5, ConnectX-6, ConnectX-6 DX + - x86_64 with ConnectX-4, ConnectX-4 Lx, ConnectX-5, ConnectX-6, ConnectX-6 Dx and BlueField. - - POWER8 and ARMv8 with ConnectX-4 LX, ConnectX-5, ConnectX-6, ConnectX-6 DX + - POWER8 and ARMv8 with ConnectX-4 Lx, ConnectX-5, ConnectX-6, ConnectX-6 Dx and BlueField. - ``mprq_en`` parameter [int] @@ -474,14 +476,14 @@ Run-time configuration If ``txq_inline_min`` key is not present, the value may be queried by the driver from the NIC via DevX if this feature is available. If there is no DevX enabled/supported the value 18 (supposing L2 header including VLAN) is set - for ConnectX-4 and ConnectX-4LX, and 0 is set by default for ConnectX-5 + for ConnectX-4 and ConnectX-4 Lx, and 0 is set by default for ConnectX-5 and newer NICs. If packet is shorter the ``txq_inline_min`` value, the entire packet is inlined. For ConnectX-4 NIC, driver does not allow specifying value below 18 (minimal L2 header, including VLAN), error will be raised. - For ConnectX-4LX NIC, it is allowed to specify values below 18, but + For ConnectX-4 Lx NIC, it is allowed to specify values below 18, but it is not recommended and may prevent NIC from sending packets over some configurations. @@ -564,7 +566,7 @@ Run-time configuration - ``txq_mpw_en`` parameter [int] A nonzero value enables Enhanced Multi-Packet Write (eMPW) for ConnectX-5, - ConnectX-6, ConnectX-6 DX and BlueField. eMPW allows the TX burst function to pack + ConnectX-6, ConnectX-6 Dx and BlueField. eMPW 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 ``txq_inline_mpw`` is set along with ``txq_mpw_en``, TX burst function copies @@ -611,7 +613,7 @@ Run-time configuration - ``tx_vec_en`` parameter [int] - A nonzero value enables Tx vector on ConnectX-5, ConnectX-6, ConnectX-6 DX + A nonzero value enables Tx vector on ConnectX-5, ConnectX-6, ConnectX-6 Dx and BlueField NICs if the number of global Tx queues on the port is less than ``txqs_max_vec``. The parameter is deprecated and ignored. @@ -912,7 +914,7 @@ Mellanox OFED/EN - ConnectX-5: **16.21.1000** and above. - ConnectX-5 Ex: **16.21.1000** and above. - ConnectX-6: **20.99.5374** and above. - - ConnectX-6 DX: **22.27.0090** and above. + - ConnectX-6 Dx: **22.27.0090** and above. - BlueField: **18.25.1010** and above. While these libraries and kernel modules are available on OpenFabrics @@ -937,28 +939,43 @@ required from that distribution. Supported NICs -------------- -* Mellanox(R) ConnectX(R)-4 10G MCX4111A-XCAT (1x10G) -* Mellanox(R) ConnectX(R)-4 10G MCX4121A-XCAT (2x10G) -* Mellanox(R) ConnectX(R)-4 25G MCX4111A-ACAT (1x25G) -* Mellanox(R) ConnectX(R)-4 25G MCX4121A-ACAT (2x25G) -* Mellanox(R) ConnectX(R)-4 40G MCX4131A-BCAT (1x40G) -* Mellanox(R) ConnectX(R)-4 40G MCX413A-BCAT (1x40G) -* Mellanox(R) ConnectX(R)-4 40G MCX415A-BCAT (1x40G) -* Mellanox(R) ConnectX(R)-4 50G MCX4131A-GCAT (1x50G) -* Mellanox(R) ConnectX(R)-4 50G MCX413A-GCAT (1x50G) -* Mellanox(R) ConnectX(R)-4 50G MCX414A-BCAT (2x50G) -* Mellanox(R) ConnectX(R)-4 50G MCX415A-GCAT (2x50G) -* Mellanox(R) ConnectX(R)-4 50G MCX416A-BCAT (2x50G) -* Mellanox(R) ConnectX(R)-4 50G MCX416A-GCAT (2x50G) -* Mellanox(R) ConnectX(R)-4 50G MCX415A-CCAT (1x100G) -* Mellanox(R) ConnectX(R)-4 100G MCX416A-CCAT (2x100G) -* Mellanox(R) ConnectX(R)-4 Lx 10G MCX4121A-XCAT (2x10G) -* Mellanox(R) ConnectX(R)-4 Lx 25G MCX4121A-ACAT (2x25G) -* Mellanox(R) ConnectX(R)-5 100G MCX556A-ECAT (2x100G) -* Mellanox(R) ConnectX(R)-5 Ex EN 100G MCX516A-CDAT (2x100G) -* Mellanox(R) ConnectX(R)-6 200G MCX654106A-HCAT (4x200G) -* Mellanox(R) ConnectX(R)-6DX EN 100G MCX623106AN-CDAT (2*100g) -* Mellanox(R) ConnectX(R)-6DX EN 200G MCX623105AN-VDAT (1*200g) +The following Mellanox device families are supported by the same mlx5 driver: + + - ConnectX-4 + - ConnectX-4 Lx + - ConnectX-5 + - ConnectX-5 Ex + - ConnectX-6 + - ConnectX-6 Dx + - BlueField + +Below are detailed device names: + +* Mellanox\ |reg| ConnectX\ |reg|-4 10G MCX4111A-XCAT (1x10G) +* Mellanox\ |reg| ConnectX\ |reg|-4 10G MCX412A-XCAT (2x10G) +* Mellanox\ |reg| ConnectX\ |reg|-4 25G MCX4111A-ACAT (1x25G) +* Mellanox\ |reg| ConnectX\ |reg|-4 25G MCX412A-ACAT (2x25G) +* Mellanox\ |reg| ConnectX\ |reg|-4 40G MCX413A-BCAT (1x40G) +* Mellanox\ |reg| ConnectX\ |reg|-4 40G MCX4131A-BCAT (1x40G) +* Mellanox\ |reg| ConnectX\ |reg|-4 40G MCX415A-BCAT (1x40G) +* Mellanox\ |reg| ConnectX\ |reg|-4 50G MCX413A-GCAT (1x50G) +* Mellanox\ |reg| ConnectX\ |reg|-4 50G MCX4131A-GCAT (1x50G) +* Mellanox\ |reg| ConnectX\ |reg|-4 50G MCX414A-BCAT (2x50G) +* Mellanox\ |reg| ConnectX\ |reg|-4 50G MCX415A-GCAT (1x50G) +* Mellanox\ |reg| ConnectX\ |reg|-4 50G MCX416A-BCAT (2x50G) +* Mellanox\ |reg| ConnectX\ |reg|-4 50G MCX416A-GCAT (2x50G) +* Mellanox\ |reg| ConnectX\ |reg|-4 50G MCX415A-CCAT (1x100G) +* Mellanox\ |reg| ConnectX\ |reg|-4 100G MCX416A-CCAT (2x100G) +* Mellanox\ |reg| ConnectX\ |reg|-4 Lx 10G MCX4111A-XCAT (1x10G) +* Mellanox\ |reg| ConnectX\ |reg|-4 Lx 10G MCX4121A-XCAT (2x10G) +* Mellanox\ |reg| ConnectX\ |reg|-4 Lx 25G MCX4111A-ACAT (1x25G) +* Mellanox\ |reg| ConnectX\ |reg|-4 Lx 25G MCX4121A-ACAT (2x25G) +* Mellanox\ |reg| ConnectX\ |reg|-4 Lx 40G MCX4131A-BCAT (1x40G) +* Mellanox\ |reg| ConnectX\ |reg|-5 100G MCX556A-ECAT (2x100G) +* Mellanox\ |reg| ConnectX\ |reg|-5 Ex EN 100G MCX516A-CDAT (2x100G) +* Mellanox\ |reg| ConnectX\ |reg|-6 200G MCX654106A-HCAT (2x200G) +* Mellanox\ |reg| ConnectX\ |reg|-6 Dx EN 100G MCX623106AN-CDAT (2x100G) +* Mellanox\ |reg| ConnectX\ |reg|-6 Dx EN 200G MCX623105AN-VDAT (1x200G) Quick Start Guide on OFED/EN ---------------------------- diff --git a/doc/guides/rel_notes/release_18_08.rst b/doc/guides/rel_notes/release_18_08.rst index 8a09dee95c..4ae388c331 100644 --- a/doc/guides/rel_notes/release_18_08.rst +++ b/doc/guides/rel_notes/release_18_08.rst @@ -546,4 +546,4 @@ Tested Platforms * Mellanox MLNX_OFED 4.2-1.4.21.0 * DPDK application running on ARM cores inside SmartNIC - * Bluefield representors support planned for next release. + * BlueField representors support planned for next release. diff --git a/doc/guides/rel_notes/release_19_02.rst b/doc/guides/rel_notes/release_19_02.rst index ace1534eff..87dfbf5c7d 100644 --- a/doc/guides/rel_notes/release_19_02.rst +++ b/doc/guides/rel_notes/release_19_02.rst @@ -109,7 +109,7 @@ New Features ``CONFIG_RTE_IBVERBS_LINK_DLOPEN`` for make and ``ibverbs_link`` for meson. * Added static linkage of ``mlx`` dependency. * Improved stability of E-Switch flow driver. - * Added new make build configuration to set the cacheline size for Bluefield + * Added new make build configuration to set the cacheline size for BlueField correctly - ``arm64-bluefield-linux-gcc``. * **Updated the enic driver.** diff --git a/doc/guides/rel_notes/release_19_11.rst b/doc/guides/rel_notes/release_19_11.rst index 84aa03a1f2..f0aee29477 100644 --- a/doc/guides/rel_notes/release_19_11.rst +++ b/doc/guides/rel_notes/release_19_11.rst @@ -206,7 +206,7 @@ New Features * Added support for VLAN set VID offload command. * Added support for matching on packets withe Geneve tunnel header. * Added hairpin support. - * Added ConnectX6-DX support. + * Added ConnectX-6 Dx support. * Flow engine selected based on RDMA Core library version. DV flow engine selected if version is rdma-core-24.0 or higher. Verbs flow engine selected otherwise. diff --git a/doc/guides/vdpadevs/mlx5.rst b/doc/guides/vdpadevs/mlx5.rst index 1660192221..dd377afda5 100644 --- a/doc/guides/vdpadevs/mlx5.rst +++ b/doc/guides/vdpadevs/mlx5.rst @@ -1,12 +1,14 @@ .. SPDX-License-Identifier: BSD-3-Clause Copyright 2019 Mellanox Technologies, Ltd +.. include:: + MLX5 vDPA driver ================ The MLX5 vDPA (vhost data path acceleration) driver library (**librte_pmd_mlx5_vdpa**) provides support for **Mellanox ConnectX-6**, -**Mellanox ConnectX-6DX** and **Mellanox BlueField** families of +**Mellanox ConnectX-6 Dx** 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. @@ -48,10 +50,10 @@ By default, the mlx5 device will be probed by the net/mlx5 driver. Supported NICs -------------- -* Mellanox(R) ConnectX(R)-6 200G MCX654106A-HCAT (4x200G) -* Mellanox(R) ConnectX(R)-6DX EN 100G MCX623106AN-CDAT (2*100G) -* Mellanox(R) ConnectX(R)-6DX EN 200G MCX623105AN-VDAT (1*200G) -* Mellanox(R) BlueField SmartNIC 25G MBF1M332A-ASCAT (2*25G) +* Mellanox\ |reg| ConnectX\ |reg|-6 200G MCX654106A-HCAT (2x200G) +* Mellanox\ |reg| ConnectX\ |reg|-6 Dx EN 100G MCX623106AN-CDAT (2x100G) +* Mellanox\ |reg| ConnectX\ |reg|-6 Dx EN 200G MCX623105AN-VDAT (1x200G) +* Mellanox\ |reg| BlueField SmartNIC 25G MBF1M332A-ASCAT (2x25G) Prerequisites ------------- diff --git a/drivers/net/mlx5/mlx5.c b/drivers/net/mlx5/mlx5.c index 4803760cab..94aaa60579 100644 --- a/drivers/net/mlx5/mlx5.c +++ b/drivers/net/mlx5/mlx5.c @@ -1724,7 +1724,7 @@ out: * key is specified in devargs * - if DevX is enabled the inline mode is queried from the * device (HCA attributes and NIC vport context if needed). - * - otherwise L2 mode (18 bytes) is assumed for ConnectX-4/4LX + * - otherwise L2 mode (18 bytes) is assumed for ConnectX-4/4 Lx * and none (0 bytes) for other NICs * * @param spawn diff --git a/drivers/net/mlx5/mlx5_rxtx.c b/drivers/net/mlx5/mlx5_rxtx.c index 2b4fc2ae06..5ac63da803 100644 --- a/drivers/net/mlx5/mlx5_rxtx.c +++ b/drivers/net/mlx5/mlx5_rxtx.c @@ -5213,7 +5213,7 @@ MLX5_TXOFF_DECL(iv, /* * Generate routines with Legacy Multi-Packet Write support. - * This mode is supported by ConnectX-4LX only and imposes + * This mode is supported by ConnectX-4 Lx only and imposes * offload limitations, not supported: * - ACL/Flows (metadata are becoming meaningless) * - WQE Inline headers diff --git a/drivers/net/mlx5/mlx5_txq.c b/drivers/net/mlx5/mlx5_txq.c index 2ad849a229..57bc116450 100644 --- a/drivers/net/mlx5/mlx5_txq.c +++ b/drivers/net/mlx5/mlx5_txq.c @@ -983,7 +983,7 @@ txq_set_params(struct mlx5_txq_ctrl *txq_ctrl) * If there is requested minimal amount of data to inline * we MUST enable inlining. This is a case for ConnectX-4 * which usually requires L2 inlined for correct operating - * and ConnectX-4LX which requires L2-L4 inlined to + * and ConnectX-4 Lx which requires L2-L4 inlined to * support E-Switch Flows. */ if (inlen_mode) { -- 2.20.1