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:
3a78b2f73206 ("doc: add virtio crypto PMD guide")
Fixes:
3cc4d996fa75 ("doc: update VFIO usage in qat crypto guide")
Fixes:
39922c470e3c ("doc: add known uio_pci_generic issue for i40e")
Fixes:
86fa6c57a175 ("doc: add known igb_uio issue for i40e")
Fixes:
beff6d8e8e2e ("net/netvsc: add documentation")
Cc: stable@dpdk.org
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
SEC HW accelerator above 4.x+ version are also known as CAAM.
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).
Linux kernel for configure and destroy the device instance (ring).
-* 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
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
-device virtio-crypto-pci,id=crypto0,cryptodev=cryptodev0
[...]
-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:
For example, 0000:00:04.0 is the domain, bus, device and function
number of the virtio-crypto device:
.. _`UUID`: https://en.wikipedia.org/wiki/Universally_unique_identifier
.. _`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.
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.
* Virtio supports software vlan stripping and inserting.
* 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
-------------
Prerequisites
-------------
- 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:
Please refer to the *DPDK Getting Started Guide* for detailed instructions.
#. Launch the kni user application:
- 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::
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::
------------------------------------------------------------------------------------------
**Description**:
------------------------------------------------------------------------------------------
**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**:
bound to the igb_uio driver.
**Implication**:
-uio pci generic module bind failed in X710/XL710/XXV710
+uio_pci_generic module bind failed in X710/XL710/XXV710
-------------------------------------------------------
**Description**:
-------------------------------------------------------
**Description**:
-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**:
--------------------------------------------------------
**Description**:
handshake sequence with the host.
**Resolution/Workaround**:
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.
**Affected Environment/Platform**:
Linux Hyper-V.
**Reason**:
When device is hot-unplugged, igb_uio driver will be removed which will destroy UIO resources.
**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.
**Resolution/Workaround**:
If using DPDK for PCI HW hot-unplug, prefer to bind device with VFIO instead of IGB_UIO.
~~~~~~~~~~~~~~~~~~~~~~~~
Make sure you have DPDK built inside the guest. Also make sure the
~~~~~~~~~~~~~~~~~~~~~~~~
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
could be done by:
.. code-block:: console