debugfs-scmi-raw

  1What:		/sys/kernel/debug/scmi/<n>/raw/message
  2Date:		March 2023
  3KernelVersion:	6.3
  4Contact:	cristian.marussi@arm.com
  5Description:	SCMI Raw synchronous message injection/snooping facility; write
  6		a complete SCMI synchronous command message (header included)
  7		in little-endian binary format to have it sent to the configured
  8		backend SCMI server for instance <n>.
  9		Any subsequently received response can be read from this same
 10		entry if it arrived within the configured timeout.
 11		Each write to the entry causes one command request to be built
 12		and sent while the replies are read back one message at time
 13		(receiving an EOF at each message boundary).
 14Users:		Debugging, any userspace test suite
 15
 16What:		/sys/kernel/debug/scmi/<n>/raw/message_async
 17Date:		March 2023
 18KernelVersion:	6.3
 19Contact:	cristian.marussi@arm.com
 20Description:	SCMI Raw asynchronous message injection/snooping facility; write
 21		a complete SCMI asynchronous command message (header included)
 22		in little-endian binary format to have it sent to the configured
 23		backend SCMI server for instance <n>.
 24		Any subsequently received response can be read from this same
 25		entry if it arrived within the configured timeout.
 26		Any additional delayed response received afterwards can be read
 27		from this same entry too if it arrived within the configured
 28		timeout.
 29		Each write to the entry causes one command request to be built
 30		and sent while the replies are read back one message at time
 31		(receiving an EOF at each message boundary).
 32Users:		Debugging, any userspace test suite
 33
 34What:		/sys/kernel/debug/scmi/<n>/raw/message_poll
 35Date:		June 2025
 36KernelVersion:	6.16
 37Contact:	cristian.marussi@arm.com
 38Description:	SCMI Raw message injection/snooping facility using polling mode;
 39		write a complete SCMI command message (header included) in
 40		little-endian binary format to have it sent to the configured
 41		backend SCMI server for instance <n>, using polling mode on
 42		the reception path. (if transport is polling capable)
 43		Any subsequently received response can be read from this same
 44		entry if it arrived within the configured timeout.
 45		Each write to the entry causes one command request to be built
 46		and sent while the replies are read back one message at time
 47		(receiving an EOF at each message boundary).
 48Users:		Debugging, any userspace test suite
 49
 50What:		/sys/kernel/debug/scmi/<n>/raw/message_poll_async
 51Date:		June 2025
 52KernelVersion:	6.16
 53Contact:	cristian.marussi@arm.com
 54Description:	SCMI Raw asynchronous message injection/snooping facility using
 55		polling-mode; write a complete SCMI asynchronous command message
 56		(header included) in little-endian binary format to have it sent
 57		to the configured backend SCMI server for instance <n>, using
 58		polling-mode on the reception path of the immediate part of the
 59		asynchronous command. (if transport is polling capable)
 60		Any subsequently received response can be read from this same
 61		entry if it arrived within the configured timeout.
 62		Any additional delayed response received afterwards can be read
 63		from this same entry too if it arrived within the configured
 64		timeout.
 65		Each write to the entry causes one command request to be built
 66		and sent while the replies are read back one message at time
 67		(receiving an EOF at each message boundary).
 68Users:		Debugging, any userspace test suite
 69
 70What:		/sys/kernel/debug/scmi/<n>/raw/errors
 71Date:		March 2023
 72KernelVersion:	6.3
 73Contact:	cristian.marussi@arm.com
 74Description:	SCMI Raw message errors facility; any kind of timed-out or
 75		generally unexpectedly received SCMI message, for instance <n>,
 76		can be read from this entry.
 77		Each read gives back one message at time (receiving an EOF at
 78		each message boundary).
 79Users:		Debugging, any userspace test suite
 80
 81What:		/sys/kernel/debug/scmi/<n>/raw/notification
 82Date:		March 2023
 83KernelVersion:	6.3
 84Contact:	cristian.marussi@arm.com
 85Description:	SCMI Raw notification snooping facility; any notification
 86		emitted by the backend SCMI server, for instance <n>, can be
 87		read from this entry.
 88		Each read gives back one message at time (receiving an EOF at
 89		each message boundary).
 90Users:		Debugging, any userspace test suite
 91
 92What:		/sys/kernel/debug/scmi/<n>/raw/reset
 93Date:		March 2023
 94KernelVersion:	6.3
 95Contact:	cristian.marussi@arm.com
 96Description:	SCMI Raw stack reset facility; writing a value to this entry
 97		causes the internal queues of any kind of received message,
 98		still pending to be read out for instance <n>, to be immediately
 99		flushed.
