aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/DocBook
diff options
context:
space:
mode:
authorSylwester Nawrocki <s.nawrocki@samsung.com>2012-05-11 05:37:03 -0400
committerMauro Carvalho Chehab <mchehab@redhat.com>2012-05-14 13:30:26 -0400
commit2272ab657b508ece04bf015da6c23f61711bac81 (patch)
tree74f8f45630875037015b7fcbcd1a470d15006318 /Documentation/DocBook
parentfc162a099e7b34bfe3501028c919ff5d43e5e3d3 (diff)
[media] V4L: Add camera auto focus controls
Add following auto focus controls: - V4L2_CID_AUTO_FOCUS_START - single-shot auto focus start - V4L2_CID_AUTO_FOCUS_STOP - single-shot auto focus stop - V4L2_CID_AUTO_FOCUS_STATUS - automatic focus status - V4L2_CID_AUTO_FOCUS_RANGE - automatic focus scan range selection Signed-off-by: Sylwester Nawrocki <s.nawrocki@samsung.com> Signed-off-by: Kyungmin Park <kyungmin.park@samsung.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>
Diffstat (limited to 'Documentation/DocBook')
-rw-r--r--Documentation/DocBook/media/v4l/compat.xml19
-rw-r--r--Documentation/DocBook/media/v4l/controls.xml98
-rw-r--r--Documentation/DocBook/media/v4l/v4l2.xml9
3 files changed, 123 insertions, 3 deletions
diff --git a/Documentation/DocBook/media/v4l/compat.xml b/Documentation/DocBook/media/v4l/compat.xml
index 149f65dfaa72..dc61b013b8a8 100644
--- a/Documentation/DocBook/media/v4l/compat.xml
+++ b/Documentation/DocBook/media/v4l/compat.xml
@@ -2435,6 +2435,21 @@ details.</para>
2435 <listitem> 2435 <listitem>
2436 <para> Added <constant>V4L2_CID_COLORFX_CBCR</constant> control.</para> 2436 <para> Added <constant>V4L2_CID_COLORFX_CBCR</constant> control.</para>
2437 </listitem> 2437 </listitem>
2438 <listitem>
2439 <para> Added camera controls <constant>V4L2_CID_AUTO_EXPOSURE_BIAS</constant>,
2440 <constant>V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE</constant>,
2441 <constant>V4L2_CID_IMAGE_STABILIZATION</constant>,
2442 <constant>V4L2_CID_ISO_SENSITIVITY</constant>,
2443 <constant>V4L2_CID_ISO_SENSITIVITY_AUTO</constant>,
2444 <constant>V4L2_CID_EXPOSURE_METERING</constant>,
2445 <constant>V4L2_CID_SCENE_MODE</constant>,
2446 <constant>V4L2_CID_3A_LOCK</constant>,
2447 <constant>V4L2_CID_AUTO_FOCUS_START</constant>,
2448 <constant>V4L2_CID_AUTO_FOCUS_STOP</constant>,
2449 <constant>V4L2_CID_AUTO_FOCUS_STATUS</constant> and
2450 <constant>V4L2_CID_AUTO_FOCUS_RANGE</constant>.
2451 </para>
2452 </listitem>
2438 </orderedlist> 2453 </orderedlist>
2439 </section> 2454 </section>
2440 2455
@@ -2555,6 +2570,10 @@ ioctls.</para>
2555 <para>Sub-device selection API: &VIDIOC-SUBDEV-G-SELECTION; 2570 <para>Sub-device selection API: &VIDIOC-SUBDEV-G-SELECTION;
2556 and &VIDIOC-SUBDEV-S-SELECTION; ioctls.</para> 2571 and &VIDIOC-SUBDEV-S-SELECTION; ioctls.</para>
2557 </listitem> 2572 </listitem>
2573 <listitem>
2574 <para><link linkend="v4l2-auto-focus-area"><constant>
2575 V4L2_CID_AUTO_FOCUS_AREA</constant></link> control.</para>
2576 </listitem>
2558 </itemizedlist> 2577 </itemizedlist>
2559 </section> 2578 </section>
2560 2579
diff --git a/Documentation/DocBook/media/v4l/controls.xml b/Documentation/DocBook/media/v4l/controls.xml
index f38f06169795..132b0cc29832 100644
--- a/Documentation/DocBook/media/v4l/controls.xml
+++ b/Documentation/DocBook/media/v4l/controls.xml
@@ -2976,13 +2976,107 @@ negative values towards infinity. This is a write-only control.</entry>
2976 <row> 2976 <row>
2977 <entry spanname="id"><constant>V4L2_CID_FOCUS_AUTO</constant>&nbsp;</entry> 2977 <entry spanname="id"><constant>V4L2_CID_FOCUS_AUTO</constant>&nbsp;</entry>
2978 <entry>boolean</entry> 2978 <entry>boolean</entry>
2979 </row><row><entry spanname="descr">Enables automatic focus 2979 </row><row><entry spanname="descr">Enables continuous automatic
2980adjustments. The effect of manual focus adjustments while this feature 2980focus adjustments. The effect of manual focus adjustments while this feature
2981is enabled is undefined, drivers should ignore such requests.</entry> 2981is enabled is undefined, drivers should ignore such requests.</entry>
2982 </row> 2982 </row>
2983 <row><entry></entry></row> 2983 <row><entry></entry></row>
2984 2984
2985 <row> 2985 <row>
2986 <entry spanname="id"><constant>V4L2_CID_AUTO_FOCUS_START</constant>&nbsp;</entry>
2987 <entry>button</entry>
2988 </row><row><entry spanname="descr">Starts single auto focus process.
2989The effect of setting this control when <constant>V4L2_CID_FOCUS_AUTO</constant>
2990is set to <constant>TRUE</constant> (1) is undefined, drivers should ignore
2991such requests.</entry>
2992 </row>
2993 <row><entry></entry></row>
2994
2995 <row>
2996 <entry spanname="id"><constant>V4L2_CID_AUTO_FOCUS_STOP</constant>&nbsp;</entry>
2997 <entry>button</entry>
2998 </row><row><entry spanname="descr">Aborts automatic focusing
2999started with <constant>V4L2_CID_AUTO_FOCUS_START</constant> control. It is
3000effective only when the continuous autofocus is disabled, that is when
3001<constant>V4L2_CID_FOCUS_AUTO</constant> control is set to <constant>FALSE
3002</constant> (0).</entry>
3003 </row>
3004 <row><entry></entry></row>
3005
3006 <row id="v4l2-auto-focus-status">
3007 <entry spanname="id">
3008 <constant>V4L2_CID_AUTO_FOCUS_STATUS</constant>&nbsp;</entry>
3009 <entry>bitmask</entry>
3010 </row>
3011 <row><entry spanname="descr">The automatic focus status. This is a read-only
3012 control.</entry>
3013 </row>
3014 <row>
3015 <entrytbl spanname="descr" cols="2">
3016 <tbody valign="top">
3017 <row>
3018 <entry><constant>V4L2_AUTO_FOCUS_STATUS_IDLE</constant>&nbsp;</entry>
3019 <entry>Automatic focus is not active.</entry>
3020 </row>
3021 <row>
3022 <entry><constant>V4L2_AUTO_FOCUS_STATUS_BUSY</constant>&nbsp;</entry>
3023 <entry>Automatic focusing is in progress.</entry>
3024 </row>
3025 <row>
3026 <entry><constant>V4L2_AUTO_FOCUS_STATUS_REACHED</constant>&nbsp;</entry>
3027 <entry>Focus has been reached.</entry>
3028 </row>
3029 <row>
3030 <entry><constant>V4L2_AUTO_FOCUS_STATUS_FAILED</constant>&nbsp;</entry>
3031 <entry>Automatic focus has failed, the driver will not
3032 transition from this state until another action is
3033 performed by an application.</entry>
3034 </row>
3035 </tbody>
3036 </entrytbl>
3037 </row>
3038 <row><entry spanname="descr">
3039Setting <constant>V4L2_LOCK_FOCUS</constant> lock bit of the <constant>V4L2_CID_3A_LOCK
3040</constant> control may stop updates of the <constant>V4L2_CID_AUTO_FOCUS_STATUS</constant>
3041control value.</entry>
3042 </row>
3043 <row><entry></entry></row>
3044
3045 <row id="v4l2-auto-focus-range">
3046 <entry spanname="id">
3047 <constant>V4L2_CID_AUTO_FOCUS_RANGE</constant>&nbsp;</entry>
3048 <entry>enum&nbsp;v4l2_auto_focus_range</entry>
3049 </row>
3050 <row><entry spanname="descr">Determines auto focus distance range
3051for which lens may be adjusted. </entry>
3052 </row>
3053 <row>
3054 <entrytbl spanname="descr" cols="2">
3055 <tbody valign="top">
3056 <row>
3057 <entry><constant>V4L2_AUTO_FOCUS_RANGE_AUTO</constant>&nbsp;</entry>
3058 <entry>The camera automatically selects the focus range.</entry>
3059 </row>
3060 <row>
3061 <entry><constant>V4L2_AUTO_FOCUS_RANGE_NORMAL</constant>&nbsp;</entry>
3062 <entry>Normal distance range, limited for best automatic focus
3063performance.</entry>
3064 </row>
3065 <row>
3066 <entry><constant>V4L2_AUTO_FOCUS_RANGE_MACRO</constant>&nbsp;</entry>
3067 <entry>Macro (close-up) auto focus. The camera will
3068use its minimum possible distance for auto focus.</entry>
3069 </row>
3070 <row>
3071 <entry><constant>V4L2_AUTO_FOCUS_RANGE_INFINITY</constant>&nbsp;</entry>
3072 <entry>The lens is set to focus on an object at infinite distance.</entry>
3073 </row>
3074 </tbody>
3075 </entrytbl>
3076 </row>
3077 <row><entry></entry></row>
3078
3079 <row>
2986 <entry spanname="id"><constant>V4L2_CID_ZOOM_ABSOLUTE</constant>&nbsp;</entry> 3080 <entry spanname="id"><constant>V4L2_CID_ZOOM_ABSOLUTE</constant>&nbsp;</entry>
2987 <entry>integer</entry> 3081 <entry>integer</entry>
2988 </row><row><entry spanname="descr">Specify the objective lens 3082 </row><row><entry spanname="descr">Specify the objective lens
diff --git a/Documentation/DocBook/media/v4l/v4l2.xml b/Documentation/DocBook/media/v4l/v4l2.xml
index 63242e2adc02..e6fbbc6c17e1 100644
--- a/Documentation/DocBook/media/v4l/v4l2.xml
+++ b/Documentation/DocBook/media/v4l/v4l2.xml
@@ -140,11 +140,18 @@ applications. -->
140 140
141 <revision> 141 <revision>
142 <revnumber>3.5</revnumber> 142 <revnumber>3.5</revnumber>
143 <date>2012-04-02</date> 143 <date>2012-05-07</date>
144 <authorinitials>sa, sn</authorinitials> 144 <authorinitials>sa, sn</authorinitials>
145 <revremark>Added V4L2_CTRL_TYPE_INTEGER_MENU and V4L2 subdev 145 <revremark>Added V4L2_CTRL_TYPE_INTEGER_MENU and V4L2 subdev
146 selections API. Improved the description of V4L2_CID_COLORFX 146 selections API. Improved the description of V4L2_CID_COLORFX
147 control, added V4L2_CID_COLORFX_CBCR control. 147 control, added V4L2_CID_COLORFX_CBCR control.
148 Added camera controls V4L2_CID_AUTO_EXPOSURE_BIAS,
149 V4L2_CID_AUTO_N_PRESET_WHITE_BALANCE, V4L2_CID_IMAGE_STABILIZATION,
150 V4L2_CID_ISO_SENSITIVITY, V4L2_CID_ISO_SENSITIVITY_AUTO,
151 V4L2_CID_EXPOSURE_METERING, V4L2_CID_SCENE_MODE,
152 V4L2_CID_3A_LOCK, V4L2_CID_AUTO_FOCUS_START,
153 V4L2_CID_AUTO_FOCUS_STOP, V4L2_CID_AUTO_FOCUS_STATUS
154 and V4L2_CID_AUTO_FOCUS_RANGE.
148 </revremark> 155 </revremark>
149 </revision> 156 </revision>
150 157