Skip to content

Commit 87f7895

Browse files
committed
doc: update mlx5 vDPA guide
Adjust supported devices and reformat headings layout. Signed-off-by: Thomas Monjalon <[email protected]>
1 parent 1b55eeb commit 87f7895

File tree

1 file changed

+15
-19
lines changed

1 file changed

+15
-19
lines changed

doc/guides/vdpadevs/mlx5.rst

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,43 +6,37 @@
66
NVIDIA MLX5 vDPA Driver
77
=======================
88

9-
The mlx5 vDPA (vhost data path acceleration) driver library
10-
(**librte_vdpa_mlx5**) provides support for **NVIDIA ConnectX-6**,
11-
**NVIDIA ConnectX-6 Dx**, **NVIDIA ConnectX-6 Lx**, **NVIDIA ConnectX7**,
12-
**NVIDIA BlueField**, **NVIDIA BlueField-2** and **NVIDIA BlueField-3** families
13-
of 10/25/40/50/100/200 Gb/s adapters as well as their virtual functions (VF) in
14-
SR-IOV context.
15-
16-
.. note::
17-
18-
This driver is enabled automatically when using "meson" build system which
19-
will detect dependencies.
9+
The mlx5 vDPA (vhost data path acceleration) driver (``librte_vdpa_mlx5``)
10+
provides support for NVIDIA NIC and DPU device families.
2011

2112
See :doc:`../../platform/mlx5` guide for design details,
2213
and which PMDs can be combined with vDPA PMD.
2314

15+
2416
Supported NICs
2517
--------------
2618

2719
* NVIDIA\ |reg| ConnectX\ |reg|-6
2820
* NVIDIA\ |reg| ConnectX\ |reg|-6 Lx
2921
* NVIDIA\ |reg| ConnectX\ |reg|-6 Dx
3022
* NVIDIA\ |reg| ConnectX\ |reg|-7
31-
* NVIDIA\ |reg| BlueField
32-
* NVIDIA\ |reg| BlueField |reg|-2
33-
* NVIDIA\ |reg| BlueField\ |reg|-3
23+
* NVIDIA\ |reg| BlueField\ |reg|-2 DPU
24+
* NVIDIA\ |reg| BlueField\ |reg|-3 DPU/SuperNIC
25+
3426

3527
Prerequisites
3628
-------------
3729

3830
- NVIDIA MLNX_OFED version: **5.0**
39-
See :ref:`mlx5 common prerequisites <mlx5_linux_prerequisites>` for more details.
31+
32+
See :ref:`mlx5 common prerequisites <mlx5_linux_prerequisites>` for more details.
33+
4034

4135
Run-time configuration
42-
~~~~~~~~~~~~~~~~~~~~~~
36+
----------------------
4337

4438
Driver options
45-
^^^^^^^^^^^^^^
39+
~~~~~~~~~~~~~~
4640

4741
Please refer to :ref:`mlx5 common options <mlx5_common_driver_options>`
4842
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.
136130

137131
- 0, default value, no pre-create virtq resource.
138132

133+
139134
Error handling
140-
^^^^^^^^^^^^^^
135+
--------------
141136

142137
Upon potential hardware errors, mlx5 PMD try to recover, give up if failed 3
143138
times in 3 seconds, virtq will be put in disable state. User should check log
144139
to get error information, or query vdpa statistics counter to know error type
145140
and count report.
146141

142+
147143
Statistics
148-
^^^^^^^^^^
144+
----------
149145

150146
The device statistics counter persists in reconfiguration until the device gets
151147
removed. User can reset counters by calling function rte_vdpa_reset_stats().

0 commit comments

Comments
 (0)