[PATCH 00/33] Update net driver documentation

[PATCH 00/33] Update net driver documentation

[Ferruh Yigit]

Some PMDs has "Pre-Installation Configuration" section in their documentation,
although section is not clear I assume that is historical from times compile
time parameters and 'make' build system used, where common make target was
'install', so section refers to compile time configuration.

Right now device arguments ("Runtime configuration") is documented under this
section which is confusing, so updating section name
from "Pre-Installation Configuration" to "Configuration".

While touching documents trying to keep following template in the documents,
with section names and order, to have consistent documents without being
too strict on applying the template:

	[Overview]
	Supported Devices
	Supported Features
	Prerequisites
	Configuration
		Compilation Options
		Environment variables
		Runtime Configuration
	Debugging
	Limitations or Known issues
	Testpmd driver specific commands

Note: Patch sent as each driver separately to help review, it can be squashed
while merging.

Other further improvements not covered here can be visiting
 "Building DPDK" sections which has redundant and less useful information,
 and "Usage example" section which has testpmd log, most of the part is same for
 all drivers.

.

Ferruh Yigit (33):
  doc: update atlantic guide
  doc: update cpfl guide
  doc: update cxgbe guide
  doc: update dpaa guide
  doc: update ena guide
  doc: update enetc guide
  doc: update enetfec guide
  doc: update enic guide
  doc: update hns3 guide
  doc: update i40e guide
  doc: update ice guide
  doc: update idpf guide
  doc: update igb guide
  doc: update igc guide
  doc: update ipn3ke guide
  doc: update ixgbe guide
  doc: update kni guide
  doc: update mana guide
  doc: update mlx5 guide
  doc: update mvneta guide
  doc: update netvsc guide
  doc: update ngbe guide
  doc: update net null guide
  doc: update octeontx guide
  doc: update pfe guide
  doc: update qede guide
  doc: update sfc guide
  doc: update softnic guide
  doc: update thunderx guide
  doc: update txgbe guide
  doc: update vdev netvsc guide
  doc: update vhost guide
  doc: update virtio guide

 doc/guides/nics/atlantic.rst    |  27 +++-----
 doc/guides/nics/cpfl.rst        |  51 +++++++-------
 doc/guides/nics/cxgbe.rst       |  61 ++++++++---------
 doc/guides/nics/dpaa.rst        |   5 +-
 doc/guides/nics/ena.rst         |  60 +++++++++--------
 doc/guides/nics/enetc.rst       |  25 +++----
 doc/guides/nics/enetfec.rst     |  12 ++--
 doc/guides/nics/enic.rst        |  79 ++++++++++------------
 doc/guides/nics/hns3.rst        |  30 ++++-----
 doc/guides/nics/i40e.rst        |  10 +--
 doc/guides/nics/ice.rst         |   8 +--
 doc/guides/nics/idpf.rst        |   8 +--
 doc/guides/nics/igb.rst         |  23 +++----
 doc/guides/nics/igc.rst         |  16 ++---
 doc/guides/nics/ipn3ke.rst      |   9 ++-
 doc/guides/nics/ixgbe.rst       |  62 ++++++++---------
 doc/guides/nics/kni.rst         |   4 +-
 doc/guides/nics/mana.rst        |   4 +-
 doc/guides/nics/mlx5.rst        | 116 ++++++++++++++++----------------
 doc/guides/nics/mvneta.rst      |   4 +-
 doc/guides/nics/netvsc.rst      |   4 +-
 doc/guides/nics/ngbe.rst        |   4 +-
 doc/guides/nics/null.rst        |   4 +-
 doc/guides/nics/octeontx.rst    |  15 ++---
 doc/guides/nics/pfe.rst         |  25 +++----
 doc/guides/nics/qede.rst        |  14 ++--
 doc/guides/nics/sfc_efx.rst     |  94 +++++++++++++-------------
 doc/guides/nics/softnic.rst     |   4 +-
 doc/guides/nics/thunderx.rst    |  16 ++---
 doc/guides/nics/txgbe.rst       |  12 ++--
 doc/guides/nics/vdev_netvsc.rst |   4 +-
 doc/guides/nics/vhost.rst       |   4 +-
 doc/guides/nics/virtio.rst      |   4 +-
 33 files changed, 395 insertions(+), 423 deletions(-)

-- 
2.34.1

[PATCH 01/33] doc: update atlantic guide

[Ferruh Yigit]

- Move "Supported Chipsets and NICs" section to top
- Fix section indentation
- Remove empty sections

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/atlantic.rst | 27 ++++++++++-----------------
 1 file changed, 10 insertions(+), 17 deletions(-)

diff --git a/doc/guides/nics/atlantic.rst b/doc/guides/nics/atlantic.rst
index 605f6dc3ab10..104e642c3c5a 100644
--- a/doc/guides/nics/atlantic.rst
+++ b/doc/guides/nics/atlantic.rst
@@ -9,8 +9,15 @@ Atlantic DPDK driver provides DPDK support for Aquantia's AQtion family of chips
 More information can be found at `Aquantia Official Website
 <https://www.aquantia.com/products/client-connectivity/>`_.
 
+Supported Chipsets and NICs
+---------------------------
+
+- Aquantia AQtion AQC107 10 Gigabit Ethernet Controller
+- Aquantia AQtion AQC108 5 Gigabit Ethernet Controller
+- Aquantia AQtion AQC109 2.5 Gigabit Ethernet Controller
+
 Supported features
-^^^^^^^^^^^^^^^^^^
+------------------
 
 - Base L2 features
 - Promiscuous mode
@@ -22,28 +29,14 @@ Supported features
 - MACSEC offload
 
 Experimental API features
-^^^^^^^^^^^^^^^^^^^^^^^^^
+-------------------------
 
 - MACSEC PMD API is considered as experimental and is subject to change/removal in next DPDK releases.
 
-
-Application Programming Interface
----------------------------------
-
 Limitations or Known issues
 ---------------------------
 
-Statistics
-~~~~~~~~~~
-
 MTU setting
-~~~~~~~~~~~
+^^^^^^^^^^^
 
 Atlantic NIC supports up to 16K jumbo frame size
-
-Supported Chipsets and NICs
----------------------------
-
-- Aquantia AQtion AQC107 10 Gigabit Ethernet Controller
-- Aquantia AQtion AQC108 5 Gigabit Ethernet Controller
-- Aquantia AQtion AQC109 2.5 Gigabit Ethernet Controller
-- 
2.34.1

Re: [EXT] [PATCH 01/33] doc: update atlantic guide

[Igor Russkikh]

> - Move "Supported Chipsets and NICs" section to top
> - Fix section indentation
> - Remove empty sections
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>


Thanks for taking care, Ferruh!

Reviewed-by: Igor Russkikh <irusskikh@marvell.com>

[PATCH 02/33] doc: update cpfl guide

[Ferruh Yigit]

- Rename "Pre-Installation Configuration" section to "Configuration"
- Rename "Runtime Config Options" section to "Runtime Configuration"

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/cpfl.rst | 51 ++++++++++++++++++++--------------------
 1 file changed, 25 insertions(+), 26 deletions(-)

diff --git a/doc/guides/nics/cpfl.rst b/doc/guides/nics/cpfl.rst
index e2d71f8a4c20..91dbec306dbb 100644
--- a/doc/guides/nics/cpfl.rst
+++ b/doc/guides/nics/cpfl.rst
@@ -20,12 +20,33 @@ Follow the DPDK :doc:`../linux_gsg/index` to setup the basic DPDK environment.
 To get better performance on Intel platforms,
 please follow the :doc:`../linux_gsg/nic_perf_intel_platform`.
 
+Features
+--------
 
-Pre-Installation Configuration
-------------------------------
+Vector PMD
+~~~~~~~~~~
+
+Vector path for Rx and Tx path are selected automatically.
+The paths are chosen based on 2 conditions:
+
+- ``CPU``
+
+  On the x86 platform, the driver checks if the CPU supports AVX512.
+  If the CPU supports AVX512 and EAL argument ``--force-max-simd-bitwidth``
+  is set to 512, AVX512 paths will be chosen.
+
+- ``Offload features``
+
+  The supported HW offload features are described in the document cpfl.ini,
+  A value "P" means the offload feature is not supported by vector path.
+  If any not supported features are used, cpfl vector PMD is disabled
+  and the scalar paths are chosen.
+
+Configuration
+-------------
 
-Runtime Config Options
-~~~~~~~~~~~~~~~~~~~~~~
+Runtime Configuration
+~~~~~~~~~~~~~~~~~~~~~
 
 - ``vport`` (default ``0``)
 
@@ -83,25 +104,3 @@ Driver compilation and testing
 ------------------------------
 
 Refer to the document :doc:`build_and_test` for details.
-
-Features
---------
-
-Vector PMD
-~~~~~~~~~~
-
-Vector path for Rx and Tx path are selected automatically.
-The paths are chosen based on 2 conditions:
-
-- ``CPU``
-
-  On the x86 platform, the driver checks if the CPU supports AVX512.
-  If the CPU supports AVX512 and EAL argument ``--force-max-simd-bitwidth``
-  is set to 512, AVX512 paths will be chosen.
-
-- ``Offload features``
-
-  The supported HW offload features are described in the document cpfl.ini,
-  A value "P" means the offload feature is not supported by vector path.
-  If any not supported features are used, cpfl vector PMD is disabled
-  and the scalar paths are chosen.
-- 
2.34.1

[PATCH 03/33] doc: update cxgbe guide

[Ferruh Yigit]

- Move supported device list up
- Rename "Runtime Options" section to "Runtime Configuration"
- Move "Limitations" section down

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/cxgbe.rst | 61 ++++++++++++++++++++-------------------
 1 file changed, 31 insertions(+), 30 deletions(-)

diff --git a/doc/guides/nics/cxgbe.rst b/doc/guides/nics/cxgbe.rst
index 6d20384b70ed..1f0b848ede11 100644
--- a/doc/guides/nics/cxgbe.rst
+++ b/doc/guides/nics/cxgbe.rst
@@ -15,34 +15,6 @@ and has support for the latest Linux operating systems.
 More information can be found at `Chelsio Communications Official Website
 <http://www.chelsio.com>`_.
 
-Features
---------
-
-CXGBE and CXGBEVF PMD has support for:
-
-- Multiple queues for TX and RX
-- Receiver Side Steering (RSS)
-  Receiver Side Steering (RSS) on IPv4, IPv6, IPv4-TCP/UDP, IPv6-TCP/UDP.
-  For 4-tuple, enabling 'RSS on TCP' and 'RSS on TCP + UDP' is supported.
-- VLAN filtering
-- Checksum offload
-- Promiscuous mode
-- All multicast mode
-- Port hardware statistics
-- Jumbo frames
-- Flow API - Support for both Wildcard (LE-TCAM) and Exact (HASH) match filters.
-
-Limitations
------------
-
-The Chelsio Terminator series of devices provide two/four ports but
-expose a single PCI bus address, thus, librte_net_cxgbe registers
-itself as a PCI driver that allocates one Ethernet device per detected
-port.
-
-For this reason, one cannot allow/block a single port without
-allowing/blocking the other ports on the same device.
-
 .. _t5-nics:
 
 Supported Chelsio T5 NICs
@@ -67,6 +39,23 @@ Supported SR-IOV Chelsio NICs
 SR-IOV virtual functions are supported on all the Chelsio NICs listed
 in :ref:`t5-nics` and :ref:`t6-nics`.
 
+Features
+--------
+
+CXGBE and CXGBEVF PMD has support for:
+
+- Multiple queues for TX and RX
+- Receiver Side Steering (RSS)
+  Receiver Side Steering (RSS) on IPv4, IPv6, IPv4-TCP/UDP, IPv6-TCP/UDP.
+  For 4-tuple, enabling 'RSS on TCP' and 'RSS on TCP + UDP' is supported.
+- VLAN filtering
+- Checksum offload
+- Promiscuous mode
+- All multicast mode
+- Port hardware statistics
+- Jumbo frames
+- Flow API - Support for both Wildcard (LE-TCAM) and Exact (HASH) match filters.
+
 Prerequisites
 -------------
 
@@ -88,8 +77,8 @@ Prerequisites
   for FreeBSD.
 
 
-Runtime Options
----------------
+Runtime Configuration
+---------------------
 
 The following ``devargs`` options can be enabled at runtime. They must
 be passed as part of EAL arguments. For example,
