From e0ae3db0c043cbdc4cc22bb60206f21ec4a82a02 Mon Sep 17 00:00:00 2001 From: Dmitry Kozlyuk Date: Sat, 9 Oct 2021 00:11:54 +0300 Subject: [PATCH] doc: update driver installation in Windows guide 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 --- 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..08f110d0b5 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 `_ +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 `_ +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.20.1