Skip to contentSkip to conversation

DocBook/media: add CEC documentation

PATCH New Hans Verkuil 1 participant 1 message Apr 27, 2015

Subsystems (4)
Documentation Media (V4L/DVB) HID Arm Samsung Exynos
lore
Share & tools
lore

Hans Verkuil

author
#0 lore raw

PATCH 1/1 DocBook/media: add CEC documentation

(Kamil, here is the DocBook documentation for the CEC API. Please add this to your patch series when you post the next version of that.)
---

Add the documentation for the public CEC API.

Signed-off-by Hans Verkuil <[email protected]>
---
 Documentation/DocBook/media/Makefile               |   4 +-
 Documentation/DocBook/media/v4l/biblio.xml         |  10 +
 Documentation/DocBook/media/v4l/cec-api.xml        |  73 ++++++
 Documentation/DocBook/media/v4l/cec-func-close.xml |  59 +++++
 Documentation/DocBook/media/v4l/cec-func-ioctl.xml |  73 ++++++
 Documentation/DocBook/media/v4l/cec-func-open.xml  |  94 +++++++
 Documentation/DocBook/media/v4l/cec-func-poll.xml  |  89 +++++++
 .../DocBook/media/v4l/cec-ioc-g-adap-log-addrs.xml | 275 +++++++++++++++++++++
 .../DocBook/media/v4l/cec-ioc-g-adap-phys-addr.xml |  78 ++++++
 .../DocBook/media/v4l/cec-ioc-g-adap-state.xml     |  87 +++++++
 Documentation/DocBook/media/v4l/cec-ioc-g-caps.xml | 167 +++++++++++++
 .../DocBook/media/v4l/cec-ioc-g-event.xml          | 128 ++++++++++
 .../DocBook/media/v4l/cec-ioc-g-vendor-id.xml      |  70 ++++++
 .../DocBook/media/v4l/cec-ioc-receive.xml          | 176 +++++++++++++
 Documentation/DocBook/media_api.tmpl               |   6 +-
 15 files changed, 1386 insertions(+), 3 deletions(-)
 create mode 100644 Documentation/DocBook/media/v4l/cec-api.xml
 create mode 100644 Documentation/DocBook/media/v4l/cec-func-close.xml
 create mode 100644 Documentation/DocBook/media/v4l/cec-func-ioctl.xml
 create mode 100644 Documentation/DocBook/media/v4l/cec-func-open.xml
 create mode 100644 Documentation/DocBook/media/v4l/cec-func-poll.xml
 create mode 100644 Documentation/DocBook/media/v4l/cec-ioc-g-adap-log-addrs.xml
 create mode 100644 Documentation/DocBook/media/v4l/cec-ioc-g-adap-phys-addr.xml
 create mode 100644 Documentation/DocBook/media/v4l/cec-ioc-g-adap-state.xml
 create mode 100644 Documentation/DocBook/media/v4l/cec-ioc-g-caps.xml
 create mode 100644 Documentation/DocBook/media/v4l/cec-ioc-g-event.xml
 create mode 100644 Documentation/DocBook/media/v4l/cec-ioc-g-vendor-id.xml
 create mode 100644 Documentation/DocBook/media/v4l/cec-ioc-receive.xml
Documentation/DocBook/media/Makefile +3 -1
index 8bf7c61..9650332 100644
@@ -64,6 +64,7 @@ IOCTLS = \
 	$(shell perl -ne 'print "$$1 " if /\#define\s+([A-Z][^\s]+)\s+_IO/' $(srctree)/include/uapi/linux/dvb/net.h) \
 	$(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/uapi/linux/dvb/video.h) \
 	$(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/uapi/linux/media.h) \
+	$(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/uapi/linux/cec.h) \
 	$(shell perl -ne 'print "$$1 " if /\#define\s+([^\s]+)\s+_IO/' $(srctree)/include/uapi/linux/v4l2-subdev.h) \
 	VIDIOC_SUBDEV_G_FRAME_INTERVAL \
 	VIDIOC_SUBDEV_S_FRAME_INTERVAL \

@@ -98,6 +99,7 @@ STRUCTS = \
 	$(shell perl -ne 'print "$$1 " if (/^struct\s+([A-Z][^\s]+)\s+/)' $(srctree)/include/uapi/linux/dvb/net.h) \
 	$(shell perl -ne 'print "$$1 " if (/^struct\s+([^\s]+)\s+/)' $(srctree)/include/uapi/linux/dvb/video.h) \
 	$(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/uapi/linux/media.h) \
+	$(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/uapi/linux/cec.h) \
 	$(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/uapi/linux/v4l2-subdev.h) \
 	$(shell perl -ne 'print "$$1 " if /^struct\s+([^\s]+)\s+/' $(srctree)/include/uapi/linux/v4l2-mediabus.h)
 

