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