aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook
diff options
context:
space:
mode:
authorHans Verkuil <hans.verkuil@cisco.com>2012-01-11 05:30:55 -0500
committerMauro Carvalho Chehab <mchehab@redhat.com>2012-01-16 06:37:53 -0500
commit6055b12ae0f433314cba98f423fb8c5fc211ca8d (patch)
tree0298a0437a2c51b3543ae788260ff98dbd8c82c9 /Documentation/DocBook
parent047a01fdc807ffa461db87e2d30d6d28f95c091a (diff)
[media] V4L2 Spec: fix extended control documentation
Update the spec to the behavior implemented by the control framework. This should have been documented long ago but for some reason it was never done. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'Documentation/DocBook')
-rw-r--r--Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml18
1 files changed, 13 insertions, 5 deletions
diff --git a/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml b/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml
index 6f1f9a629dc3..b17a7aac6997 100644
--- a/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml
+++ b/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml
@@ -183,7 +183,12 @@ applications must set the array to zero.</entry>
183 <entry>__u32</entry> 183 <entry>__u32</entry>
184 <entry><structfield>ctrl_class</structfield></entry> 184 <entry><structfield>ctrl_class</structfield></entry>
185 <entry>The control class to which all controls belong, see 185 <entry>The control class to which all controls belong, see
186<xref linkend="ctrl-class" />.</entry> 186<xref linkend="ctrl-class" />. Drivers that use a kernel framework for handling
187controls will also accept a value of 0 here, meaning that the controls can
188belong to any control class. Whether drivers support this can be tested by setting
189<structfield>ctrl_class</structfield> to 0 and calling <constant>VIDIOC_TRY_EXT_CTRLS</constant>
190with a <structfield>count</structfield> of 0. If that succeeds, then the driver
191supports this feature.</entry>
187 </row> 192 </row>
188 <row> 193 <row>
189 <entry>__u32</entry> 194 <entry>__u32</entry>
@@ -194,10 +199,13 @@ also be zero.</entry>
194 <row> 199 <row>
195 <entry>__u32</entry> 200 <entry>__u32</entry>
196 <entry><structfield>error_idx</structfield></entry> 201 <entry><structfield>error_idx</structfield></entry>
197 <entry>Set by the driver in case of an error. It is the 202 <entry>Set by the driver in case of an error. If it is equal
198index of the control causing the error or equal to 'count' when the 203to <structfield>count</structfield>, then no actual changes were made to
199error is not associated with a particular control. Undefined when the 204controls. In other words, the error was not associated with setting a particular
200ioctl returns 0 (success).</entry> 205control. If it is another value, then only the controls up to <structfield>error_idx-1</structfield>
206were modified and control <structfield>error_idx</structfield> is the one that
207caused the error. The <structfield>error_idx</structfield> value is undefined
208if the ioctl returned 0 (success).</entry>
201 </row> 209 </row>
202 <row> 210 <row>
203 <entry>__u32</entry> 211 <entry>__u32</entry>