[v2,8/8] doc/linux_gsg: remove section on IOMMU pass-through

Message ID 20220310123843.612207-9-bruce.richardson@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series Linux GSG doc updates |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS

Commit Message

Bruce Richardson March 10, 2022, 12:38 p.m. UTC
  The "Linux Drivers" section of the GSG already notes that, for use of
UIO, the IOMMU must be disabled or put into pass-through mode.
Therefore, there is no need to duplicate this information in the
"additional functionality" section.  Also the kernel configuration
options documented in the section are enabled as standard on all common
distro kernels, so the information should not be needed in a GSG doc.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/guides/linux_gsg/enable_func.rst   | 19 -------------------
 doc/guides/linux_gsg/linux_drivers.rst |  2 +-
 2 files changed, 1 insertion(+), 20 deletions(-)
  

Patch

diff --git a/doc/guides/linux_gsg/enable_func.rst b/doc/guides/linux_gsg/enable_func.rst
index 1f19842ddc..338c33290b 100644
--- a/doc/guides/linux_gsg/enable_func.rst
+++ b/doc/guides/linux_gsg/enable_func.rst
@@ -127,22 +127,3 @@  it is recommended that the ``rte_get_timer_cycles()`` and ``rte_get_timer_hz()``
 These generic APIs can work with either TSC or HPET time sources,
 depending on what is requested by an application call to ``rte_eal_hpet_init()``,
 if any, and on what is available on the system at runtime.
-
-Using Linux IOMMU Pass-Through to Run DPDK with Intel\ |reg| VT-d
-------------------------------------------------------------------
-
-To enable Intel\ |reg| VT-d in a Linux kernel, a number of kernel configuration options must be set. These include:
-
-*   ``IOMMU_SUPPORT``
-
-*   ``IOMMU_API``
-
-*   ``INTEL_IOMMU``
-
-In addition, to run the DPDK with Intel\ |reg| VT-d, the ``iommu=pt`` kernel parameter must be used when using ``igb_uio`` driver.
-This results in pass-through of the DMAR (DMA Remapping) lookup in the host.
-Also, if ``INTEL_IOMMU_DEFAULT_ON`` is not set in the kernel, the ``intel_iommu=on`` kernel parameter must be used too.
-This ensures that the Intel IOMMU is being initialized as expected.
-
-Please note that while using ``iommu=pt`` is compulsory for ``igb_uio`` driver,
-the ``vfio-pci`` driver can actually work with both ``iommu=pt`` and ``iommu=on``.
diff --git a/doc/guides/linux_gsg/linux_drivers.rst b/doc/guides/linux_gsg/linux_drivers.rst
index 03cf264a0a..2e4c80ebd3 100644
--- a/doc/guides/linux_gsg/linux_drivers.rst
+++ b/doc/guides/linux_gsg/linux_drivers.rst
@@ -367,7 +367,7 @@  It can be loaded as shown below:
 
 .. note::
 
-   If the devices used for DPDK are bound to the ``uio_pci_generic`` kernel module,
+   If the devices used for DPDK are bound to a UIO-based kernel module,
    please make sure that the IOMMU is disabled or is in passthrough mode.
    One can add ``intel_iommu=off`` or ``amd_iommu=off`` or ``intel_iommu=on iommu=pt``
    in GRUB command line on x86_64 systems,