diff options
author | Sakari Ailus <sakari.ailus@iki.fi> | 2011-08-06 15:13:47 -0400 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@redhat.com> | 2012-04-10 13:51:18 -0400 |
commit | 6ec299f3dc86b59c1787d3541dcb52b934c901f0 (patch) | |
tree | 8b0e4b1df032694d8a81d447498e7e5f36cd1263 /Documentation/DocBook | |
parent | ce580fe5190dec4d872e7925946b0aec1f694370 (diff) |
[media] v4l: Document integer menu controls
Signed-off-by: Sakari Ailus <sakari.ailus@iki.fi>
Acked-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
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 | 8 | ||||
-rw-r--r-- | Documentation/DocBook/media/v4l/vidioc-queryctrl.xml | 39 |
3 files changed, 55 insertions, 2 deletions
diff --git a/Documentation/DocBook/media/v4l/compat.xml b/Documentation/DocBook/media/v4l/compat.xml index bce97c50391b..d881520e1a54 100644 --- a/Documentation/DocBook/media/v4l/compat.xml +++ b/Documentation/DocBook/media/v4l/compat.xml | |||
@@ -2410,6 +2410,16 @@ details.</para> | |||
2410 | </orderedlist> | 2410 | </orderedlist> |
2411 | </section> | 2411 | </section> |
2412 | 2412 | ||
2413 | <section> | ||
2414 | <title>V4L2 in Linux 3.5</title> | ||
2415 | <orderedlist> | ||
2416 | <listitem> | ||
2417 | <para>Added integer menus, the new type will be | ||
2418 | V4L2_CTRL_TYPE_INTEGER_MENU.</para> | ||
2419 | </listitem> | ||
2420 | </orderedlist> | ||
2421 | </section> | ||
2422 | |||
2413 | <section id="other"> | 2423 | <section id="other"> |
2414 | <title>Relation of V4L2 to other Linux multimedia APIs</title> | 2424 | <title>Relation of V4L2 to other Linux multimedia APIs</title> |
2415 | 2425 | ||
diff --git a/Documentation/DocBook/media/v4l/v4l2.xml b/Documentation/DocBook/media/v4l/v4l2.xml index 8ae38876172e..864ba5d6873d 100644 --- a/Documentation/DocBook/media/v4l/v4l2.xml +++ b/Documentation/DocBook/media/v4l/v4l2.xml | |||
@@ -128,6 +128,14 @@ structs, ioctls) must be noted in more detail in the history chapter | |||
128 | applications. --> | 128 | applications. --> |
129 | 129 | ||
130 | <revision> | 130 | <revision> |
131 | <revnumber>3.5</revnumber> | ||
132 | <date>2012-04-02</date> | ||
133 | <authorinitials>sa</authorinitials> | ||
134 | <revremark>Added V4L2_CTRL_TYPE_INTEGER_MENU. | ||
135 | </revremark> | ||
136 | </revision> | ||
137 | |||
138 | <revision> | ||
131 | <revnumber>3.4</revnumber> | 139 | <revnumber>3.4</revnumber> |
132 | <date>2012-01-25</date> | 140 | <date>2012-01-25</date> |
133 | <authorinitials>sn</authorinitials> | 141 | <authorinitials>sn</authorinitials> |
diff --git a/Documentation/DocBook/media/v4l/vidioc-queryctrl.xml b/Documentation/DocBook/media/v4l/vidioc-queryctrl.xml index 36660d311b51..505f0206e5bd 100644 --- a/Documentation/DocBook/media/v4l/vidioc-queryctrl.xml +++ b/Documentation/DocBook/media/v4l/vidioc-queryctrl.xml | |||
@@ -215,11 +215,12 @@ the array to zero.</entry> | |||
215 | 215 | ||
216 | <table pgwide="1" frame="none" id="v4l2-querymenu"> | 216 | <table pgwide="1" frame="none" id="v4l2-querymenu"> |
217 | <title>struct <structname>v4l2_querymenu</structname></title> | 217 | <title>struct <structname>v4l2_querymenu</structname></title> |
218 | <tgroup cols="3"> | 218 | <tgroup cols="4"> |
219 | &cs-str; | 219 | &cs-str; |
220 | <tbody valign="top"> | 220 | <tbody valign="top"> |
221 | <row> | 221 | <row> |
222 | <entry>__u32</entry> | 222 | <entry>__u32</entry> |
223 | <entry></entry> | ||
223 | <entry><structfield>id</structfield></entry> | 224 | <entry><structfield>id</structfield></entry> |
224 | <entry>Identifies the control, set by the application | 225 | <entry>Identifies the control, set by the application |
225 | from the respective &v4l2-queryctrl; | 226 | from the respective &v4l2-queryctrl; |
@@ -227,18 +228,38 @@ from the respective &v4l2-queryctrl; | |||
227 | </row> | 228 | </row> |
228 | <row> | 229 | <row> |
229 | <entry>__u32</entry> | 230 | <entry>__u32</entry> |
231 | <entry></entry> | ||
230 | <entry><structfield>index</structfield></entry> | 232 | <entry><structfield>index</structfield></entry> |
231 | <entry>Index of the menu item, starting at zero, set by | 233 | <entry>Index of the menu item, starting at zero, set by |
232 | the application.</entry> | 234 | the application.</entry> |
233 | </row> | 235 | </row> |
234 | <row> | 236 | <row> |
237 | <entry>union</entry> | ||
238 | <entry></entry> | ||
239 | <entry></entry> | ||
240 | <entry></entry> | ||
241 | </row> | ||
242 | <row> | ||
243 | <entry></entry> | ||
235 | <entry>__u8</entry> | 244 | <entry>__u8</entry> |
236 | <entry><structfield>name</structfield>[32]</entry> | 245 | <entry><structfield>name</structfield>[32]</entry> |
237 | <entry>Name of the menu item, a NUL-terminated ASCII | 246 | <entry>Name of the menu item, a NUL-terminated ASCII |
238 | string. This information is intended for the user.</entry> | 247 | string. This information is intended for the user. This field is valid |
248 | for <constant>V4L2_CTRL_FLAG_MENU</constant> type controls.</entry> | ||
249 | </row> | ||
250 | <row> | ||
251 | <entry></entry> | ||
252 | <entry>__s64</entry> | ||
253 | <entry><structfield>value</structfield></entry> | ||
254 | <entry> | ||
255 | Value of the integer menu item. This field is valid for | ||
256 | <constant>V4L2_CTRL_FLAG_INTEGER_MENU</constant> type | ||
257 | controls. | ||
258 | </entry> | ||
239 | </row> | 259 | </row> |
240 | <row> | 260 | <row> |
241 | <entry>__u32</entry> | 261 | <entry>__u32</entry> |
262 | <entry></entry> | ||
242 | <entry><structfield>reserved</structfield></entry> | 263 | <entry><structfield>reserved</structfield></entry> |
243 | <entry>Reserved for future extensions. Drivers must set | 264 | <entry>Reserved for future extensions. Drivers must set |
244 | the array to zero.</entry> | 265 | the array to zero.</entry> |
@@ -292,6 +313,20 @@ the menu items can be enumerated with the | |||
292 | <constant>VIDIOC_QUERYMENU</constant> ioctl.</entry> | 313 | <constant>VIDIOC_QUERYMENU</constant> ioctl.</entry> |
293 | </row> | 314 | </row> |
294 | <row> | 315 | <row> |
316 | <entry><constant>V4L2_CTRL_TYPE_INTEGER_MENU</constant></entry> | ||
317 | <entry>≥ 0</entry> | ||
318 | <entry>1</entry> | ||
319 | <entry>N-1</entry> | ||
320 | <entry> | ||
321 | The control has a menu of N choices. The values of the | ||
322 | menu items can be enumerated with the | ||
323 | <constant>VIDIOC_QUERYMENU</constant> ioctl. This is | ||
324 | similar to <constant>V4L2_CTRL_TYPE_MENU</constant> | ||
325 | except that instead of strings, the menu items are | ||
326 | signed 64-bit integers. | ||
327 | </entry> | ||
328 | </row> | ||
329 | <row> | ||
295 | <entry><constant>V4L2_CTRL_TYPE_BITMASK</constant></entry> | 330 | <entry><constant>V4L2_CTRL_TYPE_BITMASK</constant></entry> |
296 | <entry>0</entry> | 331 | <entry>0</entry> |
297 | <entry>n/a</entry> | 332 | <entry>n/a</entry> |