aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAntti Palosaari <crope@iki.fi>2015-10-10 12:50:59 -0400
committerMauro Carvalho Chehab <mchehab@osg.samsung.com>2015-10-20 13:39:37 -0400
commitb2411b93cdcb5cb154827b8fcd2f436dd0ddab73 (patch)
tree8d1b2c341cc16411b3a727e9156adb56f59a3e4e
parent41018cb84a9ed440db1508d67d9dd4084d5460eb (diff)
[media] DocBook: document tuner RF gain control
Add brief description for tuner RF gain control. Signed-off-by: Antti Palosaari <crope@iki.fi> Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
-rw-r--r--Documentation/DocBook/media/v4l/compat.xml4
-rw-r--r--Documentation/DocBook/media/v4l/controls.xml14
-rw-r--r--Documentation/DocBook/media/v4l/v4l2.xml1
3 files changed, 19 insertions, 0 deletions
diff --git a/Documentation/DocBook/media/v4l/compat.xml b/Documentation/DocBook/media/v4l/compat.xml
index 08f4efcab4e9..6c4e95146d16 100644
--- a/Documentation/DocBook/media/v4l/compat.xml
+++ b/Documentation/DocBook/media/v4l/compat.xml
@@ -2600,6 +2600,10 @@ and &v4l2-mbus-framefmt;.
2600<constant>V4L2_TUNER_ADC</constant> is deprecated now. 2600<constant>V4L2_TUNER_ADC</constant> is deprecated now.
2601 </para> 2601 </para>
2602 </listitem> 2602 </listitem>
2603 <listitem>
2604 <para>Added <constant>V4L2_CID_RF_TUNER_RF_GAIN</constant>
2605RF Tuner control.</para>
2606 </listitem>
2603 </orderedlist> 2607 </orderedlist>
2604 </section> 2608 </section>
2605 2609
diff --git a/Documentation/DocBook/media/v4l/controls.xml b/Documentation/DocBook/media/v4l/controls.xml
index 33aece541880..f13a429093f1 100644
--- a/Documentation/DocBook/media/v4l/controls.xml
+++ b/Documentation/DocBook/media/v4l/controls.xml
@@ -5418,6 +5418,18 @@ set. Unit is in Hz. The range and step are driver-specific.</entry>
5418 <entry spanname="descr">Enables/disables IF automatic gain control (AGC)</entry> 5418 <entry spanname="descr">Enables/disables IF automatic gain control (AGC)</entry>
5419 </row> 5419 </row>
5420 <row> 5420 <row>
5421 <entry spanname="id"><constant>V4L2_CID_RF_TUNER_RF_GAIN</constant>&nbsp;</entry>
5422 <entry>integer</entry>
5423 </row>
5424 <row>
5425 <entry spanname="descr">The RF amplifier is the very first
5426amplifier on the receiver signal path, just right after the antenna input.
5427The difference between the LNA gain and the RF gain in this document is that
5428the LNA gain is integrated in the tuner chip while the RF gain is a separate
5429chip. There may be both RF and LNA gain controls in the same device.
5430The range and step are driver-specific.</entry>
5431 </row>
5432 <row>
5421 <entry spanname="id"><constant>V4L2_CID_RF_TUNER_LNA_GAIN</constant>&nbsp;</entry> 5433 <entry spanname="id"><constant>V4L2_CID_RF_TUNER_LNA_GAIN</constant>&nbsp;</entry>
5422 <entry>integer</entry> 5434 <entry>integer</entry>
5423 </row> 5435 </row>
@@ -5425,6 +5437,8 @@ set. Unit is in Hz. The range and step are driver-specific.</entry>
5425 <entry spanname="descr">LNA (low noise amplifier) gain is first 5437 <entry spanname="descr">LNA (low noise amplifier) gain is first
5426gain stage on the RF tuner signal path. It is located very close to tuner 5438gain stage on the RF tuner signal path. It is located very close to tuner
5427antenna input. Used when <constant>V4L2_CID_RF_TUNER_LNA_GAIN_AUTO</constant> is not set. 5439antenna input. Used when <constant>V4L2_CID_RF_TUNER_LNA_GAIN_AUTO</constant> is not set.
5440See <constant>V4L2_CID_RF_TUNER_RF_GAIN</constant> to understand how RF gain
5441and LNA gain differs from the each others.
5428The range and step are driver-specific.</entry> 5442The range and step are driver-specific.</entry>
5429 </row> 5443 </row>
5430 <row> 5444 <row>
diff --git a/Documentation/DocBook/media/v4l/v4l2.xml b/Documentation/DocBook/media/v4l/v4l2.xml
index 01a24df92e1d..9cc4117644fc 100644
--- a/Documentation/DocBook/media/v4l/v4l2.xml
+++ b/Documentation/DocBook/media/v4l/v4l2.xml
@@ -156,6 +156,7 @@ applications. -->
156 <date>2015-05-26</date> 156 <date>2015-05-26</date>
157 <authorinitials>ap</authorinitials> 157 <authorinitials>ap</authorinitials>
158 <revremark>Renamed V4L2_TUNER_ADC to V4L2_TUNER_SDR. 158 <revremark>Renamed V4L2_TUNER_ADC to V4L2_TUNER_SDR.
159Added V4L2_CID_RF_TUNER_RF_GAIN control.
159 </revremark> 160 </revremark>
160 </revision> 161 </revision>
161 162