* [PATCH] doc: update mlx5 vDPA guide
@ 2025-11-06 11:08 Thomas Monjalon
2025-11-06 11:13 ` Thomas Monjalon
0 siblings, 1 reply; 2+ messages in thread
From: Thomas Monjalon @ 2025-11-06 11:08 UTC (permalink / raw)
To: dev; +Cc: Matan Azrad, Viacheslav Ovsiienko
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
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2025-11-06 11:13 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2025-11-06 11:08 [PATCH] doc: update mlx5 vDPA guide Thomas Monjalon
2025-11-06 11:13 ` Thomas Monjalon
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).