hc
2024-10-12 a5969cabbb4660eab42b6ef0412cbbd1200cf14d
kernel/Documentation/ABI/testing/sysfs-class-rc
....@@ -21,15 +21,22 @@
2121 Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
2222 Description:
2323 Reading this file returns a list of available protocols,
24
- something like:
24
+ something like::
25
+
2526 "rc5 [rc6] nec jvc [sony]"
27
+
2628 Enabled protocols are shown in [] brackets.
29
+
2730 Writing "+proto" will add a protocol to the list of enabled
2831 protocols.
32
+
2933 Writing "-proto" will remove a protocol from the list of enabled
3034 protocols.
35
+
3136 Writing "proto" will enable only "proto".
37
+
3238 Writing "none" will disable all protocols.
39
+
3340 Write fails with EINVAL if an invalid protocol combination or
3441 unknown protocol name is used.
3542
....@@ -39,11 +46,13 @@
3946 Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
4047 Description:
4148 Sets the scancode filter expected value.
49
+
4250 Use in combination with /sys/class/rc/rcN/filter_mask to set the
4351 expected value of the bits set in the filter mask.
4452 If the hardware supports it then scancodes which do not match
4553 the filter will be ignored. Otherwise the write will fail with
4654 an error.
55
+
4756 This value may be reset to 0 if the current protocol is altered.
4857
4958 What: /sys/class/rc/rcN/filter_mask
....@@ -56,9 +65,11 @@
5665 of the scancode which should be compared against the expected
5766 value. A value of 0 disables the filter to allow all valid
5867 scancodes to be processed.
68
+
5969 If the hardware supports it then scancodes which do not match
6070 the filter will be ignored. Otherwise the write will fail with
6171 an error.
72
+
6273 This value may be reset to 0 if the current protocol is altered.
6374
6475 What: /sys/class/rc/rcN/wakeup_protocols
....@@ -67,15 +78,22 @@
6778 Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
6879 Description:
6980 Reading this file returns a list of available protocols to use
70
- for the wakeup filter, something like:
81
+ for the wakeup filter, something like::
82
+
7183 "rc-5 nec nec-x rc-6-0 rc-6-6a-24 [rc-6-6a-32] rc-6-mce"
84
+
7285 Note that protocol variants are listed, so "nec", "sony",
7386 "rc-5", "rc-6" have their different bit length encodings
7487 listed if available.
88
+
7589 The enabled wakeup protocol is shown in [] brackets.
90
+
7691 Only one protocol can be selected at a time.
92
+
7793 Writing "proto" will use "proto" for wakeup events.
94
+
7895 Writing "none" will disable wakeup.
96
+
7997 Write fails with EINVAL if an invalid protocol combination or
8098 unknown protocol name is used, or if wakeup is not supported by
8199 the hardware.
....@@ -86,13 +104,17 @@
86104 Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
87105 Description:
88106 Sets the scancode wakeup filter expected value.
107
+
89108 Use in combination with /sys/class/rc/rcN/wakeup_filter_mask to
90109 set the expected value of the bits set in the wakeup filter mask
91110 to trigger a system wake event.
111
+
92112 If the hardware supports it and wakeup_filter_mask is not 0 then
93113 scancodes which match the filter will wake the system from e.g.
94114 suspend to RAM or power off.
115
+
95116 Otherwise the write will fail with an error.
117
+
96118 This value may be reset to 0 if the wakeup protocol is altered.
97119
98120 What: /sys/class/rc/rcN/wakeup_filter_mask
....@@ -101,11 +123,15 @@
101123 Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
102124 Description:
103125 Sets the scancode wakeup filter mask of bits to compare.
126
+
104127 Use in combination with /sys/class/rc/rcN/wakeup_filter to set
105128 the bits of the scancode which should be compared against the
106129 expected value to trigger a system wake event.
130
+
107131 If the hardware supports it and wakeup_filter_mask is not 0 then
108132 scancodes which match the filter will wake the system from e.g.
109133 suspend to RAM or power off.
134
+
110135 Otherwise the write will fail with an error.
136
+
111137 This value may be reset to 0 if the wakeup protocol is altered.