Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

firmware: arm_scmi: Add debugfs ABI documentation for common entries

Add description of the debugfs SCMI common ABI.

Signed-off-by: Cristian Marussi <cristian.marussi@arm.com>
Tested-by: Florian Fainelli <f.fainelli@gmail.com>
Tested-by: Vincent Guittot <vincent.guittot@linaro.org>
Link: https://lore.kernel.org/r/20230118121426.492864-12-cristian.marussi@arm.com
Signed-off-by: Sudeep Holla <sudeep.holla@arm.com>

authored by

Cristian Marussi and committed by
Sudeep Holla
0f62ed00 c3d4aed7

+70
+70
Documentation/ABI/testing/debugfs-scmi
··· 1 + What: /sys/kernel/debug/scmi/<n>/instance_name 2 + Date: March 2023 3 + KernelVersion: 6.3 4 + Contact: cristian.marussi@arm.com 5 + Description: The name of the underlying SCMI instance <n> described by 6 + all the debugfs accessors rooted at /sys/kernel/debug/scmi/<n>, 7 + expressed as the full name of the top DT SCMI node under which 8 + this SCMI instance is rooted. 9 + Users: Debugging, any userspace test suite 10 + 11 + What: /sys/kernel/debug/scmi/<n>/atomic_threshold_us 12 + Date: March 2023 13 + KernelVersion: 6.3 14 + Contact: cristian.marussi@arm.com 15 + Description: An optional time value, expressed in microseconds, representing, 16 + on this SCMI instance <n>, the threshold above which any SCMI 17 + command, advertised to have an higher-than-threshold execution 18 + latency, should not be considered for atomic mode of operation, 19 + even if requested. 20 + Users: Debugging, any userspace test suite 21 + 22 + What: /sys/kernel/debug/scmi/<n>/transport/type 23 + Date: March 2023 24 + KernelVersion: 6.3 25 + Contact: cristian.marussi@arm.com 26 + Description: A string representing the type of transport configured for this 27 + SCMI instance <n>. 28 + Users: Debugging, any userspace test suite 29 + 30 + What: /sys/kernel/debug/scmi/<n>/transport/is_atomic 31 + Date: March 2023 32 + KernelVersion: 6.3 33 + Contact: cristian.marussi@arm.com 34 + Description: A boolean stating if the transport configured on the underlying 35 + SCMI instance <n> is capable of atomic mode of operation. 36 + Users: Debugging, any userspace test suite 37 + 38 + What: /sys/kernel/debug/scmi/<n>/transport/max_rx_timeout_ms 39 + Date: March 2023 40 + KernelVersion: 6.3 41 + Contact: cristian.marussi@arm.com 42 + Description: Timeout in milliseconds allowed for SCMI synchronous replies 43 + for the currently configured SCMI transport for instance <n>. 44 + Users: Debugging, any userspace test suite 45 + 46 + What: /sys/kernel/debug/scmi/<n>/transport/max_msg_size 47 + Date: March 2023 48 + KernelVersion: 6.3 49 + Contact: cristian.marussi@arm.com 50 + Description: Max message size of allowed SCMI messages for the currently 51 + configured SCMI transport for instance <n>. 52 + Users: Debugging, any userspace test suite 53 + 54 + What: /sys/kernel/debug/scmi/<n>/transport/tx_max_msg 55 + Date: March 2023 56 + KernelVersion: 6.3 57 + Contact: cristian.marussi@arm.com 58 + Description: Max number of concurrently allowed in-flight SCMI messages for 59 + the currently configured SCMI transport for instance <n> on the 60 + TX channels. 61 + Users: Debugging, any userspace test suite 62 + 63 + What: /sys/kernel/debug/scmi/<n>/transport/rx_max_msg 64 + Date: March 2023 65 + KernelVersion: 6.3 66 + Contact: cristian.marussi@arm.com 67 + Description: Max number of concurrently allowed in-flight SCMI messages for 68 + the currently configured SCMI transport for instance <n> on the 69 + RX channels. 70 + Users: Debugging, any userspace test suite