Commit dc8b1c0e authored by Hans Verkuil's avatar Hans Verkuil Committed by Mauro Carvalho Chehab

[media] DocBook media: correct description of reserved fields

Make sure that the documentation clearly states who is zeroing reserved
fields: drivers and/or applications.

This patch syncs the documentation with the checks that v4l2-compliance
and valgrind do.
Signed-off-by: default avatarHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@osg.samsung.com>
parent 5d351251
...@@ -841,15 +841,15 @@ is the file descriptor associated with a DMABUF buffer.</entry> ...@@ -841,15 +841,15 @@ is the file descriptor associated with a DMABUF buffer.</entry>
<entry>__u32</entry> <entry>__u32</entry>
<entry><structfield>reserved2</structfield></entry> <entry><structfield>reserved2</structfield></entry>
<entry></entry> <entry></entry>
<entry>A place holder for future extensions. Applications <entry>A place holder for future extensions. Drivers and applications
should set this to 0.</entry> must set this to 0.</entry>
</row> </row>
<row> <row>
<entry>__u32</entry> <entry>__u32</entry>
<entry><structfield>reserved</structfield></entry> <entry><structfield>reserved</structfield></entry>
<entry></entry> <entry></entry>
<entry>A place holder for future extensions. Applications <entry>A place holder for future extensions. Drivers and applications
should set this to 0.</entry> must set this to 0.</entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>
...@@ -930,8 +930,8 @@ should set this to 0.</entry> ...@@ -930,8 +930,8 @@ should set this to 0.</entry>
<entry>__u32</entry> <entry>__u32</entry>
<entry><structfield>reserved[11]</structfield></entry> <entry><structfield>reserved[11]</structfield></entry>
<entry></entry> <entry></entry>
<entry>Reserved for future use. Should be zeroed by an <entry>Reserved for future use. Should be zeroed by drivers and
application.</entry> applications.</entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>
......
...@@ -198,8 +198,8 @@ see <xref linkend="colorspaces" />.</entry> ...@@ -198,8 +198,8 @@ see <xref linkend="colorspaces" />.</entry>
<row> <row>
<entry>__u16</entry> <entry>__u16</entry>
<entry><structfield>reserved[6]</structfield></entry> <entry><structfield>reserved[6]</structfield></entry>
<entry>Reserved for future extensions. Should be zeroed by the <entry>Reserved for future extensions. Should be zeroed by drivers and
application.</entry> applications.</entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>
...@@ -283,8 +283,8 @@ see <xref linkend="colorspaces" />.</entry> ...@@ -283,8 +283,8 @@ see <xref linkend="colorspaces" />.</entry>
<row> <row>
<entry>__u8</entry> <entry>__u8</entry>
<entry><structfield>reserved[7]</structfield></entry> <entry><structfield>reserved[7]</structfield></entry>
<entry>Reserved for future extensions. Should be zeroed by the <entry>Reserved for future extensions. Should be zeroed by drivers
application.</entry> and applications.</entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>
......
...@@ -134,7 +134,8 @@ information.</para> ...@@ -134,7 +134,8 @@ information.</para>
<row> <row>
<entry>__u32</entry> <entry>__u32</entry>
<entry><structfield>reserved</structfield>[8]</entry> <entry><structfield>reserved</structfield>[8]</entry>
<entry>A place holder for future extensions.</entry> <entry>A place holder for future extensions. Drivers and applications
must set the array to zero.</entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>
......
...@@ -217,7 +217,8 @@ enumerated.</entry> ...@@ -217,7 +217,8 @@ enumerated.</entry>
<entry>__u32</entry> <entry>__u32</entry>
<entry><structfield>reserved[2]</structfield></entry> <entry><structfield>reserved[2]</structfield></entry>
<entry></entry> <entry></entry>
<entry>Reserved space for future use.</entry> <entry>Reserved space for future use. Must be zeroed by drivers and
applications.</entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>
......
...@@ -223,7 +223,8 @@ application should zero out all members except for the ...@@ -223,7 +223,8 @@ application should zero out all members except for the
<entry>__u32</entry> <entry>__u32</entry>
<entry><structfield>reserved[2]</structfield></entry> <entry><structfield>reserved[2]</structfield></entry>
<entry></entry> <entry></entry>
<entry>Reserved space for future use.</entry> <entry>Reserved space for future use. Must be zeroed by drivers and
applications.</entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>
......
...@@ -184,7 +184,8 @@ of open() for more details.</entry> ...@@ -184,7 +184,8 @@ of open() for more details.</entry>
<row> <row>
<entry>__u32</entry> <entry>__u32</entry>
<entry><structfield>reserved[11]</structfield></entry> <entry><structfield>reserved[11]</structfield></entry>
<entry>Reserved field for future use. Must be set to zero.</entry> <entry>Reserved field for future use. Drivers and applications must
set the array to zero.</entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>
......
...@@ -199,7 +199,7 @@ exist no rectangle</emphasis> that satisfies the constraints.</para> ...@@ -199,7 +199,7 @@ exist no rectangle</emphasis> that satisfies the constraints.</para>
<row> <row>
<entry>__u32</entry> <entry>__u32</entry>
<entry><structfield>reserved[9]</structfield></entry> <entry><structfield>reserved[9]</structfield></entry>
<entry>Reserved fields for future use.</entry> <entry>Reserved fields for future use. Drivers and applications must zero this array.</entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>
......
...@@ -60,7 +60,8 @@ buffer at any time after buffers have been allocated with the ...@@ -60,7 +60,8 @@ buffer at any time after buffers have been allocated with the
field. Valid index numbers range from zero field. Valid index numbers range from zero
to the number of buffers allocated with &VIDIOC-REQBUFS; to the number of buffers allocated with &VIDIOC-REQBUFS;
(&v4l2-requestbuffers; <structfield>count</structfield>) minus one. (&v4l2-requestbuffers; <structfield>count</structfield>) minus one.
The <structfield>reserved</structfield> field should to set to 0. The <structfield>reserved</structfield> and <structfield>reserved2 </structfield>
fields must be set to 0.
When using the <link linkend="planar-apis">multi-planar API</link>, the When using the <link linkend="planar-apis">multi-planar API</link>, the
<structfield>m.planes</structfield> field must contain a userspace pointer to an <structfield>m.planes</structfield> field must contain a userspace pointer to an
array of &v4l2-plane; and the <structfield>length</structfield> field has array of &v4l2-plane; and the <structfield>length</structfield> field has
......
...@@ -112,8 +112,8 @@ as the &v4l2-format; <structfield>type</structfield> field. See <xref ...@@ -112,8 +112,8 @@ as the &v4l2-format; <structfield>type</structfield> field. See <xref
<row> <row>
<entry>__u32</entry> <entry>__u32</entry>
<entry><structfield>reserved</structfield>[2]</entry> <entry><structfield>reserved</structfield>[2]</entry>
<entry>A place holder for future extensions. This array should <entry>A place holder for future extensions. Drivers and applications
be zeroed by applications.</entry> must set the array to zero.</entry>
</row> </row>
</tbody> </tbody>
</tgroup> </tgroup>
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment