[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: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>

diff --git a/Documentation/DocBook/media/v4l/io.xml b/Documentation/DocBook/media/v4l/io.xml
index bfe666204888d498d52a59fe139779ff1cfa1478..7bbc2a48911ea26b876f2ed92ab70d881e5c38e1 100644 (file)
--- a/Documentation/DocBook/media/v4l/io.xml
+++ b/Documentation/DocBook/media/v4l/io.xml
@@ -841,15 +841,15 @@ is the file descriptor associated with a DMABUF buffer.</entry>
            <entry>__u32</entry>
            <entry><structfield>reserved2</structfield></entry>
            <entry></entry>
-           <entry>A place holder for future extensions. Applications
-should set this to 0.</entry>
+           <entry>A place holder for future extensions. Drivers and applications
+must set this to 0.</entry>
          </row>
          <row>
            <entry>__u32</entry>
            <entry><structfield>reserved</structfield></entry>
            <entry></entry>
-           <entry>A place holder for future extensions. Applications
-should set this to 0.</entry>
+           <entry>A place holder for future extensions. Drivers and applications
+must set this to 0.</entry>
          </row>
        </tbody>
       </tgroup>
@@ -930,8 +930,8 @@ should set this to 0.</entry>
            <entry>__u32</entry>
            <entry><structfield>reserved[11]</structfield></entry>
            <entry></entry>
-           <entry>Reserved for future use. Should be zeroed by an
-           application.</entry>
+           <entry>Reserved for future use. Should be zeroed by drivers and
+           applications.</entry>
          </row>
        </tbody>
       </tgroup>

diff --git a/Documentation/DocBook/media/v4l/pixfmt.xml b/Documentation/DocBook/media/v4l/pixfmt.xml
index e7d88482a522477afd86a0e2f0d16c938e185dd7..965ea916784a1316800d2714030a9bf2c15701e2 100644 (file)
--- a/Documentation/DocBook/media/v4l/pixfmt.xml
+++ b/Documentation/DocBook/media/v4l/pixfmt.xml
@@ -198,8 +198,8 @@ see <xref linkend="colorspaces" />.</entry>
         <row>
           <entry>__u16</entry>
           <entry><structfield>reserved[6]</structfield></entry>
-          <entry>Reserved for future extensions. Should be zeroed by the
-           application.</entry>
+          <entry>Reserved for future extensions. Should be zeroed by drivers and
+           applications.</entry>
         </row>
       </tbody>
     </tgroup>
@@ -283,8 +283,8 @@ see <xref linkend="colorspaces" />.</entry>
         <row>
           <entry>__u8</entry>
           <entry><structfield>reserved[7]</structfield></entry>
-          <entry>Reserved for future extensions. Should be zeroed by the
-           application.</entry>
+          <entry>Reserved for future extensions. Should be zeroed by drivers
+           and applications.</entry>
         </row>
       </tbody>
     </tgroup>

diff --git a/Documentation/DocBook/media/v4l/vidioc-create-bufs.xml b/Documentation/DocBook/media/v4l/vidioc-create-bufs.xml
index 9b700a5f4df76406a88f14fc1cf8c0276b44af48..8ffe74f84af1f40209cf028e0a217e0b81dc3bb5 100644 (file)
--- a/Documentation/DocBook/media/v4l/vidioc-create-bufs.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-create-bufs.xml
@@ -134,7 +134,8 @@ information.</para>
          <row>
            <entry>__u32</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>
        </tbody>
       </tgroup>

diff --git a/Documentation/DocBook/media/v4l/vidioc-enum-frameintervals.xml b/Documentation/DocBook/media/v4l/vidioc-enum-frameintervals.xml
index 5fd72c4c33e352ba3edded10ee5ad27fc87f6d86..7c839ab0afbb76e379bdd4a064d1ed19d889bb97 100644 (file)
--- a/Documentation/DocBook/media/v4l/vidioc-enum-frameintervals.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-enum-frameintervals.xml
@@ -217,7 +217,8 @@ enumerated.</entry>
            <entry>__u32</entry>
            <entry><structfield>reserved[2]</structfield></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>
        </tbody>
       </tgroup>

diff --git a/Documentation/DocBook/media/v4l/vidioc-enum-framesizes.xml b/Documentation/DocBook/media/v4l/vidioc-enum-framesizes.xml
index a78454b5abcd875e517418f4b803ebed1dce8b1a..9ed68ac8f4743ce8e72227ea0161185ecd622c9c 100644 (file)
--- a/Documentation/DocBook/media/v4l/vidioc-enum-framesizes.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-enum-framesizes.xml
@@ -223,7 +223,8 @@ application should zero out all members except for the
            <entry>__u32</entry>
            <entry><structfield>reserved[2]</structfield></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>
        </tbody>
       </tgroup>

diff --git a/Documentation/DocBook/media/v4l/vidioc-expbuf.xml b/Documentation/DocBook/media/v4l/vidioc-expbuf.xml
index 4165e7bfa4ff7560c0283213e53a54b1575ab2e8..a78c9207422f7ab60360fb53021070e8b03b878c 100644 (file)
--- a/Documentation/DocBook/media/v4l/vidioc-expbuf.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-expbuf.xml
@@ -184,7 +184,8 @@ of open() for more details.</entry>
          <row>
            <entry>__u32</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>
        </tbody>
       </tgroup>

diff --git a/Documentation/DocBook/media/v4l/vidioc-g-selection.xml b/Documentation/DocBook/media/v4l/vidioc-g-selection.xml
index 0bb5c060db27847a7a93e2f22ae51743fe413d11..7865351688dab04383009f173731a7778a9868f9 100644 (file)
--- a/Documentation/DocBook/media/v4l/vidioc-g-selection.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-g-selection.xml
@@ -199,7 +199,7 @@ exist no rectangle</emphasis> that satisfies the constraints.</para>
          <row>
            <entry>__u32</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>
        </tbody>
       </tgroup>

diff --git a/Documentation/DocBook/media/v4l/vidioc-querybuf.xml b/Documentation/DocBook/media/v4l/vidioc-querybuf.xml
index a597155c052d723b7b5c5867f67c564dd2eacebe..50bfcb5e8508a4a2e26ca074c1401e613c83d5f2 100644 (file)
--- a/Documentation/DocBook/media/v4l/vidioc-querybuf.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-querybuf.xml
@@ -60,7 +60,8 @@ buffer at any time after buffers have been allocated with the
     field. Valid index numbers range from zero
 to the number of buffers allocated with &VIDIOC-REQBUFS;
     (&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
 <structfield>m.planes</structfield> field must contain a userspace pointer to an
 array of &v4l2-plane; and the <structfield>length</structfield> field has

diff --git a/Documentation/DocBook/media/v4l/vidioc-reqbufs.xml b/Documentation/DocBook/media/v4l/vidioc-reqbufs.xml
index 78a06a9a5ece18c3cfe6967f8c18822e89ace6fa..0f193fda0470fd7ab2c6811914b1caf1196c5485 100644 (file)
--- a/Documentation/DocBook/media/v4l/vidioc-reqbufs.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-reqbufs.xml
@@ -112,8 +112,8 @@ as the &v4l2-format; <structfield>type</structfield> field. See <xref
          <row>
            <entry>__u32</entry>
            <entry><structfield>reserved</structfield>[2]</entry>
-           <entry>A place holder for future extensions. This array should
-be zeroed by applications.</entry>
+           <entry>A place holder for future extensions. Drivers and applications
+must set the array to zero.</entry>
          </row>
        </tbody>
       </tgroup>