diff options
author | Hans Verkuil <hans.verkuil@cisco.com> | 2011-05-23 06:36:55 -0400 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@redhat.com> | 2011-07-27 16:55:39 -0400 |
commit | aec67f054205da77f83ba52f83239225d6cbe366 (patch) | |
tree | a291e77724025a388fbb7acbd041cddbec072b57 /Documentation/DocBook | |
parent | b6d17a56c8431810709794ceb44d2454976e3ce1 (diff) |
[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>
Diffstat (limited to 'Documentation/DocBook')
-rw-r--r-- | Documentation/DocBook/media/v4l/compat.xml | 10 | ||||
-rw-r--r-- | Documentation/DocBook/media/v4l/v4l2.xml | 11 | ||||
-rw-r--r-- | Documentation/DocBook/media/v4l/vidioc-queryctrl.xml | 12 |
3 files changed, 27 insertions, 6 deletions
diff --git a/Documentation/DocBook/media/v4l/compat.xml b/Documentation/DocBook/media/v4l/compat.xml index b010ac6bfd2c..d7c015e8df81 100644 --- a/Documentation/DocBook/media/v4l/compat.xml +++ b/Documentation/DocBook/media/v4l/compat.xml | |||
@@ -2360,6 +2360,16 @@ that used it. It was originally scheduled for removal in 2.6.35. | |||
2360 | </listitem> | 2360 | </listitem> |
2361 | </orderedlist> | 2361 | </orderedlist> |
2362 | </section> | 2362 | </section> |
2363 | <section> | ||
2364 | <title>V4L2 in Linux 3.1</title> | ||
2365 | <orderedlist> | ||
2366 | <listitem> | ||
2367 | <para>VIDIOC_QUERYCAP now returns a per-subsystem version instead of a per-driver one.</para> | ||
2368 | <para>Standardize an error code for invalid ioctl.</para> | ||
2369 | <para>Added V4L2_CTRL_TYPE_BITMASK.</para> | ||
2370 | </listitem> | ||
2371 | </orderedlist> | ||
2372 | </section> | ||
2363 | 2373 | ||
2364 | <section id="other"> | 2374 | <section id="other"> |
2365 | <title>Relation of V4L2 to other Linux multimedia APIs</title> | 2375 | <title>Relation of V4L2 to other Linux multimedia APIs</title> |
diff --git a/Documentation/DocBook/media/v4l/v4l2.xml b/Documentation/DocBook/media/v4l/v4l2.xml index 43386a6aef76..0d05e8747c12 100644 --- a/Documentation/DocBook/media/v4l/v4l2.xml +++ b/Documentation/DocBook/media/v4l/v4l2.xml | |||
@@ -87,7 +87,7 @@ Remote Controller chapter.</contrib> | |||
87 | </author> | 87 | </author> |
88 | 88 | ||
89 | <author> | 89 | <author> |
90 | <firstname>Pawel</firstname> | 90 | <firstname>Pawel</firstname> |
91 | <surname>Osciak</surname> | 91 | <surname>Osciak</surname> |
92 | <contrib>Designed and documented the multi-planar API.</contrib> | 92 | <contrib>Designed and documented the multi-planar API.</contrib> |
93 | <affiliation> | 93 | <affiliation> |
@@ -130,9 +130,10 @@ applications. --> | |||
130 | <revision> | 130 | <revision> |
131 | <revnumber>3.1</revnumber> | 131 | <revnumber>3.1</revnumber> |
132 | <date>2011-06-27</date> | 132 | <date>2011-06-27</date> |
133 | <authorinitials>mcc, po</authorinitials> | 133 | <authorinitials>mcc, po, hv</authorinitials> |
134 | <revremark>Documented that VIDIOC_QUERYCAP now returns a per-subsystem version instead of a per-driver one.</revremark> | 134 | <revremark>Documented that VIDIOC_QUERYCAP now returns a per-subsystem version instead of a per-driver one. |
135 | <revremark>Standardize an error code for invalid ioctl.</revremark> | 135 | Standardize an error code for invalid ioctl. |
136 | Added V4L2_CTRL_TYPE_BITMASK.</revremark> | ||
136 | </revision> | 137 | </revision> |
137 | 138 | ||
138 | <revision> | 139 | <revision> |
@@ -409,7 +410,7 @@ and discussions on the V4L mailing list.</revremark> | |||
409 | </partinfo> | 410 | </partinfo> |
410 | 411 | ||
411 | <title>Video for Linux Two API Specification</title> | 412 | <title>Video for Linux Two API Specification</title> |
412 | <subtitle>Revision 2.6.39</subtitle> | 413 | <subtitle>Revision 3.1</subtitle> |
413 | 414 | ||
414 | <chapter id="common"> | 415 | <chapter id="common"> |
415 | &sub-common; | 416 | &sub-common; |
diff --git a/Documentation/DocBook/media/v4l/vidioc-queryctrl.xml b/Documentation/DocBook/media/v4l/vidioc-queryctrl.xml index 0d5e8283cf32..677ea646c29f 100644 --- a/Documentation/DocBook/media/v4l/vidioc-queryctrl.xml +++ b/Documentation/DocBook/media/v4l/vidioc-queryctrl.xml | |||
@@ -156,7 +156,8 @@ signed value.</entry> | |||
156 | <entry>Maximum value, inclusive. This field gives an upper | 156 | <entry>Maximum value, inclusive. This field gives an upper |
157 | bound for <constant>V4L2_CTRL_TYPE_INTEGER</constant> controls and the | 157 | bound for <constant>V4L2_CTRL_TYPE_INTEGER</constant> controls and the |
158 | highest valid index for <constant>V4L2_CTRL_TYPE_MENU</constant> | 158 | highest valid index for <constant>V4L2_CTRL_TYPE_MENU</constant> |
159 | controls. | 159 | controls. For <constant>V4L2_CTRL_TYPE_BITMASK</constant> controls it is the |
160 | set of usable bits. | ||
160 | For <constant>V4L2_CTRL_TYPE_STRING</constant> controls the maximum value | 161 | For <constant>V4L2_CTRL_TYPE_STRING</constant> controls the maximum value |
161 | gives the maximum length of the string. This length <emphasis>does not include the terminating | 162 | gives the maximum length of the string. This length <emphasis>does not include the terminating |
162 | zero</emphasis>. It may not be valid for any other type of control, including | 163 | zero</emphasis>. It may not be valid for any other type of control, including |
@@ -291,6 +292,15 @@ the menu items can be enumerated with the | |||
291 | <constant>VIDIOC_QUERYMENU</constant> ioctl.</entry> | 292 | <constant>VIDIOC_QUERYMENU</constant> ioctl.</entry> |
292 | </row> | 293 | </row> |
293 | <row> | 294 | <row> |
295 | <entry><constant>V4L2_CTRL_TYPE_BITMASK</constant></entry> | ||
296 | <entry>0</entry> | ||
297 | <entry>n/a</entry> | ||
298 | <entry>any</entry> | ||
299 | <entry>A bitmask field. The maximum value is the set of bits that can | ||
300 | be used, all other bits are to be 0. The maximum value is interpreted as a __u32, | ||
301 | allowing the use of bit 31 in the bitmask.</entry> | ||
302 | </row> | ||
303 | <row> | ||
294 | <entry><constant>V4L2_CTRL_TYPE_BUTTON</constant></entry> | 304 | <entry><constant>V4L2_CTRL_TYPE_BUTTON</constant></entry> |
295 | <entry>0</entry> | 305 | <entry>0</entry> |
296 | <entry>0</entry> | 306 | <entry>0</entry> |