@@ -886,3 +875,15 @@ during the Chelsio NIC probe, in following order.
    level details that is specific to the Chelsio NIC. Hence, the
    firmware configuration file must not be modified without expert
    guidance from Chelsio support team.
+
+Limitations
+-----------
+
+The Chelsio Terminator series of devices provide two/four ports but
+expose a single PCI bus address, thus, librte_net_cxgbe registers
+itself as a PCI driver that allocates one Ethernet device per detected
+port.
+
+For this reason, one cannot allow/block a single port without
+allowing/blocking the other ports on the same device.
+
-- 
2.34.1

[PATCH 04/33] doc: update dpaa guide

[Ferruh Yigit]

- Renamed "Pre-Installation Configuration" section to "Configuration"

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/dpaa.rst | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/doc/guides/nics/dpaa.rst b/doc/guides/nics/dpaa.rst
index 5e05538ffb81..e8402dff5250 100644
--- a/doc/guides/nics/dpaa.rst
+++ b/doc/guides/nics/dpaa.rst
@@ -197,9 +197,8 @@ See :doc:`../platform/dpaa` for setup information
    Some part of dpaa bus code (qbman and fman - library) routines are
    dual licensed (BSD & GPLv2), however they are used as BSD in DPDK in userspace.
 
-Pre-Installation Configuration
-------------------------------
-
+Configuration
+-------------
 
 Environment Variables
 ~~~~~~~~~~~~~~~~~~~~~
-- 
2.34.1

Re: [PATCH 04/33] doc: update dpaa guide

[Sachin Saxena (OSS)]

On 3/22/2023 5:29 AM, Ferruh Yigit wrote:
> - Renamed "Pre-Installation Configuration" section to "Configuration"
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
> ---
>   doc/guides/nics/dpaa.rst | 5 ++---
>   1 file changed, 2 insertions(+), 3 deletions(-)
> 
> diff --git a/doc/guides/nics/dpaa.rst b/doc/guides/nics/dpaa.rst
> index 5e05538ffb81..e8402dff5250 100644
> --- a/doc/guides/nics/dpaa.rst
> +++ b/doc/guides/nics/dpaa.rst
> @@ -197,9 +197,8 @@ See :doc:`../platform/dpaa` for setup information
>      Some part of dpaa bus code (qbman and fman - library) routines are
>      dual licensed (BSD & GPLv2), however they are used as BSD in DPDK in userspace.
>   
> -Pre-Installation Configuration
> -------------------------------
> -
> +Configuration
> +-------------
>   
>   Environment Variables
>   ~~~~~~~~~~~~~~~~~~~~~

Acked-by: Sachin Saxena <sachin.saxena@oss.nxp.com>

-- 
Thanks,
Sachin Saxena
NXP

[PATCH 05/33] doc: update ena guide

[Ferruh Yigit]

- Move "Supported ENA adapters" section to top
- Move "Supported features" section up
- Rename "Configuration information" section to "Configuration"
- Convert paragraphs to subsections under "Configuration"
  - Rename "Runtime Configuration Parameters" to
    "Runtime Configuration" section.

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/ena.rst | 60 +++++++++++++++++++++--------------------
 1 file changed, 31 insertions(+), 29 deletions(-)

diff --git a/doc/guides/nics/ena.rst b/doc/guides/nics/ena.rst
index df5343e4aedb..b039e75ead26 100644
--- a/doc/guides/nics/ena.rst
+++ b/doc/guides/nics/ena.rst
@@ -8,6 +8,31 @@ ENA Poll Mode Driver
 The ENA PMD is a DPDK poll-mode driver for the Amazon Elastic
 Network Adapter (ENA) family.
 
+Supported ENA adapters
+----------------------
+
+Current ENA PMD supports the following ENA adapters including:
+
+* ``1d0f:ec20`` - ENA VF
+* ``1d0f:ec21`` - ENA VF RSERV0
+
+Supported features
+------------------
+
+* MTU configuration
+* Jumbo frames up to 9K
+* IPv4/TCP/UDP checksum offload
+* TSO offload
+* Multiple receive and transmit queues
+* RSS hash
+* RSS indirection table configuration
+* Low Latency Queue for Tx
+* Basic and extended statistics
+* LSC event notification
+* Watchdog (requires handling of timers in the application)
+* Device reset upon failure
+* Rx interrupts
+
 Overview
 --------
 
@@ -76,10 +101,11 @@ Refer to ``ena_eth_io_defs.h`` for the detailed structure of the descriptor
 
 The driver supports multi-queue for both Tx and Rx.
 
-Configuration information
--------------------------
+Configuration
+-------------
 
-**Runtime Configuration Parameters**
+Runtime Configuration
+^^^^^^^^^^^^^^^^^^^^^
 
    * **large_llq_hdr** (default 0)
 
@@ -105,7 +131,8 @@ Configuration information
      huge performance degradation. In general disabling LLQ is highly not
      recommended!**
 
-**ENA Configuration Parameters**
+ENA Configuration Parameters
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
    * **Number of Queues**
 
@@ -130,37 +157,12 @@ By default the ENA PMD library will be built into the DPDK library.
 For configuring and using UIO and VFIO frameworks, please also refer :ref:`the
 documentation that comes with DPDK suite <linux_gsg>`.
 
-Supported ENA adapters
-----------------------
-
-Current ENA PMD supports the following ENA adapters including:
-
-* ``1d0f:ec20`` - ENA VF
-* ``1d0f:ec21`` - ENA VF RSERV0
-
 Supported Operating Systems
 ---------------------------
 
 Any Linux distribution fulfilling the conditions described in ``System Requirements``
 section of :ref:`the DPDK documentation <linux_gsg>` or refer to *DPDK Release Notes*.
 
-Supported features
-------------------
-
-* MTU configuration
-* Jumbo frames up to 9K
-* IPv4/TCP/UDP checksum offload
-* TSO offload
-* Multiple receive and transmit queues
-* RSS hash
-* RSS indirection table configuration
-* Low Latency Queue for Tx
-* Basic and extended statistics
-* LSC event notification
-* Watchdog (requires handling of timers in the application)
-* Device reset upon failure
-* Rx interrupts
-
 Prerequisites
 -------------
 
-- 
2.34.1

[PATCH 06/33] doc: update enetc guide

[Ferruh Yigit]

- Reduce section indentation, 'ENETC' was single top level section
- Move "Supported ENETC SoCs" section up

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/enetc.rst | 25 +++++++++++--------------
 1 file changed, 11 insertions(+), 14 deletions(-)

diff --git a/doc/guides/nics/enetc.rst b/doc/guides/nics/enetc.rst
index e2be764bc40b..855bacfd0f6f 100644
--- a/doc/guides/nics/enetc.rst
+++ b/doc/guides/nics/enetc.rst
@@ -10,24 +10,21 @@ support for the inbuilt NIC found in the **NXP LS1028** SoC.
 More information can be found at `NXP Official Website
 <https://www.nxp.com/products/processors-and-microcontrollers/arm-based-processors-and-mcus/qoriq-layerscape-arm-processors/qoriq-layerscape-1028a-industrial-applications-processor:LS1028A>`_.
 
-ENETC
------
-
 This section provides an overview of the NXP ENETC
 and how it is integrated into the DPDK.
 
 Contents summary
 
 - ENETC overview
+- Supported ENETC SoCs
 - ENETC features
 - PCI bus driver
 - NIC driver
-- Supported ENETC SoCs
 - Prerequisites
 - Driver compilation and testing
 
 ENETC Overview
-~~~~~~~~~~~~~~
+--------------
 
 ENETC is a PCI Integrated End Point(IEP). IEP implements
 peripheral devices in an SoC such that software sees them as PCIe device.
@@ -41,8 +38,13 @@ This infrastructure simplifies adding support for IEP and facilitates in followi
   device register address)
 - Event reporting
 
+Supported ENETC SoCs
+--------------------
+
+- LS1028
+
 ENETC Features
-~~~~~~~~~~~~~~
+--------------
 
 - Link Status
 - Packet type information
@@ -55,7 +57,7 @@ ENETC Features
 - CRC offload
 
 NIC Driver (PMD)
-~~~~~~~~~~~~~~~~
+----------------
 
 ENETC PMD is traditional DPDK PMD which provides necessary interface between
 RTE framework and ENETC internal drivers.
@@ -68,13 +70,8 @@ RTE framework and ENETC internal drivers.
   packet processing.
 - Then Tx is done first followed by Rx.
 
-Supported ENETC SoCs
-~~~~~~~~~~~~~~~~~~~~
-
-- LS1028
-
 Prerequisites
-~~~~~~~~~~~~~
+-------------
 
 There are three main pre-requisites for executing ENETC PMD on a ENETC
 compatible board:
@@ -108,7 +105,7 @@ separately:
   LSDK and related information can be obtained from:  `LSDK <https://www.nxp.com/support/developer-resources/run-time-software/linux-software-and-development-tools/layerscape-software-development-kit:LAYERSCAPE-SDK>`_
 
 Driver compilation and testing
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+------------------------------
 
 Follow instructions available in the document
 :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
-- 
2.34.1

Re: [PATCH 06/33] doc: update enetc guide

[Sachin Saxena (OSS)]

