xref: /linux/Documentation/userspace-api/media/dvb/dvbapi.rst (revision 0526b56cbc3c489642bd6a5fe4b718dea7ef0ee8) 
1.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2.. include:: <isonum.txt>
3
4.. _dvbapi:
5
6########################
7Part II - Digital TV API
8########################
9
10.. note::
11
12   This API is also known as Linux **DVB API**.
13
14   It it was originally written to support the European digital TV
15   standard (DVB), and later extended to support all digital TV standards.
16
17   In order to avoid confusion, within this document, it was opted to refer to
18   it, and to associated hardware as **Digital TV**.
19
20   The word **DVB** is reserved to be used for:
21
22     - the Digital TV API version
23       (e. g. DVB API version 3 or DVB API version 5);
24     - digital TV data types (enums, structs, defines, etc);
25     - digital TV device nodes (``/dev/dvb/...``);
26     - the European DVB standard.
27
28**Version 5.10**
29
30.. only:: html
31
32   .. class:: toc-title
33
34        Table of Contents
35
36.. toctree::
37    :maxdepth: 5
38    :numbered:
39
40    intro
41    frontend
42    demux
43    ca
44    net
45    legacy_dvb_apis
46    examples
47    headers
48
49
50**********************
51Revision and Copyright
52**********************
53
54Authors:
55
56- J. K. Metzler, Ralph <rjkm@metzlerbros.de>
57
58 - Original author of the Digital TV API documentation.
59
60- O. C. Metzler, Marcus <rjkm@metzlerbros.de>
61
62 - Original author of the Digital TV API documentation.
63
64- Carvalho Chehab, Mauro <mchehab+samsung@kernel.org>
65
66 - Ported document to Docbook XML, addition of DVBv5 API, documentation gaps fix.
67
68**Copyright** |copy| 2002-2003 : Convergence GmbH
69
70**Copyright** |copy| 2009-2017 : Mauro Carvalho Chehab
71
72****************
73Revision History
74****************
75
76:revision: 2.2.0 / 2017-09-01 (*mcc*)
77
78Most gaps between the uAPI document and the Kernel implementation
79got fixed for the non-legacy API.
80
81:revision: 2.1.0 / 2015-05-29 (*mcc*)
82
83DocBook improvements and cleanups, in order to document the system calls
84on a more standard way and provide more description about the current
85Digital TV API.
86
87:revision: 2.0.4 / 2011-05-06 (*mcc*)
88
89Add more information about DVBv5 API, better describing the frontend
90GET/SET props ioctl's.
91
92
93:revision: 2.0.3 / 2010-07-03 (*mcc*)
94
95Add some frontend capabilities flags, present on kernel, but missing at
96the specs.
97
98
99:revision: 2.0.2 / 2009-10-25 (*mcc*)
100
101documents FE_SET_FRONTEND_TUNE_MODE and
102FE_DISHETWORK_SEND_LEGACY_CMD ioctls.
103
104
105:revision: 2.0.1 / 2009-09-16 (*mcc*)
106
107Added ISDB-T test originally written by Patrick Boettcher
108
109
110:revision: 2.0.0 / 2009-09-06 (*mcc*)
111
112Conversion from LaTex to DocBook XML. The contents is the same as the
113original LaTex version.
114
115
116:revision: 1.0.0 / 2003-07-24 (*rjkm*)
117
118Initial revision on LaTEX.
119