tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
media: debugfs-cec-error-inj: document CEC error inj debugfs ABI
Document the core of the debugfs CEC error injection ABI.
The driver specific commands are documented elsewhere and
this file points to that documentation.
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
authored by
Hans Verkuil
and committed by
Mauro Carvalho Chehab
f67449fd
f84a66d6
+41
+40
Documentation/ABI/testing/debugfs-cec-error-inj
+40
Documentation/ABI/testing/debugfs-cec-error-inj
···
1
+
What: /sys/kernel/debug/cec/*/error-inj
2
+
Date: March 2018
3
+
Contact: Hans Verkuil <hans.verkuil@cisco.com>
4
+
Description:
5
+
6
+
The CEC Framework allows for CEC error injection commands through
7
+
debugfs. Drivers that support this will create an error-inj file
8
+
through which the error injection commands can be given.
9
+
10
+
The basic syntax is as follows:
11
+
12
+
Leading spaces/tabs are ignored. If the next character is a '#' or the
13
+
end of the line was reached, then the whole line is ignored. Otherwise
14
+
a command is expected.
15
+
16
+
It is up to the driver to decide what commands to implement. The only
17
+
exception is that the command 'clear' without any arguments must be
18
+
implemented and that it will remove all current error injection
19
+
commands.
20
+
21
+
This ensures that you can always do 'echo clear >error-inj' to clear any
22
+
error injections without having to know the details of the driver-specific
23
+
commands.
24
+
25
+
Note that the output of 'error-inj' shall be valid as input to 'error-inj'.
26
+
So this must work:
27
+
28
+
$ cat error-inj >einj.txt
29
+
$ cat einj.txt >error-inj
30
+
31
+
Other than these basic rules described above this ABI is not considered
32
+
stable and may change in the future.
33
+
34
+
Drivers that implement this functionality must document the commands as
35
+
part of the CEC documentation and must keep that documentation up to date
36
+
when changes are made.
37
+
38
+
The following CEC error injection implementations exist:
39
+
40
+
- Documentation/media/uapi/cec/cec-pin-error-inj.rst
+1
MAINTAINERS
+1
MAINTAINERS