diff mbox series

[v3] doc: update i40e PMD to support on windows

Message ID 20210202190916.4632-1-pallavi.kadam@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Ferruh Yigit
Headers
Series [v3] doc: update i40e PMD to support on windows |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS

Commit Message

Kadam, Pallavi Feb. 2, 2021, 7:09 p.m. UTC 
  Add documentation to support i40e PMD on Windows.
Update the release notes and features list for the same.

v3 changes:
	- Replaced the commit link with netuio README.rst
	  documentation link

v2 changes:
	- updated doc/guides/nics/features/i40e.ini file
	- Replaced the name UIO with NetUIO

Signed-off-by: Pallavi Kadam <pallavi.kadam@intel.com>
Reviewed-by: Ranjit Menon <ranjit.menon@intel.com>
---
 doc/guides/nics/features/i40e.ini      |  1 +
 doc/guides/nics/i40e.rst               | 16 ++++++++++++++--
 doc/guides/rel_notes/release_21_02.rst |  4 ++++
 3 files changed, 19 insertions(+), 2 deletions(-)

Comments

Ferruh Yigit Feb. 3, 2021, 10:22 a.m. UTC | #1 
On 2/2/2021 7:09 PM, Pallavi Kadam wrote:
> Add documentation to support i40e PMD on Windows.
> Update the release notes and features list for the same.
> 
> v3 changes:
> 	- Replaced the commit link with netuio README.rst
> 	  documentation link
> 
> v2 changes:
> 	- updated doc/guides/nics/features/i40e.ini file
> 	- Replaced the name UIO with NetUIO
> 
> Signed-off-by: Pallavi Kadam <pallavi.kadam@intel.com>
> Reviewed-by: Ranjit Menon <ranjit.menon@intel.com>

Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
Ferruh Yigit Feb. 3, 2021, 10:59 a.m. UTC | #2 
On 2/3/2021 10:22 AM, Ferruh Yigit wrote:
> On 2/2/2021 7:09 PM, Pallavi Kadam wrote:
>> Add documentation to support i40e PMD on Windows.
>> Update the release notes and features list for the same.
>>
>> v3 changes:
>>     - Replaced the commit link with netuio README.rst
>>       documentation link
>>
>> v2 changes:
>>     - updated doc/guides/nics/features/i40e.ini file
>>     - Replaced the name UIO with NetUIO
>>
>> Signed-off-by: Pallavi Kadam <pallavi.kadam@intel.com>
>> Reviewed-by: Ranjit Menon <ranjit.menon@intel.com>
> 
> Reviewed-by: Ferruh Yigit <ferruh.yigit@intel.com>
> 

Applied to dpdk-next-net/main, thanks.
diff mbox series

Patch

diff --git a/doc/guides/nics/features/i40e.ini b/doc/guides/nics/features/i40e.ini
index b0a5ef424..542432c41 100644
--- a/doc/guides/nics/features/i40e.ini
+++ b/doc/guides/nics/features/i40e.ini
@@ -47,6 +47,7 @@  Module EEPROM dump   = Y
 Multiprocess aware   = Y
 FreeBSD              = Y
 Linux                = Y
+Windows              = Y
 x86-32               = Y
 x86-64               = Y
 ARMv8                = Y
diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst
index 20c998398..45a144230 100644
--- a/doc/guides/nics/i40e.rst
+++ b/doc/guides/nics/i40e.rst
@@ -46,8 +46,8 @@  Features of the i40e PMD are:
 - Malicious Device Drive event catch and notify
 - Generic flow API
 
-Prerequisites
--------------
+Linux Prerequisites
+-------------------
 
 - Identifying your adapter using `Intel Support
   <http://www.intel.com/support>`_ and get the latest NVM/FW images.
@@ -75,6 +75,18 @@  Prerequisites
       * In all cases Intel recommends using Intel Ethernet Optics; other modules
         may function but are not validated by Intel. Contact Intel for supported media types.
 
+Windows Prerequisites
+---------------------
+
+- Follow the DPDK `Getting Started Guide for Windows <https://doc.dpdk.org/guides/windows_gsg/index.html>`_ to setup the basic DPDK environment.
+
+- Identify the Intel® Ethernet adapter and get the latest NVM/FW version.
+
+- To access any Intel® Ethernet hardware, load the NetUIO driver in place of existing built-in (inbox) driver.
+
+- To load NetUIO driver, follow the steps mentioned in `dpdk-kmods repository
+  <https://git.dpdk.org/dpdk-kmods/tree/windows/netuio/README.rst>`_.
+
 Recommended Matching List
 -------------------------
 
diff --git a/doc/guides/rel_notes/release_21_02.rst b/doc/guides/rel_notes/release_21_02.rst
index cc181dfd1..313b8bbc7 100644
--- a/doc/guides/rel_notes/release_21_02.rst
+++ b/doc/guides/rel_notes/release_21_02.rst
@@ -92,6 +92,10 @@  New Features
 
   * Added support for 64B completion queue entries
 
+* **Updated Intel i40e driver.**
+
+  * Added support on Windows.
+
 * **Updated Intel ice driver.**
 
   Updated the Intel ice driver with new features and improvements, including: