docs: ABI: testing: Document the OCC hwmon FFDC binary interface
authorEddie James <eajames@linux.ibm.com>
Tue, 19 Oct 2021 20:53:06 +0000 (15:53 -0500)
committerJoel Stanley <joel@jms.id.au>
Thu, 21 Oct 2021 23:24:32 +0000 (09:54 +1030)
Add documentation for the new binary sysfs that will dump the SBEFIFO
FFDC.

Signed-off-by: Eddie James <eajames@linux.ibm.com>
Link: https://lore.kernel.org/r/20211019205307.36946-4-eajames@linux.ibm.com
Signed-off-by: Joel Stanley <joel@jms.id.au>
Documentation/ABI/testing/sysfs-bus-platform-devices-occ-hwmon [new file with mode: 0644]

diff --git a/Documentation/ABI/testing/sysfs-bus-platform-devices-occ-hwmon b/Documentation/ABI/testing/sysfs-bus-platform-devices-occ-hwmon
new file mode 100644 (file)
index 0000000..b24d7ab
--- /dev/null
@@ -0,0 +1,13 @@
+What:          /sys/bus/platform/devices/occ-hwmon.X/ffdc
+KernelVersion: 5.15
+Contact:       eajames@linux.ibm.com
+Description:
+               Contains the First Failure Data Capture from the SBEFIFO
+               hardware, if there is any from a previous transfer. Otherwise,
+               the file is empty. The data is cleared when it's been
+               completely read by a user. As the name suggests, only the data
+               from the first error is saved, until it's cleared upon read. The OCC hwmon driver, running on
+               a Baseboard Management Controller (BMC), communicates with
+               POWER9 and up processors over the Self-Boot Engine (SBE) FIFO.
+               In many error conditions, the SBEFIFO will return error data
+               indicating the type of error and system state, etc.