100		Can be used to reset and clean the SCMI Raw stack between to
101		different test-run.
102Users:		Debugging, any userspace test suite
103
104What:		/sys/kernel/debug/scmi/<n>/raw/channels/<m>/message
105Date:		March 2023
106KernelVersion:	6.3
107Contact:	cristian.marussi@arm.com
108Description:	SCMI Raw synchronous message injection/snooping facility; write
109		a complete SCMI synchronous command message (header included)
110		in little-endian binary format to have it sent to the configured
111		backend SCMI server for instance <n> through the <m> transport
112		channel.
113		Any subsequently received response can be read from this same
114		entry if it arrived on channel <m> within the configured
115		timeout.
116		Each write to the entry causes one command request to be built
117		and sent while the replies are read back one message at time
118		(receiving an EOF at each message boundary).
119		Channel identifier <m> matches the SCMI protocol number which
120		has been associated with this transport channel in the DT
121		description, with base protocol number 0x10 being the default
122		channel for this instance.
123		Note that these per-channel entries rooted at <..>/channels
124		exist only if the transport is configured to have more than
125		one default channel.
126Users:		Debugging, any userspace test suite
127
128What:		/sys/kernel/debug/scmi/<n>/raw/channels/<m>/message_async
129Date:		March 2023
130KernelVersion:	6.3
131Contact:	cristian.marussi@arm.com
132Description:	SCMI Raw asynchronous message injection/snooping facility; write
133		a complete SCMI asynchronous command message (header included)
134		in little-endian binary format to have it sent to the configured
135		backend SCMI server for instance <n> through the <m> transport
136		channel.
137		Any subsequently received response can be read from this same
138		entry if it arrived on channel <m> within the configured
139		timeout.
140		Any additional delayed response received afterwards can be read
141		from this same entry too if it arrived within the configured
142		timeout.
143		Each write to the entry causes one command request to be built
144		and sent while the replies are read back one message at time
145		(receiving an EOF at each message boundary).
146		Channel identifier <m> matches the SCMI protocol number which
147		has been associated with this transport channel in the DT
148		description, with base protocol number 0x10 being the default
149		channel for this instance.
150		Note that these per-channel entries rooted at <..>/channels
151		exist only if the transport is configured to have more than
152		one default channel.
153Users:		Debugging, any userspace test suite
154
155
156What:		/sys/kernel/debug/scmi/<n>/raw/channels/<m>/message_poll
157Date:		June 2025
158KernelVersion:	6.16
159Contact:	cristian.marussi@arm.com
160Description:	SCMI Raw message injection/snooping facility using polling mode;
161		write a complete SCMI command message (header included) in
162		little-endian binary format to have it sent to the configured
163		backend SCMI server for instance <n> through the <m> transport
164		channel, using polling mode on the reception path.
165		(if transport is polling capable)
166		Any subsequently received response can be read from this same
167		entry if it arrived on channel <m> within the configured
168		timeout.
169		Each write to the entry causes one command request to be built
170		and sent while the replies are read back one message at time
171		(receiving an EOF at each message boundary).
172		Channel identifier <m> matches the SCMI protocol number which
173		has been associated with this transport channel in the DT
174		description, with base protocol number 0x10 being the default
175		channel for this instance.
176		Note that these per-channel entries rooted at <..>/channels
177		exist only if the transport is configured to have more than
178		one default channel.
179Users:		Debugging, any userspace test suite
180
181What:		/sys/kernel/debug/scmi/<n>/raw/channels/<m>/message_poll_async
182Date:		June 2025
183KernelVersion:	6.16
184Contact:	cristian.marussi@arm.com
185Description:	SCMI Raw asynchronous message injection/snooping facility using
186		polling-mode; write a complete SCMI asynchronous command message
187		(header included) in little-endian binary format to have it sent
188		to the configured backend SCMI server for instance <n> through
189		the <m> transport channel, using polling mode on the reception
190		path of the immediate part of the asynchronous command.
191		(if transport is polling capable)
192		Any subsequently received response can be read from this same
193		entry if it arrived on channel <m> within the configured
194		timeout.
195		Any additional delayed response received afterwards can be read
196		from this same entry too if it arrived within the configured
197		timeout.
198		Each write to the entry causes one command request to be built
199		and sent while the replies are read back one message at time
200		(receiving an EOF at each message boundary).
201		Channel identifier <m> matches the SCMI protocol number which
202		has been associated with this transport channel in the DT
203		description, with base protocol number 0x10 being the default
204		channel for this instance.
205		Note that these per-channel entries rooted at <..>/channels
206		exist only if the transport is configured to have more than
207		one default channel.
208Users:		Debugging, any userspace test suite