blob: b65674da43bb596b81dd4d29792774e0630bfe9d [file] [log] [blame]
James Hogan7bae8972014-01-17 10:58:46 -03001What: /sys/class/rc/
2Date: Apr 2010
3KernelVersion: 2.6.35
4Contact: Mauro Carvalho Chehab <m.chehab@samsung.com>
5Description:
6 The rc/ class sub-directory belongs to the Remote Controller
7 core and provides a sysfs interface for configuring infrared
8 remote controller receivers.
9
10What: /sys/class/rc/rcN/
11Date: Apr 2010
12KernelVersion: 2.6.35
13Contact: Mauro Carvalho Chehab <m.chehab@samsung.com>
14Description:
15 A /sys/class/rc/rcN directory is created for each remote
16 control receiver device where N is the number of the receiver.
17
18What: /sys/class/rc/rcN/protocols
19Date: Jun 2010
20KernelVersion: 2.6.36
21Contact: Mauro Carvalho Chehab <m.chehab@samsung.com>
22Description:
23 Reading this file returns a list of available protocols,
24 something like:
25 "rc5 [rc6] nec jvc [sony]"
26 Enabled protocols are shown in [] brackets.
27 Writing "+proto" will add a protocol to the list of enabled
28 protocols.
29 Writing "-proto" will remove a protocol from the list of enabled
30 protocols.
31 Writing "proto" will enable only "proto".
32 Writing "none" will disable all protocols.
33 Write fails with EINVAL if an invalid protocol combination or
34 unknown protocol name is used.
James Hogan00942d12014-01-17 10:58:49 -030035
36What: /sys/class/rc/rcN/filter
37Date: Jan 2014
38KernelVersion: 3.15
39Contact: Mauro Carvalho Chehab <m.chehab@samsung.com>
40Description:
41 Sets the scancode filter expected value.
42 Use in combination with /sys/class/rc/rcN/filter_mask to set the
43 expected value of the bits set in the filter mask.
44 If the hardware supports it then scancodes which do not match
45 the filter will be ignored. Otherwise the write will fail with
46 an error.
47 This value may be reset to 0 if the current protocol is altered.
48
49What: /sys/class/rc/rcN/filter_mask
50Date: Jan 2014
51KernelVersion: 3.15
52Contact: Mauro Carvalho Chehab <m.chehab@samsung.com>
53Description:
54 Sets the scancode filter mask of bits to compare.
55 Use in combination with /sys/class/rc/rcN/filter to set the bits
56 of the scancode which should be compared against the expected
57 value. A value of 0 disables the filter to allow all valid
58 scancodes to be processed.
59 If the hardware supports it then scancodes which do not match
60 the filter will be ignored. Otherwise the write will fail with
61 an error.
62 This value may be reset to 0 if the current protocol is altered.
63
James Hoganab88c662014-02-28 20:17:05 -030064What: /sys/class/rc/rcN/wakeup_protocols
65Date: Feb 2014
66KernelVersion: 3.15
67Contact: Mauro Carvalho Chehab <m.chehab@samsung.com>
68Description:
69 Reading this file returns a list of available protocols to use
70 for the wakeup filter, something like:
71 "rc5 rc6 nec jvc [sony]"
72 The enabled wakeup protocol is shown in [] brackets.
73 Writing "+proto" will add a protocol to the list of enabled
74 wakeup protocols.
75 Writing "-proto" will remove a protocol from the list of enabled
76 wakeup protocols.
77 Writing "proto" will use "proto" for wakeup events.
78 Writing "none" will disable wakeup.
79 Write fails with EINVAL if an invalid protocol combination or
80 unknown protocol name is used, or if wakeup is not supported by
81 the hardware.
82
James Hogan00942d12014-01-17 10:58:49 -030083What: /sys/class/rc/rcN/wakeup_filter
84Date: Jan 2014
85KernelVersion: 3.15
86Contact: Mauro Carvalho Chehab <m.chehab@samsung.com>
87Description:
88 Sets the scancode wakeup filter expected value.
89 Use in combination with /sys/class/rc/rcN/wakeup_filter_mask to
90 set the expected value of the bits set in the wakeup filter mask
91 to trigger a system wake event.
92 If the hardware supports it and wakeup_filter_mask is not 0 then
93 scancodes which match the filter will wake the system from e.g.
94 suspend to RAM or power off.
95 Otherwise the write will fail with an error.
James Hoganab88c662014-02-28 20:17:05 -030096 This value may be reset to 0 if the wakeup protocol is altered.
James Hogan00942d12014-01-17 10:58:49 -030097
98What: /sys/class/rc/rcN/wakeup_filter_mask
99Date: Jan 2014
100KernelVersion: 3.15
101Contact: Mauro Carvalho Chehab <m.chehab@samsung.com>
102Description:
103 Sets the scancode wakeup filter mask of bits to compare.
104 Use in combination with /sys/class/rc/rcN/wakeup_filter to set
105 the bits of the scancode which should be compared against the
106 expected value to trigger a system wake event.
107 If the hardware supports it and wakeup_filter_mask is not 0 then
108 scancodes which match the filter will wake the system from e.g.
109 suspend to RAM or power off.
110 Otherwise the write will fail with an error.
James Hoganab88c662014-02-28 20:17:05 -0300111 This value may be reset to 0 if the wakeup protocol is altered.