diff options
Diffstat (limited to 'Documentation/DocBook')
-rw-r--r-- | Documentation/DocBook/media/v4l/vidioc-g-ctrl.xml | 8 | ||||
-rw-r--r-- | Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml | 10 |
2 files changed, 13 insertions, 5 deletions
diff --git a/Documentation/DocBook/media/v4l/vidioc-g-ctrl.xml b/Documentation/DocBook/media/v4l/vidioc-g-ctrl.xml index 12b1d0503e26..ee2820d6ca66 100644 --- a/Documentation/DocBook/media/v4l/vidioc-g-ctrl.xml +++ b/Documentation/DocBook/media/v4l/vidioc-g-ctrl.xml | |||
@@ -64,7 +64,9 @@ return an &EINVAL;. When the <structfield>value</structfield> is out | |||
64 | of bounds drivers can choose to take the closest valid value or return | 64 | of bounds drivers can choose to take the closest valid value or return |
65 | an &ERANGE;, whatever seems more appropriate. However, | 65 | an &ERANGE;, whatever seems more appropriate. However, |
66 | <constant>VIDIOC_S_CTRL</constant> is a write-only ioctl, it does not | 66 | <constant>VIDIOC_S_CTRL</constant> is a write-only ioctl, it does not |
67 | return the actual new value.</para> | 67 | return the actual new value. If the <structfield>value</structfield> |
68 | is inappropriate for the control (e.g. if it refers to an unsupported | ||
69 | menu index of a menu control), then &EINVAL; is returned as well.</para> | ||
68 | 70 | ||
69 | <para>These ioctls work only with user controls. For other | 71 | <para>These ioctls work only with user controls. For other |
70 | control classes the &VIDIOC-G-EXT-CTRLS;, &VIDIOC-S-EXT-CTRLS; or | 72 | control classes the &VIDIOC-G-EXT-CTRLS;, &VIDIOC-S-EXT-CTRLS; or |
@@ -99,7 +101,9 @@ application.</entry> | |||
99 | <term><errorcode>EINVAL</errorcode></term> | 101 | <term><errorcode>EINVAL</errorcode></term> |
100 | <listitem> | 102 | <listitem> |
101 | <para>The &v4l2-control; <structfield>id</structfield> is | 103 | <para>The &v4l2-control; <structfield>id</structfield> is |
102 | invalid.</para> | 104 | invalid or the <structfield>value</structfield> is inappropriate for |
105 | the given control (i.e. if a menu item is selected that is not supported | ||
106 | by the driver according to &VIDIOC-QUERYMENU;).</para> | ||
103 | </listitem> | 107 | </listitem> |
104 | </varlistentry> | 108 | </varlistentry> |
105 | <varlistentry> | 109 | <varlistentry> |
diff --git a/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml b/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml index 42ffbff6d37e..4e16112df992 100644 --- a/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml +++ b/Documentation/DocBook/media/v4l/vidioc-g-ext-ctrls.xml | |||
@@ -106,7 +106,9 @@ value or if an error is returned.</para> | |||
106 | &EINVAL;. When the value is out of bounds drivers can choose to take | 106 | &EINVAL;. When the value is out of bounds drivers can choose to take |
107 | the closest valid value or return an &ERANGE;, whatever seems more | 107 | the closest valid value or return an &ERANGE;, whatever seems more |
108 | appropriate. In the first case the new value is set in | 108 | appropriate. In the first case the new value is set in |
109 | &v4l2-ext-control;.</para> | 109 | &v4l2-ext-control;. If the new control value is inappropriate (e.g. the |
110 | given menu index is not supported by the menu control), then this will | ||
111 | also result in an &EINVAL; error.</para> | ||
110 | 112 | ||
111 | <para>The driver will only set/get these controls if all control | 113 | <para>The driver will only set/get these controls if all control |
112 | values are correct. This prevents the situation where only some of the | 114 | values are correct. This prevents the situation where only some of the |
@@ -331,8 +333,10 @@ These controls are described in <xref | |||
331 | <term><errorcode>EINVAL</errorcode></term> | 333 | <term><errorcode>EINVAL</errorcode></term> |
332 | <listitem> | 334 | <listitem> |
333 | <para>The &v4l2-ext-control; <structfield>id</structfield> | 335 | <para>The &v4l2-ext-control; <structfield>id</structfield> |
334 | is invalid or the &v4l2-ext-controls; | 336 | is invalid, the &v4l2-ext-controls; |
335 | <structfield>ctrl_class</structfield> is invalid. This error code is | 337 | <structfield>ctrl_class</structfield> is invalid, or the &v4l2-ext-control; |
338 | <structfield>value</structfield> was inappropriate (e.g. the given menu | ||
339 | index is not supported by the driver). This error code is | ||
336 | also returned by the <constant>VIDIOC_S_EXT_CTRLS</constant> and | 340 | also returned by the <constant>VIDIOC_S_EXT_CTRLS</constant> and |
337 | <constant>VIDIOC_TRY_EXT_CTRLS</constant> ioctls if two or more | 341 | <constant>VIDIOC_TRY_EXT_CTRLS</constant> ioctls if two or more |
338 | control values are in conflict.</para> | 342 | control values are in conflict.</para> |