Documentation/media/uapi/dvb/net.rst

   1 .. Permission is granted to copy, distribute and/or modify this
   2 .. document under the terms of the GNU Free Documentation License,
   3 .. Version 1.1 or any later version published by the Free Software
   4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
   5 .. and no Back-Cover Texts. A copy of the license is included at
   6 .. Documentation/media/uapi/fdl-appendix.rst.
   7 ..
   8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
   9
  10 .. _net:
  11
  12 ######################
  13 Digital TV Network API
  14 ######################
  15
  16 The Digital TV net device controls the mapping of data packages that are part
  17 of a transport stream to be mapped into a virtual network interface,
  18 visible through the standard Linux network protocol stack.
  19
  20 Currently, two encapsulations are supported:
  21
  22 -  `Multi Protocol Encapsulation (MPE) <http://en.wikipedia.org/wiki/Multiprotocol_Encapsulation>`__
  23
  24 -  `Ultra Lightweight Encapsulation (ULE) <http://en.wikipedia.org/wiki/Unidirectional_Lightweight_Encapsulation>`__
  25
  26 In order to create the Linux virtual network interfaces, an application
  27 needs to tell to the Kernel what are the PIDs and the encapsulation
  28 types that are present on the transport stream. This is done through
  29 ``/dev/dvb/adapter?/net?`` device node. The data will be available via
  30 virtual ``dvb?_?`` network interfaces, and will be controlled/routed via
  31 the standard ip tools (like ip, route, netstat, ifconfig, etc).
  32
  33 Data types and and ioctl definitions are defined via ``linux/dvb/net.h``
  34 header.
  35
  36
  37 .. _net_fcalls:
  38
  39 Digital TV net Function Calls
  40 #############################
  41
  42 .. toctree::
  43     :maxdepth: 1
  44
  45     net-types
  46     net-add-if
  47     net-remove-if
  48     net-get-if