Documentation/ABI/testing/sysfs-class-rc

   1 What:           /sys/class/rc/
   2 Date:           Apr 2010
   3 KernelVersion:  2.6.35
   4 Contact:        Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
   5 Description:
   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
  10 What:           /sys/class/rc/rcN/
  11 Date:           Apr 2010
  12 KernelVersion:  2.6.35
  13 Contact:        Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
  14 Description:
  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
  18 What:           /sys/class/rc/rcN/protocols
  19 Date:           Jun 2010
  20 KernelVersion:  2.6.36
  21 Contact:        Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
  22 Description:
  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.
  35
  36 What:           /sys/class/rc/rcN/filter
  37 Date:           Jan 2014
  38 KernelVersion:  3.15
  39 Contact:        Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
  40 Description:
  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
  49 What:           /sys/class/rc/rcN/filter_mask
  50 Date:           Jan 2014
  51 KernelVersion:  3.15
  52 Contact:        Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
  53 Description:
  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
  64 What:           /sys/class/rc/rcN/wakeup_protocols
  65 Date:           Feb 2017
  66 KernelVersion:  4.11
  67 Contact:        Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
  68 Description:
  69                 Reading this file returns a list of available protocols to use
  70                 for the wakeup filter, something like:
  71                     "rc-5 nec nec-x rc-6-0 rc-6-6a-24 [rc-6-6a-32] rc-6-mce"
  72                 Note that protocol variants are listed, so "nec", "sony",
  73                 "rc-5", "rc-6" have their different bit length encodings
  74                 listed if available.
  75                 The enabled wakeup protocol is shown in [] brackets.
  76                 Only one protocol can be selected at a time.
  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
  83 What:           /sys/class/rc/rcN/wakeup_filter
  84 Date:           Jan 2014
  85 KernelVersion:  3.15
  86 Contact:        Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
  87 Description:
  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.
  96                 This value may be reset to 0 if the wakeup protocol is altered.
  97
  98 What:           /sys/class/rc/rcN/wakeup_filter_mask
  99 Date:           Jan 2014
 100 KernelVersion:  3.15
 101 Contact:        Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
 102 Description:
 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.
 111                 This value may be reset to 0 if the wakeup protocol is altered.