diff mbox series

doc: update i40e PMD to support on windows

Message ID 20210121190956.2540-1-pallavi.kadam@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Qi Zhang
Headers show
Series doc: update i40e PMD to support on windows | expand

Checks

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

Commit Message

Kadam, Pallavi Jan. 21, 2021, 7:09 p.m. UTC
Add documentation to support i40e 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/i40e.rst               | 16 ++++++++++++++--
 doc/guides/rel_notes/release_21_02.rst |  4 ++++
 2 files changed, 18 insertions(+), 2 deletions(-)

Comments

Thomas Monjalon Jan. 21, 2021, 9:46 p.m. UTC | #1
21/01/2021 20:09, Pallavi Kadam:
> Add documentation to support i40e 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/i40e.rst               | 16 ++++++++++++++--
>  doc/guides/rel_notes/release_21_02.rst |  4 ++++
>  2 files changed, 18 insertions(+), 2 deletions(-)

The update of doc/guides/nics/features/i40e.ini is missing.
Please see the line "Windows" in mlx5.ini for comparison.

[...]
> +- To access any Intel® Ethernet hardware, load the UIO driver in place of existing built-in (inbox) driver.
> +
> +- To load UIO driver, follow the steps mentioned in `dpdk-kmods repository
> +  <https://browse.dpdk.org/dpdk-kmods/commit/?id=e28aabd882798f21b94918d4517621ce9e355269>`_.

I think we should say NetUIO instead of UIO.
Kadam, Pallavi Jan. 22, 2021, 1:59 p.m. UTC | #2
On 1/22/2021 3:16 AM, Thomas Monjalon wrote:
> 21/01/2021 20:09, Pallavi Kadam:
>> Add documentation to support i40e 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/i40e.rst               | 16 ++++++++++++++--
>>   doc/guides/rel_notes/release_21_02.rst |  4 ++++
>>   2 files changed, 18 insertions(+), 2 deletions(-)
> The update of doc/guides/nics/features/i40e.ini is missing.
> Please see the line "Windows" in mlx5.ini for comparison.

Thank you. Sure, I'll update it in v2.

>
> [...]
>> +- To access any Intel® Ethernet hardware, load the UIO driver in place of existing built-in (inbox) driver.
>> +
>> +- To load UIO driver, follow the steps mentioned in `dpdk-kmods repository
>> +  <https://browse.dpdk.org/dpdk-kmods/commit/?id=e28aabd882798f21b94918d4517621ce9e355269>`_.
> I think we should say NetUIO instead of UIO.

Agree. Will replace this in v2.

>
>
diff mbox series

Patch

diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst
index 20c998398..7bdaea8c0 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 UIO driver in place of existing built-in (inbox) driver.
+
+- To load UIO driver, follow the steps mentioned in `dpdk-kmods repository
+  <https://browse.dpdk.org/dpdk-kmods/commit/?id=e28aabd882798f21b94918d4517621ce9e355269>`_.
+
 Recommended Matching List
 -------------------------
 
diff --git a/doc/guides/rel_notes/release_21_02.rst b/doc/guides/rel_notes/release_21_02.rst
index ae36b6a3f..176c6a66f 100644
--- a/doc/guides/rel_notes/release_21_02.rst
+++ b/doc/guides/rel_notes/release_21_02.rst
@@ -82,6 +82,10 @@  New Features
 
   * Added support for 64B completion queue entries
 
+* **Updated Intel i40e driver.**
+
+  * Added support on Windows.
+
 * **Updated Intel ice driver.**
 
   * Added Double VLAN support for DCF switch QinQ filtering.