Documentation/media/uapi/dvb/net-add-if.rst

   1 .. -*- coding: utf-8; mode: rst -*-
   2
   3 .. _NET_ADD_IF:
   4
   5 ****************
   6 ioctl NET_ADD_IF
   7 ****************
   8
   9 Name
  10 ====
  11
  12 NET_ADD_IF - Creates a new network interface for a given Packet ID.
  13
  14
  15 Synopsis
  16 ========
  17
  18 .. cpp:function:: int ioctl( int fd, int request, struct dvb_net_if *net_if )
  19
  20
  21 Arguments
  22 =========
  23
  24 ``fd``
  25     File descriptor returned by :ref:`open() <frontend_f_open>`.
  26
  27 ``request``
  28     FE_SET_TONE
  29
  30 ``net_if``
  31     pointer to struct :ref:`dvb_net_if <dvb-net-if>`
  32
  33
  34 Description
  35 ===========
  36
  37 The NET_ADD_IF ioctl system call selects the Packet ID (PID) that
  38 contains a TCP/IP traffic, the type of encapsulation to be used (MPE or
  39 ULE) and the interface number for the new interface to be created. When
  40 the system call successfully returns, a new virtual network interface is
  41 created.
  42
  43 The struct :ref:`dvb_net_if <dvb-net-if>`::ifnum field will be
  44 filled with the number of the created interface.
  45
  46
  47 .. _dvb-net-if-t:
  48
  49 struct dvb_net_if description
  50 =============================
  51
  52 .. _dvb-net-if:
  53
  54 .. flat-table:: struct dvb_net_if
  55     :header-rows:  1
  56     :stub-columns: 0
  57
  58
  59     -  .. row 1
  60
  61        -  ID
  62
  63        -  Description
  64
  65     -  .. row 2
  66
  67        -  pid
  68
  69        -  Packet ID (PID) of the MPEG-TS that contains data
  70
  71     -  .. row 3
  72
  73        -  ifnum
  74
  75        -  number of the DVB interface.
  76
  77     -  .. row 4
  78
  79        -  feedtype
  80
  81        -  Encapsulation type of the feed. It can be:
  82           ``DVB_NET_FEEDTYPE_MPE`` for MPE encoding or
  83           ``DVB_NET_FEEDTYPE_ULE`` for ULE encoding.
  84
  85
  86 Return Value
  87 ============
  88
  89 On success 0 is returned, on error -1 and the ``errno`` variable is set
  90 appropriately. The generic error codes are described at the
  91 :ref:`Generic Error Codes <gen-errors>` chapter.