On 3/22/2023 5:29 AM, Ferruh Yigit wrote:
> - Reduce section indentation, 'ENETC' was single top level section
> - Move "Supported ENETC SoCs" section up
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
> ---
>   doc/guides/nics/enetc.rst | 25 +++++++++++--------------
>   1 file changed, 11 insertions(+), 14 deletions(-)
> 
> diff --git a/doc/guides/nics/enetc.rst b/doc/guides/nics/enetc.rst
> index e2be764bc40b..855bacfd0f6f 100644
> --- a/doc/guides/nics/enetc.rst
> +++ b/doc/guides/nics/enetc.rst
> @@ -10,24 +10,21 @@ support for the inbuilt NIC found in the **NXP LS1028** SoC.
>   More information can be found at `NXP Official Website
>   <https://www.nxp.com/products/processors-and-microcontrollers/arm-based-processors-and-mcus/qoriq-layerscape-arm-processors/qoriq-layerscape-1028a-industrial-applications-processor:LS1028A>`_.
>   
> -ENETC
> ------
> -
>   This section provides an overview of the NXP ENETC
>   and how it is integrated into the DPDK.
>   
>   Contents summary
>   
>   - ENETC overview
> +- Supported ENETC SoCs
>   - ENETC features
>   - PCI bus driver
>   - NIC driver
> -- Supported ENETC SoCs
>   - Prerequisites
>   - Driver compilation and testing
>   
>   ENETC Overview
> -~~~~~~~~~~~~~~
> +--------------
>   
>   ENETC is a PCI Integrated End Point(IEP). IEP implements
>   peripheral devices in an SoC such that software sees them as PCIe device.
> @@ -41,8 +38,13 @@ This infrastructure simplifies adding support for IEP and facilitates in followi
>     device register address)
>   - Event reporting
>   
> +Supported ENETC SoCs
> +--------------------
> +
> +- LS1028
> +
>   ENETC Features
> -~~~~~~~~~~~~~~
> +--------------
>   
>   - Link Status
>   - Packet type information
> @@ -55,7 +57,7 @@ ENETC Features
>   - CRC offload
>   
>   NIC Driver (PMD)
> -~~~~~~~~~~~~~~~~
> +----------------
>   
>   ENETC PMD is traditional DPDK PMD which provides necessary interface between
>   RTE framework and ENETC internal drivers.
> @@ -68,13 +70,8 @@ RTE framework and ENETC internal drivers.
>     packet processing.
>   - Then Tx is done first followed by Rx.
>   
> -Supported ENETC SoCs
> -~~~~~~~~~~~~~~~~~~~~
> -
> -- LS1028
> -
>   Prerequisites
> -~~~~~~~~~~~~~
> +-------------
>   
>   There are three main pre-requisites for executing ENETC PMD on a ENETC
>   compatible board:
> @@ -108,7 +105,7 @@ separately:
>     LSDK and related information can be obtained from:  `LSDK <https://www.nxp.com/support/developer-resources/run-time-software/linux-software-and-development-tools/layerscape-software-development-kit:LAYERSCAPE-SDK>`_
>   
>   Driver compilation and testing
> -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +------------------------------
>   
>   Follow instructions available in the document
>   :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`

Acked-by: Sachin Saxena <sachin.saxena@oss.nxp.com>

-- 
Thanks,
Sachin Saxena
(NXP)

[PATCH 07/33] doc: update enetfec guide

[Ferruh Yigit]

- Move "Supported ENETFEC SoCs" section up

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/enetfec.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/doc/guides/nics/enetfec.rst b/doc/guides/nics/enetfec.rst
index 381635e627af..ad28c8f8fb7f 100644
--- a/doc/guides/nics/enetfec.rst
+++ b/doc/guides/nics/enetfec.rst
@@ -19,8 +19,8 @@ which is not upstreamed yet.
 Contents summary
 
 - ENETFEC overview
-- ENETFEC features
 - Supported ENETFEC SoCs
+- ENETFEC features
 - Prerequisites
 - Driver compilation and testing
 - Limitations
@@ -81,6 +81,11 @@ net_enetfec is logical Ethernet interface, created by ENETFEC driver.
   packet processing.
 - Then Tx is done first followed by Rx via logical interfaces.
 
+Supported ENETFEC SoCs
+----------------------
+
+- i.MX 8M Mini
+
 ENETFEC Features
 ----------------
 
@@ -91,11 +96,6 @@ ENETFEC Features
 - Linux
 - ARMv8
 
-Supported ENETFEC SoCs
-----------------------
-
-- i.MX 8M Mini
-
 Prerequisites
 -------------
 
-- 
2.34.1

Re: [PATCH 07/33] doc: update enetfec guide

[Sachin Saxena (OSS)]

On 3/22/2023 5:29 AM, Ferruh Yigit wrote:
> - Move "Supported ENETFEC SoCs" section up
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
> ---
>   doc/guides/nics/enetfec.rst | 12 ++++++------
>   1 file changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/doc/guides/nics/enetfec.rst b/doc/guides/nics/enetfec.rst
> index 381635e627af..ad28c8f8fb7f 100644
> --- a/doc/guides/nics/enetfec.rst
> +++ b/doc/guides/nics/enetfec.rst
> @@ -19,8 +19,8 @@ which is not upstreamed yet.
>   Contents summary
>   
>   - ENETFEC overview
> -- ENETFEC features
>   - Supported ENETFEC SoCs
> +- ENETFEC features
>   - Prerequisites
>   - Driver compilation and testing
>   - Limitations
> @@ -81,6 +81,11 @@ net_enetfec is logical Ethernet interface, created by ENETFEC driver.
>     packet processing.
>   - Then Tx is done first followed by Rx via logical interfaces.
>   
> +Supported ENETFEC SoCs
> +----------------------
> +
> +- i.MX 8M Mini
> +
>   ENETFEC Features
>   ----------------
>   
> @@ -91,11 +96,6 @@ ENETFEC Features
>   - Linux
>   - ARMv8
>   
> -Supported ENETFEC SoCs
> -----------------------
> -
> -- i.MX 8M Mini
> -
>   Prerequisites
>   -------------
>   

Acked-by: Sachin Saxena <sachin.saxena@oss.nxp.com>

-- 
Thanks,
Sachin Saxena
(NXP)

[PATCH 08/33] doc: update enic guide

[Ferruh Yigit]

- Move "Supported Cisco VIC adapters" section up
- Move "Supported features" section up
- Remove "Contact Information" as this is duplication of Maintainers
  file

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/enic.rst | 79 ++++++++++++++++++----------------------
 1 file changed, 35 insertions(+), 44 deletions(-)

diff --git a/doc/guides/nics/enic.rst b/doc/guides/nics/enic.rst
index 5e2054fc8a9d..5bf5cc9ab98f 100644
--- a/doc/guides/nics/enic.rst
+++ b/doc/guides/nics/enic.rst
@@ -10,6 +10,41 @@ NICs. These adapters are also referred to as vNICs below. If you are running
 or would like to run DPDK software applications on Cisco UCS servers using
 Cisco VIC adapters the following documentation is relevant.
 
+Supported Cisco VIC adapters
+----------------------------
+
+ENIC PMD supports all recent generations of Cisco VIC adapters including:
+
+- VIC 1200 series
+- VIC 1300 series
+- VIC 1400 series
+
+Supported features
+------------------
+
+- Unicast, multicast and broadcast transmission and reception
+- Receive queue polling
+- Port Hardware Statistics
+- Hardware VLAN acceleration
+- IP checksum offload
+- Receive side VLAN stripping
+- Multiple receive and transmit queues
+- Promiscuous mode
+- Setting RX VLAN (supported via UCSM/CIMC only)
+- VLAN filtering (supported via UCSM/CIMC only)
+- Execution of application by unprivileged system users
+- IPV4, IPV6 and TCP RSS hashing
+- UDP RSS hashing (1400 series and later adapters)
+- Scattered Rx
+- MTU update
+- SR-IOV on UCS managed servers connected to Fabric Interconnects
+- Flow API
+- Overlay offload
+
+  - Rx/Tx checksum offloads for VXLAN, NVGRE, GENEVE
+  - TSO for VXLAN and GENEVE packets
+  - Inner RSS
+
 How to obtain ENIC PMD integrated DPDK
 --------------------------------------
 
@@ -510,47 +545,12 @@ Refer to the document :ref:`compiling and testing a PMD for a NIC
 For configuring and using UIO and VFIO frameworks, please refer to the
 documentation that comes with DPDK suite.
 
-Supported Cisco VIC adapters
-----------------------------
-
-ENIC PMD supports all recent generations of Cisco VIC adapters including:
-
-- VIC 1200 series
-- VIC 1300 series
-- VIC 1400 series
-
 Supported Operating Systems
 ---------------------------
 
 Any Linux distribution fulfilling the conditions described in Dependencies
 section of DPDK documentation.
 
-Supported features
-------------------
-
-- Unicast, multicast and broadcast transmission and reception
-- Receive queue polling
-- Port Hardware Statistics
-- Hardware VLAN acceleration
-- IP checksum offload
-- Receive side VLAN stripping
-- Multiple receive and transmit queues
-- Promiscuous mode
-- Setting RX VLAN (supported via UCSM/CIMC only)
-- VLAN filtering (supported via UCSM/CIMC only)
-- Execution of application by unprivileged system users
-- IPV4, IPV6 and TCP RSS hashing
-- UDP RSS hashing (1400 series and later adapters)
-- Scattered Rx
-- MTU update
-- SR-IOV on UCS managed servers connected to Fabric Interconnects
-- Flow API
-- Overlay offload
-
-  - Rx/Tx checksum offloads for VXLAN, NVGRE, GENEVE
-  - TSO for VXLAN and GENEVE packets
-  - Inner RSS
-
 Known bugs and unsupported features in this release
 ---------------------------------------------------
 
@@ -604,12 +604,3 @@ Additional Reference
 
 - https://www.cisco.com/c/en/us/products/servers-unified-computing/index.html
 - https://www.cisco.com/c/en/us/products/interfaces-modules/unified-computing-system-adapters/index.html
-
-Contact Information
--------------------
-
-Any questions or bugs should be reported to DPDK community and to the ENIC PMD
-maintainers:
-
-- John Daley <johndale@cisco.com>
-- Hyong Youb Kim <hyonkim@cisco.com>
-- 
2.34.1

RE: [PATCH 08/33] doc: update enic guide

[Hyong Youb Kim (hyonkim)]

> -----Original Message-----
> From: Ferruh Yigit <ferruh.yigit@amd.com>
> Sent: Wednesday, March 22, 2023 8:59 AM
> To: John McNamara <john.mcnamara@intel.com>; John Daley (johndale)
> <johndale@cisco.com>; Hyong Youb Kim (hyonkim) <hyonkim@cisco.com>
> Cc: Thomas Monjalon <thomas@monjalon.net>; Andrew Rybchenko
> <andrew.rybchenko@oktetlabs.ru>; dev@dpdk.org
> Subject: [PATCH 08/33] doc: update enic guide
> 
> - Move "Supported Cisco VIC adapters" section up
> - Move "Supported features" section up
> - Remove "Contact Information" as this is duplication of Maintainers
>   file
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
> ---

Acked-by: Hyong Youb Kim <hyonkim@cisco.com>

Thanks.
-Hyong

