Skip to content

Commit

Permalink
doc: fix names of UIO drivers
Browse files Browse the repository at this point in the history
[ upstream commit b7fe612 ]

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: 3a78b2f ("doc: add virtio crypto PMD guide")
Fixes: 3cc4d99 ("doc: update VFIO usage in qat crypto guide")
Fixes: 39922c4 ("doc: add known uio_pci_generic issue for i40e")
Fixes: 86fa6c5 ("doc: add known igb_uio issue for i40e")
Fixes: beff6d8 ("net/netvsc: add documentation")

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
  • Loading branch information
tmonjalo authored and steevenlee committed May 8, 2021
1 parent 7d3e01e commit 20bbce0
Show file tree
Hide file tree
Showing 8 changed files with 15 additions and 13 deletions.
2 changes: 1 addition & 1 deletion doc/guides/cryptodevs/caam_jr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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).


Expand Down
2 changes: 1 addition & 1 deletion doc/guides/cryptodevs/qat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/guides/cryptodevs/virtio.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion doc/guides/nics/netvsc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
5 changes: 3 additions & 2 deletions doc/guides/nics/virtio.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
-------------
Expand Down Expand Up @@ -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:
Expand Down
3 changes: 2 additions & 1 deletion doc/guides/nics/vmxnet3.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down
10 changes: 5 additions & 5 deletions doc/guides/rel_notes/known_issues.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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**:
Expand Down Expand Up @@ -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**:
Expand Down Expand Up @@ -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**:
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion doc/guides/sample_app_ug/vhost.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 20bbce0

Please sign in to comment.