linux/Documentation/PCI
Lukas Wunner 05f643d6f7 Documentation: PCI: Document PCIe TLP Header decoder for AER messages
The prefix/header of a TLP that caused an error may be recorded in the AER
Capability and emitted to the kernel log in raw hex format.  Document the
existence and usage of tlp-tool, which decodes the TLP Header into
human-readable form.

The TLP Header hints at the root cause of an error, yet is often ignored
because of its seeming opaqueness.  Instead, PCIe errors are frequently
worked around by a change in the kernel without fully understanding the
actual source of the problem.  With more documentation on available tools
we'll hopefully come up with better solutions.

There are also wireshark dissectors for TLPs, but it seems they expect a
complete TLP, not just the header, and they cannot grok the hex format
emitted by the kernel directly.  tlp-tool appears to be the most cut and
dried solution out there.

Signed-off-by: Lukas Wunner <lukas@wunner.de>
Signed-off-by: Bjorn Helgaas <bhelgaas@google.com>
Reviewed-by: Mika Westerberg <mika.westerberg@linux.intel.com>
Cc: Maciej Grochowski <mx2pg@pm.me>
Link: https://patch.msgid.link/bf826c41b4c1d255c7dcb16e266b52f774d944ed.1774246067.git.lukas@wunner.de
2026-03-23 15:58:02 -05:00
..
controller PCI: rcar-gen4: Document how to obtain platform firmware 2025-05-21 12:02:59 +00:00
endpoint Merge branch 'pci/controller/dwc' 2026-02-06 17:09:34 -06:00
acpi-info.rst docs: PCI: Replace non-breaking spaces to avoid PDF issues 2021-06-17 13:22:33 -06:00
boot-interrupts.rst docs: PCI: Fix typos 2023-12-28 17:37:36 -06:00
index.rst PCI: rcar-gen4: Document how to obtain platform firmware 2025-05-21 12:02:59 +00:00
msi-howto.rst Documentation: PCI: Fix typos in msi-howto.rst 2025-12-29 11:22:08 -06:00
pci-error-recovery.rst net: ethernet: neterion: s2io: remove unused driver 2026-01-28 20:08:07 -08:00
pci-iov-howto.rst PCI/doc: Convert examples to generic power management 2022-07-11 18:17:29 -05:00
pci.rst Documentation: PCI: fix typo in pci.rst 2024-09-10 15:30:42 -06:00
pcieaer-howto.rst Documentation: PCI: Document PCIe TLP Header decoder for AER messages 2026-03-23 15:58:02 -05:00
pciebus-howto.rst PCI: Protect Link Control 2 Register with RMW locking 2024-10-23 16:50:02 -05:00
sysfs-pci.rst PCI: Remove pci_mmap_page_range() wrapper 2022-07-29 12:08:44 -05:00
tph.rst PCI/TPH: Add TPH documentation 2024-10-21 16:19:32 -05:00