>  doc/guides/nics/enic.rst | 79 ++++++++++++++++++----------------------
>  1 file changed, 35 insertions(+), 44 deletions(-)
> 
> diff --git a/doc/guides/nics/enic.rst b/doc/guides/nics/enic.rst index
> 5e2054fc8a9d..5bf5cc9ab98f 100644
> --- a/doc/guides/nics/enic.rst
> +++ b/doc/guides/nics/enic.rst
> @@ -10,6 +10,41 @@ NICs. These adapters are also referred to as vNICs
> below. If you are running  or would like to run DPDK software applications on
> Cisco UCS servers using  Cisco VIC adapters the following documentation is
> relevant.
> 
> +Supported Cisco VIC adapters
> +----------------------------
> +
> +ENIC PMD supports all recent generations of Cisco VIC adapters including:
> +
> +- VIC 1200 series
> +- VIC 1300 series
> +- VIC 1400 series
> +
> +Supported features
> +------------------
> +
> +- Unicast, multicast and broadcast transmission and reception
> +- Receive queue polling
> +- Port Hardware Statistics
> +- Hardware VLAN acceleration
> +- IP checksum offload
> +- Receive side VLAN stripping
> +- Multiple receive and transmit queues
> +- Promiscuous mode
> +- Setting RX VLAN (supported via UCSM/CIMC only)
> +- VLAN filtering (supported via UCSM/CIMC only)
> +- Execution of application by unprivileged system users
> +- IPV4, IPV6 and TCP RSS hashing
> +- UDP RSS hashing (1400 series and later adapters)
> +- Scattered Rx
> +- MTU update
> +- SR-IOV on UCS managed servers connected to Fabric Interconnects
> +- Flow API
> +- Overlay offload
> +
> +  - Rx/Tx checksum offloads for VXLAN, NVGRE, GENEVE
> +  - TSO for VXLAN and GENEVE packets
> +  - Inner RSS
> +
>  How to obtain ENIC PMD integrated DPDK
>  --------------------------------------
> 
> @@ -510,47 +545,12 @@ Refer to the document :ref:`compiling and testing a
> PMD for a NIC  For configuring and using UIO and VFIO frameworks, please
> refer to the  documentation that comes with DPDK suite.
> 
> -Supported Cisco VIC adapters
> -----------------------------
> -
> -ENIC PMD supports all recent generations of Cisco VIC adapters including:
> -
> -- VIC 1200 series
> -- VIC 1300 series
> -- VIC 1400 series
> -
>  Supported Operating Systems
>  ---------------------------
> 
>  Any Linux distribution fulfilling the conditions described in Dependencies
> section of DPDK documentation.
> 
> -Supported features
> -------------------
> -
> -- Unicast, multicast and broadcast transmission and reception
> -- Receive queue polling
> -- Port Hardware Statistics
> -- Hardware VLAN acceleration
> -- IP checksum offload
> -- Receive side VLAN stripping
> -- Multiple receive and transmit queues
> -- Promiscuous mode
> -- Setting RX VLAN (supported via UCSM/CIMC only)
> -- VLAN filtering (supported via UCSM/CIMC only)
> -- Execution of application by unprivileged system users
> -- IPV4, IPV6 and TCP RSS hashing
> -- UDP RSS hashing (1400 series and later adapters)
> -- Scattered Rx
> -- MTU update
> -- SR-IOV on UCS managed servers connected to Fabric Interconnects
> -- Flow API
> -- Overlay offload
> -
> -  - Rx/Tx checksum offloads for VXLAN, NVGRE, GENEVE
> -  - TSO for VXLAN and GENEVE packets
> -  - Inner RSS
> -
>  Known bugs and unsupported features in this release
>  ---------------------------------------------------
> 
> @@ -604,12 +604,3 @@ Additional Reference
> 
>  - https://www.cisco.com/c/en/us/products/servers-unified-
> computing/index.html
>  - https://www.cisco.com/c/en/us/products/interfaces-modules/unified-
> computing-system-adapters/index.html
> -
> -Contact Information
> --------------------
> -
> -Any questions or bugs should be reported to DPDK community and to the
> ENIC PMD
> -maintainers:
> -
> -- John Daley <johndale@cisco.com>
> -- Hyong Youb Kim <hyonkim@cisco.com>
> --
> 2.34.1

[PATCH 09/33] doc: update hns3 guide

[Ferruh Yigit]

- Move "Link status event Pre-conditions" subsection under
  "Prerequisites" section
- Rename "Pre-Installation Configuration" section to "Configuration"
- Rename "Config File Options" section to "Compilation Options"
- Rename "Runtime Config Options" section to "Runtime Configuration"

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/hns3.rst | 30 +++++++++++++++---------------
 1 file changed, 15 insertions(+), 15 deletions(-)

diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst
index 791c9cc2ed49..5373ec5a8faf 100644
--- a/doc/guides/nics/hns3.rst
+++ b/doc/guides/nics/hns3.rst
@@ -47,11 +47,21 @@ Prerequisites
 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to
   setup the basic DPDK environment.
 
+Link status event Pre-conditions
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Pre-Installation Configuration
-------------------------------
+Firmware 1.8.0.0 and later versions support reporting link changes to the PF.
+Therefore, to use the LSC for the PF driver, ensure that the firmware version
+also supports reporting link changes.
+If the VF driver needs to support LSC, special patch must be added:
+`<https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git/commit/drivers/net/ethernet/hisilicon/hns3?h=next-20210428&id=18b6e31f8bf4ac7af7b057228f38a5a530378e4e>`_.
+Note: The patch has been uploaded to 5.13 of the Linux kernel mainline.
+
+
+Configuration
+-------------
 
-Config File Options
+Compilation Options
 ~~~~~~~~~~~~~~~~~~~
 
 The following options can be modified in the ``config/rte_config.h`` file.
@@ -60,8 +70,8 @@ The following options can be modified in the ``config/rte_config.h`` file.
 
   Number of MAX queues reserved for PF.
 
-Runtime Config Options
-~~~~~~~~~~~~~~~~~~~~~~
+Runtime Configuration
+~~~~~~~~~~~~~~~~~~~~~
 
 - ``rx_func_hint`` (default ``none``)
 
@@ -130,16 +140,6 @@ Runtime Config Options
    For example::
    -a 0000:7d:00.0,mbx_time_limit_ms=600
 
-Link status event Pre-conditions
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Firmware 1.8.0.0 and later versions support reporting link changes to the PF.
-Therefore, to use the LSC for the PF driver, ensure that the firmware version
-also supports reporting link changes.
-If the VF driver needs to support LSC, special patch must be added:
-`<https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git/commit/drivers/net/ethernet/hisilicon/hns3?h=next-20210428&id=18b6e31f8bf4ac7af7b057228f38a5a530378e4e>`_.
-Note: The patch has been uploaded to 5.13 of the Linux kernel mainline.
-
 
 Driver compilation and testing
 ------------------------------
-- 
2.34.1

Re: [PATCH 09/33] doc: update hns3 guide

[fengchengwen]

On 2023/3/22 7:59, Ferruh Yigit wrote:
> - Move "Link status event Pre-conditions" subsection under
>   "Prerequisites" section
> - Rename "Pre-Installation Configuration" section to "Configuration"
> - Rename "Config File Options" section to "Compilation Options"
> - Rename "Runtime Config Options" section to "Runtime Configuration"
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>

Acked-by: Chengwen Feng <fengchengwen@huawei.com>

...

Re: [PATCH 09/33] doc: update hns3 guide

[Dongdong Liu]

Hi Ferruh

Many thanks for your work.

On 2023/3/22 7:59, Ferruh Yigit wrote:
> - Move "Link status event Pre-conditions" subsection under
>   "Prerequisites" section
> - Rename "Pre-Installation Configuration" section to "Configuration"
> - Rename "Config File Options" section to "Compilation Options"
> - Rename "Runtime Config Options" section to "Runtime Configuration"
>
> Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>

Acked-by: Dongdong Liu <liudongdong3@huawei.com>

Thanks,
Dongdong
> ---
>  doc/guides/nics/hns3.rst | 30 +++++++++++++++---------------
>  1 file changed, 15 insertions(+), 15 deletions(-)
>
> diff --git a/doc/guides/nics/hns3.rst b/doc/guides/nics/hns3.rst
> index 791c9cc2ed49..5373ec5a8faf 100644
> --- a/doc/guides/nics/hns3.rst
> +++ b/doc/guides/nics/hns3.rst
> @@ -47,11 +47,21 @@ Prerequisites
>  - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to
>    setup the basic DPDK environment.
>
> +Link status event Pre-conditions
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> -Pre-Installation Configuration
> -------------------------------
> +Firmware 1.8.0.0 and later versions support reporting link changes to the PF.
> +Therefore, to use the LSC for the PF driver, ensure that the firmware version
> +also supports reporting link changes.
> +If the VF driver needs to support LSC, special patch must be added:
> +`<https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git/commit/drivers/net/ethernet/hisilicon/hns3?h=next-20210428&id=18b6e31f8bf4ac7af7b057228f38a5a530378e4e>`_.
> +Note: The patch has been uploaded to 5.13 of the Linux kernel mainline.
> +
> +
> +Configuration
> +-------------
>
> -Config File Options
> +Compilation Options
>  ~~~~~~~~~~~~~~~~~~~
>
>  The following options can be modified in the ``config/rte_config.h`` file.
> @@ -60,8 +70,8 @@ The following options can be modified in the ``config/rte_config.h`` file.
>
>    Number of MAX queues reserved for PF.
>
> -Runtime Config Options
> -~~~~~~~~~~~~~~~~~~~~~~
> +Runtime Configuration
> +~~~~~~~~~~~~~~~~~~~~~
>
>  - ``rx_func_hint`` (default ``none``)
>
> @@ -130,16 +140,6 @@ Runtime Config Options
>     For example::
>     -a 0000:7d:00.0,mbx_time_limit_ms=600
>
> -Link status event Pre-conditions
> -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> -
> -Firmware 1.8.0.0 and later versions support reporting link changes to the PF.
> -Therefore, to use the LSC for the PF driver, ensure that the firmware version
> -also supports reporting link changes.
> -If the VF driver needs to support LSC, special patch must be added:
> -`<https://git.kernel.org/pub/scm/linux/kernel/git/next/linux-next.git/commit/drivers/net/ethernet/hisilicon/hns3?h=next-20210428&id=18b6e31f8bf4ac7af7b057228f38a5a530378e4e>`_.
> -Note: The patch has been uploaded to 5.13 of the Linux kernel mainline.
> -
>
>  Driver compilation and testing
>  ------------------------------
>

[PATCH 10/33] doc: update i40e guide

[Ferruh Yigit]

- Rename "Pre-Installation Configuration" section to "Configuration"
- Rename "Config File Options" section to "Compilation Options"
- Rename "Runtime Config Options" section to "Runtime Configuration"

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/i40e.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst
index a6c7dbd0802f..7447af1be425 100644
--- a/doc/guides/nics/i40e.rst
+++ b/doc/guides/nics/i40e.rst
@@ -194,10 +194,10 @@ For X722,
    +--------------+-----------------------+------------------+
 
 
-Pre-Installation Configuration
-------------------------------
+Configuration
+-------------
 
-Config File Options
+Compilation Options
 ~~~~~~~~~~~~~~~~~~~
 
 The following options can be modified in the ``config/rte_config.h`` file.
@@ -210,8 +210,8 @@ The following options can be modified in the ``config/rte_config.h`` file.
 
   Number of queues reserved for each VMDQ Pool.
 
-Runtime Config Options
-~~~~~~~~~~~~~~~~~~~~~~
+Runtime Configuration
+~~~~~~~~~~~~~~~~~~~~~
 
 - ``Reserved number of Queues per VF`` (default ``4``)
 
-- 
2.34.1

[PATCH 11/33] doc: update ice guide

[Ferruh Yigit]

- Rename "Pre-Installation Configuration" section to "Configuration"
- Rename "Runtime Config Options" section to "Runtime Configuration"

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/ice.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst
index 70e19c3318be..e0ba8534d780 100644
--- a/doc/guides/nics/ice.rst
+++ b/doc/guides/nics/ice.rst
@@ -69,12 +69,12 @@ The detailed information can refer to chapter Tested Platforms/Tested NICs in re
    |    22.11  |     1.10.1    |      1.3.30     |  1.3.37   |    1.3.10    |    4.1    |
    +-----------+---------------+-----------------+-----------+--------------+-----------+
 
-Pre-Installation Configuration
-------------------------------
 
+Configuration
+-------------
 
-Runtime Config Options
-~~~~~~~~~~~~~~~~~~~~~~
+Runtime Configuration
+~~~~~~~~~~~~~~~~~~~~~
 
 - ``Safe Mode Support`` (default ``0``)
 
-- 
2.34.1

[PATCH 12/33] doc: update idpf guide

[Ferruh Yigit]

- Rename "Pre-Installation Configuration" section to "Configuration"
- Rename "Runtime Config Options" section to "Runtime Configuration"

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/idpf.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/doc/guides/nics/idpf.rst b/doc/guides/nics/idpf.rst
index b5c3aa576343..3693d8225559 100644
--- a/doc/guides/nics/idpf.rst
+++ b/doc/guides/nics/idpf.rst
@@ -19,11 +19,11 @@ To get better performance on Intel platforms,
 please follow the :doc:`../linux_gsg/nic_perf_intel_platform`.
 
 
-Pre-Installation Configuration
-------------------------------
+Configuration
+-------------
 
-Runtime Config Options
-~~~~~~~~~~~~~~~~~~~~~~
+Runtime Configuration
+~~~~~~~~~~~~~~~~~~~~~
 
 - ``vport`` (default ``0``)
 
-- 
2.34.1

[PATCH 13/33] doc: update igb guide

[Ferruh Yigit]

- Move "Supported Chipsets and NICs" section up
- Remove empty "Limitations or Known issues" section

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/igb.rst | 23 +++++++++--------------
 1 file changed, 9 insertions(+), 14 deletions(-)

diff --git a/doc/guides/nics/igb.rst b/doc/guides/nics/igb.rst
index 8231f9eef4c1..e3a91c316be4 100644
--- a/doc/guides/nics/igb.rst
+++ b/doc/guides/nics/igb.rst
@@ -7,6 +7,15 @@ IGB Poll Mode Driver
 The IGB PMD (**librte_net_e1000**) provides poll mode driver
 support for Intel 1GbE nics.
 
+Supported Chipsets and NICs
+---------------------------
+
+- Intel 82576EB 10 Gigabit Ethernet Controller
+- Intel 82580EB 10 Gigabit Ethernet Controller
+- Intel 82580DB 10 Gigabit Ethernet Controller
+- Intel Ethernet Controller I210
+- Intel Ethernet Controller I350
+
 Features
 --------
 
@@ -22,17 +31,3 @@ Features of the IGB PMD are:
 * Checksum offload
 * TCP segmentation offload
 * Jumbo frames supported
-
-
-Limitations or Known issues
----------------------------
-
-
-Supported Chipsets and NICs
----------------------------
-
-- Intel 82576EB 10 Gigabit Ethernet Controller
-- Intel 82580EB 10 Gigabit Ethernet Controller
-- Intel 82580DB 10 Gigabit Ethernet Controller
-- Intel Ethernet Controller I210
-- Intel Ethernet Controller I350
-- 
2.34.1

[PATCH 14/33] doc: update igc guide

[Ferruh Yigit]

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

- Move "Supported Chipsets and NICs" section up
- Make device list an actual list

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/igc.rst | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/doc/guides/nics/igc.rst b/doc/guides/nics/igc.rst
index 399d2d650c30..c5af806b7b68 100644
--- a/doc/guides/nics/igc.rst
+++ b/doc/guides/nics/igc.rst
@@ -12,6 +12,14 @@ I225 and I226 Series Network Adapters.
 - For information about I226, please refer to: `Intel® Ethernet Controller I226 Series
   <https://ark.intel.com/content/www/us/en/ark/products/series/210588/intel-ethernet-controller-i226-series.html>`_.
 
+Supported Chipsets and NICs
+---------------------------
+
+- Foxville LM (I225 LM, I226 LM): Client 2.5G LAN vPro Corporate
+- Foxville V (I225 V, I226 V): Client 2.5G LAN Consumer
+- Foxville I (I225 I, I226 IM): Client 2.5G Industrial Temp
+- Foxville V (I225 K, I226 K): Client 2.5G LAN Consumer
+
 Driver compilation and testing
 ------------------------------
 
@@ -19,14 +27,6 @@ Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and
 for details.
 
 
