firmware: arm_scmi: Clarify raw per-channel ABI documentation
authorCristian Marussi <cristian.marussi@arm.com>
Fri, 20 Jan 2023 12:23:26 +0000 (12:23 +0000)
committerSudeep Holla <sudeep.holla@arm.com>
Fri, 20 Jan 2023 14:11:38 +0000 (14:11 +0000)
Explain more in detail how the per-channel <m> identifier is chosen.

Suggested-by: Vincent Guittot <vincent.guittot@linaro.org>
Signed-off-by: Cristian Marussi <cristian.marussi@arm.com>
Link: https://lore.kernel.org/r/20230120122326.1932614-1-cristian.marussi@arm.com
Signed-off-by: Sudeep Holla <sudeep.holla@arm.com>
Documentation/ABI/testing/debugfs-scmi-raw

index 5468ec08c0847f92c842bc8cdd3c4bd27956be5f..97678cc9535c3867b6cc18632bc4351f79bea125 100644 (file)
@@ -80,9 +80,13 @@ Description: SCMI Raw synchronous message injection/snooping facility; write
                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).
+               Channel identifier <m> matches the SCMI protocol number which
+               has been associated with this transport channel in the DT
+               description, with base protocol number 0x10 being the default
+               channel for this instance.
                Note that these per-channel entries rooted at <..>/channels
                exist only if the transport is configured to have more than
-               one channel.
+               one default channel.
 Users:         Debugging, any userspace test suite
 
 What:          /sys/kernel/debug/scmi/<n>/raw/channels/<m>/message_async
@@ -103,7 +107,11 @@ Description:       SCMI Raw asynchronous message injection/snooping facility; write
                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).
+               Channel identifier <m> matches the SCMI protocol number which
+               has been associated with this transport channel in the DT
+               description, with base protocol number 0x10 being the default
+               channel for this instance.
                Note that these per-channel entries rooted at <..>/channels
                exist only if the transport is configured to have more than
-               one channel.
+               one default channel.
 Users:         Debugging, any userspace test suite