d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: fix names of UIO drivers

Browse Source 
Fix typos in the names of kernel drivers based on UIO,
and make sure the generic term for the interface is UIO in capitals.

Fixes: 3a78b2f732 ("doc: add virtio crypto PMD guide")
Fixes: 3cc4d996fa ("doc: update VFIO usage in qat crypto guide")
Fixes: 39922c470e ("doc: add known uio_pci_generic issue for i40e")
Fixes: 86fa6c57a1 ("doc: add known igb_uio issue for i40e")
Fixes: beff6d8e8e ("net/netvsc: add documentation")
Cc: stable@dpdk.org

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
This commit is contained in:
Thomas Monjalon 2021-03-18 12:00:49 +01:00
parent b5674be414
commit b7fe612ac1
8 changed files with 15 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/guides/cryptodevs/caam_jr.rst
View File

@ -24,7 +24,7 @@ accelerators. This provides significant improvement to system level performance.
SEC HW accelerator above 4.x+ version are also known as CAAM.
caam_jr PMD is one of DPAA drivers which uses uio interface to interact with
caam_jr PMD is one of DPAA drivers which uses UIO interface to interact with
Linux kernel for configure and destroy the device instance (ring).

2
doc/guides/cryptodevs/qat.rst
View File

@ -562,7 +562,7 @@ Binding the available VFs to the vfio-pci driver
Note:
* Please note that due to security issues, the usage of older DPDK igb-uio
* Please note that due to security issues, the usage of older DPDK igb_uio
driver is not recommended. This document shows how to use the more secure
vfio-pci driver.
* If QAT fails to bind to vfio-pci on Linux kernel 5.9+, please see the

2
doc/guides/cryptodevs/virtio.rst
View File

@ -63,7 +63,7 @@ QEMU can then be started using the following parameters:
-device virtio-crypto-pci,id=crypto0,cryptodev=cryptodev0
[...]
Secondly bind the uio_generic driver for the virtio-crypto device.
Secondly bind the uio_pci_generic driver for the virtio-crypto device.
For example, 0000:00:04.0 is the domain, bus, device and function
number of the virtio-crypto device:

2
doc/guides/nics/netvsc.rst
View File

@ -62,7 +62,7 @@ store it in a shell variable:
.. _`UUID`: https://en.wikipedia.org/wiki/Universally_unique_identifier
There are several possible ways to assign the uio device driver for a device.
There are several possible ways to assign the UIO device driver for a device.
The easiest way (but only on 4.18 or later)
is to use the `driverctl Device Driver control utility`_ to override
the normal kernel device.

5
doc/guides/nics/virtio.rst
View File

@ -71,7 +71,7 @@ In this release, the virtio PMD driver provides the basic functionality of packe
* Virtio supports software vlan stripping and inserting.
* Virtio supports using port IO to get PCI resource when uio/igb_uio module is not available.
* Virtio supports using port IO to get PCI resource when UIO module is not available.
Prerequisites
-------------
@ -103,7 +103,8 @@ Host2VM communication example
insmod rte_kni.ko
Other basic DPDK preparations like hugepage enabling, uio port binding are not listed here.
Other basic DPDK preparations like hugepage enabling,
UIO port binding are not listed here.
Please refer to the *DPDK Getting Started Guide* for detailed instructions.
#. Launch the kni user application:

3
doc/guides/nics/vmxnet3.rst
View File

@ -119,7 +119,8 @@ This section describes an example setup for Phy-vSwitch-VM-Phy communication.
.. note::
Other instructions on preparing to use DPDK such as, hugepage enabling, uio port binding are not listed here.
Other instructions on preparing to use DPDK such as,
hugepage enabling, UIO port binding are not listed here.
Please refer to *DPDK Getting Started Guide and DPDK Sample Application's User Guide* for detailed instructions.
The packet reception and transmission flow path is::

10
doc/guides/rel_notes/known_issues.rst
View File

@ -419,7 +419,7 @@ Binding PCI devices to igb_uio fails on Linux kernel 3.9 when more than one devi
------------------------------------------------------------------------------------------
**Description**:
A known bug in the uio driver included in Linux kernel version 3.9 prevents more than one PCI device to be
A known bug in the UIO driver included in Linux kernel version 3.9 prevents more than one PCI device to be
bound to the igb_uio driver.
**Implication**:
@ -614,7 +614,7 @@ I40e VF may not receive packets in the promiscuous mode
Poll Mode Driver (PMD).
uio pci generic module bind failed in X710/XL710/XXV710
uio_pci_generic module bind failed in X710/XL710/XXV710
-------------------------------------------------------
**Description**:
@ -671,7 +671,7 @@ virtio tx_burst() function cannot do TSO on shared packets
Poll Mode Driver (PMD).
igb uio legacy mode can not be used in X710/XL710/XXV710
igb_uio legacy mode can not be used in X710/XL710/XXV710
--------------------------------------------------------
**Description**:
@ -752,7 +752,7 @@ Netvsc driver and application restart
handshake sequence with the host.
**Resolution/Workaround**:
Either reboot the guest or remove and reinsert the hv_uio_generic module.
Either reboot the guest or remove and reinsert the uio_hv_generic module.
**Affected Environment/Platform**:
Linux Hyper-V.
@ -816,7 +816,7 @@ Kernel crash when hot-unplug igb_uio device while DPDK application is running
**Reason**:
When device is hot-unplugged, igb_uio driver will be removed which will destroy UIO resources.
Later trying to access any uio resource will cause kernel crash.
Later trying to access any UIO resource will cause kernel crash.
**Resolution/Workaround**:
If using DPDK for PCI HW hot-unplug, prefer to bind device with VFIO instead of IGB_UIO.

2
doc/guides/sample_app_ug/vhost.rst
View File

@ -72,7 +72,7 @@ Run testpmd inside guest
~~~~~~~~~~~~~~~~~~~~~~~~
Make sure you have DPDK built inside the guest. Also make sure the
corresponding virtio-net PCI device is bond to a uio driver, which
corresponding virtio-net PCI device is bond to a UIO driver, which
could be done by:
.. code-block:: console