blob: ab312545619a3349d7fea62e1d8cc0c533bdfbcd [file] [log] [blame]
Mauro Carvalho Chehab42661292011-05-31 16:27:44 -03001###
2# Media build rules - Auto-generates media contents/indexes and *.h xml's
3#
4
5SHELL=/bin/bash
6
7MEDIA_OBJ_DIR=$(objtree)/Documentation/DocBook/
8MEDIA_SRC_DIR=$(srctree)/Documentation/DocBook/media
9
10MEDIA_TEMP = media-entities.tmpl \
11 media-indices.tmpl \
12 videodev2.h.xml \
13 v4l2.xml \
Mauro Carvalho Chehabd9d73412011-06-08 10:23:34 -030014 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 \
Mauro Carvalho Chehab42661292011-05-31 16:27:44 -030021
22IMGFILES := $(addprefix $(MEDIA_OBJ_DIR)/media/, $(notdir $(shell ls $(MEDIA_SRC_DIR)/*/*.gif $(MEDIA_SRC_DIR)/*/*.png)))
23GENFILES := $(addprefix $(MEDIA_OBJ_DIR)/, $(MEDIA_TEMP))
24
25PHONY += cleanmediadocs mediaindexdocs
26
27cleanmediadocs:
28 -@rm `find $(MEDIA_OBJ_DIR) -type l` $(GENFILES) $(IMGFILES)
29
30$(obj)/media_api.xml: $(GENFILES) FORCE
31
32#$(MEDIA_OBJ_DIR)/media_api.html: $(MEDIA_OBJ_DIR)/media_api.xml
33#$(MEDIA_OBJ_DIR)/media_api.pdf: $(MEDIA_OBJ_DIR)/media_api.xml
34#$(MEDIA_OBJ_DIR)/media_api.ps: $(MEDIA_OBJ_DIR)/media_api.xml
35
36V4L_SGMLS = \
37 $(shell ls $(MEDIA_SRC_DIR)/v4l/*.xml|perl -ne 'print "$$1 " if (m,.*/(.*)\n,)') \
38 capture.c.xml \
39 keytable.c.xml \
40 v4l2grab.c.xml
41
42DVB_SGMLS = \
43 $(shell ls $(MEDIA_SRC_DIR)/dvb/*.xml|perl -ne 'print "$$1 " if (m,.*/(.*)\n,)')
44
45MEDIA_SGMLS = $(addprefix ./,$(V4L_SGMLS)) $(addprefix ./,$(DVB_SGMLS)) $(addprefix ./,$(MEDIA_TEMP))
46
47FUNCS = \
48 close \
49 ioctl \
50 mmap \
51 munmap \
52 open \
53 poll \
54 read \
55 select \
56 write \
57
58IOCTLS = \
59 $(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/videodev2.h) \
Mauro Carvalho Chehabd9d73412011-06-08 10:23:34 -030060 $(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) \
Mauro Carvalho Chehab98a2b602011-06-07 14:51:56 -030063 $(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/dvb/frontend.h) \
Mauro Carvalho Chehabd9d73412011-06-08 10:23:34 -030064 $(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) \
Mauro Carvalho Chehab42661292011-05-31 16:27:44 -030067 $(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/media.h) \
68 $(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/v4l2-subdev.h) \
69 VIDIOC_SUBDEV_G_FRAME_INTERVAL \
70 VIDIOC_SUBDEV_S_FRAME_INTERVAL \
71 VIDIOC_SUBDEV_ENUM_MBUS_CODE \
72 VIDIOC_SUBDEV_ENUM_FRAME_SIZE \
73 VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL \
74
75TYPES = \
Mauro Carvalho Chehab98a2b602011-06-07 14:51:56 -030076 $(shell perl -ne 'print "$$1 " if /^typedef\s+[^\s]+\s+([^\s]+)\;/' $(srctree)/include/linux/videodev2.h) \
77 $(shell perl -ne 'print "$$1 " if /^}\s+([a-z0-9_]+_t)/' $(srctree)/include/linux/dvb/frontend.h)
Mauro Carvalho Chehab42661292011-05-31 16:27:44 -030078
79ENUMS = \
80 $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/videodev2.h) \
Mauro Carvalho Chehabd9d73412011-06-08 10:23:34 -030081 $(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) \
Mauro Carvalho Chehab98a2b602011-06-07 14:51:56 -030084 $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/dvb/frontend.h) \
Mauro Carvalho Chehabd9d73412011-06-08 10:23:34 -030085 $(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) \
Mauro Carvalho Chehab42661292011-05-31 16:27:44 -030088 $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/media.h) \
89 $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-mediabus.h) \
90 $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-subdev.h)
91
92STRUCTS = \
93 $(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/videodev2.h) \
Mauro Carvalho Chehabd9d73412011-06-08 10:23:34 -030094 $(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) \
Mauro Carvalho Chehab3272c3e2011-06-07 21:40:22 -030097 $(shell perl -ne 'print "$$1 " if (!/dtv\_cmds\_h/ && /^struct\s+([^\s]+)\s+/)' $(srctree)/include/linux/dvb/frontend.h) \
Mauro Carvalho Chehabd9d73412011-06-08 10:23:34 -030098 $(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) \
Mauro Carvalho Chehab42661292011-05-31 16:27:44 -0300101 $(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/media.h) \
102 $(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-subdev.h) \
103 $(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-mediabus.h)
104
105ERRORS = \
106 EACCES \
107 EAGAIN \
108 EBADF \
109 EBUSY \
110 EFAULT \
111 EIO \
112 EINTR \
113 EINVAL \
114 ENFILE \
115 ENOMEM \
116 ENOSPC \
117 ENOTTY \
118 ENXIO \
119 EMFILE \
120 EPERM \
121 ERANGE \
122 EPIPE \
123
124ESCAPE = \
125 -e "s/&/\\&/g" \
126 -e "s/</\\&lt;/g" \
127 -e "s/>/\\&gt;/g"
128
129FILENAME = \
130 -e s,"^[^\/]*/",, \
131 -e s/"\\.xml"// \
132 -e s/"\\.tmpl"// \
133 -e s/\\\./-/g \
134 -e s/"^func-"// \
135 -e s/"^pixfmt-"// \
136 -e s/"^vidioc-"//
137
138# Generate references to these structs in videodev2.h.xml.
139DOCUMENTED = \
140 -e "s/\(enum *\)v4l2_mpeg_cx2341x_video_\([a-z]*_spatial_filter_type\)/\1<link linkend=\"\2\">v4l2_mpeg_cx2341x_video_\2<\/link>/g" \
141 -e "s/\(\(enum\|struct\) *\)\(v4l2_[a-zA-Z0-9_]*\)/\1<link linkend=\"\3\">\3<\/link>/g" \
142 -e "s/\(V4L2_PIX_FMT_[A-Z0-9_]\+\) /<link linkend=\"\1\">\1<\/link> /g" \
143 -e ":a;s/\(linkend=\".*\)_\(.*\">\)/\1-\2/;ta" \
144 -e "s/v4l2\-mpeg\-vbi\-ITV0/v4l2-mpeg-vbi-itv0-1/g"
145
146DVB_DOCUMENTED = \
Mauro Carvalho Chehab98a2b602011-06-07 14:51:56 -0300147 -e "s/\(linkend\=\"\)FE_SET_PROPERTY/\1FE_GET_PROPERTY/g" \
148 -e "s,\(struct\s\+\)\([a-z0-9_]\+\)\(\s\+{\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \
149 -e "s,\(}\s\+\)\([a-z0-9_]\+_t\+\),\1\<link linkend=\"\2\">\2\<\/link\>,g" \
Mauro Carvalho Chehab95e61e02011-06-07 16:58:00 -0300150 -e "s,\(define\s\+\)\(DTV_[A-Z0-9_]\+\)\(\s\+[0-9]\+\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \
Mauro Carvalho Chehabca5b2332011-06-08 15:08:57 -0300151 -e "s,<link\s\+linkend=\".*\">\(DTV_IOCTL_MAX_MSGS\|dtv_cmds_h\|__.*_old\)<\/link>,\1,g" \
Mauro Carvalho Chehabd5dc2de2011-06-07 16:17:00 -0300152 -e ":a;s/\(linkend=\".*\)_\(.*\">\)/\1-\2/;ta" \
Mauro Carvalho Chehabfb029092011-06-08 11:56:57 -0300153 -e "s,\(audio-mixer\|audio-karaoke\|audio-status\|ca-slot-info\|ca-descr-info\|ca-caps\|ca-msg\|ca-descr\|ca-pid\|dmx-filter\|dmx-caps\)-t,\1,g" \
Mauro Carvalho Chehab95e61e02011-06-07 16:58:00 -0300154 -e "s,DTV-ISDBT-LAYER[A-C],DTV-ISDBT-LAYER,g" \
Mauro Carvalho Chehab6cb77a82011-06-07 17:58:59 -0300155 -e "s,\(define\s\+\)\([A-Z0-9_]\+\)\(\s\+_IO\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \
Mauro Carvalho Chehabca5b2332011-06-08 15:08:57 -0300156 -e "s,<link\s\+linkend=\".*\">\(__.*_OLD\)<\/link>,\1,g" \
Mauro Carvalho Chehab42661292011-05-31 16:27:44 -0300157
158#
159# Media targets and dependencies
160#
161
162$(MEDIA_OBJ_DIR)/v4l2.xml:
163 @$($(quiet)gen_xml)
164 @(mkdir -p $(MEDIA_OBJ_DIR)/media)
165 @(cp $(MEDIA_SRC_DIR)/dvb/*.png $(MEDIA_SRC_DIR)/v4l/*.gif $(MEDIA_OBJ_DIR)/media/)
166 @(ln -sf $(MEDIA_SRC_DIR)/v4l/*xml $(MEDIA_OBJ_DIR)/)
167 @(ln -sf $(MEDIA_SRC_DIR)/dvb/*xml $(MEDIA_OBJ_DIR)/)
168
169$(MEDIA_OBJ_DIR)/videodev2.h.xml: $(srctree)/include/linux/videodev2.h $(MEDIA_OBJ_DIR)/v4l2.xml
170 @$($(quiet)gen_xml)
171 @( \
172 echo "<programlisting>") > $@
173 @( \
174 expand --tabs=8 < $< | \
175 sed $(ESCAPE) $(DOCUMENTED) | \
176 sed 's/i\.e\./&ie;/') >> $@
177 @( \
178 echo "</programlisting>") >> $@
179
Mauro Carvalho Chehabd9d73412011-06-08 10:23:34 -0300180$(MEDIA_OBJ_DIR)/audio.h.xml: $(srctree)/include/linux/dvb/audio.h $(MEDIA_OBJ_DIR)/v4l2.xml
181 @$($(quiet)gen_xml)
182 @( \
183 echo "<programlisting>") > $@
184 @( \
185 expand --tabs=8 < $< | \
186 sed $(ESCAPE) $(DVB_DOCUMENTED) | \
187 sed 's/i\.e\./&ie;/') >> $@
188 @( \
189 echo "</programlisting>") >> $@
190
191$(MEDIA_OBJ_DIR)/ca.h.xml: $(srctree)/include/linux/dvb/ca.h $(MEDIA_OBJ_DIR)/v4l2.xml
192 @$($(quiet)gen_xml)
193 @( \
194 echo "<programlisting>") > $@
195 @( \
196 expand --tabs=8 < $< | \
197 sed $(ESCAPE) $(DVB_DOCUMENTED) | \
198 sed 's/i\.e\./&ie;/') >> $@
199 @( \
200 echo "</programlisting>") >> $@
201
202$(MEDIA_OBJ_DIR)/dmx.h.xml: $(srctree)/include/linux/dvb/dmx.h $(MEDIA_OBJ_DIR)/v4l2.xml
203 @$($(quiet)gen_xml)
204 @( \
205 echo "<programlisting>") > $@
206 @( \
207 expand --tabs=8 < $< | \
208 sed $(ESCAPE) $(DVB_DOCUMENTED) | \
209 sed 's/i\.e\./&ie;/') >> $@
210 @( \
211 echo "</programlisting>") >> $@
212
Mauro Carvalho Chehab42661292011-05-31 16:27:44 -0300213$(MEDIA_OBJ_DIR)/frontend.h.xml: $(srctree)/include/linux/dvb/frontend.h $(MEDIA_OBJ_DIR)/v4l2.xml
214 @$($(quiet)gen_xml)
215 @( \
216 echo "<programlisting>") > $@
217 @( \
218 expand --tabs=8 < $< | \
219 sed $(ESCAPE) $(DVB_DOCUMENTED) | \
220 sed 's/i\.e\./&ie;/') >> $@
221 @( \
222 echo "</programlisting>") >> $@
223
Mauro Carvalho Chehabd9d73412011-06-08 10:23:34 -0300224$(MEDIA_OBJ_DIR)/net.h.xml: $(srctree)/include/linux/dvb/net.h $(MEDIA_OBJ_DIR)/v4l2.xml
225 @$($(quiet)gen_xml)
226 @( \
227 echo "<programlisting>") > $@
228 @( \
229 expand --tabs=8 < $< | \
230 sed $(ESCAPE) $(DVB_DOCUMENTED) | \
231 sed 's/i\.e\./&ie;/') >> $@
232 @( \
233 echo "</programlisting>") >> $@
234
235$(MEDIA_OBJ_DIR)/osd.h.xml: $(srctree)/include/linux/dvb/osd.h $(MEDIA_OBJ_DIR)/v4l2.xml
236 @$($(quiet)gen_xml)
237 @( \
238 echo "<programlisting>") > $@
239 @( \
240 expand --tabs=8 < $< | \
241 sed $(ESCAPE) $(DVB_DOCUMENTED) | \
242 sed 's/i\.e\./&ie;/') >> $@
243 @( \
244 echo "</programlisting>") >> $@
245
246$(MEDIA_OBJ_DIR)/video.h.xml: $(srctree)/include/linux/dvb/video.h $(MEDIA_OBJ_DIR)/v4l2.xml
247 @$($(quiet)gen_xml)
248 @( \
249 echo "<programlisting>") > $@
250 @( \
251 expand --tabs=8 < $< | \
252 sed $(ESCAPE) $(DVB_DOCUMENTED) | \
253 sed 's/i\.e\./&ie;/') >> $@
254 @( \
255 echo "</programlisting>") >> $@
256
Mauro Carvalho Chehab42661292011-05-31 16:27:44 -0300257$(MEDIA_OBJ_DIR)/media-entities.tmpl: $(MEDIA_OBJ_DIR)/v4l2.xml
258 @$($(quiet)gen_xml)
259 @( \
260 echo "<!-- Generated file! Do not edit. -->") >$@
261 @( \
262 echo -e "\n<!-- Functions -->") >>$@
263 @( \
264 for ident in $(FUNCS) ; do \
265 entity=`echo $$ident | tr _ -` ; \
266 echo "<!ENTITY func-$$entity \"<link" \
267 "linkend='func-$$entity'><function>$$ident()</function></link>\">" \
268 >>$@ ; \
269 done)
270 @( \
271 echo -e "\n<!-- Ioctls -->") >>$@
272 @( \
273 for ident in $(IOCTLS) ; do \
274 entity=`echo $$ident | tr _ -` ; \
275 id=`grep "<refname>$$ident" $(MEDIA_OBJ_DIR)/vidioc-*.xml | sed -r s,"^.*/(.*).xml.*","\1",` ; \
276 echo "<!ENTITY $$entity \"<link" \
277 "linkend='$$id'><constant>$$ident</constant></link>\">" \
278 >>$@ ; \
279 done)
280 @( \
281 echo -e "\n<!-- Types -->") >>$@
282 @( \
283 for ident in $(TYPES) ; do \
284 entity=`echo $$ident | tr _ -` ; \
285 echo "<!ENTITY $$entity \"<link" \
286 "linkend='$$entity'>$$ident</link>\">" >>$@ ; \
287 done)
288 @( \
289 echo -e "\n<!-- Enums -->") >>$@
290 @( \
291 for ident in $(ENUMS) ; do \
292 entity=`echo $$ident | sed -e "s/v4l2_mpeg_cx2341x_video_\([a-z]*_spatial_filter_type\)/\1/" | tr _ -` ; \
293 echo "<!ENTITY $$entity \"enum&nbsp;<link" \
294 "linkend='$$entity'>$$ident</link>\">" >>$@ ; \
295 done)
296 @( \
297 echo -e "\n<!-- Structures -->") >>$@
298 @( \
299 for ident in $(STRUCTS) ; do \
300 entity=`echo $$ident | tr _ - | sed s/v4l2-mpeg-vbi-ITV0/v4l2-mpeg-vbi-itv0-1/g` ; \
301 echo "<!ENTITY $$entity \"struct&nbsp;<link" \
302 "linkend='$$entity'>$$ident</link>\">" >>$@ ; \
303 done)
304 @( \
305 echo -e "\n<!-- Error Codes -->") >>$@
306 @( \
307 for ident in $(ERRORS) ; do \
308 echo "<!ENTITY $$ident \"<errorcode>$$ident</errorcode>" \
309 "error code\">" >>$@ ; \
310 done)
311 @( \
312 echo -e "\n<!-- Subsections -->") >>$@
313 @( \
314 for file in $(MEDIA_SGMLS) ; do \
315 entity=`echo "$$file" | sed $(FILENAME) -e s/"^([^-]*)"/sub\1/` ; \
316 if ! echo "$$file" | \
317 grep -q -E -e '^(func|vidioc|pixfmt)-' ; then \
318 echo "<!ENTITY sub-$$entity SYSTEM \"$$file\">" >>$@ ; \
319 fi ; \
320 done)
321 @( \
322 echo -e "\n<!-- Function Reference -->") >>$@
323 @( \
324 for file in $(MEDIA_SGMLS) ; do \
325 if echo "$$file" | \
326 grep -q -E -e '(func|vidioc|pixfmt)-' ; then \
327 entity=`echo "$$file" |sed $(FILENAME)` ; \
328 echo "<!ENTITY $$entity SYSTEM \"$$file\">" >>$@ ; \
329 fi ; \
330 done)
331
332# Jade can auto-generate a list-of-tables, which includes all structs,
333# but we only want data types, all types, and sorted please.
334$(MEDIA_OBJ_DIR)/media-indices.tmpl: $(MEDIA_OBJ_DIR)/v4l2.xml
335 @$($(quiet)gen_xml)
336 @( \
337 echo "<!-- Generated file! Do not edit. -->") >$@
338 @( \
339 echo -e "\n<index><title>List of Types</title>") >>$@
340 @( \
341 for ident in $(TYPES) ; do \
342 id=`echo $$ident | tr _ -` ; \
343 echo "<indexentry><primaryie><link" \
344 "linkend='$$id'>$$ident</link></primaryie></indexentry>" >>$@ ; \
345 done)
346 @( \
347 for ident in $(ENUMS) ; do \
348 id=`echo $$ident | sed -e "s/v4l2_mpeg_cx2341x_video_\([a-z]*_spatial_filter_type\)/\1/" | tr _ -`; \
349 echo "<indexentry><primaryie>enum&nbsp;<link" \
350 "linkend='$$id'>$$ident</link></primaryie></indexentry>" >>$@ ; \
351 done)
352 @( \
353 for ident in $(STRUCTS) ; do \
354 id=`echo $$ident | tr _ - | sed s/v4l2-mpeg-vbi-ITV0/v4l2-mpeg-vbi-itv0-1/g` ; \
355 echo "<indexentry><primaryie>struct&nbsp;<link" \
356 "linkend='$$id'>$$ident</link></primaryie></indexentry>" >>$@ ; \
357 done)
358 @( \
359 echo "</index>") >>$@
360