@@ -300,7 +302,7 @@ $(MEDIA_OBJ_DIR)/media-entities.tmpl: $(MEDIA_OBJ_DIR)/v4l2.xml
 	@(								\
 	for ident in $(IOCTLS) ; do					\
 	  entity=`echo $$ident | tr _ -` ;				\
-	  id=`grep "<refname>$$ident" $(MEDIA_OBJ_DIR)/vidioc-*.xml $(MEDIA_OBJ_DIR)/media-ioc-*.xml | sed -r s,"^.*/(.*).xml.*","\1",` ; \
+	  id=`grep "<refname>$$ident" $(MEDIA_OBJ_DIR)/vidioc-*.xml $(MEDIA_OBJ_DIR)/media-ioc-*.xml $(MEDIA_OBJ_DIR)/cec-ioc-*.xml | sed -r s,"^.*/(.*).xml.*","\1",` ; \
 	  echo "<!ENTITY $$entity \"<link"				\
 	    "linkend='$$id'><constant>$$ident</constant></link>\">"	\
 	  >>$@ ;							\
Documentation/DocBook/media/v4l/biblio.xml +10 -0
index fdee6b3..bed940b 100644
@@ -324,6 +324,16 @@ in the frequency range from 87,5 to 108,0 MHz</title>
       <subtitle>Specification Version 1.4a</subtitle>
     </biblioentry>
 
+    <biblioentry id="hdmi2">
+      <abbrev>HDMI2</abbrev>
+      <authorgroup>
+	<corpauthor>HDMI Licensing LLC
+(<ulink url="http://www.hdmi.org">http://www.hdmi.org</ulink>)</corpauthor>
+      </authorgroup>
+      <title>High-Definition Multimedia Interface</title>
+      <subtitle>Specification Version 2.0</subtitle>
+    </biblioentry>
+
     <biblioentry id="dp">
       <abbrev>DP</abbrev>
       <authorgroup>
Documentation/DocBook/media/v4l/cec-api.xml new file +73 -0

73 lines not on this page · raw message

Documentation/DocBook/media/v4l/cec-func-close.xml new file +59 -0

59 lines not on this page · raw message

Documentation/DocBook/media/v4l/cec-func-ioctl.xml new file +73 -0

73 lines not on this page · raw message

Documentation/DocBook/media/v4l/cec-func-open.xml new file +94 -0

94 lines not on this page · raw message

Documentation/DocBook/media/v4l/cec-func-poll.xml new file +89 -0

89 lines not on this page · raw message

Documentation/DocBook/media/v4l/cec-ioc-g-adap-log-addrs.xml new file +275 -0

275 lines not on this page · raw message

Documentation/DocBook/media/v4l/cec-ioc-g-adap-phys-addr.xml new file +78 -0

78 lines not on this page · raw message

Documentation/DocBook/media/v4l/cec-ioc-g-adap-state.xml new file +87 -0

87 lines not on this page · raw message

Documentation/DocBook/media/v4l/cec-ioc-g-caps.xml new file +167 -0

167 lines not on this page · raw message

Documentation/DocBook/media/v4l/cec-ioc-g-event.xml new file +128 -0

128 lines not on this page · raw message

Documentation/DocBook/media/v4l/cec-ioc-g-vendor-id.xml new file +70 -0

70 lines not on this page · raw message

Documentation/DocBook/media/v4l/cec-ioc-receive.xml new file +176 -0

176 lines not on this page · raw message

Documentation/DocBook/media_api.tmpl +4 -2
index 03f9a1f..ebddc3f 100644
@@ -37,7 +37,7 @@
 	<title>LINUX MEDIA INFRASTRUCTURE API</title>
 
 	<copyright>
-		<year>2009-2014</year>
+		<year>2009-2015</year>
 		<holder>LinuxTV Developers</holder>
 	</copyright>
 

@@ -60,7 +60,7 @@
 		analog and digital TV receiver cards, AM/FM receiver cards,
 		streaming capture and output devices, codec devices and remote
 		controllers.</para>
-	<para>It is divided into four parts.</para>
+	<para>It is divided into five parts.</para>
 	<para>The first part covers radio, video capture and output,
 		cameras, analog TV devices and codecs.</para>
 	<para>The second part covers the

@@ -71,6 +71,7 @@
 		to document support also for DVB-S2, ISDB-T and ISDB-S.</para>
 	<para>The third part covers the Remote Controller API.</para>
 	<para>The fourth part covers the Media Controller API.</para>
+	<para>The fifth part covers the CEC (Consumer Electronics Control) API.</para>
 	<para>For additional information and for the latest development code,
 		see: <ulink url="http://linuxtv.org">http://linuxtv.org</ulink>.</para>
 	<para>For discussing improvements, reporting troubles, sending new drivers, etc, please mail to: <ulink url="http://vger.kernel.org/vger-lists.html#linux-media">Linux Media Mailing List (LMML).</ulink>.</para>

@@ -80,6 +81,7 @@
 <part id="dvbapi">&sub-dvbapi;</part>
 <part id="remotes">&sub-remote_controllers;</part>
 <part id="media_common">&sub-media-controller;</part>
+<part id="cec">&sub-cec-api;</part>
 
 <chapter id="gen_errors">&sub-gen-errors;</chapter>
Signature · 1 line
2.1.4