xref: /linux/Documentation/ABI/testing/sysfs-class-remoteproc (revision 95298d63c67673c654c08952672d016212b26054)
1What:		/sys/class/remoteproc/.../firmware
2Date:		October 2016
3Contact:	Matt Redfearn <matt.redfearn@mips.com>
4Description:	Remote processor firmware
5
6		Reports the name of the firmware currently loaded to the
7		remote processor.
8
9		To change the running firmware, ensure the remote processor is
10		stopped (using /sys/class/remoteproc/.../state) and write a new filename.
11
12What:		/sys/class/remoteproc/.../state
13Date:		October 2016
14Contact:	Matt Redfearn <matt.redfearn@mips.com>
15Description:	Remote processor state
16
17		Reports the state of the remote processor, which will be one of:
18
19		"offline"
20		"suspended"
21		"running"
22		"crashed"
23		"invalid"
24
25		"offline" means the remote processor is powered off.
26
27		"suspended" means that the remote processor is suspended and
28		must be woken to receive messages.
29
30		"running" is the normal state of an available remote processor
31
32		"crashed" indicates that a problem/crash has been detected on
33		the remote processor.
34
35		"invalid" is returned if the remote processor is in an
36		unknown state.
37
38		Writing this file controls the state of the remote processor.
39		The following states can be written:
40
41		"start"
42		"stop"
43
44		Writing "start" will attempt to start the processor running the
45		firmware indicated by, or written to,
46		/sys/class/remoteproc/.../firmware. The remote processor should
47		transition to "running" state.
48
49		Writing "stop" will attempt to halt the remote processor and
50		return it to the "offline" state.
51
52What:		/sys/class/remoteproc/.../name
53Date:		August 2019
54KernelVersion:	5.4
55Contact:	Suman Anna <s-anna@ti.com>
56Description:	Remote processor name
57
58		Reports the name of the remote processor. This can be used by
59		userspace in exactly identifying a remote processor and ease
60		up the usage in modifying the 'firmware' or 'state' files.
61