-Supported Chipsets and NICs
----------------------------
-
-Foxville LM (I225 LM, I226 LM): Client 2.5G LAN vPro Corporate
-Foxville V (I225 V, I226 V): Client 2.5G LAN Consumer
-Foxville I (I225 I, I226 IM): Client 2.5G Industrial Temp
-Foxville V (I225 K, I226 K): Client 2.5G LAN Consumer
-
 Sample Application Notes
 ------------------------
 
-- 
2.34.1

RE: [PATCH 14/33] doc: update igc guide

[Su, Simei]

> -----Original Message-----
> From: Ferruh Yigit <ferruh.yigit@amd.com>
> Sent: Wednesday, March 22, 2023 7:59 AM
> To: Mcnamara, John <john.mcnamara@intel.com>; Guo, Junfeng
> <junfeng.guo@intel.com>; Su, Simei <simei.su@intel.com>
> Cc: Thomas Monjalon <thomas@monjalon.net>; Andrew Rybchenko
> <andrew.rybchenko@oktetlabs.ru>; dev@dpdk.org
> Subject: [PATCH 14/33] doc: update igc guide
> 
> - Move "Supported Chipsets and NICs" section up
> - Make device list an actual list
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
> ---
>  doc/guides/nics/igc.rst | 16 ++++++++--------
>  1 file changed, 8 insertions(+), 8 deletions(-)
> 
> diff --git a/doc/guides/nics/igc.rst b/doc/guides/nics/igc.rst index
> 399d2d650c30..c5af806b7b68 100644
> --- a/doc/guides/nics/igc.rst
> +++ b/doc/guides/nics/igc.rst
> @@ -12,6 +12,14 @@ I225 and I226 Series Network Adapters.
>  - For information about I226, please refer to: `Intel® Ethernet Controller
> I226 Series
> 
> <https://ark.intel.com/content/www/us/en/ark/products/series/210588/inte
> l-ethernet-controller-i226-series.html>`_.
> 
> +Supported Chipsets and NICs
> +---------------------------
> +
> +- Foxville LM (I225 LM, I226 LM): Client 2.5G LAN vPro Corporate
> +- Foxville V (I225 V, I226 V): Client 2.5G LAN Consumer
> +- Foxville I (I225 I, I226 IM): Client 2.5G Industrial Temp
> +- Foxville V (I225 K, I226 K): Client 2.5G LAN Consumer
> +
>  Driver compilation and testing
>  ------------------------------
> 
> @@ -19,14 +27,6 @@ Refer to the document :ref:`compiling and testing a
> PMD for a NIC <pmd_build_and  for details.
> 
> 
> -Supported Chipsets and NICs
> ----------------------------
> -
> -Foxville LM (I225 LM, I226 LM): Client 2.5G LAN vPro Corporate -Foxville V
> (I225 V, I226 V): Client 2.5G LAN Consumer -Foxville I (I225 I, I226 IM): Client
> 2.5G Industrial Temp -Foxville V (I225 K, I226 K): Client 2.5G LAN Consumer
> -
>  Sample Application Notes
>  ------------------------
> 
> --
> 2.34.1

Acked-by: Simei Su <simei.su@intel.com>

Thanks,
Simei

[PATCH 15/33] doc: update ipn3ke guide

[Ferruh Yigit]

- Rename "Pre-Installation Configuration" section to "Configuration"
- Rename "Runtime Config Options" section to "Runtime Configuration"

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/ipn3ke.rst | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)

diff --git a/doc/guides/nics/ipn3ke.rst b/doc/guides/nics/ipn3ke.rst
index a89e3719f2e0..e7e5bb79915d 100644
--- a/doc/guides/nics/ipn3ke.rst
+++ b/doc/guides/nics/ipn3ke.rst
@@ -28,12 +28,11 @@ Prerequisites
   section of the :ref:`Getting Started Guide for Linux <linux_gsg>`.
 
 
-Pre-Installation Configuration
-------------------------------
-
+Configuration
+-------------
 
-Runtime Config Options
-~~~~~~~~~~~~~~~~~~~~~~
+Runtime Configuration
+~~~~~~~~~~~~~~~~~~~~~
 
 - ``AFU name``
 
-- 
2.34.1

RE: [PATCH 15/33] doc: update ipn3ke guide

[Xu, Rosen]

Hi,

> -----Original Message-----
> From: Ferruh Yigit <ferruh.yigit@amd.com>
> Sent: Wednesday, March 22, 2023 7:59 AM
> To: Mcnamara, John <john.mcnamara@intel.com>; Xu, Rosen
> <rosen.xu@intel.com>
> Cc: Thomas Monjalon <thomas@monjalon.net>; Andrew Rybchenko
> <andrew.rybchenko@oktetlabs.ru>; dev@dpdk.org
> Subject: [PATCH 15/33] doc: update ipn3ke guide
> 
> - Rename "Pre-Installation Configuration" section to "Configuration"
> - Rename "Runtime Config Options" section to "Runtime Configuration"
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
> ---
>  doc/guides/nics/ipn3ke.rst | 9 ++++-----
>  1 file changed, 4 insertions(+), 5 deletions(-)
> 
> diff --git a/doc/guides/nics/ipn3ke.rst b/doc/guides/nics/ipn3ke.rst index
> a89e3719f2e0..e7e5bb79915d 100644
> --- a/doc/guides/nics/ipn3ke.rst
> +++ b/doc/guides/nics/ipn3ke.rst
> @@ -28,12 +28,11 @@ Prerequisites
>    section of the :ref:`Getting Started Guide for Linux <linux_gsg>`.
> 
> 
> -Pre-Installation Configuration
> -------------------------------
> -
> +Configuration
> +-------------
> 
> -Runtime Config Options
> -~~~~~~~~~~~~~~~~~~~~~~
> +Runtime Configuration
> +~~~~~~~~~~~~~~~~~~~~~
> 
>  - ``AFU name``
> 
> --
> 2.34.1

Reviewed-by: Rosen Xu <rosen.xu@intel.com>

[PATCH 16/33] doc: update ixgbe guide

[Ferruh Yigit]

- Move "Supported Chipsets and NICs" section up

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/ixgbe.rst | 62 +++++++++++++++++++--------------------
 1 file changed, 31 insertions(+), 31 deletions(-)

diff --git a/doc/guides/nics/ixgbe.rst b/doc/guides/nics/ixgbe.rst
index 5db7376992d4..b1d77ab7ab3a 100644
--- a/doc/guides/nics/ixgbe.rst
+++ b/doc/guides/nics/ixgbe.rst
@@ -6,6 +6,37 @@
 IXGBE Driver
 ============
 
+Supported Chipsets and NICs
+---------------------------
+
+- Intel 82599EB 10 Gigabit Ethernet Controller
+- Intel 82598EB 10 Gigabit Ethernet Controller
+- Intel 82599ES 10 Gigabit Ethernet Controller
+- Intel 82599EN 10 Gigabit Ethernet Controller
+- Intel Ethernet Controller X540-AT2
+- Intel Ethernet Controller X550-BT2
+- Intel Ethernet Controller X550-AT2
+- Intel Ethernet Controller X550-AT
+- Intel Ethernet Converged Network Adapter X520-SR1
+- Intel Ethernet Converged Network Adapter X520-SR2
+- Intel Ethernet Converged Network Adapter X520-LR1
+- Intel Ethernet Converged Network Adapter X520-DA1
+- Intel Ethernet Converged Network Adapter X520-DA2
+- Intel Ethernet Converged Network Adapter X520-DA4
+- Intel Ethernet Converged Network Adapter X520-QDA1
+- Intel Ethernet Converged Network Adapter X520-T2
+- Intel 10 Gigabit AF DA Dual Port Server Adapter
+- Intel 10 Gigabit AT Server Adapter
+- Intel 10 Gigabit AT2 Server Adapter
+- Intel 10 Gigabit CX4 Dual Port Server Adapter
+- Intel 10 Gigabit XF LR Server Adapter
+- Intel 10 Gigabit XF SR Dual Port Server Adapter
+- Intel 10 Gigabit XF SR Server Adapter
+- Intel Ethernet Converged Network Adapter X540-T1
+- Intel Ethernet Converged Network Adapter X540-T2
+- Intel Ethernet Converged Network Adapter X550-T1
+- Intel Ethernet Converged Network Adapter X550-T2
+
 Vector PMD for IXGBE
 --------------------
 
@@ -329,37 +360,6 @@ the VFs which are required.::
 Currently hot-plugging of representor ports is not supported so all required
 representors must be specified on the creation of the PF.
 
-Supported Chipsets and NICs
----------------------------
-
-- Intel 82599EB 10 Gigabit Ethernet Controller
-- Intel 82598EB 10 Gigabit Ethernet Controller
-- Intel 82599ES 10 Gigabit Ethernet Controller
-- Intel 82599EN 10 Gigabit Ethernet Controller
-- Intel Ethernet Controller X540-AT2
-- Intel Ethernet Controller X550-BT2
-- Intel Ethernet Controller X550-AT2
-- Intel Ethernet Controller X550-AT
-- Intel Ethernet Converged Network Adapter X520-SR1
-- Intel Ethernet Converged Network Adapter X520-SR2
-- Intel Ethernet Converged Network Adapter X520-LR1
-- Intel Ethernet Converged Network Adapter X520-DA1
-- Intel Ethernet Converged Network Adapter X520-DA2
-- Intel Ethernet Converged Network Adapter X520-DA4
-- Intel Ethernet Converged Network Adapter X520-QDA1
-- Intel Ethernet Converged Network Adapter X520-T2
-- Intel 10 Gigabit AF DA Dual Port Server Adapter
-- Intel 10 Gigabit AT Server Adapter
-- Intel 10 Gigabit AT2 Server Adapter
-- Intel 10 Gigabit CX4 Dual Port Server Adapter
-- Intel 10 Gigabit XF LR Server Adapter
-- Intel 10 Gigabit XF SR Dual Port Server Adapter
-- Intel 10 Gigabit XF SR Server Adapter
-- Intel Ethernet Converged Network Adapter X540-T1
-- Intel Ethernet Converged Network Adapter X540-T2
-- Intel Ethernet Converged Network Adapter X550-T1
-- Intel Ethernet Converged Network Adapter X550-T2
-
 .. _net_ixgbe_testpmd_commands:
 
 Testpmd driver specific commands
-- 
2.34.1

[PATCH 17/33] doc: update kni guide

[Ferruh Yigit]

- Rename "PMD arguments" section to "Runtime Configuration"

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/kni.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/guides/nics/kni.rst b/doc/guides/nics/kni.rst
index 2a23bb3f3b40..bd3033bb585c 100644
--- a/doc/guides/nics/kni.rst
+++ b/doc/guides/nics/kni.rst
@@ -62,8 +62,8 @@ KNI control path is not supported with the PMD, since there is no physical
 backend device by default.
 
 
-PMD arguments
--------------
+Runtime Configuration
+---------------------
 
 ``no_request_thread``, by default PMD creates a pthread for each KNI interface
 to handle Linux network interface control commands, like ``ifconfig kni0 up``
-- 
2.34.1

[PATCH 18/33] doc: update mana guide

[Ferruh Yigit]

- Rename "MANA PMD arguments" section to "Runtime Configuration"

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/mana.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/guides/nics/mana.rst b/doc/guides/nics/mana.rst
index 341146c4e7dc..c65634d91c66 100644
--- a/doc/guides/nics/mana.rst
+++ b/doc/guides/nics/mana.rst
@@ -62,8 +62,8 @@ Driver compilation and testing
 Refer to the document
 :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>` for details.
 
-MANA PMD arguments
-------------------
+Runtime Configuration
+---------------------
 
 The user can specify below argument in devargs.
 
-- 
2.34.1

RE: [PATCH 18/33] doc: update mana guide

[Long Li]

> Subject: [PATCH 18/33] doc: update mana guide
> 
> - Rename "MANA PMD arguments" section to "Runtime Configuration"
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>

Acked-by: Long Li <longli@microsoft.com>

> ---
>  doc/guides/nics/mana.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/guides/nics/mana.rst b/doc/guides/nics/mana.rst index
> 341146c4e7dc..c65634d91c66 100644
> --- a/doc/guides/nics/mana.rst
> +++ b/doc/guides/nics/mana.rst
> @@ -62,8 +62,8 @@ Driver compilation and testing  Refer to the
> document  :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
> for details.
> 
> -MANA PMD arguments
> -------------------
> +Runtime Configuration
> +---------------------
> 
>  The user can specify below argument in devargs.
> 
> --
> 2.34.1

