Commit a79a0e71 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

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: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
parent f45ce7a1
Loading
Loading
Loading
Loading
+12 −0
Original line number Diff line number Diff line
.. SPDX-License-Identifier: GPL-2.0

==========
Digital TV
==========

.. toctree::

	dvb_intro
	ci
	faq
	dvb_references
+27 −19
Original line number Diff line number Diff line
@@ -2,9 +2,9 @@

.. include:: <isonum.txt>

============================
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

+5 −4
Original line number Diff line number Diff line
.. 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
@@ -33,7 +34,7 @@ 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
@@ -55,7 +56,7 @@ 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
@@ -63,7 +64,7 @@ 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,