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

Commit 74a45790 authored by Hans Verkuil's avatar Hans Verkuil Committed by Mauro Carvalho Chehab
Browse files

[media] videodev2.h: add V4L2_CTRL_FLAG_VOLATILE 



Add a new VOLATILE control flag that is set for volatile controls.
That way applications know whether the value of the control is volatile
(i.e. can change continuously) or not.

Until now this was an internal property, but it is useful to know in
userspace as well.

A typical use case is the gain value when autogain is on. In that case the
hardware will continuously adjust the gain based various environmental
factors.

This patch just adds and documents the flag, it's not yet used.

Signed-off-by: default avatarHans Verkuil <hans.verkuil@cisco.com>
Acked-by: default avatarHans de Goede <hdegoede@redhat.com>
Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@redhat.com>
parent b57ce417

Documentation/DocBook/media/v4l/compat.xml

+8 −0
Original line number Diff line number Diff line
@@ -2370,6 +2370,14 @@ that used it. It was originally scheduled for removal in 2.6.35. 
        </listitem>

      </orderedlist>

    </section>

    <section>

      <title>V4L2 in Linux 3.2</title>

      <orderedlist>

        <listitem>

	  <para>V4L2_CTRL_FLAG_VOLATILE was added to signal volatile controls to userspace.</para>

        </listitem>

      </orderedlist>

    </section>



    <section id="other">

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

Documentation/DocBook/media/v4l/v4l2.xml

+8 −1
Original line number Diff line number Diff line
@@ -127,6 +127,13 @@ 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.2</revnumber>

	<date>2011-08-26</date>

	<authorinitials>hv</authorinitials>

	<revremark>Added V4L2_CTRL_FLAG_VOLATILE.</revremark>

      </revision>



      <revision>

	<revnumber>3.1</revnumber>

	<date>2011-06-27</date>
@@ -410,7 +417,7 @@ and discussions on the V4L mailing list.</revremark> 
</partinfo>



<title>Video for Linux Two API Specification</title>

 <subtitle>Revision 3.1</subtitle>

 <subtitle>Revision 3.2</subtitle>



  <chapter id="common">

    &sub-common;

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

+9 −0
Original line number Diff line number Diff line
@@ -406,6 +406,15 @@ flag is typically present for relative controls or action controls where 
writing a value will cause the device to carry out a given action

(&eg; motor control) but no meaningful value can be returned.</entry>

	  </row>

	  <row>

	    <entry><constant>V4L2_CTRL_FLAG_VOLATILE</constant></entry>

	    <entry>0x0080</entry>

	    <entry>This control is volatile, which means that the value of the control

changes continuously. A typical example would be the current gain value if the device

is in auto-gain mode. In such a case the hardware calculates the gain value based on

the lighting conditions which can change over time. Note that setting a new value for

a volatile control will have no effect. The new value will just be ignored.</entry>

	  </row>

	</tbody>

      </tgroup>

    </table>

include/linux/videodev2.h

+1 −0
Original line number Diff line number Diff line
@@ -1082,6 +1082,7 @@ struct v4l2_querymenu { 
#define V4L2_CTRL_FLAG_INACTIVE 	0x0010

#define V4L2_CTRL_FLAG_SLIDER 		0x0020

#define V4L2_CTRL_FLAG_WRITE_ONLY 	0x0040

#define V4L2_CTRL_FLAG_VOLATILE		0x0080



/*  Query flag, to be ORed with the control ID */

#define V4L2_CTRL_FLAG_NEXT_CTRL	0x80000000