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

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

authored by

Hans Verkuil and committed by
Mauro Carvalho Chehab
dc8b1c0e 5d351251

+23 -18
+6 -6
Documentation/DocBook/media/v4l/io.xml
··· 841 841 <entry>__u32</entry> 842 842 <entry><structfield>reserved2</structfield></entry> 843 843 <entry></entry> 844 - <entry>A place holder for future extensions. Applications 845 - should set this to 0.</entry> 844 + <entry>A place holder for future extensions. Drivers and applications 845 + must set this to 0.</entry> 846 846 </row> 847 847 <row> 848 848 <entry>__u32</entry> 849 849 <entry><structfield>reserved</structfield></entry> 850 850 <entry></entry> 851 - <entry>A place holder for future extensions. Applications 852 - should set this to 0.</entry> 851 + <entry>A place holder for future extensions. Drivers and applications 852 + must set this to 0.</entry> 853 853 </row> 854 854 </tbody> 855 855 </tgroup> ··· 930 930 <entry>__u32</entry> 931 931 <entry><structfield>reserved[11]</structfield></entry> 932 932 <entry></entry> 933 - <entry>Reserved for future use. Should be zeroed by an 934 - application.</entry> 933 + <entry>Reserved for future use. Should be zeroed by drivers and 934 + applications.</entry> 935 935 </row> 936 936 </tbody> 937 937 </tgroup>
+4 -4
Documentation/DocBook/media/v4l/pixfmt.xml
··· 198 198 <row> 199 199 <entry>__u16</entry> 200 200 <entry><structfield>reserved[6]</structfield></entry> 201 - <entry>Reserved for future extensions. Should be zeroed by the 202 - application.</entry> 201 + <entry>Reserved for future extensions. Should be zeroed by drivers and 202 + applications.</entry> 203 203 </row> 204 204 </tbody> 205 205 </tgroup> ··· 283 283 <row> 284 284 <entry>__u8</entry> 285 285 <entry><structfield>reserved[7]</structfield></entry> 286 - <entry>Reserved for future extensions. Should be zeroed by the 287 - application.</entry> 286 + <entry>Reserved for future extensions. Should be zeroed by drivers 287 + and applications.</entry> 288 288 </row> 289 289 </tbody> 290 290 </tgroup>
+2 -1
Documentation/DocBook/media/v4l/vidioc-create-bufs.xml
··· 134 134 <row> 135 135 <entry>__u32</entry> 136 136 <entry><structfield>reserved</structfield>[8]</entry> 137 - <entry>A place holder for future extensions.</entry> 137 + <entry>A place holder for future extensions. Drivers and applications 138 + must set the array to zero.</entry> 138 139 </row> 139 140 </tbody> 140 141 </tgroup>
+2 -1
Documentation/DocBook/media/v4l/vidioc-enum-frameintervals.xml
··· 217 217 <entry>__u32</entry> 218 218 <entry><structfield>reserved[2]</structfield></entry> 219 219 <entry></entry> 220 - <entry>Reserved space for future use.</entry> 220 + <entry>Reserved space for future use. Must be zeroed by drivers and 221 + applications.</entry> 221 222 </row> 222 223 </tbody> 223 224 </tgroup>
+2 -1
Documentation/DocBook/media/v4l/vidioc-enum-framesizes.xml
··· 223 223 <entry>__u32</entry> 224 224 <entry><structfield>reserved[2]</structfield></entry> 225 225 <entry></entry> 226 - <entry>Reserved space for future use.</entry> 226 + <entry>Reserved space for future use. Must be zeroed by drivers and 227 + applications.</entry> 227 228 </row> 228 229 </tbody> 229 230 </tgroup>
+2 -1
Documentation/DocBook/media/v4l/vidioc-expbuf.xml
··· 184 184 <row> 185 185 <entry>__u32</entry> 186 186 <entry><structfield>reserved[11]</structfield></entry> 187 - <entry>Reserved field for future use. Must be set to zero.</entry> 187 + <entry>Reserved field for future use. Drivers and applications must 188 + set the array to zero.</entry> 188 189 </row> 189 190 </tbody> 190 191 </tgroup>
+1 -1
Documentation/DocBook/media/v4l/vidioc-g-selection.xml
··· 199 199 <row> 200 200 <entry>__u32</entry> 201 201 <entry><structfield>reserved[9]</structfield></entry> 202 - <entry>Reserved fields for future use.</entry> 202 + <entry>Reserved fields for future use. Drivers and applications must zero this array.</entry> 203 203 </row> 204 204 </tbody> 205 205 </tgroup>
+2 -1
Documentation/DocBook/media/v4l/vidioc-querybuf.xml
··· 60 60 field. Valid index numbers range from zero 61 61 to the number of buffers allocated with &VIDIOC-REQBUFS; 62 62 (&v4l2-requestbuffers; <structfield>count</structfield>) minus one. 63 - The <structfield>reserved</structfield> field should to set to 0. 63 + The <structfield>reserved</structfield> and <structfield>reserved2 </structfield> 64 + fields must be set to 0. 64 65 When using the <link linkend="planar-apis">multi-planar API</link>, the 65 66 <structfield>m.planes</structfield> field must contain a userspace pointer to an 66 67 array of &v4l2-plane; and the <structfield>length</structfield> field has
+2 -2
Documentation/DocBook/media/v4l/vidioc-reqbufs.xml
··· 112 112 <row> 113 113 <entry>__u32</entry> 114 114 <entry><structfield>reserved</structfield>[2]</entry> 115 - <entry>A place holder for future extensions. This array should 116 - be zeroed by applications.</entry> 115 + <entry>A place holder for future extensions. Drivers and applications 116 + must set the array to zero.</entry> 117 117 </row> 118 118 </tbody> 119 119 </tgroup>