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>
49 lines
1.6 KiB
ReStructuredText
49 lines
1.6 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
|
|
|
|
.. _net:
|
|
|
|
######################
|
|
Digital TV Network API
|
|
######################
|
|
|
|
The Digital TV net device controls the mapping of data packages that are part
|
|
of a transport stream to be mapped into a virtual network interface,
|
|
visible through the standard Linux network protocol stack.
|
|
|
|
Currently, two encapsulations are supported:
|
|
|
|
- `Multi Protocol Encapsulation (MPE) <http://en.wikipedia.org/wiki/Multiprotocol_Encapsulation>`__
|
|
|
|
- `Ultra Lightweight Encapsulation (ULE) <http://en.wikipedia.org/wiki/Unidirectional_Lightweight_Encapsulation>`__
|
|
|
|
In order to create the Linux virtual network interfaces, an application
|
|
needs to tell to the Kernel what are the PIDs and the encapsulation
|
|
types that are present on the transport stream. This is done through
|
|
``/dev/dvb/adapter?/net?`` device node. The data will be available via
|
|
virtual ``dvb?_?`` network interfaces, and will be controlled/routed via
|
|
the standard ip tools (like ip, route, netstat, ifconfig, etc).
|
|
|
|
Data types and and ioctl definitions are defined via ``linux/dvb/net.h``
|
|
header.
|
|
|
|
|
|
.. _net_fcalls:
|
|
|
|
Digital TV net Function Calls
|
|
#############################
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
net-types
|
|
net-add-if
|
|
net-remove-if
|
|
net-get-if
|