Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

docs: pci: boot-interrupts.rst: improve html output

There are some warnings with this file:

/Documentation/PCI/boot-interrupts.rst:42: WARNING: Unexpected indentation.
/Documentation/PCI/boot-interrupts.rst:52: WARNING: Block quote ends without a blank line; unexpected unindent.
/Documentation/PCI/boot-interrupts.rst:92: WARNING: Unexpected indentation.
/Documentation/PCI/boot-interrupts.rst:98: WARNING: Unexpected indentation.
/Documentation/PCI/boot-interrupts.rst:136: WARNING: Unexpected indentation.

It turns that this file conversion to ReST could be improved,
in order to remove the warnings and provide a better output.

So, fix the warnings by adjusting blank lines, add a table and
some list markups. Also, mark endnodes as such.

Acked-by: Bjorn Helgaas <bhelgaas@google.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Link: https://lore.kernel.org/r/a6a9eb16eede10731bcce69a600ab12d92e6ba47.1586881715.git.mchehab+huawei@kernel.org
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

authored by

Mauro Carvalho Chehab and committed by
Jonathan Corbet
a588332f 877a37d3

+19 -15
+19 -15
Documentation/PCI/boot-interrupts.rst
··· 32 32 Spurious Interrupts. The IRQ will be disabled by the Linux kernel after it 33 33 reaches a specific count with the error "nobody cared". This disabled IRQ 34 34 now prevents valid usage by an existing interrupt which may happen to share 35 - the IRQ line. 35 + the IRQ line:: 36 36 37 37 irq 19: nobody cared (try booting with the "irqpoll" option) 38 38 CPU: 0 PID: 2988 Comm: irq/34-nipalk Tainted: 4.14.87-rt49-02410-g4a640ec-dirty #1 39 39 Hardware name: National Instruments NI PXIe-8880/NI PXIe-8880, BIOS 2.1.5f1 01/09/2020 40 40 Call Trace: 41 + 41 42 <IRQ> 42 43 ? dump_stack+0x46/0x5e 43 44 ? __report_bad_irq+0x2e/0xb0 ··· 86 85 The mitigations take the form of PCI quirks. The preference has been to 87 86 first identify and make use of a means to disable the routing to the PCH. 88 87 In such a case a quirk to disable boot interrupt generation can be 89 - added.[1] 88 + added. [1]_ 90 89 91 - Intel® 6300ESB I/O Controller Hub 90 + Intel® 6300ESB I/O Controller Hub 92 91 Alternate Base Address Register: 93 92 BIE: Boot Interrupt Enable 94 - 0 = Boot interrupt is enabled. 95 - 1 = Boot interrupt is disabled. 96 93 97 - Intel® Sandy Bridge through Sky Lake based Xeon servers: 94 + == =========================== 95 + 0 Boot interrupt is enabled. 96 + 1 Boot interrupt is disabled. 97 + == =========================== 98 + 99 + Intel® Sandy Bridge through Sky Lake based Xeon servers: 98 100 Coherent Interface Protocol Interrupt Control 99 101 dis_intx_route2pch/dis_intx_route2ich/dis_intx_route2dmi2: 100 102 When this bit is set. Local INTx messages received from the ··· 113 109 disabled, the Linux kernel will reroute the valid interrupt to its legacy 114 110 interrupt. This redirection of the handler will prevent the occurrence of 115 111 the spurious interrupt detection which would ordinarily disable the IRQ 116 - line due to excessive unhandled counts.[2] 112 + line due to excessive unhandled counts. [2]_ 117 113 118 114 The config option X86_REROUTE_FOR_BROKEN_BOOT_IRQS exists to enable (or 119 115 disable) the redirection of the interrupt handler to the PCH interrupt 120 116 line. The option can be overridden by either pci=ioapicreroute or 121 - pci=noioapicreroute.[3] 117 + pci=noioapicreroute. [3]_ 122 118 123 119 124 120 More Documentation ··· 131 127 Example of disabling of the boot interrupt 132 128 ------------------------------------------ 133 129 134 - Intel® 6300ESB I/O Controller Hub (Document # 300641-004US) 130 + - Intel® 6300ESB I/O Controller Hub (Document # 300641-004US) 135 131 5.7.3 Boot Interrupt 136 132 https://www.intel.com/content/dam/doc/datasheet/6300esb-io-controller-hub-datasheet.pdf 137 133 138 - Intel® Xeon® Processor E5-1600/2400/2600/4600 v3 Product Families 139 - Datasheet - Volume 2: Registers (Document # 330784-003) 134 + - Intel® Xeon® Processor E5-1600/2400/2600/4600 v3 Product Families 135 + Datasheet - Volume 2: Registers (Document # 330784-003) 140 136 6.6.41 cipintrc Coherent Interface Protocol Interrupt Control 141 137 https://www.intel.com/content/dam/www/public/us/en/documents/datasheets/xeon-e5-v3-datasheet-vol-2.pdf 142 138 143 139 Example of handler rerouting 144 140 ---------------------------- 145 141 146 - Intel® 6700PXH 64-bit PCI Hub (Document # 302628) 142 + - Intel® 6700PXH 64-bit PCI Hub (Document # 302628) 147 143 2.15.2 PCI Express Legacy INTx Support and Boot Interrupt 148 144 https://www.intel.com/content/dam/doc/datasheet/6700pxh-64-bit-pci-hub-datasheet.pdf 149 145 ··· 154 150 Sean V Kelley 155 151 sean.v.kelley@linux.intel.com 156 152 157 - [1] https://lore.kernel.org/r/12131949181903-git-send-email-sassmann@suse.de/ 158 - [2] https://lore.kernel.org/r/12131949182094-git-send-email-sassmann@suse.de/ 159 - [3] https://lore.kernel.org/r/487C8EA7.6020205@suse.de/ 153 + .. [1] https://lore.kernel.org/r/12131949181903-git-send-email-sassmann@suse.de/ 154 + .. [2] https://lore.kernel.org/r/12131949182094-git-send-email-sassmann@suse.de/ 155 + .. [3] https://lore.kernel.org/r/487C8EA7.6020205@suse.de/