[media] DocBook: document V4L2_CTRL_TYPE_BITMASK

[mchehab@redhat.com: Fix a merge conflict and make compat.xml coherent with v4l2.xml]
Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Acked-by: Sakari Ailus <sakari.ailus@iki.fi>
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
This commit is contained in:
Hans Verkuil 2011-05-23 07:36:55 -03:00 committed by Mauro Carvalho Chehab
parent b6d17a56c8
commit aec67f0542
3 changed files with 27 additions and 6 deletions

View File

@ -2360,6 +2360,16 @@ that used it. It was originally scheduled for removal in 2.6.35.
</listitem>
</orderedlist>
</section>
<section>
<title>V4L2 in Linux 3.1</title>
<orderedlist>
<listitem>
<para>VIDIOC_QUERYCAP now returns a per-subsystem version instead of a per-driver one.</para>
<para>Standardize an error code for invalid ioctl.</para>
<para>Added V4L2_CTRL_TYPE_BITMASK.</para>
</listitem>
</orderedlist>
</section>
<section id="other">
<title>Relation of V4L2 to other Linux multimedia APIs</title>

View File

@ -87,7 +87,7 @@ Remote Controller chapter.</contrib>
</author>
<author>
<firstname>Pawel</firstname>
<firstname>Pawel</firstname>
<surname>Osciak</surname>
<contrib>Designed and documented the multi-planar API.</contrib>
<affiliation>
@ -130,9 +130,10 @@ applications. -->
<revision>
<revnumber>3.1</revnumber>
<date>2011-06-27</date>
<authorinitials>mcc, po</authorinitials>
<revremark>Documented that VIDIOC_QUERYCAP now returns a per-subsystem version instead of a per-driver one.</revremark>
<revremark>Standardize an error code for invalid ioctl.</revremark>
<authorinitials>mcc, po, hv</authorinitials>
<revremark>Documented that VIDIOC_QUERYCAP now returns a per-subsystem version instead of a per-driver one.
Standardize an error code for invalid ioctl.
Added V4L2_CTRL_TYPE_BITMASK.</revremark>
</revision>
<revision>
@ -409,7 +410,7 @@ and discussions on the V4L mailing list.</revremark>
</partinfo>
<title>Video for Linux Two API Specification</title>
<subtitle>Revision 2.6.39</subtitle>
<subtitle>Revision 3.1</subtitle>
<chapter id="common">
&sub-common;

View File

@ -156,7 +156,8 @@ signed value.</entry>
<entry>Maximum value, inclusive. This field gives an upper
bound for <constant>V4L2_CTRL_TYPE_INTEGER</constant> controls and the
highest valid index for <constant>V4L2_CTRL_TYPE_MENU</constant>
controls.
controls. For <constant>V4L2_CTRL_TYPE_BITMASK</constant> controls it is the
set of usable bits.
For <constant>V4L2_CTRL_TYPE_STRING</constant> controls the maximum value
gives the maximum length of the string. This length <emphasis>does not include the terminating
zero</emphasis>. It may not be valid for any other type of control, including
@ -289,6 +290,15 @@ values which are actually different on the hardware.</entry>
<entry>The control has a menu of N choices. The names of
the menu items can be enumerated with the
<constant>VIDIOC_QUERYMENU</constant> ioctl.</entry>
</row>
<row>
<entry><constant>V4L2_CTRL_TYPE_BITMASK</constant></entry>
<entry>0</entry>
<entry>n/a</entry>
<entry>any</entry>
<entry>A bitmask field. The maximum value is the set of bits that can
be used, all other bits are to be 0. The maximum value is interpreted as a __u32,
allowing the use of bit 31 in the bitmask.</entry>
</row>
<row>
<entry><constant>V4L2_CTRL_TYPE_BUTTON</constant></entry>