[PATCH 1/3] doc/nics: improve structure of Intel VF section

[Medvedkin, Vladimir]

Acked-by: Vladimir Medvedkin <vladimir.medvedkin at intel.com>

On 24/02/2025 15:26, Bruce Richardson wrote:
> The Intel VF section in the NIC guide document had descriptions of the
> various drivers at a very deep level of the document hierarchy. Improve
> the structure of the doc by giving those per-driver subsections their
> own top-level section. Also create a new top-level section for details
> of hypervisor use of VFs.
>
> Signed-off-by: Bruce Richardson <bruce.richardson at intel.com>
> ---
>   doc/guides/nics/intel_vf.rst | 20 ++++++++++++++------
>   1 file changed, 14 insertions(+), 6 deletions(-)
>
> diff --git a/doc/guides/nics/intel_vf.rst b/doc/guides/nics/intel_vf.rst
> index 4780ee7add..2b0eebcafe 100644
> --- a/doc/guides/nics/intel_vf.rst
> +++ b/doc/guides/nics/intel_vf.rst
> @@ -68,8 +68,12 @@ and the Physical Function operates on the global resources on behalf of the Virt
>   For this out-of-band communication, an SR-IOV enabled NIC provides a memory buffer for each Virtual Function,
>   which is called a "Mailbox".
>   
> +Intel SR-IOV drivers
> +--------------------
> +
> +
>   Intel® Ethernet Adaptive Virtual Function
> -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>   Adaptive Virtual Function (IAVF) is a SR-IOV Virtual Function with the same device id (8086:1889) on different Intel Ethernet Controller.
>   IAVF Driver is VF driver which supports for all future Intel devices without requiring a VM update. And since this happens to be an adaptive VF driver,
>   every new drop of the VF driver would add more and more advanced features that can be turned on in the VM if the underlying HW device supports those
> @@ -126,7 +130,7 @@ For more detail on SR-IOV, please refer to the following documents:
>       * ``offload``: Check for use of an unsupported offload flag.
>   
>   The PCIE host-interface of Intel Ethernet Switch FM10000 Series VF infrastructure
> -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>   
>   In a virtualized environment, the programmer can enable a maximum of *64 Virtual Functions (VF)*
>   globally per PCIE host-interface of the Intel Ethernet Switch FM10000 Series device.
> @@ -157,7 +161,7 @@ However:
>       The above is an important consideration to take into account when targeting specific packets to a selected port.
>   
>   Intel® X710/XL710 Gigabit Ethernet Controller VF Infrastructure
> -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>   
>   In a virtualized environment, the programmer can enable a maximum of *128 Virtual Functions (VF)*
>   globally per Intel® X710/XL710 Gigabit Ethernet Controller NIC device.
> @@ -196,7 +200,7 @@ However:
>       one transmit queue. The default number of queue pairs per VF is 4, and can be 16 in maximum.
>   
>   Intel® 82599 10 Gigabit Ethernet Controller VF Infrastructure
> -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>   
>   The programmer can enable a maximum of *63 Virtual Functions* and there must be *one Physical Function* per Intel® 82599
>   10 Gigabit Ethernet Controller NIC port.
> @@ -271,7 +275,7 @@ However:
>       The above is an important consideration to take into account when targeting specific packets to a selected port.
>   
>   Intel® 82576 Gigabit Ethernet Controller and Intel® Ethernet Controller I350 Family VF Infrastructure
> -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>   
>   In a virtualized environment, an Intel® 82576 Gigabit Ethernet Controller serves up to eight virtual machines (VMs).
>   The controller has 16 TX and 16 RX queues.
> @@ -316,6 +320,10 @@ However:
>   
>       The above is an important consideration to take into account when targeting specific packets to a selected port.
>   
> +
> +Hypervisor Use of VFs
> +---------------------
> +
>   Validated Hypervisors
>   ~~~~~~~~~~~~~~~~~~~~~
>   
> @@ -341,7 +349,7 @@ For supported kernel versions, refer to the *DPDK Release Notes*.
>   .. _intel_vf_kvm:
>   
>   Setting Up a KVM Virtual Machine Monitor
> -----------------------------------------
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>   
>   The following describes a target environment:
>   

-- 
Regards,
Vladimir