]> git.droids-corp.org - dpdk.git/commitdiff
doc: make UIO safety warning more visible in Linux guide
authorBruce Richardson <bruce.richardson@intel.com>
Wed, 16 Mar 2022 13:45:45 +0000 (13:45 +0000)
committerThomas Monjalon <thomas@monjalon.net>
Wed, 16 Mar 2022 17:39:26 +0000 (18:39 +0100)
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 <bruce.richardson@intel.com>
doc/guides/linux_gsg/linux_drivers.rst

index bd983b4d81787493f3ea778c256fa3ea4bb77074..f0a274df6a892d29d7482a3abdc3841dda79c5e0 100644 (file)
@@ -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