Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

[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>

authored by

Hans Verkuil and committed by
Mauro Carvalho Chehab
abbec2d4 e9dab589

+11 -7
+1 -2
Documentation/DocBook/media/v4l/vidioc-dbg-g-chip-info.xml
··· 73 73 and call <constant>VIDIOC_DBG_G_CHIP_INFO</constant> with a pointer to 74 74 this structure. On success the driver stores information about the 75 75 selected chip in the <structfield>name</structfield> and 76 - <structfield>flags</structfield> fields. On failure the structure 77 - remains unchanged.</para> 76 + <structfield>flags</structfield> fields.</para> 78 77 79 78 <para>When <structfield>match.type</structfield> is 80 79 <constant>V4L2_CHIP_MATCH_BRIDGE</constant>,
+10 -5
Documentation/DocBook/media/v4l/vidioc-dbg-g-register.xml
··· 76 76 to enable these ioctls.</para> 77 77 78 78 <para>To write a register applications must initialize all fields 79 - of a &v4l2-dbg-register; and call 79 + of a &v4l2-dbg-register; except for <structfield>size</structfield> and call 80 80 <constant>VIDIOC_DBG_S_REGISTER</constant> with a pointer to this 81 81 structure. The <structfield>match.type</structfield> and 82 82 <structfield>match.addr</structfield> or <structfield>match.name</structfield> ··· 91 91 <structfield>reg</structfield> fields, and call 92 92 <constant>VIDIOC_DBG_G_REGISTER</constant> with a pointer to this 93 93 structure. On success the driver stores the register value in the 94 - <structfield>val</structfield> field. On failure the structure remains 95 - unchanged.</para> 94 + <structfield>val</structfield> field and the size (in bytes) of the 95 + value in <structfield>size</structfield>.</para> 96 96 97 97 <para>When <structfield>match.type</structfield> is 98 98 <constant>V4L2_CHIP_MATCH_BRIDGE</constant>, ··· 150 150 url="http://linuxtv.org/repo/">http://linuxtv.org/repo/</ulink> for 151 151 access 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 154 contains a duplicate of this table. --> 155 155 <table pgwide="1" frame="none" id="v4l2-dbg-match"> 156 156 <title>struct <structname>v4l2_dbg_match</structname></title> ··· 199 199 <entry>How to match the chip, see <xref linkend="v4l2-dbg-match" />.</entry> 200 200 </row> 201 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 207 <entry>__u64</entry> 203 208 <entry><structfield>reg</structfield></entry> 204 209 <entry>A register number.</entry> ··· 218 213 </tgroup> 219 214 </table> 220 215 221 - <!-- Note for convenience vidioc-dbg-g-chip-ident.sgml 216 + <!-- Note for convenience vidioc-dbg-g-chip-info.sgml 222 217 contains a duplicate of this table. --> 223 218 <table pgwide="1" frame="none" id="chip-match-types"> 224 219 <title>Chip Match Types</title>