^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) What: /sys/class/rc/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) Date: Apr 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) KernelVersion: 2.6.35
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) The rc/ class sub-directory belongs to the Remote Controller
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) core and provides a sysfs interface for configuring infrared
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) remote controller receivers.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) What: /sys/class/rc/rcN/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) Date: Apr 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) KernelVersion: 2.6.35
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) A /sys/class/rc/rcN directory is created for each remote
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) control receiver device where N is the number of the receiver.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) What: /sys/class/rc/rcN/protocols
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) Date: Jun 2010
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) KernelVersion: 2.6.36
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) Reading this file returns a list of available protocols,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) something like::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) "rc5 [rc6] nec jvc [sony]"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) Enabled protocols are shown in [] brackets.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) Writing "+proto" will add a protocol to the list of enabled
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) protocols.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) Writing "-proto" will remove a protocol from the list of enabled
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) protocols.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) Writing "proto" will enable only "proto".
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) Writing "none" will disable all protocols.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) Write fails with EINVAL if an invalid protocol combination or
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) unknown protocol name is used.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43) What: /sys/class/rc/rcN/filter
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) Date: Jan 2014
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) KernelVersion: 3.15
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) Sets the scancode filter expected value.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) Use in combination with /sys/class/rc/rcN/filter_mask to set the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) expected value of the bits set in the filter mask.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) If the hardware supports it then scancodes which do not match
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) the filter will be ignored. Otherwise the write will fail with
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) an error.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) This value may be reset to 0 if the current protocol is altered.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) What: /sys/class/rc/rcN/filter_mask
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) Date: Jan 2014
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) KernelVersion: 3.15
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) Sets the scancode filter mask of bits to compare.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) Use in combination with /sys/class/rc/rcN/filter to set the bits
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) of the scancode which should be compared against the expected
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) value. A value of 0 disables the filter to allow all valid
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) scancodes to be processed.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) If the hardware supports it then scancodes which do not match
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) the filter will be ignored. Otherwise the write will fail with
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) an error.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) This value may be reset to 0 if the current protocol is altered.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) What: /sys/class/rc/rcN/wakeup_protocols
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) Date: Feb 2017
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) KernelVersion: 4.11
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) Reading this file returns a list of available protocols to use
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) for the wakeup filter, something like::
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) "rc-5 nec nec-x rc-6-0 rc-6-6a-24 [rc-6-6a-32] rc-6-mce"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) Note that protocol variants are listed, so "nec", "sony",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) "rc-5", "rc-6" have their different bit length encodings
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) listed if available.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) The enabled wakeup protocol is shown in [] brackets.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) Only one protocol can be selected at a time.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) Writing "proto" will use "proto" for wakeup events.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) Writing "none" will disable wakeup.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) Write fails with EINVAL if an invalid protocol combination or
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) unknown protocol name is used, or if wakeup is not supported by
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) the hardware.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) What: /sys/class/rc/rcN/wakeup_filter
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) Date: Jan 2014
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) KernelVersion: 3.15
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) Sets the scancode wakeup filter expected value.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) Use in combination with /sys/class/rc/rcN/wakeup_filter_mask to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) set the expected value of the bits set in the wakeup filter mask
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) to trigger a system wake event.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) If the hardware supports it and wakeup_filter_mask is not 0 then
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) scancodes which match the filter will wake the system from e.g.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) suspend to RAM or power off.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) Otherwise the write will fail with an error.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) This value may be reset to 0 if the wakeup protocol is altered.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) What: /sys/class/rc/rcN/wakeup_filter_mask
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) Date: Jan 2014
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) KernelVersion: 3.15
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) Contact: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) Description:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) Sets the scancode wakeup filter mask of bits to compare.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) Use in combination with /sys/class/rc/rcN/wakeup_filter to set
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) the bits of the scancode which should be compared against the
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) expected value to trigger a system wake event.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) If the hardware supports it and wakeup_filter_mask is not 0 then
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) scancodes which match the filter will wake the system from e.g.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) suspend to RAM or power off.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) Otherwise the write will fail with an error.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) This value may be reset to 0 if the wakeup protocol is altered.