summaryrefslogtreecommitdiff
path: root/include/uapi
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2017-09-01 22:45:47 +0300
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2017-09-05 13:22:42 +0300
commit56d51b65bcc7a5780663abd579fb6f039616b347 (patch)
tree52db112adafcb4594fd7267fdb87a713366939d2 /include/uapi
parent5176d6eefd5d58fbb787f96c2140cffb2e826b17 (diff)
downloadlinux-56d51b65bcc7a5780663abd579fb6f039616b347.tar.xz
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>
Diffstat (limited to 'include/uapi')
-rw-r--r--include/uapi/linux/dvb/net.h15
1 files changed, 15 insertions, 0 deletions
diff --git a/include/uapi/linux/dvb/net.h b/include/uapi/linux/dvb/net.h
index f451e7eb0b0b..89d805f9a5a6 100644
--- a/include/uapi/linux/dvb/net.h
+++ b/include/uapi/linux/dvb/net.h
@@ -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;