[PATCH 19/33] doc: update mlx5 guide

[Ferruh Yigit]

[-- 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

[PATCH 20/33] doc: update mvneta guide

[Ferruh Yigit]

- Rename "Runtime options" section to "Runtime Configuration"

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/mvneta.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/guides/nics/mvneta.rst b/doc/guides/nics/mvneta.rst
index 2ee2637a58f3..69aa98eafc33 100644
--- a/doc/guides/nics/mvneta.rst
+++ b/doc/guides/nics/mvneta.rst
@@ -76,8 +76,8 @@ Prerequisites
   DPDK environment.
 
 
-Runtime options
----------------
+Runtime Configuration
+---------------------
 
 The following ``devargs`` options can be enabled at runtime. They must
 be passed as part of EAL arguments.
-- 
2.34.1

RE: [EXT] [PATCH 20/33] doc: update mvneta guide

[Liron Himi]

Acked-by: Liron Himi <lironh@marvell.com>

-----Original Message-----
From: Ferruh Yigit <ferruh.yigit@amd.com> 
Sent: Wednesday, 22 March 2023 01:59
To: John McNamara <john.mcnamara@intel.com>; Zyta Szpak <zr@semihalf.com>; Liron Himi <lironh@marvell.com>
Cc: Thomas Monjalon <thomas@monjalon.net>; Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>; dev@dpdk.org
Subject: [EXT] [PATCH 20/33] doc: update mvneta guide

External Email

----------------------------------------------------------------------
- Rename "Runtime options" section to "Runtime Configuration"

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/mvneta.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/guides/nics/mvneta.rst b/doc/guides/nics/mvneta.rst index 2ee2637a58f3..69aa98eafc33 100644
--- a/doc/guides/nics/mvneta.rst
+++ b/doc/guides/nics/mvneta.rst
@@ -76,8 +76,8 @@ Prerequisites
   DPDK environment.
 
 
-Runtime options
----------------
+Runtime Configuration
+---------------------
 
 The following ``devargs`` options can be enabled at runtime. They must  be passed as part of EAL arguments.
--
2.34.1

[PATCH 21/33] doc: update netvsc guide

[Ferruh Yigit]

- Rename "Netvsc PMD arguments" section to "Runtime Configuration"

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/netvsc.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/guides/nics/netvsc.rst b/doc/guides/nics/netvsc.rst
index 77efe1dc9175..2c0ea6ac9ed6 100644
--- a/doc/guides/nics/netvsc.rst
+++ b/doc/guides/nics/netvsc.rst
@@ -102,8 +102,8 @@ The following prerequisites apply:
     to use the netvsc PMD with 4.16 kernel but it is limited to a single queue.
 
 
-Netvsc PMD arguments
---------------------
+Runtime Configuration
+---------------------
 
 The user can specify below argument in devargs.
 
-- 
2.34.1

RE: [PATCH 21/33] doc: update netvsc guide

[Long Li]

> Subject: [PATCH 21/33] doc: update netvsc guide
> 
> - Rename "Netvsc PMD arguments" section to "Runtime Configuration"
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>


Acked-by: Long Li <longli@microsoft.com>

> ---
>  doc/guides/nics/netvsc.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/guides/nics/netvsc.rst b/doc/guides/nics/netvsc.rst index
> 77efe1dc9175..2c0ea6ac9ed6 100644
> --- a/doc/guides/nics/netvsc.rst
> +++ b/doc/guides/nics/netvsc.rst
> @@ -102,8 +102,8 @@ The following prerequisites apply:
>      to use the netvsc PMD with 4.16 kernel but it is limited to a single queue.
> 
> 
> -Netvsc PMD arguments
> ---------------------
> +Runtime Configuration
> +---------------------
> 
>  The user can specify below argument in devargs.
> 
> --
> 2.34.1

[PATCH 22/33] doc: update ngbe guide

[Ferruh Yigit]

- Rename "Pre-Installation Configuration" section to "Configuration"

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/ngbe.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/guides/nics/ngbe.rst b/doc/guides/nics/ngbe.rst
index dc8b1e174086..44d34197a661 100644
--- a/doc/guides/nics/ngbe.rst
+++ b/doc/guides/nics/ngbe.rst
@@ -38,8 +38,8 @@ Prerequisites
 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
 
 
-Pre-Installation Configuration
-------------------------------
+Configuration
+-------------
 
 Dynamic Logging Parameters
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
-- 
2.34.1

[PATCH 23/33] doc: update net null guide

[Ferruh Yigit]

- Rename "Runtime Config Options" section to "Runtime Configuration"

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/null.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/guides/nics/null.rst b/doc/guides/nics/null.rst
index e75abd96d230..5f746d7711f4 100644
--- a/doc/guides/nics/null.rst
+++ b/doc/guides/nics/null.rst
@@ -17,8 +17,8 @@ Usage
    ./<build_dir>/app/dpdk-testpmd -l 0-3 -n 4 --vdev net_null0 --vdev net_null1 -- -i
 
 
-Runtime Config Options
-----------------------
+Runtime Configuration
+---------------------
 
 - ``copy`` [optional, default disabled]
 
-- 
2.34.1

[PATCH 24/33] doc: update octeontx guide

[Ferruh Yigit]

- Move "Supported OCTEON TX SoCs" section up
- Rename "Pre-Installation Configuration" section "Configuration"

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/octeontx.rst | 15 +++++++--------
 1 file changed, 7 insertions(+), 8 deletions(-)

diff --git a/doc/guides/nics/octeontx.rst b/doc/guides/nics/octeontx.rst
index 092120815dc2..66c5ce93e302 100644
--- a/doc/guides/nics/octeontx.rst
+++ b/doc/guides/nics/octeontx.rst
@@ -11,6 +11,11 @@ SoC family as well as their virtual functions (VF) in SR-IOV context.
 More information can be found at `Cavium, Inc Official Website
 <http://www.cavium.com/OCTEON-TX_ARM_Processors.html>`_.
 
+Supported OCTEON TX SoCs
+------------------------
+
+- CN83xx
+
 Features
 --------
 
@@ -29,11 +34,6 @@ Features of the OCTEON TX Ethdev PMD are:
 - Lock-free Tx queue
 - HW offloaded `ethdev Rx queue` to `eventdev event queue` packet injection
 
-Supported OCTEON TX SoCs
-------------------------
-
-- CN83xx
-
 Unsupported features
 --------------------
 
@@ -49,9 +49,8 @@ Prerequisites
 
 See :doc:`../platform/octeontx` for setup information.
 
-Pre-Installation Configuration
-------------------------------
-
+Configuration
+-------------
 
 Driver compilation and testing
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-- 
2.34.1

[PATCH 25/33] doc: update pfe guide

[Ferruh Yigit]

- Reduce section indentation, 'PFE' was single top level section
- Move "Supported PFE SoCs" section up

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/pfe.rst | 25 +++++++++++--------------
 1 file changed, 11 insertions(+), 14 deletions(-)

diff --git a/doc/guides/nics/pfe.rst b/doc/guides/nics/pfe.rst
index 5261984884af..748c382573e8 100644
--- a/doc/guides/nics/pfe.rst
+++ b/doc/guides/nics/pfe.rst
@@ -10,23 +10,20 @@ support for the inbuilt NIC found in the **NXP LS1012** SoC.
 More information can be found at `NXP Official Website
 <https://nxp.com/ls1012a>`_.
 
-PFE
----
-
 This section provides an overview of the NXP PFE
 and how it is integrated into the DPDK.
 
 Contents summary
 
 - PFE overview
-- PFE features
 - Supported PFE SoCs
+- PFE features
 - Prerequisites
 - Driver compilation and testing
 - Limitations
 
 PFE Overview
-~~~~~~~~~~~~
+------------
 
 PFE is a hardware programmable packet forwarding engine to provide
 high performance Ethernet interfaces. The diagram below shows a
@@ -90,8 +87,13 @@ pfe.ko is required for PHY initialisation and also responsible for creating
 the character device "pfe_us_cdev" which will be used for interacting with
 the kernel layer for link status.
 
+Supported PFE SoCs
+------------------
+
+- LS1012
+
 PFE Features
-~~~~~~~~~~~~
+------------
 
 - L3/L4 checksum offload
 - Packet type parsing
@@ -102,13 +104,8 @@ PFE Features
 - Link status
 - ARMv8
 
-Supported PFE SoCs
-~~~~~~~~~~~~~~~~~~
-
-- LS1012
-
 Prerequisites
-~~~~~~~~~~~~~
+-------------
 
 Below are some pre-requisites for executing PFE PMD on a PFE
 compatible board:
@@ -157,7 +154,7 @@ separately:
 
 
 Driver compilation and testing
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+------------------------------
 
 Follow instructions available in the document
 :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
@@ -175,6 +172,6 @@ see the command below:
 
 
 Limitations
-~~~~~~~~~~~
+-----------
 
 - Multi buffer pool cannot be supported.
-- 
2.34.1

[PATCH 26/33] doc: update qede guide

[Ferruh Yigit]

- Move "Supported QLogic Adapters" section up
- Rename "Config Options" section to "Compilation Options"

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/qede.rst | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/doc/guides/nics/qede.rst b/doc/guides/nics/qede.rst
index 23965091a9ec..38d5cbb1f382 100644
--- a/doc/guides/nics/qede.rst
+++ b/doc/guides/nics/qede.rst
@@ -13,6 +13,11 @@ It is compile-tested under FreeBSD OS.
 More information can be found at `QLogic Corporation's Website
 <http://www.qlogic.com>`_.
 
+Supported QLogic Adapters
+-------------------------
+
+- QLogic FastLinQ QL4xxxx 10G/25G/40G/50G/100G Intelligent Ethernet Adapters (IEA) and Converged Network Adapters (CNA)
+
 Supported Features
 ------------------
 
@@ -71,11 +76,6 @@ Co-existence considerations
   Binding of PFs simultaneously to DPDK and Linux drivers on a given
   adapter is not supported.
 
-Supported QLogic Adapters
--------------------------
-
-- QLogic FastLinQ QL4xxxx 10G/25G/40G/50G/100G Intelligent Ethernet Adapters (IEA) and Converged Network Adapters (CNA)
-
 Prerequisites
 -------------
 
@@ -103,8 +103,8 @@ Performance note
 
 - For better performance, it is recommended to use 4K or higher RX/TX rings.
 
-Config Options
-~~~~~~~~~~~~~~
+Compilation Options
+~~~~~~~~~~~~~~~~~~~
 
 The following option can be modified in the ``config/rte_config.h`` file.
 
-- 
2.34.1

[PATCH 27/33] doc: update sfc guide

[Ferruh Yigit]

- Move "Supported NICs" section to top
- Rename "Pre-Installation Configuration" section to "Configuration"
- Rename "Build Options" section to "Compilation Options"
- Rename "Per-Device Parameters" section to "Runtime Configuration"

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/sfc_efx.rst | 94 ++++++++++++++++++-------------------
 1 file changed, 47 insertions(+), 47 deletions(-)

diff --git a/doc/guides/nics/sfc_efx.rst b/doc/guides/nics/sfc_efx.rst
index fcad671da20c..de0656876b96 100644
--- a/doc/guides/nics/sfc_efx.rst
+++ b/doc/guides/nics/sfc_efx.rst
@@ -18,6 +18,48 @@ More information can be found at `Solarflare Communications website
 <http://solarflare.com>`_.
 
 
+Supported NICs
+--------------
+
+- Xilinx Adapters:
+
+   - Alveo SN1022 SmartNIC
+
+- Solarflare XtremeScale Adapters:
+
+   - Solarflare X2522 Dual Port SFP28 10/25GbE Adapter
+
+   - Solarflare X2541 Single Port QSFP28 10/25G/100G Adapter
+
+   - Solarflare X2542 Dual Port QSFP28 10/25G/100G Adapter
+
+- Solarflare Flareon [Ultra] Server Adapters:
+
+   - Solarflare SFN8522 Dual Port SFP+ Server Adapter
+
+   - Solarflare SFN8522M Dual Port SFP+ Server Adapter
+
+   - Solarflare SFN8042 Dual Port QSFP+ Server Adapter
+
+   - Solarflare SFN8542 Dual Port QSFP+ Server Adapter
+
+   - Solarflare SFN8722 Dual Port SFP+ OCP Server Adapter
+
+   - Solarflare SFN7002F Dual Port SFP+ Server Adapter
+
+   - Solarflare SFN7004F Quad Port SFP+ Server Adapter
+
+   - Solarflare SFN7042Q Dual Port QSFP+ Server Adapter
+
+   - Solarflare SFN7122F Dual Port SFP+ Server Adapter
+
+   - Solarflare SFN7124F Quad Port SFP+ Server Adapter
+
+   - Solarflare SFN7142Q Dual Port QSFP+ Server Adapter
+
+   - Solarflare SFN7322F Precision Time Synchronization Server Adapter
+
+
 Features
 --------
 
@@ -290,48 +332,6 @@ conditions is met:
 - The last item is TCP or UDP, and it's empty.
 
 
-Supported NICs
---------------
-
-- Xilinx Adapters:
-
-   - Alveo SN1022 SmartNIC
-
-- Solarflare XtremeScale Adapters:
-
-   - Solarflare X2522 Dual Port SFP28 10/25GbE Adapter
-
-   - Solarflare X2541 Single Port QSFP28 10/25G/100G Adapter
-
-   - Solarflare X2542 Dual Port QSFP28 10/25G/100G Adapter
-
-- Solarflare Flareon [Ultra] Server Adapters:
-
-   - Solarflare SFN8522 Dual Port SFP+ Server Adapter
-
-   - Solarflare SFN8522M Dual Port SFP+ Server Adapter
-
-   - Solarflare SFN8042 Dual Port QSFP+ Server Adapter
-
-   - Solarflare SFN8542 Dual Port QSFP+ Server Adapter
-
-   - Solarflare SFN8722 Dual Port SFP+ OCP Server Adapter
-
-   - Solarflare SFN7002F Dual Port SFP+ Server Adapter
-
-   - Solarflare SFN7004F Quad Port SFP+ Server Adapter
-
-   - Solarflare SFN7042Q Dual Port QSFP+ Server Adapter
-
-   - Solarflare SFN7122F Dual Port SFP+ Server Adapter
-
-   - Solarflare SFN7124F Quad Port SFP+ Server Adapter
-
-   - Solarflare SFN7142Q Dual Port QSFP+ Server Adapter
-
-   - Solarflare SFN7322F Precision Time Synchronization Server Adapter
-
-
 Prerequisites
 -------------
 
@@ -347,12 +347,12 @@ Follow instructions from Solarflare Server Adapter User's Guide to
 update firmware and configure the adapter.
 
 
-Pre-Installation Configuration
-------------------------------
+Configuration
+-------------
 
 
-Build Options
-~~~~~~~~~~~~~
+Compilation Options
+~~~~~~~~~~~~~~~~~~~
 
 The following build-time options may be enabled on build time using
 ``-Dc_args=`` meson argument (e.g.  ``-Dc_args=-DRTE_LIBRTE_SFC_EFX_DEBUG``).
@@ -364,7 +364,7 @@ Please note that enabling debugging options may affect system performance.
   Enable compilation of the extra run-time consistency checks.
 
 
-Per-Device Parameters
+Runtime Configuration
 ~~~~~~~~~~~~~~~~~~~~~
 
 The following per-device parameters can be passed via EAL PCI device
-- 
2.34.1

[PATCH 28/33] doc: update softnic guide

[Ferruh Yigit]

- Rename "Soft NIC PMD arguments" section to "Runtime Configuration"

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/softnic.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/guides/nics/softnic.rst b/doc/guides/nics/softnic.rst
index 695ebed91fc2..64939fd48415 100644
--- a/doc/guides/nics/softnic.rst
+++ b/doc/guides/nics/softnic.rst
@@ -52,8 +52,8 @@ section of :ref:`the DPDK documentation <linux_gsg>` or refer to *DPDK
 Release Notes*.
 
 
-Soft NIC PMD arguments
-----------------------
+Runtime Configuration
+---------------------
 
 The user can specify below arguments in EAL ``--vdev`` options to create the
 Soft NIC device instance:
-- 
2.34.1

RE: [PATCH 28/33] doc: update softnic guide

[Dumitrescu, Cristian]

> -----Original Message-----
> From: Ferruh Yigit <ferruh.yigit@amd.com>
> Sent: Wednesday, March 22, 2023 12:00 AM
> To: Mcnamara, John <john.mcnamara@intel.com>; Dumitrescu, Cristian
> <cristian.dumitrescu@intel.com>
> Cc: Thomas Monjalon <thomas@monjalon.net>; Andrew Rybchenko
> <andrew.rybchenko@oktetlabs.ru>; dev@dpdk.org
> Subject: [PATCH 28/33] doc: update softnic guide
> 
> - Rename "Soft NIC PMD arguments" section to "Runtime Configuration"
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
> ---

Acked-by: Cristian Dumitrescu <cristian.dumitrescu@intel.com>

[PATCH 29/33] doc: update thunderx guide

[Ferruh Yigit]

- Move "Supported ThunderX SoCs" section up
- Rename "Module params" section "Runtime Configuration"

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/thunderx.rst | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/doc/guides/nics/thunderx.rst b/doc/guides/nics/thunderx.rst
index 5ae7e607de55..a64ae8e0aab3 100644
--- a/doc/guides/nics/thunderx.rst
+++ b/doc/guides/nics/thunderx.rst
@@ -11,6 +11,12 @@ as well as their virtual functions (VF) in SR-IOV context.
 More information can be found at `Cavium, Inc Official Website
 <http://www.cavium.com/ThunderX_ARM_Processors.html>`_.
 
+Supported ThunderX SoCs
+-----------------------
+- CN88xx
+- CN81xx
+- CN83xx
+
 Features
 --------
 
@@ -33,12 +39,6 @@ Features of the ThunderX PMD are:
 - Multi queue set support (up to 96 queues (12 queue sets)) per port
 - Skip data bytes
 
-Supported ThunderX SoCs
------------------------
-- CN88xx
-- CN81xx
-- CN83xx
-
 Prerequisites
 -------------
 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
@@ -365,8 +365,8 @@ EAL command option to change  log level
       or
       --log-level=pmd.net.thunderx.driver,7
 
-Module params
---------------
+Runtime Configuration
+---------------------
 
 skip_data_bytes
 ~~~~~~~~~~~~~~~
-- 
2.34.1

Re: [PATCH 29/33] doc: update thunderx guide

[Jerin Jacob]

On Wed, Mar 22, 2023 at 5:33 AM Ferruh Yigit <ferruh.yigit@amd.com> wrote:
>
> - Move "Supported ThunderX SoCs" section up
> - Rename "Module params" section "Runtime Configuration"
>
> Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>

Acked-by: Jerin Jacob <jerinj@marvell.com>


> ---
>  doc/guides/nics/thunderx.rst | 16 ++++++++--------
>  1 file changed, 8 insertions(+), 8 deletions(-)
>
> diff --git a/doc/guides/nics/thunderx.rst b/doc/guides/nics/thunderx.rst
> index 5ae7e607de55..a64ae8e0aab3 100644
> --- a/doc/guides/nics/thunderx.rst
> +++ b/doc/guides/nics/thunderx.rst
> @@ -11,6 +11,12 @@ as well as their virtual functions (VF) in SR-IOV context.
>  More information can be found at `Cavium, Inc Official Website
>  <http://www.cavium.com/ThunderX_ARM_Processors.html>`_.
>
> +Supported ThunderX SoCs
> +-----------------------
> +- CN88xx
> +- CN81xx
> +- CN83xx
> +
>  Features
>  --------
>
> @@ -33,12 +39,6 @@ Features of the ThunderX PMD are:
>  - Multi queue set support (up to 96 queues (12 queue sets)) per port
>  - Skip data bytes
>
> -Supported ThunderX SoCs
> ------------------------
> -- CN88xx
> -- CN81xx
> -- CN83xx
> -
>  Prerequisites
>  -------------
>  - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
> @@ -365,8 +365,8 @@ EAL command option to change  log level
>        or
>        --log-level=pmd.net.thunderx.driver,7
>
> -Module params
> ---------------
> +Runtime Configuration
> +---------------------
>
>  skip_data_bytes
>  ~~~~~~~~~~~~~~~
> --
> 2.34.1
>

[PATCH 30/33] doc: update txgbe guide

[Ferruh Yigit]

- Rename "Pre-Installation Configuration" section to "Configuration"
- Rename "Build Options" section to "Compilation Options"
- Rename "Runtime Options" to "Runtime Configuration"

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/txgbe.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

diff --git a/doc/guides/nics/txgbe.rst b/doc/guides/nics/txgbe.rst
index 5b29f1de0c22..c09cc3923f54 100644
--- a/doc/guides/nics/txgbe.rst
+++ b/doc/guides/nics/txgbe.rst
@@ -39,11 +39,11 @@ Prerequisites
 
 - Follow the DPDK :ref:`Getting Started Guide for Linux <linux_gsg>` to setup the basic DPDK environment.
 
-Pre-Installation Configuration
-------------------------------
+Configuration
+-------------
 
-Build Options
-~~~~~~~~~~~~~
+Compilation Options
+~~~~~~~~~~~~~~~~~~~
 
 The following build-time options may be enabled on build time using.
 
@@ -89,8 +89,8 @@ TXGBE PMD provides the following log types available for control:
   Extra logging of auto-negotiation process for backplane NICs.
   Supply ``--log-level=pmd.net.txgbe.bp:debug`` to view messages.
 
-Runtime Options
-~~~~~~~~~~~~~~~
+Runtime Configuration
+~~~~~~~~~~~~~~~~~~~~~
 
 The following ``devargs`` options can be enabled at runtime. They must
 be passed as part of EAL arguments. For example,
-- 
2.34.1

[PATCH 31/33] doc: update vdev netvsc guide

[Ferruh Yigit]

- Rename "Run-time parameters" section to "Runtime Configuration"

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/vdev_netvsc.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/guides/nics/vdev_netvsc.rst b/doc/guides/nics/vdev_netvsc.rst
index 5c1dcbf78d19..8dd598194798 100644
--- a/doc/guides/nics/vdev_netvsc.rst
+++ b/doc/guides/nics/vdev_netvsc.rst
@@ -62,8 +62,8 @@ either when hot-plug will be fully supported in EAL and bus drivers or when
 a new NetVSC driver will be integrated.
 
 
-Run-time parameters
--------------------
+Runtime Configuration
+---------------------
 
 This driver is invoked automatically in Hyper-V VM systems unless the user
 invoked it by command line using ``--vdev=net_vdev_netvsc`` EAL option.
-- 
2.34.1

[PATCH 32/33] doc: update vhost guide

[Ferruh Yigit]

- Rename "Vhost PMD arguments" section to "Runtime Configuration"

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/vhost.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/guides/nics/vhost.rst b/doc/guides/nics/vhost.rst
index d7c0e2ade86f..39c6fcff5887 100644
--- a/doc/guides/nics/vhost.rst
+++ b/doc/guides/nics/vhost.rst
@@ -25,8 +25,8 @@ Currently, the vhost PMD provides the basic functionality of packet reception, t
 
 *   Don't need to stop RX/TX, when the user wants to stop a guest or a virtio-net driver on guest.
 
-Vhost PMD arguments
--------------------
+Runtime Configuration
+---------------------
 
 The user can specify below arguments in `--vdev` option.
 
-- 
2.34.1

RE: [PATCH 32/33] doc: update vhost guide

[Xia, Chenbo]

> -----Original Message-----
> From: Ferruh Yigit <ferruh.yigit@amd.com>
> Sent: Wednesday, March 22, 2023 8:00 AM
> To: Mcnamara, John <john.mcnamara@intel.com>; Maxime Coquelin
> <maxime.coquelin@redhat.com>; Xia, Chenbo <chenbo.xia@intel.com>
> Cc: Thomas Monjalon <thomas@monjalon.net>; Andrew Rybchenko
> <andrew.rybchenko@oktetlabs.ru>; dev@dpdk.org
> Subject: [PATCH 32/33] doc: update vhost guide
> 
> - Rename "Vhost PMD arguments" section to "Runtime Configuration"
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
> ---
>  doc/guides/nics/vhost.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/guides/nics/vhost.rst b/doc/guides/nics/vhost.rst
> index d7c0e2ade86f..39c6fcff5887 100644
> --- a/doc/guides/nics/vhost.rst
> +++ b/doc/guides/nics/vhost.rst
> @@ -25,8 +25,8 @@ Currently, the vhost PMD provides the basic
> functionality of packet reception, t
> 
>  *   Don't need to stop RX/TX, when the user wants to stop a guest or a
> virtio-net driver on guest.
> 
> -Vhost PMD arguments
> --------------------
> +Runtime Configuration
> +---------------------
> 
>  The user can specify below arguments in `--vdev` option.
> 
> --
> 2.34.1

Reviewed-by: Chenbo Xia <chenbo.xia@intel.com> 

[PATCH 33/33] doc: update virtio guide

[Ferruh Yigit]

- Rename "Virtio PMD arguments" section to "Runtime Configuration"

Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
---
 doc/guides/nics/virtio.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/doc/guides/nics/virtio.rst b/doc/guides/nics/virtio.rst
index c422e7347a16..f5e54a5e9cfd 100644
--- a/doc/guides/nics/virtio.rst
+++ b/doc/guides/nics/virtio.rst
@@ -351,8 +351,8 @@ Here we use l3fwd-power as an example to show how to get started.
                                                --no-numa --parse-ptype
 
 
-Virtio PMD arguments
---------------------
+Runtime Configuration
+---------------------
 
 Below devargs are supported by the PCI virtio driver:
 
-- 
2.34.1

RE: [PATCH 33/33] doc: update virtio guide

[Xia, Chenbo]

> -----Original Message-----
> From: Ferruh Yigit <ferruh.yigit@amd.com>
> Sent: Wednesday, March 22, 2023 8:00 AM
> To: Mcnamara, John <john.mcnamara@intel.com>; Maxime Coquelin
> <maxime.coquelin@redhat.com>; Xia, Chenbo <chenbo.xia@intel.com>
> Cc: Thomas Monjalon <thomas@monjalon.net>; Andrew Rybchenko
> <andrew.rybchenko@oktetlabs.ru>; dev@dpdk.org
> Subject: [PATCH 33/33] doc: update virtio guide
> 
> - Rename "Virtio PMD arguments" section to "Runtime Configuration"
> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit@amd.com>
> ---
>  doc/guides/nics/virtio.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/guides/nics/virtio.rst b/doc/guides/nics/virtio.rst
> index c422e7347a16..f5e54a5e9cfd 100644
> --- a/doc/guides/nics/virtio.rst
> +++ b/doc/guides/nics/virtio.rst
> @@ -351,8 +351,8 @@ Here we use l3fwd-power as an example to show how to
> get started.
>                                                 --no-numa --parse-ptype
> 
> 
> -Virtio PMD arguments
> ---------------------
> +Runtime Configuration
> +---------------------
> 
>  Below devargs are supported by the PCI virtio driver:
> 
> --
> 2.34.1

Reviewed-by: Chenbo Xia <chenbo.xia@intel.com> 

Re: [PATCH 00/33] Update net driver documentation

[fengchengwen]

On 2023/3/22 7:59, Ferruh Yigit wrote:
> Some PMDs has "Pre-Installation Configuration" section in their documentation,
> although section is not clear I assume that is historical from times compile
> time parameters and 'make' build system used, where common make target was
> 'install', so section refers to compile time configuration.
> 
> Right now device arguments ("Runtime configuration") is documented under this
> section which is confusing, so updating section name
> from "Pre-Installation Configuration" to "Configuration".
> 
> While touching documents trying to keep following template in the documents,
> with section names and order, to have consistent documents without being
> too strict on applying the template:
> 
> 	[Overview]
> 	Supported Devices
> 	Supported Features
> 	Prerequisites
> 	Configuration
> 		Compilation Options
> 		Environment variables
> 		Runtime Configuration
> 	Debugging
> 	Limitations or Known issues
> 	Testpmd driver specific commands

Suggest document the template, so that new PMD will refer to it.

I didn't find a guide about how to add a new PMD, the above templeate is good in it.
And the guide could also includes which ops should mandatory implements, which ops
is optional implements.

> 
> Note: Patch sent as each driver separately to help review, it can be squashed
> while merging.
> 
> Other further improvements not covered here can be visiting
>  "Building DPDK" sections which has redundant and less useful information,
>  and "Usage example" section which has testpmd log, most of the part is same for
>  all drivers.
> 
> .

...

Re: [PATCH 00/33] Update net driver documentation

[Ferruh Yigit]

On 3/22/2023 12:48 AM, fengchengwen wrote:
> On 2023/3/22 7:59, Ferruh Yigit wrote:
>> Some PMDs has "Pre-Installation Configuration" section in their documentation,
>> although section is not clear I assume that is historical from times compile
>> time parameters and 'make' build system used, where common make target was
>> 'install', so section refers to compile time configuration.
>>
>> Right now device arguments ("Runtime configuration") is documented under this
>> section which is confusing, so updating section name
>> from "Pre-Installation Configuration" to "Configuration".
>>
>> While touching documents trying to keep following template in the documents,
>> with section names and order, to have consistent documents without being
>> too strict on applying the template:
>>
>> 	[Overview]
>> 	Supported Devices
>> 	Supported Features
>> 	Prerequisites
>> 	Configuration
>> 		Compilation Options
>> 		Environment variables
>> 		Runtime Configuration
>> 	Debugging
>> 	Limitations or Known issues
>> 	Testpmd driver specific commands
> 
> Suggest document the template, so that new PMD will refer to it.
> 

+1 to document it, but not sure where to put this information.

> I didn't find a guide about how to add a new PMD, the above templeate is good in it.
> And the guide could also includes which ops should mandatory implements, which ops
> is optional implements.
> 
>>
>> Note: Patch sent as each driver separately to help review, it can be squashed
>> while merging.
>>
>> Other further improvements not covered here can be visiting
>>  "Building DPDK" sections which has redundant and less useful information,
>>  and "Usage example" section which has testpmd log, most of the part is same for
>>  all drivers.
>>
>> .
> 
> ...

RE: [PATCH 00/33] Update net driver documentation

[Zhang, Qi Z]

> -----Original Message-----
> From: Ferruh Yigit <ferruh.yigit@amd.com>
> Sent: Wednesday, March 22, 2023 7:59 AM
> To: Mcnamara, John <john.mcnamara@intel.com>
> Cc: Thomas Monjalon <thomas@monjalon.net>; Andrew Rybchenko
> <andrew.rybchenko@oktetlabs.ru>; dev@dpdk.org
> Subject: [PATCH 00/33] Update net driver documentation
> 
> Some PMDs has "Pre-Installation Configuration" section in their
> documentation, although section is not clear I assume that is historical from
> times compile time parameters and 'make' build system used, where
> common make target was 'install', so section refers to compile time
> configuration.
> 
> Right now device arguments ("Runtime configuration") is documented under
> this section which is confusing, so updating section name from "Pre-
> Installation Configuration" to "Configuration".
> 
> While touching documents trying to keep following template in the
> documents, with section names and order, to have consistent documents
> without being too strict on applying the template:
> 
> 	[Overview]
> 	Supported Devices
> 	Supported Features
> 	Prerequisites
> 	Configuration
> 		Compilation Options
> 		Environment variables
> 		Runtime Configuration
> 	Debugging
> 	Limitations or Known issues
> 	Testpmd driver specific commands
> 
> Note: Patch sent as each driver separately to help review, it can be squashed
> while merging.
> 
> Other further improvements not covered here can be visiting  "Building
> DPDK" sections which has redundant and less useful information,  and
> "Usage example" section which has testpmd log, most of the part is same for
> all drivers.
> 
> .
> 
> Ferruh Yigit (33):
>   doc: update atlantic guide
>   doc: update cpfl guide
>   doc: update cxgbe guide
>   doc: update dpaa guide
>   doc: update ena guide
>   doc: update enetc guide
>   doc: update enetfec guide
>   doc: update enic guide
>   doc: update hns3 guide
>   doc: update i40e guide
>   doc: update ice guide
>   doc: update idpf guide
>   doc: update igb guide
>   doc: update igc guide
>   doc: update ipn3ke guide
>   doc: update ixgbe guide
>   doc: update kni guide
>   doc: update mana guide
>   doc: update mlx5 guide
>   doc: update mvneta guide
>   doc: update netvsc guide
>   doc: update ngbe guide
>   doc: update net null guide
>   doc: update octeontx guide
>   doc: update pfe guide
>   doc: update qede guide
>   doc: update sfc guide
>   doc: update softnic guide
>   doc: update thunderx guide
>   doc: update txgbe guide
>   doc: update vdev netvsc guide
>   doc: update vhost guide
>   doc: update virtio guide
> 
>  doc/guides/nics/atlantic.rst    |  27 +++-----
>  doc/guides/nics/cpfl.rst        |  51 +++++++-------
>  doc/guides/nics/cxgbe.rst       |  61 ++++++++---------
>  doc/guides/nics/dpaa.rst        |   5 +-
>  doc/guides/nics/ena.rst         |  60 +++++++++--------
>  doc/guides/nics/enetc.rst       |  25 +++----
>  doc/guides/nics/enetfec.rst     |  12 ++--
>  doc/guides/nics/enic.rst        |  79 ++++++++++------------
>  doc/guides/nics/hns3.rst        |  30 ++++-----
>  doc/guides/nics/i40e.rst        |  10 +--
>  doc/guides/nics/ice.rst         |   8 +--
>  doc/guides/nics/idpf.rst        |   8 +--
>  doc/guides/nics/igb.rst         |  23 +++----
>  doc/guides/nics/igc.rst         |  16 ++---
>  doc/guides/nics/ipn3ke.rst      |   9 ++-
>  doc/guides/nics/ixgbe.rst       |  62 ++++++++---------
>  doc/guides/nics/kni.rst         |   4 +-
>  doc/guides/nics/mana.rst        |   4 +-
>  doc/guides/nics/mlx5.rst        | 116 ++++++++++++++++----------------
>  doc/guides/nics/mvneta.rst      |   4 +-
>  doc/guides/nics/netvsc.rst      |   4 +-
>  doc/guides/nics/ngbe.rst        |   4 +-
>  doc/guides/nics/null.rst        |   4 +-
>  doc/guides/nics/octeontx.rst    |  15 ++---
>  doc/guides/nics/pfe.rst         |  25 +++----
>  doc/guides/nics/qede.rst        |  14 ++--
>  doc/guides/nics/sfc_efx.rst     |  94 +++++++++++++-------------
>  doc/guides/nics/softnic.rst     |   4 +-
>  doc/guides/nics/thunderx.rst    |  16 ++---
>  doc/guides/nics/txgbe.rst       |  12 ++--
>  doc/guides/nics/vdev_netvsc.rst |   4 +-
>  doc/guides/nics/vhost.rst       |   4 +-
>  doc/guides/nics/virtio.rst      |   4 +-
>  33 files changed, 395 insertions(+), 423 deletions(-)
> 
> --
> 2.34.1

For Intel nic i40e/ice/ixgbe/idpf/cpfl/igb/igc/ipn3ke

Acked-by: Qi Zhang <qi.z.zhang@intel.com>

Thanks!

Re: [PATCH 00/33] Update net driver documentation

[Thomas Monjalon]

22/03/2023 00:59, Ferruh Yigit:
> Some PMDs has "Pre-Installation Configuration" section in their documentation,
> although section is not clear I assume that is historical from times compile
> time parameters and 'make' build system used, where common make target was
> 'install', so section refers to compile time configuration.
> 
> Right now device arguments ("Runtime configuration") is documented under this
> section which is confusing, so updating section name
> from "Pre-Installation Configuration" to "Configuration".
> 
> While touching documents trying to keep following template in the documents,
> with section names and order, to have consistent documents without being
> too strict on applying the template:
> 
> 	[Overview]
> 	Supported Devices
> 	Supported Features
> 	Prerequisites
> 	Configuration
> 		Compilation Options
> 		Environment variables
> 		Runtime Configuration
> 	Debugging
> 	Limitations or Known issues
> 	Testpmd driver specific commands
> 
> Note: Patch sent as each driver separately to help review, it can be squashed
> while merging.

Squashed and applied, thanks.

> Other further improvements not covered here can be visiting
>  "Building DPDK" sections which has redundant and less useful information,
>  and "Usage example" section which has testpmd log, most of the part is same for
>  all drivers.

Yes, good idea to remove redundant information and replace with good links.