Commit 56d51b65 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab

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: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 5176d6ee
...@@ -41,40 +41,6 @@ created. ...@@ -41,40 +41,6 @@ created.
The struct :c:type:`dvb_net_if`::ifnum field will be The struct :c:type:`dvb_net_if`::ifnum field will be
filled with the number of the created interface. filled with the number of the created interface.
.. c:type:: 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 Digital TV 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.
Return Value Return Value
============ ============
......
.. -*- coding: utf-8; mode: rst -*-
.. _dmx_types:
**************
Net Data Types
**************
.. kernel-doc:: include/uapi/linux/dvb/net.h
...@@ -35,6 +35,7 @@ Digital TV net Function Calls ...@@ -35,6 +35,7 @@ Digital TV net Function Calls
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
net-types
net-add-if net-add-if
net-remove-if net-remove-if
net-get-if net-get-if
...@@ -26,6 +26,21 @@ ...@@ -26,6 +26,21 @@
#include <linux/types.h> #include <linux/types.h>
/**
* struct dvb_net_if - describes a DVB network interface
*
* @pid: Packet ID (PID) of the MPEG-TS that contains data
* @if_num: number of the Digital TV interface.
* @feedtype: Encapsulation type of the feed.
*
* A MPEG-TS stream may contain packet IDs with IP packages on it.
* This struct describes it, and the type of encoding.
*
* @feedtype can be:
*
* - %DVB_NET_FEEDTYPE_MPE for MPE encoding
* - %DVB_NET_FEEDTYPE_ULE for ULE encoding.
*/
struct dvb_net_if { struct dvb_net_if {
__u16 pid; __u16 pid;
__u16 if_num; __u16 if_num;
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment