From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 46E38A04A4 for ; Wed, 2 Mar 2022 18:24:15 +0100 (CET) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 26DAC42752; Wed, 2 Mar 2022 18:24:15 +0100 (CET) Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by mails.dpdk.org (Postfix) with ESMTP id 625E742758; Wed, 2 Mar 2022 18:24:12 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1646241852; x=1677777852; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=W/WXqetrPzHPU1i0W4z6TE+FVsvpRPyPTwocyJ//w7U=; b=XxzHfB5PLv3HdhtF8OI02Wiw4YDdFu68k+qcV1i/O4vY/lu20kIH9FW+ zMIfzXnXU5ofXUxdcE6kQse16iv2X/n+1qcSb550QYBZ3swmEFMJxKEmt 2UVzvOaj7Aak7tveGeWQVFlfpEK9E48Z9N9Str6vkNxrJEyRkGBBs1BSH f7CDr0LhflzsRE0XlDzYG7petaZa4iYwjF9FcL1ZktvU3Xat9FLXIHgLU a8uGyenyxZTSviHjxP/gcB5QfZbVTgSSrNEMgBxdibryk1Sk0TivfHOii ZN3lMA1uQdc1zf+z66YAZW8RsLL/jZATXnIIo+IfyXi4+nAXHUBzK0gP4 w==; X-IronPort-AV: E=McAfee;i="6200,9189,10274"; a="253651976" X-IronPort-AV: E=Sophos;i="5.90,149,1643702400"; d="scan'208";a="253651976" Received: from orsmga008.jf.intel.com ([10.7.209.65]) by fmsmga103.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 02 Mar 2022 09:24:11 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.90,149,1643702400"; d="scan'208";a="551348118" Received: from silpixa00399126.ir.intel.com ([10.237.223.34]) by orsmga008.jf.intel.com with ESMTP; 02 Mar 2022 09:24:10 -0800 From: Bruce Richardson To: dev@dpdk.org Cc: stable@dpdk.org, Bruce Richardson Subject: [PATCH 3/9] doc/linux_gsg: make UIO safety warning more visible Date: Wed, 2 Mar 2022 17:22:11 +0000 Message-Id: <20220302172217.472279-4-bruce.richardson@intel.com> X-Mailer: git-send-email 2.32.0 In-Reply-To: <20220302172217.472279-1-bruce.richardson@intel.com> References: <20220302172217.472279-1-bruce.richardson@intel.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: stable@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: patches for DPDK stable branches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: stable-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. Signed-off-by: Bruce Richardson --- 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 75af2f01e1..2cdacf0961 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