firmware: arm_scmi: Clarify Raw per-channel ABI documentation

  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(-)
  

[Also Cc: linux-doc list]

On Fri, Jan 20, 2023 at 12:23:26PM +0000, Cristian Marussi wrote:
> 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.

s/Base/base/

>  		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.

Same here.

>  		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
 
Otherwise LGTM.
  

On Fri, 20 Jan 2023 12:23:26 +0000, Cristian Marussi wrote:
> Explain more in detail how the per-channel <m> identifier is chosen.
> 

Applied to sudeep.holla/linux (for-next/scmi), thanks!

[1/1] firmware: arm_scmi: Clarify Raw per-channel ABI documentation
      https://git.kernel.org/sudeep.holla/c/32a55bbdd74e
--
Regards,
Sudeep
  

On Fri, Jan 20, 2023 at 07:43:30PM +0700, Bagas Sanjaya wrote:
> [Also Cc: linux-doc list]
>

Sorry for missing the Cc but get_maintainer.pl did not say anything
about this ABI docs patches.

> On Fri, Jan 20, 2023 at 12:23:26PM +0000, Cristian Marussi wrote:
> > 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.
> 
> s/Base/base/
> 
Thought that being an SCMI protocol name definitions would have to be
capitalized.

> >  		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.
> 
> Same here.
> 
> >  		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
>  
> Otherwise LGTM.
>
Thanks,
Cristian