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