linux/Documentation/media/uapi/dvb/net-add-if.rst
Mauro Carvalho Chehab 56d51b65bc media: net.h: add kernel-doc and use it at Documentation/
As we did with frontend.h, ca.h and dmx.h, move the struct
definition to net.h.

That should help to keep it updated, as more stuff gets
added there.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-09-05 06:22:42 -04:00

54 lines
1.1 KiB
ReStructuredText

.. -*- coding: utf-8; mode: rst -*-
.. _NET_ADD_IF:
****************
ioctl NET_ADD_IF
****************
Name
====
NET_ADD_IF - Creates a new network interface for a given Packet ID.
Synopsis
========
.. c:function:: int ioctl( int fd, NET_ADD_IF, struct dvb_net_if *net_if )
:name: NET_ADD_IF
Arguments
=========
``fd``
File descriptor returned by :ref:`open() <frontend_f_open>`.
``net_if``
pointer to struct :c:type:`dvb_net_if`
Description
===========
The NET_ADD_IF ioctl system call selects the Packet ID (PID) that
contains a TCP/IP traffic, the type of encapsulation to be used (MPE or
ULE) and the interface number for the new interface to be created. When
the system call successfully returns, a new virtual network interface is
created.
The struct :c:type:`dvb_net_if`::ifnum field will be
filled with the number of the created interface.
Return Value
============
On success 0 is returned, and :c:type:`ca_slot_info` is filled.
On error -1 is returned, and the ``errno`` variable is set
appropriately.
The generic error codes are described at the
:ref:`Generic Error Codes <gen-errors>` chapter.