[PATCH] DocBook: document RF tuner gain controls
Add documentation for LNA, mixer and IF gain controls. These controls are RF tuner specific. Cc: Hans Verkuil hverk...@xs4all.nl Signed-off-by: Antti Palosaari cr...@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 + titleRF Tuner Control Reference/title + + paraThe 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 +titleRF_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=leftID/entry + entry align=leftType/entry +/row +row rowsep=1 + entry spanname=descr align=leftDescription/entry +/row + /thead + tbody valign=top +rowentry/entry/row +row + entry spanname=idconstantV4L2_CID_RF_TUNER_CLASS/constantnbsp;/entry + entryclass/entry +/rowrowentry spanname=descrThe RF_TUNER class +descriptor. Calling VIDIOC-QUERYCTRL; for this control will return a +description of this control class./entry +/row +row + entry spanname=idconstantV4L2_CID_LNA_GAIN_AUTO/constantnbsp;/entry + entryboolean/entry +/row +row + entry spanname=descrEnables/disables LNA automatic gain control (AGC)/entry +/row +row + entry spanname=idconstantV4L2_CID_MIXER_GAIN_AUTO/constantnbsp;/entry + entryboolean/entry +/row +row + entry spanname=descrEnables/disables mixer automatic gain control (AGC)/entry +/row +row + entry spanname=idconstantV4L2_CID_IF_GAIN_AUTO/constantnbsp;/entry + entryboolean/entry +/row +row + entry spanname=descrEnables/disables IF automatic gain control (AGC)/entry +/row +row + entry spanname=idconstantV4L2_CID_LNA_GAIN/constantnbsp;/entry + entryinteger/entry +/row +row + entry spanname=descrLNA (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 constantV4L2_CID_LNA_GAIN_AUTO/constant is not set. +The range and step are driver-specific./entry +/row +row + entry spanname=idconstantV4L2_CID_MIXER_GAIN/constantnbsp;/entry + entryinteger/entry +/row +row + entry spanname=descrMixer 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 constantV4L2_CID_MIXER_GAIN_AUTO/constant +is not set. The range and step are driver-specific./entry +/row +row + entry spanname=idconstantV4L2_CID_IF_GAIN/constantnbsp;/entry + entryinteger/entry +/row +row + entry spanname=descrIF 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 +constantV4L2_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 -- To unsubscribe from this list: send the line unsubscribe linux-media in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
Re: [PATCH] DocBook: document RF tuner gain controls
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 hverk...@xs4all.nl Acked-by: Hans Verkuil hans.verk...@cisco.com Regards, Hans Signed-off-by: Antti Palosaari cr...@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 + titleRF Tuner Control Reference/title + + paraThe 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 +titleRF_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=leftID/entry + entry align=leftType/entry +/row +row rowsep=1 + entry spanname=descr align=leftDescription/entry +/row + /thead + tbody valign=top +rowentry/entry/row +row + entry spanname=idconstantV4L2_CID_RF_TUNER_CLASS/constantnbsp;/entry + entryclass/entry +/rowrowentry spanname=descrThe RF_TUNER class +descriptor. Calling VIDIOC-QUERYCTRL; for this control will return a +description of this control class./entry +/row +row + entry spanname=idconstantV4L2_CID_LNA_GAIN_AUTO/constantnbsp;/entry + entryboolean/entry +/row +row + entry spanname=descrEnables/disables LNA automatic gain control (AGC)/entry +/row +row + entry spanname=idconstantV4L2_CID_MIXER_GAIN_AUTO/constantnbsp;/entry + entryboolean/entry +/row +row + entry spanname=descrEnables/disables mixer automatic gain control (AGC)/entry +/row +row + entry spanname=idconstantV4L2_CID_IF_GAIN_AUTO/constantnbsp;/entry + entryboolean/entry +/row +row + entry spanname=descrEnables/disables IF automatic gain control (AGC)/entry +/row +row + entry spanname=idconstantV4L2_CID_LNA_GAIN/constantnbsp;/entry + entryinteger/entry +/row +row + entry spanname=descrLNA (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 constantV4L2_CID_LNA_GAIN_AUTO/constant is not set. +The range and step are driver-specific./entry +/row +row + entry spanname=idconstantV4L2_CID_MIXER_GAIN/constantnbsp;/entry + entryinteger/entry +/row +row + entry spanname=descrMixer 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 constantV4L2_CID_MIXER_GAIN_AUTO/constant +is not set. The range and step are driver-specific./entry +/row +row + entry spanname=idconstantV4L2_CID_IF_GAIN/constantnbsp;/entry + entryinteger/entry +/row +row + entry spanname=descrIF 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 +constantV4L2_CID_IF_GAIN_AUTO/constant is not set. The range and step are +driver-specific./entry +/row + /tbody +/tgroup + /table +/section /section -- To unsubscribe from this list: send the line unsubscribe linux-media in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
