From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
	by inbox.dpdk.org (Postfix) with ESMTP id 57574A052A;
	Tue,  2 Feb 2021 20:17:40 +0100 (CET)
Received: from [217.70.189.124] (localhost [127.0.0.1])
	by mails.dpdk.org (Postfix) with ESMTP id 408AF2403C5;
	Tue,  2 Feb 2021 20:17:40 +0100 (CET)
Received: from mga14.intel.com (mga14.intel.com [192.55.52.115])
 by mails.dpdk.org (Postfix) with ESMTP id 23D422403C5
 for <dev@dpdk.org>; Tue,  2 Feb 2021 20:17:37 +0100 (CET)
IronPort-SDR: F+WbjhNYvNWbVH2ZKeI0awAJpRSfVOWazi9kD0Datm3cQuAEj0p8/I1NeNTuIML8dYw4eM1sry
 FRR2fsvW6XKA==
X-IronPort-AV: E=McAfee;i="6000,8403,9883"; a="180138798"
X-IronPort-AV: E=Sophos;i="5.79,396,1602572400"; d="scan'208";a="180138798"
Received: from fmsmga004.fm.intel.com ([10.253.24.48])
 by fmsmga103.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;
 02 Feb 2021 11:17:37 -0800
IronPort-SDR: H+OdDU8d3FJ1LftoYy+Ezf6wprheVkt1dFeZBR5SaIQ3zbYUWn4mgxFJPdQtEH1RmI5zdSg1XL
 2Ppe+NfDC6yA==
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.79,396,1602572400"; d="scan'208";a="406280421"
Received: from win-dpdk-pallavi.jf.intel.com (HELO localhost.localdomain)
 ([10.166.188.111])
 by fmsmga004.fm.intel.com with ESMTP; 02 Feb 2021 11:17:36 -0800
From: Pallavi Kadam <pallavi.kadam@intel.com>
To: dev@dpdk.org,
	thomas@monjalon.net,
	ferruh.yigit@intel.com
Cc: ranjit.menon@intel.com, beilei.xing@intel.com, jia.guo@intel.com,
 pallavi.kadam@intel.com
Date: Tue,  2 Feb 2021 11:09:16 -0800
Message-Id: <20210202190916.4632-1-pallavi.kadam@intel.com>
X-Mailer: git-send-email 2.18.0.windows.1
In-Reply-To: <20210126230343.36-1-pallavi.kadam@intel.com>
References: <20210126230343.36-1-pallavi.kadam@intel.com>
MIME-Version: 1.0
Content-Type: text/plain; charset=y
Content-Transfer-Encoding: 8bit
Subject: [dpdk-dev] [PATCH v3] doc: update i40e PMD to support on windows
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

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(-)

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:
-- 
2.25.4