From: Thomas Monjalon <thomas@monjalon.net>
To: dev@dpdk.org
Cc: Matan Azrad <matan@nvidia.com>,
Viacheslav Ovsiienko <viacheslavo@nvidia.com>
Subject: [PATCH] doc: update mlx5 vDPA guide
Date: Thu, 6 Nov 2025 12:08:06 +0100 [thread overview]
Message-ID: <20251106110807.1223973-1-thomas@monjalon.net> (raw)
Adjust supported devices and reformat headings layout.
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
doc/guides/vdpadevs/mlx5.rst | 34 +++++++++++++++-------------------
1 file changed, 15 insertions(+), 19 deletions(-)
diff --git a/doc/guides/vdpadevs/mlx5.rst b/doc/guides/vdpadevs/mlx5.rst
index 6cea1f43e9..2ee8112131 100644
--- a/doc/guides/vdpadevs/mlx5.rst
+++ b/doc/guides/vdpadevs/mlx5.rst
@@ -6,21 +6,13 @@
NVIDIA MLX5 vDPA Driver
=======================
-The mlx5 vDPA (vhost data path acceleration) driver library
-(**librte_vdpa_mlx5**) provides support for **NVIDIA ConnectX-6**,
-**NVIDIA ConnectX-6 Dx**, **NVIDIA ConnectX-6 Lx**, **NVIDIA ConnectX7**,
-**NVIDIA BlueField**, **NVIDIA BlueField-2** and **NVIDIA BlueField-3** families
-of 10/25/40/50/100/200 Gb/s adapters as well as their virtual functions (VF) in
-SR-IOV context.
-
-.. note::
-
- This driver is enabled automatically when using "meson" build system which
- will detect dependencies.
+The mlx5 vDPA (vhost data path acceleration) driver (``librte_vdpa_mlx5``)
+provides support for NVIDIA NIC and DPU device families.
See :doc:`../../platform/mlx5` guide for design details,
and which PMDs can be combined with vDPA PMD.
+
Supported NICs
--------------
@@ -28,21 +20,23 @@ Supported NICs
* 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
+* NVIDIA\ |reg| BlueField\ |reg|-2 DPU
+* NVIDIA\ |reg| BlueField\ |reg|-3 DPU/SuperNIC
+
Prerequisites
-------------
- NVIDIA MLNX_OFED version: **5.0**
- See :ref:`mlx5 common prerequisites <mlx5_linux_prerequisites>` for more details.
+
+See :ref:`mlx5 common prerequisites <mlx5_linux_prerequisites>` for more details.
+
Run-time configuration
-~~~~~~~~~~~~~~~~~~~~~~
+----------------------
Driver options
-^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~
Please refer to :ref:`mlx5 common options <mlx5_common_driver_options>`
for an additional list of options shared with other mlx5 drivers.
@@ -136,16 +130,18 @@ for an additional list of options shared with other mlx5 drivers.
- 0, default value, no pre-create virtq resource.
+
Error handling
-^^^^^^^^^^^^^^
+--------------
Upon potential hardware errors, mlx5 PMD try to recover, give up if failed 3
times in 3 seconds, virtq will be put in disable state. User should check log
to get error information, or query vdpa statistics counter to know error type
and count report.
+
Statistics
-^^^^^^^^^^
+----------
The device statistics counter persists in reconfiguration until the device gets
removed. User can reset counters by calling function rte_vdpa_reset_stats().
--
2.51.0
next reply other threads:[~2025-11-06 11:08 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-11-06 11:08 Thomas Monjalon [this message]
2025-11-06 11:13 ` 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=20251106110807.1223973-1-thomas@monjalon.net \
--to=thomas@monjalon.net \
--cc=dev@dpdk.org \
--cc=matan@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).