platform/chrome: cros_ec_debugfs: Add debugfs ABI documentation
authorEnric Balletbo i Serra <enric.balletbo@collabora.com>
Fri, 14 Jun 2019 10:23:47 +0000 (12:23 +0200)
committerEnric Balletbo i Serra <enric.balletbo@collabora.com>
Tue, 18 Jun 2019 08:07:54 +0000 (10:07 +0200)
Add the missing ABI documentation for the already available debugfs
entries: console_log, panicinfo and pdinfo.

Signed-off-by: Enric Balletbo i Serra <enric.balletbo@collabora.com>
Documentation/ABI/testing/debugfs-cros-ec

index c91da2d..573a82d 100644 (file)
@@ -1,3 +1,29 @@
+What:          /sys/kernel/debug/<cros-ec-device>/console_log
+Date:          September 2017
+KernelVersion: 4.13
+Description:
+               If the EC supports the CONSOLE_READ command type, this file
+               can be used to grab the EC logs. The kernel polls for the log
+               and keeps its own buffer but userspace should grab this and
+               write it out to some logs.
+
+What:          /sys/kernel/debug/<cros-ec-device>/panicinfo
+Date:          September 2017
+KernelVersion: 4.13
+Description:
+               This file dumps the EC panic information from the previous
+               reboot. This file will only exist if the PANIC_INFO command
+               type is supported by the EC.
+
+What:          /sys/kernel/debug/<cros-ec-device>/pdinfo
+Date:          June 2018
+KernelVersion: 4.17
+Description:
+               This file provides the port role, muxes and power debug
+               information for all the USB PD/type-C ports available. If
+               the are no ports available, this file will be just an empty
+               file.
+
 What:          /sys/kernel/debug/<cros-ec-device>/uptime
 Date:          June 2019
 KernelVersion: 5.3