Documentation/media/v4l-drivers/v4l-with-ir.rst

   1 .. SPDX-License-Identifier: GPL-2.0
   2
   3 Infrared remote control support in video4linux drivers
   4 ======================================================
   5
   6 Authors: Gerd Hoffmann, Mauro Carvalho Chehab
   7
   8 Basics
   9 ------
  10
  11 Most analog and digital TV boards support remote controllers. Several of
  12 them have a microprocessor that receives the IR carriers, convert into
  13 pulse/space sequences and then to scan codes, returning such codes to
  14 userspace ("scancode mode"). Other boards return just the pulse/space
  15 sequences ("raw mode").
  16
  17 The support for remote controller in scancode mode is provided by the
  18 standard Linux input layer. The support for raw mode is provided via LIRC.
  19
  20 In order to check the support and test it, it is suggested to download
  21 the `v4l-utils <https://git.linuxtv.org/v4l-utils.git/>`_. It provides
  22 two tools to handle remote controllers:
  23
  24 - ir-keytable: provides a way to query the remote controller, list the
  25   protocols it supports, enable in-kernel support for IR decoder or
  26   switch the protocol and to test the reception of scan codes;
  27
  28 - ir-ctl: provide tools to handle remote controllers that support raw mode
  29   via LIRC interface.
  30
  31 Usually, the remote controller module is auto-loaded when the TV card is
  32 detected. However, for a few devices, you need to manually load the
  33 ir-kbd-i2c module.
  34
  35 How it works
  36 ------------
  37
  38 The modules register the remote as keyboard within the linux input
  39 layer, i.e. you'll see the keys of the remote as normal key strokes
  40 (if CONFIG_INPUT_KEYBOARD is enabled).
  41
  42 Using the event devices (CONFIG_INPUT_EVDEV) it is possible for
  43 applications to access the remote via /dev/input/event<n> devices.
  44 The udev/systemd will automatically create the devices. If you install
  45 the `v4l-utils <https://git.linuxtv.org/v4l-utils.git/>`_, it may also
  46 automatically load a different keytable than the default one. Please see
  47 `v4l-utils <https://git.linuxtv.org/v4l-utils.git/>`_ ir-keytable.1
  48 man page for details.
  49
  50 The ir-keytable tool is nice for trouble shooting, i.e. to check
  51 whenever the input device is really present, which of the devices it
  52 is, check whenever pressing keys on the remote actually generates
  53 events and the like.  You can also use any other input utility that changes
  54 the keymaps, like the input kbd utility.
  55
  56
  57 Using with lircd
  58 ================
  59
  60 The latest versions of the lircd daemon supports reading events from the
  61 linux input layer (via event device). It also supports receiving IR codes
  62 in lirc mode.
  63
  64
  65 Using without lircd
  66 ===================
  67
  68 Xorg recognizes several IR keycodes that have its numerical value lower
  69 than 247. With the advent of Wayland, the input driver got updated too,
  70 and should now accept all keycodes. Yet, you may want to just reasign
  71 the keycodes to something that your favorite media application likes.
  72
  73 This can be done by setting
  74 `v4l-utils <https://git.linuxtv.org/v4l-utils.git/>`_ to load your own
  75 keytable in runtime. Please read  ir-keytable.1 man page for details.