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