From: Thomas Monjalon <thomas@monjalon.net>
To: dev@dpdk.org
Cc: Matan Azrad <matan@nvidia.com>,
Viacheslav Ovsiienko <viacheslavo@nvidia.com>,
Dariusz Sosnowski <dsosnowski@nvidia.com>,
Bing Zhao <bingz@nvidia.com>, Ori Kam <orika@nvidia.com>,
Suanming Mou <suanmingm@nvidia.com>
Subject: [PATCH 1/4] doc: simplify mlx5 devices lists
Date: Fri, 18 Jul 2025 00:05:41 +0200 [thread overview]
Message-ID: <20250717220912.376503-2-thomas@monjalon.net> (raw)
In-Reply-To: <20250717220912.376503-1-thomas@monjalon.net>
No need to list all devices of a family.
Instead, a list of families is given with technical details.
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
doc/guides/nics/mlx4.rst | 5 +-
doc/guides/nics/mlx5.rst | 91 +++++++++++++-----------------------
doc/guides/platform/mlx5.rst | 9 ++--
doc/guides/vdpadevs/mlx5.rst | 16 +++----
4 files changed, 46 insertions(+), 75 deletions(-)
diff --git a/doc/guides/nics/mlx4.rst b/doc/guides/nics/mlx4.rst
index e92fcc155c..24aba8661b 100644
--- a/doc/guides/nics/mlx4.rst
+++ b/doc/guides/nics/mlx4.rst
@@ -267,9 +267,8 @@ Installing NVIDIA MLNX_OFED
connectx_port_config
-#. Continue with :ref:`section 2 of the Quick Start Guide <QSG_2>`.
+#. Continue with :ref:`section 2 of the Quick Start Guide <mlx4_QSG_2>`.
-.. _qsg:
Quick Start Guide
-----------------
@@ -286,7 +285,7 @@ Quick Start Guide
to Ethernet using connectx_port_config tool provided by it.
:ref:`OFED_as_a_fallback`:
-.. _QSG_2:
+.. _mlx4_QSG_2:
#. In case of bare metal or hypervisor, configure optimized steering mode
by adding the following line to ``/etc/modprobe.d/mlx4_core.conf``::
diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst
index 5c825dd6b0..1b136f083a 100644
--- a/doc/guides/nics/mlx5.rst
+++ b/doc/guides/nics/mlx5.rst
@@ -7,70 +7,45 @@
NVIDIA MLX5 Ethernet Driver
===========================
+The mlx5 Ethernet poll mode driver (``librte_net_mlx5``)
+provides support for NVIDIA NIC and DPU device families.
+The embedded switch, Physical Functions (PF),
+SR-IOV Virtual Functions (VF), Linux auxiliary Sub-Functions (SF),
+and their port representors are supported
+with many :ref:`features <mlx5_net_features>`.
-The mlx5 Ethernet poll mode driver library (**librte_net_mlx5**) provides support
-for **NVIDIA ConnectX-4**, **NVIDIA ConnectX-4 Lx** , **NVIDIA ConnectX-5**,
-**NVIDIA ConnectX-6**, **NVIDIA ConnectX-6 Dx**, **NVIDIA ConnectX-6 Lx**,
-**NVIDIA ConnectX-7**, **NVIDIA ConnectX-8**, **NVIDIA BlueField**,
-**NVIDIA BlueField-2** and **NVIDIA BlueField-3** families of
-10/25/40/50/100/200/400 Gb/s adapters as well as their virtual
-functions (VF) in SR-IOV context.
+For additional support, you may contact NVIDIA_.
-Supported NICs
---------------
+.. _NVIDIA: mailto:enterprisesupport@nvidia.com?subject=DPDK%20mlx5%20support&body=Company:%20%0D%0A%0D%0AEnvironment:%20%0D%0A%0D%0ADPDK%20version:%20%0D%0A%0D%0AQuestion:
-The following NVIDIA device families are supported by the same mlx5 driver:
- - ConnectX-4
- - ConnectX-4 Lx
- - ConnectX-5
- - ConnectX-5 Ex
- - ConnectX-6
- - ConnectX-6 Dx
- - ConnectX-6 Lx
- - ConnectX-7
- - ConnectX-8
- - BlueField
- - BlueField-2
- - BlueField-3
+Supported Devices
+-----------------
-Below are detailed device names:
+The following families of NVIDIA ConnectX NICs and BlueField DPUs are supported
+with the same driver:
-* NVIDIA\ |reg| ConnectX\ |reg|-4 10G MCX4111A-XCAT (1x10G)
-* NVIDIA\ |reg| ConnectX\ |reg|-4 10G MCX412A-XCAT (2x10G)
-* NVIDIA\ |reg| ConnectX\ |reg|-4 25G MCX4111A-ACAT (1x25G)
-* NVIDIA\ |reg| ConnectX\ |reg|-4 25G MCX412A-ACAT (2x25G)
-* NVIDIA\ |reg| ConnectX\ |reg|-4 40G MCX413A-BCAT (1x40G)
-* NVIDIA\ |reg| ConnectX\ |reg|-4 40G MCX4131A-BCAT (1x40G)
-* NVIDIA\ |reg| ConnectX\ |reg|-4 40G MCX415A-BCAT (1x40G)
-* NVIDIA\ |reg| ConnectX\ |reg|-4 50G MCX413A-GCAT (1x50G)
-* NVIDIA\ |reg| ConnectX\ |reg|-4 50G MCX4131A-GCAT (1x50G)
-* NVIDIA\ |reg| ConnectX\ |reg|-4 50G MCX414A-BCAT (2x50G)
-* NVIDIA\ |reg| ConnectX\ |reg|-4 50G MCX415A-GCAT (1x50G)
-* NVIDIA\ |reg| ConnectX\ |reg|-4 50G MCX416A-BCAT (2x50G)
-* NVIDIA\ |reg| ConnectX\ |reg|-4 50G MCX416A-GCAT (2x50G)
-* NVIDIA\ |reg| ConnectX\ |reg|-4 50G MCX415A-CCAT (1x100G)
-* NVIDIA\ |reg| ConnectX\ |reg|-4 100G MCX416A-CCAT (2x100G)
-* NVIDIA\ |reg| ConnectX\ |reg|-4 Lx 10G MCX4111A-XCAT (1x10G)
-* NVIDIA\ |reg| ConnectX\ |reg|-4 Lx 10G MCX4121A-XCAT (2x10G)
-* NVIDIA\ |reg| ConnectX\ |reg|-4 Lx 25G MCX4111A-ACAT (1x25G)
-* NVIDIA\ |reg| ConnectX\ |reg|-4 Lx 25G MCX4121A-ACAT (2x25G)
-* NVIDIA\ |reg| ConnectX\ |reg|-4 Lx 40G MCX4131A-BCAT (1x40G)
-* NVIDIA\ |reg| ConnectX\ |reg|-5 100G MCX556A-ECAT (2x100G)
-* NVIDIA\ |reg| ConnectX\ |reg|-5 Ex EN 100G MCX516A-CDAT (2x100G)
-* NVIDIA\ |reg| ConnectX\ |reg|-6 200G MCX654106A-HCAT (2x200G)
-* NVIDIA\ |reg| ConnectX\ |reg|-6 Dx EN 100G MCX623106AN-CDAT (2x100G)
-* NVIDIA\ |reg| ConnectX\ |reg|-6 Dx EN 200G MCX623105AN-VDAT (1x200G)
-* NVIDIA\ |reg| ConnectX\ |reg|-6 Lx EN 25G MCX631102AN-ADAT (2x25G)
-* NVIDIA\ |reg| ConnectX\ |reg|-7 200G CX713106AE-HEA_QP1_Ax (2x200G)
-* NVIDIA\ |reg| ConnectX\ |reg|-8 400G C900-9X81Q-00CN-STQ_Ax (2x400G)
-* NVIDIA\ |reg| BlueField\ |reg|-2 25G MBF2H332A-AEEOT_A1 (2x25Gg
-* NVIDIA\ |reg| BlueField\ |reg|-3 200GbE 900-9D3B6-00CV-AA0 (2x200)
-* NVIDIA\ |reg| BlueField\ |reg|-3 200GbE 900-9D3B6-00SV-AA0 (2x200)
-* NVIDIA\ |reg| BlueField\ |reg|-3 400GbE 900-9D3B6-00CN-AB0 (2x400)
-* NVIDIA\ |reg| BlueField\ |reg|-3 100GbE 900-9D3B4-00CC-EA0 (2x100)
-* NVIDIA\ |reg| BlueField\ |reg|-3 100GbE 900-9D3B4-00SC-EA0 (2x100)
-* NVIDIA\ |reg| BlueField\ |reg|-3 400GbE 900-9D3B4-00EN-EA0 (1x100)
+================== =============== ========= =========== ============
+NIC / DPU total bandwidth max ports PCIe embedded CPU
+================== =============== ========= =========== ============
+**ConnectX-4 Lx** 50 Gb/s 2 Gen3 --
+**ConnectX-4** 100 Gb/s 2 Gen3 --
+**ConnectX-5** 100 Gb/s 2 Gen3 --
+**ConnectX-5 Ex** 100 Gb/s 2 Gen4 --
+**ConnectX-6 Lx** 50 Gb/s 2 Gen3 / Gen4 --
+**ConnectX-6** 200 Gb/s 2 Gen3 / Gen4 --
+**ConnectX-6 Dx** 200 Gb/s 2 Gen4 --
+**BlueField-2** 200 Gb/s 2 Gen4 A72 x8
+**ConnectX-7** 400 Gb/s 4 Gen5 --
+**ConnectX-8** 400 Gb/s 4 Gen6 --
+**BlueField-3** 400 Gb/s 2 Gen5 A78 x16
+================== =============== ========= =========== ============
+
+The details of models and specifications can be found on the website
+for `ConnectX NICs <https://www.nvidia.com/en-in/networking/ethernet-adapters/>`_
+and `BlueField DPUs <https://www.nvidia.com/en-in/networking/products/data-processing-unit/>`_.
+
+A DPU can act as a NIC in NIC mode.
Design
diff --git a/doc/guides/platform/mlx5.rst b/doc/guides/platform/mlx5.rst
index 8742f84972..fe5cff7032 100644
--- a/doc/guides/platform/mlx5.rst
+++ b/doc/guides/platform/mlx5.rst
@@ -7,11 +7,10 @@
NVIDIA MLX5 Common Driver
=========================
-The mlx5 common driver library (**librte_common_mlx5**) provides support for
-**NVIDIA ConnectX-4**, **NVIDIA ConnectX-4 Lx**, **NVIDIA ConnectX-5**,
-**NVIDIA ConnectX-6**, **NVIDIA ConnectX-6 Dx**, **NVIDIA ConnectX-6 Lx**,
-**NVIDIA ConnectX-7**, **NVIDIA ConnectX-8**, **NVIDIA BlueField**, **NVIDIA BlueField-2** and
-**NVIDIA BlueField-3** families of 10/25/40/50/100/200 Gb/s adapters.
+The mlx5 common driver library (``librte_common_mlx5``) provides support
+for NVIDIA NIC and DPU device families.
+The SR-IOV Virtual Functions (VF), Linux auxiliary Sub-Functions (SF),
+and their port representors are supported as well.
Information and documentation for these adapters can be found on the
`NVIDIA website <https://www.nvidia.com/en-us/networking/>`_.
diff --git a/doc/guides/vdpadevs/mlx5.rst b/doc/guides/vdpadevs/mlx5.rst
index e7d37aa4ea..6cea1f43e9 100644
--- a/doc/guides/vdpadevs/mlx5.rst
+++ b/doc/guides/vdpadevs/mlx5.rst
@@ -24,15 +24,13 @@ and which PMDs can be combined with vDPA PMD.
Supported NICs
--------------
-* NVIDIA\ |reg| ConnectX\ |reg|-6 200G MCX654106A-HCAT (2x200G)
-* NVIDIA\ |reg| ConnectX\ |reg|-6 Dx EN 25G MCX621102AN-ADAT (2x25G)
-* NVIDIA\ |reg| ConnectX\ |reg|-6 Dx EN 100G MCX623106AN-CDAT (2x100G)
-* NVIDIA\ |reg| ConnectX\ |reg|-6 Dx EN 200G MCX623105AN-VDAT (1x200G)
-* NVIDIA\ |reg| ConnectX\ |reg|-6 Lx EN 25G MCX631102AN-ADAT (2x25G)
-* NVIDIA\ |reg| ConnectX\ |reg|-7 200G CX713106AE-HEA_QP1_Ax (2x200G)
-* NVIDIA\ |reg| BlueField SmartNIC 25G MBF1M332A-ASCAT (2x25G)
-* NVIDIA\ |reg| BlueField |reg|-2 SmartNIC MT41686 - MBF2H332A-AEEOT_A1 (2x25G)
-* NVIDIA\ |reg| BlueField\ |reg|-3 200GbE 900-9D3B6-00CV-AAB_Ax
+* NVIDIA\ |reg| ConnectX\ |reg|-6
+* NVIDIA\ |reg| ConnectX\ |reg|-6 Lx
+* NVIDIA\ |reg| ConnectX\ |reg|-6 Dx
+* NVIDIA\ |reg| ConnectX\ |reg|-7
+* NVIDIA\ |reg| BlueField
+* NVIDIA\ |reg| BlueField |reg|-2
+* NVIDIA\ |reg| BlueField\ |reg|-3
Prerequisites
-------------
--
2.47.1
next prev parent reply other threads:[~2025-07-17 22:09 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-07-17 22:05 [PATCH 0/4] rework mlx5 guide Thomas Monjalon
2025-07-17 22:05 ` Thomas Monjalon [this message]
2025-07-17 22:05 ` [PATCH 2/4] doc: add table styles for guides Thomas Monjalon
2025-07-17 22:05 ` [PATCH 3/4] doc: rework mlx5 guide per features Thomas Monjalon
2025-07-17 22:05 ` [PATCH 4/4] doc: add testpmd command examples in mlx5 guide Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250717220912.376503-2-thomas@monjalon.net \
--to=thomas@monjalon.net \
--cc=bingz@nvidia.com \
--cc=dev@dpdk.org \
--cc=dsosnowski@nvidia.com \
--cc=matan@nvidia.com \
--cc=orika@nvidia.com \
--cc=suanmingm@nvidia.com \
--cc=viacheslavo@nvidia.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).