Commit 60f4570d authored by Hans Verkuil's avatar Hans Verkuil Committed by Mauro Carvalho Chehab

[media] DocBook/media: clarify control documentation

- Add missing V4L2_CTRL_TYPE_U32 documentation
- Remove 'which are actually different on the hardware' sentence which
  is confusing. I think the idea was to let the user know that the step can
  be different for different hardware, but that's obvious because otherwise
  you wouldn't need to specify the step value.
- Clarify that V4L2_CTRL_COMPOUND_TYPES also applies to arrays.
Signed-off-by: default avatarHans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@osg.samsung.com>
parent 35204e2e
...@@ -197,6 +197,13 @@ Valid if this control is of type <constant>V4L2_CTRL_TYPE_U8</constant>.</entry> ...@@ -197,6 +197,13 @@ Valid if this control is of type <constant>V4L2_CTRL_TYPE_U8</constant>.</entry>
<entry><structfield>p_u16</structfield></entry> <entry><structfield>p_u16</structfield></entry>
<entry>A pointer to a matrix control of unsigned 16-bit values. <entry>A pointer to a matrix control of unsigned 16-bit values.
Valid if this control is of type <constant>V4L2_CTRL_TYPE_U16</constant>.</entry> Valid if this control is of type <constant>V4L2_CTRL_TYPE_U16</constant>.</entry>
</row>
<row>
<entry></entry>
<entry>__u32 *</entry>
<entry><structfield>p_u32</structfield></entry>
<entry>A pointer to a matrix control of unsigned 32-bit values.
Valid if this control is of type <constant>V4L2_CTRL_TYPE_U32</constant>.</entry>
</row> </row>
<row> <row>
<entry></entry> <entry></entry>
......
...@@ -101,8 +101,9 @@ prematurely end the enumeration).</para></footnote></para> ...@@ -101,8 +101,9 @@ prematurely end the enumeration).</para></footnote></para>
next supported non-compound control, or <errorcode>EINVAL</errorcode> next supported non-compound control, or <errorcode>EINVAL</errorcode>
if there is none. In addition, the <constant>V4L2_CTRL_FLAG_NEXT_COMPOUND</constant> if there is none. In addition, the <constant>V4L2_CTRL_FLAG_NEXT_COMPOUND</constant>
flag can be specified to enumerate all compound controls (i.e. controls flag can be specified to enumerate all compound controls (i.e. controls
with type &ge; <constant>V4L2_CTRL_COMPOUND_TYPES</constant>). Specify both with type &ge; <constant>V4L2_CTRL_COMPOUND_TYPES</constant> and/or array
<constant>V4L2_CTRL_FLAG_NEXT_CTRL</constant> and control, in other words controls that contain more than one value).
Specify both <constant>V4L2_CTRL_FLAG_NEXT_CTRL</constant> and
<constant>V4L2_CTRL_FLAG_NEXT_COMPOUND</constant> in order to enumerate <constant>V4L2_CTRL_FLAG_NEXT_COMPOUND</constant> in order to enumerate
all controls, compound or not. Drivers which do not support these flags yet all controls, compound or not. Drivers which do not support these flags yet
always return <errorcode>EINVAL</errorcode>.</para> always return <errorcode>EINVAL</errorcode>.</para>
...@@ -422,7 +423,7 @@ the array to zero.</entry> ...@@ -422,7 +423,7 @@ the array to zero.</entry>
<entry>any</entry> <entry>any</entry>
<entry>An integer-valued control ranging from minimum to <entry>An integer-valued control ranging from minimum to
maximum inclusive. The step value indicates the increment between maximum inclusive. The step value indicates the increment between
values which are actually different on the hardware.</entry> values.</entry>
</row> </row>
<row> <row>
<entry><constant>V4L2_CTRL_TYPE_BOOLEAN</constant></entry> <entry><constant>V4L2_CTRL_TYPE_BOOLEAN</constant></entry>
...@@ -518,7 +519,7 @@ Older drivers which do not support this feature return an ...@@ -518,7 +519,7 @@ Older drivers which do not support this feature return an
<entry>any</entry> <entry>any</entry>
<entry>An unsigned 8-bit valued control ranging from minimum to <entry>An unsigned 8-bit valued control ranging from minimum to
maximum inclusive. The step value indicates the increment between maximum inclusive. The step value indicates the increment between
values which are actually different on the hardware. values.
</entry> </entry>
</row> </row>
<row> <row>
...@@ -528,7 +529,17 @@ values which are actually different on the hardware. ...@@ -528,7 +529,17 @@ values which are actually different on the hardware.
<entry>any</entry> <entry>any</entry>
<entry>An unsigned 16-bit valued control ranging from minimum to <entry>An unsigned 16-bit valued control ranging from minimum to
maximum inclusive. The step value indicates the increment between maximum inclusive. The step value indicates the increment between
values which are actually different on the hardware. values.
</entry>
</row>
<row>
<entry><constant>V4L2_CTRL_TYPE_U32</constant></entry>
<entry>any</entry>
<entry>any</entry>
<entry>any</entry>
<entry>An unsigned 32-bit valued control ranging from minimum to
maximum inclusive. The step value indicates the increment between
values.
</entry> </entry>
</row> </row>
</tbody> </tbody>
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment