From 5881b2d2d904b4e35cb7f7d27bb8431a8bd906f8 Mon Sep 17 00:00:00 2001 From: Tal Shnaiderman Date: Sun, 3 Jan 2021 12:28:27 +0200 Subject: [PATCH] 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 --- doc/guides/nics/features.rst | 8 ++++ doc/guides/nics/features/default.ini | 1 + doc/guides/nics/features/mlx5.ini | 1 + doc/guides/nics/mlx5.rst | 55 ++++++++++++++++++++++++-- doc/guides/rel_notes/release_21_02.rst | 6 +++ 5 files changed, 67 insertions(+), 4 deletions(-) diff --git a/doc/guides/nics/features.rst b/doc/guides/nics/features.rst index 43f74e02ab..cf82e9d57f 100644 --- a/doc/guides/nics/features.rst +++ b/doc/guides/nics/features.rst @@ -819,6 +819,14 @@ Other kdrv Kernel module other than above ones supported. +.. _nic_features_windows: + +Windows +------- + +Support Windows. + + .. _nic_features_armv7: ARMv7 diff --git a/doc/guides/nics/features/default.ini b/doc/guides/nics/features/default.ini index 4d0ad324ea..ee786d3d9a 100644 --- a/doc/guides/nics/features/default.ini +++ b/doc/guides/nics/features/default.ini @@ -69,6 +69,7 @@ BSD nic_uio = Linux UIO = Linux VFIO = Other kdrv = +Windows = ARMv7 = ARMv8 = Power8 = diff --git a/doc/guides/nics/features/mlx5.ini b/doc/guides/nics/features/mlx5.ini index 54ec95db7f..9d14678b1e 100644 --- a/doc/guides/nics/features/mlx5.ini +++ b/doc/guides/nics/features/mlx5.ini @@ -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 diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index 6950cc1188..efa3e8b84c 100644 --- a/doc/guides/nics/mlx5.rst +++ b/doc/guides/nics/mlx5.rst @@ -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 +`__. + +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 +`__ + +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 diff --git a/doc/guides/rel_notes/release_21_02.rst b/doc/guides/rel_notes/release_21_02.rst index b1bb2d8679..c64294e7a6 100644 --- a/doc/guides/rel_notes/release_21_02.rst +++ b/doc/guides/rel_notes/release_21_02.rst @@ -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 ------------- -- 2.20.1