* [PATCH] DocBook: document RF tuner gain controls
@ 2014-01-30 3:02 Antti Palosaari
2014-01-30 7:31 ` Hans Verkuil
0 siblings, 1 reply; 2+ messages in thread
From: Antti Palosaari @ 2014-01-30 3:02 UTC (permalink / raw)
To: linux-media; +Cc: Antti Palosaari, Hans Verkuil
Add documentation for LNA, mixer and IF gain controls. These
controls are RF tuner specific.
Cc: Hans Verkuil <hverkuil@xs4all.nl>
Signed-off-by: Antti Palosaari <crope@iki.fi>
---
Documentation/DocBook/media/v4l/controls.xml | 91 ++++++++++++++++++++++++++++
1 file changed, 91 insertions(+)
diff --git a/Documentation/DocBook/media/v4l/controls.xml b/Documentation/DocBook/media/v4l/controls.xml
index a5a3188..0145341 100644
--- a/Documentation/DocBook/media/v4l/controls.xml
+++ b/Documentation/DocBook/media/v4l/controls.xml
@@ -4971,4 +4971,95 @@ defines possible values for de-emphasis. Here they are:</entry>
</table>
</section>
+
+ <section id="rf-tuner-controls">
+ <title>RF Tuner Control Reference</title>
+
+ <para>The RF Tuner (RF_TUNER) class includes controls for common features
+of devices having RF tuner.</para>
+
+ <table pgwide="1" frame="none" id="rf-tuner-control-id">
+ <title>RF_TUNER Control IDs</title>
+
+ <tgroup cols="4">
+ <colspec colname="c1" colwidth="1*" />
+ <colspec colname="c2" colwidth="6*" />
+ <colspec colname="c3" colwidth="2*" />
+ <colspec colname="c4" colwidth="6*" />
+ <spanspec namest="c1" nameend="c2" spanname="id" />
+ <spanspec namest="c2" nameend="c4" spanname="descr" />
+ <thead>
+ <row>
+ <entry spanname="id" align="left">ID</entry>
+ <entry align="left">Type</entry>
+ </row>
+ <row rowsep="1">
+ <entry spanname="descr" align="left">Description</entry>
+ </row>
+ </thead>
+ <tbody valign="top">
+ <row><entry></entry></row>
+ <row>
+ <entry spanname="id"><constant>V4L2_CID_RF_TUNER_CLASS</constant> </entry>
+ <entry>class</entry>
+ </row><row><entry spanname="descr">The RF_TUNER class
+descriptor. Calling &VIDIOC-QUERYCTRL; for this control will return a
+description of this control class.</entry>
+ </row>
+ <row>
+ <entry spanname="id"><constant>V4L2_CID_LNA_GAIN_AUTO</constant> </entry>
+ <entry>boolean</entry>
+ </row>
+ <row>
+ <entry spanname="descr">Enables/disables LNA automatic gain control (AGC)</entry>
+ </row>
+ <row>
+ <entry spanname="id"><constant>V4L2_CID_MIXER_GAIN_AUTO</constant> </entry>
+ <entry>boolean</entry>
+ </row>
+ <row>
+ <entry spanname="descr">Enables/disables mixer automatic gain control (AGC)</entry>
+ </row>
+ <row>
+ <entry spanname="id"><constant>V4L2_CID_IF_GAIN_AUTO</constant> </entry>
+ <entry>boolean</entry>
+ </row>
+ <row>
+ <entry spanname="descr">Enables/disables IF automatic gain control (AGC)</entry>
+ </row>
+ <row>
+ <entry spanname="id"><constant>V4L2_CID_LNA_GAIN</constant> </entry>
+ <entry>integer</entry>
+ </row>
+ <row>
+ <entry spanname="descr">LNA (low noise amplifier) gain is first
+gain stage on the RF tuner signal path. It is located very close to tuner
+antenna input. Used when <constant>V4L2_CID_LNA_GAIN_AUTO</constant> is not set.
+The range and step are driver-specific.</entry>
+ </row>
+ <row>
+ <entry spanname="id"><constant>V4L2_CID_MIXER_GAIN</constant> </entry>
+ <entry>integer</entry>
+ </row>
+ <row>
+ <entry spanname="descr">Mixer gain is second gain stage on the RF
+tuner signal path. It is located inside mixer block, where RF signal is
+down-converted by the mixer. Used when <constant>V4L2_CID_MIXER_GAIN_AUTO</constant>
+is not set. The range and step are driver-specific.</entry>
+ </row>
+ <row>
+ <entry spanname="id"><constant>V4L2_CID_IF_GAIN</constant> </entry>
+ <entry>integer</entry>
+ </row>
+ <row>
+ <entry spanname="descr">IF gain is last gain stage on the RF tuner
+signal path. It is located on output of RF tuner. It controls signal level of
+intermediate frequency output or baseband output. Used when
+<constant>V4L2_CID_IF_GAIN_AUTO</constant> is not set. The range and step are
+driver-specific.</entry>
+ </row>
+ </tbody>
+ </tgroup>
+ </table>
+ </section>
</section>
--
1.8.5.3
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH] DocBook: document RF tuner gain controls
2014-01-30 3:02 [PATCH] DocBook: document RF tuner gain controls Antti Palosaari
@ 2014-01-30 7:31 ` Hans Verkuil
0 siblings, 0 replies; 2+ messages in thread
From: Hans Verkuil @ 2014-01-30 7:31 UTC (permalink / raw)
To: Antti Palosaari; +Cc: linux-media
On 01/30/2014 04:02 AM, Antti Palosaari wrote:
> Add documentation for LNA, mixer and IF gain controls. These
> controls are RF tuner specific.
>
> Cc: Hans Verkuil <hverkuil@xs4all.nl>
Acked-by: Hans Verkuil <hans.verkuil@cisco.com>
Regards,
Hans
> Signed-off-by: Antti Palosaari <crope@iki.fi>
> ---
> Documentation/DocBook/media/v4l/controls.xml | 91 ++++++++++++++++++++++++++++
> 1 file changed, 91 insertions(+)
>
> diff --git a/Documentation/DocBook/media/v4l/controls.xml b/Documentation/DocBook/media/v4l/controls.xml
> index a5a3188..0145341 100644
> --- a/Documentation/DocBook/media/v4l/controls.xml
> +++ b/Documentation/DocBook/media/v4l/controls.xml
> @@ -4971,4 +4971,95 @@ defines possible values for de-emphasis. Here they are:</entry>
> </table>
>
> </section>
> +
> + <section id="rf-tuner-controls">
> + <title>RF Tuner Control Reference</title>
> +
> + <para>The RF Tuner (RF_TUNER) class includes controls for common features
> +of devices having RF tuner.</para>
> +
> + <table pgwide="1" frame="none" id="rf-tuner-control-id">
> + <title>RF_TUNER Control IDs</title>
> +
> + <tgroup cols="4">
> + <colspec colname="c1" colwidth="1*" />
> + <colspec colname="c2" colwidth="6*" />
> + <colspec colname="c3" colwidth="2*" />
> + <colspec colname="c4" colwidth="6*" />
> + <spanspec namest="c1" nameend="c2" spanname="id" />
> + <spanspec namest="c2" nameend="c4" spanname="descr" />
> + <thead>
> + <row>
> + <entry spanname="id" align="left">ID</entry>
> + <entry align="left">Type</entry>
> + </row>
> + <row rowsep="1">
> + <entry spanname="descr" align="left">Description</entry>
> + </row>
> + </thead>
> + <tbody valign="top">
> + <row><entry></entry></row>
> + <row>
> + <entry spanname="id"><constant>V4L2_CID_RF_TUNER_CLASS</constant> </entry>
> + <entry>class</entry>
> + </row><row><entry spanname="descr">The RF_TUNER class
> +descriptor. Calling &VIDIOC-QUERYCTRL; for this control will return a
> +description of this control class.</entry>
> + </row>
> + <row>
> + <entry spanname="id"><constant>V4L2_CID_LNA_GAIN_AUTO</constant> </entry>
> + <entry>boolean</entry>
> + </row>
> + <row>
> + <entry spanname="descr">Enables/disables LNA automatic gain control (AGC)</entry>
> + </row>
> + <row>
> + <entry spanname="id"><constant>V4L2_CID_MIXER_GAIN_AUTO</constant> </entry>
> + <entry>boolean</entry>
> + </row>
> + <row>
> + <entry spanname="descr">Enables/disables mixer automatic gain control (AGC)</entry>
> + </row>
> + <row>
> + <entry spanname="id"><constant>V4L2_CID_IF_GAIN_AUTO</constant> </entry>
> + <entry>boolean</entry>
> + </row>
> + <row>
> + <entry spanname="descr">Enables/disables IF automatic gain control (AGC)</entry>
> + </row>
> + <row>
> + <entry spanname="id"><constant>V4L2_CID_LNA_GAIN</constant> </entry>
> + <entry>integer</entry>
> + </row>
> + <row>
> + <entry spanname="descr">LNA (low noise amplifier) gain is first
> +gain stage on the RF tuner signal path. It is located very close to tuner
> +antenna input. Used when <constant>V4L2_CID_LNA_GAIN_AUTO</constant> is not set.
> +The range and step are driver-specific.</entry>
> + </row>
> + <row>
> + <entry spanname="id"><constant>V4L2_CID_MIXER_GAIN</constant> </entry>
> + <entry>integer</entry>
> + </row>
> + <row>
> + <entry spanname="descr">Mixer gain is second gain stage on the RF
> +tuner signal path. It is located inside mixer block, where RF signal is
> +down-converted by the mixer. Used when <constant>V4L2_CID_MIXER_GAIN_AUTO</constant>
> +is not set. The range and step are driver-specific.</entry>
> + </row>
> + <row>
> + <entry spanname="id"><constant>V4L2_CID_IF_GAIN</constant> </entry>
> + <entry>integer</entry>
> + </row>
> + <row>
> + <entry spanname="descr">IF gain is last gain stage on the RF tuner
> +signal path. It is located on output of RF tuner. It controls signal level of
> +intermediate frequency output or baseband output. Used when
> +<constant>V4L2_CID_IF_GAIN_AUTO</constant> is not set. The range and step are
> +driver-specific.</entry>
> + </row>
> + </tbody>
> + </tgroup>
> + </table>
> + </section>
> </section>
>
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2014-01-30 7:31 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2014-01-30 3:02 [PATCH] DocBook: document RF tuner gain controls Antti Palosaari
2014-01-30 7:31 ` Hans Verkuil
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.