treewide: remove redundant IS_ERR() before error code check
[linux/fpc-iii.git] / Documentation / ABI / testing / sysfs-class-remoteproc
blob36094fbeb97493b74b6952e3ae0ad8eda5a8ff70
1 What:           /sys/class/remoteproc/.../firmware
2 Date:           October 2016
3 Contact:        Matt Redfearn <matt.redfearn@mips.com>
4 Description:    Remote processor firmware
6                 Reports the name of the firmware currently loaded to the
7                 remote processor.
9                 To change the running firmware, ensure the remote processor is
10                 stopped (using /sys/class/remoteproc/.../state) and write a new filename.
12 What:           /sys/class/remoteproc/.../state
13 Date:           October 2016
14 Contact:        Matt Redfearn <matt.redfearn@mips.com>
15 Description:    Remote processor state
17                 Reports the state of the remote processor, which will be one of:
19                 "offline"
20                 "suspended"
21                 "running"
22                 "crashed"
23                 "invalid"
25                 "offline" means the remote processor is powered off.
27                 "suspended" means that the remote processor is suspended and
28                 must be woken to receive messages.
30                 "running" is the normal state of an available remote processor
32                 "crashed" indicates that a problem/crash has been detected on
33                 the remote processor.
35                 "invalid" is returned if the remote processor is in an
36                 unknown state.
38                 Writing this file controls the state of the remote processor.
39                 The following states can be written:
41                 "start"
42                 "stop"
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.
49                 Writing "stop" will attempt to halt the remote processor and
50                 return it to the "offline" state.
52 What:           /sys/class/remoteproc/.../name
53 Date:           August 2019
54 KernelVersion:  5.4
55 Contact:        Suman Anna <s-anna@ti.com>
56 Description:    Remote processor name
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.