Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

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

[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

Documentation/DocBook/media/v4l/io.xml

+6 −6
Original line number Diff line number Diff line
@@ -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>

Documentation/DocBook/media/v4l/pixfmt.xml

+4 −4
Original line number Diff line number Diff line
@@ -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>

Documentation/DocBook/media/v4l/vidioc-create-bufs.xml

+2 −1
Original line number Diff line number Diff line
@@ -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>

Documentation/DocBook/media/v4l/vidioc-enum-frameintervals.xml

+2 −1
Original line number Diff line number Diff line
@@ -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>

Documentation/DocBook/media/v4l/vidioc-enum-framesizes.xml

+2 −1
Original line number Diff line number Diff line
@@ -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>