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 50323A0561;
Thu, 18 Mar 2021 12:01:09 +0100 (CET)
Received: from [217.70.189.124] (localhost [127.0.0.1])
by mails.dpdk.org (Postfix) with ESMTP id 28161140E8E;
Thu, 18 Mar 2021 12:01:09 +0100 (CET)
Received: from new1-smtp.messagingengine.com (new1-smtp.messagingengine.com
[66.111.4.221])
by mails.dpdk.org (Postfix) with ESMTP id 4A634140E71;
Thu, 18 Mar 2021 12:01:08 +0100 (CET)
Received: from compute2.internal (compute2.nyi.internal [10.202.2.42])
by mailnew.nyi.internal (Postfix) with ESMTP id 7E14A58187B;
Thu, 18 Mar 2021 07:01:07 -0400 (EDT)
Received: from mailfrontend2 ([10.202.2.163])
by compute2.internal (MEProxy); Thu, 18 Mar 2021 07:01:07 -0400
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h=
from:to:cc:subject:date:message-id:mime-version
:content-transfer-encoding; s=fm3; bh=DkXUEGXm6zLHib4mCEnMN+K7VA
FxO+J8C865K7PuyIk=; b=r/IBo3D6fUUJsZxTafVL8eSfIpt/gOuKyegG5SdQP2
NO+tiRwLZq2U48qeUCECt1tMeQe/KAydM0kvx8UjX0qobTJGsZ3ynYa0X74Lj13B
dsI0T36upvSobHNSi7AWQVM6agsJStx7+d8Vy2uBPUAhQ3/cG2oqeZHYp0ELSGY6
CMsAtQB3Ejm6v2BEmvO49l4rZjToj0sRbMSMEvgPJK2y6/RObv6Xc03tJ22l+z9q
QKhLlIsKBrAGIDu6cDinyj7IFAnA8HUgFjWPZYS8LRU9ZAMxN73/MM7B5HRnwpDn
O53n3CGyScFTmDxJYMkQNSL2gz1U57ZerAtMBoSDEwTQ==
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=
messagingengine.com; h=cc:content-transfer-encoding:date:from
:message-id:mime-version:subject:to:x-me-proxy:x-me-proxy
:x-me-sender:x-me-sender:x-sasl-enc; s=fm2; bh=DkXUEGXm6zLHib4mC
EnMN+K7VAFxO+J8C865K7PuyIk=; b=O+uZmfmFAoXzwQ3xooLhj2eWbUZN3xCw+
no7B9VipROe4lQGuSKrxzbLBPQ+iRYbPcf5BigfH40xNAzLl63KhXcqhdFL6k5gb
28GqNDlINNXAJb66CfH2vcm9msjqnMxjvZBmKLw50yfh9tnccdCbdo+n+q665uQ9
nSN/kGVlGfdz/oXeHpYzWmmzb3d67PxjR7erqKF6neKfYRBnRsnFvQ+YesyNmBYZ
9bBAU5KXnyxTnn1B3T5oDp4Uwn8hf2ymGoX1V9IxarMCaLOiXXQuYN+6WRczPMFN
9dMCuSjxPQNNj7etJr024lA0il+5b18AJpk0uMwmWk9WxK5wMOE4g==
X-ME-Sender: <xms:8jJTYLq2LuzHMLZW9lb8jQ39AjSeiYfqELBCOAgeTO0pHxfYepCSLg>
<xme:8jJTYFoFfY-S8SPexKU-gaJ-MrxTTqAZjPJIrNY0_PEUxAC8fXl_yGYBKSOlZyEcR
k0IRIpYFN67QclA5w>
X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeduledrudefiedgvdefucetufdoteggodetrfdotf
fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen
uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne
cujfgurhephffvufffkffoggfgsedtkeertdertddtnecuhfhrohhmpefvhhhomhgrshcu
ofhonhhjrghlohhnuceothhhohhmrghssehmohhnjhgrlhhonhdrnhgvtheqnecuggftrf
grthhtvghrnhepjedugeffffdvueejtefggefhkeegiedugffhgeefudehkedugfduhfej
keevhfelnecuffhomhgrihhnpeifihhkihhpvgguihgrrdhorhhgnecukfhppeejjedrud
efgedrvddtfedrudekgeenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhepmhgr
ihhlfhhrohhmpehthhhomhgrshesmhhonhhjrghlohhnrdhnvght
X-ME-Proxy: <xmx:8jJTYIN7Yl2_Blf9aeWO9A58Tx0E0nCerDZhjWyavUTuI3fmc-yc5w>
<xmx:8jJTYO60jfkGmY6woiKMcQ0hF93d4gbp25MHjdG44t1urNNs2IUCCg>
<xmx:8jJTYK6hj_2BOer_BRx_qQhBLT-hK3lp9GRwoKvhk1jfPGGmRhZb8w>
<xmx:8zJTYHxgHBSmHRe4i2yJpRMS_btvFvTVifzf0FTamri4vvpI6J5maA>
Received: from xps.monjalon.net (184.203.134.77.rev.sfr.net [77.134.203.184])
by mail.messagingengine.com (Postfix) with ESMTPA id 5C086108005F;
Thu, 18 Mar 2021 07:01:04 -0400 (EDT)
From: Thomas Monjalon <thomas@monjalon.net>
To: dev@dpdk.org
Cc: dmitry.kozliuk@gmail.com, stable@dpdk.org,
Gagandeep Singh <g.singh@nxp.com>, Hemant Agrawal <hemant.agrawal@nxp.com>,
John Griffin <john.griffin@intel.com>, Fiona Trahe <fiona.trahe@intel.com>,
Deepak Kumar Jain <deepak.k.jain@intel.com>,
Jay Zhou <jianjay.zhou@huawei.com>,
Stephen Hemminger <sthemmin@microsoft.com>, Long Li <longli@microsoft.com>,
Maxime Coquelin <maxime.coquelin@redhat.com>,
Chenbo Xia <chenbo.xia@intel.com>, Yong Wang <yongwang@vmware.com>,
Fan Zhang <roy.fan.zhang@intel.com>,
Adam Dybkowski <adamx.dybkowski@intel.com>,
Anatoly Burakov <anatoly.burakov@intel.com>,
Jingjing Wu <jingjing.wu@intel.com>, Jeff Guo <jia.guo@intel.com>,
John McNamara <john.mcnamara@intel.com>,
Qiming Yang <qiming.yang@intel.com>
Date: Thu, 18 Mar 2021 12:00:49 +0100
Message-Id: <20210318110049.2048166-1-thomas@monjalon.net>
X-Mailer: git-send-email 2.30.1
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Subject: [dpdk-dev] [PATCH] doc: fix names of UIO drivers
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>
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>
---
doc/guides/cryptodevs/caam_jr.rst | 2 +-
doc/guides/cryptodevs/qat.rst | 2 +-
doc/guides/cryptodevs/virtio.rst | 2 +-
doc/guides/nics/netvsc.rst | 2 +-
doc/guides/nics/virtio.rst | 5 +++--
doc/guides/nics/vmxnet3.rst | 3 ++-
doc/guides/rel_notes/known_issues.rst | 10 +++++-----
doc/guides/sample_app_ug/vhost.rst | 2 +-
8 files changed, 15 insertions(+), 13 deletions(-)
diff --git a/doc/guides/cryptodevs/caam_jr.rst b/doc/guides/cryptodevs/caam_jr.rst
index 5ef33ae78e..d7b0f14234 100644
--- a/doc/guides/cryptodevs/caam_jr.rst
+++ b/doc/guides/cryptodevs/caam_jr.rst
@@ -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).
diff --git a/doc/guides/cryptodevs/qat.rst b/doc/guides/cryptodevs/qat.rst
index cf16f03503..ea5c03b8fa 100644
--- a/doc/guides/cryptodevs/qat.rst
+++ b/doc/guides/cryptodevs/qat.rst
@@ -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
diff --git a/doc/guides/cryptodevs/virtio.rst b/doc/guides/cryptodevs/virtio.rst
index 83d8e32397..8b96446ff2 100644
--- a/doc/guides/cryptodevs/virtio.rst
+++ b/doc/guides/cryptodevs/virtio.rst
@@ -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:
diff --git a/doc/guides/nics/netvsc.rst b/doc/guides/nics/netvsc.rst
index 19f9940fe6..c0e218c743 100644
--- a/doc/guides/nics/netvsc.rst
+++ b/doc/guides/nics/netvsc.rst
@@ -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.
diff --git a/doc/guides/nics/virtio.rst b/doc/guides/nics/virtio.rst
index 02e74a6e77..ac07d4d1e5 100644
--- a/doc/guides/nics/virtio.rst
+++ b/doc/guides/nics/virtio.rst
@@ -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:
diff --git a/doc/guides/nics/vmxnet3.rst b/doc/guides/nics/vmxnet3.rst
index ae146f0d55..190cf91a47 100644
--- a/doc/guides/nics/vmxnet3.rst
+++ b/doc/guides/nics/vmxnet3.rst
@@ -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::
diff --git a/doc/guides/rel_notes/known_issues.rst b/doc/guides/rel_notes/known_issues.rst
index ee3ed1e658..e8f9fe6023 100644
--- a/doc/guides/rel_notes/known_issues.rst
+++ b/doc/guides/rel_notes/known_issues.rst
@@ -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.
diff --git a/doc/guides/sample_app_ug/vhost.rst b/doc/guides/sample_app_ug/vhost.rst
index 09b1b6c57d..9afde9c7f5 100644
--- a/doc/guides/sample_app_ug/vhost.rst
+++ b/doc/guides/sample_app_ug/vhost.rst
@@ -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
--
2.30.1