[PATCH] Documentation: Explain pci=conf1,conf2 more verbosely

[PATCH] Documentation: Explain pci=conf1,conf2 more verbosely

[Borislav Petkov]

From: Borislav Petkov <bp@suse.de>

People complained that setting the PCI config space access mechanism
through "pci=conf1" or "pci=conf2" on the command line is not really
documented. Yeah, can you blame them? Look at what we have now.

So try to improve the situation a bit by explaining what those "conf1"
and "conf2" things actually mean.

See http://wiki.osdev.org/PCI for more info.

Suggested-by: Eric Morton <Eric.Morton@amd.com>
Signed-off-by: Borislav Petkov <bp@suse.de>
---
 Documentation/kernel-parameters.txt | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/Documentation/kernel-parameters.txt b/Documentation/kernel-parameters.txt
index 742f69d18fc8..d1f5e057f3f3 100644
--- a/Documentation/kernel-parameters.txt
+++ b/Documentation/kernel-parameters.txt
@@ -2733,10 +2733,14 @@ bytes respectively. Such letter suffixes can also be entirely omitted.
 				hardware access methods are allowed. Use this
 				if you experience crashes upon bootup and you
 				suspect they are caused by the BIOS.
-		conf1		[X86] Force use of PCI Configuration
-				Mechanism 1.
-		conf2		[X86] Force use of PCI Configuration
-				Mechanism 2.
+		conf1		[X86] Force use of PCI Configuration Access
+				Mechanism 1 (config address in IO port 0xCF8,
+				data in IO port 0xCFC, both 32-bit).
+		conf2		[X86] Force use of PCI Configuration Access
+				Mechanism 2 (IO port 0xCF8 is an 8-bit port for
+				the function, IO port 0xCFA, also 8-bit, sets
+				bus number. The config space is then accessed
+				through ports 0xC000-0xCFFF).
 		noaer		[PCIE] If the PCIEAER kernel config parameter is
 				enabled, this kernel boot option can be used to
 				disable the use of PCIE advanced error reporting.
-- 
2.3.5

Re: [PATCH] Documentation: Explain pci=conf1,conf2 more verbosely

[Jonathan Corbet]

On Wed, 13 Jan 2016 16:48:51 +0100
Borislav Petkov <bp@alien8.de> wrote:

> People complained that setting the PCI config space access mechanism
> through "pci=conf1" or "pci=conf2" on the command line is not really
> documented. Yeah, can you blame them? Look at what we have now.
> 
> So try to improve the situation a bit by explaining what those "conf1"
> and "conf2" things actually mean.

Seems good, applied to the docs tree...

> See http://wiki.osdev.org/PCI for more info.

...but I took the liberty of adding this URL too; people reading the
document are unlikely to check the commit log in case there's a useful
pointer waiting there for them :)

Thanks,

jon

Re: [PATCH] Documentation: Explain pci=conf1,conf2 more verbosely

[Borislav Petkov]

On Thu, Jan 14, 2016 at 01:27:16PM -0700, Jonathan Corbet wrote:
> > See http://wiki.osdev.org/PCI for more info.
> 
> ...but I took the liberty of adding this URL too; people reading the
> document are unlikely to check the commit log in case there's a useful
> pointer waiting there for them :)

Fair enough.

We did have a little discussion about adding some URL which might
disappear in the future, to our docs. If it does, I guess we can then
fall back to the internet archive...

-- 
Regards/Gruss,
    Boris.

ECO tip #101: Trim your mails when you reply.