xref: /linux/Documentation/ABI/testing/debugfs-scmi-raw (revision ba199dc909a20fe62270ae4e93f263987bb9d119)
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/errors
35Date:		March 2023
36KernelVersion:	6.3
37Contact:	cristian.marussi@arm.com
38Description:	SCMI Raw message errors facility; any kind of timed-out or
39		generally unexpectedly received SCMI message, for instance <n>,
40		can be read from this entry.
41		Each read gives back one message at time (receiving an EOF at
42		each message boundary).
43Users:		Debugging, any userspace test suite
44
45What:		/sys/kernel/debug/scmi/<n>/raw/notification
46Date:		March 2023
47KernelVersion:	6.3
48Contact:	cristian.marussi@arm.com
49Description:	SCMI Raw notification snooping facility; any notification
50		emitted by the backend SCMI server, for instance <n>, can be
51		read from this entry.
52		Each read gives back one message at time (receiving an EOF at
53		each message boundary).
54Users:		Debugging, any userspace test suite
55
56What:		/sys/kernel/debug/scmi/<n>/raw/reset
57Date:		March 2023
58KernelVersion:	6.3
59Contact:	cristian.marussi@arm.com
60Description:	SCMI Raw stack reset facility; writing a value to this entry
61		causes the internal queues of any kind of received message,
62		still pending to be read out for instance <n>, to be immediately
63		flushed.
64		Can be used to reset and clean the SCMI Raw stack between to
65		different test-run.
66Users:		Debugging, any userspace test suite
67
68What:		/sys/kernel/debug/scmi/<n>/raw/channels/<m>/message
69Date:		March 2023
70KernelVersion:	6.3
71Contact:	cristian.marussi@arm.com
72Description:	SCMI Raw synchronous message injection/snooping facility; write
73		a complete SCMI synchronous command message (header included)
74		in little-endian binary format to have it sent to the configured
75		backend SCMI server for instance <n> through the <m> transport
76		channel.
77		Any subsequently received response can be read from this same
78		entry if it arrived on channel <m> within the configured
79		timeout.
80		Each write to the entry causes one command request to be built
81		and sent while the replies are read back one message at time
82		(receiving an EOF at each message boundary).
83		Channel identifier <m> matches the SCMI protocol number which
84		has been associated with this transport channel in the DT
85		description, with base protocol number 0x10 being the default
86		channel for this instance.
87		Note that these per-channel entries rooted at <..>/channels
88		exist only if the transport is configured to have more than
89		one default channel.
90Users:		Debugging, any userspace test suite
91
92What:		/sys/kernel/debug/scmi/<n>/raw/channels/<m>/message_async
93Date:		March 2023
94KernelVersion:	6.3
95Contact:	cristian.marussi@arm.com
96Description:	SCMI Raw asynchronous message injection/snooping facility; write
97		a complete SCMI asynchronous command message (header included)
98		in little-endian binary format to have it sent to the configured
99		backend SCMI server for instance <n> through the <m> transport
100		channel.
101		Any subsequently received response can be read from this same
102		entry if it arrived on channel <m> within the configured
103		timeout.
104		Any additional delayed response received afterwards can be read
105		from this same entry too if it arrived within the configured
106		timeout.
107		Each write to the entry causes one command request to be built
108		and sent while the replies are read back one message at time
109		(receiving an EOF at each message boundary).
110		Channel identifier <m> matches the SCMI protocol number which
111		has been associated with this transport channel in the DT
112		description, with base protocol number 0x10 being the default
113		channel for this instance.
114		Note that these per-channel entries rooted at <..>/channels
115		exist only if the transport is configured to have more than
116		one default channel.
117Users:		Debugging, any userspace test suite
118