1 .. SPDX-License-Identifier: GFDL-1.1-no-invari !! 1 .. Permission is granted to copy, distribute and/or modify this
>> 2 .. document under the terms of the GNU Free Documentation License,
>> 3 .. Version 1.1 or any later version published by the Free Software
>> 4 .. Foundation, with no Invariant Sections, no Front-Cover Texts
>> 5 .. and no Back-Cover Texts. A copy of the license is included at
>> 6 .. Documentation/userspace-api/media/fdl-appendix.rst.
>> 7 ..
>> 8 .. TODO: replace it to GFDL-1.1-or-later WITH no-invariant-sections
2 9
3 .. _rf-tuner-controls: 10 .. _rf-tuner-controls:
4 11
5 ************************** 12 **************************
6 RF Tuner Control Reference 13 RF Tuner Control Reference
7 ************************** 14 **************************
8 15
9 The RF Tuner (RF_TUNER) class includes control 16 The RF Tuner (RF_TUNER) class includes controls for common features of
10 devices having RF tuner. 17 devices having RF tuner.
11 18
12 In this context, RF tuner is radio receiver ci 19 In this context, RF tuner is radio receiver circuit between antenna and
13 demodulator. It receives radio frequency (RF) 20 demodulator. It receives radio frequency (RF) from the antenna and
14 converts that received signal to lower interme 21 converts that received signal to lower intermediate frequency (IF) or
15 baseband frequency (BB). Tuners that could do 22 baseband frequency (BB). Tuners that could do baseband output are often
16 called Zero-IF tuners. Older tuners were typic 23 called Zero-IF tuners. Older tuners were typically simple PLL tuners
17 inside a metal box, while newer ones are highl 24 inside a metal box, while newer ones are highly integrated chips
18 without a metal box "silicon tuners". These co 25 without a metal box "silicon tuners". These controls are mostly
19 applicable for new feature rich silicon tuners 26 applicable for new feature rich silicon tuners, just because older
20 tuners does not have much adjustable features. 27 tuners does not have much adjustable features.
21 28
22 For more information about RF tuners see 29 For more information about RF tuners see
23 `Tuner (radio) <http://en.wikipedia.org/wiki/T 30 `Tuner (radio) <http://en.wikipedia.org/wiki/Tuner_%28radio%29>`__
24 and `RF front end <http://en.wikipedia.org/wik 31 and `RF front end <http://en.wikipedia.org/wiki/RF_front_end>`__
25 from Wikipedia. 32 from Wikipedia.
26 33
27 34
28 .. _rf-tuner-control-id: 35 .. _rf-tuner-control-id:
29 36
30 RF_TUNER Control IDs 37 RF_TUNER Control IDs
31 ==================== 38 ====================
32 39
33 ``V4L2_CID_RF_TUNER_CLASS (class)`` 40 ``V4L2_CID_RF_TUNER_CLASS (class)``
34 The RF_TUNER class descriptor. Calling 41 The RF_TUNER class descriptor. Calling
35 :ref:`VIDIOC_QUERYCTRL` for this control w 42 :ref:`VIDIOC_QUERYCTRL` for this control will
36 return a description of this control class 43 return a description of this control class.
37 44
38 ``V4L2_CID_RF_TUNER_BANDWIDTH_AUTO (boolean)`` 45 ``V4L2_CID_RF_TUNER_BANDWIDTH_AUTO (boolean)``
39 Enables/disables tuner radio channel bandw 46 Enables/disables tuner radio channel bandwidth configuration. In
40 automatic mode bandwidth configuration is 47 automatic mode bandwidth configuration is performed by the driver.
41 48
42 ``V4L2_CID_RF_TUNER_BANDWIDTH (integer)`` 49 ``V4L2_CID_RF_TUNER_BANDWIDTH (integer)``
43 Filter(s) on tuner signal path are used to 50 Filter(s) on tuner signal path are used to filter signal according
44 to receiving party needs. Driver configure 51 to receiving party needs. Driver configures filters to fulfill
45 desired bandwidth requirement. Used when 52 desired bandwidth requirement. Used when
46 V4L2_CID_RF_TUNER_BANDWIDTH_AUTO is not se 53 V4L2_CID_RF_TUNER_BANDWIDTH_AUTO is not set. Unit is in Hz. The
47 range and step are driver-specific. 54 range and step are driver-specific.
48 55
49 ``V4L2_CID_RF_TUNER_LNA_GAIN_AUTO (boolean)`` 56 ``V4L2_CID_RF_TUNER_LNA_GAIN_AUTO (boolean)``
50 Enables/disables LNA automatic gain contro 57 Enables/disables LNA automatic gain control (AGC)
51 58
52 ``V4L2_CID_RF_TUNER_MIXER_GAIN_AUTO (boolean)` 59 ``V4L2_CID_RF_TUNER_MIXER_GAIN_AUTO (boolean)``
53 Enables/disables mixer automatic gain cont 60 Enables/disables mixer automatic gain control (AGC)
54 61
55 ``V4L2_CID_RF_TUNER_IF_GAIN_AUTO (boolean)`` 62 ``V4L2_CID_RF_TUNER_IF_GAIN_AUTO (boolean)``
56 Enables/disables IF automatic gain control 63 Enables/disables IF automatic gain control (AGC)
57 64
58 ``V4L2_CID_RF_TUNER_RF_GAIN (integer)`` 65 ``V4L2_CID_RF_TUNER_RF_GAIN (integer)``
59 The RF amplifier is the very first amplifi 66 The RF amplifier is the very first amplifier on the receiver signal
60 path, just right after the antenna input. 67 path, just right after the antenna input. The difference between the
61 LNA gain and the RF gain in this document 68 LNA gain and the RF gain in this document is that the LNA gain is
62 integrated in the tuner chip while the RF 69 integrated in the tuner chip while the RF gain is a separate chip.
63 There may be both RF and LNA gain controls 70 There may be both RF and LNA gain controls in the same device. The
64 range and step are driver-specific. 71 range and step are driver-specific.
65 72
66 ``V4L2_CID_RF_TUNER_LNA_GAIN (integer)`` 73 ``V4L2_CID_RF_TUNER_LNA_GAIN (integer)``
67 LNA (low noise amplifier) gain is first ga 74 LNA (low noise amplifier) gain is first gain stage on the RF tuner
68 signal path. It is located very close to t 75 signal path. It is located very close to tuner antenna input. Used
69 when ``V4L2_CID_RF_TUNER_LNA_GAIN_AUTO`` i 76 when ``V4L2_CID_RF_TUNER_LNA_GAIN_AUTO`` is not set. See
70 ``V4L2_CID_RF_TUNER_RF_GAIN`` to understan 77 ``V4L2_CID_RF_TUNER_RF_GAIN`` to understand how RF gain and LNA gain
71 differs from the each others. The range an 78 differs from the each others. The range and step are
72 driver-specific. 79 driver-specific.
73 80
74 ``V4L2_CID_RF_TUNER_MIXER_GAIN (integer)`` 81 ``V4L2_CID_RF_TUNER_MIXER_GAIN (integer)``
75 Mixer gain is second gain stage on the RF 82 Mixer gain is second gain stage on the RF tuner signal path. It is
76 located inside mixer block, where RF signa 83 located inside mixer block, where RF signal is down-converted by the
77 mixer. Used when ``V4L2_CID_RF_TUNER_MIXER 84 mixer. Used when ``V4L2_CID_RF_TUNER_MIXER_GAIN_AUTO`` is not set.
78 The range and step are driver-specific. 85 The range and step are driver-specific.
79 86
80 ``V4L2_CID_RF_TUNER_IF_GAIN (integer)`` 87 ``V4L2_CID_RF_TUNER_IF_GAIN (integer)``
81 IF gain is last gain stage on the RF tuner 88 IF gain is last gain stage on the RF tuner signal path. It is
82 located on output of RF tuner. It controls 89 located on output of RF tuner. It controls signal level of
83 intermediate frequency output or baseband 90 intermediate frequency output or baseband output. Used when
84 ``V4L2_CID_RF_TUNER_IF_GAIN_AUTO`` is not 91 ``V4L2_CID_RF_TUNER_IF_GAIN_AUTO`` is not set. The range and step
85 are driver-specific. 92 are driver-specific.
86 93
87 ``V4L2_CID_RF_TUNER_PLL_LOCK (boolean)`` 94 ``V4L2_CID_RF_TUNER_PLL_LOCK (boolean)``
88 Is synthesizer PLL locked? RF tuner is rec 95 Is synthesizer PLL locked? RF tuner is receiving given frequency
89 when that control is set. This is a read-o 96 when that control is set. This is a read-only control.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.