aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@redhat.com>2011-06-08 09:23:34 -0400
committerMauro Carvalho Chehab <mchehab@redhat.com>2011-07-27 16:52:55 -0400
commitd9d73416edfad05aa5c34255948a12c3860291f3 (patch)
tree0ff3eecd93f7f12132cb6d756b6edcbcd8b25cd7
parent446c18fcfdd1c165e50b18c07e0ac2f4b10e5947 (diff)
[media] DocBook: Add the other DVB API header files
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
-rw-r--r--Documentation/DocBook/media/Makefile92
-rw-r--r--Documentation/DocBook/media/dvb/dvbapi.xml24
-rw-r--r--Documentation/DocBook/media/dvb/intro.xml19
3 files changed, 133 insertions, 2 deletions
diff --git a/Documentation/DocBook/media/Makefile b/Documentation/DocBook/media/Makefile
index eb64087ac520..a747f2a6c2c1 100644
--- a/Documentation/DocBook/media/Makefile
+++ b/Documentation/DocBook/media/Makefile
@@ -11,7 +11,13 @@ MEDIA_TEMP = media-entities.tmpl \
11 media-indices.tmpl \ 11 media-indices.tmpl \
12 videodev2.h.xml \ 12 videodev2.h.xml \
13 v4l2.xml \ 13 v4l2.xml \
14 frontend.h.xml 14 audio.h.xml \
15 ca.h.xml \
16 dmx.h.xml \
17 frontend.h.xml \
18 net.h.xml \
19 osd.h.xml \
20 video.h.xml \
15 21
16IMGFILES := $(addprefix $(MEDIA_OBJ_DIR)/media/, $(notdir $(shell ls $(MEDIA_SRC_DIR)/*/*.gif $(MEDIA_SRC_DIR)/*/*.png))) 22IMGFILES := $(addprefix $(MEDIA_OBJ_DIR)/media/, $(notdir $(shell ls $(MEDIA_SRC_DIR)/*/*.gif $(MEDIA_SRC_DIR)/*/*.png)))
17GENFILES := $(addprefix $(MEDIA_OBJ_DIR)/, $(MEDIA_TEMP)) 23GENFILES := $(addprefix $(MEDIA_OBJ_DIR)/, $(MEDIA_TEMP))
@@ -51,7 +57,13 @@ FUNCS = \
51 57
52IOCTLS = \ 58IOCTLS = \
53 $(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/videodev2.h) \ 59 $(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/videodev2.h) \
60 $(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/dvb/audio.h) \
61 $(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/dvb/ca.h) \
62 $(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/dvb/dmx.h) \
54 $(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/dvb/frontend.h) \ 63 $(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/dvb/frontend.h) \
64 $(shell perl -ne 'print "$$1 " if /\#define\s+([A-Z][^\s]+)\s+_IO/' $(srctree)/include/linux/dvb/net.h) \
65 $(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/dvb/osd.h) \
66 $(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/dvb/video.h) \
55 $(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/media.h) \ 67 $(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/media.h) \
56 $(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/v4l2-subdev.h) \ 68 $(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/v4l2-subdev.h) \
57 VIDIOC_SUBDEV_G_FRAME_INTERVAL \ 69 VIDIOC_SUBDEV_G_FRAME_INTERVAL \
@@ -66,14 +78,26 @@ TYPES = \
66 78
67ENUMS = \ 79ENUMS = \
68 $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/videodev2.h) \ 80 $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/videodev2.h) \
81 $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/dvb/audio.h) \
82 $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/dvb/ca.h) \
83 $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/dvb/dmx.h) \
69 $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/dvb/frontend.h) \ 84 $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/dvb/frontend.h) \
85 $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/dvb/net.h) \
86 $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/dvb/osd.h) \
87 $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/dvb/video.h) \
70 $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/media.h) \ 88 $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/media.h) \
71 $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-mediabus.h) \ 89 $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-mediabus.h) \
72 $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-subdev.h) 90 $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-subdev.h)
73 91
74STRUCTS = \ 92STRUCTS = \
75 $(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/videodev2.h) \ 93 $(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/videodev2.h) \
94 $(shell perl -ne 'print "$$1 " if (/^struct\s+([^\s\{]+)\s*/)' $(srctree)/include/linux/dvb/audio.h) \
95 $(shell perl -ne 'print "$$1 " if (/^struct\s+([^\s]+)\s+/)' $(srctree)/include/linux/dvb/ca.h) \
96 $(shell perl -ne 'print "$$1 " if (/^struct\s+([^\s]+)\s+/)' $(srctree)/include/linux/dvb/dmx.h) \
76 $(shell perl -ne 'print "$$1 " if (!/dtv\_cmds\_h/ && /^struct\s+([^\s]+)\s+/)' $(srctree)/include/linux/dvb/frontend.h) \ 97 $(shell perl -ne 'print "$$1 " if (!/dtv\_cmds\_h/ && /^struct\s+([^\s]+)\s+/)' $(srctree)/include/linux/dvb/frontend.h) \
98 $(shell perl -ne 'print "$$1 " if (/^struct\s+([A-Z][^\s]+)\s+/)' $(srctree)/include/linux/dvb/net.h) \
99 $(shell perl -ne 'print "$$1 " if (/^struct\s+([^\s]+)\s+/)' $(srctree)/include/linux/dvb/osd.h) \
100 $(shell perl -ne 'print "$$1 " if (/^struct\s+([^\s]+)\s+/)' $(srctree)/include/linux/dvb/video.h) \
77 $(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/media.h) \ 101 $(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/media.h) \
78 $(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-subdev.h) \ 102 $(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-subdev.h) \
79 $(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-mediabus.h) 103 $(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-mediabus.h)
@@ -151,6 +175,39 @@ $(MEDIA_OBJ_DIR)/videodev2.h.xml: $(srctree)/include/linux/videodev2.h $(MEDIA_O
151 @( \ 175 @( \
152 echo "</programlisting>") >> $@ 176 echo "</programlisting>") >> $@
153 177
178$(MEDIA_OBJ_DIR)/audio.h.xml: $(srctree)/include/linux/dvb/audio.h $(MEDIA_OBJ_DIR)/v4l2.xml
179 @$($(quiet)gen_xml)
180 @( \
181 echo "<programlisting>") > $@
182 @( \
183 expand --tabs=8 < $< | \
184 sed $(ESCAPE) $(DVB_DOCUMENTED) | \
185 sed 's/i\.e\./&ie;/') >> $@
186 @( \
187 echo "</programlisting>") >> $@
188
189$(MEDIA_OBJ_DIR)/ca.h.xml: $(srctree)/include/linux/dvb/ca.h $(MEDIA_OBJ_DIR)/v4l2.xml
190 @$($(quiet)gen_xml)
191 @( \
192 echo "<programlisting>") > $@
193 @( \
194 expand --tabs=8 < $< | \
195 sed $(ESCAPE) $(DVB_DOCUMENTED) | \
196 sed 's/i\.e\./&ie;/') >> $@
197 @( \
198 echo "</programlisting>") >> $@
199
200$(MEDIA_OBJ_DIR)/dmx.h.xml: $(srctree)/include/linux/dvb/dmx.h $(MEDIA_OBJ_DIR)/v4l2.xml
201 @$($(quiet)gen_xml)
202 @( \
203 echo "<programlisting>") > $@
204 @( \
205 expand --tabs=8 < $< | \
206 sed $(ESCAPE) $(DVB_DOCUMENTED) | \
207 sed 's/i\.e\./&ie;/') >> $@
208 @( \
209 echo "</programlisting>") >> $@
210
154$(MEDIA_OBJ_DIR)/frontend.h.xml: $(srctree)/include/linux/dvb/frontend.h $(MEDIA_OBJ_DIR)/v4l2.xml 211$(MEDIA_OBJ_DIR)/frontend.h.xml: $(srctree)/include/linux/dvb/frontend.h $(MEDIA_OBJ_DIR)/v4l2.xml
155 @$($(quiet)gen_xml) 212 @$($(quiet)gen_xml)
156 @( \ 213 @( \
@@ -162,6 +219,39 @@ $(MEDIA_OBJ_DIR)/frontend.h.xml: $(srctree)/include/linux/dvb/frontend.h $(MEDIA
162 @( \ 219 @( \
163 echo "</programlisting>") >> $@ 220 echo "</programlisting>") >> $@
164 221
222$(MEDIA_OBJ_DIR)/net.h.xml: $(srctree)/include/linux/dvb/net.h $(MEDIA_OBJ_DIR)/v4l2.xml
223 @$($(quiet)gen_xml)
224 @( \
225 echo "<programlisting>") > $@
226 @( \
227 expand --tabs=8 < $< | \
228 sed $(ESCAPE) $(DVB_DOCUMENTED) | \
229 sed 's/i\.e\./&ie;/') >> $@
230 @( \
231 echo "</programlisting>") >> $@
232
233$(MEDIA_OBJ_DIR)/osd.h.xml: $(srctree)/include/linux/dvb/osd.h $(MEDIA_OBJ_DIR)/v4l2.xml
234 @$($(quiet)gen_xml)
235 @( \
236 echo "<programlisting>") > $@
237 @( \
238 expand --tabs=8 < $< | \
239 sed $(ESCAPE) $(DVB_DOCUMENTED) | \
240 sed 's/i\.e\./&ie;/') >> $@
241 @( \
242 echo "</programlisting>") >> $@
243
244$(MEDIA_OBJ_DIR)/video.h.xml: $(srctree)/include/linux/dvb/video.h $(MEDIA_OBJ_DIR)/v4l2.xml
245 @$($(quiet)gen_xml)
246 @( \
247 echo "<programlisting>") > $@
248 @( \
249 expand --tabs=8 < $< | \
250 sed $(ESCAPE) $(DVB_DOCUMENTED) | \
251 sed 's/i\.e\./&ie;/') >> $@
252 @( \
253 echo "</programlisting>") >> $@
254
165$(MEDIA_OBJ_DIR)/media-entities.tmpl: $(MEDIA_OBJ_DIR)/v4l2.xml 255$(MEDIA_OBJ_DIR)/media-entities.tmpl: $(MEDIA_OBJ_DIR)/v4l2.xml
166 @$($(quiet)gen_xml) 256 @$($(quiet)gen_xml)
167 @( \ 257 @( \
diff --git a/Documentation/DocBook/media/dvb/dvbapi.xml b/Documentation/DocBook/media/dvb/dvbapi.xml
index 9fad86ce7f5e..5291430dbb62 100644
--- a/Documentation/DocBook/media/dvb/dvbapi.xml
+++ b/Documentation/DocBook/media/dvb/dvbapi.xml
@@ -114,8 +114,32 @@ Added ISDB-T test originally written by Patrick Boettcher
114 &sub-examples; 114 &sub-examples;
115 </chapter> 115 </chapter>
116<!-- END OF CHAPTERS --> 116<!-- END OF CHAPTERS -->
117 <appendix id="audio_h">
118 <title>DVB Audio Header File</title>
119 &sub-audio-h;
120 </appendix>
121 <appendix id="ca_h">
122 <title>DVB Conditional Access Header File</title>
123 &sub-ca-h;
124 </appendix>
125 <appendix id="dmx_h">
126 <title>DVB Demux Header File</title>
127 &sub-dmx-h;
128 </appendix>
117 <appendix id="frontend_h"> 129 <appendix id="frontend_h">
118 <title>DVB Frontend Header File</title> 130 <title>DVB Frontend Header File</title>
119 &sub-frontend-h; 131 &sub-frontend-h;
120 </appendix> 132 </appendix>
133 <appendix id="net_h">
134 <title>DVB Network Header File</title>
135 &sub-net-h;
136 </appendix>
137 <appendix id="osd_h">
138 <title>DVB OSD Header File</title>
139 &sub-osd-h;
140 </appendix>
141 <appendix id="video_h">
142 <title>DVB Video Header File</title>
143 &sub-video-h;
144 </appendix>
121 145
diff --git a/Documentation/DocBook/media/dvb/intro.xml b/Documentation/DocBook/media/dvb/intro.xml
index 0dc83f672ea2..82236396eef3 100644
--- a/Documentation/DocBook/media/dvb/intro.xml
+++ b/Documentation/DocBook/media/dvb/intro.xml
@@ -175,10 +175,27 @@ the devices are described in the following chapters.</para>
175The DVB API include files should be included in application sources with 175The DVB API include files should be included in application sources with
176a partial path like:</para> 176a partial path like:</para>
177 177
178 178<programlisting>
179 #include &#x003C;linux/dvb/audio.h&#x003E;
180</programlisting>
181<programlisting>
182 #include &#x003C;linux/dvb/ca.h&#x003E;
183</programlisting>
184<programlisting>
185 #include &#x003C;linux/dvb/dmx.h&#x003E;
186</programlisting>
179<programlisting> 187<programlisting>
180 #include &#x003C;linux/dvb/frontend.h&#x003E; 188 #include &#x003C;linux/dvb/frontend.h&#x003E;
181</programlisting> 189</programlisting>
190<programlisting>
191 #include &#x003C;linux/dvb/net.h&#x003E;
192</programlisting>
193<programlisting>
194 #include &#x003C;linux/dvb/osd.h&#x003E;
195</programlisting>
196<programlisting>
197 #include &#x003C;linux/dvb/video.h&#x003E;
198</programlisting>
182 199
183<para>To enable applications to support different API version, an 200<para>To enable applications to support different API version, an
184additional include file <emphasis 201additional include file <emphasis