Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input
[sfrench/cifs-2.6.git] / Documentation / media / uapi / dvb / frontend.rst
1 .. Permission is granted to copy, distribute and/or modify this
2 .. document under the terms of the GNU Free Documentation License,
3 .. Version 1.1 or any later version published by the Free Software
4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
5 .. and no Back-Cover Texts. A copy of the license is included at
6 .. Documentation/media/uapi/fdl-appendix.rst.
7 ..
8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
9
10 .. _dvb_frontend:
11
12 #######################
13 Digital TV Frontend API
14 #######################
15
16 The Digital TV frontend API was designed to support three groups of delivery
17 systems: Terrestrial, cable and Satellite. Currently, the following
18 delivery systems are supported:
19
20 -  Terrestrial systems: DVB-T, DVB-T2, ATSC, ATSC M/H, ISDB-T, DVB-H,
21    DTMB, CMMB
22
23 -  Cable systems: DVB-C Annex A/C, ClearQAM (DVB-C Annex B)
24
25 -  Satellite systems: DVB-S, DVB-S2, DVB Turbo, ISDB-S, DSS
26
27 The Digital TV frontend controls several sub-devices including:
28
29 -  Tuner
30
31 -  Digital TV demodulator
32
33 -  Low noise amplifier (LNA)
34
35 -  Satellite Equipment Control (SEC) [#f1]_.
36
37 The frontend can be accessed through ``/dev/dvb/adapter?/frontend?``.
38 Data types and ioctl definitions can be accessed by including
39 ``linux/dvb/frontend.h`` in your application.
40
41 .. note::
42
43    Transmission via the internet (DVB-IP) and MMT (MPEG Media Transport)
44    is not yet handled by this API but a future extension is possible.
45
46 .. [#f1]
47
48    On Satellite systems, the API support for the Satellite Equipment
49    Control (SEC) allows to power control and to send/receive signals to
50    control the antenna subsystem, selecting the polarization and choosing
51    the Intermediate Frequency IF) of the Low Noise Block Converter Feed
52    Horn (LNBf). It supports the DiSEqC and V-SEC protocols. The DiSEqC
53    (digital SEC) specification is available at
54    `Eutelsat <http://www.eutelsat.com/satellites/4_5_5.html>`__.
55
56
57 .. toctree::
58     :maxdepth: 1
59
60     query-dvb-frontend-info
61     dvb-fe-read-status
62     dvbproperty
63     frontend_fcalls