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 6ED84A0032;
Wed, 16 Mar 2022 14:46:24 +0100 (CET)
Received: from [217.70.189.124] (localhost [127.0.0.1])
by mails.dpdk.org (Postfix) with ESMTP id 5E8764115F;
Wed, 16 Mar 2022 14:46:09 +0100 (CET)
Received: from mga14.intel.com (mga14.intel.com [192.55.52.115])
by mails.dpdk.org (Postfix) with ESMTP id 98802410EC;
Wed, 16 Mar 2022 14:46:05 +0100 (CET)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple;
d=intel.com; i=@intel.com; q=dns/txt; s=Intel;
t=1647438365; x=1678974365;
h=from:to:cc:subject:date:message-id:in-reply-to:
references:mime-version:content-transfer-encoding;
bh=I0SywmE4kawcto0DjwgmPxfnu/HH9iE033uSzVrxRI8=;
b=G/AqMW4tfB2IAhZXHjwrXm/TARV/5hEVvlaai5Iiu1DJ3ZU+ek58xYMf
++9GfkRl4xjH/thrFZZKZKL/oeMUBbIaYEA7A5V+NR3ueuAGkfZVjJhQk
zpgTCD2qZKc++td1wgPdiuT9hlqTFBDp0jLKqAeG98POxPaVDk6KBs9cp
8a1s30kTyJkVs9UKj/dDF7ubE64FgXkSBXTb0I1SmpoH70tddvpXFnoSU
g9urC9DF3G9iQ1iES+QghShz9KS15NoRoSh/N8co1ae0u9qHaZ+sFxUEe
nVnxxew8D863A9MHxSCrpWN0idku2oPkdsePjS6R5+hvxLhFhmsN1J9Kb w==;
X-IronPort-AV: E=McAfee;i="6200,9189,10286"; a="256780555"
X-IronPort-AV: E=Sophos;i="5.90,186,1643702400"; d="scan'208";a="256780555"
Received: from orsmga005.jf.intel.com ([10.7.209.41])
by fmsmga103.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;
16 Mar 2022 06:46:04 -0700
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.90,186,1643702400"; d="scan'208";a="714606485"
Received: from silpixa00399126.ir.intel.com ([10.237.223.34])
by orsmga005.jf.intel.com with ESMTP; 16 Mar 2022 06:46:03 -0700
From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Cc: Bruce Richardson <bruce.richardson@intel.com>,
stable@dpdk.org
Subject: [PATCH v2 3/9] doc: make UIO safety warning more visible in Linux GSG
Date: Wed, 16 Mar 2022 13:45:45 +0000
Message-Id: <20220316134551.1099599-4-bruce.richardson@intel.com>
X-Mailer: git-send-email 2.32.0
In-Reply-To: <20220316134551.1099599-1-bruce.richardson@intel.com>
References: <20220302172217.472279-1-bruce.richardson@intel.com>
<20220316134551.1099599-1-bruce.richardson@intel.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
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
The GSG has a note warning that use of UIO is inherently unsafe due to
lack of IOMMU protection. However, this was only flagged as a "NOTE",
meaning it could easily be missed. Changing the rst tag from "note" to
"warning" and moving it to the top of the UIO subsection makes this a
lot more visible to users.
Cc: stable@dpdk.org
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
doc/guides/linux_gsg/linux_drivers.rst | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/doc/guides/linux_gsg/linux_drivers.rst b/doc/guides/linux_gsg/linux_drivers.rst
index bd983b4d81..f0a274df6a 100644
--- a/doc/guides/linux_gsg/linux_drivers.rst
+++ b/doc/guides/linux_gsg/linux_drivers.rst
@@ -153,6 +153,11 @@ After that, VFIO can be used with hardware devices as usual.
UIO
---
+.. warning::
+
+ Using UIO drivers is inherently unsafe due to this method lacking IOMMU protection,
+ and can only be done by root user.
+
In situations where using VFIO is not an option, there are alternative drivers one can use.
In many cases, the standard ``uio_pci_generic`` module included in the Linux kernel
can be used as a substitute for VFIO. This module can be loaded using the command:
@@ -195,11 +200,6 @@ It can be loaded as shown below:
in GRUB command line on x86_64 systems,
or add ``iommu.passthrough=1`` on aarch64 systems.
-.. note::
-
- Using UIO drivers is inherently unsafe due to this method lacking IOMMU protection,
- and can only be done by root user.
-
.. _bifurcated_driver:
Bifurcated Driver
--
2.32.0