diff options
Diffstat (limited to 'Documentation/linux_tv/media/dvb/net.rst')
| -rw-r--r-- | Documentation/linux_tv/media/dvb/net.rst | 180 |
1 files changed, 5 insertions, 175 deletions
diff --git a/Documentation/linux_tv/media/dvb/net.rst b/Documentation/linux_tv/media/dvb/net.rst index c5c42e43d277..eca42dd53261 100644 --- a/Documentation/linux_tv/media/dvb/net.rst +++ b/Documentation/linux_tv/media/dvb/net.rst @@ -32,179 +32,9 @@ header. DVB net Function Calls ###################### -.. _NET_ADD_IF: +.. toctree:: + :maxdepth: 1 -**************** -ioctl NET_ADD_IF -**************** - -*man NET_ADD_IF(2)* - -Creates a new network interface for a given Packet ID. - - -Synopsis -======== - -.. cpp:function:: int ioctl( int fd, int request, struct dvb_net_if *net_if ) - -Arguments -========= - -``fd`` - File descriptor returned by :ref:`open() <frontend_f_open>`. - -``request`` - FE_SET_TONE - -``net_if`` - pointer to struct :ref:`dvb_net_if <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 :ref:`dvb_net_if <dvb-net-if>`::ifnum field will be -filled with the number of the created interface. - -RETURN VALUE - -On success 0 is returned, on error -1 and the ``errno`` variable is set -appropriately. The generic error codes are described at the -:ref:`Generic Error Codes <gen-errors>` chapter. - - -.. _dvb-net-if-t: - -struct dvb_net_if description -============================= - - -.. _dvb-net-if: - -.. flat-table:: struct dvb_net_if - :header-rows: 1 - :stub-columns: 0 - - - - .. row 1 - - - ID - - - Description - - - .. row 2 - - - pid - - - Packet ID (PID) of the MPEG-TS that contains data - - - .. row 3 - - - ifnum - - - number of the DVB interface. - - - .. row 4 - - - feedtype - - - Encapsulation type of the feed. It can be: - ``DVB_NET_FEEDTYPE_MPE`` for MPE encoding or - ``DVB_NET_FEEDTYPE_ULE`` for ULE encoding. - - - -.. _NET_REMOVE_IF: - -******************* -ioctl NET_REMOVE_IF -******************* - -*man NET_REMOVE_IF(2)* - -Removes a network interface. - - -Synopsis -======== - -.. cpp:function:: int ioctl( int fd, int request, int ifnum ) - -Arguments -========= - -``fd`` - File descriptor returned by :ref:`open() <frontend_f_open>`. - -``request`` - FE_SET_TONE - -``net_if`` - number of the interface to be removed - - -Description -=========== - -The NET_REMOVE_IF ioctl deletes an interface previously created via -:ref:`NET_ADD_IF <net>`. - -RETURN VALUE - -On success 0 is returned, on error -1 and the ``errno`` variable is set -appropriately. The generic error codes are described at the -:ref:`Generic Error Codes <gen-errors>` chapter. - - -.. _NET_GET_IF: - -**************** -ioctl NET_GET_IF -**************** - -*man NET_GET_IF(2)* - -Read the configuration data of an interface created via -:ref:`NET_ADD_IF <net>`. - - -Synopsis -======== - -.. cpp:function:: int ioctl( int fd, int request, struct dvb_net_if *net_if ) - -Arguments -========= - -``fd`` - File descriptor returned by :ref:`open() <frontend_f_open>`. - -``request`` - FE_SET_TONE - -``net_if`` - pointer to struct :ref:`dvb_net_if <dvb-net-if>` - - -Description -=========== - -The NET_GET_IF ioctl uses the interface number given by the struct -:ref:`dvb_net_if <dvb-net-if>`::ifnum field and fills the content of -struct :ref:`dvb_net_if <dvb-net-if>` with the packet ID and -encapsulation type used on such interface. If the interface was not -created yet with :ref:`NET_ADD_IF <net>`, it will return -1 and fill -the ``errno`` with ``EINVAL`` error code. - -RETURN VALUE - -On success 0 is returned, on error -1 and the ``errno`` variable is set -appropriately. The generic error codes are described at the -:ref:`Generic Error Codes <gen-errors>` chapter. + net-add-if + net-remove-if + net-get-if |