From: Akihiko Odaki <akihiko.odaki@daynix.com>
Date: Sun, 15 Sep 2024 01:36:58 +0000 (+0900)
Subject: Documentation: Fix pci=config_acs= example
X-Git-Tag: v6.14-rc1~90^2^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b388face5f169e7a41c1b5e1cdd20515160a83b3;p=thirdparty%2Fkernel%2Fstable.git

Documentation: Fix pci=config_acs= example

The documentation currently says:

  config_acs=
                  Format:
                  <ACS flags>@<pci_dev>[; ...]
                  Specify one or more PCI devices (in the format
                  specified above) optionally prepended with flags
                  and separated by semicolons. The respective
                  capabilities will be enabled, disabled or
                  unchanged based on what is specified in
                  flags.
           (...)
                  For example,
                    pci=config_acs=10x
                  would configure all devices that support
                  ACS to enable P2P Request Redirect, disable
                  Translation Blocking, and leave Source
                  Validation unchanged from whatever power-up
                  or firmware set it to.

See the complete documentation at:

  https://www.kernel.org/doc/html/latest/admin-guide/kernel-parameters.html

However, a flag specification always needs to be suffixed with "@" and
a PCI valid device address, which is missing in this example. Also, to
configure all devices that support ACS, the flag needs to be suffixed
with "@pci:0:0", for the ACS support to be enabled.

Fix the documentation so the example is correct.

Link: https://lore.kernel.org/r/20240915-acs-v1-1-b9ee536ee9bd@daynix.com
Signed-off-by: Akihiko Odaki <akihiko.odaki@daynix.com>
[kwilczynski: commit log]
Signed-off-by: Krzysztof Wilczyński <kwilczynski@kernel.org>
Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
---

diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
index dc663c0ca6706..b1350b66cc4fa 100644
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -4673,7 +4673,7 @@
 				  '1' – force enabled
 				  'x' – unchanged
 				For example,
-				  pci=config_acs=10x
+				  pci=config_acs=10x@pci:0:0
 				would configure all devices that support
 				ACS to enable P2P Request Redirect, disable
 				Translation Blocking, and leave Source