From a79a0e71ae67ec9f43df9a2d2d611ab56fcef89f Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Sat, 18 Apr 2020 11:59:24 +0200 Subject: media: admin-guide: reorganize the guide Separate the generic documentation from the driver-specific parts, and use a better title for the documentation. Signed-off-by: Mauro Carvalho Chehab --- Documentation/admin-guide/media/dvb.rst | 12 ++++ Documentation/admin-guide/media/index.rst | 46 +++++++------ .../admin-guide/media/remote-controller.rst | 76 ++++++++++++++++++++++ Documentation/admin-guide/media/v4l-with-ir.rst | 75 --------------------- 4 files changed, 115 insertions(+), 94 deletions(-) create mode 100644 Documentation/admin-guide/media/dvb.rst create mode 100644 Documentation/admin-guide/media/remote-controller.rst delete mode 100644 Documentation/admin-guide/media/v4l-with-ir.rst (limited to 'Documentation/admin-guide/media') diff --git a/Documentation/admin-guide/media/dvb.rst b/Documentation/admin-guide/media/dvb.rst new file mode 100644 index 000000000000..e5258bfa5cd9 --- /dev/null +++ b/Documentation/admin-guide/media/dvb.rst @@ -0,0 +1,12 @@ +.. SPDX-License-Identifier: GPL-2.0 + +========== +Digital TV +========== + +.. toctree:: + + dvb_intro + ci + faq + dvb_references diff --git a/Documentation/admin-guide/media/index.rst b/Documentation/admin-guide/media/index.rst index dbe36e427e6b..05ddd4930699 100644 --- a/Documentation/admin-guide/media/index.rst +++ b/Documentation/admin-guide/media/index.rst @@ -2,9 +2,9 @@ .. include:: -============================ -Media subsystem usage guides -============================ +==================================== +Media subsystem admin and user guide +==================================== This section contains usage information about media subsystem and its supported drivers. @@ -18,11 +18,8 @@ Please see: for driver development information and Kernel APIs used by media devices; -.. _uapi-v4l-drivers: - -################################################ -Video4Linux (V4L) driver-specific documentation -################################################ +The media subsystem +=================== .. only:: html @@ -37,9 +34,27 @@ Video4Linux (V4L) driver-specific documentation intro building + remote-controller + + dvb + cardlist - v4l-with-ir + +.. _uapi-v4l-drivers: + +Video4Linux (V4L) driver-specific documentation +=============================================== + +.. only:: html + + .. class:: toc-title + + Table of Contents + +.. toctree:: + :maxdepth: 5 + :numbered: bttv cafe_ccic @@ -64,9 +79,8 @@ Video4Linux (V4L) driver-specific documentation vimc vivid -############################################## -Linux Digital TV driver-specific documentation -############################################## +Digital TV driver-specific documentation +======================================== .. only:: html @@ -78,11 +92,6 @@ Linux Digital TV driver-specific documentation :maxdepth: 5 :numbered: - dvb_intro - ci - faq - dvb_references - avermedia bt8xx lmedm04 @@ -91,9 +100,8 @@ Linux Digital TV driver-specific documentation ttusb-dec zr364xx -################################# CEC driver-specific documentation -################################# +================================= .. only:: html diff --git a/Documentation/admin-guide/media/remote-controller.rst b/Documentation/admin-guide/media/remote-controller.rst new file mode 100644 index 000000000000..fa05410c3cd5 --- /dev/null +++ b/Documentation/admin-guide/media/remote-controller.rst @@ -0,0 +1,76 @@ +.. SPDX-License-Identifier: GPL-2.0 + +====================================================== +Infrared remote control support in video4linux drivers +====================================================== + +Authors: Gerd Hoffmann, Mauro Carvalho Chehab + +Basics +====== + +Most analog and digital TV boards support remote controllers. Several of +them have a microprocessor that receives the IR carriers, convert into +pulse/space sequences and then to scan codes, returning such codes to +userspace ("scancode mode"). Other boards return just the pulse/space +sequences ("raw mode"). + +The support for remote controller in scancode mode is provided by the +standard Linux input layer. The support for raw mode is provided via LIRC. + +In order to check the support and test it, it is suggested to download +the `v4l-utils `_. It provides +two tools to handle remote controllers: + +- ir-keytable: provides a way to query the remote controller, list the + protocols it supports, enable in-kernel support for IR decoder or + switch the protocol and to test the reception of scan codes; + +- ir-ctl: provide tools to handle remote controllers that support raw mode + via LIRC interface. + +Usually, the remote controller module is auto-loaded when the TV card is +detected. However, for a few devices, you need to manually load the +ir-kbd-i2c module. + +How it works +============ + +The modules register the remote as keyboard within the linux input +layer, i.e. you'll see the keys of the remote as normal key strokes +(if CONFIG_INPUT_KEYBOARD is enabled). + +Using the event devices (CONFIG_INPUT_EVDEV) it is possible for +applications to access the remote via /dev/input/event devices. +The udev/systemd will automatically create the devices. If you install +the `v4l-utils `_, it may also +automatically load a different keytable than the default one. Please see +`v4l-utils `_ ir-keytable.1 +man page for details. + +The ir-keytable tool is nice for trouble shooting, i.e. to check +whenever the input device is really present, which of the devices it +is, check whenever pressing keys on the remote actually generates +events and the like. You can also use any other input utility that changes +the keymaps, like the input kbd utility. + + +Using with lircd +---------------- + +The latest versions of the lircd daemon supports reading events from the +linux input layer (via event device). It also supports receiving IR codes +in lirc mode. + + +Using without lircd +------------------- + +Xorg recognizes several IR keycodes that have its numerical value lower +than 247. With the advent of Wayland, the input driver got updated too, +and should now accept all keycodes. Yet, you may want to just reasign +the keycodes to something that your favorite media application likes. + +This can be done by setting +`v4l-utils `_ to load your own +keytable in runtime. Please read ir-keytable.1 man page for details. diff --git a/Documentation/admin-guide/media/v4l-with-ir.rst b/Documentation/admin-guide/media/v4l-with-ir.rst deleted file mode 100644 index ce23c8a7bc93..000000000000 --- a/Documentation/admin-guide/media/v4l-with-ir.rst +++ /dev/null @@ -1,75 +0,0 @@ -.. SPDX-License-Identifier: GPL-2.0 - -Infrared remote control support in video4linux drivers -====================================================== - -Authors: Gerd Hoffmann, Mauro Carvalho Chehab - -Basics ------- - -Most analog and digital TV boards support remote controllers. Several of -them have a microprocessor that receives the IR carriers, convert into -pulse/space sequences and then to scan codes, returning such codes to -userspace ("scancode mode"). Other boards return just the pulse/space -sequences ("raw mode"). - -The support for remote controller in scancode mode is provided by the -standard Linux input layer. The support for raw mode is provided via LIRC. - -In order to check the support and test it, it is suggested to download -the `v4l-utils `_. It provides -two tools to handle remote controllers: - -- ir-keytable: provides a way to query the remote controller, list the - protocols it supports, enable in-kernel support for IR decoder or - switch the protocol and to test the reception of scan codes; - -- ir-ctl: provide tools to handle remote controllers that support raw mode - via LIRC interface. - -Usually, the remote controller module is auto-loaded when the TV card is -detected. However, for a few devices, you need to manually load the -ir-kbd-i2c module. - -How it works ------------- - -The modules register the remote as keyboard within the linux input -layer, i.e. you'll see the keys of the remote as normal key strokes -(if CONFIG_INPUT_KEYBOARD is enabled). - -Using the event devices (CONFIG_INPUT_EVDEV) it is possible for -applications to access the remote via /dev/input/event devices. -The udev/systemd will automatically create the devices. If you install -the `v4l-utils `_, it may also -automatically load a different keytable than the default one. Please see -`v4l-utils `_ ir-keytable.1 -man page for details. - -The ir-keytable tool is nice for trouble shooting, i.e. to check -whenever the input device is really present, which of the devices it -is, check whenever pressing keys on the remote actually generates -events and the like. You can also use any other input utility that changes -the keymaps, like the input kbd utility. - - -Using with lircd -================ - -The latest versions of the lircd daemon supports reading events from the -linux input layer (via event device). It also supports receiving IR codes -in lirc mode. - - -Using without lircd -=================== - -Xorg recognizes several IR keycodes that have its numerical value lower -than 247. With the advent of Wayland, the input driver got updated too, -and should now accept all keycodes. Yet, you may want to just reasign -the keycodes to something that your favorite media application likes. - -This can be done by setting -`v4l-utils `_ to load your own -keytable in runtime. Please read ir-keytable.1 man page for details. -- cgit v1.2.3