From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
by inbox.dpdk.org (Postfix) with ESMTP id 9A6FAA0C47;
Fri, 8 Oct 2021 23:12:04 +0200 (CEST)
Received: from [217.70.189.124] (localhost [127.0.0.1])
by mails.dpdk.org (Postfix) with ESMTP id 8C600410E0;
Fri, 8 Oct 2021 23:12:04 +0200 (CEST)
Received: from mail-lf1-f46.google.com (mail-lf1-f46.google.com
[209.85.167.46]) by mails.dpdk.org (Postfix) with ESMTP id 89C60410E0
for <dev@dpdk.org>; Fri, 8 Oct 2021 23:12:03 +0200 (CEST)
Received: by mail-lf1-f46.google.com with SMTP id j21so26421755lfe.0
for <dev@dpdk.org>; Fri, 08 Oct 2021 14:12:03 -0700 (PDT)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112;
h=from:to:cc:subject:date:message-id:mime-version
:content-transfer-encoding;
bh=l8e0OXfEh1T+sw0C00lZXjlSweHqz/CVyzZUM0ZGFdU=;
b=Y1gqt8Hq0KCrvzLnMYhzY4IyWEb3eLbTXjaDmv5PUFDHfron2XYiMsXICq6cXIkzvn
lqzLOEdsXT0tKNyaAXE2ggowhpTSsy051+AINsn/iwSvK4PIf6gLOnBN3ZBnEgUTfsGN
ZkMkqQ6fMaBRLb8RMkZor7ybfbFjsMozDYgEnbKB7sSb2aaAeFHH3nbduzazOcsNI8QD
GTtczFjiAgQTfonC6lKqQuYZGaLLXPvWkJmChC+Ntkgn7t9LhQKAOVIcGUUKM1kOVjeU
fZqRBaHJTzpTbDWM+mW83Q1LS/8DEWIscPU/ToiYIG6P0pOu4ix5way94Ll90KR7V8gt
mg8Q==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
d=1e100.net; s=20210112;
h=x-gm-message-state:from:to:cc:subject:date:message-id:mime-version
:content-transfer-encoding;
bh=l8e0OXfEh1T+sw0C00lZXjlSweHqz/CVyzZUM0ZGFdU=;
b=FO2JzHTjz46SxnoBH+U0tDckoSII7yhyfILk56GSMnvQXvB8sDtOSqmhId1rx2w91r
32MbVZPXxrXeevJ9j9f1ZbJIuNZblISd97ansAhwt8Xrwu5gjCERpszRn/xWyStt4846
2sAAqOsUwFyWGjw8CSWrkjgBZ9hLQ17IP9/mN3zVMn9U5hmozNb9TjQ4Co8P/3O4Bejo
QFvI7ydcNNSh3Nj+I0xqRfOFrxMUqpP/GIpF5ciXWHlubslKFGDHCKyMGbwR5N+zH1Wa
3QsMP521CN/Fjqe3ur4BzRNmtPHt9s+ylreU/DinAJfCrN88WfgdtFtVHD7M6r3N22+9
XqKw==
X-Gm-Message-State: AOAM531bn0bzIJqy6EynbNAtayrW3bwUgkm0AbLo1OOOFV8L20NHUy8s
cwtHbVgAWNX5NEoRqE27L/ONKUkc6fs=
X-Google-Smtp-Source: ABdhPJz+gd5aTa3Fgxq6d6Nb1vmMTZB5iDgocZB8CO8jSdt257uHlMonr0LivzZA6DjLkU8AWCXzwg==
X-Received: by 2002:a05:651c:544:: with SMTP id
q4mr5874429ljp.320.1633727522932;
Fri, 08 Oct 2021 14:12:02 -0700 (PDT)
Received: from sovereign.. (broadband-37-110-65-23.ip.moscow.rt.ru.
[37.110.65.23])
by smtp.gmail.com with ESMTPSA id z20sm33620lfh.306.2021.10.08.14.12.02
(version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);
Fri, 08 Oct 2021 14:12:02 -0700 (PDT)
From: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>
To: dev@dpdk.org
Cc: William Tu <u9012063@gmail.com>, Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>,
Narcisa Ana Maria Vasile <navasile@linux.microsoft.com>,
Dmitry Malloy <dmitrym@microsoft.com>,
Pallavi Kadam <pallavi.kadam@intel.com>
Date: Sat, 9 Oct 2021 00:11:54 +0300
Message-Id: <20211008211154.349793-1-dmitry.kozliuk@gmail.com>
X-Mailer: git-send-email 2.29.3
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Subject: [dpdk-dev] [PATCH] doc/windows_gsg: update section on driver
installation
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>
Windows GSG included a section only on virt2phys driver installation,
but not on NetUIO. The content of the section duplicated documentation
in dpdk-kmods, but contained no links to it, only a reference.
Add subsections for virt2phys and NetUIO, explaining their roles.
Refer to documenttion in dpdk-kmods as an authoritative source,
but leave specific diagnostic and usage hints in the GSG.
Signed-off-by: Dmitry Kozlyuk <dmitry.kozliuk@gmail.com>
---
doc/guides/windows_gsg/run_apps.rst | 48 ++++++++++++++---------------
1 file changed, 23 insertions(+), 25 deletions(-)
diff --git a/doc/guides/windows_gsg/run_apps.rst b/doc/guides/windows_gsg/run_apps.rst
index abaecc3793..70bb1da33f 100644
--- a/doc/guides/windows_gsg/run_apps.rst
+++ b/doc/guides/windows_gsg/run_apps.rst
@@ -27,40 +27,27 @@ See `Large-Page Support`_ in MSDN for details.
.. _Large-Page Support: https://docs.microsoft.com/en-us/windows/win32/memory/large-page-support
-Load virt2phys Driver
----------------------
+Install Drivers
+---------------
-Access to physical addresses is provided by a kernel-mode driver, virt2phys.
-It is mandatory at least for using hardware PMDs, but may also be required
-for mempools.
-
-Refer to documentation in ``dpdk-kmods`` repository for details on system
-setup, driver build and installation. This driver is not signed, so signature
-checking must be disabled to load it.
+Certain kernel-mode drivers are required to run DPDK applications.
+Refer to `Windows documentation <https://git.dpdk.org/dpdk-kmods/tree/windows>`_
+in ``dpdk-kmods`` repository for common instructions on system setup,
+driver build and installation. The drivers are not signed, so signature
+enforcement has to be disabled.
.. warning::
Disabling driver signature enforcement weakens OS security.
It is discouraged in production environments.
-Compiled package consists of ``virt2phys.inf``, ``virt2phys.cat``,
-and ``virt2phys.sys``. It can be installed as follows
-from Elevated Command Prompt:
-
-.. code-block:: console
-
- pnputil /add-driver Z:\path\to\virt2phys.inf /install
-On Windows Server additional steps are required:
+virt2phys
+~~~~~~~~~
-1. From Device Manager, Action menu, select "Add legacy hardware".
-2. It will launch the "Add Hardware Wizard". Click "Next".
-3. Select second option "Install the hardware that I manually select
- from a list (Advanced)".
-4. On the next screen, "Kernel bypass" will be shown as a device class.
-5. Select it, and click "Next".
-6. The previously installed drivers will now be installed for the
- "Virtual to physical address translator" device.
+Access to physical addresses is provided by a kernel-mode driver, virt2phys.
+It is mandatory for allocating physically-contiguous memory which is required
+by hardware PMDs.
When loaded successfully, the driver is shown in *Device Manager* as *Virtual
to physical address translator* device under *Kernel bypass* category.
@@ -74,6 +61,17 @@ on initialization (debug-level logs provide more details):
EAL: Cannot open virt2phys driver interface
+NetUIO
+~~~~~~
+
+NetUIO kernel-mode driver provides access to the device hardware resources.
+It is mandatory for all hardware PMDs, except for MLX5 PMD.
+
+Refer to `NetUIO documentation <https://git.dpdk.org/dpdk-kmods/tree/windows/netuio/README.rst>`_
+in ``dpdk-kmods`` repository for instructions to build and set up the driver.
+Devices supported by NetUIO are listed in ``netuio.inf``.
+The list can be extended in order to try running DPDK with new devices.
+
Run the ``helloworld`` Example
------------------------------
--
2.29.3