Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 6ec299f3 authored by Sakari Ailus's avatar Sakari Ailus Committed by Mauro Carvalho Chehab
Browse files

[media] v4l: Document integer menu controls 



Signed-off-by: default avatarSakari Ailus <sakari.ailus@iki.fi>
Acked-by: default avatarLaurent Pinchart <laurent.pinchart@ideasonboard.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@redhat.com>
parent ce580fe5

Documentation/DocBook/media/v4l/compat.xml

+10 −0
Original line number Diff line number Diff line
@@ -2410,6 +2410,16 @@ details.</para> 
      </orderedlist>

    </section>



    <section>

      <title>V4L2 in Linux 3.5</title>

      <orderedlist>

        <listitem>

	  <para>Added integer menus, the new type will be

	  V4L2_CTRL_TYPE_INTEGER_MENU.</para>

        </listitem>

      </orderedlist>

    </section>



    <section id="other">

      <title>Relation of V4L2 to other Linux multimedia APIs</title>

Documentation/DocBook/media/v4l/v4l2.xml

+8 −0
Original line number Diff line number Diff line
@@ -127,6 +127,14 @@ structs, ioctls) must be noted in more detail in the history chapter 
(compat.xml), along with the possible impact on existing drivers and

applications. -->



      <revision>

	<revnumber>3.5</revnumber>

	<date>2012-04-02</date>

	<authorinitials>sa</authorinitials>

	<revremark>Added V4L2_CTRL_TYPE_INTEGER_MENU.

	</revremark>

      </revision>



      <revision>

	<revnumber>3.4</revnumber>

	<date>2012-01-25</date>

Documentation/DocBook/media/v4l/vidioc-queryctrl.xml

+37 −2
Original line number Diff line number Diff line
@@ -215,11 +215,12 @@ the array to zero.</entry> 


    <table pgwide="1" frame="none" id="v4l2-querymenu">

      <title>struct <structname>v4l2_querymenu</structname></title>

      <tgroup cols="3">

      <tgroup cols="4">

	&cs-str;

	<tbody valign="top">

	  <row>

	    <entry>__u32</entry>

	    <entry></entry>

	    <entry><structfield>id</structfield></entry>

	    <entry>Identifies the control, set by the application

from the respective &v4l2-queryctrl;
@@ -227,18 +228,38 @@ from the respective &v4l2-queryctrl; 
	  </row>

	  <row>

	    <entry>__u32</entry>

	    <entry></entry>

	    <entry><structfield>index</structfield></entry>

	    <entry>Index of the menu item, starting at zero, set by

	    the application.</entry>

	  </row>

	  <row>

	    <entry>union</entry>

	    <entry></entry>

	    <entry></entry>

	    <entry></entry>

	  </row>

	  <row>

	    <entry></entry>

	    <entry>__u8</entry>

	    <entry><structfield>name</structfield>[32]</entry>

	    <entry>Name of the menu item, a NUL-terminated ASCII

string. This information is intended for the user.</entry>

string. This information is intended for the user. This field is valid

for <constant>V4L2_CTRL_FLAG_MENU</constant> type controls.</entry>

	  </row>

	  <row>

	    <entry></entry>

	    <entry>__s64</entry>

	    <entry><structfield>value</structfield></entry>

	    <entry>

              Value of the integer menu item. This field is valid for

              <constant>V4L2_CTRL_FLAG_INTEGER_MENU</constant> type

              controls.

            </entry>

	  </row>

	  <row>

	    <entry>__u32</entry>

	    <entry></entry>

	    <entry><structfield>reserved</structfield></entry>

	    <entry>Reserved for future extensions. Drivers must set

the array to zero.</entry>
@@ -291,6 +312,20 @@ values which are actually different on the hardware.</entry> 
the menu items can be enumerated with the

<constant>VIDIOC_QUERYMENU</constant> ioctl.</entry>

	  </row>

	  <row>

	    <entry><constant>V4L2_CTRL_TYPE_INTEGER_MENU</constant></entry>

	    <entry>&ge; 0</entry>

	    <entry>1</entry>

	    <entry>N-1</entry>

	    <entry>

              The control has a menu of N choices. The values of the

              menu items can be enumerated with the

              <constant>VIDIOC_QUERYMENU</constant> ioctl. This is

              similar to <constant>V4L2_CTRL_TYPE_MENU</constant>

              except that instead of strings, the menu items are

              signed 64-bit integers.

            </entry>

	  </row>

	  <row>

	    <entry><constant>V4L2_CTRL_TYPE_BITMASK</constant></entry>

	    <entry>0</entry>