[PATCH v4 09/11] firmware: arm_scmi: Add debugfs ABI documentation for Raw mode

From: Cristian Marussi
Date: Wed Oct 19 2022 - 16:47:44 EST


Add description of the debugfs SCMI Raw ABI.

Signed-off-by: Cristian Marussi <cristian.marussi@xxxxxxx>
---
Documentation/ABI/testing/debugfs-scmi-raw | 88 ++++++++++++++++++++++
1 file changed, 88 insertions(+)
create mode 100644 Documentation/ABI/testing/debugfs-scmi-raw

diff --git a/Documentation/ABI/testing/debugfs-scmi-raw b/Documentation/ABI/testing/debugfs-scmi-raw
new file mode 100644
index 000000000000..183ec678cb3e
--- /dev/null
+++ b/Documentation/ABI/testing/debugfs-scmi-raw
@@ -0,0 +1,88 @@
+What: /sys/kernel/debug/scmi_raw/transport_max_msg_size
+Date: December 2022
+KernelVersion: 6.1
+Contact: cristian.marussi@xxxxxxx
+Description: Max message size of allowed SCMI messages for the currently
+ configured SCMI transport.
+Users: Debugging, any userspace test suite
+
+What: /sys/kernel/debug/scmi_raw/transport_tx_max_msg
+Date: December 2022
+KernelVersion: 6.1
+Contact: cristian.marussi@xxxxxxx
+Description: Max number of concurrently allowed in-flight SCMI messages for
+ the currently configured SCMI transport.
+Users: Debugging, any userspace test suite
+
+What: /sys/kernel/debug/scmi_raw/transport_rx_timeout_ms
+Date: December 2022
+KernelVersion: 6.1
+Contact: cristian.marussi@xxxxxxx
+Description: Timeout in milliseconds allowed for SCMI synchronous replies
+ for the currently configured SCMI transport.
+Users: Debugging, any userspace test suite
+
+What: /sys/kernel/debug/scmi_raw/message
+Date: December 2022
+KernelVersion: 6.1
+Contact: cristian.marussi@xxxxxxx
+Description: SCMI Raw synchronous message injection/snooping facility; write
+ a complete SCMI synchronous command message (header included)
+ in little-endian binary format to have it sent to the configured
+ backend SCMI server.
+ Any subsequently received response can be read from this same
+ entry if it arrived within the configured timeout.
+ Each write to the entry causes one command request to be built
+ and sent while the replies are read back one message at time
+ (receiving an EOF at each message boundary).
+Users: Debugging, any userspace test suite
+
+What: /sys/kernel/debug/scmi_raw/message_async
+Date: December 2022
+KernelVersion: 6.1
+Contact: cristian.marussi@xxxxxxx
+Description: SCMI Raw asynchronous message injection/snooping facility; write
+ a complete SCMI asynchronous command message (header included)
+ in little-endian binary format to have it sent to the configured
+ backend SCMI server.
+ Any subsequently received response can be read from this same
+ entry if it arrived within the configured timeout.
+ Any additional delayed response received afterwards can be read
+ from this same entry too if it arrived within the configured
+ timeout.
+ Each write to the entry causes one command request to be built
+ and sent while the replies are read back one message at time
+ (receiving an EOF at each message boundary).
+Users: Debugging, any userspace test suite
+
+What: /sys/kernel/debug/scmi_raw/errors
+Date: December 2022
+KernelVersion: 6.1
+Contact: cristian.marussi@xxxxxxx
+Description: SCMI Raw message errors facility; any kind of timed-out or
+ generally unexpectedly received SCMI message can be read from
+ this entry.
+ Each read gives back one message at time (receiving an EOF at
+ each message boundary).
+Users: Debugging, any userspace test suite
+
+What: /sys/kernel/debug/scmi_raw/notification
+Date: December 2022
+KernelVersion: 6.1
+Contact: cristian.marussi@xxxxxxx
+Description: SCMI Raw notification snooping facility; any notification
+ emitted by the backend SCMI server can be read from this entry.
+ Each read gives back one message at time (receiving an EOF at
+ each message boundary).
+Users: Debugging, any userspace test suite
+
+What: /sys/kernel/debug/scmi_raw/reset
+Date: December 2022
+KernelVersion: 6.1
+Contact: cristian.marussi@xxxxxxx
+Description: SCMI Raw stack reset facility; writing a value to this entry
+ causes the internal queues of any kind of received message,
+ still pending to be read out, to be flushed.
+ Can be used to reset and clean the SCMI Raw stack between to
+ different test-run.
+Users: Debugging, any userspace test suite
--
2.34.1