[v3] x86: Kconfig cleanups and help text improvements

[PATCH v3 5/7] x86/Kconfig: Document CONFIG_PCI_MMCONFIG

Posted by David Heidelberg via B4 Relay 10 months, 3 weeks ago

From: Mateusz Jończyk <mat.jonczyk@o2.pl>

This configuration option had no help text, so add it.

CONFIG_EXPERT is enabled on some distribution kernels, so people using a
distribution kernel's configuration as a starting point will see this
option.

Signed-off-by: Mateusz Jończyk <mat.jonczyk@o2.pl>
Signed-off-by: David Heideberg <david@ixit.cz>
---
 arch/x86/Kconfig | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/arch/x86/Kconfig b/arch/x86/Kconfig
index fbc9ba30fd1cbfb574399a0632b9f77876ba84a8..64a1e00619df95f559488e3004558a7b0f653df3 100644
--- a/arch/x86/Kconfig
+++ b/arch/x86/Kconfig
@@ -2914,6 +2914,19 @@ config PCI_MMCONFIG
 	default y
 	depends on PCI && (ACPI || JAILHOUSE_GUEST)
 	depends on X86_64 || (PCI_GOANY || PCI_GOMMCONFIG)
+	help
+	  Add support for accessing the PCI configuration space as a memory
+	  mapped area. It is the recommended method if the system supports
+	  this (it must have PCI Express and ACPI for it to be available).
+
+	  In the unlikely case that enabling this configuration option causes
+	  problems, the mechanism can be switched off with the 'pci=nommconf'
+	  command line parameter.
+
+	  Say 'n' only if you are sure that your platform does not support this
+	  access method or you have problems caused by it.
+
+	  Say 'y' otherwise.
 
 config PCI_OLPC
 	def_bool y

-- 
2.49.0

Re: [PATCH v3 5/7] x86/Kconfig: Document CONFIG_PCI_MMCONFIG

Posted by Ingo Molnar 10 months, 3 weeks ago

* David Heidelberg via B4 Relay <devnull+david.ixit.cz@kernel.org> wrote:

> From: Mateusz Jończyk <mat.jonczyk@o2.pl>
> 
> This configuration option had no help text, so add it.
> 
> CONFIG_EXPERT is enabled on some distribution kernels, so people using a
> distribution kernel's configuration as a starting point will see this
> option.
> 
> Signed-off-by: Mateusz Jończyk <mat.jonczyk@o2.pl>
> Signed-off-by: David Heideberg <david@ixit.cz>
> ---
>  arch/x86/Kconfig | 13 +++++++++++++
>  1 file changed, 13 insertions(+)
> 
> diff --git a/arch/x86/Kconfig b/arch/x86/Kconfig
> index fbc9ba30fd1cbfb574399a0632b9f77876ba84a8..64a1e00619df95f559488e3004558a7b0f653df3 100644
> --- a/arch/x86/Kconfig
> +++ b/arch/x86/Kconfig
> @@ -2914,6 +2914,19 @@ config PCI_MMCONFIG
>  	default y
>  	depends on PCI && (ACPI || JAILHOUSE_GUEST)
>  	depends on X86_64 || (PCI_GOANY || PCI_GOMMCONFIG)
> +	help
> +	  Add support for accessing the PCI configuration space as a memory
> +	  mapped area. It is the recommended method if the system supports
> +	  this (it must have PCI Express and ACPI for it to be available).
> +
> +	  In the unlikely case that enabling this configuration option causes
> +	  problems, the mechanism can be switched off with the 'pci=nommconf'
> +	  command line parameter.
> +
> +	  Say 'n' only if you are sure that your platform does not support this
> +	  access method or you have problems caused by it.
> +
> +	  Say 'y' otherwise.

For future reference, the canonical incantantion in Kconfig lore is:

	  Say Y otherwise.

I have fixed it up in this commit.

Thanks,

	Ingo

[tip: x86/urgent] x86/Kconfig: Document CONFIG_PCI_MMCONFIG

Posted by tip-bot2 for Mateusz Jończyk 10 months, 3 weeks ago

The following commit has been merged into the x86/urgent branch of tip:

Commit-ID:     21d8fb8d4e7071b2e60bc48c217ff1b4ce8cb855
Gitweb:        https://git.kernel.org/tip/21d8fb8d4e7071b2e60bc48c217ff1b4ce8cb855
Author:        Mateusz Jończyk <mat.jonczyk@o2.pl>
AuthorDate:    Fri, 21 Mar 2025 21:48:47 +01:00
Committer:     Ingo Molnar <mingo@kernel.org>
CommitterDate: Sat, 22 Mar 2025 08:08:20 +01:00

x86/Kconfig: Document CONFIG_PCI_MMCONFIG

This configuration option had no help text, so add it.

CONFIG_EXPERT is enabled on some distribution kernels, so people using a
distribution kernel's configuration as a starting point will see this
option.

[ mingo: Standardized the new Kconfig text a bit. ]

Signed-off-by: Mateusz Jończyk <mat.jonczyk@o2.pl>
Signed-off-by: David Heideberg <david@ixit.cz>
Signed-off-by: Ingo Molnar <mingo@kernel.org>
Cc: "H. Peter Anvin" <hpa@zytor.com>
Cc: Linus Torvalds <torvalds@linux-foundation.org>
Link: https://lore.kernel.org/r/20250321-x86_x2apic-v3-5-b0cbaa6fa338@ixit.cz
---
 arch/x86/Kconfig | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/arch/x86/Kconfig b/arch/x86/Kconfig
index 917cd2f..a079ecf 100644
--- a/arch/x86/Kconfig
+++ b/arch/x86/Kconfig
@@ -2902,6 +2902,19 @@ config PCI_MMCONFIG
 	default y
 	depends on PCI && (ACPI || JAILHOUSE_GUEST)
 	depends on X86_64 || (PCI_GOANY || PCI_GOMMCONFIG)
+	help
+	  Add support for accessing the PCI configuration space as a memory
+	  mapped area. It is the recommended method if the system supports
+	  this (it must have PCI Express and ACPI for it to be available).
+
+	  In the unlikely case that enabling this configuration option causes
+	  problems, the mechanism can be switched off with the 'pci=nommconf'
+	  command line parameter.
+
+	  Say N only if you are sure that your platform does not support this
+	  access method or you have problems caused by it.
+
+	  Say Y otherwise.
 
 config PCI_OLPC
 	def_bool y