[dpdk-dev] [PATCH 21/22] doc: updating REAME for NetUIO driver

[Narcisa Ana Maria Vasile]

From: Harini Ramakrishnan <haramakr at microsoft.com>

Signed-off-by: Harini Ramakrishnan <haramakr at microsoft.com>
---
 kernel/README_NetUIO.rst | 63 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 63 insertions(+)
 create mode 100644 kernel/README_NetUIO.rst

diff --git a/kernel/README_NetUIO.rst b/kernel/README_NetUIO.rst
new file mode 100644
index 000000000..9b21a4a8b
--- /dev/null
+++ b/kernel/README_NetUIO.rst
@@ -0,0 +1,63 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2020 Microsoft Corporation.
+
+Compiling the NetUIO Driver from Source
+=======================================
+
+Operating System
+~~~~~~~~~~~~~~~~
+
+The NetUIO source has been validated against the following operating systems:
+
+* Windows Server 2016
+* Windows Server 2019
+
+Hardware Requirements
+~~~~~~~~~~~~~~~~~~~~~
+The NetUIO driver has been validated using the following network adapters on the Windows platform:
+
+*
+*
+
+Software Requirements
+~~~~~~~~~~~~~~~~~~~~~
+
+* Install Microsoft Visual Studio 2017 or Visual Stuido Studio 2019 Enterprise from https://visualstudio.microsoft.com/downloads/ 
+	* During installation ensure following components are selected:
+		Windows 10 SDK (10.0.15063.0) 
+		Windows 10 SDK (10.0.17763.0)
+		Windows Drivers Kit
+		
+* Install WDK for Windows 10 (10.0.17763.1) from https://docs.microsoft.com/en-us/windows-hardware/drivers/download-the-wdk 
+
+Building the NetUIO Driver
+--------------------------
+Follow the steps below to build the NetUIO driver and install the driver for the network adapter. 
+
+* Clone the dpdk-kmods repository: git clone git://dpdk.org/dpdk-kmods
+* Navigate to \dpdk-kmods\windows\netuio\mk\exec-env\windows\netuio
+* Load netuio.sln in Microsoft Visual Studio 2017 or 2019
+* Choose Release as the configuration mode and Build the solution
+* The resultant output files can be found in \dpdk-kmods\windows\netuio\x64\Release\netuio
+ 
+Installing netuio.sys Driver for development
+--------------------------------------------
+NOTE: In a development environment, NetUIO driver can be loaded by enabling test-signing. 
+Please implement adequate precautionary measures before installing a test-signed driver, replacing a signed-driver.
+
+To ensure test-signed kernel-mode drivers can load on Windows, enable test-signing, using the following BCDEdit command.
+
+C:\windows\system32>Bcdedit.exe -set TESTSIGNING ON
+
+Windows displays the text “Test Mode” to remind users the system has test-signing enabled. 
+Refer to the MSDN documentation on how to Test-Sign a Driver Package.
+ 
+To procure a WHQL signed NetUIO driver for Windows, please reach out to dpdkwin at microsoft.com
+
+* Go to Device Manager -> Network Adapters.
+* Right Click on target network adapter -> Select Update Driver.
+* Select “Browse my computer for driver software”.
+* In the resultant Window, select “Let me pick from a list of available drivers on my computer”.
+* Select “DPDK netUIO for Network Adapter” from the list of drivers.
+* The NetUIO.sys driver is successfully installed.
+ 
\ No newline at end of file
-- 
2.23.0.vfs.1.1.63.g5a5ad7f