doc: add Windows support for mlx5

Windows is supported by mlx5 PMD.
The mlx5 guide is updated with the needed information.

Signed-off-by: Tal Shnaiderman <talshn@nvidia.com>
This commit is contained in:
Tal Shnaiderman 2021-01-03 12:28:27 +02:00 committed by Ferruh Yigit
parent 510893b3dc
commit 5881b2d2d9
5 changed files with 67 additions and 4 deletions

View File

@ -819,6 +819,14 @@ Other kdrv
Kernel module other than above ones supported.
.. _nic_features_windows:
Windows
-------
Support Windows.
.. _nic_features_armv7:
ARMv7

View File

@ -69,6 +69,7 @@ BSD nic_uio =
Linux UIO =
Linux VFIO =
Other kdrv =
Windows =
ARMv7 =
ARMv8 =
Power8 =

View File

@ -45,6 +45,7 @@ FW version = Y
Module EEPROM dump = Y
Multiprocess aware = Y
Other kdrv = Y
Windows = P
ARMv8 = Y
Power8 = Y
x86-32 = Y

View File

@ -102,6 +102,16 @@ Features
Limitations
-----------
- Windows support:
On Windows, the features are limited:
- Promiscuous mode is not supported
- The following rules are supported:
- IPv4/UDP with CVLAN filtering
- Unicast MAC filtering
- For secondary process:
- Forked secondary process not supported.
@ -1013,8 +1023,8 @@ Below are some firmware configurations listed.
FLEX_PARSER_PROFILE_ENABLE=4
PROG_PARSE_GRAPH=1
Prerequisites
-------------
Linux Prerequisites
-------------------
This driver relies on external libraries and kernel drivers for resources
allocations and initialization. The following dependencies are not part of
@ -1127,7 +1137,44 @@ required from that distribution.
Several versions of Mellanox OFED/EN are available. Installing the version
this DPDK release was developed and tested against is strongly
recommended. Please check the `prerequisites`_.
recommended. Please check the `linux prerequisites`_.
Windows Prerequisites
---------------------
This driver relies on external libraries and kernel drivers for resources
allocations and initialization. The dependencies in the following sub-sections
are not part of DPDK, and must be installed separately.
Compilation Prerequisites
~~~~~~~~~~~~~~~~~~~~~~~~~
DevX SDK installation
^^^^^^^^^^^^^^^^^^^^^
The DevX SDK must be installed on the machine building the Windows PMD.
Additional information can be found at
`How to Integrate Windows DevX in Your Development Environment
<https://docs.mellanox.com/display/winof2v250/RShim+Drivers+and+Usage#RShimDriversandUsage-DevXInterface>`__.
Runtime Prerequisites
~~~~~~~~~~~~~~~~~~~~~
WinOF2 version 2.60 or higher must be installed on the machine.
WinOF2 installation
^^^^^^^^^^^^^^^^^^^
The driver can be downloaded from the following site:
`WINOF2
<https://www.mellanox.com/products/adapter-software/ethernet/windows/winof-2>`__
DevX Enablement
^^^^^^^^^^^^^^^
DevX for Windows must be enabled in the Windows registry.
The keys ``DevxEnabled`` and ``DevxFsRules`` must be set.
Additional information can be found in the WinOF2 user manual.
Supported NICs
--------------
@ -1176,7 +1223,7 @@ Below are detailed device names:
Quick Start Guide on OFED/EN
----------------------------
1. Download latest Mellanox OFED/EN. For more info check the `prerequisites`_.
1. Download latest Mellanox OFED/EN. For more info check the `linux prerequisites`_.
2. Install the required libraries and kernel modules either by installing

View File

@ -61,6 +61,12 @@ New Features
* Added support for Stingray2 device.
* **Updated Mellanox mlx5 driver.**
Updated the Mellanox mlx5 driver with new features and improvements, including:
* Introduced basic support on Windows.
Removed Items
-------------