[media] DocBook: media: document PLL lock control
authorAntti Palosaari <crope@iki.fi>
Fri, 7 Feb 2014 06:55:32 +0000 (03:55 -0300)
committerMauro Carvalho Chehab <m.chehab@samsung.com>
Thu, 13 Mar 2014 13:26:48 +0000 (10:26 -0300)
Document PLL lock V4L2 control. It is read only RF tuner control
which is used to inform if tuner is receiving frequency or not.

Cc: Hans Verkuil <hverkuil@xs4all.nl>
Signed-off-by: Antti Palosaari <crope@iki.fi>
Signed-off-by: Mauro Carvalho Chehab <m.chehab@samsung.com>
Documentation/DocBook/media/v4l/controls.xml

index 8c62ead889e42e53722d2a2eb70615b072d1c101..47198eef75a4c32b5227cb71b041e00749dc1000 100644 (file)
@@ -5134,6 +5134,15 @@ intermediate frequency output or baseband output. Used when
 <constant>V4L2_CID_RF_TUNER_IF_GAIN_AUTO</constant> is not set. The range and step are
 driver-specific.</entry>
             </row>
+            <row>
+              <entry spanname="id"><constant>V4L2_CID_RF_TUNER_PLL_LOCK</constant>&nbsp;</entry>
+              <entry>boolean</entry>
+            </row>
+            <row>
+              <entry spanname="descr">Is synthesizer PLL locked? RF tuner is
+receiving given frequency when that control is set. This is a read-only control.
+</entry>
+            </row>
           </tbody>
         </tgroup>
       </table>