Skip to content

Commit 05f643d

Browse files
l1kbjorn-helgaas
authored andcommitted
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 <[email protected]> Signed-off-by: Bjorn Helgaas <[email protected]> Reviewed-by: Mika Westerberg <[email protected]> Cc: Maciej Grochowski <[email protected]> Link: https://patch.msgid.link/bf826c41b4c1d255c7dcb16e266b52f774d944ed.1774246067.git.lukas@wunner.de
1 parent 70bb843 commit 05f643d

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

Documentation/PCI/pcieaer-howto.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,16 @@ In the example, 'Requester ID' means the ID of the device that sent
8585
the error message to the Root Port. Please refer to PCIe specs for other
8686
fields.
8787

88+
The 'TLP Header' is the prefix/header of the TLP that caused the error
89+
in raw hex format. To decode the TLP Header into human-readable form
90+
one may use tlp-tool:
91+
92+
https://github.com/mmpg-x86/tlp-tool
93+
94+
Example usage::
95+
96+
curl -L https://git.kernel.org/linus/2ca1c94ce0b6 | rtlp-tool --aer
97+
8898
AER Ratelimits
8999
--------------
90100

0 commit comments

Comments
 (0)