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 <mchehab+huawei@kernel.org>
This commit is contained in:
Mauro Carvalho Chehab 2020-04-18 11:59:24 +02:00
parent f45ce7a1e5
commit a79a0e71ae
3 changed files with 44 additions and 23 deletions

View File

@ -0,0 +1,12 @@
.. SPDX-License-Identifier: GPL-2.0
==========
Digital TV
==========
.. toctree::
dvb_intro
ci
faq
dvb_references

View File

@ -2,9 +2,9 @@
.. include:: <isonum.txt> .. include:: <isonum.txt>
============================ ====================================
Media subsystem usage guides Media subsystem admin and user guide
============================ ====================================
This section contains usage information about media subsystem and This section contains usage information about media subsystem and
its supported drivers. its supported drivers.
@ -18,11 +18,8 @@ Please see:
for driver development information and Kernel APIs used by for driver development information and Kernel APIs used by
media devices; media devices;
.. _uapi-v4l-drivers: The media subsystem
===================
################################################
Video4Linux (V4L) driver-specific documentation
################################################
.. only:: html .. only:: html
@ -37,9 +34,27 @@ Video4Linux (V4L) driver-specific documentation
intro intro
building building
remote-controller
dvb
cardlist 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 bttv
cafe_ccic cafe_ccic
@ -64,9 +79,8 @@ Video4Linux (V4L) driver-specific documentation
vimc vimc
vivid vivid
############################################## Digital TV driver-specific documentation
Linux Digital TV driver-specific documentation ========================================
##############################################
.. only:: html .. only:: html
@ -78,11 +92,6 @@ Linux Digital TV driver-specific documentation
:maxdepth: 5 :maxdepth: 5
:numbered: :numbered:
dvb_intro
ci
faq
dvb_references
avermedia avermedia
bt8xx bt8xx
lmedm04 lmedm04
@ -91,9 +100,8 @@ Linux Digital TV driver-specific documentation
ttusb-dec ttusb-dec
zr364xx zr364xx
#################################
CEC driver-specific documentation CEC driver-specific documentation
################################# =================================
.. only:: html .. only:: html

View File

@ -1,12 +1,13 @@
.. SPDX-License-Identifier: GPL-2.0 .. SPDX-License-Identifier: GPL-2.0
======================================================
Infrared remote control support in video4linux drivers Infrared remote control support in video4linux drivers
====================================================== ======================================================
Authors: Gerd Hoffmann, Mauro Carvalho Chehab Authors: Gerd Hoffmann, Mauro Carvalho Chehab
Basics Basics
------ ======
Most analog and digital TV boards support remote controllers. Several of Most analog and digital TV boards support remote controllers. Several of
them have a microprocessor that receives the IR carriers, convert into them have a microprocessor that receives the IR carriers, convert into
@ -33,7 +34,7 @@ detected. However, for a few devices, you need to manually load the
ir-kbd-i2c module. ir-kbd-i2c module.
How it works How it works
------------ ============
The modules register the remote as keyboard within the linux input 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 layer, i.e. you'll see the keys of the remote as normal key strokes
@ -55,7 +56,7 @@ the keymaps, like the input kbd utility.
Using with lircd Using with lircd
================ ----------------
The latest versions of the lircd daemon supports reading events from the The latest versions of the lircd daemon supports reading events from the
linux input layer (via event device). It also supports receiving IR codes linux input layer (via event device). It also supports receiving IR codes
@ -63,7 +64,7 @@ in lirc mode.
Using without lircd Using without lircd
=================== -------------------
Xorg recognizes several IR keycodes that have its numerical value lower Xorg recognizes several IR keycodes that have its numerical value lower
than 247. With the advent of Wayland, the input driver got updated too, than 247. With the advent of Wayland, the input driver got updated too,