Makefile 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268
  1. ###
  2. # Media build rules - Auto-generates media contents/indexes and *.h xml's
  3. #
  4. SHELL=/bin/bash
  5. MEDIA_OBJ_DIR=$(objtree)/Documentation/DocBook/
  6. MEDIA_SRC_DIR=$(srctree)/Documentation/DocBook/media
  7. MEDIA_TEMP = media-entities.tmpl \
  8. media-indices.tmpl \
  9. videodev2.h.xml \
  10. v4l2.xml \
  11. frontend.h.xml
  12. IMGFILES := $(addprefix $(MEDIA_OBJ_DIR)/media/, $(notdir $(shell ls $(MEDIA_SRC_DIR)/*/*.gif $(MEDIA_SRC_DIR)/*/*.png)))
  13. GENFILES := $(addprefix $(MEDIA_OBJ_DIR)/, $(MEDIA_TEMP))
  14. PHONY += cleanmediadocs mediaindexdocs
  15. cleanmediadocs:
  16. -@rm `find $(MEDIA_OBJ_DIR) -type l` $(GENFILES) $(IMGFILES)
  17. $(obj)/media_api.xml: $(GENFILES) FORCE
  18. #$(MEDIA_OBJ_DIR)/media_api.html: $(MEDIA_OBJ_DIR)/media_api.xml
  19. #$(MEDIA_OBJ_DIR)/media_api.pdf: $(MEDIA_OBJ_DIR)/media_api.xml
  20. #$(MEDIA_OBJ_DIR)/media_api.ps: $(MEDIA_OBJ_DIR)/media_api.xml
  21. V4L_SGMLS = \
  22. $(shell ls $(MEDIA_SRC_DIR)/v4l/*.xml|perl -ne 'print "$$1 " if (m,.*/(.*)\n,)') \
  23. capture.c.xml \
  24. keytable.c.xml \
  25. v4l2grab.c.xml
  26. DVB_SGMLS = \
  27. $(shell ls $(MEDIA_SRC_DIR)/dvb/*.xml|perl -ne 'print "$$1 " if (m,.*/(.*)\n,)')
  28. MEDIA_SGMLS = $(addprefix ./,$(V4L_SGMLS)) $(addprefix ./,$(DVB_SGMLS)) $(addprefix ./,$(MEDIA_TEMP))
  29. FUNCS = \
  30. close \
  31. ioctl \
  32. mmap \
  33. munmap \
  34. open \
  35. poll \
  36. read \
  37. select \
  38. write \
  39. IOCTLS = \
  40. $(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/videodev2.h) \
  41. $(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/dvb/frontend.h) \
  42. $(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/media.h) \
  43. $(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/linux/v4l2-subdev.h) \
  44. VIDIOC_SUBDEV_G_FRAME_INTERVAL \
  45. VIDIOC_SUBDEV_S_FRAME_INTERVAL \
  46. VIDIOC_SUBDEV_ENUM_MBUS_CODE \
  47. VIDIOC_SUBDEV_ENUM_FRAME_SIZE \
  48. VIDIOC_SUBDEV_ENUM_FRAME_INTERVAL \
  49. TYPES = \
  50. $(shell perl -ne 'print "$$1 " if /^typedef\s+[^\s]+\s+([^\s]+)\;/' $(srctree)/include/linux/videodev2.h) \
  51. $(shell perl -ne 'print "$$1 " if /^}\s+([a-z0-9_]+_t)/' $(srctree)/include/linux/dvb/frontend.h)
  52. ENUMS = \
  53. $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/videodev2.h) \
  54. $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/dvb/frontend.h) \
  55. $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/media.h) \
  56. $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-mediabus.h) \
  57. $(shell perl -ne 'print "$$1 " if /^enum\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-subdev.h)
  58. STRUCTS = \
  59. $(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/videodev2.h) \
  60. $(shell perl -ne 'print "$$1 " if (!/dtv\_cmds\_h/ && /^struct\s+([^\s]+)\s+/)' $(srctree)/include/linux/dvb/frontend.h) \
  61. $(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/media.h) \
  62. $(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-subdev.h) \
  63. $(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/linux/v4l2-mediabus.h)
  64. ERRORS = \
  65. EACCES \
  66. EAGAIN \
  67. EBADF \
  68. EBUSY \
  69. EFAULT \
  70. EIO \
  71. EINTR \
  72. EINVAL \
  73. ENFILE \
  74. ENOMEM \
  75. ENOSPC \
  76. ENOTTY \
  77. ENXIO \
  78. EMFILE \
  79. EPERM \
  80. ERANGE \
  81. EPIPE \
  82. ESCAPE = \
  83. -e "s/&/\\&/g" \
  84. -e "s/</\\&lt;/g" \
  85. -e "s/>/\\&gt;/g"
  86. FILENAME = \
  87. -e s,"^[^\/]*/",, \
  88. -e s/"\\.xml"// \
  89. -e s/"\\.tmpl"// \
  90. -e s/\\\./-/g \
  91. -e s/"^func-"// \
  92. -e s/"^pixfmt-"// \
  93. -e s/"^vidioc-"//
  94. # Generate references to these structs in videodev2.h.xml.
  95. DOCUMENTED = \
  96. -e "s/\(enum *\)v4l2_mpeg_cx2341x_video_\([a-z]*_spatial_filter_type\)/\1<link linkend=\"\2\">v4l2_mpeg_cx2341x_video_\2<\/link>/g" \
  97. -e "s/\(\(enum\|struct\) *\)\(v4l2_[a-zA-Z0-9_]*\)/\1<link linkend=\"\3\">\3<\/link>/g" \
  98. -e "s/\(V4L2_PIX_FMT_[A-Z0-9_]\+\) /<link linkend=\"\1\">\1<\/link> /g" \
  99. -e ":a;s/\(linkend=\".*\)_\(.*\">\)/\1-\2/;ta" \
  100. -e "s/v4l2\-mpeg\-vbi\-ITV0/v4l2-mpeg-vbi-itv0-1/g"
  101. DVB_DOCUMENTED = \
  102. -e "s/\(linkend\=\"\)FE_SET_PROPERTY/\1FE_GET_PROPERTY/g" \
  103. -e "s,\(struct\s\+\)\([a-z0-9_]\+\)\(\s\+{\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \
  104. -e "s,\(}\s\+\)\([a-z0-9_]\+_t\+\),\1\<link linkend=\"\2\">\2\<\/link\>,g" \
  105. -e "s,\(define\s\+\)\(DTV_[A-Z0-9_]\+\)\(\s\+[0-9]\+\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \
  106. -e "s,<link linkend=\".*\">\(DTV_IOCTL_MAX_MSGS\|dtv_cmds_h\)<\/link>,\1,g" \
  107. -e ":a;s/\(linkend=\".*\)_\(.*\">\)/\1-\2/;ta" \
  108. -e "s,DTV-ISDBT-LAYER[A-C],DTV-ISDBT-LAYER,g" \
  109. -e "s,\(define\s\+\)\([A-Z0-9_]\+\)\(\s\+_IO\),\1\<link linkend=\"\2\">\2\<\/link\>\3,g" \
  110. #
  111. # Media targets and dependencies
  112. #
  113. $(MEDIA_OBJ_DIR)/v4l2.xml:
  114. @$($(quiet)gen_xml)
  115. @(mkdir -p $(MEDIA_OBJ_DIR)/media)
  116. @(cp $(MEDIA_SRC_DIR)/dvb/*.png $(MEDIA_SRC_DIR)/v4l/*.gif $(MEDIA_OBJ_DIR)/media/)
  117. @(ln -sf $(MEDIA_SRC_DIR)/v4l/*xml $(MEDIA_OBJ_DIR)/)
  118. @(ln -sf $(MEDIA_SRC_DIR)/dvb/*xml $(MEDIA_OBJ_DIR)/)
  119. $(MEDIA_OBJ_DIR)/videodev2.h.xml: $(srctree)/include/linux/videodev2.h $(MEDIA_OBJ_DIR)/v4l2.xml
  120. @$($(quiet)gen_xml)
  121. @( \
  122. echo "<programlisting>") > $@
  123. @( \
  124. expand --tabs=8 < $< | \
  125. sed $(ESCAPE) $(DOCUMENTED) | \
  126. sed 's/i\.e\./&ie;/') >> $@
  127. @( \
  128. echo "</programlisting>") >> $@
  129. $(MEDIA_OBJ_DIR)/frontend.h.xml: $(srctree)/include/linux/dvb/frontend.h $(MEDIA_OBJ_DIR)/v4l2.xml
  130. @$($(quiet)gen_xml)
  131. @( \
  132. echo "<programlisting>") > $@
  133. @( \
  134. expand --tabs=8 < $< | \
  135. sed $(ESCAPE) $(DVB_DOCUMENTED) | \
  136. sed 's/i\.e\./&ie;/') >> $@
  137. @( \
  138. echo "</programlisting>") >> $@
  139. $(MEDIA_OBJ_DIR)/media-entities.tmpl: $(MEDIA_OBJ_DIR)/v4l2.xml
  140. @$($(quiet)gen_xml)
  141. @( \
  142. echo "<!-- Generated file! Do not edit. -->") >$@
  143. @( \
  144. echo -e "\n<!-- Functions -->") >>$@
  145. @( \
  146. for ident in $(FUNCS) ; do \
  147. entity=`echo $$ident | tr _ -` ; \
  148. echo "<!ENTITY func-$$entity \"<link" \
  149. "linkend='func-$$entity'><function>$$ident()</function></link>\">" \
  150. >>$@ ; \
  151. done)
  152. @( \
  153. echo -e "\n<!-- Ioctls -->") >>$@
  154. @( \
  155. for ident in $(IOCTLS) ; do \
  156. entity=`echo $$ident | tr _ -` ; \
  157. id=`grep "<refname>$$ident" $(MEDIA_OBJ_DIR)/vidioc-*.xml | sed -r s,"^.*/(.*).xml.*","\1",` ; \
  158. echo "<!ENTITY $$entity \"<link" \
  159. "linkend='$$id'><constant>$$ident</constant></link>\">" \
  160. >>$@ ; \
  161. done)
  162. @( \
  163. echo -e "\n<!-- Types -->") >>$@
  164. @( \
  165. for ident in $(TYPES) ; do \
  166. entity=`echo $$ident | tr _ -` ; \
  167. echo "<!ENTITY $$entity \"<link" \
  168. "linkend='$$entity'>$$ident</link>\">" >>$@ ; \
  169. done)
  170. @( \
  171. echo -e "\n<!-- Enums -->") >>$@
  172. @( \
  173. for ident in $(ENUMS) ; do \
  174. entity=`echo $$ident | sed -e "s/v4l2_mpeg_cx2341x_video_\([a-z]*_spatial_filter_type\)/\1/" | tr _ -` ; \
  175. echo "<!ENTITY $$entity \"enum&nbsp;<link" \
  176. "linkend='$$entity'>$$ident</link>\">" >>$@ ; \
  177. done)
  178. @( \
  179. echo -e "\n<!-- Structures -->") >>$@
  180. @( \
  181. for ident in $(STRUCTS) ; do \
  182. entity=`echo $$ident | tr _ - | sed s/v4l2-mpeg-vbi-ITV0/v4l2-mpeg-vbi-itv0-1/g` ; \
  183. echo "<!ENTITY $$entity \"struct&nbsp;<link" \
  184. "linkend='$$entity'>$$ident</link>\">" >>$@ ; \
  185. done)
  186. @( \
  187. echo -e "\n<!-- Error Codes -->") >>$@
  188. @( \
  189. for ident in $(ERRORS) ; do \
  190. echo "<!ENTITY $$ident \"<errorcode>$$ident</errorcode>" \
  191. "error code\">" >>$@ ; \
  192. done)
  193. @( \
  194. echo -e "\n<!-- Subsections -->") >>$@
  195. @( \
  196. for file in $(MEDIA_SGMLS) ; do \
  197. entity=`echo "$$file" | sed $(FILENAME) -e s/"^([^-]*)"/sub\1/` ; \
  198. if ! echo "$$file" | \
  199. grep -q -E -e '^(func|vidioc|pixfmt)-' ; then \
  200. echo "<!ENTITY sub-$$entity SYSTEM \"$$file\">" >>$@ ; \
  201. fi ; \
  202. done)
  203. @( \
  204. echo -e "\n<!-- Function Reference -->") >>$@
  205. @( \
  206. for file in $(MEDIA_SGMLS) ; do \
  207. if echo "$$file" | \
  208. grep -q -E -e '(func|vidioc|pixfmt)-' ; then \
  209. entity=`echo "$$file" |sed $(FILENAME)` ; \
  210. echo "<!ENTITY $$entity SYSTEM \"$$file\">" >>$@ ; \
  211. fi ; \
  212. done)
  213. # Jade can auto-generate a list-of-tables, which includes all structs,
  214. # but we only want data types, all types, and sorted please.
  215. $(MEDIA_OBJ_DIR)/media-indices.tmpl: $(MEDIA_OBJ_DIR)/v4l2.xml
  216. @$($(quiet)gen_xml)
  217. @( \
  218. echo "<!-- Generated file! Do not edit. -->") >$@
  219. @( \
  220. echo -e "\n<index><title>List of Types</title>") >>$@
  221. @( \
  222. for ident in $(TYPES) ; do \
  223. id=`echo $$ident | tr _ -` ; \
  224. echo "<indexentry><primaryie><link" \
  225. "linkend='$$id'>$$ident</link></primaryie></indexentry>" >>$@ ; \
  226. done)
  227. @( \
  228. for ident in $(ENUMS) ; do \
  229. id=`echo $$ident | sed -e "s/v4l2_mpeg_cx2341x_video_\([a-z]*_spatial_filter_type\)/\1/" | tr _ -`; \
  230. echo "<indexentry><primaryie>enum&nbsp;<link" \
  231. "linkend='$$id'>$$ident</link></primaryie></indexentry>" >>$@ ; \
  232. done)
  233. @( \
  234. for ident in $(STRUCTS) ; do \
  235. id=`echo $$ident | tr _ - | sed s/v4l2-mpeg-vbi-ITV0/v4l2-mpeg-vbi-itv0-1/g` ; \
  236. echo "<indexentry><primaryie>struct&nbsp;<link" \
  237. "linkend='$$id'>$$ident</link></primaryie></indexentry>" >>$@ ; \
  238. done)
  239. @( \
  240. echo "</index>") >>$@