v4l2-ctrls: document the changes about auto focus mode

RFC PATCH Superseded Kim, HeungJun 1 participant 1 message Feb 25, 2011

Subsystems (2)

Documentation Media (V4L/DVB)

lore

Share & tools

lore

Kim, HeungJun

author

2011-02-25 12:46 UTC #0 lore raw

RFC PATCH v2 3/3 v4l2-ctrls: document the changes about auto focus mode

Document about the type changes and the enumeration of the auto focus control.

Signed-off-by Heungjun Kim <[email protected]>

Signed-off-by Kyungmin Park <[email protected]>

---
 Documentation/DocBook/v4l/controls.xml    |   31 +++++++++++++++++++++++++---
 Documentation/DocBook/v4l/videodev2.h.xml |    6 +++++
 2 files changed, 33 insertions(+), 4 deletions(-)

Documentation/DocBook/v4l/controls.xml +27 -4

index 2fae3e8..889fa84 100644
@@ -1801,12 +1801,35 @@ negative values towards infinity. This is a write-only control.</entry>
 	  </row>
 	  <row><entry></entry></row>
 
-	  <row>
+	  <row id="v4l2-focus-auto-type">
 	    <entry spanname="id"><constant>V4L2_CID_FOCUS_AUTO</constant>&nbsp;</entry>
-	    <entry>boolean</entry>
+	    <entry>enum&nbsp;v4l2_focus_auto_type</entry>
 	  </row><row><entry spanname="descr">Enables automatic focus
-adjustments. The effect of manual focus adjustments while this feature
-is enabled is undefined, drivers should ignore such requests.</entry>
+adjustments of the normal or macro or continuous(CAF) mode. The effect of
+manual focus adjustments while this feature is enabled is undefined,
+drivers should ignore such requests. Possible values are:</entry>
+	  </row>
+	  <row>
+	    <entrytbl spanname="descr" cols="2">
+	      <tbody valign="top">
+		<row>
+		  <entry><constant>V4L2_FOCUS_MANUAL</constant>&nbsp;</entry>
+		  <entry>Manual focus mode.</entry>
+		</row>
+		<row>
+		  <entry><constant>V4L2_FOCUS_AUTO</constant>&nbsp;</entry>
+		  <entry>Auto focus mode with normal operation.</entry>
+		</row>
+		<row>
+		  <entry><constant>V4L2_FOCUS_MACRO</constant>&nbsp;</entry>
+		  <entry>Auto focus mode with macro operation.</entry>
+		</row>
+		<row>
+		  <entry><constant>V4L2_FOCUS_CONTINUOUS</constant>&nbsp;</entry>
+		  <entry>Auto focus mode with continuous(CAF) operation.</entry>
+		</row>
+	      </tbody>
+	    </entrytbl>
 	  </row>
 	  <row><entry></entry></row>

Documentation/DocBook/v4l/videodev2.h.xml +6 -0

index 325b23b..ccf6c2b 100644
@@ -1291,6 +1291,12 @@ enum  <link linkend="v4l2-exposure-auto-type">v4l2_exposure_auto_type</link> {
 #define V4L2_CID_FOCUS_ABSOLUTE                 (V4L2_CID_CAMERA_CLASS_BASE+10)
 #define V4L2_CID_FOCUS_RELATIVE                 (V4L2_CID_CAMERA_CLASS_BASE+11)
 #define V4L2_CID_FOCUS_AUTO                     (V4L2_CID_CAMERA_CLASS_BASE+12)
+enum  <link linkend="v4l2-focus-auto-type">v4l2_exposure_auto_type</link> {
+	V4L2_FOCUS_MANUAL = 0,
+	V4L2_FOCUS_AUTO = 1,
+	V4L2_FOCUS_MACRO = 2,
+	V4L2_FOCUS_CONTINUOUS = 3
+};
 
 #define V4L2_CID_ZOOM_ABSOLUTE                  (V4L2_CID_CAMERA_CLASS_BASE+13)
 #define V4L2_CID_ZOOM_RELATIVE                  (V4L2_CID_CAMERA_CLASS_BASE+14)

Signature · 1 line

1.7.0.4