Documentation/media/uapi/dvb/dvbapi.rst

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