aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHans Verkuil <hans.verkuil@cisco.com>2013-05-29 06:00:11 -0400
committerMauro Carvalho Chehab <mchehab@redhat.com>2013-06-17 08:18:01 -0400
commitabbec2d401d6698db44e632f5adbef2a47e6e812 (patch)
tree798d8e9e8c6b9b6762b3f6b38fb65f19c7830913
parente9dab5897066aa979db5de02d0751db9734bbf71 (diff)
[media] DocBook/media/v4l: update VIDIOC_DBG_ documentation
- Remove the "On failure the structure remains unchanged." part since that isn't necessarily true. - Document the 'size' field. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
-rw-r--r--Documentation/DocBook/media/v4l/vidioc-dbg-g-chip-info.xml3
-rw-r--r--Documentation/DocBook/media/v4l/vidioc-dbg-g-register.xml15
2 files changed, 11 insertions, 7 deletions
diff --git a/Documentation/DocBook/media/v4l/vidioc-dbg-g-chip-info.xml b/Documentation/DocBook/media/v4l/vidioc-dbg-g-chip-info.xml
index e1cece6c5de1..80e8021369f6 100644
--- a/Documentation/DocBook/media/v4l/vidioc-dbg-g-chip-info.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-dbg-g-chip-info.xml
@@ -73,8 +73,7 @@ fields of a &v4l2-dbg-chip-info;
73and call <constant>VIDIOC_DBG_G_CHIP_INFO</constant> with a pointer to 73and call <constant>VIDIOC_DBG_G_CHIP_INFO</constant> with a pointer to
74this structure. On success the driver stores information about the 74this structure. On success the driver stores information about the
75selected chip in the <structfield>name</structfield> and 75selected chip in the <structfield>name</structfield> and
76<structfield>flags</structfield> fields. On failure the structure 76<structfield>flags</structfield> fields.</para>
77remains unchanged.</para>
78 77
79 <para>When <structfield>match.type</structfield> is 78 <para>When <structfield>match.type</structfield> is
80<constant>V4L2_CHIP_MATCH_BRIDGE</constant>, 79<constant>V4L2_CHIP_MATCH_BRIDGE</constant>,
diff --git a/Documentation/DocBook/media/v4l/vidioc-dbg-g-register.xml b/Documentation/DocBook/media/v4l/vidioc-dbg-g-register.xml
index d13bac9e2445..e23285fad3bf 100644
--- a/Documentation/DocBook/media/v4l/vidioc-dbg-g-register.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-dbg-g-register.xml
@@ -76,7 +76,7 @@ compiled with the <constant>CONFIG_VIDEO_ADV_DEBUG</constant> option
76to enable these ioctls.</para> 76to enable these ioctls.</para>
77 77
78 <para>To write a register applications must initialize all fields 78 <para>To write a register applications must initialize all fields
79of a &v4l2-dbg-register; and call 79of a &v4l2-dbg-register; except for <structfield>size</structfield> and call
80<constant>VIDIOC_DBG_S_REGISTER</constant> with a pointer to this 80<constant>VIDIOC_DBG_S_REGISTER</constant> with a pointer to this
81structure. The <structfield>match.type</structfield> and 81structure. The <structfield>match.type</structfield> and
82<structfield>match.addr</structfield> or <structfield>match.name</structfield> 82<structfield>match.addr</structfield> or <structfield>match.name</structfield>
@@ -91,8 +91,8 @@ written into the register.</para>
91<structfield>reg</structfield> fields, and call 91<structfield>reg</structfield> fields, and call
92<constant>VIDIOC_DBG_G_REGISTER</constant> with a pointer to this 92<constant>VIDIOC_DBG_G_REGISTER</constant> with a pointer to this
93structure. On success the driver stores the register value in the 93structure. On success the driver stores the register value in the
94<structfield>val</structfield> field. On failure the structure remains 94<structfield>val</structfield> field and the size (in bytes) of the
95unchanged.</para> 95value in <structfield>size</structfield>.</para>
96 96
97 <para>When <structfield>match.type</structfield> is 97 <para>When <structfield>match.type</structfield> is
98<constant>V4L2_CHIP_MATCH_BRIDGE</constant>, 98<constant>V4L2_CHIP_MATCH_BRIDGE</constant>,
@@ -150,7 +150,7 @@ LinuxTV v4l-dvb repository; see <ulink
150url="http://linuxtv.org/repo/">http://linuxtv.org/repo/</ulink> for 150url="http://linuxtv.org/repo/">http://linuxtv.org/repo/</ulink> for
151access instructions.</para> 151access instructions.</para>
152 152
153 <!-- Note for convenience vidioc-dbg-g-chip-ident.sgml 153 <!-- Note for convenience vidioc-dbg-g-chip-info.sgml
154 contains a duplicate of this table. --> 154 contains a duplicate of this table. -->
155 <table pgwide="1" frame="none" id="v4l2-dbg-match"> 155 <table pgwide="1" frame="none" id="v4l2-dbg-match">
156 <title>struct <structname>v4l2_dbg_match</structname></title> 156 <title>struct <structname>v4l2_dbg_match</structname></title>
@@ -199,6 +199,11 @@ to the <structfield>type</structfield> field.</entry>
199 <entry>How to match the chip, see <xref linkend="v4l2-dbg-match" />.</entry> 199 <entry>How to match the chip, see <xref linkend="v4l2-dbg-match" />.</entry>
200 </row> 200 </row>
201 <row> 201 <row>
202 <entry>__u32</entry>
203 <entry><structfield>size</structfield></entry>
204 <entry>The register size in bytes.</entry>
205 </row>
206 <row>
202 <entry>__u64</entry> 207 <entry>__u64</entry>
203 <entry><structfield>reg</structfield></entry> 208 <entry><structfield>reg</structfield></entry>
204 <entry>A register number.</entry> 209 <entry>A register number.</entry>
@@ -213,7 +218,7 @@ register.</entry>
213 </tgroup> 218 </tgroup>
214 </table> 219 </table>
215 220
216 <!-- Note for convenience vidioc-dbg-g-chip-ident.sgml 221 <!-- Note for convenience vidioc-dbg-g-chip-info.sgml
217 contains a duplicate of this table. --> 222 contains a duplicate of this table. -->
218 <table pgwide="1" frame="none" id="chip-match-types"> 223 <table pgwide="1" frame="none" id="chip-match-types">
219 <title>Chip Match Types</title> 224 <title>Chip Match Types</title>