[v2] doc: update i40e PMD to support on windows
Checks
Commit Message
Add documentation to support i40e PMD on Windows.
Update the release notes and features list for the same.
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
On 1/26/2021 11:03 PM, Pallavi Kadam wrote:
> Add documentation to support i40e PMD on Windows.
> Update the release notes and features list for the same.
>
> 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>
<...>
> @@ -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://browse.dpdk.org/dpdk-kmods/commit/?id=e28aabd882798f21b94918d4517621ce9e355269>`_.
Is the intention to reference the 'README.rst'? If so better to provide link for
the documentation, instead of a specific commit, like:
https://git.dpdk.org/dpdk-kmods/tree/windows/README.rst
And for long term, I guess we need a way to host 'dpdk-kmods' repo documentation.
On 2/2/2021 4:21 AM, Ferruh Yigit wrote:
> On 1/26/2021 11:03 PM, Pallavi Kadam wrote:
>> Add documentation to support i40e PMD on Windows.
>> Update the release notes and features list for the same.
>>
>> 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>
>
> <...>
>
>> @@ -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://browse.dpdk.org/dpdk-kmods/commit/?id=e28aabd882798f21b94918d4517621ce9e355269>`_.
>
> Is the intention to reference the 'README.rst'? If so better to
> provide link for the documentation, instead of a specific commit, like:
> https://git.dpdk.org/dpdk-kmods/tree/windows/README.rst
Thanks, Ferruh. I'll replace the commit link with the README.rst link in v3.
> And for long term, I guess we need a way to host 'dpdk-kmods' repo
> documentation.
Will discuss this in the community meeting.
@@ -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
@@ -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://browse.dpdk.org/dpdk-kmods/commit/?id=e28aabd882798f21b94918d4517621ce9e355269>`_.
+
Recommended Matching List
-------------------------
@@ -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.