All of lore.kernel.org
 help / color / mirror / Atom feed
From: Ferruh Yigit <ferruh.yigit@amd.com>
To: John McNamara <john.mcnamara@intel.com>,
	Matan Azrad <matan@nvidia.com>,
	Viacheslav Ovsiienko <viacheslavo@nvidia.com>
Cc: Thomas Monjalon <thomas@monjalon.net>,
	Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>, <dev@dpdk.org>
Subject: [PATCH 19/33] doc: update mlx5 guide
Date: Tue, 21 Mar 2023 23:59:27 +0000	[thread overview]
Message-ID: <20230321235941.2169068-20-ferruh.yigit@amd.com> (raw)
In-Reply-To: <20230321235941.2169068-1-ferruh.yigit@amd.com>

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset="true", Size: 6616 bytes --]

- 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 <ferruh.yigit@amd.com>
---
 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 <mlx5_common_driver_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


  parent reply	other threads:[~2023-03-22  0:02 UTC|newest]

Thread overview: 54+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-03-21 23:59 [PATCH 00/33] Update net driver documentation Ferruh Yigit
2023-03-21 23:59 ` [PATCH 01/33] doc: update atlantic guide Ferruh Yigit
2023-03-22 10:21   ` [EXT] " Igor Russkikh
2023-03-21 23:59 ` [PATCH 02/33] doc: update cpfl guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 03/33] doc: update cxgbe guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 04/33] doc: update dpaa guide Ferruh Yigit
2023-03-22  9:01   ` Sachin Saxena (OSS)
2023-03-21 23:59 ` [PATCH 05/33] doc: update ena guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 06/33] doc: update enetc guide Ferruh Yigit
2023-03-22  9:07   ` Sachin Saxena (OSS)
2023-03-21 23:59 ` [PATCH 07/33] doc: update enetfec guide Ferruh Yigit
2023-03-22  9:08   ` Sachin Saxena (OSS)
2023-03-21 23:59 ` [PATCH 08/33] doc: update enic guide Ferruh Yigit
2023-03-22  2:32   ` Hyong Youb Kim (hyonkim)
2023-03-21 23:59 ` [PATCH 09/33] doc: update hns3 guide Ferruh Yigit
2023-03-22  0:33   ` fengchengwen
2023-03-22  7:54   ` Dongdong Liu
2023-03-21 23:59 ` [PATCH 10/33] doc: update i40e guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 11/33] doc: update ice guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 12/33] doc: update idpf guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 13/33] doc: update igb guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 14/33] doc: update igc guide Ferruh Yigit
2023-03-22  2:31   ` Su, Simei
2023-03-21 23:59 ` [PATCH 15/33] doc: update ipn3ke guide Ferruh Yigit
2023-03-22  1:41   ` Xu, Rosen
2023-03-21 23:59 ` [PATCH 16/33] doc: update ixgbe guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 17/33] doc: update kni guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 18/33] doc: update mana guide Ferruh Yigit
2023-03-22  0:09   ` Long Li
2023-03-21 23:59 ` Ferruh Yigit [this message]
2023-03-21 23:59 ` [PATCH 20/33] doc: update mvneta guide Ferruh Yigit
2023-03-22 11:45   ` [EXT] " Liron Himi
2023-03-21 23:59 ` [PATCH 21/33] doc: update netvsc guide Ferruh Yigit
2023-03-22  0:09   ` Long Li
2023-03-21 23:59 ` [PATCH 22/33] doc: update ngbe guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 23/33] doc: update net null guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 24/33] doc: update octeontx guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 25/33] doc: update pfe guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 26/33] doc: update qede guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 27/33] doc: update sfc guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 28/33] doc: update softnic guide Ferruh Yigit
2023-03-22 12:43   ` Dumitrescu, Cristian
2023-03-21 23:59 ` [PATCH 29/33] doc: update thunderx guide Ferruh Yigit
2023-03-22 13:18   ` Jerin Jacob
2023-03-21 23:59 ` [PATCH 30/33] doc: update txgbe guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 31/33] doc: update vdev netvsc guide Ferruh Yigit
2023-03-21 23:59 ` [PATCH 32/33] doc: update vhost guide Ferruh Yigit
2023-03-22  2:17   ` Xia, Chenbo
2023-03-21 23:59 ` [PATCH 33/33] doc: update virtio guide Ferruh Yigit
2023-03-22  2:17   ` Xia, Chenbo
2023-03-22  0:48 ` [PATCH 00/33] Update net driver documentation fengchengwen
2023-03-22  8:43   ` Ferruh Yigit
2023-03-22  2:53 ` Zhang, Qi Z
2023-03-28 16:59 ` 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=20230321235941.2169068-20-ferruh.yigit@amd.com \
    --to=ferruh.yigit@amd.com \
    --cc=andrew.rybchenko@oktetlabs.ru \
    --cc=dev@dpdk.org \
    --cc=john.mcnamara@intel.com \
    --cc=matan@nvidia.com \
    --cc=thomas@monjalon.net \
    --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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.