Documentation/userspace-api/media/dvb/net-add-if.rst

   1 .. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later
   2 .. c:namespace:: DTV.net
   3
   4 .. _NET_ADD_IF:
   5
   6 ****************
   7 ioctl NET_ADD_IF
   8 ****************
   9
  10 Name
  11 ====
  12
  13 NET_ADD_IF - Creates a new network interface for a given Packet ID.
  14
  15 Synopsis
  16 ========
  17
  18 .. c:macro:: NET_ADD_IF
  19
  20 ``int ioctl(int fd, NET_ADD_IF, struct dvb_net_if *net_if)``
  21
  22 Arguments
  23 =========
  24
  25 ``fd``
  26     File descriptor returned by :c:func:`open()`.
  27
  28 ``net_if``
  29     pointer to struct :c:type:`dvb_net_if`
  30
  31 Description
  32 ===========
  33
  34 The NET_ADD_IF ioctl system call selects the Packet ID (PID) that
  35 contains a TCP/IP traffic, the type of encapsulation to be used (MPE or
  36 ULE) and the interface number for the new interface to be created. When
  37 the system call successfully returns, a new virtual network interface is
  38 created.
  39
  40 The struct :c:type:`dvb_net_if`::ifnum field will be
  41 filled with the number of the created interface.
  42
  43 Return Value
  44 ============
  45
  46 On success 0 is returned, and :c:type:`ca_slot_info` is filled.
  47
  48 On error -1 is returned, and the ``errno`` variable is set
  49 appropriately.
  50
  51 The generic error codes are described at the
  52 :ref:`Generic Error Codes <gen-errors>` chapter.