- Move "Supported NICs" section up - Rename "Driver options" section to "Runtime Configuration" - Rename "Testpmd" section to "Testpmd driver specific commands" Signed-off-by: Ferruh Yigit --- doc/guides/nics/mlx5.rst | 116 +++++++++++++++++++-------------------- 1 file changed, 58 insertions(+), 58 deletions(-) diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index 7960a42e9cfc..ee654392ca0a 100644 --- a/doc/guides/nics/mlx5.rst +++ b/doc/guides/nics/mlx5.rst @@ -21,6 +21,60 @@ for **NVIDIA ConnectX-4**, **NVIDIA ConnectX-4 Lx** , **NVIDIA ConnectX-5**, **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. +Supported NICs +-------------- + +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 + - BlueField + - BlueField-2 + - BlueField-3 + +Below are detailed device names: + +* 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| 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) + Design ------ @@ -670,8 +724,8 @@ Firmware configuration See :ref:`mlx5_firmware_config` guide. -Driver options -~~~~~~~~~~~~~~ +Runtime Configuration +~~~~~~~~~~~~~~~~~~~~~ Please refer to :ref:`mlx5 common options ` for an additional list of options shared with other mlx5 drivers. @@ -1249,60 +1303,6 @@ for an additional list of options shared with other mlx5 drivers. By default, the PMD will set this value to 1. -Supported NICs --------------- - -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 - - BlueField - - BlueField-2 - - BlueField-3 - -Below are detailed device names: - -* 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| 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) - Sub-Function ------------ @@ -1991,8 +1991,8 @@ and disables ``avail_thresh_triggered``. testpmd> mlx5 set port 1 host_shaper avail_thresh_triggered 0 rate 50 -Testpmd -------- +Testpmd driver specific commands +-------------------------------- port attach with socket path ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- 2.34.1