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