mirrors/linux-stable
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git synced 2024-09-05 18:39:59 +00:00
Code Issues Releases Wiki Activity

[media] vidioc-enum-dv-timings.xml: explicitly state that pad and reserved should be zeroed

Browse source 
The ENUM_DV_TIMINGS documentation did not clearly state that the pad and reserved
fields should be zeroed (pad only when used with a video device node).

Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
This commit is contained in:
Hans Verkuil 2016-03-22 07:30:28 -03:00 committed by Mauro Carvalho Chehab
parent 0be67c40d4
commit 0c53fee973
1 changed files with 3 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
Documentation/DocBook/media/v4l/vidioc-enum-dv-timings.xml
View file

@ -61,8 +61,9 @@ of known supported timings. Call &VIDIOC-DV-TIMINGS-CAP; to check if it also sup
standards or even custom timings that are not in this list.</para> standards or even custom timings that are not in this list.</para>
<para>To query the available timings, applications initialize the <para>To query the available timings, applications initialize the
<structfield>index</structfield> field and zero the reserved array of &v4l2-enum-dv-timings; <structfield>index</structfield> field, set the <structfield>pad</structfield> field to 0,
and call the <constant>VIDIOC_ENUM_DV_TIMINGS</constant> ioctl on a video node with a zero the reserved array of &v4l2-enum-dv-timings; and call the
<constant>VIDIOC_ENUM_DV_TIMINGS</constant> ioctl on a video node with a
pointer to this structure. Drivers fill the rest of the structure or return an pointer to this structure. Drivers fill the rest of the structure or return an
&EINVAL; when the index is out of bounds. To enumerate all supported DV timings, &EINVAL; when the index is out of bounds. To enumerate all supported DV timings,
applications shall begin at index zero, incrementing by one until the applications shall begin at index zero, incrementing by one until the