From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (xvm-189-124.dc0.ghst.net [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 8CD1DA09E4; Sun, 3 Jan 2021 11:28:50 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 14FF3160693; Sun, 3 Jan 2021 11:28:50 +0100 (CET) Received: from mellanox.co.il (mail-il-dmz.mellanox.com [193.47.165.129]) by mails.dpdk.org (Postfix) with ESMTP id 2387B160690 for ; Sun, 3 Jan 2021 11:28:49 +0100 (CET) Received: from Internal Mail-Server by MTLPINE1 (envelope-from talshn@nvidia.com) with SMTP; 3 Jan 2021 12:28:44 +0200 Received: from nvidia.com (l-wincomp04-vm.mtl.labs.mlnx [10.237.1.5]) by labmailer.mlnx (8.13.8/8.13.8) with ESMTP id 103ASi56026063; Sun, 3 Jan 2021 12:28:44 +0200 From: Tal Shnaiderman To: dev@dpdk.org Cc: thomas@monjalon.net, matan@nvidia.com, rasland@nvidia.com, ophirmu@nvidia.com Date: Sun, 3 Jan 2021 12:28:27 +0200 Message-Id: <20210103102827.7436-1-talshn@nvidia.com> X-Mailer: git-send-email 2.16.1.windows.4 Subject: [dpdk-dev] [PATCH] doc: update Windows support in mlx5 guide X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Windows will be supported by mlx5 PMD. The mlx5 guide is updated with the needed information. Signed-off-by: Tal Shnaiderman --- Depends-on: patch-85939 ("drivers/common: enable Windows common mlx5 compilation") --- doc/guides/nics/mlx5.rst | 54 ++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 50 insertions(+), 4 deletions(-) diff --git a/doc/guides/nics/mlx5.rst b/doc/guides/nics/mlx5.rst index 3bda0f8417..fc33c00449 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. @@ -1031,8 +1041,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 @@ -1145,7 +1155,43 @@ 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 the `How to Integrate Windows DevX in Your Development Environment +`__ section. + +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 -------------- @@ -1194,7 +1240,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 -- 2.16.1.windows.4