Debian Codegraph @

Documentation/userspace-api/media/dvb/dvbapi.rst

raw
1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
2 .. include:: <isonum.txt>
3
4 .. _dvbapi:
5
6 ########################
7 Part 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 .. toctree::
31 :caption: Table of Contents
32 :maxdepth: 5
33 :numbered:
34
35 intro
36 frontend
37 demux
38 ca
39 net
40 legacy_dvb_apis
41 examples
42 headers
43
44
45 **********************
46 Revision and Copyright
47 **********************
48
49 Authors:
50
51 - J. K. Metzler, Ralph <[email protected]>
52
53 - Original author of the Digital TV API documentation.
54
55 - O. C. Metzler, Marcus <[email protected]>
56
57 - Original author of the Digital TV API documentation.
58
59 - Carvalho Chehab, Mauro <[email protected]>
60
61 - Ported document to Docbook XML, addition of DVBv5 API, documentation gaps fix.
62
63 **Copyright** |copy| 2002-2003 : Convergence GmbH
64
65 **Copyright** |copy| 2009-2017 : Mauro Carvalho Chehab
66
67 ****************
68 Revision History
69 ****************
70
71 :revision: 2.2.0 / 2017-09-01 (*mcc*)
72
73 Most gaps between the uAPI document and the Kernel implementation
74 got fixed for the non-legacy API.
75
76 :revision: 2.1.0 / 2015-05-29 (*mcc*)
77
78 DocBook improvements and cleanups, in order to document the system calls
79 on a more standard way and provide more description about the current
80 Digital TV API.
81
82 :revision: 2.0.4 / 2011-05-06 (*mcc*)
83
84 Add more information about DVBv5 API, better describing the frontend
85 GET/SET props ioctl's.
86
87
88 :revision: 2.0.3 / 2010-07-03 (*mcc*)
89
90 Add some frontend capabilities flags, present on kernel, but missing at
91 the specs.
92
93
94 :revision: 2.0.2 / 2009-10-25 (*mcc*)
95
96 documents FE_SET_FRONTEND_TUNE_MODE and
97 FE_DISHETWORK_SEND_LEGACY_CMD ioctls.
98
99
100 :revision: 2.0.1 / 2009-09-16 (*mcc*)
101
102 Added ISDB-T test originally written by Patrick Boettcher
103
104
105 :revision: 2.0.0 / 2009-09-06 (*mcc*)
106
107 Conversion from LaTex to DocBook XML. The contents is the same as the
108 original LaTex version.
109
110
111 :revision: 1.0.0 / 2003-07-24 (*rjkm*)
112
113 Initial revision on LaTEX.