[v3,3/3] doc: update iavf PMD and 21.11 release notes
Checks
Commit Message
Add documentation to support iavf PMD on Windows.
Update the release notes for the same.
Signed-off-by: Pallavi Kadam <pallavi.kadam@intel.com>
Reviewed-by: Ranjit Menon <ranjit.menon@intel.com>
---
doc/guides/nics/intel_vf.rst | 18 ++++++++++++++++++
doc/guides/rel_notes/release_21_11.rst | 4 ++++
2 files changed, 22 insertions(+)
Comments
-----Original Message-----
From: Kadam, Pallavi <pallavi.kadam@intel.com>
Sent: Thursday, September 9, 2021 4:23 PM
To: dev@dpdk.org
Cc: thomas@monjalon.net; Zhang, Qi Z <qi.z.zhang@intel.com>; fady@mellanox.com; Narcisa.Vasile@microsoft.com; dmitry.kozliuk@gmail.com; Yigit, Ferruh <ferruh.yigit@intel.com>; Wu, Jingjing <jingjing.wu@intel.com>; Xing, Beilei <beilei.xing@intel.com>; Menon, Ranjit <ranjit.menon@intel.com>; Shukla, Shivanshu <shivanshu.shukla@intel.com>; Kadam, Pallavi <pallavi.kadam@intel.com>
Subject: [PATCH v3 3/3] doc: update iavf PMD and 21.11 release notes
Add documentation to support iavf PMD on Windows.
Update the release notes for the same.
Signed-off-by: Pallavi Kadam <pallavi.kadam@intel.com>
Reviewed-by: Ranjit Menon <ranjit.menon@intel.com>
Ack-by: Shivanshu Shukla <shivanshu.shukla@intel.com>
---
doc/guides/nics/intel_vf.rst | 18 ++++++++++++++++++
doc/guides/rel_notes/release_21_11.rst | 4 ++++
2 files changed, 22 insertions(+)
diff --git a/doc/guides/nics/intel_vf.rst b/doc/guides/nics/intel_vf.rst index fcea8151bf..20b89431a4 100644
--- a/doc/guides/nics/intel_vf.rst
+++ b/doc/guides/nics/intel_vf.rst
@@ -616,3 +616,21 @@ which belongs to the destination VF on the VM.
.. figure:: img/inter_vm_comms.*
Inter-VM Communication
+
+
+Windows Support
+---------------
+
+* IAVF PMD currently is supported only inside Windows guest created on Linux host.
+
+* Physical PCI resources are exposed as virtual functions into Windows VM using SR-IOV pass through feature.
+
+* Create a Windows guest on Linux host using KVM hypervisor. Refer to the steps mentioned in the above section "Setting Up a KVM Virtual Machine monitor"
+
+* In the Host machine, download and install the kernel Ethernet driver from:
+
+`http://downloadcenter.intel.com/Detail_Desc.aspx?agr=Y&DwnldID=146
+87
+<http://downloadcenter.intel.com/Detail_Desc.aspx?agr=Y&DwnldID=146
+87>`_
+
+* For Windows guest, install NetUIO driver in place of existing built-in(inbox) Virtual Function driver.
+
+* To load NetUIO driver, follow the steps mentioned in `dpdk-kmods repository
+ <https://git.dpdk.org/dpdk-kmods/tree/windows/netuio/README.rst>`_.
diff --git a/doc/guides/rel_notes/release_21_11.rst b/doc/guides/rel_notes/release_21_11.rst
index 675b573834..f5ae66a0ef 100644
--- a/doc/guides/rel_notes/release_21_11.rst
+++ b/doc/guides/rel_notes/release_21_11.rst
@@ -62,6 +62,10 @@ New Features
* Added bus-level parsing of the devargs syntax.
* Kept compatibility with the legacy syntax as parsing fallback.
+* **Updated Intel iavf driver.**
+
+ * Added Intel iavf support on Windows.
+
Removed Items
-------------
--
2.31.1.windows.1
10/09/2021 01:23, Pallavi Kadam:
> Add documentation to support iavf PMD on Windows.
> Update the release notes for the same.
>
> Signed-off-by: Pallavi Kadam <pallavi.kadam@intel.com>
> Reviewed-by: Ranjit Menon <ranjit.menon@intel.com>
> ---
> doc/guides/nics/intel_vf.rst | 18 ++++++++++++++++++
> doc/guides/rel_notes/release_21_11.rst | 4 ++++
> 2 files changed, 22 insertions(+)
It should be squashed with the patch enabling IAVF on Windows.
In general, doc should not be updated separately.
10/09/2021 01:23, Pallavi Kadam:
> Add documentation to support iavf PMD on Windows.
> Update the release notes for the same.
>
> Signed-off-by: Pallavi Kadam <pallavi.kadam@intel.com>
> Reviewed-by: Ranjit Menon <ranjit.menon@intel.com>
> ---
> --- a/doc/guides/nics/intel_vf.rst
> +++ b/doc/guides/nics/intel_vf.rst
> +Windows Support
> +---------------
> +
> +* IAVF PMD currently is supported only inside Windows guest created on Linux host.
> +
> +* Physical PCI resources are exposed as virtual functions into Windows VM using SR-IOV pass through feature.
> +
> +* Create a Windows guest on Linux host using KVM hypervisor. Refer to the steps mentioned in the above section "Setting Up a KVM Virtual Machine monitor"
It should be an internal hyperlink.
> +
> +* In the Host machine, download and install the kernel Ethernet driver from:
> + `http://downloadcenter.intel.com/Detail_Desc.aspx?agr=Y&DwnldID=14687 <http://downloadcenter.intel.com/Detail_Desc.aspx?agr=Y&DwnldID=14687>`_
No need to print the full URL as hyperlink.
> +
> +* For Windows guest, install NetUIO driver in place of existing built-in(inbox) Virtual Function driver.
> +
> +* To load NetUIO driver, follow the steps mentioned in `dpdk-kmods repository
> + <https://git.dpdk.org/dpdk-kmods/tree/windows/netuio/README.rst>`_.
@@ -616,3 +616,21 @@ which belongs to the destination VF on the VM.
.. figure:: img/inter_vm_comms.*
Inter-VM Communication
+
+
+Windows Support
+---------------
+
+* IAVF PMD currently is supported only inside Windows guest created on Linux host.
+
+* Physical PCI resources are exposed as virtual functions into Windows VM using SR-IOV pass through feature.
+
+* Create a Windows guest on Linux host using KVM hypervisor. Refer to the steps mentioned in the above section "Setting Up a KVM Virtual Machine monitor"
+
+* In the Host machine, download and install the kernel Ethernet driver from:
+ `http://downloadcenter.intel.com/Detail_Desc.aspx?agr=Y&DwnldID=14687 <http://downloadcenter.intel.com/Detail_Desc.aspx?agr=Y&DwnldID=14687>`_
+
+* For Windows guest, install NetUIO driver in place of existing built-in(inbox) Virtual Function driver.
+
+* To load NetUIO driver, follow the steps mentioned in `dpdk-kmods repository
+ <https://git.dpdk.org/dpdk-kmods/tree/windows/netuio/README.rst>`_.
@@ -62,6 +62,10 @@ New Features
* Added bus-level parsing of the devargs syntax.
* Kept compatibility with the legacy syntax as parsing fallback.
+* **Updated Intel iavf driver.**
+
+ * Added Intel iavf support on Windows.
+
Removed Items
-------------