mirror of
https://github.com/AuxXxilium/linux_dsm_epyc7002.git
synced 2024-12-25 07:13:27 +07:00
54f38fcae5
Since 2017, there is an space reserved for userspace API,
created by changeset 1d596dee38 ("docs: Create a user-space API guide").
As the media subsystem was one of the first subsystems to use
Sphinx, until this patch, we were keeping things on a separate
place.
Let's just use the new location, as having all uAPI altogether
will likely make things easier for developers.
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
127 lines
2.9 KiB
ReStructuredText
127 lines
2.9 KiB
ReStructuredText
.. Permission is granted to copy, distribute and/or modify this
|
|
.. document under the terms of the GNU Free Documentation License,
|
|
.. Version 1.1 or any later version published by the Free Software
|
|
.. Foundation, with no Invariant Sections, no Front-Cover Texts
|
|
.. and no Back-Cover Texts. A copy of the license is included at
|
|
.. Documentation/userspace-api/media/fdl-appendix.rst.
|
|
..
|
|
.. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
|
|
|
|
.. include:: <isonum.txt>
|
|
|
|
.. _dvbapi:
|
|
|
|
########################
|
|
Part II - Digital TV API
|
|
########################
|
|
|
|
.. note::
|
|
|
|
This API is also known as Linux **DVB API**.
|
|
|
|
It it was originally written to support the European digital TV
|
|
standard (DVB), and later extended to support all digital TV standards.
|
|
|
|
In order to avoid confusion, within this document, it was opted to refer to
|
|
it, and to associated hardware as **Digital TV**.
|
|
|
|
The word **DVB** is reserved to be used for:
|
|
|
|
- the Digital TV API version
|
|
(e. g. DVB API version 3 or DVB API version 5);
|
|
- digital TV data types (enums, structs, defines, etc);
|
|
- digital TV device nodes (``/dev/dvb/...``);
|
|
- the European DVB standard.
|
|
|
|
**Version 5.10**
|
|
|
|
.. only:: html
|
|
|
|
.. class:: toc-title
|
|
|
|
Table of Contents
|
|
|
|
.. toctree::
|
|
:maxdepth: 5
|
|
:numbered:
|
|
|
|
intro
|
|
frontend
|
|
demux
|
|
ca
|
|
net
|
|
legacy_dvb_apis
|
|
examples
|
|
headers
|
|
|
|
|
|
**********************
|
|
Revision and Copyright
|
|
**********************
|
|
|
|
Authors:
|
|
|
|
- J. K. Metzler, Ralph <rjkm@metzlerbros.de>
|
|
|
|
- Original author of the Digital TV API documentation.
|
|
|
|
- O. C. Metzler, Marcus <rjkm@metzlerbros.de>
|
|
|
|
- Original author of the Digital TV API documentation.
|
|
|
|
- Carvalho Chehab, Mauro <mchehab+samsung@kernel.org>
|
|
|
|
- Ported document to Docbook XML, addition of DVBv5 API, documentation gaps fix.
|
|
|
|
**Copyright** |copy| 2002-2003 : Convergence GmbH
|
|
|
|
**Copyright** |copy| 2009-2017 : Mauro Carvalho Chehab
|
|
|
|
****************
|
|
Revision History
|
|
****************
|
|
|
|
:revision: 2.2.0 / 2017-09-01 (*mcc*)
|
|
|
|
Most gaps between the uAPI document and the Kernel implementation
|
|
got fixed for the non-legacy API.
|
|
|
|
:revision: 2.1.0 / 2015-05-29 (*mcc*)
|
|
|
|
DocBook improvements and cleanups, in order to document the system calls
|
|
on a more standard way and provide more description about the current
|
|
Digital TV API.
|
|
|
|
:revision: 2.0.4 / 2011-05-06 (*mcc*)
|
|
|
|
Add more information about DVBv5 API, better describing the frontend
|
|
GET/SET props ioctl's.
|
|
|
|
|
|
:revision: 2.0.3 / 2010-07-03 (*mcc*)
|
|
|
|
Add some frontend capabilities flags, present on kernel, but missing at
|
|
the specs.
|
|
|
|
|
|
:revision: 2.0.2 / 2009-10-25 (*mcc*)
|
|
|
|
documents FE_SET_FRONTEND_TUNE_MODE and
|
|
FE_DISHETWORK_SEND_LEGACY_CMD ioctls.
|
|
|
|
|
|
:revision: 2.0.1 / 2009-09-16 (*mcc*)
|
|
|
|
Added ISDB-T test originally written by Patrick Boettcher
|
|
|
|
|
|
:revision: 2.0.0 / 2009-09-06 (*mcc*)
|
|
|
|
Conversion from LaTex to DocBook XML. The contents is the same as the
|
|
original LaTex version.
|
|
|
|
|
|
:revision: 1.0.0 / 2003-07-24 (*rjkm*)
|
|
|
|
Initial revision on LaTEX.
|