[PATCH] iommu: Documentation: rearrange, update kernel-parameters

[PATCH] iommu: Documentation: rearrange, update kernel-parameters

[Randy Dunlap]

Add text for some undescribed iommu= parameters (merge, nomerge,
biomerge, panic, nopanic, pt, nopt). Add "usedac" and its description.
Add that iommu=pt is equivalent to iommu.passthrough=1
and that iommu=nopt is equivalent to iommu.passthrough=0.

Move the PPC/POWERNV heading & its option "nobypass" to a separate
area since the current "iommu=" applies only to X86 (according to
its heading).

Unindent the AMD GART IOMMU options heading to make it stand out.
Also add its kconfig symbol name to be explicit about what these
options apply to.

Make sure that the IOMMU options that are listed under AMD Gart
HW IOMMU-specific options are only for that product; i.e., add "force"
there and move "merge", "nomerge", and "panic" to the general IOMMU
options area.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
NB: Wording suggestions welcome.

Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Shuah Khan <skhan@linuxfoundation.org>
Cc: linux-doc@vger.kernel.org
Cc: Joerg Roedel <joro@8bytes.org>
Cc: Will Deacon <will@kernel.org>
Cc: Robin Murphy <robin.murphy@arm.com>
Cc: iommu@lists.linux.dev
Cc: Borislav Petkov <bp@alien8.de>

 Documentation/admin-guide/kernel-parameters.txt |   48 +++++++++-----
 1 file changed, 32 insertions(+), 16 deletions(-)

--- linux-next-20260527.orig/Documentation/admin-guide/kernel-parameters.txt
+++ linux-next-20260527/Documentation/admin-guide/kernel-parameters.txt
@@ -2548,23 +2548,41 @@ Kernel parameters
 			Don't force hardware IOMMU usage when it is not
 			needed. (default).
 
+		merge
+			Do scatter-gather (SG) merging. Implies "force"
+			(experimental).
+
+		nomerge
+			Don't do scatter-gather (SG) merging.
+
 		biomerge
+			Do scatter-gather (SG) merging. Implies "force"
+			(experimental). [same as "merge"]
+
 		panic
+			Always panic when IOMMU overflows.
+
 		nopanic
-		merge
-		nomerge
+			Don't panic on IOMMU overflows.
+
+		pt
+			Use passththrough mode by default
+			(Equivalent to iommu.passthrough=1)
+
+		nopt
+			Use translated mode for DMA by default
+			(Equivalent to iommu.passthrough=0)
 
 		soft
 			Use software bounce buffering (SWIOTLB) (default for
 			Intel machines). This can be used to prevent the usage
 			of an available hardware IOMMU.
 
-		pt
-		nopt
-		nobypass	[PPC/POWERNV]
-			Disable IOMMU bypass, using IOMMU for PCI devices.
+		usedac
+			Use the DAC on VIA PCI bridge
+			(default: disable the VIA PCI bridge DAC)
 
-		AMD Gart HW IOMMU-specific options:
+	    AMD Gart HW IOMMU-specific options: (CONFIG_GART_IOMMU)
 
 		<size>
 			Set the size of the remapping area in bytes.
@@ -2572,6 +2590,9 @@ Kernel parameters
 		allowed
 			Overwrite iommu off workarounds for specific chipsets
 
+		force
+			Overwrite iommu off workarounds for specific chipsets
+
 		fullflush
 			Flush IOMMU on each allocation (default).
 
@@ -2582,21 +2603,16 @@ Kernel parameters
 			Allocate an own aperture over RAM with size
 			32MB<<order.  (default: order=1, i.e. 64MB)
 
-		merge
-			Do scatter-gather (SG) merging. Implies "force"
-			(experimental).
-
-		nomerge
-			Don't do scatter-gather (SG) merging.
-
 		noaperture
 			Ask the IOMMU not to touch the aperture for AGP.
 
 		noagp
 			Don't initialize the AGP driver and use full aperture.
 
-		panic
-			Always panic when IOMMU overflows.
+	iommu=		[PPC/POWERNV]
+
+		nobypass
+			Disable IOMMU bypass, using IOMMU for PCI devices.
 
 	iommu.forcedac=	[ARM64,X86,EARLY] Control IOVA allocation for PCI devices.
 			Format: { "0" | "1" }

Re: [PATCH] iommu: Documentation: rearrange, update kernel-parameters

[Jonathan Corbet]

Randy Dunlap <rdunlap@infradead.org> writes:

> Add text for some undescribed iommu= parameters (merge, nomerge,
> biomerge, panic, nopanic, pt, nopt). Add "usedac" and its description.
> Add that iommu=pt is equivalent to iommu.passthrough=1
> and that iommu=nopt is equivalent to iommu.passthrough=0.
>
> Move the PPC/POWERNV heading & its option "nobypass" to a separate
> area since the current "iommu=" applies only to X86 (according to
> its heading).
>
> Unindent the AMD GART IOMMU options heading to make it stand out.
> Also add its kconfig symbol name to be explicit about what these
> options apply to.
>
> Make sure that the IOMMU options that are listed under AMD Gart
> HW IOMMU-specific options are only for that product; i.e., add "force"
> there and move "merge", "nomerge", and "panic" to the general IOMMU
> options area.

Applied, thanks.

jon