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 .. c:function:: int ioctl( int fd, NET_ADD_IF, struct dvb_net_if *net_if )
  19     :name: NET_ADD_IF
  20
  21
  22 Arguments
  23 =========
  24
  25 ``fd``
  26     File descriptor returned by :ref:`open() <frontend_f_open>`.
  27
  28 ``net_if``
  29     pointer to struct :c:type:`dvb_net_if`
  30
  31
  32 Description
  33 ===========
  34
  35 The NET_ADD_IF ioctl system call selects the Packet ID (PID) that
  36 contains a TCP/IP traffic, the type of encapsulation to be used (MPE or
  37 ULE) and the interface number for the new interface to be created. When
  38 the system call successfully returns, a new virtual network interface is
  39 created.
  40
  41 The struct :c:type:`dvb_net_if`::ifnum field will be
  42 filled with the number of the created interface.
  43
  44 Return Value
  45 ============
  46
  47 On success 0 is returned, and :c:type:`ca_slot_info` is filled.
  48
  49 On error -1 is returned, and the ``errno`` variable is set
  50 appropriately.
  51
  52 The generic error codes are described at the
  53 :ref:`Generic Error Codes <gen-errors>` chapter.