xref: /linux/Documentation/ABI/testing/sysfs-class-rc (revision ab88c66deace78989aa71cb139284cf7fb227ba4)
17bae8979SJames HoganWhat:		/sys/class/rc/
27bae8979SJames HoganDate:		Apr 2010
37bae8979SJames HoganKernelVersion:	2.6.35
47bae8979SJames HoganContact:	Mauro Carvalho Chehab <m.chehab@samsung.com>
57bae8979SJames HoganDescription:
67bae8979SJames Hogan		The rc/ class sub-directory belongs to the Remote Controller
77bae8979SJames Hogan		core and provides a sysfs interface for configuring infrared
87bae8979SJames Hogan		remote controller receivers.
97bae8979SJames Hogan
107bae8979SJames HoganWhat:		/sys/class/rc/rcN/
117bae8979SJames HoganDate:		Apr 2010
127bae8979SJames HoganKernelVersion:	2.6.35
137bae8979SJames HoganContact:	Mauro Carvalho Chehab <m.chehab@samsung.com>
147bae8979SJames HoganDescription:
157bae8979SJames Hogan		A /sys/class/rc/rcN directory is created for each remote
167bae8979SJames Hogan		control receiver device where N is the number of the receiver.
177bae8979SJames Hogan
187bae8979SJames HoganWhat:		/sys/class/rc/rcN/protocols
197bae8979SJames HoganDate:		Jun 2010
207bae8979SJames HoganKernelVersion:	2.6.36
217bae8979SJames HoganContact:	Mauro Carvalho Chehab <m.chehab@samsung.com>
227bae8979SJames HoganDescription:
237bae8979SJames Hogan		Reading this file returns a list of available protocols,
247bae8979SJames Hogan		something like:
257bae8979SJames Hogan		    "rc5 [rc6] nec jvc [sony]"
267bae8979SJames Hogan		Enabled protocols are shown in [] brackets.
277bae8979SJames Hogan		Writing "+proto" will add a protocol to the list of enabled
287bae8979SJames Hogan		protocols.
297bae8979SJames Hogan		Writing "-proto" will remove a protocol from the list of enabled
307bae8979SJames Hogan		protocols.
317bae8979SJames Hogan		Writing "proto" will enable only "proto".
327bae8979SJames Hogan		Writing "none" will disable all protocols.
337bae8979SJames Hogan		Write fails with EINVAL if an invalid protocol combination or
347bae8979SJames Hogan		unknown protocol name is used.
3500942d1aSJames Hogan
3600942d1aSJames HoganWhat:		/sys/class/rc/rcN/filter
3700942d1aSJames HoganDate:		Jan 2014
3800942d1aSJames HoganKernelVersion:	3.15
3900942d1aSJames HoganContact:	Mauro Carvalho Chehab <m.chehab@samsung.com>
4000942d1aSJames HoganDescription:
4100942d1aSJames Hogan		Sets the scancode filter expected value.
4200942d1aSJames Hogan		Use in combination with /sys/class/rc/rcN/filter_mask to set the
4300942d1aSJames Hogan		expected value of the bits set in the filter mask.
4400942d1aSJames Hogan		If the hardware supports it then scancodes which do not match
4500942d1aSJames Hogan		the filter will be ignored. Otherwise the write will fail with
4600942d1aSJames Hogan		an error.
4700942d1aSJames Hogan		This value may be reset to 0 if the current protocol is altered.
4800942d1aSJames Hogan
4900942d1aSJames HoganWhat:		/sys/class/rc/rcN/filter_mask
5000942d1aSJames HoganDate:		Jan 2014
5100942d1aSJames HoganKernelVersion:	3.15
5200942d1aSJames HoganContact:	Mauro Carvalho Chehab <m.chehab@samsung.com>
5300942d1aSJames HoganDescription:
5400942d1aSJames Hogan		Sets the scancode filter mask of bits to compare.
5500942d1aSJames Hogan		Use in combination with /sys/class/rc/rcN/filter to set the bits
5600942d1aSJames Hogan		of the scancode which should be compared against the expected
5700942d1aSJames Hogan		value. A value of 0 disables the filter to allow all valid
5800942d1aSJames Hogan		scancodes to be processed.
5900942d1aSJames Hogan		If the hardware supports it then scancodes which do not match
6000942d1aSJames Hogan		the filter will be ignored. Otherwise the write will fail with
6100942d1aSJames Hogan		an error.
6200942d1aSJames Hogan		This value may be reset to 0 if the current protocol is altered.
6300942d1aSJames Hogan
64*ab88c66dSJames HoganWhat:		/sys/class/rc/rcN/wakeup_protocols
65*ab88c66dSJames HoganDate:		Feb 2014
66*ab88c66dSJames HoganKernelVersion:	3.15
67*ab88c66dSJames HoganContact:	Mauro Carvalho Chehab <m.chehab@samsung.com>
68*ab88c66dSJames HoganDescription:
69*ab88c66dSJames Hogan		Reading this file returns a list of available protocols to use
70*ab88c66dSJames Hogan		for the wakeup filter, something like:
71*ab88c66dSJames Hogan		    "rc5 rc6 nec jvc [sony]"
72*ab88c66dSJames Hogan		The enabled wakeup protocol is shown in [] brackets.
73*ab88c66dSJames Hogan		Writing "+proto" will add a protocol to the list of enabled
74*ab88c66dSJames Hogan		wakeup protocols.
75*ab88c66dSJames Hogan		Writing "-proto" will remove a protocol from the list of enabled
76*ab88c66dSJames Hogan		wakeup protocols.
77*ab88c66dSJames Hogan		Writing "proto" will use "proto" for wakeup events.
78*ab88c66dSJames Hogan		Writing "none" will disable wakeup.
79*ab88c66dSJames Hogan		Write fails with EINVAL if an invalid protocol combination or
80*ab88c66dSJames Hogan		unknown protocol name is used, or if wakeup is not supported by
81*ab88c66dSJames Hogan		the hardware.
82*ab88c66dSJames Hogan
8300942d1aSJames HoganWhat:		/sys/class/rc/rcN/wakeup_filter
8400942d1aSJames HoganDate:		Jan 2014
8500942d1aSJames HoganKernelVersion:	3.15
8600942d1aSJames HoganContact:	Mauro Carvalho Chehab <m.chehab@samsung.com>
8700942d1aSJames HoganDescription:
8800942d1aSJames Hogan		Sets the scancode wakeup filter expected value.
8900942d1aSJames Hogan		Use in combination with /sys/class/rc/rcN/wakeup_filter_mask to
9000942d1aSJames Hogan		set the expected value of the bits set in the wakeup filter mask
9100942d1aSJames Hogan		to trigger a system wake event.
9200942d1aSJames Hogan		If the hardware supports it and wakeup_filter_mask is not 0 then
9300942d1aSJames Hogan		scancodes which match the filter will wake the system from e.g.
9400942d1aSJames Hogan		suspend to RAM or power off.
9500942d1aSJames Hogan		Otherwise the write will fail with an error.
96*ab88c66dSJames Hogan		This value may be reset to 0 if the wakeup protocol is altered.
9700942d1aSJames Hogan
9800942d1aSJames HoganWhat:		/sys/class/rc/rcN/wakeup_filter_mask
9900942d1aSJames HoganDate:		Jan 2014
10000942d1aSJames HoganKernelVersion:	3.15
10100942d1aSJames HoganContact:	Mauro Carvalho Chehab <m.chehab@samsung.com>
10200942d1aSJames HoganDescription:
10300942d1aSJames Hogan		Sets the scancode wakeup filter mask of bits to compare.
10400942d1aSJames Hogan		Use in combination with /sys/class/rc/rcN/wakeup_filter to set
10500942d1aSJames Hogan		the bits of the scancode which should be compared against the
10600942d1aSJames Hogan		expected value to trigger a system wake event.
10700942d1aSJames Hogan		If the hardware supports it and wakeup_filter_mask is not 0 then
10800942d1aSJames Hogan		scancodes which match the filter will wake the system from e.g.
10900942d1aSJames Hogan		suspend to RAM or power off.
11000942d1aSJames Hogan		Otherwise the write will fail with an error.
111*ab88c66dSJames Hogan		This value may be reset to 0 if the wakeup protocol is altered.
112