Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
From:   Cristian Marussi <cristian.marussi@arm.com>
To:     linux-kernel@vger.kernel.org, linux-arm-kernel@lists.infradead.org
Cc:     sudeep.holla@arm.com, Cristian Marussi <cristian.marussi@arm.com>,
        Vincent Guittot <vincent.guittot@linaro.org>
Subject: [PATCH] firmware: arm_scmi: Clarify Raw per-channel ABI documentation
Date:   Fri, 20 Jan 2023 12:23:26 +0000
Message-Id: <20230120122326.1932614-1-cristian.marussi@arm.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
Precedence: bulk

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>
---
 Documentation/ABI/testing/debugfs-scmi-raw | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

diff --git a/Documentation/ABI/testing/debugfs-scmi-raw b/Documentation/ABI/testing/debugfs-scmi-raw
index 5468ec08c084..b1c505ed444c 100644
--- a/Documentation/ABI/testing/debugfs-scmi-raw
+++ b/Documentation/ABI/testing/debugfs-scmi-raw
@@ -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
-- 
2.34.1