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