dvbapi.rst 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
  2. .. include:: <isonum.txt>
  3. .. _dvbapi:
  4. ########################
  5. Part II - Digital TV API
  6. ########################
  7. .. note::
  8. This API is also known as Linux **DVB API**.
  9. It it was originally written to support the European digital TV
  10. standard (DVB), and later extended to support all digital TV standards.
  11. In order to avoid confusion, within this document, it was opted to refer to
  12. it, and to associated hardware as **Digital TV**.
  13. The word **DVB** is reserved to be used for:
  14. - the Digital TV API version
  15. (e. g. DVB API version 3 or DVB API version 5);
  16. - digital TV data types (enums, structs, defines, etc);
  17. - digital TV device nodes (``/dev/dvb/...``);
  18. - the European DVB standard.
  19. **Version 5.10**
  20. .. toctree::
  21. :caption: Table of Contents
  22. :maxdepth: 5
  23. :numbered:
  24. intro
  25. frontend
  26. demux
  27. ca
  28. net
  29. legacy_dvb_apis
  30. examples
  31. headers
  32. **********************
  33. Revision and Copyright
  34. **********************
  35. Authors:
  36. - J. K. Metzler, Ralph <rjkm@metzlerbros.de>
  37. - Original author of the Digital TV API documentation.
  38. - O. C. Metzler, Marcus <rjkm@metzlerbros.de>
  39. - Original author of the Digital TV API documentation.
  40. - Carvalho Chehab, Mauro <mchehab+samsung@kernel.org>
  41. - Ported document to Docbook XML, addition of DVBv5 API, documentation gaps fix.
  42. **Copyright** |copy| 2002-2003 : Convergence GmbH
  43. **Copyright** |copy| 2009-2017 : Mauro Carvalho Chehab
  44. ****************
  45. Revision History
  46. ****************
  47. :revision: 2.2.0 / 2017-09-01 (*mcc*)
  48. Most gaps between the uAPI document and the Kernel implementation
  49. got fixed for the non-legacy API.
  50. :revision: 2.1.0 / 2015-05-29 (*mcc*)
  51. DocBook improvements and cleanups, in order to document the system calls
  52. on a more standard way and provide more description about the current
  53. Digital TV API.
  54. :revision: 2.0.4 / 2011-05-06 (*mcc*)
  55. Add more information about DVBv5 API, better describing the frontend
  56. GET/SET props ioctl's.
  57. :revision: 2.0.3 / 2010-07-03 (*mcc*)
  58. Add some frontend capabilities flags, present on kernel, but missing at
  59. the specs.
  60. :revision: 2.0.2 / 2009-10-25 (*mcc*)
  61. documents FE_SET_FRONTEND_TUNE_MODE and
  62. FE_DISHETWORK_SEND_LEGACY_CMD ioctls.
  63. :revision: 2.0.1 / 2009-09-16 (*mcc*)
  64. Added ISDB-T test originally written by Patrick Boettcher
  65. :revision: 2.0.0 / 2009-09-06 (*mcc*)
  66. Conversion from LaTex to DocBook XML. The contents is the same as the
  67. original LaTex version.
  68. :revision: 1.0.0 / 2003-07-24 (*rjkm*)
  69. Initial revision on LaTEX.