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

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

Documentation/media/uapi/dvb/net-add-if.rst

+0 −34
Original line number Diff line number Diff line
@@ -41,40 +41,6 @@ created. 
The struct :c:type:`dvb_net_if`::ifnum field will be

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

============

Documentation/media/uapi/dvb/net-types.rst

0 → 100644
+9 −0
Original line number Diff line number Diff line 
.. -*- coding: utf-8; mode: rst -*-



.. _dmx_types:



**************

Net Data Types

**************



.. kernel-doc:: include/uapi/linux/dvb/net.h

Documentation/media/uapi/dvb/net.rst

+1 −0
Original line number Diff line number Diff line
@@ -35,6 +35,7 @@ Digital TV net Function Calls 
.. toctree::

    :maxdepth: 1



    net-types

    net-add-if

    net-remove-if

    net-get-if

include/uapi/linux/dvb/net.h

+15 −0
Original line number Diff line number Diff line
@@ -26,6 +26,21 @@ 


#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 {

	__u16 pid;

	__u16 if_num;